Houdini Engine 3.2
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
HAPI_Common.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  */
7 
8 #ifndef __HAPI_COMMON_h__
9 #define __HAPI_COMMON_h__
10 
11 #include "HAPI_API.h"
12 
13 /////////////////////////////////////////////////////////////////////////////
14 // Defines
15 
16 #define HAPI_POSITION_VECTOR_SIZE 3
17 #define HAPI_SCALE_VECTOR_SIZE 3
18 #define HAPI_SHEAR_VECTOR_SIZE 3
19 #define HAPI_NORMAL_VECTOR_SIZE 3
20 #define HAPI_QUATERNION_VECTOR_SIZE 4
21 #define HAPI_EULER_VECTOR_SIZE 3
22 #define HAPI_UV_VECTOR_SIZE 2
23 #define HAPI_COLOR_VECTOR_SIZE 4
24 #define HAPI_CV_VECTOR_SIZE 4
25 
26 #define HAPI_PRIM_MIN_VERTEX_COUNT 1
27 #define HAPI_PRIM_MAX_VERTEX_COUNT 16
28 
29 #define HAPI_INVALID_PARM_ID -1
30 
31 /// Common Default Attributes' Names
32 /// @{
33 #define HAPI_ATTRIB_POSITION "P"
34 #define HAPI_ATTRIB_UV "uv"
35 #define HAPI_ATTRIB_UV2 "uv2"
36 #define HAPI_ATTRIB_NORMAL "N"
37 #define HAPI_ATTRIB_TANGENT "tangentu"
38 #define HAPI_ATTRIB_TANGENT2 "tangentv"
39 #define HAPI_ATTRIB_COLOR "Cd"
40 #define HAPI_ATTRIB_NAME "name"
41 #define HAPI_ATTRIB_INSTANCE "instance"
42 /// @}
43 
44 /// This is the name of the primitive group created from all the primitives
45 /// that are not in any user-defined group. This way, when you put all the
46 /// groups together you cover the entire mesh. This is important for some
47 /// clients where the mesh has to be defined in terms of submeshes that cover
48 /// the entire original mesh.
49 #define HAPI_UNGROUPED_GROUP_NAME "__ungrouped_group"
50 
51 /// Common image file format names (to use with the material extract APIs).
52 /// Note that you may still want to check if they are supported via
53 /// HAPI_GetSupportedImageFileFormats() since all formats are loaded
54 /// dynamically by Houdini on-demand so just because these formats are defined
55 /// here doesn't mean they are supported in your instance.
56 /// @{
57 #define HAPI_RAW_FORMAT_NAME "HAPI_RAW" // HAPI-only Raw Format
58 #define HAPI_PNG_FORMAT_NAME "PNG"
59 #define HAPI_JPEG_FORMAT_NAME "JPEG"
60 #define HAPI_BMP_FORMAT_NAME "Bitmap"
61 #define HAPI_TIFF_FORMAT_NAME "TIFF"
62 #define HAPI_TGA_FORMAT_NAME "Targa"
63 /// @}
64 
65 /// Default image file format's name - used when the image generated and has
66 /// no "original" file format and the user does not specify a format to
67 /// convert to.
68 #define HAPI_DEFAULT_IMAGE_FORMAT_NAME HAPI_PNG_FORMAT_NAME
69 
70 /// Name of subnet OBJ node containing the global nodes.
71 #define HAPI_GLOBAL_NODES_NODE_NAME "GlobalNodes"
72 
73 /// Environment variables.
74 #define HAPI_ENV_HIP "HIP"
75 #define HAPI_ENV_JOB "JOB"
76 #define HAPI_ENV_CLIENT_NAME "HAPI_CLIENT_NAME"
77 
78 /// [HAPI_CACHE]
79 /// Common cache names. You can see these same cache names in the
80 /// Cache Manager window in Houdini (Windows > Cache Manager).
81 #define HAPI_CACHE_COP_COOK "COP Cook Cache"
82 #define HAPI_CACHE_COP_FLIPBOOK "COP Flipbook Cache"
83 #define HAPI_CACHE_IMAGE "Image Cache"
84 #define HAPI_CACHE_OBJ "Object Transform Cache"
85 #define HAPI_CACHE_GL_TEXTURE "OpenGL Texture Cache"
86 #define HAPI_CACHE_GL_VERTEX "OpenGL Vertex Cache"
87 #define HAPI_CACHE_SOP "SOP Cache"
88 #define HAPI_CACHE_VEX "VEX File Cache"
89 /// [HAPI_CACHE]
90 
91 // Make sure our enums and structs are usable without those keywords, as-is,
92 // in C.
93 #ifdef __cplusplus
94  #define HAPI_C_ENUM_TYPEDEF( enum_name )
95  #define HAPI_C_STRUCT_TYPEDEF( struct_name )
96 #else
97  #define HAPI_C_ENUM_TYPEDEF( enum_name ) \
98  typedef enum enum_name enum_name;
99  #define HAPI_C_STRUCT_TYPEDEF( struct_name ) \
100  typedef struct struct_name struct_name;
101 #endif // __cplusplus
102 
103 /////////////////////////////////////////////////////////////////////////////
104 // Typedefs
105 
106 // C has no bool.
107 #ifdef __cplusplus
108  typedef bool HAPI_Bool;
109 #else
110  typedef char HAPI_Bool;
111 #endif // __cplusplus
112 
113 // 64-bit Integers
114 typedef long long HAPI_Int64;
115 HAPI_STATIC_ASSERT( sizeof( HAPI_Int64 ) == 8, unsupported_size_of_long );
116 
117 // The process id has to be uint on Windows and int on any other platform.
118 #if ( defined _WIN32 || defined WIN32 )
119  typedef unsigned int HAPI_ProcessId;
120 #else
121  typedef int HAPI_ProcessId;
122 #endif
123 
124 /// Has to be 64-bit.
126 
127 /// Use this with HAPI_GetString() to get the value.
128 /// See @ref HAPI_Fundamentals_Strings.
129 typedef int HAPI_StringHandle;
130 
132 
133 /// See @ref HAPI_Nodes_Basics.
134 typedef int HAPI_NodeId;
135 
136 /// Either get this from the ::HAPI_ParmInfo or ::HAPI_GetParmIdFromName().
137 /// See @ref HAPI_Parameters.
138 typedef int HAPI_ParmId;
139 
140 /// Use this with ::HAPI_GetPartInfo().
141 /// See @ref HAPI_Parts.
142 typedef int HAPI_PartId;
143 
144 /// Use this with PDG functions
146 
147 /// Use this with PDG functions
149 
150 /////////////////////////////////////////////////////////////////////////////
151 // Enums
152 
154 {
162 };
164 
166 {
171 };
173 
175 {
179 
181  ///< Equivalent to ::HAPI_STATUSVERBOSITY_2.
182 
183  // Used for Results.
185  ///< Equivalent to ::HAPI_STATUSVERBOSITY_0.
187  ///< Equivalent to ::HAPI_STATUSVERBOSITY_1.
189  ///< Equivalent to ::HAPI_STATUSVERBOSITY_2.
190 };
192 
194 {
206 
213 
216 
218 
220 };
222 
224 {
227 };
229 typedef int HAPI_ErrorCodeBits;
230 
232 {
239 };
241 
243 {
244  HAPI_STATE_READY, ///< Everything cook successfully without errors.
245  HAPI_STATE_READY_WITH_FATAL_ERRORS, ///< You should abort the cook.
246  HAPI_STATE_READY_WITH_COOK_ERRORS, ///< Only some objects failed.
252 
254 };
256 
258 {
264 };
266 
268 {
274 };
276 
278 {
283 };
285 
286 /// As you can see, some of these high level types share the same underlying
287 /// raw data type. For instance, both string and file parameter types can be
288 /// represented with strings, yet semantically they are different. We will
289 /// group high level parameter types that share an underlying raw data type
290 /// together, so you can always check the raw data type of a parameter based
291 /// on its high level data type by checking a range of values.
293 {
298 
301 
306 
308 
311 
316 
317 
318  // Helpers
319 
320  HAPI_PARMTYPE_MAX, ///< Total number of supported parameter types.
321 
324 
327 
330 
333 
336 
339 
342 };
344 
345 /// Corresponds to the types as shown in the Houdini Type Properties
346 /// window and in DialogScript files. Available on HAPI_ParmInfo
347 /// See: <a href="http://www.sidefx.com/docs/houdini/ref/windows/optype.html#parmtypes">Parameter types</a>
348 ///
350 {
351  HAPI_PRM_SCRIPT_TYPE_INT = 0, ///< "int", "integer"
359  HAPI_PRM_SCRIPT_TYPE_TOGGLE, ///< "toggle", "embed"
362  HAPI_PRM_SCRIPT_TYPE_VECTOR3, ///< "vector", "vector3"
365  HAPI_PRM_SCRIPT_TYPE_INTVECTOR3, ///< "intvector", "intvector3"
369  HAPI_PRM_SCRIPT_TYPE_DIR, ///< "dir", "direction"
370  HAPI_PRM_SCRIPT_TYPE_COLOR, ///< "color", "rgb"
371  HAPI_PRM_SCRIPT_TYPE_COLOR4, ///< "color4", "rgba"
393 
394  // The following apply to HAPI_PARMTYPE_FOLDER type parms
395  HAPI_PRM_SCRIPT_TYPE_GROUPRADIO = 1000, ///< Radio buttons Folder
396  HAPI_PRM_SCRIPT_TYPE_GROUPCOLLAPSIBLE, ///< Collapsible Folder
398  HAPI_PRM_SCRIPT_TYPE_GROUP ///< Tabs Folder
399 };
401 
403 {
404  HAPI_CHOICELISTTYPE_NONE, ///< Parameter is not a menu.
405  HAPI_CHOICELISTTYPE_NORMAL, ///< Menu Only, Single Selection
406  HAPI_CHOICELISTTYPE_MINI, ///< Mini Menu Only, Single Selection
407  HAPI_CHOICELISTTYPE_REPLACE, ///< Field + Single Selection Menu
408  HAPI_CHOICELISTTYPE_TOGGLE ///< Field + Multiple Selection Menu
409 };
411 
413 {
415  HAPI_PRESETTYPE_BINARY = 0, ///< Just the presets binary blob.
416  HAPI_PRESETTYPE_IDX, ///< Presets blob within an .idx file format.
418 };
420 
422 {
435 };
437 typedef int HAPI_NodeTypeBits;
438 
439 /// Flags used to filter compositions of node lists. Flags marked
440 /// 'Recursive Flag' will exclude children whos parent does not
441 /// satisfy the flag, even if the children themselves satisfy the flag.
443 {
446  HAPI_NODEFLAGS_DISPLAY = 1 << 0, ///< Recursive Flag
447  HAPI_NODEFLAGS_RENDER = 1 << 1, ///< Recursive Flag
453 
454  /// OBJ Node Specific Flags
459 
460  /// SOP Node Specific Flags
461  HAPI_NODEFLAGS_SOP_CURVE = 1 << 11 ///< Looks for "curve".
462 };
464 typedef int HAPI_NodeFlagsBits;
465 
467 {
472 };
474 
476 {
483 };
485 
487 {
493 };
495 
497 {
502 };
504 
506 {
514 };
516 
518 {
520  HAPI_ATTRIBUTE_TYPE_NONE, // Implicit type based on data
522  HAPI_ATTRIBUTE_TYPE_HPOINT, // Homogeneous position
523  HAPI_ATTRIBUTE_TYPE_VECTOR, // Direction vector
529  HAPI_ATTRIBUTE_TYPE_ST, // Parametric interval
530  HAPI_ATTRIBUTE_TYPE_HIDDEN, // "Private" (hidden)
531  HAPI_ATTRIBUTE_TYPE_BOX2, // 2x2 Bounding box
532  HAPI_ATTRIBUTE_TYPE_BOX, // 3x3 Bounding box
533  HAPI_ATTRIBUTE_TYPE_TEXTURE, // Texture coordinate
535 };
537 
539 {
541 
542  /// Most geos will be of this type which essentially means a geo
543  /// not of the other types.
545 
546  /// An exposed edit node.
547  /// See @ref HAPI_IntermediateAssetsResults.
549 
550  /// An input geo that can accept geometry from the host.
551  /// See @ref HAPI_AssetInputs_MarshallingGeometryIntoHoudini.
553 
554  /// A curve.
555  /// See @ref HAPI_Curves.
557 
559 };
561 
563 {
572 };
574 
576 {
581 };
583 
585 {
591 };
593 
595 {
609 };
611 
613 {
614  HAPI_TRS = 0,
620 
622 };
624 
626 {
627  HAPI_XYZ = 0,
633 
635 };
637 
639 {
647 
649 };
651 
653 {
655  HAPI_IMAGE_PACKING_SINGLE, ///< Single Channel
656  HAPI_IMAGE_PACKING_DUAL, ///< Dual Channel
658  HAPI_IMAGE_PACKING_BGR, ///< RGB Reversed
660  HAPI_IMAGE_PACKING_ABGR, ///< RGBA Reversed
662 
665 };
667 
668 /// This enum is to be used with ::HAPI_GetEnvInt() to retrieve basic
669 /// information about the HAPI implementation currently being linked
670 /// against. Note that as of HAPI version 2.0, these enum values are
671 /// guaranteed never to change so you can reliably get this information from
672 /// any post-2.0 version of HAPI. The same goes for the actual
673 /// ::HAPI_GetEnvInt() API call.
675 {
677 
678  /// The three components of the Houdini version that HAPI is
679  /// expecting to link against.
680  /// @{
685  /// @}
686 
687  /// The two components of the Houdini Engine (marketed) version.
688  /// @{
691  /// @}
692 
693  /// This is a monotonously increasing API version number that can be used
694  /// to lock against a certain API for compatibility purposes. Basically,
695  /// when this number changes code compiled against the HAPI.h methods
696  /// might no longer compile. Semantic changes to the methods will also
697  /// cause this version to increase. This number will be reset to 0
698  /// every time the Houdini Engine version is bumped.
700 
702 };
704 
705 /// This enum is to be used with ::HAPI_GetSessionEnvInt() to retrieve basic
706 /// session-specific information.
708 {
710 
711  /// License Type. See ::HAPI_License.
713 
715 };
717 
718 /// [HAPI_CacheProperty]
720 {
721  /// Current memory usage in MB. Setting this to 0 invokes
722  /// a cache clear.
724 
725  HAPI_CACHEPROP_HAS_MIN, ///< True if it actually has a minimum size.
726  HAPI_CACHEPROP_MIN, ///< Min cache memory limit in MB.
727  HAPI_CACHEPROP_HAS_MAX, ///< True if it actually has a maximum size.
728  HAPI_CACHEPROP_MAX, ///< Max cache memory limit in MB.
729 
730  /// How aggressive to cull memory. This only works for:
731  /// - ::HAPI_CACHE_COP_COOK where:
732  /// 0 -> Never reduce inactive cache.
733  /// 1 -> Always reduce inactive cache.
734  /// - ::HAPI_CACHE_OBJ where:
735  /// 0 -> Never enforce the max memory limit.
736  /// 1 -> Always enforce the max memory limit.
737  /// - ::HAPI_CACHE_SOP where:
738  /// 0 -> When to Unload = Never
739  /// When to Limit Max Memory = Never
740  /// 1-2 -> When to Unload = Based on Flag
741  /// When to Limit Max Memory = Never
742  /// 3-4 -> When to Unload = Based on Flag
743  /// When to Limit Max Memory = Always
744  /// 5 -> When to Unload = Always
745  /// When to Limit Max Memory = Always
747 };
748 
750 
751 /// Used with PDG functions
753 {
757 
759 };
761 
762 /// Used with PDG functions
764 {
771 };
773 
774 /// Used with PDG functions
776 {
778 
782 
785 
788 
790 
793 
795 };
797 
798 /// Used with PDG functions
800 {
810 };
812 
813 /////////////////////////////////////////////////////////////////////////////
814 // Main API Structs
815 
816 // GENERICS -----------------------------------------------------------------
817 
819 {
820  float position[ HAPI_POSITION_VECTOR_SIZE ];
821  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
822  float scale[ HAPI_SCALE_VECTOR_SIZE ];
823  float shear[ HAPI_SHEAR_VECTOR_SIZE ];
824 
826 };
828 
830 {
831  float position[ HAPI_POSITION_VECTOR_SIZE ];
832  float rotationEuler[ HAPI_EULER_VECTOR_SIZE ];
833  float scale[ HAPI_SCALE_VECTOR_SIZE ];
834  float shear[ HAPI_SHEAR_VECTOR_SIZE ];
835 
838 };
840 
841 // SESSIONS -----------------------------------------------------------------
842 
844 {
845  /// The type of session determines the which implementation will be
846  /// used to communicate with the Houdini Engine library.
848 
849  /// Some session types support multiple simultaneous sessions. This means
850  /// that each session needs to have a unique identifier.
851  HAPI_SessionId id;
852 };
854 
855 /// Options to configure a Thrift server being started from HARC.
857 {
858  /// Close the server automatically when all clients disconnect from it.
860 
861  /// Timeout in milliseconds for waiting on the server to
862  /// signal that it's ready to serve. If the server fails
863  /// to signal within this time interval, the start server call fails
864  /// and the server process is terminated.
865  float timeoutMs;
866 };
868 
869 // TIME ---------------------------------------------------------------------
870 
872 {
873  float fps;
874 
875  float startTime;
876  float endTime;
877 };
879 
880 // ASSETS -------------------------------------------------------------------
881 
883 {
884  /// Use the node id to get the asset's parameters.
885  /// See @ref HAPI_Nodes_Basics.
886  HAPI_NodeId nodeId;
887 
888  /// The objectNodeId differs from the regular nodeId in that for
889  /// geometry based assets (SOPs) it will be the node id of the dummy
890  /// object (OBJ) node instead of the asset node. For object based assets
891  /// the objectNodeId will equal the nodeId. The reason the distinction
892  /// exists is because transforms are always stored on the object node
893  /// but the asset parameters may not be on the asset node if the asset
894  /// is a geometry asset so we need both.
895  HAPI_NodeId objectNodeId;
896 
897  /// It's possible to instantiate an asset without cooking it.
898  /// See @ref HAPI_Assets_Cooking.
900 
901  HAPI_StringHandle nameSH; ///< Instance name (the label + a number).
902  HAPI_StringHandle labelSH; ///< This is what any end user should be shown.
903  HAPI_StringHandle filePathSH; ///< Path to the .otl library file.
904  HAPI_StringHandle versionSH; ///< User-defined asset version.
905  HAPI_StringHandle fullOpNameSH; ///< Full asset name and namespace.
906  HAPI_StringHandle helpTextSH; ///< Asset help marked-up text.
907 
908  int objectCount; ///< See @ref HAPI_Objects.
909  int handleCount; ///< See @ref HAPI_Handles.
910 
911  /// Transform inputs exposed by the asset. For OBJ assets this is the
912  /// number of transform inputs on the OBJ node. For SOP assets, this is
913  /// the singular transform input on the dummy wrapper OBJ node.
914  /// See @ref HAPI_AssetInputs.
916 
917  /// Geometry inputs exposed by the asset. For SOP assets this is
918  /// the number of geometry inputs on the SOP node itself. OBJ assets
919  /// will always have zero geometry inputs.
920  /// See @ref HAPI_AssetInputs.
922 
923  /// Geometry outputs exposed by the asset. For SOP assets this is
924  /// the number of geometry outputs on the SOP node itself. OBJ assets
925  /// will always have zero geometry outputs.
926  /// See @ref HAPI_AssetInputs.
928 
929  /// For incremental updates. Indicates whether any of the assets's
930  /// objects have changed. Refreshed only during an asset cook.
932 
933  /// For incremental updates. Indicates whether any of the asset's
934  /// materials have changed. Refreshed only during an asset cook.
936 };
938 
940 {
941  /// Normally, geos are split into parts in two different ways. First it
942  /// is split by group and within each group it is split by primitive type.
943  ///
944  /// For example, if you have a geo with group1 covering half of the mesh
945  /// and volume1 and group2 covering the other half of the mesh, all of
946  /// curve1, and volume2 you will end up with 5 parts. First two parts
947  /// will be for the half-mesh of group1 and volume1, and the last three
948  /// will cover group2.
949  ///
950  /// This toggle lets you disable the splitting by group and just have
951  /// the geo be split by primitive type alone. By default, this is true
952  /// and therefore geos will be split by group and primitive type. If
953  /// set to false, geos will only be split by primitive type.
955 
956  /// For meshes only, this is enforced by convexing the mesh. Use -1
957  /// to avoid convexing at all and get some performance boost.
959 
960  /// For curves only.
961  /// If this is set to true, then all curves will be refined to a linear
962  /// curve and you can no longer access the original CVs. You can control
963  /// the refinement detail via ::HAPI_CookOptions::curveRefineLOD.
964  /// If it's false, the curve type (NURBS, Bezier etc) will be left as is.
966 
967  /// Controls the number of divisions per unit distance when refining
968  /// a curve to linear. The default in Houdini is 8.0.
970 
971  /// If this option is turned on, then we will recursively clear the
972  /// errors and warnings (and messages) of all nodes before performing
973  /// the cook.
975 
976  /// Decide whether to recursively cook all templated geos or not.
978 
979  /// Decide whether to split points by vertex attributes. This takes
980  /// all vertex attributes and tries to copy them to their respective
981  /// points. If two vertices have any difference in their attribute values,
982  /// the corresponding point is split into two points. This is repeated
983  /// until all the vertex attributes have been copied to the points.
984  ///
985  /// With this option enabled, you can reduce the total number of vertices
986  /// on a game engine side as sharing of attributes (like UVs) is optimized.
987  /// To make full use of this feature, you have to think of Houdini points
988  /// as game engine vertices (sharable). With this option OFF (or before
989  /// this feature existed) you had to map Houdini vertices to game engine
990  /// vertices, to make sure all attribute values are accounted for.
992 
993  /// Choose how you want the cook to handle packed primitives.
994  /// The default is: ::HAPI_PACKEDPRIM_INSTANCING_MODE_DISABLED
996 
997  /// Choose which special part types should be handled. Unhandled special
998  /// part types will just be refined to ::HAPI_PARTTYPE_MESH.
1001 
1002  /// If enabled, sets the ::HAPI_PartInfo::hasChanged member during the
1003  /// cook. If disabled, the member will always be true. Checking for
1004  /// part changes can be expensive, so there is a potential performance
1005  /// gain when disabled.
1007 
1008  /// For internal use only. :)
1010 };
1012 
1013 // NODES --------------------------------------------------------------------
1014 
1016 {
1017  HAPI_NodeId id;
1018  HAPI_NodeId parentId;
1019  HAPI_StringHandle nameSH;
1021 
1022  /// Always true unless the asset's definition has changed due to loading
1023  /// a duplicate asset definition and from another OTL asset library
1024  /// file OR deleting the OTL asset library file used by this node's asset.
1026 
1027  /// Total number of cooks of this node.
1029 
1030  /// Use this unique id to grab the OP_Node pointer for this node.
1031  /// If you're linking against the C++ HDK, include the OP_Node.h header
1032  /// and call OP_Node::lookupNode().
1034 
1035  /// This is the internal node path in the Houdini scene graph. This path
1036  /// is meant to be abstracted away for most client purposes but for
1037  /// advanced uses it can come in handy.
1038  HAPI_StringHandle internalNodePathSH;
1039 
1040  /// Total number of parameters this asset has exposed. Includes hidden
1041  /// parameters.
1042  /// See @ref HAPI_Parameters.
1044 
1045  /// Number of values. A single parameter may have more than one value so
1046  /// this number is more than or equal to ::HAPI_NodeInfo::parmCount.
1047  /// @{
1051  /// @}
1052 
1053  /// The total number of choices among all the combo box parameters.
1054  /// See @ref HAPI_Parameters_ChoiceLists.
1056 
1057  /// The number of child nodes. This is 0 for all nodes that are not
1058  /// node networks.
1060 
1061  /// The number of inputs this specific node has.
1063 
1064  /// The number of outputs this specific node has.
1066 
1067  /// Nodes created via scripts or via ::HAPI_CreateNode() will be have
1068  /// this set to true. Only such nodes can be deleted using
1069  /// ::HAPI_DeleteNode().
1071 
1072  /// Indicates if this node will change over time
1074 };
1076 
1077 // PARAMETERS ---------------------------------------------------------------
1078 
1079 /// @struct HAPI_ParmInfo
1080 ///
1081 /// Contains parameter information like name, label, type, and size.
1082 ///
1084 {
1085  /// The parent id points to the id of the parent parm
1086  /// of this parm. The parent parm is something like a folder.
1087  HAPI_ParmId id;
1088 
1089  /// Parameter id of the parent of this parameter.
1090  HAPI_ParmId parentId;
1091 
1092  /// Child index within its immediate parent parameter.
1094 
1095  /// The HAPI type of the parm
1097 
1098  /// The Houdini script-type of the parm
1100 
1101  /// Some parameter types require additional type information.
1102  /// - File path parameters will indicate what file extensions they
1103  /// expect in a space-separated list of wild-cards. This is set
1104  /// in the Operator Type Properties using the File Pattern
1105  /// parameter property.
1106  /// For example, for filtering by PNG and JPG only: "*.png *.jpg"
1107  HAPI_StringHandle typeInfoSH;
1108 
1109  /// For the majority of parameter types permission will not be applicable.
1110  /// For file path parameters these permissions will indicate how the
1111  /// asset plans to use the file: whether it will only read it, only write
1112  /// to it, or both. This is set in the Operator Type Properties using
1113  /// the Browse Mode parameter property.
1115 
1116  /// Number of tags on this paramter.
1118 
1119  /// Tuple size. For scalar parameters this value is 1, but for vector
1120  /// parameters this value can be greater. For example, a 3 vector would
1121  /// have a size of 3. For folders and folder lists, this value is the
1122  /// number of children they own.
1123  int size;
1124 
1125  /// Any ::HAPI_ParmType can be a choice list. If this is set to
1126  /// ::HAPI_CHOICELISTTYPE_NONE, than this parameter is NOT a choice list.
1127  /// Otherwise, the parameter is a choice list of the indicated type.
1128  /// See @ref HAPI_Parameters_ChoiceLists.
1130 
1131  /// Any ::HAPI_ParmType can be a choice list. If the parameter is a
1132  /// choice list, this tells you how many choices it currently has.
1133  /// Note that some menu parameters can have a dynamic number of choices
1134  /// so it is important that this count is re-checked after every cook.
1135  /// See @ref HAPI_Parameters_ChoiceLists.
1137 
1138  /// Note that folders are not real parameters in Houdini so they do not
1139  /// have names. The folder names given here are generated from the name
1140  /// of the folderlist (or switcher) parameter which is a parameter. The
1141  /// folderlist parameter simply defines how many of the "next" parameters
1142  /// belong to the first folder, how many of the parameters after that
1143  /// belong to the next folder, and so on. This means that folder names
1144  /// can change just by reordering the folders around so don't rely on
1145  /// them too much. The only guarantee here is that the folder names will
1146  /// be unique among all other parameter names.
1147  HAPI_StringHandle nameSH;
1148 
1149  /// The label string for the parameter
1150  HAPI_StringHandle labelSH;
1151 
1152  /// If this parameter is a multiparm instance than the
1153  /// ::HAPI_ParmInfo::templateNameSH will be the hash-templated parm name,
1154  /// containing #'s for the parts of the name that use the instance number.
1155  /// Compared to the ::HAPI_ParmInfo::nameSH, the ::HAPI_ParmInfo::nameSH
1156  /// will be the ::HAPI_ParmInfo::templateNameSH but with the #'s
1157  /// replaced by the instance number. For regular parms, the
1158  /// ::HAPI_ParmInfo::templateNameSH is identical to the
1159  /// ::HAPI_ParmInfo::nameSH.
1160  HAPI_StringHandle templateNameSH;
1161 
1162  /// The help string for this parameter
1163  HAPI_StringHandle helpSH;
1164 
1165  /// Whether min/max exists for the parameter values.
1166  /// @{
1171  /// @}
1172 
1173  /// Parameter value range, shared between int and float parameters.
1174  /// @{
1175  float min;
1176  float max;
1177  float UIMin;
1178  float UIMax;
1179  /// @}
1180 
1181  /// Whether this parm should be hidden from the user entirely. This is
1182  /// mostly used to expose parameters as asset meta-data but not allow the
1183  /// user to directly modify them.
1185 
1186  /// Whether this parm should appear enabled or disabled.
1188 
1189  /// If true, it means this parameter doesn't actually exist on the node
1190  /// in Houdini but was added by Houdini Engine as a spare parameter.
1191  /// This is just for your information. The behaviour of this parameter
1192  /// is not any different than a non-spare parameter.
1194 
1195  HAPI_Bool joinNext; ///< Whether this parm should be on the same line as
1196  ///< the next parm.
1197  HAPI_Bool labelNone; ///< Whether the label should be displayed.
1198 
1199  /// The index to use to look into the values array in order to retrieve
1200  /// the actual value(s) of this parameter.
1201  /// @{
1206  /// @}
1207 
1208  /// If this is a ::HAPI_PARMTYPE_NODE, this tells you what node types
1209  /// this parameter accepts.
1211 
1212  /// The node input parameter could have another subtype filter specified,
1213  /// like "Object: Geometry Only". In this case, this value will specify
1214  /// that extra filter. If the filter demands a node that HAPI does not
1215  /// support, both this and ::HAPI_ParmInfo::inputNodeType will be set to
1216  /// NONE as such a node is not settable through HAPI.
1218 
1219  /// See @ref HAPI_Parameters_MultiParms.
1220  /// @{
1222 
1223  int instanceNum; ///< The index of the instance in the multiparm.
1224  int instanceLength; ///< The number of parms in a multiparm instance.
1225  int instanceCount; ///< The number of instances in a multiparm.
1226 
1227  /// First instance's ::HAPI_ParmInfo::instanceNum. Either 0 or 1.
1229 
1231  /// @}
1232 
1233  /// Provides the raw condition string which is used to evaluate the
1234  /// the visibility of a parm
1235  HAPI_StringHandle visibilityConditionSH;
1236 
1237  /// Provides the raw condition string which is used to evalute whether
1238  /// a parm is enabled or disabled
1239  HAPI_StringHandle disabledConditionSH;
1240 };
1242 
1244 {
1245  HAPI_ParmId parentParmId;
1246  HAPI_StringHandle labelSH;
1247 
1248  /// This evaluates to the value of the token associated with the label
1249  /// applies to string menus only.
1250  HAPI_StringHandle valueSH;
1251 };
1253 
1254 // HANDLES ------------------------------------------------------------------
1255 
1256 /// @struct HAPI_HandleInfo
1257 ///
1258 /// Contains handle information such as the type of handle
1259 /// (translate, rotate, scale, softxform ...etc) and the number of
1260 /// parameters the current handle is bound to.
1261 ///
1263 {
1264  HAPI_StringHandle nameSH;
1265  HAPI_StringHandle typeNameSH;
1266 
1268 };
1270 
1271 /// @struct HAPI_HandleBindingInfo
1272 ///
1273 /// Contains binding information that maps the handle parameter to
1274 /// the asset parameter
1275 ///
1277 {
1278  HAPI_StringHandle handleParmNameSH;
1279  HAPI_StringHandle assetParmNameSH;
1280 
1281  HAPI_ParmId assetParmId;
1282 };
1284 
1285 // OBJECTS ------------------------------------------------------------------
1286 
1288 {
1289  HAPI_StringHandle nameSH;
1290 
1291  /// (deprecated)
1292  HAPI_StringHandle objectInstancePathSH;
1293 
1294  /// For incremental updates. Indicates whether the object's transform
1295  /// has changed. Refreshed only during an asset cook.
1297 
1298  /// For incremental updates. Indicates whether any of the object's
1299  /// geometry nodes have changed. Refreshed only during an asset cook.
1301 
1302  /// Whether the object is hidden and should not be shown. Some objects
1303  /// should be hidden but still brought into the host environment, for
1304  /// example those used only for instancing.
1305  /// See @ref HAPI_Instancing.
1307 
1308  /// See @ref HAPI_Instancing.
1310 
1311  /// Determine if this object is being instanced. Normally, this implies
1312  /// that while this object may not be visible, it should still be
1313  /// brought into the host application because it is needed by an instancer.
1314  /// See @ref HAPI_Instancing.
1316 
1317  /// (deprecated) The number of geometries under this object. For those familiar
1318  /// with Houdini, this number will always include the one visible SOP and any
1319  /// SOPs that were exposed as "editable" or "templated".
1320  /// See @ref HAPI_Geos.
1322 
1323  /// Use the node id to get the node's parameters.
1324  /// Using the HDK, you can also get the raw node C++ pointer for this
1325  /// object's internal node.
1326  /// See @ref HAPI_Nodes_Basics.
1327  HAPI_NodeId nodeId;
1328 
1329  /// If the object is an instancer, this variable gives the object id of
1330  /// the object that should be instanced.
1331  /// See @ref HAPI_Instancing.
1332  HAPI_NodeId objectToInstanceId;
1333 };
1335 
1336 // GEOMETRY -----------------------------------------------------------------
1337 
1339 {
1341  HAPI_StringHandle nameSH;
1342 
1343  /// Use the node id to get the node's parameters.
1344  /// Using the HDK, you can also get the raw node C++ pointer for this
1345  /// object's internal node.
1346  HAPI_NodeId nodeId;
1347 
1348  /// Whether the SOP node has been exposed by dragging it into the
1349  /// editable nodes section of the asset definition.
1351 
1352  /// Has the templated flag turned on which means "expose as read-only".
1354 
1355  /// Final Result (Display SOP).
1357 
1358  /// For incremental updates.
1360 
1361  /// (deprecated) This variable is deprecated and should no longer be used.
1362  /// Materials are now separate from parts. They are maintained at the
1363  /// asset level so you only need to check if the material itself has
1364  /// changed via ::HAPI_MaterialInfo::hasChanged instead of the material
1365  /// on the part.
1367 
1368  /// Groups.
1369  /// @{
1372  /// @}
1373 
1374  /// Total number of parts this geometry contains.
1375  /// See @ref HAPI_Parts.
1377 };
1379 
1381 {
1382  HAPI_PartId id;
1383  HAPI_StringHandle nameSH;
1385 
1388  int pointCount; ///< Number of points. Note that this is NOT the number
1389  ///< of "positions" as "points" may imply. If your
1390  ///< geometry has 3 points then set this to 3 and not 3*3.
1391 
1392  int attributeCounts[ HAPI_ATTROWNER_MAX ];
1393 
1394  /// If this is true, don't display this part. Load its data but then
1395  /// instance it where the corresponding instancer part tells you to
1396  /// instance it.
1398 
1399  /// The number of parts that this instancer part is instancing.
1400  /// For example, if we're instancing a curve and a box, they would come
1401  /// across as two parts, hence this count would be two.
1402  /// Call ::HAPI_GetInstancedPartIds() to get the list of ::HAPI_PartId's.
1404 
1405  /// The number of instances that this instancer part is instancing.
1406  /// Using the same example as with ::HAPI_PartInfo::instancedPartCount,
1407  /// if I'm instancing the merge of a curve and a box 5 times, this count
1408  /// would be 5. To be clear, all instanced parts are instanced the same
1409  /// number of times and with the same transform for each instance.
1410  /// Call ::HAPI_GetInstancerPartTransforms() to get the transform of
1411  /// each instance.
1413 
1414  /// If this is false, the underlying attribute data appear to match that of
1415  /// the previous cook. In this case you may be able to re-used marshaled
1416  /// data from the previous cook.
1418 };
1420 
1421 /// See @ref HAPI_Attributes.
1423 {
1425 
1428 
1429  /// When converting from the Houdini native GA geometry format to the
1430  /// GT geometry format HAPI uses, some attributes might change owners.
1431  /// For example, in Houdini GA curves can have points shared by
1432  /// vertices but the GT format only supports curve vertices
1433  /// (no points). This means that if you had point attributes on a curve
1434  /// in Houdini, when it comes out of HAPI those point attributes will now
1435  /// be vertex attributes. In this case, the ::HAPI_AttributeInfo::owner
1436  /// will be set to ::HAPI_ATTROWNER_VERTEX but the
1437  /// ::HAPI_AttributeInfo::originalOwner will be ::HAPI_ATTROWNER_POINT.
1439 
1440  /// Number of attributes. This count will match the number of values
1441  /// given the owner. For example, if the owner is ::HAPI_ATTROWNER_VERTEX
1442  /// this count will be the same as the ::HAPI_PartInfo::vertexCount.
1443  /// To be clear, this is not the number of values in the attribute, rather
1444  /// it is the number of attributes. If your geometry has three 3D points
1445  /// then this count will be 3 (not 3*3) while the
1446  /// ::HAPI_AttributeInfo::tupleSize will be 3.
1447  int count;
1448 
1449  /// Number of values per attribute.
1450  /// Note that this is NOT the memory size of the attribute. It is the
1451  /// number of values per attributes. Multiplying this by the
1452  /// size of the ::HAPI_AttributeInfo::storage will give you the memory
1453  /// size per attribute.
1455 
1456  /// Attribute type info
1457  /// This is used to help identify the type of data stored in an attribute.
1458  /// Using the type is recommended over using just an attribute's name to identify
1459  /// its purpose.
1461 };
1463 
1464 // MATERIALS ----------------------------------------------------------------
1465 
1467 {
1468  /// This is the HAPI node id for the SHOP node this material is attached
1469  /// to. Use it to get access to the parameters (which contain the
1470  /// texture paths).
1471  /// IMPORTANT: When the ::HAPI_MaterialInfo::hasChanged is true this
1472  /// @p nodeId could have changed. Do not assume ::HAPI_MaterialInfo::nodeId
1473  /// will never change for a specific material.
1474  HAPI_NodeId nodeId;
1475 
1477 
1479 };
1481 
1483 {
1484  HAPI_StringHandle nameSH;
1485  HAPI_StringHandle descriptionSH;
1486  HAPI_StringHandle defaultExtensionSH;
1487 };
1489 
1491 {
1492  /// Unlike the other members of this struct changing imageFileFormatNameSH
1493  /// and giving this struct back to HAPI_SetImageInfo() nothing will happen.
1494  /// Use this member variable to derive which image file format will be used
1495  /// by the HAPI_ExtractImageTo...() functions if called with
1496  /// image_file_format_name set to NULL. This way, you can decide whether
1497  /// to ask for a file format conversion (slower) or not (faster).
1498  HAPI_StringHandle imageFileFormatNameSH; // Read-only
1499 
1500  int xRes;
1501  int yRes;
1502 
1504 
1505  HAPI_Bool interleaved; ///< ex: true = RGBRGBRGB, false = RRRGGGBBB
1507 
1508  /// Adjust the gamma of the image. For anything less than
1509  /// ::HAPI_IMAGE_DATA_INT16, you probably want to leave this as 2.2.
1510  double gamma;
1511 };
1513 
1514 // ANIMATION ----------------------------------------------------------------
1515 
1517 {
1518  float time;
1519  float value;
1520  float inTangent;
1521  float outTangent;
1522 };
1524 
1525 // VOLUMES ------------------------------------------------------------------
1526 
1527 /// @struct HAPI_VolumeInfo
1528 ///
1529 /// This represents a volume primitive but does not contain the actual voxel
1530 /// values, which can be retrieved on a per-tile basis.
1531 ///
1532 /// See @ref HAPI_Volumes.
1533 ///
1535 {
1536  HAPI_StringHandle nameSH;
1537 
1539 
1540  /// Each voxel is identified with an index. The indices will range
1541  /// between:
1542  /// [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )
1543  /// @{
1544  int xLength;
1545  int yLength;
1546  int zLength;
1547  int minX;
1548  int minY;
1549  int minZ;
1550  /// @}
1551 
1552  /// Number of values per voxel.
1553  /// The tuple size field is 1 for scalars and 3 for vector data.
1555 
1556  /// Can be either ::HAPI_STORAGETYPE_INT or ::HAPI_STORAGETYPE_FLOAT.
1558 
1559  /// The dimensions of each tile.
1560  /// This can be 8 or 16, denoting an 8x8x8 or 16x16x16 tiles.
1562 
1563  /// The transform of the volume with respect to the lengths.
1564  /// The volume may be positioned anywhere in space.
1566 
1567  /// Denotes special situations where the volume tiles are not perfect
1568  /// cubes, but are tapered instead.
1570 
1571  /// If there is taper involved, denotes the amount of taper involved.
1572  /// @{
1573  float xTaper;
1574  float yTaper;
1575  /// @}
1576 };
1578 
1579 /// @struct HAPI_VolumeTileInfo
1580 ///
1581 /// A HAPI_VolumeTileInfo represents an cube subarray of the volume.
1582 /// The size of each dimension is HAPI_VoluemInfo::tileSize
1583 /// bbox [(minX, minY, minZ), (minX+tileSize, minY+tileSize, minZ+tileSize))
1584 ///
1586 {
1587  int minX;
1588  int minY;
1589  int minZ;
1591 };
1593 
1594 // CURVES -------------------------------------------------------------------
1595 
1596 /// @struct HAPI_CurveInfo
1597 ///
1598 /// This represents the meta-data associated with a curve mesh (a number
1599 /// of curves of the same type).
1601 {
1603  int curveCount; ///< The number of curves contained in this curve mesh.
1604  int vertexCount; ///< The number of control vertices (CVs) for all curves.
1605  int knotCount; ///< The number of knots for all curves.
1606 
1608  ///< Whether the curves in this curve mesh are periodic.
1610  ///< Whether the curves in this curve mesh are rational.
1611  int order; ///< Order of 1 is invalid. 0 means there is a varying order.
1612 
1613  HAPI_Bool hasKnots; ///< Whether the curve has knots.
1614 };
1616 
1617 // BASIC PRIMITIVES ---------------------------------------------------------
1618 
1620 {
1621  float center[ HAPI_POSITION_VECTOR_SIZE ];
1622  float size[ HAPI_SCALE_VECTOR_SIZE ];
1623  float rotation[ HAPI_EULER_VECTOR_SIZE ];
1624 };
1626 
1628 {
1629  float center[ HAPI_POSITION_VECTOR_SIZE ];
1630  float radius;
1631 };
1633 
1634 // PDG Structs ---------------------------------------------------------------
1635 
1637 {
1638  HAPI_NodeId nodeId; /// id of related node
1639  HAPI_PDG_WorkitemId workitemId; /// id of related workitem
1640  HAPI_PDG_WorkitemId dependencyId; /// id of related workitem dependency
1641  int currentState; /// (HAPI_PDG_WorkItemState) value of current state for state change
1642  int lastState; /// (HAPI_PDG_WorkItemState) value of last state for state change
1643  int eventType; /// (HAPI_PDG_EventType) event type
1644 };
1646 
1648 {
1649  int index; /// index of the workitem
1650  int numResults; /// number of results reported
1651  HAPI_StringHandle nameSH; /// name of the workitem
1652 };
1654 
1656 {
1657  int resultSH; /// result string data
1658  int resultTagSH; /// result tag
1659  HAPI_Int64 resultHash; /// hash value of result
1660 };
1662 
1663 #endif // __HAPI_COMMON_h__
HAPI_License
Definition: HAPI_Common.h:153
HAPI_NodeId objectNodeId
Definition: HAPI_Common.h:895
"vector", "vector3"
Definition: HAPI_Common.h:362
#define HAPI_QUATERNION_VECTOR_SIZE
Definition: HAPI_Common.h:20
True if it actually has a maximum size.
Definition: HAPI_Common.h:727
HAPI_StringHandle disabledConditionSH
Definition: HAPI_Common.h:1239
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1341
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1147
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1638
SOP Node Specific Flags.
Definition: HAPI_Common.h:461
HAPI_StringHandle labelSH
This is what any end user should be shown.
Definition: HAPI_Common.h:902
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1383
HAPI_Bool isInstancer
See Instancing.
Definition: HAPI_Common.h:1309
HAPI_ImageDataFormat dataFormat
Definition: HAPI_Common.h:1503
int parmStringValueCount
Definition: HAPI_Common.h:1050
HAPI_Bool clearErrorsAndWarnings
Definition: HAPI_Common.h:974
Recursive Flag.
Definition: HAPI_Common.h:447
Recursive Flag.
Definition: HAPI_Common.h:446
HAPI_ChoiceListType choiceListType
Definition: HAPI_Common.h:1129
int HAPI_NodeTypeBits
Definition: HAPI_Common.h:437
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1289
HAPI_NodeId objectToInstanceId
Definition: HAPI_Common.h:1332
HAPI_Bool refineCurveToLinear
Definition: HAPI_Common.h:965
HAPI_PDG_WorkitemId workitemId
id of related node
Definition: HAPI_Common.h:1639
Equivalent to HAPI_STATUSVERBOSITY_1.
Definition: HAPI_Common.h:186
HAPI_ParmId id
Definition: HAPI_Common.h:1087
Just the presets binary blob.
Definition: HAPI_Common.h:415
Radio buttons Folder.
Definition: HAPI_Common.h:395
"dir", "direction"
Definition: HAPI_Common.h:369
HAPI_Bool isEditable
Definition: HAPI_Common.h:1350
int HAPI_PDG_GraphContextId
Use this with PDG functions.
Definition: HAPI_Common.h:148
#define HAPI_POSITION_VECTOR_SIZE
Definition: HAPI_Common.h:16
HAPI_RampType rampType
Definition: HAPI_Common.h:1230
HAPI_PackedPrimInstancingMode packedPrimInstancingMode
Definition: HAPI_Common.h:995
HAPI_SessionEnvIntType
Definition: HAPI_Common.h:707
"toggle", "embed"
Definition: HAPI_Common.h:359
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1019
#define HAPI_API
Definition: HAPI_API.h:79
OBJ Node Specific Flags.
Definition: HAPI_Common.h:455
int resultTagSH
result string data
Definition: HAPI_Common.h:1658
HAPI_NodeFlags
Definition: HAPI_Common.h:442
HAPI_GeoType
Definition: HAPI_Common.h:538
int instanceCount
The number of instances in a multiparm.
Definition: HAPI_Common.h:1225
HAPI_StringHandle visibilityConditionSH
Definition: HAPI_Common.h:1235
HAPI_Bool hasEverCooked
Definition: HAPI_Common.h:899
int eventType
(HAPI_PDG_WorkItemState) value of last state for state change
Definition: HAPI_Common.h:1643
HAPI_Bool haveMaterialsChanged
Definition: HAPI_Common.h:935
HAPI_NodeType inputNodeType
Definition: HAPI_Common.h:1210
HAPI_StringHandle typeNameSH
Definition: HAPI_Common.h:1265
HAPI_Bool isPeriodic
Whether the curves in this curve mesh are periodic.
Definition: HAPI_Common.h:1607
HAPI_RSTOrder
Definition: HAPI_Common.h:612
int parmFloatValueCount
Definition: HAPI_Common.h:1049
"intvector", "intvector3"
Definition: HAPI_Common.h:365
HAPI_CurveType
Definition: HAPI_Common.h:486
HAPI_PDG_State
Used with PDG functions.
Definition: HAPI_Common.h:752
HAPI_AttributeOwner owner
Definition: HAPI_Common.h:1426
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:825
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1346
int uniqueHoudiniNodeId
Definition: HAPI_Common.h:1033
Single Channel.
Definition: HAPI_Common.h:655
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1474
HAPI_ImageDataFormat
Definition: HAPI_Common.h:638
int handleCount
See Handles.
Definition: HAPI_Common.h:909
HAPI_PartType
Definition: HAPI_Common.h:562
int currentState
id of related workitem dependency
Definition: HAPI_Common.h:1641
HAPI_EnvIntType
Definition: HAPI_Common.h:674
HAPI_Bool isRational
Whether the curves in this curve mesh are rational.
Definition: HAPI_Common.h:1609
HAPI_Bool isValid
Definition: HAPI_Common.h:1025
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:837
HAPI_PackedPrimInstancingMode
Definition: HAPI_Common.h:257
HAPI_StringHandle labelSH
The label string for the parameter.
Definition: HAPI_Common.h:1150
Max cache memory limit in MB.
Definition: HAPI_Common.h:728
HAPI_Permissions
Definition: HAPI_Common.h:267
#define HAPI_SHEAR_VECTOR_SIZE
Definition: HAPI_Common.h:18
Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:180
True if it actually has a minimum size.
Definition: HAPI_Common.h:725
HAPI_Bool cookTemplatedGeos
Decide whether to recursively cook all templated geos or not.
Definition: HAPI_Common.h:977
HAPI_StringHandle helpSH
The help string for this parameter.
Definition: HAPI_Common.h:1163
HAPI_Bool autoClose
Close the server automatically when all clients disconnect from it.
Definition: HAPI_Common.h:859
HAPI_StringHandle templateNameSH
Definition: HAPI_Common.h:1160
HAPI_AttributeOwner
Definition: HAPI_Common.h:475
HAPI_StringHandle fullOpNameSH
Full asset name and namespace.
Definition: HAPI_Common.h:905
RGBA Reversed.
Definition: HAPI_Common.h:660
Only some objects failed.
Definition: HAPI_Common.h:246
HAPI_ErrorCode
Definition: HAPI_Common.h:223
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1484
HAPI_Bool createdPostAssetLoad
Definition: HAPI_Common.h:1070
HAPI_NodeType
Definition: HAPI_Common.h:421
HAPI_CurveType curveType
Definition: HAPI_Common.h:1602
int knotCount
The number of knots for all curves.
Definition: HAPI_Common.h:1605
HAPI_Bool hasUIMax
Definition: HAPI_Common.h:1170
HAPI_StringHandle handleParmNameSH
Definition: HAPI_Common.h:1278
int HAPI_StringHandle
Definition: HAPI_Common.h:129
HAPI_StatusVerbosity
Definition: HAPI_Common.h:174
HAPI_AttributeOwner originalOwner
Definition: HAPI_Common.h:1438
Equivalent to HAPI_STATUSVERBOSITY_0.
Definition: HAPI_Common.h:184
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:856
Total number of supported parameter types.
Definition: HAPI_Common.h:320
See Attributes.
Definition: HAPI_Common.h:1422
HAPI_ChoiceListType
Definition: HAPI_Common.h:402
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1417
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1397
Everything cook successfully without errors.
Definition: HAPI_Common.h:244
HAPI_Bool spare
Definition: HAPI_Common.h:1193
Menu Only, Single Selection.
Definition: HAPI_Common.h:405
HAPI_XYZOrder rotationOrder
Definition: HAPI_Common.h:836
int curveCount
The number of curves contained in this curve mesh.
Definition: HAPI_Common.h:1603
HAPI_PrmScriptType
Definition: HAPI_Common.h:349
HAPI_Bool hasKnots
Whether the curve has knots.
Definition: HAPI_Common.h:1613
HAPI_XYZOrder
Definition: HAPI_Common.h:625
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1264
int HAPI_ParmId
Definition: HAPI_Common.h:138
int numResults
index of the workitem
Definition: HAPI_Common.h:1650
HAPI_ParmId parentId
Parameter id of the parent of this parameter.
Definition: HAPI_Common.h:1090
int HAPI_ErrorCodeBits
Definition: HAPI_Common.h:229
HAPI_AttributeTypeInfo typeInfo
Definition: HAPI_Common.h:1460
int order
Order of 1 is invalid. 0 means there is a varying order.
Definition: HAPI_Common.h:1611
int instancedPartCount
Definition: HAPI_Common.h:1403
int tagCount
Number of tags on this paramter.
Definition: HAPI_Common.h:1117
int transformInputCount
Definition: HAPI_Common.h:915
int outputCount
The number of outputs this specific node has.
Definition: HAPI_Common.h:1065
HAPI_Bool handleSpherePartTypes
Definition: HAPI_Common.h:1000
int instanceStartOffset
First instance's HAPI_ParmInfo::instanceNum. Either 0 or 1.
Definition: HAPI_Common.h:1228
int childIndex
Child index within its immediate parent parameter.
Definition: HAPI_Common.h:1093
HAPI_NodeId id
Definition: HAPI_Common.h:1017
HAPI_ImagePacking
Definition: HAPI_Common.h:652
HAPI_Transform transform
Definition: HAPI_Common.h:1565
HAPI_PDG_EventType
Used with PDG functions.
Definition: HAPI_Common.h:775
HAPI_SessionType
Definition: HAPI_Common.h:231
HAPI_StorageType storage
Definition: HAPI_Common.h:1427
Presets blob within an .idx file format.
Definition: HAPI_Common.h:416
int instanceNum
The index of the instance in the multiparm.
Definition: HAPI_Common.h:1223
int instanceLength
The number of parms in a multiparm instance.
Definition: HAPI_Common.h:1224
int lastState
(HAPI_PDG_WorkItemState) value of current state for state change
Definition: HAPI_Common.h:1642
HAPI_Permissions permissions
Definition: HAPI_Common.h:1114
HAPI_PDG_WorkitemState
Used with PDG functions.
Definition: HAPI_Common.h:799
HAPI_VolumeType
Definition: HAPI_Common.h:496
HAPI_ParmType type
The HAPI type of the parm.
Definition: HAPI_Common.h:1096
License Type. See HAPI_License.
Definition: HAPI_Common.h:712
HAPI_StringHandle descriptionSH
Definition: HAPI_Common.h:1485
HAPI_PDG_WorkitemId dependencyId
id of related workitem
Definition: HAPI_Common.h:1640
Field + Multiple Selection Menu.
Definition: HAPI_Common.h:408
HAPI_ImagePacking packing
Definition: HAPI_Common.h:1506
HAPI_Int64 HAPI_SessionId
Has to be 64-bit.
Definition: HAPI_Common.h:125
#define HAPI_SCALE_VECTOR_SIZE
Definition: HAPI_Common.h:17
HAPI_Bool labelNone
Whether the label should be displayed.
Definition: HAPI_Common.h:1197
HAPI_GeoType type
Definition: HAPI_Common.h:1340
HAPI_SessionId id
Definition: HAPI_Common.h:851
int HAPI_ProcessId
Definition: HAPI_Common.h:121
HAPI_RampType
Definition: HAPI_Common.h:277
HAPI_ParmType
Definition: HAPI_Common.h:292
HAPI_CurveOrders
Definition: HAPI_Common.h:584
HAPI_Bool invisible
Definition: HAPI_Common.h:1184
HAPI_Bool joinNext
the next parm.
Definition: HAPI_Common.h:1195
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1478
HAPI_PartType type
Definition: HAPI_Common.h:1384
HAPI_StringHandle valueSH
Definition: HAPI_Common.h:1250
HAPI_Bool haveGeosChanged
Definition: HAPI_Common.h:1300
HAPI_StringHandle versionSH
User-defined asset version.
Definition: HAPI_Common.h:904
HAPI_StorageType
Definition: HAPI_Common.h:505
HAPI_STATIC_ASSERT(sizeof(HAPI_Int64)==8, unsupported_size_of_long)
HAPI_Bool hasMax
Definition: HAPI_Common.h:1168
HAPI_NodeId nodeId
Definition: HAPI_Common.h:886
HAPI_StringHandle defaultExtensionSH
Definition: HAPI_Common.h:1486
HAPI_StringHandle assetParmNameSH
Definition: HAPI_Common.h:1279
HAPI_Bool isDisplayGeo
Final Result (Display SOP).
Definition: HAPI_Common.h:1356
HAPI_Bool isTimeDependent
Indicates if this node will change over time.
Definition: HAPI_Common.h:1073
HAPI_Bool hasGeoChanged
For incremental updates.
Definition: HAPI_Common.h:1359
int vertexCount
The number of control vertices (CVs) for all curves.
Definition: HAPI_Common.h:1604
HAPI_StringHandle imageFileFormatNameSH
Definition: HAPI_Common.h:1498
HAPI_PDG_CookType
Used with PDG functions.
Definition: HAPI_Common.h:763
HAPI_Bool hasMaterialChanged
Definition: HAPI_Common.h:1366
HAPI_NodeId parentId
Definition: HAPI_Common.h:1018
Min cache memory limit in MB.
Definition: HAPI_Common.h:726
HAPI_Bool isTemplated
Has the templated flag turned on which means "expose as read-only".
Definition: HAPI_Common.h:1353
int totalCookCount
Total number of cooks of this node.
Definition: HAPI_Common.h:1028
HAPI_StringHandle filePathSH
Path to the .otl library file.
Definition: HAPI_Common.h:903
HAPI_Bool checkPartChanges
Definition: HAPI_Common.h:1006
char HAPI_Bool
Definition: HAPI_Common.h:110
HAPI_Bool hasUIMin
Definition: HAPI_Common.h:1169
HAPI_StringHandle typeInfoSH
Definition: HAPI_Common.h:1107
HAPI_NodeType type
Definition: HAPI_Common.h:1020
HAPI_StatusType
Definition: HAPI_Common.h:165
int extraFlags
For internal use only. :)
Definition: HAPI_Common.h:1009
HAPI_PresetType
Definition: HAPI_Common.h:412
HAPI_StringHandle labelSH
Definition: HAPI_Common.h:1246
HAPI_Bool interleaved
ex: true = RGBRGBRGB, false = RRRGGGBBB
Definition: HAPI_Common.h:1505
int inputCount
The number of inputs this specific node has.
Definition: HAPI_Common.h:1062
HAPI_Int64 resultHash
result tag
Definition: HAPI_Common.h:1659
HAPI_ParmId parentParmId
Definition: HAPI_Common.h:1245
"int", "integer"
Definition: HAPI_Common.h:351
HAPI_Result
Definition: HAPI_Common.h:193
HAPI_InputType
Definition: HAPI_Common.h:575
RGB Reversed.
Definition: HAPI_Common.h:658
HAPI_Bool splitGeosByGroup
Definition: HAPI_Common.h:954
HAPI_State
Definition: HAPI_Common.h:242
HAPI_VolumeType type
Definition: HAPI_Common.h:1538
int objectCount
See Objects.
Definition: HAPI_Common.h:908
HAPI_StringHandle helpTextSH
Asset help marked-up text.
Definition: HAPI_Common.h:906
int HAPI_PDG_WorkitemId
Use this with PDG functions.
Definition: HAPI_Common.h:145
HAPI_Bool splitPointsByVertexAttributes
Definition: HAPI_Common.h:991
HAPI_StorageType storage
Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT.
Definition: HAPI_Common.h:1557
int HAPI_NodeFlagsBits
Definition: HAPI_Common.h:464
Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:188
HAPI_AttributeTypeInfo
Definition: HAPI_Common.h:517
HAPI_Bool haveObjectsChanged
Definition: HAPI_Common.h:931
#define HAPI_EULER_VECTOR_SIZE
Definition: HAPI_Common.h:21
HAPI_Bool hasTaper
Definition: HAPI_Common.h:1569
HAPI_GroupType
Definition: HAPI_Common.h:466
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1536
#define HAPI_C_STRUCT_TYPEDEF(struct_name)
Definition: HAPI_Common.h:99
long long HAPI_Int64
Definition: HAPI_Common.h:114
HAPI_Bool isVisible
Definition: HAPI_Common.h:1306
Field + Single Selection Menu.
Definition: HAPI_Common.h:407
int HAPI_NodeId
See Nodes Basics.
Definition: HAPI_Common.h:134
HAPI_PartId id
Definition: HAPI_Common.h:1382
HAPI_CacheProperty
[HAPI_CacheProperty]
Definition: HAPI_Common.h:719
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1315
You should abort the cook.
Definition: HAPI_Common.h:245
int primitiveGroupCount
Definition: HAPI_Common.h:1371
HAPI_PrmScriptType scriptType
The Houdini script-type of the parm.
Definition: HAPI_Common.h:1099
HAPI_StringHandle nameSH
Instance name (the label + a number).
Definition: HAPI_Common.h:901
HAPI_StringHandle nameSH
number of results reported
Definition: HAPI_Common.h:1651
Mini Menu Only, Single Selection.
Definition: HAPI_Common.h:406
int HAPI_AssetLibraryId
Definition: HAPI_Common.h:131
Parameter is not a menu.
Definition: HAPI_Common.h:404
#define HAPI_C_ENUM_TYPEDEF(enum_name)
[HAPI_CACHE]
Definition: HAPI_Common.h:97
HAPI_TransformComponent
Definition: HAPI_Common.h:594
HAPI_Bool hasTransformChanged
Definition: HAPI_Common.h:1296
HAPI_StringHandle objectInstancePathSH
(deprecated)
Definition: HAPI_Common.h:1292
HAPI_Bool hasMin
Definition: HAPI_Common.h:1167
HAPI_StringHandle internalNodePathSH
Definition: HAPI_Common.h:1038
HAPI_Bool disabled
Whether this parm should appear enabled or disabled.
Definition: HAPI_Common.h:1187
HAPI_Bool handleBoxPartTypes
Definition: HAPI_Common.h:999
HAPI_SessionType type
Definition: HAPI_Common.h:847
HAPI_NodeFlags inputNodeFlag
Definition: HAPI_Common.h:1217
int HAPI_PartId
Definition: HAPI_Common.h:142
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1327
int maxVerticesPerPrimitive
Definition: HAPI_Common.h:958
HAPI_Bool isChildOfMultiParm
Definition: HAPI_Common.h:1221