Skip to content

publish_plugins

ExtractReviewDataModel

Bases: BaseSettingsModel

Add a raw reviewable representation from the output of a write node.

This can be useful when you don't want to use e.g. Extract Review Intermediates with baking streams but are already writing ready for review images that don't need custom baking.

Source code in server/settings/publish_plugins.py
 94
 95
 96
 97
 98
 99
100
101
class ExtractReviewDataModel(BaseSettingsModel):
    """Add a raw reviewable representation from the output of a write node.

    This can be useful when you don't want to use e.g. Extract Review
    Intermediates with baking streams but are already writing ready for
    review images that don't need custom baking.
    """
    enabled: bool = SettingsField(title="Enabled")

NodeModel

Bases: BaseSettingsModel

Source code in server/settings/publish_plugins.py
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class NodeModel(BaseSettingsModel):
    name: str = SettingsField(
        title="Node name"
    )
    nodeclass: str = SettingsField(
        "",
        title="Node class"
    )
    dependent: str = SettingsField(
        "",
        title="Incoming dependency"
    )
    knobs: list[KnobModel] = SettingsField(
        default_factory=list,
        title="Knobs",
    )

    @validator("knobs")
    def ensure_unique_names(cls, value):
        """Ensure name fields within the lists have unique names."""
        ensure_unique_names(value)
        return value

ensure_unique_names(value)

Ensure name fields within the lists have unique names.

Source code in server/settings/publish_plugins.py
60
61
62
63
64
@validator("knobs")
def ensure_unique_names(cls, value):
    """Ensure name fields within the lists have unique names."""
    ensure_unique_names(value)
    return value

ReformatNodesConfigModel

Bases: BaseSettingsModel

Only reposition nodes supported.

You can add multiple reformat nodes and set their knobs. Order of reformat nodes is important. First reformat node will be applied first and last reformat node will be applied last.

Source code in server/settings/publish_plugins.py
126
127
128
129
130
131
132
133
134
135
136
137
class ReformatNodesConfigModel(BaseSettingsModel):
    """Only reposition nodes supported.

    You can add multiple reformat nodes and set their knobs.
    Order of reformat nodes is important. First reformat node will
    be applied first and last reformat node will be applied last.
    """
    enabled: bool = SettingsField(False)
    reposition_nodes: list[ReformatNodesRepositionNodes] = SettingsField(
        default_factory=list,
        title="Reposition knobs"
    )

nuke_export_formats_enum()

Return all nuke export format available in creators.

Source code in server/settings/publish_plugins.py
35
36
37
38
39
40
def nuke_export_formats_enum():
    """Return all nuke export format available in creators."""
    return [
        {"value": "abc", "label": "Alembic"},
        {"value": "fbx", "label": "FBX"},    
    ]

nuke_product_types_enum()

Return all nuke families available in creators.

Source code in server/settings/publish_plugins.py
24
25
26
27
28
29
30
31
32
def nuke_product_types_enum():
    """Return all nuke families available in creators."""
    return [
        {"value": "nukenodes", "label": "Nukenodes"},
        {"value": "model", "label": "Model"},
        {"value": "camera", "label": "Camera"},
        {"value": "gizmo", "label": "Gizmo"},
        {"value": "source", "label": "Source"}
    ] + nuke_render_publish_types_enum()

nuke_render_publish_types_enum()

Return all nuke render families available in creators.

Source code in server/settings/publish_plugins.py
15
16
17
18
19
20
21
def nuke_render_publish_types_enum():
    """Return all nuke render families available in creators."""
    return [
        {"value": "render", "label": "Render"},
        {"value": "prerender", "label": "Prerender"},
        {"value": "image", "label": "Image"}
    ]