HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends 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 #define HAPI_MAX_NUM_CONNECTIONS 128
32 
33 /// Common Default Attributes' Names
34 /// @{
35 #define HAPI_ATTRIB_POSITION "P"
36 #define HAPI_ATTRIB_UV "uv"
37 #define HAPI_ATTRIB_UV2 "uv2"
38 #define HAPI_ATTRIB_NORMAL "N"
39 #define HAPI_ATTRIB_TANGENT "tangentu"
40 #define HAPI_ATTRIB_TANGENT2 "tangentv"
41 #define HAPI_ATTRIB_COLOR "Cd"
42 #define HAPI_ATTRIB_NAME "name"
43 #define HAPI_ATTRIB_INSTANCE "instance"
44 #define HAPI_ATTRIB_ROT "rot"
45 #define HAPI_ATTRIB_SCALE "scale"
46 /// @}
47 
48 /// This is the name of the primitive group created from all the primitives
49 /// that are not in any user-defined group. This way, when you put all the
50 /// groups together you cover the entire mesh. This is important for some
51 /// clients where the mesh has to be defined in terms of submeshes that cover
52 /// the entire original mesh.
53 #define HAPI_UNGROUPED_GROUP_NAME "__ungrouped_group"
54 
55 /// Common image file format names (to use with the material extract APIs).
56 /// Note that you may still want to check if they are supported via
57 /// HAPI_GetSupportedImageFileFormats() since all formats are loaded
58 /// dynamically by Houdini on-demand so just because these formats are defined
59 /// here doesn't mean they are supported in your instance.
60 /// @{
61 #define HAPI_RAW_FORMAT_NAME "HAPI_RAW" // HAPI-only Raw Format
62 #define HAPI_PNG_FORMAT_NAME "PNG"
63 #define HAPI_JPEG_FORMAT_NAME "JPEG"
64 #define HAPI_BMP_FORMAT_NAME "Bitmap"
65 #define HAPI_TIFF_FORMAT_NAME "TIFF"
66 #define HAPI_TGA_FORMAT_NAME "Targa"
67 /// @}
68 
69 /// Default image file format's name - used when the image generated and has
70 /// no "original" file format and the user does not specify a format to
71 /// convert to.
72 #define HAPI_DEFAULT_IMAGE_FORMAT_NAME HAPI_PNG_FORMAT_NAME
73 
74 /// Name of subnet OBJ node containing the global nodes.
75 #define HAPI_GLOBAL_NODES_NODE_NAME "GlobalNodes"
76 
77 /// Environment variables.
78 #define HAPI_ENV_HIP "HIP"
79 #define HAPI_ENV_JOB "JOB"
80 #define HAPI_ENV_CLIENT_NAME "HAPI_CLIENT_NAME"
81 
82 /// [HAPI_CACHE]
83 /// Common cache names. You can see these same cache names in the
84 /// Cache Manager window in Houdini (Windows > Cache Manager).
85 #define HAPI_CACHE_COP2_COOK "Old COP Cook Cache"
86 #define HAPI_CACHE_COP2_FLIPBOOK "Composite View Cache"
87 #define HAPI_CACHE_IMAGE "Image Cache"
88 #define HAPI_CACHE_OBJ "Object Transform Cache"
89 #define HAPI_CACHE_GL_TEXTURE "OpenGL Texture Cache"
90 #define HAPI_CACHE_GL_VERTEX "OpenGL Vertex Cache"
91 #define HAPI_CACHE_SOP "SOP Cache"
92 #define HAPI_CACHE_VEX "VEX File Cache"
93 /// [HAPI_CACHE]
94 
95 /// [HAPI_InputCurve]
96 /// HAPI input curve attribute
97 #define HAPI_ATTRIB_INPUT_CURVE_COORDS "hapi_input_curve_coords"
98 /// [HAPI_InputCurve]
99 
100 // Make sure our enums and structs are usable without those keywords, as-is,
101 // in C.
102 #ifdef __cplusplus
103  #define HAPI_C_ENUM_TYPEDEF( enum_name )
104  #define HAPI_C_STRUCT_TYPEDEF( struct_name )
105 #else
106  #define HAPI_C_ENUM_TYPEDEF( enum_name ) \
107  typedef enum enum_name enum_name;
108  #define HAPI_C_STRUCT_TYPEDEF( struct_name ) \
109  typedef struct struct_name struct_name;
110 #endif // __cplusplus
111 
112 /////////////////////////////////////////////////////////////////////////////
113 // Typedefs
114 
115 // C has no bool.
116 #ifdef __cplusplus
117  typedef bool HAPI_Bool;
118 #else
119  typedef char HAPI_Bool;
120 #endif // __cplusplus
121 
122 // x-bit Integers
123 // Thrift doesn't support unsigned integers, so we cast it as a signed 8-bit int, but only
124 // for automated code generation and thrift
125 #ifdef HAPI_AUTOGEN
126  typedef signed char int8_t;
127  typedef short int16_t;
128  typedef long long int64_t;
129  typedef signed char HAPI_UInt8; // signed 8-bit int for thrift to avoid overflow
130 #else
131  #include <stdint.h>
132  #ifdef HAPI_THRIFT_ABI
133  typedef int8_t HAPI_UInt8; // signed 8-bit int for thrift to avoid overflow
134  #else
135  typedef uint8_t HAPI_UInt8;
136  HAPI_STATIC_ASSERT(sizeof(HAPI_UInt8) == 1, unsupported_size_of_uint8);
137  #endif
138 #endif
139 
140 typedef int8_t HAPI_Int8;
141 HAPI_STATIC_ASSERT(sizeof(HAPI_Int8) == 1, unsupported_size_of_int8);
142 typedef int16_t HAPI_Int16;
143 HAPI_STATIC_ASSERT(sizeof(HAPI_Int16) == 2, unsupported_size_of_int16);
144 typedef int64_t HAPI_Int64;
145 HAPI_STATIC_ASSERT(sizeof(HAPI_Int64) == 8, unsupported_size_of_long);
146 
147 
148 // The process id has to be uint on Windows and int on any other platform.
149 #if ( defined _WIN32 || defined WIN32 )
150  typedef unsigned int HAPI_ProcessId;
151 #else
152  typedef int HAPI_ProcessId;
153 #endif
154 
155 /// Has to be 64-bit.
156 typedef HAPI_Int64 HAPI_SessionId;
157 
158 /// Use this with HAPI_GetString() to get the value.
159 /// See @ref HAPI_Fundamentals_Strings.
160 typedef int HAPI_StringHandle;
161 
163 
164 /// See @ref HAPI_Nodes_Basics.
165 typedef int HAPI_NodeId;
166 
167 /// Either get this from the ::HAPI_ParmInfo or ::HAPI_GetParmIdFromName().
168 /// See @ref HAPI_Parameters.
169 typedef int HAPI_ParmId;
170 
171 /// Use this with ::HAPI_GetPartInfo().
172 /// See @ref HAPI_Parts.
173 typedef int HAPI_PartId;
174 
175 /// Use this with PDG functions
177 
178 /// Backwards compatibility for HAPI_PDG_WorkitemId
179 typedef HAPI_PDG_WorkItemId HAPI_PDG_WorkitemId;
180 
181 /// Use this with PDG functions
183 
184 /// When we load a HIP file, we associate a HIP file ID with the created nodes
185 /// so that they can be looked up later
186 typedef int HAPI_HIPFileId;
187 
188 /////////////////////////////////////////////////////////////////////////////
189 // Enums
190 
192 {
203 };
205 
207 {
212 };
214 
216 {
220 
221  /// Used for Results. Equivalent to ::HAPI_STATUSVERBOSITY_2
223  /// Used for Results. Equivalent to ::HAPI_STATUSVERBOSITY_0
225  /// Used for Results. Equivalent to ::HAPI_STATUSVERBOSITY_1
227  /// Used for Results. Equivalent to ::HAPI_STATUSVERBOSITY_2
229 };
231 
233 {
237 };
239 
241 {
253 
261 
264 
266 
268 };
270 
272 {
275 };
277 typedef int HAPI_ErrorCodeBits;
278 
280 {
287 };
289 
291 {
292  /// Everything cook successfully without errors
294  /// You should abort the cook.
296  /// Only some objects failed.
303 
305 };
307 
309 {
315 };
317 
319 {
325 };
327 
329 {
334 };
336 
337 /// Represents the data type of a parm.
338 /// As you can see, some of these high level types share the same underlying
339 /// raw data type. For instance, both string and file parameter types can be
340 /// represented with strings, yet semantically they are different. We will
341 /// group high level parameter types that share an underlying raw data type
342 /// together, so you can always check the raw data type of a parameter based
343 /// on its high level data type by checking a range of values.
345 {
346  /// @{
351  /// }@
352 
353  /// @{
356  /// @}
357 
358  /// @{
363  /// @}
364 
366 
367  /// @{
370  /// @}
371 
372  /// @{
377  /// @}
378 
379  // Helpers
380 
381  /// Total number of supported parameter types.
383 
386 
389 
392 
395 
398 
401 
404 };
406 
407 /// Corresponds to the types as shown in the Houdini Type Properties
408 /// window and in DialogScript files. Available on HAPI_ParmInfo
409 /// See: <a href="http://www.sidefx.com/docs/houdini/ref/windows/optype.html#parmtypes">Parameter types</a>
410 ///
412 {
413  /// "int", "integer"
422  /// "toggle", "embed"
426  /// "vector", "vector3"
430  /// "intvector", "intvector3"
435  /// "dir", "direction"
437  /// "color", "rgb"
439  /// "color4", "rgba"
463 
464  /// The following apply to HAPI_PARMTYPE_FOLDER type parms.
465  /// Radio buttons Folder
467  /// Collapsible Folder
469  /// Simple Folder
471  /// Tabs Folder
473 };
475 
477 {
478  /// Parameter is not a menu
480  /// Menu Only, Single Selection
482  /// Mini Menu Only, Single Selection
484  /// Field + Single Selection Menu
486  /// Field + Multiple Selection Menu
488 };
490 
492 {
494  /// Just the presets binary blob
496  /// Presets blob within an .idx file format
499 };
501 
503 {
517 };
519 typedef int HAPI_NodeTypeBits;
520 
521 /// Flags used to filter compositions of node lists.
522 /// Flags marked 'Recursive Flag' will exclude children whos parent does not
523 /// satisfy the flag, even if the children themselves satisfy the flag.
525 {
528  /// Recursive Flag
530  /// Recursive Flag
537 
538  /// OBJ Node Specific Flags
543 
544  /// SOP Node Specific Flags
545  /// Looks for "curve"
547  /// Looks for Guide Geometry
549 
550  /// TOP Node Specific Flags
551  /// All TOP nodes except schedulers
553 
554  /// Recursive Flag
555  /// Nodes that are not bypassed
557 };
559 typedef int HAPI_NodeFlagsBits;
560 
562 {
568 };
570 
572 {
579 };
581 
583 {
589 };
591 
593 {
598 };
600 
602 {
608 };
610 
612 {
617 };
619 
621 {
629 };
631 
633 {
635 
645 
655 
657 };
659 
661 {
663  /// Implicit type based on data
665  /// Position
667  /// Homogeneous position
669  /// Direction vector
671  /// Normal
673  /// Color
675  /// Quaternion
677  /// 3x3 Matrix
679  /// Matrix
681  /// Parametric interval
683  /// "Private" (hidden)
685  /// 2x2 Bounding box
687  /// 3x3 Bounding box
689  /// Texture coordinate
692 };
694 
696 {
698 
699  /// Most geos will be of this type which essentially means a geo
700  /// not of the other types.
702 
703  /// An exposed edit node.
704  /// See @ref HAPI_IntermediateAssetsResults.
706 
707  /// An input geo that can accept geometry from the host.
708  /// See @ref HAPI_AssetInputs_MarshallingGeometryIntoHoudini.
710 
711  /// A curve.
712  /// See @ref HAPI_Curves.
714 
716 };
718 
720 {
729 };
731 
733 {
738 };
740 
742 {
748 };
750 
752 {
766 };
768 
770 {
771  HAPI_TRS = 0,
777 
779 };
781 
783 {
784  HAPI_XYZ = 0,
790 
792 };
794 
796 {
804 
806 };
808 
810 {
812  HAPI_IMAGE_PACKING_SINGLE, /// Single Channel
813  HAPI_IMAGE_PACKING_DUAL, /// Dual Channel
815  HAPI_IMAGE_PACKING_BGR, /// RGB Reversed
817  HAPI_IMAGE_PACKING_ABGR, /// RGBA Reversed
819 
822 };
824 
825 /// Used with ::HAPI_GetEnvInt() to retrieve basic information
826 /// about the HAPI implementation currently being linked
827 /// against. Note that as of HAPI version 2.0, these enum values are
828 /// guaranteed never to change so you can reliably get this information from
829 /// any post-2.0 version of HAPI. The same goes for the actual
830 /// ::HAPI_GetEnvInt() API call.
832 {
834 
835  /// The three components of the Houdini version that HAPI is
836  /// expecting to link against.
837  /// @{
842  /// @}
843 
844  /// The two components of the Houdini Engine (marketed) version.
845  /// @{
848  /// @}
849 
850  /// This is a monotonously increasing API version number that can be used
851  /// to lock against a certain API for compatibility purposes. Basically,
852  /// when this number changes code compiled against the HAPI.h methods
853  /// might no longer compile. Semantic changes to the methods will also
854  /// cause this version to increase. This number will be reset to 0
855  /// every time the Houdini Engine version is bumped.
857 
859 };
861 
862 /// This enum is to be used with ::HAPI_GetSessionEnvInt() to retrieve basic
863 /// session-specific information.
865 {
867 
868  /// License Type. See ::HAPI_License.
870 
872 };
874 
875 /// Identifies a memory cache
877 {
878  /// Current memory usage in MB. Setting this to 0 invokes
879  /// a cache clear.
881 
882  HAPI_CACHEPROP_HAS_MIN, /// True if it actually has a minimum size.
883  HAPI_CACHEPROP_MIN, /// Min cache memory limit in MB.
884  HAPI_CACHEPROP_HAS_MAX, /// True if it actually has a maximum size.
885  HAPI_CACHEPROP_MAX, /// Max cache memory limit in MB.
886 
887  /// How aggressive to cull memory. This only works for:
888  /// - ::HAPI_CACHE_COP2_COOK where:
889  /// 0 -> Never reduce inactive cache.
890  /// 1 -> Always reduce inactive cache.
891  /// - ::HAPI_CACHE_OBJ where:
892  /// 0 -> Never enforce the max memory limit.
893  /// 1 -> Always enforce the max memory limit.
894  /// - ::HAPI_CACHE_SOP where:
895  /// 0 -> When to Unload = Never
896  /// When to Limit Max Memory = Never
897  /// 1-2 -> When to Unload = Based on Flag
898  /// When to Limit Max Memory = Never
899  /// 3-4 -> When to Unload = Based on Flag
900  /// When to Limit Max Memory = Always
901  /// 5 -> When to Unload = Always
902  /// When to Limit Max Memory = Always
904 };
905 
907 
908 /// Type of sampling for heightfield
910 {
913 };
915 
916 /// Used with PDG functions
918 {
922 
924 };
926 
927 /// Used with PDG functions
929 {
930  /// An empty, undefined event. Should be ignored.
932 
933  /// Sent when a new work item is added by a node
935  /// Sent when a work item is deleted from a node
937  /// Sent when a work item's state changes
939 
940  /// Sent when a work item has a dependency added
942  /// Sent when a dependency is removed from a work item
944 
945  /// Sent from dynamic work items that generate from a cooked item
947  /// Sent when the parent item for a work item is deleted
949 
950  /// A node event that indicates that node is about to have all its work items cleared
952 
953  /// Sent when an error is issued by the node
955  /// Sent when an warning is issued by the node
957 
958  /// Sent for each node in the graph, when a cook completes
960 
961  /// A node event indicating that one more items in the node will be dirtied
963  /// A node event indicating that the node has finished dirtying items
965 
966  /// A event indicating that the entire graph is about to be dirtied
968 
969  /// A work item event that indicates the item has been selected in the TOPs UI
971 
972  /// Sent when a new node is created
974  /// Sent when a node was removed from the graph
976  /// Sent when a node was renamed
978  /// Sent when a node was connected to another node
980  /// Sent when a node is disconnected from another node
982  /// Sent when a node cooks for the first time
984 
985  /// Deprecated
987  /// Deprecated
989  /// Deprecated
991  /// Deprecated
993  /// Deprecated
995  /// Deprecated
997  /// Deprecated
999  /// Deprecated
1001  /// Sent when an output file is added to a work item
1003 
1004  /// Deprecated
1006  /// Sent for each node in the graph, when a cook starts
1008  /// Deprecated
1010  /// Deprecated
1012 
1013  /// Deprecated
1015  /// Deprecated
1017  /// A special enum that represents the OR of all event types
1019  /// A special enum that represents the OR of both the `CookError` and `CookWarning` events
1021 
1022  /// Sent when a new scheduler is added to the graph
1024  /// Sent when a scheduler is removed from the graph
1026  /// Deprecated
1028  /// Deprecated
1030 
1031  /// Sent when a node finishes cooking
1033  /// Sent when a node finished generating
1035 
1036  /// Sent when a work item's frame changes
1038 
1040 };
1042 
1043 /// Used with PDG functions
1045 {
1056 };
1058 
1059 /// Backwards compatibility for HAPI_PDG_WorkitemState
1061 
1063 {
1067 };
1069 
1071 {
1074 };
1076 
1077 /////////////////////////////////////////////////////////////////////////////
1078 // Main API Structs
1079 
1080 // GENERICS -----------------------------------------------------------------
1081 
1082 /// A Transform with Quaternion rotation
1084 {
1086  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
1089 
1091 };
1093 
1094 /// A Transform with Euler rotation
1096 {
1098  float rotationEuler[ HAPI_EULER_VECTOR_SIZE ];
1101 
1104 };
1106 
1107 // SESSIONS -----------------------------------------------------------------
1108 
1109 /// Identifies a session
1111 {
1112  /// The type of session determines the which implementation will be
1113  /// used to communicate with the Houdini Engine library.
1115 
1116  /// Some session types support multiple simultaneous sessions. This means
1117  /// that each session needs to have a unique identifier.
1118  HAPI_SessionId id;
1119 };
1121 
1122 /// Configurations for sessions
1124 {
1125  /// The number of subconnections in this session
1127 
1128  /// Specification for the port numbers
1130 
1131  /// Specifies a range of port numbers, [minPort, maxPort]
1132  int minPort;
1133  int maxPort;
1134 
1135  /// Specifies a list of port numbers
1137 
1138  // Must match the buffer type passed to the HARS executable through the
1139  // command line or ::HAPI_StartThriftSharedMemoryServer
1141 
1142  // Must match the buffer size passed to the HARS executable through the
1143  // command line or ::HAPI_StartThriftSharedMemoryServer. This is the size of
1144  // the shared memory buffer in megabytes (MB).
1146 
1148 };
1150 
1151 /// Options to configure a Thrift server being started from HARC.
1153 {
1154  /// Close the server automatically when all clients disconnect from it.
1156 
1157  /// Timeout in milliseconds for waiting on the server to
1158  /// signal that it's ready to serve. If the server fails
1159  /// to signal within this time interval, the start server call fails
1160  /// and the server process is terminated.
1161  float timeoutMs;
1162 
1163  // Specifies the maximum status verbosity that will be logged.
1165 
1166  // Only used when starting a Thrift shared memory server. This controls the
1167  // type of buffer that is used in the underlying communication protocol. A
1168  // fixed length buffer is faster but the data passed to any single HAPI API
1169  // call cannot exceed the total length of the buffer. A ring buffer is
1170  // slower but has no limitations on the size of the data.
1172 
1173  // Only used when starting a Thrift shared memory server. This variable
1174  // specifies the size in megabytes (MB) of the allocated shared memory
1175  // buffer.
1177 };
1179 
1180 // TIME ---------------------------------------------------------------------
1181 
1182 /// Data for global timeline, used with ::HAPI_SetTimelineOptions()
1184 {
1185  double fps;
1186 
1187  double startTime;
1188  double endTime;
1189 };
1191 
1192 // ASSETS -------------------------------------------------------------------
1193 
1194 /// Meta-data about an HDA, returned by ::HAPI_GetAssetInfo()
1196 {
1197  /// Use the node id to get the asset's parameters.
1198  /// See @ref HAPI_Nodes_Basics.
1199  HAPI_NodeId nodeId;
1200 
1201  /// The objectNodeId differs from the regular nodeId in that for
1202  /// geometry based assets (SOPs) it will be the node id of the dummy
1203  /// object (OBJ) node instead of the asset node. For object based assets
1204  /// the objectNodeId will equal the nodeId. The reason the distinction
1205  /// exists is because transforms are always stored on the object node
1206  /// but the asset parameters may not be on the asset node if the asset
1207  /// is a geometry asset so we need both.
1208  HAPI_NodeId objectNodeId;
1209 
1210  /// It's possible to instantiate an asset without cooking it.
1211  /// See @ref HAPI_Assets_Cooking.
1213 
1214  HAPI_StringHandle nameSH; /// Instance name (the label + a number).
1215  HAPI_StringHandle labelSH; /// This is what any end user should be shown.
1216  HAPI_StringHandle filePathSH; /// Path to the .otl library file.
1217  HAPI_StringHandle versionSH; /// User-defined asset version.
1218  HAPI_StringHandle fullOpNameSH; /// Full asset name and namespace.
1219  HAPI_StringHandle helpTextSH; /// Asset help marked-up text.
1220  HAPI_StringHandle helpURLSH; /// Asset help URL.
1221 
1222  int objectCount; /// See @ref HAPI_Objects.
1223  int handleCount; /// See @ref HAPI_Handles.
1224 
1225  /// Transform inputs exposed by the asset. For OBJ assets this is the
1226  /// number of transform inputs on the OBJ node. For SOP assets, this is
1227  /// the singular transform input on the dummy wrapper OBJ node.
1228  /// See @ref HAPI_AssetInputs.
1230 
1231  /// Geometry inputs exposed by the asset. For SOP assets this is
1232  /// the number of geometry inputs on the SOP node itself. OBJ assets
1233  /// will always have zero geometry inputs.
1234  /// See @ref HAPI_AssetInputs.
1236 
1237  /// Geometry outputs exposed by the asset. For SOP assets this is
1238  /// the number of geometry outputs on the SOP node itself. OBJ assets
1239  /// will always have zero geometry outputs.
1240  /// See @ref HAPI_AssetInputs.
1242 
1243  /// For incremental updates. Indicates whether any of the assets's
1244  /// objects have changed. Refreshed only during an asset cook.
1246 
1247  /// For incremental updates. Indicates whether any of the asset's
1248  /// materials have changed. Refreshed only during an asset cook.
1250 };
1252 
1253 /// Options which affect how nodes are cooked.
1255 {
1256  /// Normally, geos are split into parts in two different ways. First it
1257  /// is split by group and within each group it is split by primitive type.
1258  ///
1259  /// For example, if you have a geo with group1 covering half of the mesh
1260  /// and volume1 and group2 covering the other half of the mesh, all of
1261  /// curve1, and volume2 you will end up with 5 parts. First two parts
1262  /// will be for the half-mesh of group1 and volume1, and the last three
1263  /// will cover group2.
1264  ///
1265  /// This toggle lets you disable the splitting by group and just have
1266  /// the geo be split by primitive type alone. By default, this is true
1267  /// and therefore geos will be split by group and primitive type. If
1268  /// set to false, geos will only be split by primitive type.
1270  HAPI_StringHandle splitGroupSH;
1271 
1272  /// This toggle lets you enable the splitting by unique values
1273  /// of a specified attribute. By default, this is false and
1274  /// the geo be split as described above.
1275  /// as described above. If this is set to true, and splitGeosByGroup
1276  /// set to false, mesh geos will be split on attribute values
1277  /// The attribute name to split on must be created with HAPI_SetCustomString
1278  /// and then the splitAttrSH handle set on the struct.
1280  HAPI_StringHandle splitAttrSH;
1281 
1282  /// For meshes only, this is enforced by convexing the mesh. Use -1
1283  /// to avoid convexing at all and get some performance boost.
1285 
1286  /// For curves only.
1287  /// If this is set to true, then all curves will be refined to a linear
1288  /// curve and you can no longer access the original CVs. You can control
1289  /// the refinement detail via ::HAPI_CookOptions::curveRefineLOD.
1290  /// If it's false, the curve type (NURBS, Bezier etc) will be left as is.
1292 
1293  /// Controls the number of divisions per unit distance when refining
1294  /// a curve to linear. The default in Houdini is 8.0.
1296 
1297  /// If this option is turned on, then we will recursively clear the
1298  /// errors and warnings (and messages) of all nodes before performing
1299  /// the cook.
1301 
1302  /// Decide whether to recursively cook all templated geos or not.
1304 
1305  /// Decide whether to split points by vertex attributes. This takes
1306  /// all vertex attributes and tries to copy them to their respective
1307  /// points. If two vertices have any difference in their attribute values,
1308  /// the corresponding point is split into two points. This is repeated
1309  /// until all the vertex attributes have been copied to the points.
1310  ///
1311  /// With this option enabled, you can reduce the total number of vertices
1312  /// on a game engine side as sharing of attributes (like UVs) is optimized.
1313  /// To make full use of this feature, you have to think of Houdini points
1314  /// as game engine vertices (sharable). With this option OFF (or before
1315  /// this feature existed) you had to map Houdini vertices to game engine
1316  /// vertices, to make sure all attribute values are accounted for.
1318 
1319  /// Choose how you want the cook to handle packed primitives.
1320  /// The default is: ::HAPI_PACKEDPRIM_INSTANCING_MODE_DISABLED
1322 
1323  /// Choose which special part types should be handled. Unhandled special
1324  /// part types will just be refined to ::HAPI_PARTTYPE_MESH.
1327 
1328  /// If enabled, sets the ::HAPI_PartInfo::hasChanged member during the
1329  /// cook. If disabled, the member will always be true. Checking for
1330  /// part changes can be expensive, so there is a potential performance
1331  /// gain when disabled.
1333 
1334  /// This toggle lets you enable the caching of the mesh topology.
1335  /// By default, this is false. If this is set to true, cooking a mesh
1336  /// geometry will update only the topology if the number of points changed.
1337  /// Use this to get better performance on deforming meshes.
1339 
1340  /// If enabled, calls to ::HAPI_CookNode() on an OBJ node will cook the output
1341  /// nodes of any nested SOP nodes. If none exist or the option is disabled,
1342  /// HAPI will instead cook the display nodes of any nested SOP nodes.
1344 
1345  /// For internal use only. :)
1347 };
1349 
1350 // NODES --------------------------------------------------------------------
1351 
1352 /// Meta-data for a Houdini Node
1354 {
1355  HAPI_NodeId id;
1356  HAPI_NodeId parentId;
1357  HAPI_StringHandle nameSH;
1359 
1360  /// Always true unless the asset's definition has changed due to loading
1361  /// a duplicate asset definition and from another OTL asset library
1362  /// file OR deleting the OTL asset library file used by this node's asset.
1364 
1365  /// Total number of cooks of this node.
1367 
1368  /// Use this unique id to grab the OP_Node pointer for this node.
1369  /// If you're linking against the C++ HDK, include the OP_Node.h header
1370  /// and call OP_Node::lookupNode().
1372 
1373  /// This is the internal node path in the Houdini scene graph. This path
1374  /// is meant to be abstracted away for most client purposes but for
1375  /// advanced uses it can come in handy.
1376  HAPI_StringHandle internalNodePathSH;
1377 
1378  /// Total number of parameters this asset has exposed. Includes hidden
1379  /// parameters.
1380  /// See @ref HAPI_Parameters.
1382 
1383  /// Number of values. A single parameter may have more than one value so
1384  /// this number is more than or equal to ::HAPI_NodeInfo::parmCount.
1385  /// @{
1389  /// @}
1390 
1391  /// The total number of choices among all the combo box parameters.
1392  /// See @ref HAPI_Parameters_ChoiceLists.
1394 
1395  /// The number of child nodes. This is 0 for all nodes that are not
1396  /// node networks.
1398 
1399  /// The number of inputs this specific node has.
1401 
1402  /// The number of outputs this specific node has.
1404 
1405  /// Nodes created via scripts or via ::HAPI_CreateNode() will be have
1406  /// this set to true. Only such nodes can be deleted using
1407  /// ::HAPI_DeleteNode().
1409 
1410  /// Indicates if this node will change over time
1412 };
1414 
1415 // PARAMETERS ---------------------------------------------------------------
1416 
1417 ///
1418 /// Contains parameter information like name, label, type, and size.
1419 ///
1421 {
1422  /// The parent id points to the id of the parent parm
1423  /// of this parm. The parent parm is something like a folder.
1424  HAPI_ParmId id;
1425 
1426  /// Parameter id of the parent of this parameter.
1427  HAPI_ParmId parentId;
1428 
1429  /// Child index within its immediate parent parameter.
1431 
1432  /// The HAPI type of the parm
1434 
1435  /// The Houdini script-type of the parm
1437 
1438  /// Some parameter types require additional type information.
1439  /// - File path parameters will indicate what file extensions they
1440  /// expect in a space-separated list of wild-cards. This is set
1441  /// in the Operator Type Properties using the File Pattern
1442  /// parameter property.
1443  /// For example, for filtering by PNG and JPG only: "*.png *.jpg"
1444  HAPI_StringHandle typeInfoSH;
1445 
1446  /// For the majority of parameter types permission will not be applicable.
1447  /// For file path parameters these permissions will indicate how the
1448  /// asset plans to use the file: whether it will only read it, only write
1449  /// to it, or both. This is set in the Operator Type Properties using
1450  /// the Browse Mode parameter property.
1452 
1453  /// Number of tags on this paramter.
1455 
1456  /// Tuple size. For scalar parameters this value is 1, but for vector
1457  /// parameters this value can be greater. For example, a 3 vector would
1458  /// have a size of 3. For folders and folder lists, this value is the
1459  /// number of children they own.
1460  int size;
1461 
1462  /// Any ::HAPI_ParmType can be a choice list. If this is set to
1463  /// ::HAPI_CHOICELISTTYPE_NONE, than this parameter is NOT a choice list.
1464  /// Otherwise, the parameter is a choice list of the indicated type.
1465  /// See @ref HAPI_Parameters_ChoiceLists.
1467 
1468  /// Any ::HAPI_ParmType can be a choice list. If the parameter is a
1469  /// choice list, this tells you how many choices it currently has.
1470  /// Note that some menu parameters can have a dynamic number of choices
1471  /// so it is important that this count is re-checked after every cook.
1472  /// See @ref HAPI_Parameters_ChoiceLists.
1474 
1475  /// Note that folders are not real parameters in Houdini so they do not
1476  /// have names. The folder names given here are generated from the name
1477  /// of the folderlist (or switcher) parameter which is a parameter. The
1478  /// folderlist parameter simply defines how many of the "next" parameters
1479  /// belong to the first folder, how many of the parameters after that
1480  /// belong to the next folder, and so on. This means that folder names
1481  /// can change just by reordering the folders around so don't rely on
1482  /// them too much. The only guarantee here is that the folder names will
1483  /// be unique among all other parameter names.
1484  HAPI_StringHandle nameSH;
1485 
1486  /// The label string for the parameter
1487  HAPI_StringHandle labelSH;
1488 
1489  /// If this parameter is a multiparm instance than the
1490  /// ::HAPI_ParmInfo::templateNameSH will be the hash-templated parm name,
1491  /// containing #'s for the parts of the name that use the instance number.
1492  /// Compared to the ::HAPI_ParmInfo::nameSH, the ::HAPI_ParmInfo::nameSH
1493  /// will be the ::HAPI_ParmInfo::templateNameSH but with the #'s
1494  /// replaced by the instance number. For regular parms, the
1495  /// ::HAPI_ParmInfo::templateNameSH is identical to the
1496  /// ::HAPI_ParmInfo::nameSH.
1497  HAPI_StringHandle templateNameSH;
1498 
1499  /// The help string for this parameter
1500  HAPI_StringHandle helpSH;
1501 
1502  /// Whether min/max exists for the parameter values.
1503  /// @{
1508  /// @}
1509 
1510  /// Parameter value range, shared between int and float parameters.
1511  /// @{
1512  float min;
1513  float max;
1514  float UIMin;
1515  float UIMax;
1516  /// @}
1517 
1518  /// Whether this parm should be hidden from the user entirely. This is
1519  /// mostly used to expose parameters as asset meta-data but not allow the
1520  /// user to directly modify them.
1522 
1523  /// Whether this parm should appear enabled or disabled.
1525 
1526  /// If true, it means this parameter doesn't actually exist on the node
1527  /// in Houdini but was added by Houdini Engine as a spare parameter.
1528  /// This is just for your information. The behaviour of this parameter
1529  /// is not any different than a non-spare parameter.
1531 
1532  HAPI_Bool joinNext; /// Whether this parm should be on the same line as
1533  /// the next parm.
1534  HAPI_Bool labelNone; /// Whether the label should be displayed.
1535 
1536  /// The index to use to look into the values array in order to retrieve
1537  /// the actual value(s) of this parameter.
1538  /// @{
1543  /// @}
1544 
1545  /// If this is a ::HAPI_PARMTYPE_NODE, this tells you what node types
1546  /// this parameter accepts.
1548 
1549  /// The node input parameter could have another subtype filter specified,
1550  /// like "Object: Geometry Only". In this case, this value will specify
1551  /// that extra filter. If the filter demands a node that HAPI does not
1552  /// support, both this and ::HAPI_ParmInfo::inputNodeType will be set to
1553  /// NONE as such a node is not settable through HAPI.
1555 
1556  /// See @ref HAPI_Parameters_MultiParms.
1557  /// @{
1559 
1560  int instanceNum; /// The index of the instance in the multiparm.
1561  int instanceLength; /// The number of parms in a multiparm instance.
1562  int instanceCount; /// The number of instances in a multiparm.
1563 
1564  /// First instance's ::HAPI_ParmInfo::instanceNum. Either 0 or 1.
1566 
1568  /// @}
1569 
1570  /// Provides the raw condition string which is used to evaluate the
1571  /// the visibility of a parm
1572  HAPI_StringHandle visibilityConditionSH;
1573 
1574  /// Provides the raw condition string which is used to evalute whether
1575  /// a parm is enabled or disabled
1576  HAPI_StringHandle disabledConditionSH;
1577 
1578  /// Whether or not the "Use Menu Item Token As Value" checkbox was checked in a integer menu item.
1580 };
1582 
1583 /// Meta-data for a combo-box / choice parm
1585 {
1586  HAPI_ParmId parentParmId;
1587  HAPI_StringHandle labelSH;
1588 
1589  /// This evaluates to the value of the token associated with the label
1590  /// applies to string menus only.
1591  HAPI_StringHandle valueSH;
1592 };
1594 
1595 // HANDLES ------------------------------------------------------------------
1596 
1597 ///
1598 /// Contains handle information such as the type of handle
1599 /// (translate, rotate, scale, softxform ...etc) and the number of
1600 /// parameters the current handle is bound to.
1601 ///
1603 {
1604  HAPI_StringHandle nameSH;
1605  HAPI_StringHandle typeNameSH;
1606 
1608 };
1610 
1611 ///
1612 /// Contains binding information that maps the handle parameter to
1613 /// the asset parameter. The index is only used for int and float vector
1614 /// and colour parms.
1615 ///
1617 {
1618  HAPI_StringHandle handleParmNameSH;
1619  HAPI_StringHandle assetParmNameSH;
1620 
1621  HAPI_ParmId assetParmId;
1623 };
1625 
1626 // OBJECTS ------------------------------------------------------------------
1627 
1628 /// Meta-data for an OBJ Node
1630 {
1631  HAPI_StringHandle nameSH;
1632 
1633  /// @deprecated This member is no longer used
1634  HAPI_StringHandle objectInstancePathSH;
1635 
1636  /// For incremental updates. Indicates whether the object's transform
1637  /// has changed. Refreshed only during an asset cook.
1639 
1640  /// For incremental updates. Indicates whether any of the object's
1641  /// geometry nodes have changed. Refreshed only during an asset cook.
1643 
1644  /// Whether the object is hidden and should not be shown. Some objects
1645  /// should be hidden but still brought into the host environment, for
1646  /// example those used only for instancing.
1647  /// See @ref HAPI_Instancing.
1649 
1650  /// See @ref HAPI_Instancing.
1652 
1653  /// Determine if this object is being instanced. Normally, this implies
1654  /// that while this object may not be visible, it should still be
1655  /// brought into the host application because it is needed by an instancer.
1656  /// See @ref HAPI_Instancing.
1658 
1659  /// @deprecated No longer used. See @ref HAPI_Geos
1661 
1662  /// Use the node id to get the node's parameters.
1663  /// Using the HDK, you can also get the raw node C++ pointer for this
1664  /// object's internal node.
1665  /// See @ref HAPI_Nodes_Basics.
1666  HAPI_NodeId nodeId;
1667 
1668  /// If the object is an instancer, this variable gives the object id of
1669  /// the object that should be instanced.
1670  /// See @ref HAPI_Instancing.
1671  HAPI_NodeId objectToInstanceId;
1672 };
1674 
1675 // GEOMETRY -----------------------------------------------------------------
1676 
1677 /// Meta-data for a SOP Node
1679 {
1681  HAPI_StringHandle nameSH;
1682 
1683  /// Use the node id to get the node's parameters.
1684  /// Using the HDK, you can also get the raw node C++ pointer for this
1685  /// object's internal node.
1686  HAPI_NodeId nodeId;
1687 
1688  /// Whether the SOP node has been exposed by dragging it into the
1689  /// editable nodes section of the asset definition.
1691 
1692  /// Has the templated flag turned on which means "expose as read-only".
1694 
1695  /// Final Result (Display SOP).
1697 
1698  /// For incremental updates.
1700 
1701  /// @deprecated This variable is deprecated and should no longer be used.
1702  /// Materials are now separate from parts. They are maintained at the
1703  /// asset level so you only need to check if the material itself has
1704  /// changed via ::HAPI_MaterialInfo::hasChanged instead of the material
1705  /// on the part.
1707 
1708  /// Groups.
1709  /// @{
1713  /// @}
1714 
1715  /// Total number of parts this geometry contains.
1716  /// See @ref HAPI_Parts.
1718 };
1720 
1721 /// Meta-data describing a Geo Part
1723 {
1724  /// Id to identify this part relative to it's Geo
1725  HAPI_PartId id;
1726  /// String handle for the name of the part
1727  HAPI_StringHandle nameSH;
1729 
1732  /// Number of points. Note that this is NOT the number
1733  /// of "positions" as "points" may imply. If your
1734  /// geometry has 3 points then set this to 3 and not 3*3.
1736 
1737  int attributeCounts[ HAPI_ATTROWNER_MAX ];
1738 
1739  /// If this is true, don't display this part. Load its data but then
1740  /// instance it where the corresponding instancer part tells you to
1741  /// instance it.
1743 
1744  /// The number of parts that this instancer part is instancing.
1745  /// For example, if we're instancing a curve and a box, they would come
1746  /// across as two parts, hence this count would be two.
1747  /// Call ::HAPI_GetInstancedPartIds() to get the list of ::HAPI_PartId.
1749 
1750  /// The number of instances that this instancer part is instancing.
1751  /// Using the same example as with ::HAPI_PartInfo::instancedPartCount,
1752  /// if I'm instancing the merge of a curve and a box 5 times, this count
1753  /// would be 5. To be clear, all instanced parts are instanced the same
1754  /// number of times and with the same transform for each instance.
1755  /// Call ::HAPI_GetInstancerPartTransforms() to get the transform of
1756  /// each instance.
1758 
1759  /// If this is false, the underlying attribute data appear to match that of
1760  /// the previous cook. In this case you may be able to re-used marshaled
1761  /// data from the previous cook.
1763 };
1765 
1766 /// Meta-data describing an attribute
1767 /// See @ref HAPI_Attributes.
1769 {
1771 
1774 
1775  /// When converting from the Houdini native GA geometry format to the
1776  /// GT geometry format HAPI uses, some attributes might change owners.
1777  /// For example, in Houdini GA curves can have points shared by
1778  /// vertices but the GT format only supports curve vertices
1779  /// (no points). This means that if you had point attributes on a curve
1780  /// in Houdini, when it comes out of HAPI those point attributes will now
1781  /// be vertex attributes. In this case, the ::HAPI_AttributeInfo::owner
1782  /// will be set to ::HAPI_ATTROWNER_VERTEX but the
1783  /// ::HAPI_AttributeInfo::originalOwner will be ::HAPI_ATTROWNER_POINT.
1785 
1786  /// Number of attributes. This count will match the number of values
1787  /// given the owner. For example, if the owner is ::HAPI_ATTROWNER_VERTEX
1788  /// this count will be the same as the ::HAPI_PartInfo::vertexCount.
1789  /// To be clear, this is not the number of values in the attribute, rather
1790  /// it is the number of attributes. If your geometry has three 3D points
1791  /// then this count will be 3 (not 3*3) while the
1792  /// ::HAPI_AttributeInfo::tupleSize will be 3.
1793  int count;
1794 
1795  /// Number of values per attribute.
1796  /// Note that this is NOT the memory size of the attribute. It is the
1797  /// number of values per attributes. Multiplying this by the
1798  /// size of the ::HAPI_AttributeInfo::storage will give you the memory
1799  /// size per attribute.
1801 
1802  /// Total number of elements for an array attribute.
1803  /// An array attribute can be thought of as a 2 dimensional array where
1804  /// the 2nd dimension can vary in size for each element in the 1st
1805  /// dimension. Therefore this returns the total number of values in
1806  /// the entire array.
1807  /// This should be used to determine the total storage
1808  /// size needed by multiplying with ::HAPI_AttributeInfo::storage.
1809  /// Note that this will be 0 for a non-array attribute.
1811 
1812  /// Attribute type info
1813  /// This is used to help identify the type of data stored in an attribute.
1814  /// Using the type is recommended over using just an attribute's name to identify
1815  /// its purpose.
1817 };
1819 
1820 // MATERIALS ----------------------------------------------------------------
1821 
1823 {
1824  /// This is the HAPI node id for the SHOP node this material is attached
1825  /// to. Use it to get access to the parameters (which contain the
1826  /// texture paths).
1827  /// IMPORTANT: When the ::HAPI_MaterialInfo::hasChanged is true this
1828  /// @p nodeId could have changed. Do not assume ::HAPI_MaterialInfo::nodeId
1829  /// will never change for a specific material.
1830  HAPI_NodeId nodeId;
1831 
1833 
1835 };
1837 
1838 /// Describes an image format, used with ::HAPI_GetSupportedImageFileFormats()
1840 {
1841  HAPI_StringHandle nameSH;
1842  HAPI_StringHandle descriptionSH;
1843  HAPI_StringHandle defaultExtensionSH;
1844 };
1846 
1847 /// Data for an image, used with ::HAPI_GetImageInfo() and ::HAPI_SetImageInfo()
1849 {
1850  /// Unlike the other members of this struct changing imageFileFormatNameSH
1851  /// and giving this struct back to ::HAPI_SetImageInfo() nothing will happen.
1852  /// Use this member variable to derive which image file format will be used
1853  /// by the ::HAPI_ExtractImageToFile() and ::HAPI_ExtractImageToMemory()
1854  /// functions if called with image_file_format_name set to NULL. This way,
1855  /// you can decide whether to ask for a file format conversion (slower) or
1856  /// not (faster).
1857  /// (Read-only)
1858  HAPI_StringHandle imageFileFormatNameSH;
1859 
1860  int xRes;
1861  int yRes;
1862 
1864 
1865  HAPI_Bool interleaved; /// ex: true = RGBRGBRGB, false = RRRGGGBBB
1867 
1868  /// Adjust the gamma of the image. For anything less than
1869  /// ::HAPI_IMAGE_DATA_INT16, you probably want to leave this as 2.2.
1870  double gamma;
1871 };
1873 
1874 // ANIMATION ----------------------------------------------------------------
1875 
1876 /// Data for a single Key Frame
1878 {
1879  float time;
1880  float value;
1881  float inTangent;
1882  float outTangent;
1883 };
1885 
1886 // VOLUMES ------------------------------------------------------------------
1887 
1888 ///
1889 /// This represents a volume primitive but does not contain the actual voxel
1890 /// values, which can be retrieved on a per-tile basis.
1891 ///
1892 /// See @ref HAPI_Volumes.
1893 ///
1895 {
1896  HAPI_StringHandle nameSH;
1897 
1899 
1900  /// Each voxel is identified with an index. The indices will range
1901  /// between:
1902  /// [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )
1903  /// @{
1904  int xLength;
1905  int yLength;
1906  int zLength;
1907  int minX;
1908  int minY;
1909  int minZ;
1910  /// @}
1911 
1912  /// Number of values per voxel.
1913  /// The tuple size field is 1 for scalars and 3 for vector data.
1915 
1916  /// Can be either ::HAPI_STORAGETYPE_INT or ::HAPI_STORAGETYPE_FLOAT.
1918 
1919  /// The dimensions of each tile.
1920  /// This can be 8 or 16, denoting an 8x8x8 or 16x16x16 tiles.
1922 
1923  /// The transform of the volume with respect to the lengths.
1924  /// The volume may be positioned anywhere in space.
1926 
1927  /// Denotes special situations where the volume tiles are not perfect
1928  /// cubes, but are tapered instead.
1930 
1931  /// If there is taper involved, denotes the amount of taper involved.
1932  /// @{
1933  float xTaper;
1934  float yTaper;
1935  /// @}
1936 };
1938 
1939 ///
1940 /// A HAPI_VolumeTileInfo represents an cube subarray of the volume.
1941 /// The size of each dimension is ::HAPI_VolumeInfo::tileSize
1942 /// bbox [(minX, minY, minZ), (minX+tileSize, minY+tileSize, minZ+tileSize))
1943 ///
1945 {
1946  int minX;
1947  int minY;
1948  int minZ;
1950 };
1952 
1953 ///
1954 /// Describes the visual settings of a volume.
1955 ///
1957 {
1959  float iso;
1960  float density;
1961 };
1963 
1964 // CURVES -------------------------------------------------------------------
1965 
1966 ///
1967 /// Represents the meta-data associated with a curve mesh (a number
1968 /// of curves of the same type).
1970 {
1972 
1973  /// The number of curves contained in this curve mesh.
1975 
1976  /// The number of control vertices (CVs) for all curves.
1978 
1979  /// The number of knots for all curves.
1981 
1982  /// Whether the curves in this curve mesh are periodic (closed by appending a new point)
1984 
1985  /// Whether the curves in this curve mesh are rational.
1987 
1988  /// Order of 1 is invalid. 0 means there is a varying order.
1989  int order;
1990 
1991  /// Whether the curve has knots.
1993 
1994  /// Similar to isPeriodic, but creates a polygon instead of a separate point
1996 };
1998 
1999 // Curve info dealing specifically with input curves
2001 {
2002  /// The desired curve type of the curve.
2003  /// Note that this is NOT necessarily equal to the value in HAPI_CurveInfo
2004  /// in the case of curve refinement.
2006 
2007  /// The desired order for your input curve.
2008  /// This is your desired order, which may differ from HAPI_CurveInfo
2009  /// as it will do range checks and adjust the actual order accordingly.
2010  int order;
2011 
2012  /// Whether or not the curve is closed.
2013  /// May differ from HAPI_CurveInfo::isPeriodic depending on the curveType
2014  /// (e.g. A NURBs curve is never technically closed according to HAPI_CurveInfo).
2016 
2017  /// Whether or not to reverse the curve input.
2019 
2020  // Input method type (CVs or Brekapoints).
2022 
2023  // Parameterization - Only used when inputMethod is BREAKPOINTS
2025 
2026 };
2028 
2029 // BASIC PRIMITIVES ---------------------------------------------------------
2030 
2031 /// Data for a Box Part
2033 {
2034  float center[ HAPI_POSITION_VECTOR_SIZE ];
2037 };
2039 
2040 /// Data for a Sphere Part
2042 {
2043  float center[ HAPI_POSITION_VECTOR_SIZE ];
2044  float radius;
2045 };
2047 
2048 // PDG Structs --------------------------------------------------------------
2049 
2050 /// Data associated with a PDG Event
2052 {
2053  /// id of related node.
2054  HAPI_NodeId nodeId;
2055 
2056  /// id of related work item.
2057  HAPI_PDG_WorkItemId workItemId;
2058 
2059  /// id of related work item dependency.
2060  HAPI_PDG_WorkItemId dependencyId;
2061 
2062  /// ::HAPI_PDG_WorkItemState value of current state for state change.
2064 
2065  /// ::HAPI_PDG_WorkItemState value of last state for state change.
2067 
2068  /// ::HAPI_PDG_EventType event type.
2070 
2071  /// String handle of the event message (> 0 if there is a message).
2072  HAPI_StringHandle msgSH;
2073 };
2075 
2076 /// Info for a PDG work item
2078 {
2079  /// The work item's index
2080  int index;
2081 
2082  /// The number of output files reported by the work item.
2084 
2085  /// Name of the work item
2086  HAPI_StringHandle nameSH;
2087 };
2089 
2090 /// Backwards compatibility for HAPI_PDG_WorkitemInfo
2092 
2093 /// Data for a PDG output file
2095 {
2096  /// The file path of the output.
2098 
2099  /// The file tag of the output.
2100  int tagSH;
2101 
2102  /// Hash of the output file. Properties such as the file path and
2103  /// modification time of the file are typical inputs to the hash function,
2104  /// but this will vary based on the node that is producing the output file.
2105  HAPI_Int64 hash;
2106 };
2108 
2109 /// Backwards compatibility for HAPI_PDG_WorkitemResultInfo
2111 
2112 // SESSIONSYNC --------------------------------------------------------------
2113 
2114 ///
2115 /// Contains the information for synchronizing viewport between Houdini
2116 /// and other applications. When SessionSync is enabled, Houdini will
2117 /// update this struct with its viewport state. It will also update
2118 /// its own viewport if this struct has changed.
2119 /// The data stored is in Houdini's right-handed Y-up coordinate system.
2120 ///
2122 {
2123  /// The world position of the viewport camera's pivot.
2125 
2126  /// The direction of the viewport camera stored as a quaternion.
2127  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
2128 
2129  /// The offset from the pivot to the viewport camera's
2130  /// actual world position.
2131  float offset;
2132 };
2134 
2135 ///
2136 /// Contains the information for synchronizing general SessionSync
2137 /// state between Houdini and other applications. When SessionSync
2138 /// is enabled, Houdini will update this struct with its state.
2139 /// It will also update its internal state if this struct has
2140 /// changed.
2141 ///
2143 {
2144  /// Specifies whether Houdini's current time is used for Houdini Engine
2145  /// cooks. This is automatically enabled in SessionSync where
2146  /// Houdini's viewport forces cooks to use Houdini's current time.
2147  /// This is disabled in non-SessionSync mode, but can be toggled to
2148  /// override default behaviour.
2150 
2151  /// Specifies whether viewport synchronization is enabled. If enabled,
2152  /// in SessionSync, Houdini will update its own viewport using
2153  /// ::HAPI_Viewport.
2155 };
2157 
2158 /// Configuration options for Houdini's compositing context
2160 {
2161  /// Specifies the maximum allowed width of an image in the compositor
2163 
2164  /// Specifies the maximum allowed height of an image in the compositor
2166 };
2168 
2169 #endif // __HAPI_COMMON_h__
HAPI_License
Definition: HAPI_Common.h:191
HAPI_NodeId objectNodeId
Definition: HAPI_Common.h:1208
"vector", "vector3"
Definition: HAPI_Common.h:427
#define HAPI_QUATERNION_VECTOR_SIZE
Definition: HAPI_Common.h:20
Min cache memory limit in MB.
Definition: HAPI_Common.h:884
A event indicating that the entire graph is about to be dirtied.
Definition: HAPI_Common.h:967
HAPI_StringHandle disabledConditionSH
Definition: HAPI_Common.h:1576
Sent when a dependency is removed from a work item.
Definition: HAPI_Common.h:943
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1681
Sent when an output file is added to a work item.
Definition: HAPI_Common.h:1002
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1484
int maximumResolutionX
Specifies the maximum allowed width of an image in the compositor.
Definition: HAPI_Common.h:2162
HAPI_NodeId nodeId
id of related node.
Definition: HAPI_Common.h:2054
Data for an image, used with HAPI_GetImageInfo() and HAPI_SetImageInfo()
Definition: HAPI_Common.h:1848
HAPI_StringHandle labelSH
Instance name (the label + a number).
Definition: HAPI_Common.h:1215
HAPI_StringHandle nameSH
String handle for the name of the part.
Definition: HAPI_Common.h:1727
HAPI_Bool isInstancer
See HAPI_Instancing.
Definition: HAPI_Common.h:1651
HAPI_VolumeVisualType
Definition: HAPI_Common.h:620
Sent for each node in the graph, when a cook completes.
Definition: HAPI_Common.h:959
HAPI_Bool reverse
Whether or not to reverse the curve input.
Definition: HAPI_Common.h:2018
Sent when an error is issued by the node.
Definition: HAPI_Common.h:954
HAPI_ImageDataFormat dataFormat
Definition: HAPI_Common.h:1863
int parmStringValueCount
Definition: HAPI_Common.h:1388
HAPI_Bool clearErrorsAndWarnings
Definition: HAPI_Common.h:1300
Texture coordinate.
Definition: HAPI_Common.h:690
Recursive Flag.
Definition: HAPI_Common.h:531
Recursive Flag.
Definition: HAPI_Common.h:529
HAPI_JobStatus
Definition: HAPI_Common.h:232
A work item event that indicates the item has been selected in the TOPs UI.
Definition: HAPI_Common.h:970
HAPI_ChoiceListType choiceListType
Definition: HAPI_Common.h:1466
int HAPI_NodeTypeBits
Definition: HAPI_Common.h:519
HAPI_PDG_WorkItemId HAPI_PDG_WorkitemId
Backwards compatibility for HAPI_PDG_WorkitemId.
Definition: HAPI_Common.h:179
int16_t HAPI_Int16
Definition: HAPI_Common.h:142
Data for a PDG output file.
Definition: HAPI_Common.h:2094
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1631
Sent when a node finished generating.
Definition: HAPI_Common.h:1034
HAPI_NodeId objectToInstanceId
Definition: HAPI_Common.h:1671
HAPI_PDG_WorkItemId dependencyId
id of related work item dependency.
Definition: HAPI_Common.h:2060
HAPI_Bool refineCurveToLinear
Definition: HAPI_Common.h:1291
HAPI_StatusVerbosity verbosity
Definition: HAPI_Common.h:1164
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_1.
Definition: HAPI_Common.h:226
HAPI_ParmId id
Definition: HAPI_Common.h:1424
int HAPI_PDG_WorkItemId
Use this with PDG functions.
Definition: HAPI_Common.h:176
Just the presets binary blob.
Definition: HAPI_Common.h:495
int intValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1539
"dir", "direction"
Definition: HAPI_Common.h:436
HAPI_Bool isEditable
Definition: HAPI_Common.h:1690
int HAPI_PDG_GraphContextId
Use this with PDG functions.
Definition: HAPI_Common.h:182
#define HAPI_POSITION_VECTOR_SIZE
Definition: HAPI_Common.h:16
HAPI_RampType rampType
Definition: HAPI_Common.h:1567
int floatValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1540
MatType shear(Axis axis0, Axis axis1, typename MatType::value_type shear)
Set the matrix to a shear along axis0 by a fraction of axis1.
Definition: Mat.h:688
HAPI_PackedPrimInstancingMode packedPrimInstancingMode
Definition: HAPI_Common.h:1321
Parametric interval.
Definition: HAPI_Common.h:682
HAPI_SessionEnvIntType
Definition: HAPI_Common.h:864
"toggle", "embed"
Definition: HAPI_Common.h:423
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1357
#define HAPI_API
Definition: HAPI_API.h:79
OBJ Node Specific Flags.
Definition: HAPI_Common.h:539
HAPI_NodeFlags
Definition: HAPI_Common.h:524
HAPI_GeoType
Definition: HAPI_Common.h:695
A special enum that represents the OR of all event types.
Definition: HAPI_Common.h:1018
int instanceCount
The number of parms in a multiparm instance.
Definition: HAPI_Common.h:1562
HAPI_StringHandle visibilityConditionSH
Definition: HAPI_Common.h:1572
HAPI_Bool hasEverCooked
Definition: HAPI_Common.h:1212
int eventType
HAPI_PDG_EventType event type.
Definition: HAPI_Common.h:2069
HAPI_Bool haveMaterialsChanged
Definition: HAPI_Common.h:1249
HAPI_NodeType inputNodeType
Definition: HAPI_Common.h:1547
HAPI_StringHandle typeNameSH
Definition: HAPI_Common.h:1605
HAPI_Bool isPeriodic
Whether the curves in this curve mesh are periodic (closed by appending a new point) ...
Definition: HAPI_Common.h:1983
HAPI_RSTOrder
Definition: HAPI_Common.h:769
int parmFloatValueCount
Definition: HAPI_Common.h:1387
"intvector", "intvector3"
Definition: HAPI_Common.h:431
HAPI_CurveType
Definition: HAPI_Common.h:582
HAPI_PDG_State
Used with PDG functions.
Definition: HAPI_Common.h:917
HAPI_AttributeOwner owner
Definition: HAPI_Common.h:1772
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:1090
Sent when a work item has a dependency added.
Definition: HAPI_Common.h:941
Single Channel.
Definition: HAPI_Common.h:813
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1686
int uniqueHoudiniNodeId
Definition: HAPI_Common.h:1371
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1830
Sent when a node cooks for the first time.
Definition: HAPI_Common.h:983
int HAPI_HIPFileId
Definition: HAPI_Common.h:186
HAPI_ImageDataFormat
Definition: HAPI_Common.h:795
int handleCount
See HAPI_Objects.
Definition: HAPI_Common.h:1223
Sent when a new node is created.
Definition: HAPI_Common.h:973
HAPI_PartType
Definition: HAPI_Common.h:719
int currentState
HAPI_PDG_WorkItemState value of current state for state change.
Definition: HAPI_Common.h:2063
HAPI_EnvIntType
Definition: HAPI_Common.h:831
HAPI_Bool isRational
Whether the curves in this curve mesh are rational.
Definition: HAPI_Common.h:1986
HAPI_Bool isValid
Definition: HAPI_Common.h:1363
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:1103
int choiceIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1542
Sent when the parent item for a work item is deleted.
Definition: HAPI_Common.h:948
HAPI_PackedPrimInstancingMode
Definition: HAPI_Common.h:308
HAPI_StringHandle labelSH
The label string for the parameter.
Definition: HAPI_Common.h:1487
True if it actually has a maximum size.
Definition: HAPI_Common.h:885
HAPI_Permissions
Definition: HAPI_Common.h:318
Sent when a node is disconnected from another node.
Definition: HAPI_Common.h:981
Info for a PDG work item.
Definition: HAPI_Common.h:2077
#define HAPI_SHEAR_VECTOR_SIZE
Definition: HAPI_Common.h:18
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:222
HAPI_Bool cookTemplatedGeos
Decide whether to recursively cook all templated geos or not.
Definition: HAPI_Common.h:1303
HAPI_StringHandle helpSH
The help string for this parameter.
Definition: HAPI_Common.h:1500
HAPI_VolumeVisualType type
Definition: HAPI_Common.h:1958
3x3 Bounding box
Definition: HAPI_Common.h:688
HAPI_Bool autoClose
Close the server automatically when all clients disconnect from it.
Definition: HAPI_Common.h:1155
HAPI_ThriftSharedMemoryBufferType
Definition: HAPI_Common.h:1070
HAPI_StringHandle templateNameSH
Definition: HAPI_Common.h:1497
Meta-data about an HDA, returned by HAPI_GetAssetInfo()
Definition: HAPI_Common.h:1195
HAPI_AttributeOwner
Definition: HAPI_Common.h:571
int stringValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1541
HAPI_InputCurveParameterization
Definition: HAPI_Common.h:601
HAPI_StringHandle fullOpNameSH
User-defined asset version.
Definition: HAPI_Common.h:1218
Only some objects failed.
Definition: HAPI_Common.h:297
HAPI_ErrorCode
Definition: HAPI_Common.h:271
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1841
HAPI_Bool createdPostAssetLoad
Definition: HAPI_Common.h:1408
HAPI_Bool splitGeosByAttribute
Definition: HAPI_Common.h:1279
HAPI_InputCurveParameterization breakpointParameterization
Definition: HAPI_Common.h:2024
Meta-data for an OBJ Node.
Definition: HAPI_Common.h:1629
HAPI_NodeType
Definition: HAPI_Common.h:502
HAPI_CurveType curveType
Definition: HAPI_Common.h:1971
int knotCount
The number of knots for all curves.
Definition: HAPI_Common.h:1980
HAPI_Bool hasUIMax
Definition: HAPI_Common.h:1507
Sent when a work item is deleted from a node.
Definition: HAPI_Common.h:936
HAPI_StringHandle handleParmNameSH
Definition: HAPI_Common.h:1618
int HAPI_StringHandle
Definition: HAPI_Common.h:160
HAPI_StatusVerbosity
Definition: HAPI_Common.h:215
Sent when a node finishes cooking.
Definition: HAPI_Common.h:1032
HAPI_AttributeOwner originalOwner
Definition: HAPI_Common.h:1784
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_0.
Definition: HAPI_Common.h:224
HAPI_ThriftSharedMemoryBufferType sharedMemoryBufferType
Definition: HAPI_Common.h:1140
int minPort
Specifies a range of port numbers, [minPort, maxPort].
Definition: HAPI_Common.h:1132
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:1152
Total number of supported parameter types.
Definition: HAPI_Common.h:382
HAPI_ChoiceListType
Definition: HAPI_Common.h:476
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1762
HAPI_Bool enableSharedMemoryDataTransfer
Definition: HAPI_Common.h:1147
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1742
GA_API const UT_StringHolder scale
Everything cook successfully without errors.
Definition: HAPI_Common.h:293
HAPI_Bool spare
Definition: HAPI_Common.h:1530
Menu Only, Single Selection.
Definition: HAPI_Common.h:481
int index
The work item's index.
Definition: HAPI_Common.h:2080
HAPI_XYZOrder rotationOrder
Definition: HAPI_Common.h:1102
int curveCount
The number of curves contained in this curve mesh.
Definition: HAPI_Common.h:1974
HAPI_Bool cacheMeshTopology
Definition: HAPI_Common.h:1338
HAPI_PrmScriptType
Definition: HAPI_Common.h:411
A node event indicating that the node has finished dirtying items.
Definition: HAPI_Common.h:964
HAPI_Bool hasKnots
Whether the curve has knots.
Definition: HAPI_Common.h:1992
HAPI_STATIC_ASSERT(sizeof(HAPI_UInt8)==1, unsupported_size_of_uint8)
HAPI_XYZOrder
Definition: HAPI_Common.h:782
HAPI_CurveType curveType
Definition: HAPI_Common.h:2005
Data associated with a PDG Event.
Definition: HAPI_Common.h:2051
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1604
int HAPI_ParmId
Definition: HAPI_Common.h:169
int tagSH
The file tag of the output.
Definition: HAPI_Common.h:2100
HAPI_ParmId parentId
Parameter id of the parent of this parameter.
Definition: HAPI_Common.h:1427
Meta-data describing a Geo Part.
Definition: HAPI_Common.h:1722
int HAPI_ErrorCodeBits
Definition: HAPI_Common.h:277
HAPI_AttributeTypeInfo typeInfo
Definition: HAPI_Common.h:1816
int order
Order of 1 is invalid. 0 means there is a varying order.
Definition: HAPI_Common.h:1989
int instancedPartCount
Definition: HAPI_Common.h:1748
int tagCount
Number of tags on this paramter.
Definition: HAPI_Common.h:1454
int transformInputCount
See HAPI_Handles.
Definition: HAPI_Common.h:1229
int outputCount
The number of outputs this specific node has.
Definition: HAPI_Common.h:1403
HAPI_TCP_PortType portType
Specification for the port numbers.
Definition: HAPI_Common.h:1129
HAPI_Bool handleSpherePartTypes
Definition: HAPI_Common.h:1326
Sent when a work item's frame changes.
Definition: HAPI_Common.h:1037
HAPI_PDG_WorkItemState
Used with PDG functions.
Definition: HAPI_Common.h:1044
int instanceStartOffset
The number of instances in a multiparm.
Definition: HAPI_Common.h:1565
int childIndex
Child index within its immediate parent parameter.
Definition: HAPI_Common.h:1430
HAPI_NodeId id
Definition: HAPI_Common.h:1355
HAPI_ImagePacking
Definition: HAPI_Common.h:809
Meta-data for a Houdini Node.
Definition: HAPI_Common.h:1353
int connectionCount
The number of subconnections in this session.
Definition: HAPI_Common.h:1126
HAPI_Transform transform
Definition: HAPI_Common.h:1925
HAPI_PDG_EventType
Used with PDG functions.
Definition: HAPI_Common.h:928
HAPI_SessionType
Definition: HAPI_Common.h:279
HAPI_StorageType storage
Definition: HAPI_Common.h:1773
Presets blob within an .idx file format.
Definition: HAPI_Common.h:497
int instanceLength
The index of the instance in the multiparm.
Definition: HAPI_Common.h:1561
int lastState
HAPI_PDG_WorkItemState value of last state for state change.
Definition: HAPI_Common.h:2066
HAPI_Permissions permissions
Definition: HAPI_Common.h:1451
Configuration options for Houdini's compositing context.
Definition: HAPI_Common.h:2159
HAPI_VolumeType
Definition: HAPI_Common.h:611
HAPI_ParmType type
The HAPI type of the parm.
Definition: HAPI_Common.h:1433
HAPI_Int64 sharedMemoryBufferSize
Definition: HAPI_Common.h:1145
License Type. See HAPI_License.
Definition: HAPI_Common.h:869
HAPI_StringHandle descriptionSH
Definition: HAPI_Common.h:1842
SIM_API const UT_StringHolder rotation
HAPI_HeightFieldSampling
Type of sampling for heightfield.
Definition: HAPI_Common.h:909
Field + Multiple Selection Menu.
Definition: HAPI_Common.h:487
HAPI_ImagePacking packing
ex: true = RGBRGBRGB, false = RRRGGGBBB
Definition: HAPI_Common.h:1866
HAPI_Int64 HAPI_SessionId
Has to be 64-bit.
Definition: HAPI_Common.h:156
#define HAPI_SCALE_VECTOR_SIZE
Definition: HAPI_Common.h:17
HAPI_Bool labelNone
the next parm.
Definition: HAPI_Common.h:1534
HAPI_GeoType type
Definition: HAPI_Common.h:1680
HAPI_SessionId id
Definition: HAPI_Common.h:1118
int HAPI_ProcessId
Definition: HAPI_Common.h:152
HAPI_RampType
Definition: HAPI_Common.h:328
Configurations for sessions.
Definition: HAPI_Common.h:1123
Options which affect how nodes are cooked.
Definition: HAPI_Common.h:1254
HAPI_ParmType
Definition: HAPI_Common.h:344
Homogeneous position.
Definition: HAPI_Common.h:668
HAPI_Bool useMenuItemTokenAsValue
Whether or not the "Use Menu Item Token As Value" checkbox was checked in a integer menu item...
Definition: HAPI_Common.h:1579
HAPI_CurveOrders
Definition: HAPI_Common.h:741
HAPI_Bool invisible
Definition: HAPI_Common.h:1521
HAPI_Bool joinNext
Definition: HAPI_Common.h:1532
A node event that indicates that node is about to have all its work items cleared.
Definition: HAPI_Common.h:951
HAPI_StringHandle splitAttrSH
Definition: HAPI_Common.h:1280
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1834
Sent when a new scheduler is added to the graph.
Definition: HAPI_Common.h:1023
HAPI_PartType type
Definition: HAPI_Common.h:1728
#define HAPI_MAX_NUM_CONNECTIONS
Definition: HAPI_Common.h:31
HAPI_StringHandle valueSH
Definition: HAPI_Common.h:1591
Identifies a session.
Definition: HAPI_Common.h:1110
HAPI_Bool haveGeosChanged
Definition: HAPI_Common.h:1642
HAPI_StringHandle versionSH
Path to the .otl library file.
Definition: HAPI_Common.h:1217
HAPI_StorageType
Definition: HAPI_Common.h:632
HAPI_Bool hasMax
Definition: HAPI_Common.h:1505
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1199
HAPI_ThriftSharedMemoryBufferType sharedMemoryBufferType
Definition: HAPI_Common.h:1171
HAPI_StringHandle defaultExtensionSH
Definition: HAPI_Common.h:1843
int maximumResolutionY
Specifies the maximum allowed height of an image in the compositor.
Definition: HAPI_Common.h:2165
Sent when a node was renamed.
Definition: HAPI_Common.h:977
HAPI_StringHandle assetParmNameSH
Definition: HAPI_Common.h:1619
Meta-data for a SOP Node.
Definition: HAPI_Common.h:1678
HAPI_Bool isDisplayGeo
Final Result (Display SOP).
Definition: HAPI_Common.h:1696
"Private" (hidden)
Definition: HAPI_Common.h:684
GLsizeiptr size
Definition: glcorearb.h:664
A Transform with Euler rotation.
Definition: HAPI_Common.h:1095
HAPI_Bool isTimeDependent
Indicates if this node will change over time.
Definition: HAPI_Common.h:1411
Sent from dynamic work items that generate from a cooked item.
Definition: HAPI_Common.h:946
HAPI_Bool hasGeoChanged
For incremental updates.
Definition: HAPI_Common.h:1699
Sent when a work item's state changes.
Definition: HAPI_Common.h:938
int vertexCount
The number of control vertices (CVs) for all curves.
Definition: HAPI_Common.h:1977
HAPI_StringHandle imageFileFormatNameSH
Definition: HAPI_Common.h:1858
int64_t HAPI_Int64
Definition: HAPI_Common.h:144
Data for global timeline, used with HAPI_SetTimelineOptions()
Definition: HAPI_Common.h:1183
HAPI_Bool hasMaterialChanged
Definition: HAPI_Common.h:1706
A node event indicating that one more items in the node will be dirtied.
Definition: HAPI_Common.h:962
HAPI_NodeId parentId
Definition: HAPI_Common.h:1356
Sent when a new work item is added by a node.
Definition: HAPI_Common.h:934
True if it actually has a minimum size.
Definition: HAPI_Common.h:883
RGBA Reversed.
Definition: HAPI_Common.h:818
HAPI_Bool isTemplated
Has the templated flag turned on which means "expose as read-only".
Definition: HAPI_Common.h:1693
Looks for Guide Geometry.
Definition: HAPI_Common.h:548
int totalCookCount
Total number of cooks of this node.
Definition: HAPI_Common.h:1366
HAPI_StringHandle filePathSH
This is what any end user should be shown.
Definition: HAPI_Common.h:1216
HAPI_Bool checkPartChanges
Definition: HAPI_Common.h:1332
char HAPI_Bool
Definition: HAPI_Common.h:119
SIM_API const UT_StringHolder position
HAPI_Bool hasUIMin
Definition: HAPI_Common.h:1506
HAPI_StringHandle typeInfoSH
Definition: HAPI_Common.h:1444
HAPI_PDG_WorkItemId workItemId
id of related work item.
Definition: HAPI_Common.h:2057
HAPI_NodeType type
Definition: HAPI_Common.h:1358
HAPI_StatusType
Definition: HAPI_Common.h:206
int extraFlags
For internal use only. :)
Definition: HAPI_Common.h:1346
HAPI_StringHandle splitGroupSH
Definition: HAPI_Common.h:1270
HAPI_PresetType
Definition: HAPI_Common.h:491
HAPI_StringHandle labelSH
Definition: HAPI_Common.h:1587
Data for a Box Part.
Definition: HAPI_Common.h:2032
HAPI_Bool interleaved
Definition: HAPI_Common.h:1865
int inputCount
The number of inputs this specific node has.
Definition: HAPI_Common.h:1400
HAPI_StringHandle helpURLSH
Asset help marked-up text.
Definition: HAPI_Common.h:1220
HAPI_ParmId parentParmId
Definition: HAPI_Common.h:1586
"int", "integer"
Definition: HAPI_Common.h:414
HAPI_Result
Definition: HAPI_Common.h:240
Direction vector.
Definition: HAPI_Common.h:670
int outputFileCount
The number of output files reported by the work item.
Definition: HAPI_Common.h:2083
HAPI_InputType
Definition: HAPI_Common.h:732
Max cache memory limit in MB.
Definition: HAPI_Common.h:903
HAPI_StringHandle nameSH
Name of the work item.
Definition: HAPI_Common.h:2086
HAPI_Bool splitGeosByGroup
Definition: HAPI_Common.h:1269
HAPI_State
Definition: HAPI_Common.h:290
HAPI_VolumeType type
Definition: HAPI_Common.h:1898
Sent for each node in the graph, when a cook starts.
Definition: HAPI_Common.h:1007
int objectCount
Asset help URL.
Definition: HAPI_Common.h:1222
HAPI_StringHandle helpTextSH
Full asset name and namespace.
Definition: HAPI_Common.h:1219
Implicit type based on data.
Definition: HAPI_Common.h:664
Sent when a scheduler is removed from the graph.
Definition: HAPI_Common.h:1025
HAPI_Bool splitPointsByVertexAttributes
Definition: HAPI_Common.h:1317
HAPI_StorageType storage
Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT.
Definition: HAPI_Common.h:1917
HAPI_InputCurveMethod
Definition: HAPI_Common.h:592
HAPI_InputCurveMethod inputMethod
Definition: HAPI_Common.h:2021
int HAPI_NodeFlagsBits
Definition: HAPI_Common.h:559
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:228
Data for a Sphere Part.
Definition: HAPI_Common.h:2041
Sent when a node was removed from the graph.
Definition: HAPI_Common.h:975
HAPI_AttributeTypeInfo
Definition: HAPI_Common.h:660
HAPI_Bool haveObjectsChanged
Definition: HAPI_Common.h:1245
A Transform with Quaternion rotation.
Definition: HAPI_Common.h:1083
#define HAPI_EULER_VECTOR_SIZE
Definition: HAPI_Common.h:21
HAPI_Bool cookUsingHoudiniTime
Definition: HAPI_Common.h:2149
HAPI_Bool hasTaper
Definition: HAPI_Common.h:1929
HAPI_Int64 sharedMemoryBufferSize
Definition: HAPI_Common.h:1176
HAPI_GroupType
Definition: HAPI_Common.h:561
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1896
#define HAPI_C_STRUCT_TYPEDEF(struct_name)
Definition: HAPI_Common.h:108
HAPI_Bool isVisible
Definition: HAPI_Common.h:1648
Field + Single Selection Menu.
Definition: HAPI_Common.h:485
Sent when an warning is issued by the node.
Definition: HAPI_Common.h:956
int HAPI_NodeId
See HAPI_Nodes_Basics.
Definition: HAPI_Common.h:165
HAPI_PartId id
Id to identify this part relative to it's Geo.
Definition: HAPI_Common.h:1725
Describes an image format, used with HAPI_GetSupportedImageFileFormats()
Definition: HAPI_Common.h:1839
HAPI_CacheProperty
Identifies a memory cache.
Definition: HAPI_Common.h:876
HAPI_TCP_PortType
Definition: HAPI_Common.h:1062
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1657
You should abort the cook.
Definition: HAPI_Common.h:295
Sent when a node was connected to another node.
Definition: HAPI_Common.h:979
int primitiveGroupCount
Definition: HAPI_Common.h:1711
HAPI_PrmScriptType scriptType
The Houdini script-type of the parm.
Definition: HAPI_Common.h:1436
Data for a single Key Frame.
Definition: HAPI_Common.h:1877
HAPI_Int64 totalArrayElements
Definition: HAPI_Common.h:1810
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1214
Mini Menu Only, Single Selection.
Definition: HAPI_Common.h:483
int HAPI_AssetLibraryId
Definition: HAPI_Common.h:162
HAPI_Bool isClosed
Similar to isPeriodic, but creates a polygon instead of a separate point.
Definition: HAPI_Common.h:1995
A special enum that represents the OR of both the CookError and CookWarning events.
Definition: HAPI_Common.h:1020
Parameter is not a menu.
Definition: HAPI_Common.h:479
2x2 Bounding box
Definition: HAPI_Common.h:686
#define HAPI_C_ENUM_TYPEDEF(enum_name)
[HAPI_InputCurve]
Definition: HAPI_Common.h:106
HAPI_TransformComponent
Definition: HAPI_Common.h:751
int filePathSH
The file path of the output.
Definition: HAPI_Common.h:2097
HAPI_Bool hasTransformChanged
Definition: HAPI_Common.h:1638
HAPI_StringHandle objectInstancePathSH
Definition: HAPI_Common.h:1634
int8_t HAPI_Int8
Definition: HAPI_Common.h:140
HAPI_Bool hasMin
Definition: HAPI_Common.h:1504
HAPI_StringHandle internalNodePathSH
Definition: HAPI_Common.h:1376
An empty, undefined event. Should be ignored.
Definition: HAPI_Common.h:931
HAPI_Bool preferOutputNodes
Definition: HAPI_Common.h:1343
HAPI_Bool disabled
Whether this parm should appear enabled or disabled.
Definition: HAPI_Common.h:1524
HAPI_Bool handleBoxPartTypes
Definition: HAPI_Common.h:1325
HAPI_StringHandle msgSH
String handle of the event message (> 0 if there is a message).
Definition: HAPI_Common.h:2072
Meta-data for a combo-box / choice parm.
Definition: HAPI_Common.h:1584
HAPI_SessionType type
Definition: HAPI_Common.h:1114
HAPI_NodeFlags inputNodeFlag
Definition: HAPI_Common.h:1554
int HAPI_PartId
Definition: HAPI_Common.h:173
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1666
Dual Channel.
Definition: HAPI_Common.h:814
uint8_t HAPI_UInt8
Definition: HAPI_Common.h:135
HAPI_Bool isChildOfMultiParm
Definition: HAPI_Common.h:1558