SceneGraphNode

The base node class of nodes visible in space.

Parent: Node

Plugs

name	description	type	default	flags
transform	The object's local matrix.	M44f		in
world_transform	The object's world matrix.	M44f		out
inherits_transform	If true, the node inherits its parent world matrix, if false, it doesn't.	bool	true	in
show	If false, the node and its children will be hidden.	bool	true	in
visible	The node final visibility state. If true, is node is visible, if false, it's not.	bool	true	out
hovered	true if the node is hovered by the mouse.	bool	false	out

AnimLayer

Base class for the animation layer nodes. The AnimLayer contains the layer parameters. Those parameters are connected to the AnimLayerBlend nodes.

Parent: Node

Plugs

name	description	type	default	flags
nice_name	The layer name visible in the user interface.	string	"Animation Layer"	in
layer_id	The animation layer id. For internal use.	int	0	in
lock	Lock or unlock the animation layer. If true, the layer is locked, i-e, no new channel can be added to this layer.	bool	false	in
enable	Enable or disable the effect of the animation layer.	bool	true	in
mode	The mode (Additive, Negative, Blend, ...) of the animation layer. - 0 : Add. The channel values of this layer will be added to the previous layer values. - 1 : Substract. The channel values of this layer will be substracted from the previous layer values. - 2 : Blend. The channel values of this layer will replace the previous layer values.	int	0	in
weight	The weight of the animation layer. If the weight is 0, the animation layer has no effect. If the weight is 1, the animation is fully enabled.	float	1	in
color	The color of the animation layer.	Color	(0, 0, 0, 1)	in
reduced_keys	The set of keyframes present in this layer.	KeySet		out
layer_data	Return the data for the AnimationLayerBlend nodes.	Array		out

AnimLayerBlend

Internal node which blend a channel between two layers.

Parent: Node

Plugs

name	description	type	default	flags
layer_data	The animation layer parameters.	Array		in
input1	The first channel input.	Value		in
input2	The second channel input.	Value		in
output	Return the result of the Animation Layer Blend	Value		out

ConstraintLayer

A layer node which apply matrix constraints.

Parent: AnimLayer

Plugs

name	description	type	default	flags
target_world_transform	The world matrix of the target object	M44f		in
parent_world_transform	The world matrix of the parent of the constrained object	M44f		in
rotate_order	The Imath rotate order of the constrained object	int		in
tx	Constraint tx	bool	false	in
offset_tx	x translation offset	float	0	in
in_tx	Initial x translation	float	0	in
ty	Constraint ty	bool	false	in
offset_ty	y translation offset	float	0	in
in_ty	Initial y translation	float	0	in
tz	Constraint tz	bool	false	in
offset_tz	z translation offset	float	0	in
in_tz	Initial z translation	float	0	in
rx	Constraint rx	bool	false	in
offset_rx	x rotation offset	float	0	in
in_rx	Initial x rotation	float	0	in
ry	Constraint ry	bool	false	in
offset_ry	y rotation offset	float	0	in
in_ry	Initial y rotation	float	0	in
rz	Constraint rz	bool	false	in
offset_rz	z rotation offset	float	0	in
in_rz	Initial z rotation	float	0	in
sx	Constraint sx	bool	false	in
offset_sx	x scale offset	float	1	in
in_sx	Initial x scale	float	1	in
sy	Constraint sy	bool	false	in
offset_sy	y scale offset	float	1	in
in_sy	Initial y scale	float	1	in
sz	Constraint sz	bool	false	in
offset_sz	z scale offset	float	1	in
in_sz	Initial z scale	float	1	in
in_pre_rotate	Pre Rotate Constant	v3f		in
in_post_roate	Post Rotate Constant	v3f		in
offset	The offset matrix	M44f		out
out	For internal usage.	M44f		out
out_tx	Return new x translation.	float		out
out_tx	Return new y translation.	float		out
out_tx	Return new z translation.	float		out
out_tx	Return new x rotation.	float		out
out_tx	Return new y rotation.	float		out
out_tx	Return new z rotation.	float		out
out_tx	Return new x scale.	float		out
out_tx	Return new y scale.	float		out
out_tx	Return new z scale.	float		out

EvalSurface

Evaluate surface positions, normals, tangents and derivatives for specific parameters.

Parent: Node

Plugs

name	description	type	default	flags
surface	The input nurbs surface.	NurbsSurface		in
parameters	The surface parameters where the evaluation is done.	V2f	(0, 0)	in
position	The surface position at the parameter.	V3f		out
normal	The normalized surface normal at the parameter.	V3f		out
tangent_u	The normalized surface u tangent at the parameter.	V3f		out
tangent_v	The normalized surface v tangent at the parameter.	V3f		out
du	The surface u derivative at the parameter.	V3f		out
dv	The surface v derivative at the parameter.	V3f		out

GetArray

Return the array value at the specified index.

Parent: Node

Plugs

name	description	type	default	flags
array	The input array.	Array		in
index	The index of the array element to return. If the index is invalid, the node returns a default Value object.	int	0	in
value	The array value at the specified index or a default Value object if the index is invalid.	Value		out

GetDict

Return the dict value at the specified key.

Parent: Node

Plugs

name	description	type	default	flags
dict	The input dict.	Dict		in
key	The key of the dict element to return. If the key is invalid, the node returns a default Value object.	string		in
value	The dict value at the specified key or a default Value object if the key is invalid.	Value		out

IsoCurve

Extract an iso curve from a nurbs surface.

Parent: Node

Plugs

name	description	type	default	flags
surface_in	The input nurbs surface.	NurbsSurface		in
u	The parameter on the surface where to extract the curve.	float	0	in
use_v	If true, use the u parameter, else use the v parameter.	bool	false	in
curve_out	The extracted nurbs curve.	NurbsCurve		out

Lerp

Perform a linear interpolation on numerical values. Returns input1*(1-weight)+input2*(weight).

Parent: Node

Plugs

name	description	type	default	flags
weight	The weight of the interpolation.	float	0	in
input1	The first float input.	float	0	in
input2	The second float input.	float	0	in
v3f_input1	The first V3f input.	V3f	0	in
v3f_input2	The second V3f input.	V3f	0	in
output	Return the result of the interpolation on floats.	float		out
V3f_output	Return the result of the interpolation on V3f.	V3f		out

MakeArray

Build an array of values. The array plug has dependencies on the node dynamic plugs. It returns those plug values in an Array value.

Parent: node

Plugs

name	description	type	default	flags
array	The built array	Array		out

MakeDict

Build a dictionnary of values. The dict plug has dependencies on the node dynamic plugs. It returns those plug values in a Dict value. The keys plug describes the string keys used to index the values in the dictionnary.

Parent: Node

Plugs

name	description	type	default	flags
keys	The dictionnary keys list. The list is a semi-colon separated strings. For every dynamic plug in dependence on the dict plug providing a dictionnary value, a string in this list specifies the value key, assuming the order in the list and in the dependencies is the same. The accepted separators are ";,\n".	string	""	in
dict	The built dict.	Dict		out

MakeSparseBuffer

Build a sparse buffer. The array plug has dependencies on the node dynamic plugs.

Parent: Node

Plugs

name	description	type	default	flags
output		Value		out

Reference

This node is a place hodler for unloaded reference files. It keeps the path to the original reference file and the value and the connections of its plugs.

Parent: Node

Plugs

name	description	type	default	flags
file	The original reference file name.	String		in
edits	Reference edits	Dict		in

RemoveAttribute

Remove a shape attribute. This attribute can be per-vertex (vertex), per-face (face) or per-face-corner (face_varying).

The attribute must be provided through a BufferXXX value, like a BufferFloat or a BufferV3f.

The buffer size must fit the geometry topology size.

Parent: Node

Plugs

name	description	type	default	flags
points_in	The input geometry into which the attribute must be set.	Shape		in
attribute_name	The attribute name	string	"attribute"	in
topology	The new attribute topology. constant(0): the value must be is constant. It can be any type of value. vertex(1): the value must be is a per-vertex buffer. face(2): The value must be is a per-face buffer. face_varying(3): The value must be is a per-face-corner buffer.	int	0	in
points_out	Returns the points_in geometry with the new attribute added if the attribute match the geometry topology. If not, the points_in geometry is returned, unchanged.	Points		out

SelectionSet

A node selection set.

Parent: Node

Plugs

name	description	type	default	flags
content	The content of the selection set	string	""	in

SetAttribute

Add or replace a geometry attribute. This attribute can be per-vertex (vertex), per-face (face) or per-face-corner (face_varying).

The attribute must be provided through a BufferXXX value, like a BufferFloat or a BufferV3f.

The buffer size must fit the geometry topology size.

Parent: Node

Plugs

name	description	type	default	flags
points_in	The input shape into which the attribute must be set.	Shape		in
attribute_name	The attribute name	string	"attribute"	in
topology	The new shape topology. constant(0): the value must be is constant. It can be any type of value. vertex(1): the value must be is a per-vertex buffer. face(2): The value must be is a per-face buffer. face_varying(3): The value must be is a per-face-corner buffer.	int	0	in
value	The new attribute value. Must be a buffer Value, like a BufferFloat or a BufferV3f.	Value		in
points_out	Returns the points_in geometry with the new attribute added if the attribute match the geometry topology. If not, the points_in geometry is returned, unchanged.	Points		out

ShapeAttribute

Retrieve an attribute from a Shape object. This attribute can be constant, per-vertex (vertex), per-face (face) or per-face-corner (face_varying).

Parent: Node

Plugs

name	description	type	default	flags
shape	The input Shape object where the attribute is set.	Shape		in
attribute_name	The attribute name	string	"attribute"	in
topology	The attribute topology. constant(0): the value is a constant. vertex(1): the value is a per-vertex buffer. face(2): The value is a per-face buffer. face_varying(3): The value is a per-face-corner buffer.	int	0	in
value	Returns the value if the attribute has been found in the good topology, or returns a default Value.	Value		out

SurfaceInfo

Query the nurbs surface information.

Parent: Node

Plugs

name	description	type	default	flags
surface	The input nurbs surface.	NurbsSurface		in
range_u	The surface u parameter range. x is min, y is max.	V2f		out
range_v	The surface v parameter range. x is min, y is max.	V2f		out

TransformGeometry

Transform the geometry points using a matrix.

Parent: Node

Plugs

name	description	type	default	flags
points_in	The input geometry.	Points		in
matrix	The matrix to apply on the geometry vertices.	M44f		in
points_out	The output geometry with the transformed points.	M44f		out