<StructInstanceArrayNode> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyType » Node » VariableNode » VariableArrayNode » StructInstanceArrayNode

Function Members

Function members are as follows:

Return Type Function Name Documentation
<Node>FindStructDeclarationReturns a pointer to the <StructNode> used by the <StructInstanceArrayNode>, or a nullptr if the declaration has not been set or cannot be found.
<TypeBuffer>GetMembersReturns a pointer to a <TypeBuffer> with pointers to the <DataCapture> objects
int32IsDeclaredReturns true if the <StructInstanceArrayNode> refers to a <StructNode> that determines the type of struct expression it forms.
int32SetDeclarationForms a relationship between the <StructInstanceArrayNode> and the <StructNode> for which it is a variable. For example, given the expression 'struct S { vec3 v; };' and the expression 'S s', 's[4]' is represented by the <StructInstanceArrayNode> and 'S' is the <StructNode>. This function configures the <StructInstanceArrayNode> object's underlying <NodeSelector> object to refer to the <StructNode> ( whether it is in the same document or in a remote document ). Requires the <StructInstanceArrayNode> to have been added to a Model via Model.AddNode(), and the Model must have been saved at least once ( because it must have a valid filename ).

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
<NodeSelector>DeclarationSelectorReturns a pointer to the <StructInstanceArrayNode> object's <NodeSelector> object, which is the object that implements and manages the relationship between the <StructInstanceArrayNode> and the <StructNode> of which it is an instance.
<StructInstanceArrayLayout>LayoutReturns a pointer to this object's underlying <StructInstanceLayout> object.
<Node>StructDeclarationGets or sets a pointer to the <StructNode> referred to by the <StructInstanceArrayNode>. This <StructNode> must be in the local document. To make a <StructInstanceArrayNode> refer to a <StructNode> in a remote document, use the data interface SetDeclaration().
<Node>StructDeclarationLinkGets or sets a pointer to the <StructNode> referred to by the <StructInstanceArrayNode>. 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.
stringStructTypeNameGets or sets the struct type name.