CompositorNodeBoxMask(CompositorNode)¶

base classes — bpy_struct, Node, NodeInternal, CompositorNode

class bpy.types.CompositorNodeBoxMask(CompositorNode)¶

Create rectangular mask suitable for use as a simple matte

mask_height¶

Height of the box

Type:: float in [0, 2], default 0.2

mask_type¶

Type:: enum in [‘ADD’, ‘SUBTRACT’, ‘MULTIPLY’, ‘NOT’], default ‘ADD’

mask_width¶

Width of the box

Type:: float in [0, 2], default 0.3

rotation¶

Rotation angle of the box

Type:: float in [-31.4159, 31.4159], default 0.0

X position of the middle of the box

Type:: float in [-1, 2], default 0.5

Y position of the middle of the box

Type:: float in [-1, 2], default 0.5

classmethod is_registered_node_type()¶

True if a registered node type

Returns:: Result
Return type:: boolean

classmethod input_template(index)¶

Input socket template

Parameters:: index (int in [0, inf]) – Index
Returns:: result
Return type:: NodeInternalSocketTemplate

classmethod output_template(index)¶

Output socket template

Parameters:: index (int in [0, inf]) – Index
Returns:: result
Return type:: NodeInternalSocketTemplate

update()¶

classmethod bl_rna_get_subclass(id, default=None)¶

Parameters:: id (str) – The RNA type identifier.
Returns:: The RNA type or default when not found.
Return type:: bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)¶

Parameters:: id (str) – The RNA type identifier.
Returns:: The class or default when not found.
Return type:: type

Inherited Functions¶