Houdini Engine 3.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
HAPI_NodeInfo Struct Reference

#include <HAPI_Common.h>

Public Attributes

HAPI_NodeId id
 
HAPI_NodeId parentId
 
HAPI_StringHandle nameSH
 
HAPI_NodeType type
 
HAPI_Bool isValid
 
int totalCookCount
 Total number of cooks of this node. More...
 
int uniqueHoudiniNodeId
 
HAPI_StringHandle internalNodePathSH
 
int parmCount
 
int parmChoiceCount
 
int childNodeCount
 
int inputCount
 The number of inputs this specific node has. More...
 
HAPI_Bool createdPostAssetLoad
 
int parmIntValueCount
 
int parmFloatValueCount
 
int parmStringValueCount
 

Detailed Description

Definition at line 875 of file HAPI_Common.h.

Member Data Documentation

int HAPI_NodeInfo::childNodeCount

The number of child nodes. This is 0 for all nodes that are not node networks.

Definition at line 919 of file HAPI_Common.h.

HAPI_Bool HAPI_NodeInfo::createdPostAssetLoad

Nodes created via scripts or via HAPI_CreateNode() will be have this set to true. Only such nodes can be deleted using HAPI_DeleteNode().

Definition at line 927 of file HAPI_Common.h.

HAPI_NodeId HAPI_NodeInfo::id

Definition at line 877 of file HAPI_Common.h.

int HAPI_NodeInfo::inputCount

The number of inputs this specific node has.

Definition at line 922 of file HAPI_Common.h.

HAPI_StringHandle HAPI_NodeInfo::internalNodePathSH

This is the internal node path in the Houdini scene graph. This path is meant to be abstracted away for most client purposes but for advanced uses it can come in handy.

Definition at line 898 of file HAPI_Common.h.

HAPI_Bool HAPI_NodeInfo::isValid

Always true unless the asset's definition has changed due to loading a duplicate asset definition and from another OTL asset library file OR deleting the OTL asset library file used by this node's asset.

Definition at line 885 of file HAPI_Common.h.

HAPI_StringHandle HAPI_NodeInfo::nameSH

Definition at line 879 of file HAPI_Common.h.

HAPI_NodeId HAPI_NodeInfo::parentId

Definition at line 878 of file HAPI_Common.h.

int HAPI_NodeInfo::parmChoiceCount

The total number of choices among all the combo box parameters. See Choice Lists.

Definition at line 915 of file HAPI_Common.h.

int HAPI_NodeInfo::parmCount

Total number of parameters this asset has exposed. Includes hidden parameters. See Parameters.

Definition at line 903 of file HAPI_Common.h.

int HAPI_NodeInfo::parmFloatValueCount

Number of values. A single parameter may have more than one value so this number is more than or equal to HAPI_NodeInfo::parmCount.

Definition at line 909 of file HAPI_Common.h.

int HAPI_NodeInfo::parmIntValueCount

Number of values. A single parameter may have more than one value so this number is more than or equal to HAPI_NodeInfo::parmCount.

Definition at line 908 of file HAPI_Common.h.

int HAPI_NodeInfo::parmStringValueCount

Number of values. A single parameter may have more than one value so this number is more than or equal to HAPI_NodeInfo::parmCount.

Definition at line 910 of file HAPI_Common.h.

int HAPI_NodeInfo::totalCookCount

Total number of cooks of this node.

Definition at line 888 of file HAPI_Common.h.

HAPI_NodeType HAPI_NodeInfo::type

Definition at line 880 of file HAPI_Common.h.

int HAPI_NodeInfo::uniqueHoudiniNodeId

Use this unique id to grab the OP_Node pointer for this node. If you're linking against the C++ HDK, include the OP_Node.h header and call OP_Node::lookupNode().

Definition at line 893 of file HAPI_Common.h.


The documentation for this struct was generated from the following file: