Node

A node in the Inochi2D rendering tree

@TypeId("Node")

class Node : ISerializable {

Transform offsetTransform;

float offsetSort;

void resetMask();

void serializeSelf(InochiSerializer serializer);

void serializeSelf(InochiSerializerCompact serializer);

bool enabled;

bool renderEnabled();

const(char)* cName();

string typeId();

float relZSort();

float zSortBase();

float zSortNoOffset();

float zSort();

void zSort(float value);

bool lockToRoot();

void lockToRoot(bool value);

this(Puppet puppet);

this(Node parent);

this(uint uuid, Node parent);

Transform localTransform;

Transform globalTransform;

bool recalculateTransform;

Transform transform();

Transform transformNoLock();

void setRelativeTo(Node to);

void setRelativeTo(mat4 to);

static vec3 getRelativePosition(mat4 m1, mat4 m2);

string getNodePath();

Node[] children();

Node parent();

Puppet puppet();

void clearChildren();

void addChild(Node child);

void parent(Node node);

ptrdiff_t getIndexInParent();

ptrdiff_t getIndexInNode(Node n);

enum OFFSET_START;

enum OFFSET_END;

void insertInto(Node node, size_t offset);

bool hasParam(string key);

float getDefaultValue(string key);

bool setValue(string key, float value);

float scaleValue(string key, float value, int axis, float scale);

void drawOne();

void finalize();

void beginUpdate();

void update();

void transformChanged();

string toString();

void serialize(S serializer);

SerdeException deserializeFromFghj(Fghj data);

void forceSetUUID(uint uuid);

vec4 getCombinedBounds();

bool canReparent(Node to);

void drawOrientation();

void drawBounds();

}

Constructors

this this(Puppet puppet): Constructs a new puppet root node
this this(Node parent): Constructs a new node
this this(uint uuid, Node parent): Constructs a new node with an UUID

Members

Functions

addChild void addChild(Node child): Adds a node as a child of this node.
beginUpdate void beginUpdate(): Undocumented in source. Be warned that the author may not have intended to support it.
cName const(char)* cName(): Name of node as a null-terminated C string
canReparent bool canReparent(Node to): Gets whether nodes can be reparented
children Node[] children(): Gets a list of this node's children
clearChildren void clearChildren(): Removes all children from this node
depth int depth(): Gets the depth of this node
deserializeFromFghj SerdeException deserializeFromFghj(Fghj data): Deserializes node from Fghj formatted JSON data.
draw void draw(): Draws this node and it's subnodes
drawBounds void drawBounds(): Draws bounds
drawOne void drawOne(): Draws this node.
drawOrientation void drawOrientation(): Draws orientation of the node
finalize void finalize(): Finalizes this node and any children
forceSetUUID void forceSetUUID(uint uuid): Force sets the node's ID
getCombinedBounds vec4 getCombinedBounds(): Gets the combined bounds of the node
getDefaultValue float getDefaultValue(string key): Gets the default offset value
getIndexInNode ptrdiff_t getIndexInNode(Node n): Undocumented in source. Be warned that the author may not have intended to support it.
getIndexInParent ptrdiff_t getIndexInParent(): Undocumented in source. Be warned that the author may not have intended to support it.
getNodePath string getNodePath(): Gets the path to the node.
hasParam bool hasParam(string key): Return whether this node supports a parameter
insertInto void insertInto(Node node, size_t offset): Undocumented in source. Be warned that the author may not have intended to support it.
lockToRoot bool lockToRoot(): Lock translation to root
lockToRoot void lockToRoot(bool value): Lock translation to root
parent Node parent(): Gets the parent of this node
parent void parent(Node node): Sets the parent of this node
puppet Puppet puppet(): The puppet this node is attached to
relZSort float relZSort(): Gets the relative Z sorting
renderEnabled bool renderEnabled(): Whether the node is enabled for rendering
resetMask void resetMask(): Undocumented in source. Be warned that the author may not have intended to support it.
scaleValue float scaleValue(string key, float value, int axis, float scale): Scale an offset value, given an axis and a scale
serialize void serialize(S serializer): Allows serializing a node (with pretty serializer)
serializeSelf void serializeSelf(InochiSerializer serializer): Undocumented in source. Be warned that the author may not have intended to support it.
serializeSelf void serializeSelf(InochiSerializerCompact serializer): Undocumented in source. Be warned that the author may not have intended to support it.
setPuppet void setPuppet(Puppet puppet): Needed for deserialization
setRelativeTo void setRelativeTo(Node to): Calculates the relative position between 2 nodes and applies the offset. You should call this before reparenting nodes.
setRelativeTo void setRelativeTo(mat4 to): Calculates the relative position between this node and a matrix and applies the offset. This does not handle zSorting. Pass a Node for that.
setValue bool setValue(string key, float value): Sets offset value
toString string toString(): Undocumented in source. Be warned that the author may not have intended to support it.
transform Transform transform(): The transform in world space
transformChanged void transformChanged(): Marks this node's transform (and its descendents') as dirty
transformNoLock Transform transformNoLock(): The transform in world space without locking
typeId string typeId(): This node's type ID
update void update(): Updates the node
uuid uint uuid(): Returns the unique identifier for this node
zSort float zSort(): Gets the Z sorting
zSort void zSort(float value): Sets the (relative) Z sorting
zSortBase float zSortBase(): Gets the basis zSort offset.
zSortNoOffset float zSortNoOffset(): Gets the Z sorting without parameter offsets

Manifest constants

OFFSET_END enum OFFSET_END;: Undocumented in source.
OFFSET_START enum OFFSET_START;: Undocumented in source.

Static functions

getRelativePosition vec3 getRelativePosition(mat4 m1, mat4 m2): Gets a relative position for 2 matrices

Variables

enabled bool enabled;: Whether the node is enabled
globalTransform Transform globalTransform;: The cached world space transform of the node
localTransform Transform localTransform;: The local transform of the node
name string name;: Visual name of the node
offsetSort float offsetSort;: The offset to apply to sorting
offsetTransform Transform offsetTransform;: The offset to the transform to apply
recalculateTransform bool recalculateTransform;: Undocumented in source.

Inherited Members

From ISerializable

serialize void serialize(S serializer): Custom serializer function

Meta

Source

See Implementation

inochi2d core nodes modules

classes

Node

functions

manifest constants

InInvalidUUID

mixin templates

InNode