Houdini Engine 8.0
 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 #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 
262 
265 
267 
269 };
271 
273 {
276 };
278 typedef int HAPI_ErrorCodeBits;
279 
281 {
288 };
290 
292 {
293  /// Everything cook successfully without errors
295  /// You should abort the cook.
297  /// Only some objects failed.
304 
306 };
308 
310 {
316 };
318 
320 {
326 };
328 
330 {
335 };
337 
338 /// Represents the data type of a parm.
339 /// As you can see, some of these high level types share the same underlying
340 /// raw data type. For instance, both string and file parameter types can be
341 /// represented with strings, yet semantically they are different. We will
342 /// group high level parameter types that share an underlying raw data type
343 /// together, so you can always check the raw data type of a parameter based
344 /// on its high level data type by checking a range of values.
346 {
347  /// @{
352  /// }@
353 
354  /// @{
357  /// @}
358 
359  /// @{
364  /// @}
365 
367 
368  /// @{
371  /// @}
372 
373  /// @{
378  /// @}
379 
380  // Helpers
381 
382  /// Total number of supported parameter types.
384 
387 
390 
393 
396 
399 
402 
405 };
407 
408 /// Corresponds to the types as shown in the Houdini Type Properties
409 /// window and in DialogScript files. Available on HAPI_ParmInfo
410 /// See: <a href="http://www.sidefx.com/docs/houdini/ref/windows/optype.html#parmtypes">Parameter types</a>
411 ///
413 {
414  /// "int", "integer"
423  /// "toggle", "embed"
427  /// "vector", "vector3"
431  /// "intvector", "intvector3"
436  /// "dir", "direction"
438  /// "color", "rgb"
440  /// "color4", "rgba"
464 
465  /// The following apply to HAPI_PARMTYPE_FOLDER type parms.
466  /// Radio buttons Folder
468  /// Collapsible Folder
470  /// Simple Folder
472  /// Tabs Folder
474 };
476 
478 {
479  /// Parameter is not a menu
481  /// Menu Only, Single Selection
483  /// Mini Menu Only, Single Selection
485  /// Field + Single Selection Menu
487  /// Field + Multiple Selection Menu
489 };
491 
493 {
495  /// Just the presets binary blob
497  /// Presets blob within an .idx file format
500 };
502 
504 {
518 };
520 typedef int HAPI_NodeTypeBits;
521 
522 /// Flags used to filter compositions of node lists.
523 /// Flags marked 'Recursive Flag' will exclude children whos parent does not
524 /// satisfy the flag, even if the children themselves satisfy the flag.
526 {
529  /// Recursive Flag
531  /// Recursive Flag
538 
539  /// OBJ Node Specific Flags
544 
545  /// SOP Node Specific Flags
546  /// Looks for "curve"
548  /// Looks for Guide Geometry
550 
551  /// TOP Node Specific Flags
552  /// All TOP nodes except schedulers
554 
555  /// Recursive Flag
556  /// Nodes that are not bypassed
558 };
560 typedef int HAPI_NodeFlagsBits;
561 
563 {
569 };
571 
573 {
580 };
582 
584 {
590 };
592 
594 {
599 };
601 
603 {
609 };
611 
613 {
618 };
620 
622 {
630 };
632 
634 {
636 
646 
656 
658 };
660 
662 {
664  /// Implicit type based on data
666  /// Position
668  /// Homogeneous position
670  /// Direction vector
672  /// Normal
674  /// Color
676  /// Quaternion
678  /// 3x3 Matrix
680  /// Matrix
682  /// Parametric interval
684  /// "Private" (hidden)
686  /// 2x2 Bounding box
688  /// 3x3 Bounding box
690  /// Texture coordinate
693 };
695 
697 {
699 
700  /// Most geos will be of this type which essentially means a geo
701  /// not of the other types.
703 
704  /// An exposed edit node.
705  /// See @ref HAPI_IntermediateAssetsResults.
707 
708  /// An input geo that can accept geometry from the host.
709  /// See @ref HAPI_AssetInputs_MarshallingGeometryIntoHoudini.
711 
712  /// A curve.
713  /// See @ref HAPI_Curves.
715 
717 };
719 
721 {
730 };
732 
734 {
739 };
741 
743 {
749 };
751 
753 {
767 };
769 
771 {
772  HAPI_TRS = 0,
778 
780 };
782 
784 {
785  HAPI_XYZ = 0,
791 
793 };
795 
797 {
805 
807 };
809 
811 {
813  HAPI_IMAGE_PACKING_SINGLE, /// Single Channel
814  HAPI_IMAGE_PACKING_DUAL, /// Dual Channel
816  HAPI_IMAGE_PACKING_BGR, /// RGB Reversed
818  HAPI_IMAGE_PACKING_ABGR, /// RGBA Reversed
820 
823 };
825 
826 /// Used with ::HAPI_GetEnvInt() to retrieve basic information
827 /// about the HAPI implementation currently being linked
828 /// against. Note that as of HAPI version 2.0, these enum values are
829 /// guaranteed never to change so you can reliably get this information from
830 /// any post-2.0 version of HAPI. The same goes for the actual
831 /// ::HAPI_GetEnvInt() API call.
833 {
835 
836  /// The three components of the Houdini version that HAPI is
837  /// expecting to link against.
838  /// @{
843  /// @}
844 
845  /// The two components of the Houdini Engine (marketed) version.
846  /// @{
849  /// @}
850 
851  /// This is a monotonously increasing API version number that can be used
852  /// to lock against a certain API for compatibility purposes. Basically,
853  /// when this number changes code compiled against the HAPI.h methods
854  /// might no longer compile. Semantic changes to the methods will also
855  /// cause this version to increase. This number will be reset to 0
856  /// every time the Houdini Engine version is bumped.
858 
860 };
862 
863 /// This enum is to be used with ::HAPI_GetSessionEnvInt() to retrieve basic
864 /// session-specific information.
866 {
868 
869  /// License Type. See ::HAPI_License.
871 
873 };
875 
876 /// Identifies a memory cache
878 {
879  /// Current memory usage in MB. Setting this to 0 invokes
880  /// a cache clear.
882 
883  HAPI_CACHEPROP_HAS_MIN, /// True if it actually has a minimum size.
884  HAPI_CACHEPROP_MIN, /// Min cache memory limit in MB.
885  HAPI_CACHEPROP_HAS_MAX, /// True if it actually has a maximum size.
886  HAPI_CACHEPROP_MAX, /// Max cache memory limit in MB.
887 
888  /// How aggressive to cull memory. This only works for:
889  /// - ::HAPI_CACHE_COP2_COOK where:
890  /// 0 -> Never reduce inactive cache.
891  /// 1 -> Always reduce inactive cache.
892  /// - ::HAPI_CACHE_OBJ where:
893  /// 0 -> Never enforce the max memory limit.
894  /// 1 -> Always enforce the max memory limit.
895  /// - ::HAPI_CACHE_SOP where:
896  /// 0 -> When to Unload = Never
897  /// When to Limit Max Memory = Never
898  /// 1-2 -> When to Unload = Based on Flag
899  /// When to Limit Max Memory = Never
900  /// 3-4 -> When to Unload = Based on Flag
901  /// When to Limit Max Memory = Always
902  /// 5 -> When to Unload = Always
903  /// When to Limit Max Memory = Always
905 };
906 
908 
909 /// Type of sampling for heightfield
911 {
914 };
916 
917 /// Used with PDG functions
919 {
923 
925 };
927 
928 /// Used with PDG functions
930 {
931  /// An empty, undefined event. Should be ignored.
933 
934  /// Sent when a new work item is added by a node
936  /// Sent when a work item is deleted from a node
938  /// Sent when a work item's state changes
940 
941  /// Sent when a work item has a dependency added
943  /// Sent when a dependency is removed from a work item
945 
946  /// Sent from dynamic work items that generate from a cooked item
948  /// Sent when the parent item for a work item is deleted
950 
951  /// A node event that indicates that node is about to have all its work items cleared
953 
954  /// Sent when an error is issued by the node
956  /// Sent when an warning is issued by the node
958 
959  /// Sent for each node in the graph, when a cook completes
961 
962  /// A node event indicating that one more items in the node will be dirtied
964  /// A node event indicating that the node has finished dirtying items
966 
967  /// A event indicating that the entire graph is about to be dirtied
969 
970  /// A work item event that indicates the item has been selected in the TOPs UI
972 
973  /// Sent when a new node is created
975  /// Sent when a node was removed from the graph
977  /// Sent when a node was renamed
979  /// Sent when a node was connected to another node
981  /// Sent when a node is disconnected from another node
983  /// Sent when a node cooks for the first time
985 
986  /// Deprecated
988  /// Deprecated
990  /// Deprecated
992  /// Deprecated
994  /// Deprecated
996  /// Deprecated
998  /// Deprecated
1000  /// Deprecated
1002  /// Sent when an output file is added to a work item
1004 
1005  /// Deprecated
1007  /// Sent for each node in the graph, when a cook starts
1009  /// Deprecated
1011  /// Deprecated
1013 
1014  /// Deprecated
1016  /// Deprecated
1018  /// A special enum that represents the OR of all event types
1020  /// A special enum that represents the OR of both the `CookError` and `CookWarning` events
1022 
1023  /// Sent when a new scheduler is added to the graph
1025  /// Sent when a scheduler is removed from the graph
1027  /// Deprecated
1029  /// Deprecated
1031 
1032  /// Sent when a node finishes cooking
1034  /// Sent when a node finished generating
1036 
1037  /// Sent when a work item's frame changes
1039 
1041 };
1043 
1044 /// Used with PDG functions
1046 {
1057 };
1059 
1060 /// Backwards compatibility for HAPI_PDG_WorkitemState
1062 
1064 {
1068 };
1070 
1072 {
1075 };
1077 
1078 /////////////////////////////////////////////////////////////////////////////
1079 // Main API Structs
1080 
1081 // GENERICS -----------------------------------------------------------------
1082 
1083 /// A Transform with Quaternion rotation
1085 {
1086  float position[ HAPI_POSITION_VECTOR_SIZE ];
1087  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
1088  float scale[ HAPI_SCALE_VECTOR_SIZE ];
1089  float shear[ HAPI_SHEAR_VECTOR_SIZE ];
1090 
1092 };
1094 
1095 /// A Transform with Euler rotation
1097 {
1098  float position[ HAPI_POSITION_VECTOR_SIZE ];
1099  float rotationEuler[ HAPI_EULER_VECTOR_SIZE ];
1100  float scale[ HAPI_SCALE_VECTOR_SIZE ];
1101  float shear[ HAPI_SHEAR_VECTOR_SIZE ];
1102 
1105 };
1107 
1108 // SESSIONS -----------------------------------------------------------------
1109 
1110 /// Identifies a session
1112 {
1113  /// The type of session determines the which implementation will be
1114  /// used to communicate with the Houdini Engine library.
1116 
1117  /// Some session types support multiple simultaneous sessions. This means
1118  /// that each session needs to have a unique identifier.
1119  HAPI_SessionId id;
1120 };
1122 
1123 /// Configurations for sessions
1125 {
1126  /// The number of subconnections in this session
1128 
1129  /// Specification for the port numbers
1131 
1132  /// Specifies a range of port numbers, [minPort, maxPort]
1133  int minPort;
1134  int maxPort;
1135 
1136  /// Specifies a list of port numbers
1138 
1139  // Must match the buffer type passed to the HARS executable through the
1140  // command line or ::HAPI_StartThriftSharedMemoryServer
1142 
1143  // Must match the buffer size passed to the HARS executable through the
1144  // command line or ::HAPI_StartThriftSharedMemoryServer. This is the size of
1145  // the shared memory buffer in megabytes (MB).
1147 
1149 };
1151 
1152 /// Options to configure a Thrift server being started from HARC.
1154 {
1155  /// Close the server automatically when all clients disconnect from it.
1157 
1158  /// Timeout in milliseconds for waiting on the server to
1159  /// signal that it's ready to serve. If the server fails
1160  /// to signal within this time interval, the start server call fails
1161  /// and the server process is terminated.
1162  float timeoutMs;
1163 
1164  // Specifies the maximum status verbosity that will be logged.
1166 
1167  // Only used when starting a Thrift shared memory server. This controls the
1168  // type of buffer that is used in the underlying communication protocol. A
1169  // fixed length buffer is faster but the data passed to any single HAPI API
1170  // call cannot exceed the total length of the buffer. A ring buffer is
1171  // slower but has no limitations on the size of the data.
1173 
1174  // Only used when starting a Thrift shared memory server. This variable
1175  // specifies the size in megabytes (MB) of the allocated shared memory
1176  // buffer.
1178 };
1180 
1181 // TIME ---------------------------------------------------------------------
1182 
1183 /// Data for global timeline, used with ::HAPI_SetTimelineOptions()
1185 {
1186  double fps;
1187 
1188  double startTime;
1189  double endTime;
1190 };
1192 
1193 // ASSETS -------------------------------------------------------------------
1194 
1195 /// Meta-data about an HDA, returned by ::HAPI_GetAssetInfo()
1197 {
1198  /// Use the node id to get the asset's parameters.
1199  /// See @ref HAPI_Nodes_Basics.
1200  HAPI_NodeId nodeId;
1201 
1202  /// The objectNodeId differs from the regular nodeId in that for
1203  /// geometry based assets (SOPs) it will be the node id of the dummy
1204  /// object (OBJ) node instead of the asset node. For object based assets
1205  /// the objectNodeId will equal the nodeId. The reason the distinction
1206  /// exists is because transforms are always stored on the object node
1207  /// but the asset parameters may not be on the asset node if the asset
1208  /// is a geometry asset so we need both.
1209  HAPI_NodeId objectNodeId;
1210 
1211  /// It's possible to instantiate an asset without cooking it.
1212  /// See @ref HAPI_Assets_Cooking.
1214 
1215  HAPI_StringHandle nameSH; /// Instance name (the label + a number).
1216  HAPI_StringHandle labelSH; /// This is what any end user should be shown.
1217  HAPI_StringHandle filePathSH; /// Path to the .otl library file.
1218  HAPI_StringHandle versionSH; /// User-defined asset version.
1219  HAPI_StringHandle fullOpNameSH; /// Full asset name and namespace.
1220  HAPI_StringHandle helpTextSH; /// Asset help marked-up text.
1221  HAPI_StringHandle helpURLSH; /// Asset help URL.
1222 
1223  int objectCount; /// See @ref HAPI_Objects.
1224  int handleCount; /// See @ref HAPI_Handles.
1225 
1226  /// Transform inputs exposed by the asset. For OBJ assets this is the
1227  /// number of transform inputs on the OBJ node. For SOP assets, this is
1228  /// the singular transform input on the dummy wrapper OBJ node.
1229  /// See @ref HAPI_AssetInputs.
1231 
1232  /// Geometry inputs exposed by the asset. For SOP assets this is
1233  /// the number of geometry inputs on the SOP node itself. OBJ assets
1234  /// will always have zero geometry inputs.
1235  /// See @ref HAPI_AssetInputs.
1237 
1238  /// Geometry outputs exposed by the asset. For SOP assets this is
1239  /// the number of geometry outputs on the SOP node itself. OBJ assets
1240  /// will always have zero geometry outputs.
1241  /// See @ref HAPI_AssetInputs.
1243 
1244  /// For incremental updates. Indicates whether any of the assets's
1245  /// objects have changed. Refreshed only during an asset cook.
1247 
1248  /// For incremental updates. Indicates whether any of the asset's
1249  /// materials have changed. Refreshed only during an asset cook.
1251 };
1253 
1254 /// Options which affect how nodes are cooked.
1256 {
1257  /// Normally, geos are split into parts in two different ways. First it
1258  /// is split by group and within each group it is split by primitive type.
1259  ///
1260  /// For example, if you have a geo with group1 covering half of the mesh
1261  /// and volume1 and group2 covering the other half of the mesh, all of
1262  /// curve1, and volume2 you will end up with 5 parts. First two parts
1263  /// will be for the half-mesh of group1 and volume1, and the last three
1264  /// will cover group2.
1265  ///
1266  /// This toggle lets you disable the splitting by group and just have
1267  /// the geo be split by primitive type alone. By default, this is true
1268  /// and therefore geos will be split by group and primitive type. If
1269  /// set to false, geos will only be split by primitive type.
1271  HAPI_StringHandle splitGroupSH;
1272 
1273  /// This toggle lets you enable the splitting by unique values
1274  /// of a specified attribute. By default, this is false and
1275  /// the geo be split as described above.
1276  /// as described above. If this is set to true, and splitGeosByGroup
1277  /// set to false, mesh geos will be split on attribute values
1278  /// The attribute name to split on must be created with HAPI_SetCustomString
1279  /// and then the splitAttrSH handle set on the struct.
1281  HAPI_StringHandle splitAttrSH;
1282 
1283  /// For meshes only, this is enforced by convexing the mesh. Use -1
1284  /// to avoid convexing at all and get some performance boost.
1286 
1287  /// For curves only.
1288  /// If this is set to true, then all curves will be refined to a linear
1289  /// curve and you can no longer access the original CVs. You can control
1290  /// the refinement detail via ::HAPI_CookOptions::curveRefineLOD.
1291  /// If it's false, the curve type (NURBS, Bezier etc) will be left as is.
1293 
1294  /// Controls the number of divisions per unit distance when refining
1295  /// a curve to linear. The default in Houdini is 8.0.
1297 
1298  /// If this option is turned on, then we will recursively clear the
1299  /// errors and warnings (and messages) of all nodes before performing
1300  /// the cook.
1302 
1303  /// Decide whether to recursively cook all templated geos or not.
1305 
1306  /// Decide whether to split points by vertex attributes. This takes
1307  /// all vertex attributes and tries to copy them to their respective
1308  /// points. If two vertices have any difference in their attribute values,
1309  /// the corresponding point is split into two points. This is repeated
1310  /// until all the vertex attributes have been copied to the points.
1311  ///
1312  /// With this option enabled, you can reduce the total number of vertices
1313  /// on a game engine side as sharing of attributes (like UVs) is optimized.
1314  /// To make full use of this feature, you have to think of Houdini points
1315  /// as game engine vertices (sharable). With this option OFF (or before
1316  /// this feature existed) you had to map Houdini vertices to game engine
1317  /// vertices, to make sure all attribute values are accounted for.
1319 
1320  /// Choose how you want the cook to handle packed primitives.
1321  /// The default is: ::HAPI_PACKEDPRIM_INSTANCING_MODE_DISABLED
1323 
1324  /// Choose which special part types should be handled. Unhandled special
1325  /// part types will just be refined to ::HAPI_PARTTYPE_MESH.
1328 
1329  /// If enabled, sets the ::HAPI_PartInfo::hasChanged member during the
1330  /// cook. If disabled, the member will always be true. Checking for
1331  /// part changes can be expensive, so there is a potential performance
1332  /// gain when disabled.
1334 
1335  /// This toggle lets you enable the caching of the mesh topology.
1336  /// By default, this is false. If this is set to true, cooking a mesh
1337  /// geometry will update only the topology if the number of points changed.
1338  /// Use this to get better performance on deforming meshes.
1340 
1341  /// If enabled, calls to ::HAPI_CookNode() on an OBJ node will cook the output
1342  /// nodes of any nested SOP nodes. If none exist or the option is disabled,
1343  /// HAPI will instead cook the display nodes of any nested SOP nodes.
1345 
1346  /// For internal use only. :)
1348 };
1350 
1351 // NODES --------------------------------------------------------------------
1352 
1353 /// Meta-data for a Houdini Node
1355 {
1356  HAPI_NodeId id;
1357  HAPI_NodeId parentId;
1358  HAPI_StringHandle nameSH;
1360 
1361  /// Always true unless the asset's definition has changed due to loading
1362  /// a duplicate asset definition and from another OTL asset library
1363  /// file OR deleting the OTL asset library file used by this node's asset.
1365 
1366  /// Total number of cooks of this node.
1368 
1369  /// Use this unique id to grab the OP_Node pointer for this node.
1370  /// If you're linking against the C++ HDK, include the OP_Node.h header
1371  /// and call OP_Node::lookupNode().
1373 
1374  /// This is the internal node path in the Houdini scene graph. This path
1375  /// is meant to be abstracted away for most client purposes but for
1376  /// advanced uses it can come in handy.
1377  HAPI_StringHandle internalNodePathSH;
1378 
1379  /// Total number of parameters this asset has exposed. Includes hidden
1380  /// parameters.
1381  /// See @ref HAPI_Parameters.
1383 
1384  /// Number of values. A single parameter may have more than one value so
1385  /// this number is more than or equal to ::HAPI_NodeInfo::parmCount.
1386  /// @{
1390  /// @}
1391 
1392  /// The total number of choices among all the combo box parameters.
1393  /// See @ref HAPI_Parameters_ChoiceLists.
1395 
1396  /// The number of child nodes. This is 0 for all nodes that are not
1397  /// node networks.
1399 
1400  /// The number of inputs this specific node has.
1402 
1403  /// The number of outputs this specific node has.
1405 
1406  /// Nodes created via scripts or via ::HAPI_CreateNode() will be have
1407  /// this set to true. Only such nodes can be deleted using
1408  /// ::HAPI_DeleteNode().
1410 
1411  /// Indicates if this node will change over time
1413 };
1415 
1416 // PARAMETERS ---------------------------------------------------------------
1417 
1418 ///
1419 /// Contains parameter information like name, label, type, and size.
1420 ///
1422 {
1423  /// The parent id points to the id of the parent parm
1424  /// of this parm. The parent parm is something like a folder.
1425  HAPI_ParmId id;
1426 
1427  /// Parameter id of the parent of this parameter.
1428  HAPI_ParmId parentId;
1429 
1430  /// Child index within its immediate parent parameter.
1432 
1433  /// The HAPI type of the parm
1435 
1436  /// The Houdini script-type of the parm
1438 
1439  /// Some parameter types require additional type information.
1440  /// - File path parameters will indicate what file extensions they
1441  /// expect in a space-separated list of wild-cards. This is set
1442  /// in the Operator Type Properties using the File Pattern
1443  /// parameter property.
1444  /// For example, for filtering by PNG and JPG only: "*.png *.jpg"
1445  HAPI_StringHandle typeInfoSH;
1446 
1447  /// For the majority of parameter types permission will not be applicable.
1448  /// For file path parameters these permissions will indicate how the
1449  /// asset plans to use the file: whether it will only read it, only write
1450  /// to it, or both. This is set in the Operator Type Properties using
1451  /// the Browse Mode parameter property.
1453 
1454  /// Number of tags on this paramter.
1456 
1457  /// Tuple size. For scalar parameters this value is 1, but for vector
1458  /// parameters this value can be greater. For example, a 3 vector would
1459  /// have a size of 3. For folders and folder lists, this value is the
1460  /// number of children they own.
1461  int size;
1462 
1463  /// Any ::HAPI_ParmType can be a choice list. If this is set to
1464  /// ::HAPI_CHOICELISTTYPE_NONE, than this parameter is NOT a choice list.
1465  /// Otherwise, the parameter is a choice list of the indicated type.
1466  /// See @ref HAPI_Parameters_ChoiceLists.
1468 
1469  /// Any ::HAPI_ParmType can be a choice list. If the parameter is a
1470  /// choice list, this tells you how many choices it currently has.
1471  /// Note that some menu parameters can have a dynamic number of choices
1472  /// so it is important that this count is re-checked after every cook.
1473  /// See @ref HAPI_Parameters_ChoiceLists.
1475 
1476  /// Note that folders are not real parameters in Houdini so they do not
1477  /// have names. The folder names given here are generated from the name
1478  /// of the folderlist (or switcher) parameter which is a parameter. The
1479  /// folderlist parameter simply defines how many of the "next" parameters
1480  /// belong to the first folder, how many of the parameters after that
1481  /// belong to the next folder, and so on. This means that folder names
1482  /// can change just by reordering the folders around so don't rely on
1483  /// them too much. The only guarantee here is that the folder names will
1484  /// be unique among all other parameter names.
1485  HAPI_StringHandle nameSH;
1486 
1487  /// The label string for the parameter
1488  HAPI_StringHandle labelSH;
1489 
1490  /// If this parameter is a multiparm instance than the
1491  /// ::HAPI_ParmInfo::templateNameSH will be the hash-templated parm name,
1492  /// containing #'s for the parts of the name that use the instance number.
1493  /// Compared to the ::HAPI_ParmInfo::nameSH, the ::HAPI_ParmInfo::nameSH
1494  /// will be the ::HAPI_ParmInfo::templateNameSH but with the #'s
1495  /// replaced by the instance number. For regular parms, the
1496  /// ::HAPI_ParmInfo::templateNameSH is identical to the
1497  /// ::HAPI_ParmInfo::nameSH.
1498  HAPI_StringHandle templateNameSH;
1499 
1500  /// The help string for this parameter
1501  HAPI_StringHandle helpSH;
1502 
1503  /// Whether min/max exists for the parameter values.
1504  /// @{
1509  /// @}
1510 
1511  /// Parameter value range, shared between int and float parameters.
1512  /// @{
1513  float min;
1514  float max;
1515  float UIMin;
1516  float UIMax;
1517  /// @}
1518 
1519  /// Whether this parm should be hidden from the user entirely. This is
1520  /// mostly used to expose parameters as asset meta-data but not allow the
1521  /// user to directly modify them.
1523 
1524  /// Whether this parm should appear enabled or disabled.
1526 
1527  /// If true, it means this parameter doesn't actually exist on the node
1528  /// in Houdini but was added by Houdini Engine as a spare parameter.
1529  /// This is just for your information. The behaviour of this parameter
1530  /// is not any different than a non-spare parameter.
1532 
1533  HAPI_Bool joinNext; /// Whether this parm should be on the same line as
1534  /// the next parm.
1535  HAPI_Bool labelNone; /// Whether the label should be displayed.
1536 
1537  /// The index to use to look into the values array in order to retrieve
1538  /// the actual value(s) of this parameter.
1539  /// @{
1544  /// @}
1545 
1546  /// If this is a ::HAPI_PARMTYPE_NODE, this tells you what node types
1547  /// this parameter accepts.
1549 
1550  /// The node input parameter could have another subtype filter specified,
1551  /// like "Object: Geometry Only". In this case, this value will specify
1552  /// that extra filter. If the filter demands a node that HAPI does not
1553  /// support, both this and ::HAPI_ParmInfo::inputNodeType will be set to
1554  /// NONE as such a node is not settable through HAPI.
1556 
1557  /// See @ref HAPI_Parameters_MultiParms.
1558  /// @{
1560 
1561  int instanceNum; /// The index of the instance in the multiparm.
1562  int instanceLength; /// The number of parms in a multiparm instance.
1563  int instanceCount; /// The number of instances in a multiparm.
1564 
1565  /// First instance's ::HAPI_ParmInfo::instanceNum. Either 0 or 1.
1567 
1569  /// @}
1570 
1571  /// Provides the raw condition string which is used to evaluate the
1572  /// the visibility of a parm
1573  HAPI_StringHandle visibilityConditionSH;
1574 
1575  /// Provides the raw condition string which is used to evalute whether
1576  /// a parm is enabled or disabled
1577  HAPI_StringHandle disabledConditionSH;
1578 
1579  /// Whether or not the "Use Menu Item Token As Value" checkbox was checked in a integer menu item.
1581 };
1583 
1584 /// Meta-data for a combo-box / choice parm
1586 {
1587  HAPI_ParmId parentParmId;
1588  HAPI_StringHandle labelSH;
1589 
1590  /// This evaluates to the value of the token associated with the label
1591  /// applies to string menus only.
1592  HAPI_StringHandle valueSH;
1593 };
1595 
1596 // HANDLES ------------------------------------------------------------------
1597 
1598 ///
1599 /// Contains handle information such as the type of handle
1600 /// (translate, rotate, scale, softxform ...etc) and the number of
1601 /// parameters the current handle is bound to.
1602 ///
1604 {
1605  HAPI_StringHandle nameSH;
1606  HAPI_StringHandle typeNameSH;
1607 
1609 };
1611 
1612 ///
1613 /// Contains binding information that maps the handle parameter to
1614 /// the asset parameter. The index is only used for int and float vector
1615 /// and colour parms.
1616 ///
1618 {
1619  HAPI_StringHandle handleParmNameSH;
1620  HAPI_StringHandle assetParmNameSH;
1621 
1622  HAPI_ParmId assetParmId;
1624 };
1626 
1627 // OBJECTS ------------------------------------------------------------------
1628 
1629 /// Meta-data for an OBJ Node
1631 {
1632  HAPI_StringHandle nameSH;
1633 
1634  /// @deprecated This member is no longer used
1635  HAPI_StringHandle objectInstancePathSH;
1636 
1637  /// For incremental updates. Indicates whether the object's transform
1638  /// has changed. Refreshed only during an asset cook.
1640 
1641  /// For incremental updates. Indicates whether any of the object's
1642  /// geometry nodes have changed. Refreshed only during an asset cook.
1644 
1645  /// Whether the object is hidden and should not be shown. Some objects
1646  /// should be hidden but still brought into the host environment, for
1647  /// example those used only for instancing.
1648  /// See @ref HAPI_Instancing.
1650 
1651  /// See @ref HAPI_Instancing.
1653 
1654  /// Determine if this object is being instanced. Normally, this implies
1655  /// that while this object may not be visible, it should still be
1656  /// brought into the host application because it is needed by an instancer.
1657  /// See @ref HAPI_Instancing.
1659 
1660  /// @deprecated No longer used. See @ref HAPI_Geos
1662 
1663  /// Use the node id to get the node's parameters.
1664  /// Using the HDK, you can also get the raw node C++ pointer for this
1665  /// object's internal node.
1666  /// See @ref HAPI_Nodes_Basics.
1667  HAPI_NodeId nodeId;
1668 
1669  /// If the object is an instancer, this variable gives the object id of
1670  /// the object that should be instanced.
1671  /// See @ref HAPI_Instancing.
1672  HAPI_NodeId objectToInstanceId;
1673 };
1675 
1676 // GEOMETRY -----------------------------------------------------------------
1677 
1678 /// Meta-data for a SOP Node
1680 {
1682  HAPI_StringHandle nameSH;
1683 
1684  /// Use the node id to get the node's parameters.
1685  /// Using the HDK, you can also get the raw node C++ pointer for this
1686  /// object's internal node.
1687  HAPI_NodeId nodeId;
1688 
1689  /// Whether the SOP node has been exposed by dragging it into the
1690  /// editable nodes section of the asset definition.
1692 
1693  /// Has the templated flag turned on which means "expose as read-only".
1695 
1696  /// Final Result (Display SOP).
1698 
1699  /// For incremental updates.
1701 
1702  /// @deprecated This variable is deprecated and should no longer be used.
1703  /// Materials are now separate from parts. They are maintained at the
1704  /// asset level so you only need to check if the material itself has
1705  /// changed via ::HAPI_MaterialInfo::hasChanged instead of the material
1706  /// on the part.
1708 
1709  /// Groups.
1710  /// @{
1714  /// @}
1715 
1716  /// Total number of parts this geometry contains.
1717  /// See @ref HAPI_Parts.
1719 };
1721 
1722 /// Meta-data describing a Geo Part
1724 {
1725  /// Id to identify this part relative to it's Geo
1726  HAPI_PartId id;
1727  /// String handle for the name of the part
1728  HAPI_StringHandle nameSH;
1730 
1733  /// Number of points. Note that this is NOT the number
1734  /// of "positions" as "points" may imply. If your
1735  /// geometry has 3 points then set this to 3 and not 3*3.
1737 
1738  int attributeCounts[ HAPI_ATTROWNER_MAX ];
1739 
1740  /// If this is true, don't display this part. Load its data but then
1741  /// instance it where the corresponding instancer part tells you to
1742  /// instance it.
1744 
1745  /// The number of parts that this instancer part is instancing.
1746  /// For example, if we're instancing a curve and a box, they would come
1747  /// across as two parts, hence this count would be two.
1748  /// Call ::HAPI_GetInstancedPartIds() to get the list of ::HAPI_PartId.
1750 
1751  /// The number of instances that this instancer part is instancing.
1752  /// Using the same example as with ::HAPI_PartInfo::instancedPartCount,
1753  /// if I'm instancing the merge of a curve and a box 5 times, this count
1754  /// would be 5. To be clear, all instanced parts are instanced the same
1755  /// number of times and with the same transform for each instance.
1756  /// Call ::HAPI_GetInstancerPartTransforms() to get the transform of
1757  /// each instance.
1759 
1760  /// If this is false, the underlying attribute data appear to match that of
1761  /// the previous cook. In this case you may be able to re-used marshaled
1762  /// data from the previous cook.
1764 };
1766 
1767 /// Meta-data describing an attribute
1768 /// See @ref HAPI_Attributes.
1770 {
1772 
1775 
1776  /// When converting from the Houdini native GA geometry format to the
1777  /// GT geometry format HAPI uses, some attributes might change owners.
1778  /// For example, in Houdini GA curves can have points shared by
1779  /// vertices but the GT format only supports curve vertices
1780  /// (no points). This means that if you had point attributes on a curve
1781  /// in Houdini, when it comes out of HAPI those point attributes will now
1782  /// be vertex attributes. In this case, the ::HAPI_AttributeInfo::owner
1783  /// will be set to ::HAPI_ATTROWNER_VERTEX but the
1784  /// ::HAPI_AttributeInfo::originalOwner will be ::HAPI_ATTROWNER_POINT.
1786 
1787  /// Number of attributes. This count will match the number of values
1788  /// given the owner. For example, if the owner is ::HAPI_ATTROWNER_VERTEX
1789  /// this count will be the same as the ::HAPI_PartInfo::vertexCount.
1790  /// To be clear, this is not the number of values in the attribute, rather
1791  /// it is the number of attributes. If your geometry has three 3D points
1792  /// then this count will be 3 (not 3*3) while the
1793  /// ::HAPI_AttributeInfo::tupleSize will be 3.
1794  int count;
1795 
1796  /// Number of values per attribute.
1797  /// Note that this is NOT the memory size of the attribute. It is the
1798  /// number of values per attributes. Multiplying this by the
1799  /// size of the ::HAPI_AttributeInfo::storage will give you the memory
1800  /// size per attribute.
1802 
1803  /// Total number of elements for an array attribute.
1804  /// An array attribute can be thought of as a 2 dimensional array where
1805  /// the 2nd dimension can vary in size for each element in the 1st
1806  /// dimension. Therefore this returns the total number of values in
1807  /// the entire array.
1808  /// This should be used to determine the total storage
1809  /// size needed by multiplying with ::HAPI_AttributeInfo::storage.
1810  /// Note that this will be 0 for a non-array attribute.
1812 
1813  /// Attribute type info
1814  /// This is used to help identify the type of data stored in an attribute.
1815  /// Using the type is recommended over using just an attribute's name to identify
1816  /// its purpose.
1818 };
1820 
1821 // MATERIALS ----------------------------------------------------------------
1822 
1824 {
1825  /// This is the HAPI node id for the SHOP node this material is attached
1826  /// to. Use it to get access to the parameters (which contain the
1827  /// texture paths).
1828  /// IMPORTANT: When the ::HAPI_MaterialInfo::hasChanged is true this
1829  /// @p nodeId could have changed. Do not assume ::HAPI_MaterialInfo::nodeId
1830  /// will never change for a specific material.
1831  HAPI_NodeId nodeId;
1832 
1834 
1836 };
1838 
1839 /// Describes an image format, used with ::HAPI_GetSupportedImageFileFormats()
1841 {
1842  HAPI_StringHandle nameSH;
1843  HAPI_StringHandle descriptionSH;
1844  HAPI_StringHandle defaultExtensionSH;
1845 };
1847 
1848 /// Data for an image, used with ::HAPI_GetImageInfo() and ::HAPI_SetImageInfo()
1850 {
1851  /// Unlike the other members of this struct changing imageFileFormatNameSH
1852  /// and giving this struct back to ::HAPI_SetImageInfo() nothing will happen.
1853  /// Use this member variable to derive which image file format will be used
1854  /// by the ::HAPI_ExtractImageToFile() and ::HAPI_ExtractImageToMemory()
1855  /// functions if called with image_file_format_name set to NULL. This way,
1856  /// you can decide whether to ask for a file format conversion (slower) or
1857  /// not (faster).
1858  /// (Read-only)
1859  HAPI_StringHandle imageFileFormatNameSH;
1860 
1861  int xRes;
1862  int yRes;
1863 
1865 
1866  HAPI_Bool interleaved; /// ex: true = RGBRGBRGB, false = RRRGGGBBB
1868 
1869  /// Adjust the gamma of the image. For anything less than
1870  /// ::HAPI_IMAGE_DATA_INT16, you probably want to leave this as 2.2.
1871  double gamma;
1872 };
1874 
1875 // ANIMATION ----------------------------------------------------------------
1876 
1877 /// Data for a single Key Frame
1879 {
1880  float time;
1881  float value;
1882  float inTangent;
1883  float outTangent;
1884 };
1886 
1887 // VOLUMES ------------------------------------------------------------------
1888 
1889 ///
1890 /// This represents a volume primitive but does not contain the actual voxel
1891 /// values, which can be retrieved on a per-tile basis.
1892 ///
1893 /// See @ref HAPI_Volumes.
1894 ///
1896 {
1897  HAPI_StringHandle nameSH;
1898 
1900 
1901  /// Each voxel is identified with an index. The indices will range
1902  /// between:
1903  /// [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )
1904  /// @{
1905  int xLength;
1906  int yLength;
1907  int zLength;
1908  int minX;
1909  int minY;
1910  int minZ;
1911  /// @}
1912 
1913  /// Number of values per voxel.
1914  /// The tuple size field is 1 for scalars and 3 for vector data.
1916 
1917  /// Can be either ::HAPI_STORAGETYPE_INT or ::HAPI_STORAGETYPE_FLOAT.
1919 
1920  /// The dimensions of each tile.
1921  /// This can be 8 or 16, denoting an 8x8x8 or 16x16x16 tiles.
1923 
1924  /// The transform of the volume with respect to the lengths.
1925  /// The volume may be positioned anywhere in space.
1927 
1928  /// Denotes special situations where the volume tiles are not perfect
1929  /// cubes, but are tapered instead.
1931 
1932  /// If there is taper involved, denotes the amount of taper involved.
1933  /// @{
1934  float xTaper;
1935  float yTaper;
1936  /// @}
1937 };
1939 
1940 ///
1941 /// A HAPI_VolumeTileInfo represents an cube subarray of the volume.
1942 /// The size of each dimension is ::HAPI_VolumeInfo::tileSize
1943 /// bbox [(minX, minY, minZ), (minX+tileSize, minY+tileSize, minZ+tileSize))
1944 ///
1946 {
1947  int minX;
1948  int minY;
1949  int minZ;
1951 };
1953 
1954 ///
1955 /// Describes the visual settings of a volume.
1956 ///
1958 {
1960  float iso;
1961  float density;
1962 };
1964 
1965 // CURVES -------------------------------------------------------------------
1966 
1967 ///
1968 /// Represents the meta-data associated with a curve mesh (a number
1969 /// of curves of the same type).
1971 {
1973 
1974  /// The number of curves contained in this curve mesh.
1976 
1977  /// The number of control vertices (CVs) for all curves.
1979 
1980  /// The number of knots for all curves.
1982 
1983  /// Whether the curves in this curve mesh are periodic (closed by appending a new point)
1985 
1986  /// Whether the curves in this curve mesh are rational.
1988 
1989  /// Order of 1 is invalid. 0 means there is a varying order.
1990  int order;
1991 
1992  /// Whether the curve has knots.
1994 
1995  /// Similar to isPeriodic, but creates a polygon instead of a separate point
1997 };
1999 
2000 // Curve info dealing specifically with input curves
2002 {
2003  /// The desired curve type of the curve.
2004  /// Note that this is NOT necessarily equal to the value in HAPI_CurveInfo
2005  /// in the case of curve refinement.
2007 
2008  /// The desired order for your input curve.
2009  /// This is your desired order, which may differ from HAPI_CurveInfo
2010  /// as it will do range checks and adjust the actual order accordingly.
2011  int order;
2012 
2013  /// Whether or not the curve is closed.
2014  /// May differ from HAPI_CurveInfo::isPeriodic depending on the curveType
2015  /// (e.g. A NURBs curve is never technically closed according to HAPI_CurveInfo).
2017 
2018  /// Whether or not to reverse the curve input.
2020 
2021  // Input method type (CVs or Brekapoints).
2023 
2024  // Parameterization - Only used when inputMethod is BREAKPOINTS
2026 
2027 };
2029 
2030 // BASIC PRIMITIVES ---------------------------------------------------------
2031 
2032 /// Data for a Box Part
2034 {
2035  float center[ HAPI_POSITION_VECTOR_SIZE ];
2036  float size[ HAPI_SCALE_VECTOR_SIZE ];
2037  float rotation[ HAPI_EULER_VECTOR_SIZE ];
2038 };
2040 
2041 /// Data for a Sphere Part
2043 {
2044  float center[ HAPI_POSITION_VECTOR_SIZE ];
2045  float radius;
2046 };
2048 
2049 // PDG Structs --------------------------------------------------------------
2050 
2051 /// Data associated with a PDG Event
2053 {
2054  /// id of related node.
2055  HAPI_NodeId nodeId;
2056 
2057  /// id of related work item.
2058  HAPI_PDG_WorkItemId workItemId;
2059 
2060  /// id of related work item dependency.
2061  HAPI_PDG_WorkItemId dependencyId;
2062 
2063  /// ::HAPI_PDG_WorkItemState value of current state for state change.
2065 
2066  /// ::HAPI_PDG_WorkItemState value of last state for state change.
2068 
2069  /// ::HAPI_PDG_EventType event type.
2071 
2072  /// String handle of the event message (> 0 if there is a message).
2073  HAPI_StringHandle msgSH;
2074 };
2076 
2077 /// Info for a PDG work item
2079 {
2080  /// The work item's index
2081  int index;
2082 
2083  /// The number of output files reported by the work item.
2085 
2086  /// Name of the work item
2087  HAPI_StringHandle nameSH;
2088 };
2090 
2091 /// Backwards compatibility for HAPI_PDG_WorkitemInfo
2093 
2094 /// Data for a PDG output file
2096 {
2097  /// The file path of the output.
2099 
2100  /// The file tag of the output.
2101  int tagSH;
2102 
2103  /// Hash of the output file. Properties such as the file path and
2104  /// modification time of the file are typical inputs to the hash function,
2105  /// but this will vary based on the node that is producing the output file.
2106  HAPI_Int64 hash;
2107 };
2109 
2110 /// Backwards compatibility for HAPI_PDG_WorkitemResultInfo
2112 
2113 // SESSIONSYNC --------------------------------------------------------------
2114 
2115 ///
2116 /// Contains the information for synchronizing viewport between Houdini
2117 /// and other applications. When SessionSync is enabled, Houdini will
2118 /// update this struct with its viewport state. It will also update
2119 /// its own viewport if this struct has changed.
2120 /// The data stored is in Houdini's right-handed Y-up coordinate system.
2121 ///
2123 {
2124  /// The world position of the viewport camera's pivot.
2125  float position[ HAPI_POSITION_VECTOR_SIZE ];
2126 
2127  /// The direction of the viewport camera stored as a quaternion.
2128  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
2129 
2130  /// The offset from the pivot to the viewport camera's
2131  /// actual world position.
2132  float offset;
2133 };
2135 
2136 ///
2137 /// Contains the information for synchronizing general SessionSync
2138 /// state between Houdini and other applications. When SessionSync
2139 /// is enabled, Houdini will update this struct with its state.
2140 /// It will also update its internal state if this struct has
2141 /// changed.
2142 ///
2144 {
2145  /// Specifies whether Houdini's current time is used for Houdini Engine
2146  /// cooks. This is automatically enabled in SessionSync where
2147  /// Houdini's viewport forces cooks to use Houdini's current time.
2148  /// This is disabled in non-SessionSync mode, but can be toggled to
2149  /// override default behaviour.
2151 
2152  /// Specifies whether viewport synchronization is enabled. If enabled,
2153  /// in SessionSync, Houdini will update its own viewport using
2154  /// ::HAPI_Viewport.
2156 };
2158 
2159 /// Configuration options for Houdini's compositing context
2161 {
2162  /// Specifies the maximum allowed width of an image in the compositor
2164 
2165  /// Specifies the maximum allowed height of an image in the compositor
2167 };
2169 
2170 #endif // __HAPI_COMMON_h__
HAPI_License
Definition: HAPI_Common.h:191
HAPI_NodeId objectNodeId
Definition: HAPI_Common.h:1209
"vector", "vector3"
Definition: HAPI_Common.h:428
#define HAPI_QUATERNION_VECTOR_SIZE
Definition: HAPI_Common.h:20
Min cache memory limit in MB.
Definition: HAPI_Common.h:885
A event indicating that the entire graph is about to be dirtied.
Definition: HAPI_Common.h:968
HAPI_StringHandle disabledConditionSH
Definition: HAPI_Common.h:1577
Sent when a dependency is removed from a work item.
Definition: HAPI_Common.h:944
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1682
Sent when an output file is added to a work item.
Definition: HAPI_Common.h:1003
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1485
int maximumResolutionX
Specifies the maximum allowed width of an image in the compositor.
Definition: HAPI_Common.h:2163
HAPI_NodeId nodeId
id of related node.
Definition: HAPI_Common.h:2055
Data for an image, used with HAPI_GetImageInfo() and HAPI_SetImageInfo()
Definition: HAPI_Common.h:1849
HAPI_StringHandle labelSH
Instance name (the label + a number).
Definition: HAPI_Common.h:1216
HAPI_StringHandle nameSH
String handle for the name of the part.
Definition: HAPI_Common.h:1728
HAPI_Bool isInstancer
See Instancing.
Definition: HAPI_Common.h:1652
HAPI_VolumeVisualType
Definition: HAPI_Common.h:621
Sent for each node in the graph, when a cook completes.
Definition: HAPI_Common.h:960
HAPI_Bool reverse
Whether or not to reverse the curve input.
Definition: HAPI_Common.h:2019
Sent when an error is issued by the node.
Definition: HAPI_Common.h:955
HAPI_ImageDataFormat dataFormat
Definition: HAPI_Common.h:1864
int parmStringValueCount
Definition: HAPI_Common.h:1389
HAPI_Bool clearErrorsAndWarnings
Definition: HAPI_Common.h:1301
Texture coordinate.
Definition: HAPI_Common.h:691
Recursive Flag.
Definition: HAPI_Common.h:532
Recursive Flag.
Definition: HAPI_Common.h:530
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:971
HAPI_ChoiceListType choiceListType
Definition: HAPI_Common.h:1467
int HAPI_NodeTypeBits
Definition: HAPI_Common.h:520
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:2095
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1632
Sent when a node finished generating.
Definition: HAPI_Common.h:1035
HAPI_NodeId objectToInstanceId
Definition: HAPI_Common.h:1672
HAPI_PDG_WorkItemId dependencyId
id of related work item dependency.
Definition: HAPI_Common.h:2061
HAPI_Bool refineCurveToLinear
Definition: HAPI_Common.h:1292
HAPI_StatusVerbosity verbosity
Definition: HAPI_Common.h:1165
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_1.
Definition: HAPI_Common.h:226
HAPI_ParmId id
Definition: HAPI_Common.h:1425
int HAPI_PDG_WorkItemId
Use this with PDG functions.
Definition: HAPI_Common.h:176
Just the presets binary blob.
Definition: HAPI_Common.h:496
int intValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1540
"dir", "direction"
Definition: HAPI_Common.h:437
HAPI_Bool isEditable
Definition: HAPI_Common.h:1691
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:1568
int floatValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1541
HAPI_PackedPrimInstancingMode packedPrimInstancingMode
Definition: HAPI_Common.h:1322
Parametric interval.
Definition: HAPI_Common.h:683
HAPI_SessionEnvIntType
Definition: HAPI_Common.h:865
"toggle", "embed"
Definition: HAPI_Common.h:424
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1358
#define HAPI_API
Definition: HAPI_API.h:79
OBJ Node Specific Flags.
Definition: HAPI_Common.h:540
HAPI_NodeFlags
Definition: HAPI_Common.h:525
HAPI_GeoType
Definition: HAPI_Common.h:696
A special enum that represents the OR of all event types.
Definition: HAPI_Common.h:1019
int instanceCount
The number of parms in a multiparm instance.
Definition: HAPI_Common.h:1563
HAPI_StringHandle visibilityConditionSH
Definition: HAPI_Common.h:1573
HAPI_Bool hasEverCooked
Definition: HAPI_Common.h:1213
int eventType
HAPI_PDG_EventType event type.
Definition: HAPI_Common.h:2070
HAPI_Bool haveMaterialsChanged
Definition: HAPI_Common.h:1250
HAPI_NodeType inputNodeType
Definition: HAPI_Common.h:1548
HAPI_StringHandle typeNameSH
Definition: HAPI_Common.h:1606
HAPI_Bool isPeriodic
Whether the curves in this curve mesh are periodic (closed by appending a new point) ...
Definition: HAPI_Common.h:1984
HAPI_RSTOrder
Definition: HAPI_Common.h:770
int parmFloatValueCount
Definition: HAPI_Common.h:1388
"intvector", "intvector3"
Definition: HAPI_Common.h:432
HAPI_CurveType
Definition: HAPI_Common.h:583
HAPI_PDG_State
Used with PDG functions.
Definition: HAPI_Common.h:918
HAPI_AttributeOwner owner
Definition: HAPI_Common.h:1773
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:1091
Sent when a work item has a dependency added.
Definition: HAPI_Common.h:942
Single Channel.
Definition: HAPI_Common.h:814
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1687
int uniqueHoudiniNodeId
Definition: HAPI_Common.h:1372
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1831
Sent when a node cooks for the first time.
Definition: HAPI_Common.h:984
int HAPI_HIPFileId
Definition: HAPI_Common.h:186
HAPI_ImageDataFormat
Definition: HAPI_Common.h:796
int handleCount
See Objects.
Definition: HAPI_Common.h:1224
Sent when a new node is created.
Definition: HAPI_Common.h:974
HAPI_PartType
Definition: HAPI_Common.h:720
int currentState
HAPI_PDG_WorkItemState value of current state for state change.
Definition: HAPI_Common.h:2064
HAPI_EnvIntType
Definition: HAPI_Common.h:832
HAPI_Bool isRational
Whether the curves in this curve mesh are rational.
Definition: HAPI_Common.h:1987
HAPI_Bool isValid
Definition: HAPI_Common.h:1364
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:1104
int choiceIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1543
Sent when the parent item for a work item is deleted.
Definition: HAPI_Common.h:949
HAPI_PackedPrimInstancingMode
Definition: HAPI_Common.h:309
HAPI_StringHandle labelSH
The label string for the parameter.
Definition: HAPI_Common.h:1488
True if it actually has a maximum size.
Definition: HAPI_Common.h:886
HAPI_Permissions
Definition: HAPI_Common.h:319
Sent when a node is disconnected from another node.
Definition: HAPI_Common.h:982
Info for a PDG work item.
Definition: HAPI_Common.h:2078
#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:1304
HAPI_StringHandle helpSH
The help string for this parameter.
Definition: HAPI_Common.h:1501
HAPI_VolumeVisualType type
Definition: HAPI_Common.h:1959
3x3 Bounding box
Definition: HAPI_Common.h:689
HAPI_Bool autoClose
Close the server automatically when all clients disconnect from it.
Definition: HAPI_Common.h:1156
HAPI_ThriftSharedMemoryBufferType
Definition: HAPI_Common.h:1071
HAPI_StringHandle templateNameSH
Definition: HAPI_Common.h:1498
Meta-data about an HDA, returned by HAPI_GetAssetInfo()
Definition: HAPI_Common.h:1196
HAPI_AttributeOwner
Definition: HAPI_Common.h:572
int stringValuesIndex
Whether the label should be displayed.
Definition: HAPI_Common.h:1542
HAPI_InputCurveParameterization
Definition: HAPI_Common.h:602
HAPI_StringHandle fullOpNameSH
User-defined asset version.
Definition: HAPI_Common.h:1219
Only some objects failed.
Definition: HAPI_Common.h:298
HAPI_ErrorCode
Definition: HAPI_Common.h:272
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1842
HAPI_Bool createdPostAssetLoad
Definition: HAPI_Common.h:1409
HAPI_Bool splitGeosByAttribute
Definition: HAPI_Common.h:1280
HAPI_InputCurveParameterization breakpointParameterization
Definition: HAPI_Common.h:2025
Meta-data for an OBJ Node.
Definition: HAPI_Common.h:1630
HAPI_NodeType
Definition: HAPI_Common.h:503
HAPI_CurveType curveType
Definition: HAPI_Common.h:1972
int knotCount
The number of knots for all curves.
Definition: HAPI_Common.h:1981
HAPI_Bool hasUIMax
Definition: HAPI_Common.h:1508
Sent when a work item is deleted from a node.
Definition: HAPI_Common.h:937
HAPI_StringHandle handleParmNameSH
Definition: HAPI_Common.h:1619
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:1033
HAPI_AttributeOwner originalOwner
Definition: HAPI_Common.h:1785
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_0.
Definition: HAPI_Common.h:224
HAPI_ThriftSharedMemoryBufferType sharedMemoryBufferType
Definition: HAPI_Common.h:1141
int minPort
Specifies a range of port numbers, [minPort, maxPort].
Definition: HAPI_Common.h:1133
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:1153
Total number of supported parameter types.
Definition: HAPI_Common.h:383
HAPI_ChoiceListType
Definition: HAPI_Common.h:477
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1763
HAPI_Bool enableSharedMemoryDataTransfer
Definition: HAPI_Common.h:1148
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1743
Everything cook successfully without errors.
Definition: HAPI_Common.h:294
HAPI_Bool spare
Definition: HAPI_Common.h:1531
Menu Only, Single Selection.
Definition: HAPI_Common.h:482
int index
The work item's index.
Definition: HAPI_Common.h:2081
HAPI_XYZOrder rotationOrder
Definition: HAPI_Common.h:1103
int curveCount
The number of curves contained in this curve mesh.
Definition: HAPI_Common.h:1975
HAPI_Bool cacheMeshTopology
Definition: HAPI_Common.h:1339
HAPI_PrmScriptType
Definition: HAPI_Common.h:412
A node event indicating that the node has finished dirtying items.
Definition: HAPI_Common.h:965
HAPI_Bool hasKnots
Whether the curve has knots.
Definition: HAPI_Common.h:1993
HAPI_STATIC_ASSERT(sizeof(HAPI_UInt8)==1, unsupported_size_of_uint8)
HAPI_XYZOrder
Definition: HAPI_Common.h:783
HAPI_CurveType curveType
Definition: HAPI_Common.h:2006
Data associated with a PDG Event.
Definition: HAPI_Common.h:2052
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1605
int HAPI_ParmId
Definition: HAPI_Common.h:169
int tagSH
The file tag of the output.
Definition: HAPI_Common.h:2101
HAPI_ParmId parentId
Parameter id of the parent of this parameter.
Definition: HAPI_Common.h:1428
Meta-data describing a Geo Part.
Definition: HAPI_Common.h:1723
int HAPI_ErrorCodeBits
Definition: HAPI_Common.h:278
HAPI_AttributeTypeInfo typeInfo
Definition: HAPI_Common.h:1817
int order
Order of 1 is invalid. 0 means there is a varying order.
Definition: HAPI_Common.h:1990
int instancedPartCount
Definition: HAPI_Common.h:1749
int tagCount
Number of tags on this paramter.
Definition: HAPI_Common.h:1455
int transformInputCount
See Handles.
Definition: HAPI_Common.h:1230
int outputCount
The number of outputs this specific node has.
Definition: HAPI_Common.h:1404
HAPI_TCP_PortType portType
Specification for the port numbers.
Definition: HAPI_Common.h:1130
HAPI_Bool handleSpherePartTypes
Definition: HAPI_Common.h:1327
Sent when a work item's frame changes.
Definition: HAPI_Common.h:1038
HAPI_PDG_WorkItemState
Used with PDG functions.
Definition: HAPI_Common.h:1045
int instanceStartOffset
The number of instances in a multiparm.
Definition: HAPI_Common.h:1566
int childIndex
Child index within its immediate parent parameter.
Definition: HAPI_Common.h:1431
HAPI_NodeId id
Definition: HAPI_Common.h:1356
HAPI_ImagePacking
Definition: HAPI_Common.h:810
Meta-data for a Houdini Node.
Definition: HAPI_Common.h:1354
int connectionCount
The number of subconnections in this session.
Definition: HAPI_Common.h:1127
HAPI_Transform transform
Definition: HAPI_Common.h:1926
HAPI_PDG_EventType
Used with PDG functions.
Definition: HAPI_Common.h:929
HAPI_SessionType
Definition: HAPI_Common.h:280
HAPI_StorageType storage
Definition: HAPI_Common.h:1774
Presets blob within an .idx file format.
Definition: HAPI_Common.h:498
int instanceLength
The index of the instance in the multiparm.
Definition: HAPI_Common.h:1562
int lastState
HAPI_PDG_WorkItemState value of last state for state change.
Definition: HAPI_Common.h:2067
HAPI_Permissions permissions
Definition: HAPI_Common.h:1452
Configuration options for Houdini's compositing context.
Definition: HAPI_Common.h:2160
HAPI_VolumeType
Definition: HAPI_Common.h:612
HAPI_ParmType type
The HAPI type of the parm.
Definition: HAPI_Common.h:1434
HAPI_Int64 sharedMemoryBufferSize
Definition: HAPI_Common.h:1146
License Type. See HAPI_License.
Definition: HAPI_Common.h:870
HAPI_StringHandle descriptionSH
Definition: HAPI_Common.h:1843
HAPI_HeightFieldSampling
Type of sampling for heightfield.
Definition: HAPI_Common.h:910
Field + Multiple Selection Menu.
Definition: HAPI_Common.h:488
HAPI_ImagePacking packing
ex: true = RGBRGBRGB, false = RRRGGGBBB
Definition: HAPI_Common.h:1867
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:1535
HAPI_GeoType type
Definition: HAPI_Common.h:1681
HAPI_SessionId id
Definition: HAPI_Common.h:1119
int HAPI_ProcessId
Definition: HAPI_Common.h:152
HAPI_RampType
Definition: HAPI_Common.h:329
Configurations for sessions.
Definition: HAPI_Common.h:1124
Options which affect how nodes are cooked.
Definition: HAPI_Common.h:1255
HAPI_ParmType
Definition: HAPI_Common.h:345
Homogeneous position.
Definition: HAPI_Common.h:669
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:1580
HAPI_CurveOrders
Definition: HAPI_Common.h:742
HAPI_Bool invisible
Definition: HAPI_Common.h:1522
HAPI_Bool joinNext
Definition: HAPI_Common.h:1533
A node event that indicates that node is about to have all its work items cleared.
Definition: HAPI_Common.h:952
HAPI_StringHandle splitAttrSH
Definition: HAPI_Common.h:1281
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1835
Sent when a new scheduler is added to the graph.
Definition: HAPI_Common.h:1024
HAPI_PartType type
Definition: HAPI_Common.h:1729
#define HAPI_MAX_NUM_CONNECTIONS
Definition: HAPI_Common.h:31
HAPI_StringHandle valueSH
Definition: HAPI_Common.h:1592
Identifies a session.
Definition: HAPI_Common.h:1111
HAPI_Bool haveGeosChanged
Definition: HAPI_Common.h:1643
HAPI_StringHandle versionSH
Path to the .otl library file.
Definition: HAPI_Common.h:1218
HAPI_StorageType
Definition: HAPI_Common.h:633
HAPI_Bool hasMax
Definition: HAPI_Common.h:1506
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1200
HAPI_ThriftSharedMemoryBufferType sharedMemoryBufferType
Definition: HAPI_Common.h:1172
HAPI_StringHandle defaultExtensionSH
Definition: HAPI_Common.h:1844
int maximumResolutionY
Specifies the maximum allowed height of an image in the compositor.
Definition: HAPI_Common.h:2166
Sent when a node was renamed.
Definition: HAPI_Common.h:978
HAPI_StringHandle assetParmNameSH
Definition: HAPI_Common.h:1620
Meta-data for a SOP Node.
Definition: HAPI_Common.h:1679
HAPI_Bool isDisplayGeo
Final Result (Display SOP).
Definition: HAPI_Common.h:1697
"Private" (hidden)
Definition: HAPI_Common.h:685
A Transform with Euler rotation.
Definition: HAPI_Common.h:1096
HAPI_Bool isTimeDependent
Indicates if this node will change over time.
Definition: HAPI_Common.h:1412
Sent from dynamic work items that generate from a cooked item.
Definition: HAPI_Common.h:947
HAPI_Bool hasGeoChanged
For incremental updates.
Definition: HAPI_Common.h:1700
Sent when a work item's state changes.
Definition: HAPI_Common.h:939
int vertexCount
The number of control vertices (CVs) for all curves.
Definition: HAPI_Common.h:1978
HAPI_StringHandle imageFileFormatNameSH
Definition: HAPI_Common.h:1859
int64_t HAPI_Int64
Definition: HAPI_Common.h:144
Data for global timeline, used with HAPI_SetTimelineOptions()
Definition: HAPI_Common.h:1184
HAPI_Bool hasMaterialChanged
Definition: HAPI_Common.h:1707
A node event indicating that one more items in the node will be dirtied.
Definition: HAPI_Common.h:963
HAPI_NodeId parentId
Definition: HAPI_Common.h:1357
Sent when a new work item is added by a node.
Definition: HAPI_Common.h:935
True if it actually has a minimum size.
Definition: HAPI_Common.h:884
RGBA Reversed.
Definition: HAPI_Common.h:819
HAPI_Bool isTemplated
Has the templated flag turned on which means "expose as read-only".
Definition: HAPI_Common.h:1694
Looks for Guide Geometry.
Definition: HAPI_Common.h:549
int totalCookCount
Total number of cooks of this node.
Definition: HAPI_Common.h:1367
HAPI_StringHandle filePathSH
This is what any end user should be shown.
Definition: HAPI_Common.h:1217
HAPI_Bool checkPartChanges
Definition: HAPI_Common.h:1333
char HAPI_Bool
Definition: HAPI_Common.h:119
HAPI_Bool hasUIMin
Definition: HAPI_Common.h:1507
HAPI_StringHandle typeInfoSH
Definition: HAPI_Common.h:1445
HAPI_PDG_WorkItemId workItemId
id of related work item.
Definition: HAPI_Common.h:2058
HAPI_NodeType type
Definition: HAPI_Common.h:1359
HAPI_StatusType
Definition: HAPI_Common.h:206
int extraFlags
For internal use only. :)
Definition: HAPI_Common.h:1347
HAPI_StringHandle splitGroupSH
Definition: HAPI_Common.h:1271
HAPI_PresetType
Definition: HAPI_Common.h:492
HAPI_StringHandle labelSH
Definition: HAPI_Common.h:1588
Data for a Box Part.
Definition: HAPI_Common.h:2033
HAPI_Bool interleaved
Definition: HAPI_Common.h:1866
int inputCount
The number of inputs this specific node has.
Definition: HAPI_Common.h:1401
HAPI_StringHandle helpURLSH
Asset help marked-up text.
Definition: HAPI_Common.h:1221
HAPI_ParmId parentParmId
Definition: HAPI_Common.h:1587
"int", "integer"
Definition: HAPI_Common.h:415
HAPI_Result
Definition: HAPI_Common.h:240
Direction vector.
Definition: HAPI_Common.h:671
int outputFileCount
The number of output files reported by the work item.
Definition: HAPI_Common.h:2084
HAPI_InputType
Definition: HAPI_Common.h:733
Max cache memory limit in MB.
Definition: HAPI_Common.h:904
HAPI_StringHandle nameSH
Name of the work item.
Definition: HAPI_Common.h:2087
HAPI_Bool splitGeosByGroup
Definition: HAPI_Common.h:1270
HAPI_State
Definition: HAPI_Common.h:291
HAPI_VolumeType type
Definition: HAPI_Common.h:1899
Sent for each node in the graph, when a cook starts.
Definition: HAPI_Common.h:1008
int objectCount
Asset help URL.
Definition: HAPI_Common.h:1223
HAPI_StringHandle helpTextSH
Full asset name and namespace.
Definition: HAPI_Common.h:1220
Implicit type based on data.
Definition: HAPI_Common.h:665
Sent when a scheduler is removed from the graph.
Definition: HAPI_Common.h:1026
HAPI_Bool splitPointsByVertexAttributes
Definition: HAPI_Common.h:1318
HAPI_StorageType storage
Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT.
Definition: HAPI_Common.h:1918
HAPI_InputCurveMethod
Definition: HAPI_Common.h:593
HAPI_InputCurveMethod inputMethod
Definition: HAPI_Common.h:2022
int HAPI_NodeFlagsBits
Definition: HAPI_Common.h:560
Used for Results. Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:228
Data for a Sphere Part.
Definition: HAPI_Common.h:2042
Sent when a node was removed from the graph.
Definition: HAPI_Common.h:976
HAPI_AttributeTypeInfo
Definition: HAPI_Common.h:661
HAPI_Bool haveObjectsChanged
Definition: HAPI_Common.h:1246
A Transform with Quaternion rotation.
Definition: HAPI_Common.h:1084
#define HAPI_EULER_VECTOR_SIZE
Definition: HAPI_Common.h:21
HAPI_Bool cookUsingHoudiniTime
Definition: HAPI_Common.h:2150
HAPI_Bool hasTaper
Definition: HAPI_Common.h:1930
HAPI_Int64 sharedMemoryBufferSize
Definition: HAPI_Common.h:1177
HAPI_GroupType
Definition: HAPI_Common.h:562
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1897
#define HAPI_C_STRUCT_TYPEDEF(struct_name)
Definition: HAPI_Common.h:108
HAPI_Bool isVisible
Definition: HAPI_Common.h:1649
Field + Single Selection Menu.
Definition: HAPI_Common.h:486
Sent when an warning is issued by the node.
Definition: HAPI_Common.h:957
int HAPI_NodeId
See Nodes Basics.
Definition: HAPI_Common.h:165
HAPI_PartId id
Id to identify this part relative to it's Geo.
Definition: HAPI_Common.h:1726
Describes an image format, used with HAPI_GetSupportedImageFileFormats()
Definition: HAPI_Common.h:1840
HAPI_CacheProperty
Identifies a memory cache.
Definition: HAPI_Common.h:877
HAPI_TCP_PortType
Definition: HAPI_Common.h:1063
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1658
You should abort the cook.
Definition: HAPI_Common.h:296
Sent when a node was connected to another node.
Definition: HAPI_Common.h:980
int primitiveGroupCount
Definition: HAPI_Common.h:1712
HAPI_PrmScriptType scriptType
The Houdini script-type of the parm.
Definition: HAPI_Common.h:1437
Data for a single Key Frame.
Definition: HAPI_Common.h:1878
HAPI_Int64 totalArrayElements
Definition: HAPI_Common.h:1811
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1215
Mini Menu Only, Single Selection.
Definition: HAPI_Common.h:484
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:1996
A special enum that represents the OR of both the CookError and CookWarning events.
Definition: HAPI_Common.h:1021
Parameter is not a menu.
Definition: HAPI_Common.h:480
2x2 Bounding box
Definition: HAPI_Common.h:687
#define HAPI_C_ENUM_TYPEDEF(enum_name)
[HAPI_InputCurve]
Definition: HAPI_Common.h:106
HAPI_TransformComponent
Definition: HAPI_Common.h:752
int filePathSH
The file path of the output.
Definition: HAPI_Common.h:2098
HAPI_Bool hasTransformChanged
Definition: HAPI_Common.h:1639
HAPI_StringHandle objectInstancePathSH
Definition: HAPI_Common.h:1635
int8_t HAPI_Int8
Definition: HAPI_Common.h:140
HAPI_Bool hasMin
Definition: HAPI_Common.h:1505
HAPI_StringHandle internalNodePathSH
Definition: HAPI_Common.h:1377
An empty, undefined event. Should be ignored.
Definition: HAPI_Common.h:932
HAPI_Bool preferOutputNodes
Definition: HAPI_Common.h:1344
HAPI_Bool disabled
Whether this parm should appear enabled or disabled.
Definition: HAPI_Common.h:1525
HAPI_Bool handleBoxPartTypes
Definition: HAPI_Common.h:1326
HAPI_StringHandle msgSH
String handle of the event message (> 0 if there is a message).
Definition: HAPI_Common.h:2073
Meta-data for a combo-box / choice parm.
Definition: HAPI_Common.h:1585
HAPI_SessionType type
Definition: HAPI_Common.h:1115
HAPI_NodeFlags inputNodeFlag
Definition: HAPI_Common.h:1555
int HAPI_PartId
Definition: HAPI_Common.h:173
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1667
Dual Channel.
Definition: HAPI_Common.h:815
uint8_t HAPI_UInt8
Definition: HAPI_Common.h:135
HAPI_Bool isChildOfMultiParm
Definition: HAPI_Common.h:1559