Skip to content

create_plugins

CreateWriteImageModel

Bases: BaseSettingsModel

Source code in server/settings/create_plugins.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
class CreateWriteImageModel(BaseSettingsModel):
    enabled: bool = SettingsField(
        True,
        title="Enabled",
        description="Enable or disable the plugin"
    )
    order: int = SettingsField(
        100,
        title="Order",
        description="Order of the plugin in the list"
    )
    temp_rendering_path_template: str = SettingsField(
        title="Temporary rendering path template"
    )
    default_variants: list[str] = SettingsField(
        title="Default variants",
        default_factory=list
    )
    instance_attributes: list[str] = SettingsField(
        default_factory=list,
        enum_resolver=instance_attributes_enum,
        title="Instance attributes"
    )
    render_target: str = SettingsField(
        enum_resolver=render_target_enum,
        conditional_enum=True,
        title="Render target",
        description=RENDER_TARGET_DESCRIPTION,
    )
    exposed_knobs: list[str] = SettingsField(
        title="Write Node Exposed Knobs",
        default_factory=list
    )
    prenodes: list[PrenodeModel] = SettingsField(
        default_factory=list,
        title="Preceding nodes",
        description=PRENODES_LIST_DESCRIPTION,
    )

    @validator("prenodes")
    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/create_plugins.py 
229
230
231
232
233
@validator("prenodes")
def ensure_unique_names(cls, value):
    """Ensure name fields within the lists have unique names."""
    ensure_unique_names(value)
    return value

CreateWritePrerenderModel

Bases: BaseSettingsModel

Source code in server/settings/create_plugins.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
class CreateWritePrerenderModel(BaseSettingsModel):
    enabled: bool = SettingsField(
        True,
        title="Enabled",
        description="Enable or disable the plugin"
    )
    order: int = SettingsField(
        100,
        title="Order",
        description="Order of the plugin in the list"
    )
    temp_rendering_path_template: str = SettingsField(
        title="Temporary rendering path template"
    )
    default_variants: list[str] = SettingsField(
        title="Default variants",
        default_factory=list
    )
    instance_attributes: list[str] = SettingsField(
        default_factory=list,
        enum_resolver=instance_attributes_enum,
        title="Instance attributes",
        description = INSTANCE_ATTRIBUTES_DESCRIPTION
    )
    render_target: str = SettingsField(
        enum_resolver=render_target_enum,
        conditional_enum=True,
        title="Render target",
        description=RENDER_TARGET_DESCRIPTION,
    )
    exposed_knobs: list[str] = SettingsField(
        title="Write Node Exposed Knobs",
        default_factory=list
    )
    prenodes: list[PrenodeModel] = SettingsField(
        default_factory=list,
        title="Preceding nodes",
        description=PRENODES_LIST_DESCRIPTION,
    )

    @validator("prenodes")
    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/create_plugins.py 
183
184
185
186
187
@validator("prenodes")
def ensure_unique_names(cls, value):
    """Ensure name fields within the lists have unique names."""
    ensure_unique_names(value)
    return value

CreateWriteRenderModel

Bases: BaseSettingsModel

Source code in server/settings/create_plugins.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
class CreateWriteRenderModel(BaseSettingsModel):
    enabled: bool = SettingsField(
        True,
        title="Enabled",
        description="Enable or disable the plugin"
    )
    order: int = SettingsField(
        100,
        title="Order",
        description="Order of the plugin in the list"
    )
    temp_rendering_path_template: str = SettingsField(
        title="Temporary rendering path template"
    )
    default_variants: list[str] = SettingsField(
        title="Default variants",
        default_factory=list
    )
    instance_attributes: list[str] = SettingsField(
        default_factory=list,
        enum_resolver=instance_attributes_enum,
        title="Instance attributes",
        description=INSTANCE_ATTRIBUTES_DESCRIPTION
    )
    render_target: str = SettingsField(
        enum_resolver=render_target_enum,
        conditional_enum=True,
        title="Render target",
        description=RENDER_TARGET_DESCRIPTION,
    )
    exposed_knobs: list[str] = SettingsField(
        title="Write Node Exposed Knobs",
        default_factory=list
    )
    prenodes: list[PrenodeModel] = SettingsField(
        default_factory=list,
        title="Preceding nodes",
        description=PRENODES_LIST_DESCRIPTION
    )

    @validator("prenodes")
    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/create_plugins.py 
136
137
138
139
140
@validator("prenodes")
def ensure_unique_names(cls, value):
    """Ensure name fields within the lists have unique names."""
    ensure_unique_names(value)
    return value

PrenodeModel

Bases: BaseSettingsModel

Source code in server/settings/create_plugins.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class PrenodeModel(BaseSettingsModel):
    name: str = SettingsField(
        title="Node name",
        description=(
            "Node name, use this as the name in 'Incoming dependency' on other"
            " preceding nodes if a connection is needed."
        )
    )

    nodeclass: str = SettingsField(
        "",
        title="Node class",
        description="Nuke node class (type) of the node to add."
    )
    dependent: str = SettingsField(
        "",
        title="Incoming dependency",
        description=(
            "Input node name of another preceding node that should"
            "come before this node."
        ),
    )

    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/create_plugins.py 
89
90
91
92
93
@validator("knobs")
def ensure_unique_names(cls, value):
    """Ensure name fields within the lists have unique names."""
    ensure_unique_names(value)
    return value

instance_attributes_enum()

Return create write instance attributes.

Source code in server/settings/create_plugins.py 
38
39
40
41
42
43
44
45
46
47
48
def instance_attributes_enum():
    """Return create write instance attributes."""
    return [
        {"value": "reviewable", "label": "Reviewable"},
        {"value": "farm_rendering", "label": "Farm rendering"},
        {"value": "use_range_limit", "label": "Use range limit"},
        {
            "value": "render_on_farm",
            "label": "Render On Farm"
        }
    ]

render_target_enum()

Return write render target enum.

Source code in server/settings/create_plugins.py 
51
52
53
54
55
56
57
58
def render_target_enum():
    """Return write render target enum."""
    return [
        {"value": "local", "label": "Local machine rendering"},
        {"value": "frames", "label": "Use existing frames"},
        {"value": "frames_farm", "label": "Use existing frames - farm"},
        {"value": "farm", "label": "Farm rendering"}
    ]