Houdini Engine 3.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
HAPI_Common.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  */
7 
8 #ifndef __HAPI_COMMON_h__
9 #define __HAPI_COMMON_h__
10 
11 #include "HAPI_API.h"
12 
13 /////////////////////////////////////////////////////////////////////////////
14 // Defines
15 
16 #define HAPI_POSITION_VECTOR_SIZE 3
17 #define HAPI_SCALE_VECTOR_SIZE 3
18 #define HAPI_SHEAR_VECTOR_SIZE 3
19 #define HAPI_NORMAL_VECTOR_SIZE 3
20 #define HAPI_QUATERNION_VECTOR_SIZE 4
21 #define HAPI_EULER_VECTOR_SIZE 3
22 #define HAPI_UV_VECTOR_SIZE 2
23 #define HAPI_COLOR_VECTOR_SIZE 4
24 #define HAPI_CV_VECTOR_SIZE 4
25 
26 #define HAPI_PRIM_MIN_VERTEX_COUNT 1
27 #define HAPI_PRIM_MAX_VERTEX_COUNT 16
28 
29 #define HAPI_INVALID_PARM_ID -1
30 
31 /// Common Default Attributes' Names
32 /// @{
33 #define HAPI_ATTRIB_POSITION "P"
34 #define HAPI_ATTRIB_UV "uv"
35 #define HAPI_ATTRIB_UV2 "uv2"
36 #define HAPI_ATTRIB_NORMAL "N"
37 #define HAPI_ATTRIB_TANGENT "tangentu"
38 #define HAPI_ATTRIB_TANGENT2 "tangentv"
39 #define HAPI_ATTRIB_COLOR "Cd"
40 #define HAPI_ATTRIB_NAME "name"
41 #define HAPI_ATTRIB_INSTANCE "instance"
42 /// @}
43 
44 /// This is the name of the primitive group created from all the primitives
45 /// that are not in any user-defined group. This way, when you put all the
46 /// groups together you cover the entire mesh. This is important for some
47 /// clients where the mesh has to be defined in terms of submeshes that cover
48 /// the entire original mesh.
49 #define HAPI_UNGROUPED_GROUP_NAME "__ungrouped_group"
50 
51 /// Common image file format names (to use with the material extract APIs).
52 /// Note that you may still want to check if they are supported via
53 /// HAPI_GetSupportedImageFileFormats() since all formats are loaded
54 /// dynamically by Houdini on-demand so just because these formats are defined
55 /// here doesn't mean they are supported in your instance.
56 /// @{
57 #define HAPI_RAW_FORMAT_NAME "HAPI_RAW" // HAPI-only Raw Format
58 #define HAPI_PNG_FORMAT_NAME "PNG"
59 #define HAPI_JPEG_FORMAT_NAME "JPEG"
60 #define HAPI_BMP_FORMAT_NAME "Bitmap"
61 #define HAPI_TIFF_FORMAT_NAME "TIFF"
62 #define HAPI_TGA_FORMAT_NAME "Targa"
63 /// @}
64 
65 /// Default image file format's name - used when the image generated and has
66 /// no "original" file format and the user does not specify a format to
67 /// convert to.
68 #define HAPI_DEFAULT_IMAGE_FORMAT_NAME HAPI_PNG_FORMAT_NAME
69 
70 /// Name of subnet OBJ node containing the global nodes.
71 #define HAPI_GLOBAL_NODES_NODE_NAME "GlobalNodes"
72 
73 /// Environment variables.
74 #define HAPI_ENV_HIP "HIP"
75 #define HAPI_ENV_JOB "JOB"
76 #define HAPI_ENV_CLIENT_NAME "HAPI_CLIENT_NAME"
77 
78 /// [HAPI_CACHE]
79 /// Common cache names. You can see these same cache names in the
80 /// Cache Manager window in Houdini (Windows > Cache Manager).
81 #define HAPI_CACHE_COP_COOK "COP Cook Cache"
82 #define HAPI_CACHE_COP_FLIPBOOK "COP Flipbook Cache"
83 #define HAPI_CACHE_IMAGE "Image Cache"
84 #define HAPI_CACHE_OBJ "Object Transform Cache"
85 #define HAPI_CACHE_GL_TEXTURE "OpenGL Texture Cache"
86 #define HAPI_CACHE_GL_VERTEX "OpenGL Vertex Cache"
87 #define HAPI_CACHE_SOP "SOP Cache"
88 #define HAPI_CACHE_VEX "VEX File Cache"
89 /// [HAPI_CACHE]
90 
91 // Make sure our enums and structs are usable without those keywords, as-is,
92 // in C.
93 #ifdef __cplusplus
94  #define HAPI_C_ENUM_TYPEDEF( enum_name )
95  #define HAPI_C_STRUCT_TYPEDEF( struct_name )
96 #else
97  #define HAPI_C_ENUM_TYPEDEF( enum_name ) \
98  typedef enum enum_name enum_name;
99  #define HAPI_C_STRUCT_TYPEDEF( struct_name ) \
100  typedef struct struct_name struct_name;
101 #endif // __cplusplus
102 
103 /////////////////////////////////////////////////////////////////////////////
104 // Typedefs
105 
106 // C has no bool.
107 #ifdef __cplusplus
108  typedef bool HAPI_Bool;
109 #else
110  typedef char HAPI_Bool;
111 #endif // __cplusplus
112 
113 // x-bit Integers
114 // Thrift doesn't support unsigned integers, so we cast it as a 16-bit int, but only
115 // for automated code generation
116 #ifdef HAPI_AUTOGEN
117  typedef signed char int8_t;
118  typedef short int16_t;
119  typedef long long int64_t;
120  typedef short HAPI_UInt8; // 16-bit type for thrift
121 #else
122  #include <stdint.h>
123  #ifdef HAPI_THRIFT_ABI
124  typedef int16_t HAPI_UInt8;
125  #else
126  typedef uint8_t HAPI_UInt8;
127  HAPI_STATIC_ASSERT(sizeof(HAPI_UInt8) == 1, unsupported_size_of_uint8);
128  #endif
129 #endif
130 
131 typedef int8_t HAPI_Int8;
132 HAPI_STATIC_ASSERT(sizeof(HAPI_Int8) == 1, unsupported_size_of_int8);
133 typedef int16_t HAPI_Int16;
134 HAPI_STATIC_ASSERT(sizeof(HAPI_Int16) == 2, unsupported_size_of_int16);
135 typedef int64_t HAPI_Int64;
136 HAPI_STATIC_ASSERT(sizeof(HAPI_Int64) == 8, unsupported_size_of_long);
137 
138 
139 // The process id has to be uint on Windows and int on any other platform.
140 #if ( defined _WIN32 || defined WIN32 )
141  typedef unsigned int HAPI_ProcessId;
142 #else
143  typedef int HAPI_ProcessId;
144 #endif
145 
146 /// Has to be 64-bit.
147 typedef HAPI_Int64 HAPI_SessionId;
148 
149 /// Use this with HAPI_GetString() to get the value.
150 /// See @ref HAPI_Fundamentals_Strings.
151 typedef int HAPI_StringHandle;
152 
154 
155 /// See @ref HAPI_Nodes_Basics.
156 typedef int HAPI_NodeId;
157 
158 /// Either get this from the ::HAPI_ParmInfo or ::HAPI_GetParmIdFromName().
159 /// See @ref HAPI_Parameters.
160 typedef int HAPI_ParmId;
161 
162 /// Use this with ::HAPI_GetPartInfo().
163 /// See @ref HAPI_Parts.
164 typedef int HAPI_PartId;
165 
166 /// Use this with PDG functions
168 
169 /// Use this with PDG functions
171 
172 /// When we load a HIP file, we associate a HIP file ID with the created nodes
173 /// so that they can be looked up later
174 typedef int HAPI_HIPFileId;
175 
176 /////////////////////////////////////////////////////////////////////////////
177 // Enums
178 
180 {
188 };
190 
192 {
197 };
199 
201 {
205 
206  /// Used for Results. Equivalent to ::HAPI_STATUSVERBOSITY_2
208  /// Used for Results. Equivalent to ::HAPI_STATUSVERBOSITY_0
210  /// Used for Results. Equivalent to ::HAPI_STATUSVERBOSITY_1
212  /// Used for Results. Equivalent to ::HAPI_STATUSVERBOSITY_2
214 };
216 
218 {
230 
237 
240 
242 
244 };
246 
248 {
251 };
253 typedef int HAPI_ErrorCodeBits;
254 
256 {
263 };
265 
267 {
268  /// Everything cook successfully without errors
270  /// You should abort the cook.
272  /// Only some objects failed.
279 
281 };
283 
285 {
291 };
293 
295 {
301 };
303 
305 {
310 };
312 
313 /// Represents the data type of a parm.
314 /// As you can see, some of these high level types share the same underlying
315 /// raw data type. For instance, both string and file parameter types can be
316 /// represented with strings, yet semantically they are different. We will
317 /// group high level parameter types that share an underlying raw data type
318 /// together, so you can always check the raw data type of a parameter based
319 /// on its high level data type by checking a range of values.
321 {
322  /// @{
327  /// }@
328 
329  /// @{
332  /// @}
333 
334  /// @{
339  /// @}
340 
342 
343  /// @{
346  /// @}
347 
348  /// @{
353  /// @}
354 
355  // Helpers
356 
357  /// Total number of supported parameter types.
359 
362 
365 
368 
371 
374 
377 
380 };
382 
383 /// Corresponds to the types as shown in the Houdini Type Properties
384 /// window and in DialogScript files. Available on HAPI_ParmInfo
385 /// See: <a href="http://www.sidefx.com/docs/houdini/ref/windows/optype.html#parmtypes">Parameter types</a>
386 ///
388 {
389  /// "int", "integer"
398  /// "toggle", "embed"
402  /// "vector", "vector3"
406  /// "intvector", "intvector3"
411  /// "dir", "direction"
413  /// "color", "rgb"
415  /// "color4", "rgba"
438 
439  /// The following apply to HAPI_PARMTYPE_FOLDER type parms.
440  /// Radio buttons Folder
442  /// Collapsible Folder
444  /// Simple Folder
446  /// Tabs Folder
448 };
450 
452 {
453  /// Parameter is not a menu
455  /// Menu Only, Single Selection
457  /// Mini Menu Only, Single Selection
459  /// Field + Single Selection Menu
461  /// Field + Multiple Selection Menu
463 };
465 
467 {
469  /// Just the presets binary blob
471  /// Presets blob within an .idx file format
474 };
476 
478 {
490 };
492 typedef int HAPI_NodeTypeBits;
493 
494 /// Flags used to filter compositions of node lists.
495 /// Flags marked 'Recursive Flag' will exclude children whos parent does not
496 /// satisfy the flag, even if the children themselves satisfy the flag.
498 {
501  /// Recursive Flag
503  /// Recursive Flag
510 
511  /// OBJ Node Specific Flags
516 
517  /// SOP Node Specific Flags
518  /// Looks for "curve"
520  /// Looks for Guide Geometry
522 
523  /// TOP Node Specific Flags
524  /// All TOP nodes except schedulers
526 
527 };
529 typedef int HAPI_NodeFlagsBits;
530 
532 {
537 };
539 
541 {
548 };
550 
552 {
558 };
560 
562 {
567 };
569 
571 {
579 };
581 
583 {
594 };
596 
598 {
600  /// Implicit type based on data
602  /// Position
604  /// Homogeneous position
606  /// Direction vector
608  /// Normal
610  /// Color
612  /// Quaternion
614  /// 3x3 Matrix
616  /// Matrix
618  /// Parametric interval
620  /// "Private" (hidden)
622  /// 2x2 Bounding box
624  /// 3x3 Bounding box
626  /// Texture coordinate
629 };
631 
633 {
635 
636  /// Most geos will be of this type which essentially means a geo
637  /// not of the other types.
639 
640  /// An exposed edit node.
641  /// See @ref HAPI_IntermediateAssetsResults.
643 
644  /// An input geo that can accept geometry from the host.
645  /// See @ref HAPI_AssetInputs_MarshallingGeometryIntoHoudini.
647 
648  /// A curve.
649  /// See @ref HAPI_Curves.
651 
653 };
655 
657 {
666 };
668 
670 {
675 };
677 
679 {
685 };
687 
689 {
703 };
705 
707 {
708  HAPI_TRS = 0,
714 
716 };
718 
720 {
721  HAPI_XYZ = 0,
727 
729 };
731 
733 {
741 
743 };
745 
747 {
749  HAPI_IMAGE_PACKING_SINGLE, /// Single Channel
750  HAPI_IMAGE_PACKING_DUAL, /// Dual Channel
752  HAPI_IMAGE_PACKING_BGR, /// RGB Reversed
754  HAPI_IMAGE_PACKING_ABGR, /// RGBA Reversed
756 
759 };
761 
762 /// Used with ::HAPI_GetEnvInt() to retrieve basic information
763 /// about the HAPI implementation currently being linked
764 /// against. Note that as of HAPI version 2.0, these enum values are
765 /// guaranteed never to change so you can reliably get this information from
766 /// any post-2.0 version of HAPI. The same goes for the actual
767 /// ::HAPI_GetEnvInt() API call.
769 {
771 
772  /// The three components of the Houdini version that HAPI is
773  /// expecting to link against.
774  /// @{
779  /// @}
780 
781  /// The two components of the Houdini Engine (marketed) version.
782  /// @{
785  /// @}
786 
787  /// This is a monotonously increasing API version number that can be used
788  /// to lock against a certain API for compatibility purposes. Basically,
789  /// when this number changes code compiled against the HAPI.h methods
790  /// might no longer compile. Semantic changes to the methods will also
791  /// cause this version to increase. This number will be reset to 0
792  /// every time the Houdini Engine version is bumped.
794 
796 };
798 
799 /// This enum is to be used with ::HAPI_GetSessionEnvInt() to retrieve basic
800 /// session-specific information.
802 {
804 
805  /// License Type. See ::HAPI_License.
807 
809 };
811 
812 /// Identifies a memory cache
814 {
815  /// Current memory usage in MB. Setting this to 0 invokes
816  /// a cache clear.
818 
819  HAPI_CACHEPROP_HAS_MIN, /// True if it actually has a minimum size.
820  HAPI_CACHEPROP_MIN, /// Min cache memory limit in MB.
821  HAPI_CACHEPROP_HAS_MAX, /// True if it actually has a maximum size.
822  HAPI_CACHEPROP_MAX, /// Max cache memory limit in MB.
823 
824  /// How aggressive to cull memory. This only works for:
825  /// - ::HAPI_CACHE_COP_COOK where:
826  /// 0 -> Never reduce inactive cache.
827  /// 1 -> Always reduce inactive cache.
828  /// - ::HAPI_CACHE_OBJ where:
829  /// 0 -> Never enforce the max memory limit.
830  /// 1 -> Always enforce the max memory limit.
831  /// - ::HAPI_CACHE_SOP where:
832  /// 0 -> When to Unload = Never
833  /// When to Limit Max Memory = Never
834  /// 1-2 -> When to Unload = Based on Flag
835  /// When to Limit Max Memory = Never
836  /// 3-4 -> When to Unload = Based on Flag
837  /// When to Limit Max Memory = Always
838  /// 5 -> When to Unload = Always
839  /// When to Limit Max Memory = Always
841 };
842 
844 
845 /// Type of sampling for heightfield
847 {
850 };
852 
853 /// Used with PDG functions
855 {
859 
861 };
863 
864 /// Used with PDG functions
866 {
867  /// An empty, undefined event. Should be ignored.
869 
870  /// Sent when a new work item is added by a node
872  /// Sent when a work item is deleted from a node
874  /// Sent when a work item's state changes
876 
877  /// Sent when a work item has a dependency added
879  /// Sent when a dependency is removed from a work item
881 
882  /// Sent from dynamic work items that generate from a cooked item
884  /// Sent when the parent item for a work item is deleted
886 
887  /// A node event that indicates that node is about to have all its work items cleared
889 
890  /// Sent when an error is issued by the node
892  /// Sent when an warning is issued by the node
894 
895  /// Sent for each node in the graph, when a cook completes
897 
898  /// A node event indicating that one more items in the node will be dirtied
900  /// A node event indicating that the node has finished dirtying items
902 
903  /// A event indicating that the entire graph is about to be dirtied
905 
906  /// A work item event that indicates the item has been selected in the TOPs UI
908 
909  /// Sent when a new node is created
911  /// Sent when a node was removed from the graph
913  /// Sent when a node was renamed
915  /// Sent when a node was connected to another node
917  /// Sent when a node is disconnected from another node
919 
920  /// Sent when an int attribute value is modified on a work item
922  /// Sent when a float attribute value is modified on a work item
924  /// Sent when a string attribute value is modified on a work item
926  /// Sent when a file attribute value is modified on a work item
928  /// Sent when a Python object attribute value is modified on a work item
930  /// Sent when a geometry attribute value is modified on a work item
932  /// Deprecated
934  /// Sent when an output file is added to a work item
936 
937  /// Sent when a work items priority is changed
939  /// Sent for each node in the graph, when a cook starts
941  /// Deprecated
943  /// Deprecated
945 
946  /// Deprecated
948  /// Deprecated
950  /// A special enum that represents the OR of all event types
952  /// A special enum that represents the OR of both the `CookError` and `CookWarning` events
954 
955  /// Sent when a new scheduler is added to the graph
957  /// Sent when a scheduler is removed from the graph
959  /// Sent when the scheduler assigned to a node is changed
961  /// Deprecated
963 
965 };
967 
968 /// Used with PDG functions
970 {
981 };
983 
984 /////////////////////////////////////////////////////////////////////////////
985 // Main API Structs
986 
987 // GENERICS -----------------------------------------------------------------
988 
989 /// A Transform with Quaternion rotation
991 {
992  float position[ HAPI_POSITION_VECTOR_SIZE ];
993  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
994  float scale[ HAPI_SCALE_VECTOR_SIZE ];
995  float shear[ HAPI_SHEAR_VECTOR_SIZE ];
996 
998 };
1000 
1001 /// A Transform with Euler rotation
1003 {
1004  float position[ HAPI_POSITION_VECTOR_SIZE ];
1005  float rotationEuler[ HAPI_EULER_VECTOR_SIZE ];
1006  float scale[ HAPI_SCALE_VECTOR_SIZE ];
1007  float shear[ HAPI_SHEAR_VECTOR_SIZE ];
1008 
1011 };
1013 
1014 // SESSIONS -----------------------------------------------------------------
1015 
1016 /// Identifies a session
1018 {
1019  /// The type of session determines the which implementation will be
1020  /// used to communicate with the Houdini Engine library.
1022 
1023  /// Some session types support multiple simultaneous sessions. This means
1024  /// that each session needs to have a unique identifier.
1025  HAPI_SessionId id;
1026 };
1028 
1029 /// Options to configure a Thrift server being started from HARC.
1031 {
1032  /// Close the server automatically when all clients disconnect from it.
1034 
1035  /// Timeout in milliseconds for waiting on the server to
1036  /// signal that it's ready to serve. If the server fails
1037  /// to signal within this time interval, the start server call fails
1038  /// and the server process is terminated.
1039  float timeoutMs;
1040 };
1042 
1043 // TIME ---------------------------------------------------------------------
1044 
1045 /// Data for global timeline, used with ::HAPI_SetTimelineOptions()
1047 {
1048  float fps;
1049 
1050  float startTime;
1051  float endTime;
1052 };
1054 
1055 // ASSETS -------------------------------------------------------------------
1056 
1057 /// Meta-data about an HDA, returned by ::HAPI_GetAssetInfo()
1059 {
1060  /// Use the node id to get the asset's parameters.
1061  /// See @ref HAPI_Nodes_Basics.
1062  HAPI_NodeId nodeId;
1063 
1064  /// The objectNodeId differs from the regular nodeId in that for
1065  /// geometry based assets (SOPs) it will be the node id of the dummy
1066  /// object (OBJ) node instead of the asset node. For object based assets
1067  /// the objectNodeId will equal the nodeId. The reason the distinction
1068  /// exists is because transforms are always stored on the object node
1069  /// but the asset parameters may not be on the asset node if the asset
1070  /// is a geometry asset so we need both.
1071  HAPI_NodeId objectNodeId;
1072 
1073  /// It's possible to instantiate an asset without cooking it.
1074  /// See @ref HAPI_Assets_Cooking.
1076 
1077  HAPI_StringHandle nameSH; /// Instance name (the label + a number).
1078  HAPI_StringHandle labelSH; /// This is what any end user should be shown.
1079  HAPI_StringHandle filePathSH; /// Path to the .otl library file.
1080  HAPI_StringHandle versionSH; /// User-defined asset version.
1081  HAPI_StringHandle fullOpNameSH; /// Full asset name and namespace.
1082  HAPI_StringHandle helpTextSH; /// Asset help marked-up text.
1083  HAPI_StringHandle helpURLSH; /// Asset help URL.
1084 
1085  int objectCount; /// See @ref HAPI_Objects.
1086  int handleCount; /// See @ref HAPI_Handles.
1087 
1088  /// Transform inputs exposed by the asset. For OBJ assets this is the
1089  /// number of transform inputs on the OBJ node. For SOP assets, this is
1090  /// the singular transform input on the dummy wrapper OBJ node.
1091  /// See @ref HAPI_AssetInputs.
1093 
1094  /// Geometry inputs exposed by the asset. For SOP assets this is
1095  /// the number of geometry inputs on the SOP node itself. OBJ assets
1096  /// will always have zero geometry inputs.
1097  /// See @ref HAPI_AssetInputs.
1099 
1100  /// Geometry outputs exposed by the asset. For SOP assets this is
1101  /// the number of geometry outputs on the SOP node itself. OBJ assets
1102  /// will always have zero geometry outputs.
1103  /// See @ref HAPI_AssetInputs.
1105 
1106  /// For incremental updates. Indicates whether any of the assets's
1107  /// objects have changed. Refreshed only during an asset cook.
1109 
1110  /// For incremental updates. Indicates whether any of the asset's
1111  /// materials have changed. Refreshed only during an asset cook.
1113 };
1115 
1116 /// Options which affect how nodes are cooked.
1118 {
1119  /// Normally, geos are split into parts in two different ways. First it
1120  /// is split by group and within each group it is split by primitive type.
1121  ///
1122  /// For example, if you have a geo with group1 covering half of the mesh
1123  /// and volume1 and group2 covering the other half of the mesh, all of
1124  /// curve1, and volume2 you will end up with 5 parts. First two parts
1125  /// will be for the half-mesh of group1 and volume1, and the last three
1126  /// will cover group2.
1127  ///
1128  /// This toggle lets you disable the splitting by group and just have
1129  /// the geo be split by primitive type alone. By default, this is true
1130  /// and therefore geos will be split by group and primitive type. If
1131  /// set to false, geos will only be split by primitive type.
1133 
1134  /// This toggle lets you enable the splitting by unique values
1135  /// of a specified attribute. By default, this is false and
1136  /// the geo be split as described above.
1137  /// as described above. If this is set to true, and splitGeosByGroup
1138  /// set to false, mesh geos will be split on attribute values
1139  /// The attribute name to split on must be created with HAPI_SetCustomString
1140  /// and then the splitAttrSH handle set on the struct.
1142  HAPI_StringHandle splitAttrSH;
1143 
1144  /// For meshes only, this is enforced by convexing the mesh. Use -1
1145  /// to avoid convexing at all and get some performance boost.
1147 
1148  /// For curves only.
1149  /// If this is set to true, then all curves will be refined to a linear
1150  /// curve and you can no longer access the original CVs. You can control
1151  /// the refinement detail via ::HAPI_CookOptions::curveRefineLOD.
1152  /// If it's false, the curve type (NURBS, Bezier etc) will be left as is.
1154 
1155  /// Controls the number of divisions per unit distance when refining
1156  /// a curve to linear. The default in Houdini is 8.0.
1158 
1159  /// If this option is turned on, then we will recursively clear the
1160  /// errors and warnings (and messages) of all nodes before performing
1161  /// the cook.
1163 
1164  /// Decide whether to recursively cook all templated geos or not.
1166 
1167  /// Decide whether to split points by vertex attributes. This takes
1168  /// all vertex attributes and tries to copy them to their respective
1169  /// points. If two vertices have any difference in their attribute values,
1170  /// the corresponding point is split into two points. This is repeated
1171  /// until all the vertex attributes have been copied to the points.
1172  ///
1173  /// With this option enabled, you can reduce the total number of vertices
1174  /// on a game engine side as sharing of attributes (like UVs) is optimized.
1175  /// To make full use of this feature, you have to think of Houdini points
1176  /// as game engine vertices (sharable). With this option OFF (or before
1177  /// this feature existed) you had to map Houdini vertices to game engine
1178  /// vertices, to make sure all attribute values are accounted for.
1180 
1181  /// Choose how you want the cook to handle packed primitives.
1182  /// The default is: ::HAPI_PACKEDPRIM_INSTANCING_MODE_DISABLED
1184 
1185  /// Choose which special part types should be handled. Unhandled special
1186  /// part types will just be refined to ::HAPI_PARTTYPE_MESH.
1189 
1190  /// If enabled, sets the ::HAPI_PartInfo::hasChanged member during the
1191  /// cook. If disabled, the member will always be true. Checking for
1192  /// part changes can be expensive, so there is a potential performance
1193  /// gain when disabled.
1195 
1196 
1197  /// This toggle lets you enable the caching of the mesh topology.
1198  /// By default, this is false. If this is set to true, cooking a mesh
1199  /// geometry will update only the topology if the number of points changed.
1200  /// Use this to get better performance on deforming meshes.
1202 
1203  /// For internal use only. :)
1205 };
1207 
1208 // NODES --------------------------------------------------------------------
1209 
1210 /// Meta-data for a Houdini Node
1212 {
1213  HAPI_NodeId id;
1214  HAPI_NodeId parentId;
1215  HAPI_StringHandle nameSH;
1217 
1218  /// Always true unless the asset's definition has changed due to loading
1219  /// a duplicate asset definition and from another OTL asset library
1220  /// file OR deleting the OTL asset library file used by this node's asset.
1222 
1223  /// Total number of cooks of this node.
1225 
1226  /// Use this unique id to grab the OP_Node pointer for this node.
1227  /// If you're linking against the C++ HDK, include the OP_Node.h header
1228  /// and call OP_Node::lookupNode().
1230 
1231  /// This is the internal node path in the Houdini scene graph. This path
1232  /// is meant to be abstracted away for most client purposes but for
1233  /// advanced uses it can come in handy.
1234  HAPI_StringHandle internalNodePathSH;
1235 
1236  /// Total number of parameters this asset has exposed. Includes hidden
1237  /// parameters.
1238  /// See @ref HAPI_Parameters.
1240 
1241  /// Number of values. A single parameter may have more than one value so
1242  /// this number is more than or equal to ::HAPI_NodeInfo::parmCount.
1243  /// @{
1247  /// @}
1248 
1249  /// The total number of choices among all the combo box parameters.
1250  /// See @ref HAPI_Parameters_ChoiceLists.
1252 
1253  /// The number of child nodes. This is 0 for all nodes that are not
1254  /// node networks.
1256 
1257  /// The number of inputs this specific node has.
1259 
1260  /// The number of outputs this specific node has.
1262 
1263  /// Nodes created via scripts or via ::HAPI_CreateNode() will be have
1264  /// this set to true. Only such nodes can be deleted using
1265  /// ::HAPI_DeleteNode().
1267 
1268  /// Indicates if this node will change over time
1270 };
1272 
1273 // PARAMETERS ---------------------------------------------------------------
1274 
1275 ///
1276 /// Contains parameter information like name, label, type, and size.
1277 ///
1279 {
1280  /// The parent id points to the id of the parent parm
1281  /// of this parm. The parent parm is something like a folder.
1282  HAPI_ParmId id;
1283 
1284  /// Parameter id of the parent of this parameter.
1285  HAPI_ParmId parentId;
1286 
1287  /// Child index within its immediate parent parameter.
1289 
1290  /// The HAPI type of the parm
1292 
1293  /// The Houdini script-type of the parm
1295 
1296  /// Some parameter types require additional type information.
1297  /// - File path parameters will indicate what file extensions they
1298  /// expect in a space-separated list of wild-cards. This is set
1299  /// in the Operator Type Properties using the File Pattern
1300  /// parameter property.
1301  /// For example, for filtering by PNG and JPG only: "*.png *.jpg"
1302  HAPI_StringHandle typeInfoSH;
1303 
1304  /// For the majority of parameter types permission will not be applicable.
1305  /// For file path parameters these permissions will indicate how the
1306  /// asset plans to use the file: whether it will only read it, only write
1307  /// to it, or both. This is set in the Operator Type Properties using
1308  /// the Browse Mode parameter property.
1310 
1311  /// Number of tags on this paramter.
1313 
1314  /// Tuple size. For scalar parameters this value is 1, but for vector
1315  /// parameters this value can be greater. For example, a 3 vector would
1316  /// have a size of 3. For folders and folder lists, this value is the
1317  /// number of children they own.
1318  int size;
1319 
1320  /// Any ::HAPI_ParmType can be a choice list. If this is set to
1321  /// ::HAPI_CHOICELISTTYPE_NONE, than this parameter is NOT a choice list.
1322  /// Otherwise, the parameter is a choice list of the indicated type.
1323  /// See @ref HAPI_Parameters_ChoiceLists.
1325 
1326  /// Any ::HAPI_ParmType can be a choice list. If the parameter is a
1327  /// choice list, this tells you how many choices it currently has.
1328  /// Note that some menu parameters can have a dynamic number of choices
1329  /// so it is important that this count is re-checked after every cook.
1330  /// See @ref HAPI_Parameters_ChoiceLists.
1332 
1333  /// Note that folders are not real parameters in Houdini so they do not
1334  /// have names. The folder names given here are generated from the name
1335  /// of the folderlist (or switcher) parameter which is a parameter. The
1336  /// folderlist parameter simply defines how many of the "next" parameters
1337  /// belong to the first folder, how many of the parameters after that
1338  /// belong to the next folder, and so on. This means that folder names
1339  /// can change just by reordering the folders around so don't rely on
1340  /// them too much. The only guarantee here is that the folder names will
1341  /// be unique among all other parameter names.
1342  HAPI_StringHandle nameSH;
1343 
1344  /// The label string for the parameter
1345  HAPI_StringHandle labelSH;
1346 
1347  /// If this parameter is a multiparm instance than the
1348  /// ::HAPI_ParmInfo::templateNameSH will be the hash-templated parm name,
1349  /// containing #'s for the parts of the name that use the instance number.
1350  /// Compared to the ::HAPI_ParmInfo::nameSH, the ::HAPI_ParmInfo::nameSH
1351  /// will be the ::HAPI_ParmInfo::templateNameSH but with the #'s
1352  /// replaced by the instance number. For regular parms, the
1353  /// ::HAPI_ParmInfo::templateNameSH is identical to the
1354  /// ::HAPI_ParmInfo::nameSH.
1355  HAPI_StringHandle templateNameSH;
1356 
1357  /// The help string for this parameter
1358  HAPI_StringHandle helpSH;
1359 
1360  /// Whether min/max exists for the parameter values.
1361  /// @{
1366  /// @}
1367 
1368  /// Parameter value range, shared between int and float parameters.
1369  /// @{
1370  float min;
1371  float max;
1372  float UIMin;
1373  float UIMax;
1374  /// @}
1375 
1376  /// Whether this parm should be hidden from the user entirely. This is
1377  /// mostly used to expose parameters as asset meta-data but not allow the
1378  /// user to directly modify them.
1380 
1381  /// Whether this parm should appear enabled or disabled.
1383 
1384  /// If true, it means this parameter doesn't actually exist on the node
1385  /// in Houdini but was added by Houdini Engine as a spare parameter.
1386  /// This is just for your information. The behaviour of this parameter
1387  /// is not any different than a non-spare parameter.
1389 
1390  HAPI_Bool joinNext; /// Whether this parm should be on the same line as
1391  /// the next parm.
1392  HAPI_Bool labelNone; /// Whether the label should be displayed.
1393 
1394  /// The index to use to look into the values array in order to retrieve
1395  /// the actual value(s) of this parameter.
1396  /// @{
1401  /// @}
1402 
1403  /// If this is a ::HAPI_PARMTYPE_NODE, this tells you what node types
1404  /// this parameter accepts.
1406 
1407  /// The node input parameter could have another subtype filter specified,
1408  /// like "Object: Geometry Only". In this case, this value will specify
1409  /// that extra filter. If the filter demands a node that HAPI does not
1410  /// support, both this and ::HAPI_ParmInfo::inputNodeType will be set to
1411  /// NONE as such a node is not settable through HAPI.
1413 
1414  /// See @ref HAPI_Parameters_MultiParms.
1415  /// @{
1417 
1418  int instanceNum; /// The index of the instance in the multiparm.
1419  int instanceLength; /// The number of parms in a multiparm instance.
1420  int instanceCount; /// The number of instances in a multiparm.
1421 
1422  /// First instance's ::HAPI_ParmInfo::instanceNum. Either 0 or 1.
1424 
1426  /// @}
1427 
1428  /// Provides the raw condition string which is used to evaluate the
1429  /// the visibility of a parm
1430  HAPI_StringHandle visibilityConditionSH;
1431 
1432  /// Provides the raw condition string which is used to evalute whether
1433  /// a parm is enabled or disabled
1434  HAPI_StringHandle disabledConditionSH;
1435 };
1437 
1438 /// Meta-data for a combo-box / choice parm
1440 {
1441  HAPI_ParmId parentParmId;
1442  HAPI_StringHandle labelSH;
1443 
1444  /// This evaluates to the value of the token associated with the label
1445  /// applies to string menus only.
1446  HAPI_StringHandle valueSH;
1447 };
1449 
1450 // HANDLES ------------------------------------------------------------------
1451 
1452 ///
1453 /// Contains handle information such as the type of handle
1454 /// (translate, rotate, scale, softxform ...etc) and the number of
1455 /// parameters the current handle is bound to.
1456 ///
1458 {
1459  HAPI_StringHandle nameSH;
1460  HAPI_StringHandle typeNameSH;
1461 
1463 };
1465 
1466 ///
1467 /// Contains binding information that maps the handle parameter to
1468 /// the asset parameter. The index is only used for int and float vector
1469 /// and colour parms.
1470 ///
1472 {
1473  HAPI_StringHandle handleParmNameSH;
1474  HAPI_StringHandle assetParmNameSH;
1475 
1476  HAPI_ParmId assetParmId;
1478 };
1480 
1481 // OBJECTS ------------------------------------------------------------------
1482 
1483 /// Meta-data for an OBJ Node
1485 {
1486  HAPI_StringHandle nameSH;
1487 
1488  /// @deprecated This member is no longer used
1489  HAPI_StringHandle objectInstancePathSH;
1490 
1491  /// For incremental updates. Indicates whether the object's transform
1492  /// has changed. Refreshed only during an asset cook.
1494 
1495  /// For incremental updates. Indicates whether any of the object's
1496  /// geometry nodes have changed. Refreshed only during an asset cook.
1498 
1499  /// Whether the object is hidden and should not be shown. Some objects
1500  /// should be hidden but still brought into the host environment, for
1501  /// example those used only for instancing.
1502  /// See @ref HAPI_Instancing.
1504 
1505  /// See @ref HAPI_Instancing.
1507 
1508  /// Determine if this object is being instanced. Normally, this implies
1509  /// that while this object may not be visible, it should still be
1510  /// brought into the host application because it is needed by an instancer.
1511  /// See @ref HAPI_Instancing.
1513 
1514  /// @deprecated No longer used. See @ref HAPI_Geos
1516 
1517  /// Use the node id to get the node's parameters.
1518  /// Using the HDK, you can also get the raw node C++ pointer for this
1519  /// object's internal node.
1520  /// See @ref HAPI_Nodes_Basics.
1521  HAPI_NodeId nodeId;
1522 
1523  /// If the object is an instancer, this variable gives the object id of
1524  /// the object that should be instanced.
1525  /// See @ref HAPI_Instancing.
1526  HAPI_NodeId objectToInstanceId;
1527 };
1529 
1530 // GEOMETRY -----------------------------------------------------------------
1531 
1532 /// Meta-data for a SOP Node
1534 {
1536  HAPI_StringHandle nameSH;
1537 
1538  /// Use the node id to get the node's parameters.
1539  /// Using the HDK, you can also get the raw node C++ pointer for this
1540  /// object's internal node.
1541  HAPI_NodeId nodeId;
1542 
1543  /// Whether the SOP node has been exposed by dragging it into the
1544  /// editable nodes section of the asset definition.
1546 
1547  /// Has the templated flag turned on which means "expose as read-only".
1549 
1550  /// Final Result (Display SOP).
1552 
1553  /// For incremental updates.
1555 
1556  /// @deprecated This variable is deprecated and should no longer be used.
1557  /// Materials are now separate from parts. They are maintained at the
1558  /// asset level so you only need to check if the material itself has
1559  /// changed via ::HAPI_MaterialInfo::hasChanged instead of the material
1560  /// on the part.
1562 
1563  /// Groups.
1564  /// @{
1567  /// @}
1568 
1569  /// Total number of parts this geometry contains.
1570  /// See @ref HAPI_Parts.
1572 };
1574 
1575 /// Meta-data describing a Geo Part
1577 {
1578  /// Id to identify this part relative to it's Geo
1579  HAPI_PartId id;
1580  /// String handle for the name of the part
1581  HAPI_StringHandle nameSH;
1583 
1586  /// Number of points. Note that this is NOT the number
1587  /// of "positions" as "points" may imply. If your
1588  /// geometry has 3 points then set this to 3 and not 3*3.
1590 
1591  int attributeCounts[ HAPI_ATTROWNER_MAX ];
1592 
1593  /// If this is true, don't display this part. Load its data but then
1594  /// instance it where the corresponding instancer part tells you to
1595  /// instance it.
1597 
1598  /// The number of parts that this instancer part is instancing.
1599  /// For example, if we're instancing a curve and a box, they would come
1600  /// across as two parts, hence this count would be two.
1601  /// Call ::HAPI_GetInstancedPartIds() to get the list of ::HAPI_PartId's.
1603 
1604  /// The number of instances that this instancer part is instancing.
1605  /// Using the same example as with ::HAPI_PartInfo::instancedPartCount,
1606  /// if I'm instancing the merge of a curve and a box 5 times, this count
1607  /// would be 5. To be clear, all instanced parts are instanced the same
1608  /// number of times and with the same transform for each instance.
1609  /// Call ::HAPI_GetInstancerPartTransforms() to get the transform of
1610  /// each instance.
1612 
1613  /// If this is false, the underlying attribute data appear to match that of
1614  /// the previous cook. In this case you may be able to re-used marshaled
1615  /// data from the previous cook.
1617 };
1619 
1620 /// Meta-data describing an attribute
1621 /// See @ref HAPI_Attributes.
1623 {
1625 
1628 
1629  /// When converting from the Houdini native GA geometry format to the
1630  /// GT geometry format HAPI uses, some attributes might change owners.
1631  /// For example, in Houdini GA curves can have points shared by
1632  /// vertices but the GT format only supports curve vertices
1633  /// (no points). This means that if you had point attributes on a curve
1634  /// in Houdini, when it comes out of HAPI those point attributes will now
1635  /// be vertex attributes. In this case, the ::HAPI_AttributeInfo::owner
1636  /// will be set to ::HAPI_ATTROWNER_VERTEX but the
1637  /// ::HAPI_AttributeInfo::originalOwner will be ::HAPI_ATTROWNER_POINT.
1639 
1640  /// Number of attributes. This count will match the number of values
1641  /// given the owner. For example, if the owner is ::HAPI_ATTROWNER_VERTEX
1642  /// this count will be the same as the ::HAPI_PartInfo::vertexCount.
1643  /// To be clear, this is not the number of values in the attribute, rather
1644  /// it is the number of attributes. If your geometry has three 3D points
1645  /// then this count will be 3 (not 3*3) while the
1646  /// ::HAPI_AttributeInfo::tupleSize will be 3.
1647  int count;
1648 
1649  /// Number of values per attribute.
1650  /// Note that this is NOT the memory size of the attribute. It is the
1651  /// number of values per attributes. Multiplying this by the
1652  /// size of the ::HAPI_AttributeInfo::storage will give you the memory
1653  /// size per attribute.
1655 
1656  /// Total number of elements for an array attribute.
1657  /// An array attribute can be thought of as a 2 dimensional array where
1658  /// the 2nd dimension can vary in size for each element in the 1st
1659  /// dimension. Therefore this returns the total number of values in
1660  /// the entire array.
1661  /// This should be used to determine the total storage
1662  /// size needed by multiplying with ::HAPI_AttributeInfo::storage.
1663  /// Note that this will be 0 for a non-array attribute.
1665 
1666  /// Attribute type info
1667  /// This is used to help identify the type of data stored in an attribute.
1668  /// Using the type is recommended over using just an attribute's name to identify
1669  /// its purpose.
1671 };
1673 
1674 // MATERIALS ----------------------------------------------------------------
1675 
1677 {
1678  /// This is the HAPI node id for the SHOP node this material is attached
1679  /// to. Use it to get access to the parameters (which contain the
1680  /// texture paths).
1681  /// IMPORTANT: When the ::HAPI_MaterialInfo::hasChanged is true this
1682  /// @p nodeId could have changed. Do not assume ::HAPI_MaterialInfo::nodeId
1683  /// will never change for a specific material.
1684  HAPI_NodeId nodeId;
1685 
1687 
1689 };
1691 
1692 /// Describes an image format, used with ::HAPI_GetSupportedImageFileFormats()
1694 {
1695  HAPI_StringHandle nameSH;
1696  HAPI_StringHandle descriptionSH;
1697  HAPI_StringHandle defaultExtensionSH;
1698 };
1700 
1701 /// Data for an image, used with ::HAPI_GetImageInfo() and ::HAPI_SetImageInfo()
1703 {
1704  /// Unlike the other members of this struct changing imageFileFormatNameSH
1705  /// and giving this struct back to HAPI_SetImageInfo() nothing will happen.
1706  /// Use this member variable to derive which image file format will be used
1707  /// by the HAPI_ExtractImageTo...() functions if called with
1708  /// image_file_format_name set to NULL. This way, you can decide whether
1709  /// to ask for a file format conversion (slower) or not (faster).
1710  /// (Read-only)
1711  HAPI_StringHandle imageFileFormatNameSH;
1712 
1713  int xRes;
1714  int yRes;
1715 
1717 
1718  HAPI_Bool interleaved; /// ex: true = RGBRGBRGB, false = RRRGGGBBB
1720 
1721  /// Adjust the gamma of the image. For anything less than
1722  /// ::HAPI_IMAGE_DATA_INT16, you probably want to leave this as 2.2.
1723  double gamma;
1724 };
1726 
1727 // ANIMATION ----------------------------------------------------------------
1728 
1729 /// Data for a single Key Frame
1731 {
1732  float time;
1733  float value;
1734  float inTangent;
1735  float outTangent;
1736 };
1738 
1739 // VOLUMES ------------------------------------------------------------------
1740 
1741 ///
1742 /// This represents a volume primitive but does not contain the actual voxel
1743 /// values, which can be retrieved on a per-tile basis.
1744 ///
1745 /// See @ref HAPI_Volumes.
1746 ///
1748 {
1749  HAPI_StringHandle nameSH;
1750 
1752 
1753  /// Each voxel is identified with an index. The indices will range
1754  /// between:
1755  /// [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )
1756  /// @{
1757  int xLength;
1758  int yLength;
1759  int zLength;
1760  int minX;
1761  int minY;
1762  int minZ;
1763  /// @}
1764 
1765  /// Number of values per voxel.
1766  /// The tuple size field is 1 for scalars and 3 for vector data.
1768 
1769  /// Can be either ::HAPI_STORAGETYPE_INT or ::HAPI_STORAGETYPE_FLOAT.
1771 
1772  /// The dimensions of each tile.
1773  /// This can be 8 or 16, denoting an 8x8x8 or 16x16x16 tiles.
1775 
1776  /// The transform of the volume with respect to the lengths.
1777  /// The volume may be positioned anywhere in space.
1779 
1780  /// Denotes special situations where the volume tiles are not perfect
1781  /// cubes, but are tapered instead.
1783 
1784  /// If there is taper involved, denotes the amount of taper involved.
1785  /// @{
1786  float xTaper;
1787  float yTaper;
1788  /// @}
1789 };
1791 
1792 ///
1793 /// A HAPI_VolumeTileInfo represents an cube subarray of the volume.
1794 /// The size of each dimension is ::HAPI_VolumeInfo::tileSize
1795 /// bbox [(minX, minY, minZ), (minX+tileSize, minY+tileSize, minZ+tileSize))
1796 ///
1798 {
1799  int minX;
1800  int minY;
1801  int minZ;
1803 };
1805 
1806 ///
1807 /// Describes the visual settings of a volume.
1808 ///
1810 {
1812  float iso;
1813  float density;
1814 };
1816 
1817 // CURVES -------------------------------------------------------------------
1818 
1819 ///
1820 /// Represents the meta-data associated with a curve mesh (a number
1821 /// of curves of the same type).
1823 {
1825  int curveCount; /// The number of curves contained in this curve mesh.
1826  int vertexCount; /// The number of control vertices (CVs) for all curves.
1827  int knotCount; /// The number of knots for all curves.
1828 
1830  /// Whether the curves in this curve mesh are periodic.
1832  /// Whether the curves in this curve mesh are rational.
1833  int order; /// Order of 1 is invalid. 0 means there is a varying order.
1834 
1835  HAPI_Bool hasKnots; /// Whether the curve has knots.
1836 };
1838 
1839 // BASIC PRIMITIVES ---------------------------------------------------------
1840 
1841 /// Data for a Box Part
1843 {
1844  float center[ HAPI_POSITION_VECTOR_SIZE ];
1845  float size[ HAPI_SCALE_VECTOR_SIZE ];
1846  float rotation[ HAPI_EULER_VECTOR_SIZE ];
1847 };
1849 
1850 /// Data for a Sphere Part
1852 {
1853  float center[ HAPI_POSITION_VECTOR_SIZE ];
1854  float radius;
1855 };
1857 
1858 // PDG Structs --------------------------------------------------------------
1859 
1860 /// Data associated with a PDG Event
1862 {
1863  HAPI_NodeId nodeId; /// id of related node
1864  HAPI_PDG_WorkitemId workitemId; /// id of related workitem
1865  HAPI_PDG_WorkitemId dependencyId; /// id of related workitem dependency
1866  int currentState; /// (HAPI_PDG_WorkItemState) value of current state for state change
1867  int lastState; /// (HAPI_PDG_WorkItemState) value of last state for state change
1868  int eventType; /// (HAPI_PDG_EventType) event type
1869  HAPI_StringHandle msgSH; /// String handle of the event message (> 0 if there is a message)
1870 };
1872 
1873 /// Info for a PDG Workitem
1875 {
1876  int index; /// index of the workitem
1877  int numResults; /// number of results reported
1878  HAPI_StringHandle nameSH; /// name of the workitem
1879 };
1881 
1882 /// Data for a PDG file result
1884 {
1885  int resultSH; /// result string data
1886  int resultTagSH; /// result tag
1887  HAPI_Int64 resultHash; /// hash value of result
1888 };
1890 
1891 // SESSIONSYNC --------------------------------------------------------------
1892 
1893 ///
1894 /// Contains the information for synchronizing viewport between Houdini
1895 /// and other applications. When SessionSync is enabled, Houdini will
1896 /// update this struct with its viewport state. It will also update
1897 /// its own viewport if this struct has changed.
1898 /// The data stored is in Houdini's right-handed Y-up coordinate system.
1899 ///
1901 {
1902  /// The world position of the viewport camera's pivot.
1903  float position[ HAPI_POSITION_VECTOR_SIZE ];
1904 
1905  /// The direction of the viewport camera stored as a quaternion.
1906  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
1907 
1908  /// The offset from the pivot to the viewport camera's
1909  /// actual world position.
1910  float offset;
1911 };
1913 
1914 ///
1915 /// Contains the information for synchronizing general SessionSync
1916 /// state between Houdini and other applications. When SessionSync
1917 /// is enabled, Houdini will update this struct with its state.
1918 /// It will also update its internal state if this struct has
1919 /// changed.
1920 ///
1922 {
1923  /// Specifies whether Houdini's current time is used for Houdini Engine
1924  /// cooks. This is automatically enabled in SessionSync where
1925  /// Houdini's viewport forces cooks to use Houdini's current time.
1926  /// This is disabled in non-SessionSync mode, but can be toggled to
1927  /// override default behaviour.
1929 
1930  /// Specifies whether viewport synchronization is enabled. If enabled,
1931  /// in SessionSync, Houdini will update its own viewport using
1932  /// ::HAPI_Viewport.
1934 };
1936 
1937 #endif // __HAPI_COMMON_h__
HAPI_License
Definition: HAPI_Common.h:179
HAPI_NodeId objectNodeId
Definition: HAPI_Common.h:1071
"vector", "vector3"
Definition: HAPI_Common.h:403
#define HAPI_QUATERNION_VECTOR_SIZE
Definition: HAPI_Common.h:20
Min cache memory limit in MB.
Definition: HAPI_Common.h:821
A event indicating that the entire graph is about to be dirtied.
Definition: HAPI_Common.h:904
HAPI_StringHandle disabledConditionSH
Definition: HAPI_Common.h:1434
Sent when a dependency is removed from a work item.
Definition: HAPI_Common.h:880
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1536
Sent when an output file is added to a work item.
Definition: HAPI_Common.h:935
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1342
Sent when a geometry attribute value is modified on a work item.
Definition: HAPI_Common.h:931
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1863
Data for an image, used with HAPI_GetImageInfo() and HAPI_SetImageInfo()
Definition: HAPI_Common.h:1702
HAPI_StringHandle labelSH
Instance name (the label + a number).
Definition: HAPI_Common.h:1078
HAPI_StringHandle nameSH
String handle for the name of the part.
Definition: HAPI_Common.h:1581
HAPI_Bool isInstancer
See Instancing.
Definition: HAPI_Common.h:1506
HAPI_VolumeVisualType
Definition: HAPI_Common.h:570
Sent for each node in the graph, when a cook completes.
Definition: HAPI_Common.h:896
Sent when an error is issued by the node.
Definition: HAPI_Common.h:891
HAPI_ImageDataFormat dataFormat
Definition: HAPI_Common.h:1716
int parmStringValueCount
Definition: HAPI_Common.h:1246
HAPI_Bool clearErrorsAndWarnings
Definition: HAPI_Common.h:1162
Texture coordinate.
Definition: HAPI_Common.h:627
Recursive Flag.
Definition: HAPI_Common.h:504
Recursive Flag.
Definition: HAPI_Common.h:502
A work item event that indicates the item has been selected in the TOPs UI.
Definition: HAPI_Common.h:907
HAPI_ChoiceListType choiceListType
Definition: HAPI_Common.h:1324
int HAPI_NodeTypeBits
Definition: HAPI_Common.h:492
int16_t HAPI_Int16
Definition: HAPI_Common.h:133
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1486
Sent when a file attribute value is modified on a work item.
Definition: HAPI_Common.h:927
HAPI_NodeId objectToInstanceId
Definition: HAPI_Common.h:1526
HAPI_Bool refineCurveToLinear
Definition: HAPI_Common.h:1153
HAPI_PDG_WorkitemId workitemId
id of related node
Definition: HAPI_Common.h:1864
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_1.
Definition: HAPI_Common.h:211
HAPI_ParmId id
Definition: HAPI_Common.h:1282
Just the presets binary blob.
Definition: HAPI_Common.h:470
int intValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1397
"dir", "direction"
Definition: HAPI_Common.h:412
HAPI_Bool isEditable
Definition: HAPI_Common.h:1545
int HAPI_PDG_GraphContextId
Use this with PDG functions.
Definition: HAPI_Common.h:170
#define HAPI_POSITION_VECTOR_SIZE
Definition: HAPI_Common.h:16
HAPI_RampType rampType
Definition: HAPI_Common.h:1425
int floatValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1398
HAPI_PackedPrimInstancingMode packedPrimInstancingMode
Definition: HAPI_Common.h:1183
Parametric interval.
Definition: HAPI_Common.h:619
HAPI_SessionEnvIntType
Definition: HAPI_Common.h:801
"toggle", "embed"
Definition: HAPI_Common.h:399
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1215
#define HAPI_API
Definition: HAPI_API.h:79
OBJ Node Specific Flags.
Definition: HAPI_Common.h:512
int resultTagSH
result string data
Definition: HAPI_Common.h:1886
HAPI_NodeFlags
Definition: HAPI_Common.h:497
HAPI_GeoType
Definition: HAPI_Common.h:632
A special enum that represents the OR of all event types.
Definition: HAPI_Common.h:951
int instanceCount
The number of parms in a multiparm instance.
Definition: HAPI_Common.h:1420
HAPI_StringHandle visibilityConditionSH
Definition: HAPI_Common.h:1430
HAPI_Bool hasEverCooked
Definition: HAPI_Common.h:1075
int eventType
(HAPI_PDG_WorkItemState) value of last state for state change
Definition: HAPI_Common.h:1868
HAPI_Bool haveMaterialsChanged
Definition: HAPI_Common.h:1112
HAPI_NodeType inputNodeType
Definition: HAPI_Common.h:1405
HAPI_StringHandle typeNameSH
Definition: HAPI_Common.h:1460
HAPI_Bool isPeriodic
The number of knots for all curves.
Definition: HAPI_Common.h:1829
HAPI_RSTOrder
Definition: HAPI_Common.h:706
int parmFloatValueCount
Definition: HAPI_Common.h:1245
"intvector", "intvector3"
Definition: HAPI_Common.h:407
HAPI_CurveType
Definition: HAPI_Common.h:551
HAPI_PDG_State
Used with PDG functions.
Definition: HAPI_Common.h:854
HAPI_AttributeOwner owner
Definition: HAPI_Common.h:1626
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:997
Sent when a work item has a dependency added.
Definition: HAPI_Common.h:878
Single Channel.
Definition: HAPI_Common.h:750
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1541
int uniqueHoudiniNodeId
Definition: HAPI_Common.h:1229
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1684
int HAPI_HIPFileId
Definition: HAPI_Common.h:174
HAPI_ImageDataFormat
Definition: HAPI_Common.h:732
int handleCount
See Objects.
Definition: HAPI_Common.h:1086
Sent when a new node is created.
Definition: HAPI_Common.h:910
HAPI_PartType
Definition: HAPI_Common.h:656
int currentState
id of related workitem dependency
Definition: HAPI_Common.h:1866
HAPI_EnvIntType
Definition: HAPI_Common.h:768
HAPI_Bool isRational
Whether the curves in this curve mesh are periodic.
Definition: HAPI_Common.h:1831
HAPI_Bool isValid
Definition: HAPI_Common.h:1221
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:1010
int choiceIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1400
Sent when the parent item for a work item is deleted.
Definition: HAPI_Common.h:885
HAPI_PackedPrimInstancingMode
Definition: HAPI_Common.h:284
HAPI_StringHandle labelSH
The label string for the parameter.
Definition: HAPI_Common.h:1345
True if it actually has a maximum size.
Definition: HAPI_Common.h:822
HAPI_Permissions
Definition: HAPI_Common.h:294
Sent when a node is disconnected from another node.
Definition: HAPI_Common.h:918
#define HAPI_SHEAR_VECTOR_SIZE
Definition: HAPI_Common.h:18
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:207
HAPI_Bool cookTemplatedGeos
Decide whether to recursively cook all templated geos or not.
Definition: HAPI_Common.h:1165
HAPI_StringHandle helpSH
The help string for this parameter.
Definition: HAPI_Common.h:1358
HAPI_VolumeVisualType type
Definition: HAPI_Common.h:1811
3x3 Bounding box
Definition: HAPI_Common.h:625
HAPI_Bool autoClose
Close the server automatically when all clients disconnect from it.
Definition: HAPI_Common.h:1033
HAPI_StringHandle templateNameSH
Definition: HAPI_Common.h:1355
Meta-data about an HDA, returned by HAPI_GetAssetInfo()
Definition: HAPI_Common.h:1058
Data for a PDG file result.
Definition: HAPI_Common.h:1883
HAPI_AttributeOwner
Definition: HAPI_Common.h:540
int stringValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1399
HAPI_StringHandle fullOpNameSH
User-defined asset version.
Definition: HAPI_Common.h:1081
Only some objects failed.
Definition: HAPI_Common.h:273
HAPI_ErrorCode
Definition: HAPI_Common.h:247
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1695
HAPI_Bool createdPostAssetLoad
Definition: HAPI_Common.h:1266
HAPI_Bool splitGeosByAttribute
Definition: HAPI_Common.h:1141
Meta-data for an OBJ Node.
Definition: HAPI_Common.h:1484
HAPI_NodeType
Definition: HAPI_Common.h:477
HAPI_CurveType curveType
Definition: HAPI_Common.h:1824
int knotCount
The number of control vertices (CVs) for all curves.
Definition: HAPI_Common.h:1827
HAPI_Bool hasUIMax
Definition: HAPI_Common.h:1365
Sent when a work item is deleted from a node.
Definition: HAPI_Common.h:873
HAPI_StringHandle handleParmNameSH
Definition: HAPI_Common.h:1473
int HAPI_StringHandle
Definition: HAPI_Common.h:151
HAPI_StatusVerbosity
Definition: HAPI_Common.h:200
HAPI_AttributeOwner originalOwner
Definition: HAPI_Common.h:1638
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_0.
Definition: HAPI_Common.h:209
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:1030
Total number of supported parameter types.
Definition: HAPI_Common.h:358
HAPI_ChoiceListType
Definition: HAPI_Common.h:451
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1616
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1596
Everything cook successfully without errors.
Definition: HAPI_Common.h:269
HAPI_Bool spare
Definition: HAPI_Common.h:1388
Menu Only, Single Selection.
Definition: HAPI_Common.h:456
HAPI_XYZOrder rotationOrder
Definition: HAPI_Common.h:1009
HAPI_Bool cacheMeshTopology
Definition: HAPI_Common.h:1201
HAPI_PrmScriptType
Definition: HAPI_Common.h:387
A node event indicating that the node has finished dirtying items.
Definition: HAPI_Common.h:901
HAPI_Bool hasKnots
Order of 1 is invalid. 0 means there is a varying order.
Definition: HAPI_Common.h:1835
HAPI_STATIC_ASSERT(sizeof(HAPI_UInt8)==1, unsupported_size_of_uint8)
HAPI_XYZOrder
Definition: HAPI_Common.h:719
Data associated with a PDG Event.
Definition: HAPI_Common.h:1861
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1459
int HAPI_ParmId
Definition: HAPI_Common.h:160
int numResults
index of the workitem
Definition: HAPI_Common.h:1877
HAPI_ParmId parentId
Parameter id of the parent of this parameter.
Definition: HAPI_Common.h:1285
Sent when a Python object attribute value is modified on a work item.
Definition: HAPI_Common.h:929
Meta-data describing a Geo Part.
Definition: HAPI_Common.h:1576
int HAPI_ErrorCodeBits
Definition: HAPI_Common.h:253
HAPI_AttributeTypeInfo typeInfo
Definition: HAPI_Common.h:1670
int order
Whether the curves in this curve mesh are rational.
Definition: HAPI_Common.h:1833
int instancedPartCount
Definition: HAPI_Common.h:1602
int tagCount
Number of tags on this paramter.
Definition: HAPI_Common.h:1312
int transformInputCount
See Handles.
Definition: HAPI_Common.h:1092
int outputCount
The number of outputs this specific node has.
Definition: HAPI_Common.h:1261
HAPI_Bool handleSpherePartTypes
Definition: HAPI_Common.h:1188
int instanceStartOffset
The number of instances in a multiparm.
Definition: HAPI_Common.h:1423
int childIndex
Child index within its immediate parent parameter.
Definition: HAPI_Common.h:1288
HAPI_NodeId id
Definition: HAPI_Common.h:1213
HAPI_ImagePacking
Definition: HAPI_Common.h:746
Meta-data for a Houdini Node.
Definition: HAPI_Common.h:1211
HAPI_Transform transform
Definition: HAPI_Common.h:1778
HAPI_PDG_EventType
Used with PDG functions.
Definition: HAPI_Common.h:865
HAPI_SessionType
Definition: HAPI_Common.h:255
HAPI_StorageType storage
Definition: HAPI_Common.h:1627
Presets blob within an .idx file format.
Definition: HAPI_Common.h:472
int instanceLength
The index of the instance in the multiparm.
Definition: HAPI_Common.h:1419
int lastState
(HAPI_PDG_WorkItemState) value of current state for state change
Definition: HAPI_Common.h:1867
HAPI_Permissions permissions
Definition: HAPI_Common.h:1309
HAPI_PDG_WorkitemState
Used with PDG functions.
Definition: HAPI_Common.h:969
Sent when the scheduler assigned to a node is changed.
Definition: HAPI_Common.h:960
HAPI_VolumeType
Definition: HAPI_Common.h:561
HAPI_ParmType type
The HAPI type of the parm.
Definition: HAPI_Common.h:1291
License Type. See HAPI_License.
Definition: HAPI_Common.h:806
HAPI_StringHandle descriptionSH
Definition: HAPI_Common.h:1696
HAPI_PDG_WorkitemId dependencyId
id of related workitem
Definition: HAPI_Common.h:1865
HAPI_HeightFieldSampling
Type of sampling for heightfield.
Definition: HAPI_Common.h:846
Field + Multiple Selection Menu.
Definition: HAPI_Common.h:462
HAPI_ImagePacking packing
ex: true = RGBRGBRGB, false = RRRGGGBBB
Definition: HAPI_Common.h:1719
HAPI_Int64 HAPI_SessionId
Has to be 64-bit.
Definition: HAPI_Common.h:147
#define HAPI_SCALE_VECTOR_SIZE
Definition: HAPI_Common.h:17
HAPI_Bool labelNone
the next parm.
Definition: HAPI_Common.h:1392
HAPI_GeoType type
Definition: HAPI_Common.h:1535
HAPI_SessionId id
Definition: HAPI_Common.h:1025
int HAPI_ProcessId
Definition: HAPI_Common.h:143
HAPI_RampType
Definition: HAPI_Common.h:304
Options which affect how nodes are cooked.
Definition: HAPI_Common.h:1117
HAPI_ParmType
Definition: HAPI_Common.h:320
Homogeneous position.
Definition: HAPI_Common.h:605
HAPI_CurveOrders
Definition: HAPI_Common.h:678
HAPI_Bool invisible
Definition: HAPI_Common.h:1379
HAPI_Bool joinNext
Definition: HAPI_Common.h:1390
Sent when a float attribute value is modified on a work item.
Definition: HAPI_Common.h:923
A node event that indicates that node is about to have all its work items cleared.
Definition: HAPI_Common.h:888
HAPI_StringHandle splitAttrSH
Definition: HAPI_Common.h:1142
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1688
Sent when a new scheduler is added to the graph.
Definition: HAPI_Common.h:956
HAPI_PartType type
Definition: HAPI_Common.h:1582
HAPI_StringHandle valueSH
Definition: HAPI_Common.h:1446
Identifies a session.
Definition: HAPI_Common.h:1017
HAPI_Bool haveGeosChanged
Definition: HAPI_Common.h:1497
HAPI_StringHandle versionSH
Path to the .otl library file.
Definition: HAPI_Common.h:1080
HAPI_StorageType
Definition: HAPI_Common.h:582
HAPI_Bool hasMax
Definition: HAPI_Common.h:1363
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1062
HAPI_StringHandle defaultExtensionSH
Definition: HAPI_Common.h:1697
Sent when a node was renamed.
Definition: HAPI_Common.h:914
HAPI_StringHandle assetParmNameSH
Definition: HAPI_Common.h:1474
Sent when a work items priority is changed.
Definition: HAPI_Common.h:938
Meta-data for a SOP Node.
Definition: HAPI_Common.h:1533
HAPI_Bool isDisplayGeo
Final Result (Display SOP).
Definition: HAPI_Common.h:1551
"Private" (hidden)
Definition: HAPI_Common.h:621
A Transform with Euler rotation.
Definition: HAPI_Common.h:1002
HAPI_Bool isTimeDependent
Indicates if this node will change over time.
Definition: HAPI_Common.h:1269
Sent from dynamic work items that generate from a cooked item.
Definition: HAPI_Common.h:883
HAPI_Bool hasGeoChanged
For incremental updates.
Definition: HAPI_Common.h:1554
Sent when a work item's state changes.
Definition: HAPI_Common.h:875
int vertexCount
The number of curves contained in this curve mesh.
Definition: HAPI_Common.h:1826
HAPI_StringHandle imageFileFormatNameSH
Definition: HAPI_Common.h:1711
int64_t HAPI_Int64
Definition: HAPI_Common.h:135
Data for global timeline, used with HAPI_SetTimelineOptions()
Definition: HAPI_Common.h:1046
HAPI_Bool hasMaterialChanged
Definition: HAPI_Common.h:1561
A node event indicating that one more items in the node will be dirtied.
Definition: HAPI_Common.h:899
HAPI_NodeId parentId
Definition: HAPI_Common.h:1214
Sent when a new work item is added by a node.
Definition: HAPI_Common.h:871
True if it actually has a minimum size.
Definition: HAPI_Common.h:820
RGBA Reversed.
Definition: HAPI_Common.h:755
HAPI_Bool isTemplated
Has the templated flag turned on which means "expose as read-only".
Definition: HAPI_Common.h:1548
Looks for Guide Geometry.
Definition: HAPI_Common.h:521
int totalCookCount
Total number of cooks of this node.
Definition: HAPI_Common.h:1224
HAPI_StringHandle filePathSH
This is what any end user should be shown.
Definition: HAPI_Common.h:1079
HAPI_Bool checkPartChanges
Definition: HAPI_Common.h:1194
char HAPI_Bool
Definition: HAPI_Common.h:110
HAPI_Bool hasUIMin
Definition: HAPI_Common.h:1364
HAPI_StringHandle typeInfoSH
Definition: HAPI_Common.h:1302
HAPI_NodeType type
Definition: HAPI_Common.h:1216
HAPI_StatusType
Definition: HAPI_Common.h:191
int extraFlags
For internal use only. :)
Definition: HAPI_Common.h:1204
HAPI_PresetType
Definition: HAPI_Common.h:466
HAPI_StringHandle labelSH
Definition: HAPI_Common.h:1442
Data for a Box Part.
Definition: HAPI_Common.h:1842
HAPI_Bool interleaved
Definition: HAPI_Common.h:1718
Sent when a string attribute value is modified on a work item.
Definition: HAPI_Common.h:925
int inputCount
The number of inputs this specific node has.
Definition: HAPI_Common.h:1258
HAPI_StringHandle helpURLSH
Asset help marked-up text.
Definition: HAPI_Common.h:1083
HAPI_Int64 resultHash
result tag
Definition: HAPI_Common.h:1887
HAPI_ParmId parentParmId
Definition: HAPI_Common.h:1441
"int", "integer"
Definition: HAPI_Common.h:390
HAPI_Result
Definition: HAPI_Common.h:217
Direction vector.
Definition: HAPI_Common.h:607
HAPI_InputType
Definition: HAPI_Common.h:669
Max cache memory limit in MB.
Definition: HAPI_Common.h:840
HAPI_Bool splitGeosByGroup
Definition: HAPI_Common.h:1132
HAPI_State
Definition: HAPI_Common.h:266
HAPI_VolumeType type
Definition: HAPI_Common.h:1751
Sent for each node in the graph, when a cook starts.
Definition: HAPI_Common.h:940
int objectCount
Asset help URL.
Definition: HAPI_Common.h:1085
HAPI_StringHandle helpTextSH
Full asset name and namespace.
Definition: HAPI_Common.h:1082
int HAPI_PDG_WorkitemId
Use this with PDG functions.
Definition: HAPI_Common.h:167
Implicit type based on data.
Definition: HAPI_Common.h:601
Sent when a scheduler is removed from the graph.
Definition: HAPI_Common.h:958
HAPI_Bool splitPointsByVertexAttributes
Definition: HAPI_Common.h:1179
HAPI_StorageType storage
Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT.
Definition: HAPI_Common.h:1770
int HAPI_NodeFlagsBits
Definition: HAPI_Common.h:529
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:213
Data for a Sphere Part.
Definition: HAPI_Common.h:1851
Sent when a node was removed from the graph.
Definition: HAPI_Common.h:912
HAPI_AttributeTypeInfo
Definition: HAPI_Common.h:597
HAPI_Bool haveObjectsChanged
Definition: HAPI_Common.h:1108
A Transform with Quaternion rotation.
Definition: HAPI_Common.h:990
#define HAPI_EULER_VECTOR_SIZE
Definition: HAPI_Common.h:21
HAPI_Bool cookUsingHoudiniTime
Definition: HAPI_Common.h:1928
HAPI_Bool hasTaper
Definition: HAPI_Common.h:1782
HAPI_GroupType
Definition: HAPI_Common.h:531
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1749
#define HAPI_C_STRUCT_TYPEDEF(struct_name)
Definition: HAPI_Common.h:99
HAPI_Bool isVisible
Definition: HAPI_Common.h:1503
Field + Single Selection Menu.
Definition: HAPI_Common.h:460
Sent when an warning is issued by the node.
Definition: HAPI_Common.h:893
int HAPI_NodeId
See Nodes Basics.
Definition: HAPI_Common.h:156
HAPI_PartId id
Id to identify this part relative to it's Geo.
Definition: HAPI_Common.h:1579
Describes an image format, used with HAPI_GetSupportedImageFileFormats()
Definition: HAPI_Common.h:1693
HAPI_CacheProperty
Identifies a memory cache.
Definition: HAPI_Common.h:813
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1512
You should abort the cook.
Definition: HAPI_Common.h:271
Sent when a node was connected to another node.
Definition: HAPI_Common.h:916
int primitiveGroupCount
Definition: HAPI_Common.h:1566
Info for a PDG Workitem.
Definition: HAPI_Common.h:1874
Sent when an int attribute value is modified on a work item.
Definition: HAPI_Common.h:921
HAPI_PrmScriptType scriptType
The Houdini script-type of the parm.
Definition: HAPI_Common.h:1294
Data for a single Key Frame.
Definition: HAPI_Common.h:1730
HAPI_Int64 totalArrayElements
Definition: HAPI_Common.h:1664
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1077
HAPI_StringHandle nameSH
number of results reported
Definition: HAPI_Common.h:1878
Mini Menu Only, Single Selection.
Definition: HAPI_Common.h:458
int HAPI_AssetLibraryId
Definition: HAPI_Common.h:153
A special enum that represents the OR of both the CookError and CookWarning events.
Definition: HAPI_Common.h:953
Parameter is not a menu.
Definition: HAPI_Common.h:454
2x2 Bounding box
Definition: HAPI_Common.h:623
#define HAPI_C_ENUM_TYPEDEF(enum_name)
[HAPI_CACHE]
Definition: HAPI_Common.h:97
HAPI_TransformComponent
Definition: HAPI_Common.h:688
HAPI_Bool hasTransformChanged
Definition: HAPI_Common.h:1493
HAPI_StringHandle objectInstancePathSH
Definition: HAPI_Common.h:1489
int8_t HAPI_Int8
Definition: HAPI_Common.h:131
HAPI_Bool hasMin
Definition: HAPI_Common.h:1362
HAPI_StringHandle internalNodePathSH
Definition: HAPI_Common.h:1234
An empty, undefined event. Should be ignored.
Definition: HAPI_Common.h:868
HAPI_Bool disabled
Whether this parm should appear enabled or disabled.
Definition: HAPI_Common.h:1382
HAPI_Bool handleBoxPartTypes
Definition: HAPI_Common.h:1187
HAPI_StringHandle msgSH
(HAPI_PDG_EventType) event type
Definition: HAPI_Common.h:1869
Meta-data for a combo-box / choice parm.
Definition: HAPI_Common.h:1439
HAPI_SessionType type
Definition: HAPI_Common.h:1021
HAPI_NodeFlags inputNodeFlag
Definition: HAPI_Common.h:1412
int HAPI_PartId
Definition: HAPI_Common.h:164
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1521
Dual Channel.
Definition: HAPI_Common.h:751
uint8_t HAPI_UInt8
Definition: HAPI_Common.h:126
HAPI_Bool isChildOfMultiParm
Definition: HAPI_Common.h:1416