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