Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » Node » VariableNode » VariableArrayNode » StructInstanceNode |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| <Node> | FindStructDeclaration | Returns a pointer to the <StructNode> used by the <StructInstanceNode>, or a nullptr if the declaration has not been set or cannot be found. |
| <TypeBuffer> | GetMembers | Returns a pointer to a <TypeBuffer> with pointers to the <DataCapture> objects |
| int32 | IsDeclared | Returns true if the <StructInstanceNode> is connected to a <StructNode> of which the <StructInstanceNode> is an instance. |
| int32 | SetDeclaration | Forms a relationship between the <StructInstanceNode> and the <StructNode> for which it is a variable. For example, given the expression 'struct S { vec3 v; };' and the expression 'S s', 's' is represented by the <StructInstanceNode> and 'S' is the <StructNode>. This function configures the <StructInstanceNode> object's underlying <NodeSelector> object to refer to the <StructNode> ( whether it is in the same document or in a remote document ). Requires the <StructInstanceNode> to have been added to a <Model3D> via Model3D.AddNode(), and the <Model3D> must have been saved at least once ( because it must have a valid filename ). |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <NodeSelector> | DeclarationSelector | Returns a pointer to the <StructInstanceNode> object's <NodeSelector> object, which is the object that implements and manages the relationship between the <StructInstanceNode> and the <StructNode> of which it is an instance. |
| <StructInstanceLayout> | Layout | Returns a pointer to this object's underlying <StructInstanceLayout> object. |
| <Node> | StructDeclaration | Gets or sets a pointer to the <StructNode> referred to by the <StructInstanceNode>. This <StructNode> must be in the local document. To make a <StructInstanceNode> refer to a <StructNode> in a remote document, use the data interface SetDeclaration(). |
| <Node> | StructDeclarationLink | Gets or sets a pointer to the <StructNode> referred to by the <StructInstanceNode>. Unlike .StructDeclaration(), this data interface allows you to specify a <NodeLink> that refers to a <StructNode>. The <NodeLink> may refer to a <StructNode> in any local or remote document. |
| string | StructTypeName | Gets or sets the struct type name. |