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