Houdini Engine 3.3
 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 {
434 };
436 typedef int HAPI_NodeTypeBits;
437 
438 /// Flags used to filter compositions of node lists. Flags marked
439 /// 'Recursive Flag' will exclude children whos parent does not
440 /// satisfy the flag, even if the children themselves satisfy the flag.
442 {
445  HAPI_NODEFLAGS_DISPLAY = 1 << 0, ///< Recursive Flag
446  HAPI_NODEFLAGS_RENDER = 1 << 1, ///< Recursive Flag
452 
453  /// OBJ Node Specific Flags
458 
459  /// SOP Node Specific Flags
460  HAPI_NODEFLAGS_SOP_CURVE = 1 << 11, ///< Looks for "curve".
461  HAPI_NODEFLAGS_SOP_GUIDE = 1 << 12, ///< Looks for Guide Geometry
462 
463  /// TOP Node Specific Flags
464  HAPI_NODEFLAGS_TOP_NONSCHEDULER = 1 << 13 /// All TOP nodes except schedulers
465 
466 };
468 typedef int HAPI_NodeFlagsBits;
469 
471 {
476 };
478 
480 {
487 };
489 
491 {
497 };
499 
501 {
506 };
508 
510 {
518 };
520 
522 {
524  HAPI_ATTRIBUTE_TYPE_NONE, // Implicit type based on data
526  HAPI_ATTRIBUTE_TYPE_HPOINT, // Homogeneous position
527  HAPI_ATTRIBUTE_TYPE_VECTOR, // Direction vector
533  HAPI_ATTRIBUTE_TYPE_ST, // Parametric interval
534  HAPI_ATTRIBUTE_TYPE_HIDDEN, // "Private" (hidden)
535  HAPI_ATTRIBUTE_TYPE_BOX2, // 2x2 Bounding box
536  HAPI_ATTRIBUTE_TYPE_BOX, // 3x3 Bounding box
537  HAPI_ATTRIBUTE_TYPE_TEXTURE, // Texture coordinate
539 };
541 
543 {
545 
546  /// Most geos will be of this type which essentially means a geo
547  /// not of the other types.
549 
550  /// An exposed edit node.
551  /// See @ref HAPI_IntermediateAssetsResults.
553 
554  /// An input geo that can accept geometry from the host.
555  /// See @ref HAPI_AssetInputs_MarshallingGeometryIntoHoudini.
557 
558  /// A curve.
559  /// See @ref HAPI_Curves.
561 
563 };
565 
567 {
576 };
578 
580 {
585 };
587 
589 {
595 };
597 
599 {
613 };
615 
617 {
618  HAPI_TRS = 0,
624 
626 };
628 
630 {
631  HAPI_XYZ = 0,
637 
639 };
641 
643 {
651 
653 };
655 
657 {
659  HAPI_IMAGE_PACKING_SINGLE, ///< Single Channel
660  HAPI_IMAGE_PACKING_DUAL, ///< Dual Channel
662  HAPI_IMAGE_PACKING_BGR, ///< RGB Reversed
664  HAPI_IMAGE_PACKING_ABGR, ///< RGBA Reversed
666 
669 };
671 
672 /// This enum is to be used with ::HAPI_GetEnvInt() to retrieve basic
673 /// information about the HAPI implementation currently being linked
674 /// against. Note that as of HAPI version 2.0, these enum values are
675 /// guaranteed never to change so you can reliably get this information from
676 /// any post-2.0 version of HAPI. The same goes for the actual
677 /// ::HAPI_GetEnvInt() API call.
679 {
681 
682  /// The three components of the Houdini version that HAPI is
683  /// expecting to link against.
684  /// @{
689  /// @}
690 
691  /// The two components of the Houdini Engine (marketed) version.
692  /// @{
695  /// @}
696 
697  /// This is a monotonously increasing API version number that can be used
698  /// to lock against a certain API for compatibility purposes. Basically,
699  /// when this number changes code compiled against the HAPI.h methods
700  /// might no longer compile. Semantic changes to the methods will also
701  /// cause this version to increase. This number will be reset to 0
702  /// every time the Houdini Engine version is bumped.
704 
706 };
708 
709 /// This enum is to be used with ::HAPI_GetSessionEnvInt() to retrieve basic
710 /// session-specific information.
712 {
714 
715  /// License Type. See ::HAPI_License.
717 
719 };
721 
722 /// [HAPI_CacheProperty]
724 {
725  /// Current memory usage in MB. Setting this to 0 invokes
726  /// a cache clear.
728 
729  HAPI_CACHEPROP_HAS_MIN, ///< True if it actually has a minimum size.
730  HAPI_CACHEPROP_MIN, ///< Min cache memory limit in MB.
731  HAPI_CACHEPROP_HAS_MAX, ///< True if it actually has a maximum size.
732  HAPI_CACHEPROP_MAX, ///< Max cache memory limit in MB.
733 
734  /// How aggressive to cull memory. This only works for:
735  /// - ::HAPI_CACHE_COP_COOK where:
736  /// 0 -> Never reduce inactive cache.
737  /// 1 -> Always reduce inactive cache.
738  /// - ::HAPI_CACHE_OBJ where:
739  /// 0 -> Never enforce the max memory limit.
740  /// 1 -> Always enforce the max memory limit.
741  /// - ::HAPI_CACHE_SOP where:
742  /// 0 -> When to Unload = Never
743  /// When to Limit Max Memory = Never
744  /// 1-2 -> When to Unload = Based on Flag
745  /// When to Limit Max Memory = Never
746  /// 3-4 -> When to Unload = Based on Flag
747  /// When to Limit Max Memory = Always
748  /// 5 -> When to Unload = Always
749  /// When to Limit Max Memory = Always
751 };
752 
754 
755 /// Type of sampling for heightfield
757 {
760 };
762 
763 /// Used with PDG functions
765 {
769 
771 };
773 
774 /// Used with PDG functions
776 {
778 
782 
785 
788 
790 
793 
795 
798 
800 
802 
808 
816 
818 
820 
823 
825 
827 
829 
831 };
833 
834 /// Used with PDG functions
836 {
847 };
849 
850 /////////////////////////////////////////////////////////////////////////////
851 // Main API Structs
852 
853 // GENERICS -----------------------------------------------------------------
854 
856 {
857  float position[ HAPI_POSITION_VECTOR_SIZE ];
858  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
859  float scale[ HAPI_SCALE_VECTOR_SIZE ];
860  float shear[ HAPI_SHEAR_VECTOR_SIZE ];
861 
863 };
865 
867 {
868  float position[ HAPI_POSITION_VECTOR_SIZE ];
869  float rotationEuler[ HAPI_EULER_VECTOR_SIZE ];
870  float scale[ HAPI_SCALE_VECTOR_SIZE ];
871  float shear[ HAPI_SHEAR_VECTOR_SIZE ];
872 
875 };
877 
878 // SESSIONS -----------------------------------------------------------------
879 
881 {
882  /// The type of session determines the which implementation will be
883  /// used to communicate with the Houdini Engine library.
885 
886  /// Some session types support multiple simultaneous sessions. This means
887  /// that each session needs to have a unique identifier.
888  HAPI_SessionId id;
889 };
891 
892 /// Options to configure a Thrift server being started from HARC.
894 {
895  /// Close the server automatically when all clients disconnect from it.
897 
898  /// Timeout in milliseconds for waiting on the server to
899  /// signal that it's ready to serve. If the server fails
900  /// to signal within this time interval, the start server call fails
901  /// and the server process is terminated.
902  float timeoutMs;
903 };
905 
906 // TIME ---------------------------------------------------------------------
907 
909 {
910  float fps;
911 
912  float startTime;
913  float endTime;
914 };
916 
917 // ASSETS -------------------------------------------------------------------
918 
920 {
921  /// Use the node id to get the asset's parameters.
922  /// See @ref HAPI_Nodes_Basics.
923  HAPI_NodeId nodeId;
924 
925  /// The objectNodeId differs from the regular nodeId in that for
926  /// geometry based assets (SOPs) it will be the node id of the dummy
927  /// object (OBJ) node instead of the asset node. For object based assets
928  /// the objectNodeId will equal the nodeId. The reason the distinction
929  /// exists is because transforms are always stored on the object node
930  /// but the asset parameters may not be on the asset node if the asset
931  /// is a geometry asset so we need both.
932  HAPI_NodeId objectNodeId;
933 
934  /// It's possible to instantiate an asset without cooking it.
935  /// See @ref HAPI_Assets_Cooking.
937 
938  HAPI_StringHandle nameSH; ///< Instance name (the label + a number).
939  HAPI_StringHandle labelSH; ///< This is what any end user should be shown.
940  HAPI_StringHandle filePathSH; ///< Path to the .otl library file.
941  HAPI_StringHandle versionSH; ///< User-defined asset version.
942  HAPI_StringHandle fullOpNameSH; ///< Full asset name and namespace.
943  HAPI_StringHandle helpTextSH; ///< Asset help marked-up text.
944  HAPI_StringHandle helpURLSH; ///< Asset help URL.
945 
946  int objectCount; ///< See @ref HAPI_Objects.
947  int handleCount; ///< See @ref HAPI_Handles.
948 
949  /// Transform inputs exposed by the asset. For OBJ assets this is the
950  /// number of transform inputs on the OBJ node. For SOP assets, this is
951  /// the singular transform input on the dummy wrapper OBJ node.
952  /// See @ref HAPI_AssetInputs.
954 
955  /// Geometry inputs exposed by the asset. For SOP assets this is
956  /// the number of geometry inputs on the SOP node itself. OBJ assets
957  /// will always have zero geometry inputs.
958  /// See @ref HAPI_AssetInputs.
960 
961  /// Geometry outputs exposed by the asset. For SOP assets this is
962  /// the number of geometry outputs on the SOP node itself. OBJ assets
963  /// will always have zero geometry outputs.
964  /// See @ref HAPI_AssetInputs.
966 
967  /// For incremental updates. Indicates whether any of the assets's
968  /// objects have changed. Refreshed only during an asset cook.
970 
971  /// For incremental updates. Indicates whether any of the asset's
972  /// materials have changed. Refreshed only during an asset cook.
974 };
976 
978 {
979  /// Normally, geos are split into parts in two different ways. First it
980  /// is split by group and within each group it is split by primitive type.
981  ///
982  /// For example, if you have a geo with group1 covering half of the mesh
983  /// and volume1 and group2 covering the other half of the mesh, all of
984  /// curve1, and volume2 you will end up with 5 parts. First two parts
985  /// will be for the half-mesh of group1 and volume1, and the last three
986  /// will cover group2.
987  ///
988  /// This toggle lets you disable the splitting by group and just have
989  /// the geo be split by primitive type alone. By default, this is true
990  /// and therefore geos will be split by group and primitive type. If
991  /// set to false, geos will only be split by primitive type.
993 
994  /// This toggle lets you enable the splitting by unique values
995  /// of a specified attribute. By default, this is false and
996  /// the geo be split as described above.
997  /// as described above. If this is set to true, and splitGeosByGroup
998  /// set to false, mesh geos will be split on attribute values
999  /// The attribute name to split on must be created with HAPI_SetCustomString
1000  /// and then the splitAttrSH handle set on the struct.
1002  HAPI_StringHandle splitAttrSH;
1003 
1004  /// For meshes only, this is enforced by convexing the mesh. Use -1
1005  /// to avoid convexing at all and get some performance boost.
1007 
1008  /// For curves only.
1009  /// If this is set to true, then all curves will be refined to a linear
1010  /// curve and you can no longer access the original CVs. You can control
1011  /// the refinement detail via ::HAPI_CookOptions::curveRefineLOD.
1012  /// If it's false, the curve type (NURBS, Bezier etc) will be left as is.
1014 
1015  /// Controls the number of divisions per unit distance when refining
1016  /// a curve to linear. The default in Houdini is 8.0.
1018 
1019  /// If this option is turned on, then we will recursively clear the
1020  /// errors and warnings (and messages) of all nodes before performing
1021  /// the cook.
1023 
1024  /// Decide whether to recursively cook all templated geos or not.
1026 
1027  /// Decide whether to split points by vertex attributes. This takes
1028  /// all vertex attributes and tries to copy them to their respective
1029  /// points. If two vertices have any difference in their attribute values,
1030  /// the corresponding point is split into two points. This is repeated
1031  /// until all the vertex attributes have been copied to the points.
1032  ///
1033  /// With this option enabled, you can reduce the total number of vertices
1034  /// on a game engine side as sharing of attributes (like UVs) is optimized.
1035  /// To make full use of this feature, you have to think of Houdini points
1036  /// as game engine vertices (sharable). With this option OFF (or before
1037  /// this feature existed) you had to map Houdini vertices to game engine
1038  /// vertices, to make sure all attribute values are accounted for.
1040 
1041  /// Choose how you want the cook to handle packed primitives.
1042  /// The default is: ::HAPI_PACKEDPRIM_INSTANCING_MODE_DISABLED
1044 
1045  /// Choose which special part types should be handled. Unhandled special
1046  /// part types will just be refined to ::HAPI_PARTTYPE_MESH.
1049 
1050  /// If enabled, sets the ::HAPI_PartInfo::hasChanged member during the
1051  /// cook. If disabled, the member will always be true. Checking for
1052  /// part changes can be expensive, so there is a potential performance
1053  /// gain when disabled.
1055 
1056  /// For internal use only. :)
1058 };
1060 
1061 // NODES --------------------------------------------------------------------
1062 
1064 {
1065  HAPI_NodeId id;
1066  HAPI_NodeId parentId;
1067  HAPI_StringHandle nameSH;
1069 
1070  /// Always true unless the asset's definition has changed due to loading
1071  /// a duplicate asset definition and from another OTL asset library
1072  /// file OR deleting the OTL asset library file used by this node's asset.
1074 
1075  /// Total number of cooks of this node.
1077 
1078  /// Use this unique id to grab the OP_Node pointer for this node.
1079  /// If you're linking against the C++ HDK, include the OP_Node.h header
1080  /// and call OP_Node::lookupNode().
1082 
1083  /// This is the internal node path in the Houdini scene graph. This path
1084  /// is meant to be abstracted away for most client purposes but for
1085  /// advanced uses it can come in handy.
1086  HAPI_StringHandle internalNodePathSH;
1087 
1088  /// Total number of parameters this asset has exposed. Includes hidden
1089  /// parameters.
1090  /// See @ref HAPI_Parameters.
1092 
1093  /// Number of values. A single parameter may have more than one value so
1094  /// this number is more than or equal to ::HAPI_NodeInfo::parmCount.
1095  /// @{
1099  /// @}
1100 
1101  /// The total number of choices among all the combo box parameters.
1102  /// See @ref HAPI_Parameters_ChoiceLists.
1104 
1105  /// The number of child nodes. This is 0 for all nodes that are not
1106  /// node networks.
1108 
1109  /// The number of inputs this specific node has.
1111 
1112  /// The number of outputs this specific node has.
1114 
1115  /// Nodes created via scripts or via ::HAPI_CreateNode() will be have
1116  /// this set to true. Only such nodes can be deleted using
1117  /// ::HAPI_DeleteNode().
1119 
1120  /// Indicates if this node will change over time
1122 };
1124 
1125 // PARAMETERS ---------------------------------------------------------------
1126 
1127 /// @struct HAPI_ParmInfo
1128 ///
1129 /// Contains parameter information like name, label, type, and size.
1130 ///
1132 {
1133  /// The parent id points to the id of the parent parm
1134  /// of this parm. The parent parm is something like a folder.
1135  HAPI_ParmId id;
1136 
1137  /// Parameter id of the parent of this parameter.
1138  HAPI_ParmId parentId;
1139 
1140  /// Child index within its immediate parent parameter.
1142 
1143  /// The HAPI type of the parm
1145 
1146  /// The Houdini script-type of the parm
1148 
1149  /// Some parameter types require additional type information.
1150  /// - File path parameters will indicate what file extensions they
1151  /// expect in a space-separated list of wild-cards. This is set
1152  /// in the Operator Type Properties using the File Pattern
1153  /// parameter property.
1154  /// For example, for filtering by PNG and JPG only: "*.png *.jpg"
1155  HAPI_StringHandle typeInfoSH;
1156 
1157  /// For the majority of parameter types permission will not be applicable.
1158  /// For file path parameters these permissions will indicate how the
1159  /// asset plans to use the file: whether it will only read it, only write
1160  /// to it, or both. This is set in the Operator Type Properties using
1161  /// the Browse Mode parameter property.
1163 
1164  /// Number of tags on this paramter.
1166 
1167  /// Tuple size. For scalar parameters this value is 1, but for vector
1168  /// parameters this value can be greater. For example, a 3 vector would
1169  /// have a size of 3. For folders and folder lists, this value is the
1170  /// number of children they own.
1171  int size;
1172 
1173  /// Any ::HAPI_ParmType can be a choice list. If this is set to
1174  /// ::HAPI_CHOICELISTTYPE_NONE, than this parameter is NOT a choice list.
1175  /// Otherwise, the parameter is a choice list of the indicated type.
1176  /// See @ref HAPI_Parameters_ChoiceLists.
1178 
1179  /// Any ::HAPI_ParmType can be a choice list. If the parameter is a
1180  /// choice list, this tells you how many choices it currently has.
1181  /// Note that some menu parameters can have a dynamic number of choices
1182  /// so it is important that this count is re-checked after every cook.
1183  /// See @ref HAPI_Parameters_ChoiceLists.
1185 
1186  /// Note that folders are not real parameters in Houdini so they do not
1187  /// have names. The folder names given here are generated from the name
1188  /// of the folderlist (or switcher) parameter which is a parameter. The
1189  /// folderlist parameter simply defines how many of the "next" parameters
1190  /// belong to the first folder, how many of the parameters after that
1191  /// belong to the next folder, and so on. This means that folder names
1192  /// can change just by reordering the folders around so don't rely on
1193  /// them too much. The only guarantee here is that the folder names will
1194  /// be unique among all other parameter names.
1195  HAPI_StringHandle nameSH;
1196 
1197  /// The label string for the parameter
1198  HAPI_StringHandle labelSH;
1199 
1200  /// If this parameter is a multiparm instance than the
1201  /// ::HAPI_ParmInfo::templateNameSH will be the hash-templated parm name,
1202  /// containing #'s for the parts of the name that use the instance number.
1203  /// Compared to the ::HAPI_ParmInfo::nameSH, the ::HAPI_ParmInfo::nameSH
1204  /// will be the ::HAPI_ParmInfo::templateNameSH but with the #'s
1205  /// replaced by the instance number. For regular parms, the
1206  /// ::HAPI_ParmInfo::templateNameSH is identical to the
1207  /// ::HAPI_ParmInfo::nameSH.
1208  HAPI_StringHandle templateNameSH;
1209 
1210  /// The help string for this parameter
1211  HAPI_StringHandle helpSH;
1212 
1213  /// Whether min/max exists for the parameter values.
1214  /// @{
1219  /// @}
1220 
1221  /// Parameter value range, shared between int and float parameters.
1222  /// @{
1223  float min;
1224  float max;
1225  float UIMin;
1226  float UIMax;
1227  /// @}
1228 
1229  /// Whether this parm should be hidden from the user entirely. This is
1230  /// mostly used to expose parameters as asset meta-data but not allow the
1231  /// user to directly modify them.
1233 
1234  /// Whether this parm should appear enabled or disabled.
1236 
1237  /// If true, it means this parameter doesn't actually exist on the node
1238  /// in Houdini but was added by Houdini Engine as a spare parameter.
1239  /// This is just for your information. The behaviour of this parameter
1240  /// is not any different than a non-spare parameter.
1242 
1243  HAPI_Bool joinNext; ///< Whether this parm should be on the same line as
1244  ///< the next parm.
1245  HAPI_Bool labelNone; ///< Whether the label should be displayed.
1246 
1247  /// The index to use to look into the values array in order to retrieve
1248  /// the actual value(s) of this parameter.
1249  /// @{
1254  /// @}
1255 
1256  /// If this is a ::HAPI_PARMTYPE_NODE, this tells you what node types
1257  /// this parameter accepts.
1259 
1260  /// The node input parameter could have another subtype filter specified,
1261  /// like "Object: Geometry Only". In this case, this value will specify
1262  /// that extra filter. If the filter demands a node that HAPI does not
1263  /// support, both this and ::HAPI_ParmInfo::inputNodeType will be set to
1264  /// NONE as such a node is not settable through HAPI.
1266 
1267  /// See @ref HAPI_Parameters_MultiParms.
1268  /// @{
1270 
1271  int instanceNum; ///< The index of the instance in the multiparm.
1272  int instanceLength; ///< The number of parms in a multiparm instance.
1273  int instanceCount; ///< The number of instances in a multiparm.
1274 
1275  /// First instance's ::HAPI_ParmInfo::instanceNum. Either 0 or 1.
1277 
1279  /// @}
1280 
1281  /// Provides the raw condition string which is used to evaluate the
1282  /// the visibility of a parm
1283  HAPI_StringHandle visibilityConditionSH;
1284 
1285  /// Provides the raw condition string which is used to evalute whether
1286  /// a parm is enabled or disabled
1287  HAPI_StringHandle disabledConditionSH;
1288 };
1290 
1292 {
1293  HAPI_ParmId parentParmId;
1294  HAPI_StringHandle labelSH;
1295 
1296  /// This evaluates to the value of the token associated with the label
1297  /// applies to string menus only.
1298  HAPI_StringHandle valueSH;
1299 };
1301 
1302 // HANDLES ------------------------------------------------------------------
1303 
1304 /// @struct HAPI_HandleInfo
1305 ///
1306 /// Contains handle information such as the type of handle
1307 /// (translate, rotate, scale, softxform ...etc) and the number of
1308 /// parameters the current handle is bound to.
1309 ///
1311 {
1312  HAPI_StringHandle nameSH;
1313  HAPI_StringHandle typeNameSH;
1314 
1316 };
1318 
1319 /// @struct HAPI_HandleBindingInfo
1320 ///
1321 /// Contains binding information that maps the handle parameter to
1322 /// the asset parameter. The index is only used for int and float vector
1323 /// and colour parms.
1324 ///
1326 {
1327  HAPI_StringHandle handleParmNameSH;
1328  HAPI_StringHandle assetParmNameSH;
1329 
1330  HAPI_ParmId assetParmId;
1332 };
1334 
1335 // OBJECTS ------------------------------------------------------------------
1336 
1338 {
1339  HAPI_StringHandle nameSH;
1340 
1341  /// (deprecated)
1342  HAPI_StringHandle objectInstancePathSH;
1343 
1344  /// For incremental updates. Indicates whether the object's transform
1345  /// has changed. Refreshed only during an asset cook.
1347 
1348  /// For incremental updates. Indicates whether any of the object's
1349  /// geometry nodes have changed. Refreshed only during an asset cook.
1351 
1352  /// Whether the object is hidden and should not be shown. Some objects
1353  /// should be hidden but still brought into the host environment, for
1354  /// example those used only for instancing.
1355  /// See @ref HAPI_Instancing.
1357 
1358  /// See @ref HAPI_Instancing.
1360 
1361  /// Determine if this object is being instanced. Normally, this implies
1362  /// that while this object may not be visible, it should still be
1363  /// brought into the host application because it is needed by an instancer.
1364  /// See @ref HAPI_Instancing.
1366 
1367  /// (deprecated) The number of geometries under this object. For those familiar
1368  /// with Houdini, this number will always include the one visible SOP and any
1369  /// SOPs that were exposed as "editable" or "templated".
1370  /// See @ref HAPI_Geos.
1372 
1373  /// Use the node id to get the node's parameters.
1374  /// Using the HDK, you can also get the raw node C++ pointer for this
1375  /// object's internal node.
1376  /// See @ref HAPI_Nodes_Basics.
1377  HAPI_NodeId nodeId;
1378 
1379  /// If the object is an instancer, this variable gives the object id of
1380  /// the object that should be instanced.
1381  /// See @ref HAPI_Instancing.
1382  HAPI_NodeId objectToInstanceId;
1383 };
1385 
1386 // GEOMETRY -----------------------------------------------------------------
1387 
1389 {
1391  HAPI_StringHandle nameSH;
1392 
1393  /// Use the node id to get the node's parameters.
1394  /// Using the HDK, you can also get the raw node C++ pointer for this
1395  /// object's internal node.
1396  HAPI_NodeId nodeId;
1397 
1398  /// Whether the SOP node has been exposed by dragging it into the
1399  /// editable nodes section of the asset definition.
1401 
1402  /// Has the templated flag turned on which means "expose as read-only".
1404 
1405  /// Final Result (Display SOP).
1407 
1408  /// For incremental updates.
1410 
1411  /// (deprecated) This variable is deprecated and should no longer be used.
1412  /// Materials are now separate from parts. They are maintained at the
1413  /// asset level so you only need to check if the material itself has
1414  /// changed via ::HAPI_MaterialInfo::hasChanged instead of the material
1415  /// on the part.
1417 
1418  /// Groups.
1419  /// @{
1422  /// @}
1423 
1424  /// Total number of parts this geometry contains.
1425  /// See @ref HAPI_Parts.
1427 };
1429 
1431 {
1432  HAPI_PartId id;
1433  HAPI_StringHandle nameSH;
1435 
1438  int pointCount; ///< Number of points. Note that this is NOT the number
1439  ///< of "positions" as "points" may imply. If your
1440  ///< geometry has 3 points then set this to 3 and not 3*3.
1441 
1442  int attributeCounts[ HAPI_ATTROWNER_MAX ];
1443 
1444  /// If this is true, don't display this part. Load its data but then
1445  /// instance it where the corresponding instancer part tells you to
1446  /// instance it.
1448 
1449  /// The number of parts that this instancer part is instancing.
1450  /// For example, if we're instancing a curve and a box, they would come
1451  /// across as two parts, hence this count would be two.
1452  /// Call ::HAPI_GetInstancedPartIds() to get the list of ::HAPI_PartId's.
1454 
1455  /// The number of instances that this instancer part is instancing.
1456  /// Using the same example as with ::HAPI_PartInfo::instancedPartCount,
1457  /// if I'm instancing the merge of a curve and a box 5 times, this count
1458  /// would be 5. To be clear, all instanced parts are instanced the same
1459  /// number of times and with the same transform for each instance.
1460  /// Call ::HAPI_GetInstancerPartTransforms() to get the transform of
1461  /// each instance.
1463 
1464  /// If this is false, the underlying attribute data appear to match that of
1465  /// the previous cook. In this case you may be able to re-used marshaled
1466  /// data from the previous cook.
1468 };
1470 
1471 /// See @ref HAPI_Attributes.
1473 {
1475 
1478 
1479  /// When converting from the Houdini native GA geometry format to the
1480  /// GT geometry format HAPI uses, some attributes might change owners.
1481  /// For example, in Houdini GA curves can have points shared by
1482  /// vertices but the GT format only supports curve vertices
1483  /// (no points). This means that if you had point attributes on a curve
1484  /// in Houdini, when it comes out of HAPI those point attributes will now
1485  /// be vertex attributes. In this case, the ::HAPI_AttributeInfo::owner
1486  /// will be set to ::HAPI_ATTROWNER_VERTEX but the
1487  /// ::HAPI_AttributeInfo::originalOwner will be ::HAPI_ATTROWNER_POINT.
1489 
1490  /// Number of attributes. This count will match the number of values
1491  /// given the owner. For example, if the owner is ::HAPI_ATTROWNER_VERTEX
1492  /// this count will be the same as the ::HAPI_PartInfo::vertexCount.
1493  /// To be clear, this is not the number of values in the attribute, rather
1494  /// it is the number of attributes. If your geometry has three 3D points
1495  /// then this count will be 3 (not 3*3) while the
1496  /// ::HAPI_AttributeInfo::tupleSize will be 3.
1497  int count;
1498 
1499  /// Number of values per attribute.
1500  /// Note that this is NOT the memory size of the attribute. It is the
1501  /// number of values per attributes. Multiplying this by the
1502  /// size of the ::HAPI_AttributeInfo::storage will give you the memory
1503  /// size per attribute.
1505 
1506  /// Attribute type info
1507  /// This is used to help identify the type of data stored in an attribute.
1508  /// Using the type is recommended over using just an attribute's name to identify
1509  /// its purpose.
1511 };
1513 
1514 // MATERIALS ----------------------------------------------------------------
1515 
1517 {
1518  /// This is the HAPI node id for the SHOP node this material is attached
1519  /// to. Use it to get access to the parameters (which contain the
1520  /// texture paths).
1521  /// IMPORTANT: When the ::HAPI_MaterialInfo::hasChanged is true this
1522  /// @p nodeId could have changed. Do not assume ::HAPI_MaterialInfo::nodeId
1523  /// will never change for a specific material.
1524  HAPI_NodeId nodeId;
1525 
1527 
1529 };
1531 
1533 {
1534  HAPI_StringHandle nameSH;
1535  HAPI_StringHandle descriptionSH;
1536  HAPI_StringHandle defaultExtensionSH;
1537 };
1539 
1541 {
1542  /// Unlike the other members of this struct changing imageFileFormatNameSH
1543  /// and giving this struct back to HAPI_SetImageInfo() nothing will happen.
1544  /// Use this member variable to derive which image file format will be used
1545  /// by the HAPI_ExtractImageTo...() functions if called with
1546  /// image_file_format_name set to NULL. This way, you can decide whether
1547  /// to ask for a file format conversion (slower) or not (faster).
1548  HAPI_StringHandle imageFileFormatNameSH; // Read-only
1549 
1550  int xRes;
1551  int yRes;
1552 
1554 
1555  HAPI_Bool interleaved; ///< ex: true = RGBRGBRGB, false = RRRGGGBBB
1557 
1558  /// Adjust the gamma of the image. For anything less than
1559  /// ::HAPI_IMAGE_DATA_INT16, you probably want to leave this as 2.2.
1560  double gamma;
1561 };
1563 
1564 // ANIMATION ----------------------------------------------------------------
1565 
1567 {
1568  float time;
1569  float value;
1570  float inTangent;
1571  float outTangent;
1572 };
1574 
1575 // VOLUMES ------------------------------------------------------------------
1576 
1577 /// @struct HAPI_VolumeInfo
1578 ///
1579 /// This represents a volume primitive but does not contain the actual voxel
1580 /// values, which can be retrieved on a per-tile basis.
1581 ///
1582 /// See @ref HAPI_Volumes.
1583 ///
1585 {
1586  HAPI_StringHandle nameSH;
1587 
1589 
1590  /// Each voxel is identified with an index. The indices will range
1591  /// between:
1592  /// [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )
1593  /// @{
1594  int xLength;
1595  int yLength;
1596  int zLength;
1597  int minX;
1598  int minY;
1599  int minZ;
1600  /// @}
1601 
1602  /// Number of values per voxel.
1603  /// The tuple size field is 1 for scalars and 3 for vector data.
1605 
1606  /// Can be either ::HAPI_STORAGETYPE_INT or ::HAPI_STORAGETYPE_FLOAT.
1608 
1609  /// The dimensions of each tile.
1610  /// This can be 8 or 16, denoting an 8x8x8 or 16x16x16 tiles.
1612 
1613  /// The transform of the volume with respect to the lengths.
1614  /// The volume may be positioned anywhere in space.
1616 
1617  /// Denotes special situations where the volume tiles are not perfect
1618  /// cubes, but are tapered instead.
1620 
1621  /// If there is taper involved, denotes the amount of taper involved.
1622  /// @{
1623  float xTaper;
1624  float yTaper;
1625  /// @}
1626 };
1628 
1629 /// @struct HAPI_VolumeTileInfo
1630 ///
1631 /// A HAPI_VolumeTileInfo represents an cube subarray of the volume.
1632 /// The size of each dimension is HAPI_VoluemInfo::tileSize
1633 /// bbox [(minX, minY, minZ), (minX+tileSize, minY+tileSize, minZ+tileSize))
1634 ///
1636 {
1637  int minX;
1638  int minY;
1639  int minZ;
1641 };
1643 
1644 // CURVES -------------------------------------------------------------------
1645 
1646 /// @struct HAPI_CurveInfo
1647 ///
1648 /// This represents the meta-data associated with a curve mesh (a number
1649 /// of curves of the same type).
1651 {
1653  int curveCount; ///< The number of curves contained in this curve mesh.
1654  int vertexCount; ///< The number of control vertices (CVs) for all curves.
1655  int knotCount; ///< The number of knots for all curves.
1656 
1658  ///< Whether the curves in this curve mesh are periodic.
1660  ///< Whether the curves in this curve mesh are rational.
1661  int order; ///< Order of 1 is invalid. 0 means there is a varying order.
1662 
1663  HAPI_Bool hasKnots; ///< Whether the curve has knots.
1664 };
1666 
1667 // BASIC PRIMITIVES ---------------------------------------------------------
1668 
1670 {
1671  float center[ HAPI_POSITION_VECTOR_SIZE ];
1672  float size[ HAPI_SCALE_VECTOR_SIZE ];
1673  float rotation[ HAPI_EULER_VECTOR_SIZE ];
1674 };
1676 
1678 {
1679  float center[ HAPI_POSITION_VECTOR_SIZE ];
1680  float radius;
1681 };
1683 
1684 // PDG Structs --------------------------------------------------------------
1685 
1687 {
1688  HAPI_NodeId nodeId; /// id of related node
1689  HAPI_PDG_WorkitemId workitemId; /// id of related workitem
1690  HAPI_PDG_WorkitemId dependencyId; /// id of related workitem dependency
1691  int currentState; /// (HAPI_PDG_WorkItemState) value of current state for state change
1692  int lastState; /// (HAPI_PDG_WorkItemState) value of last state for state change
1693  int eventType; /// (HAPI_PDG_EventType) event type
1694  HAPI_StringHandle msgSH; /// String handle of the event message (> 0 if there is a message)
1695 };
1697 
1699 {
1700  int index; /// index of the workitem
1701  int numResults; /// number of results reported
1702  HAPI_StringHandle nameSH; /// name of the workitem
1703 };
1705 
1707 {
1708  int resultSH; /// result string data
1709  int resultTagSH; /// result tag
1710  HAPI_Int64 resultHash; /// hash value of result
1711 };
1713 
1714 // SESSIONSYNC --------------------------------------------------------------
1715 
1716 /// @struct HAPI_Viewport
1717 ///
1718 /// Contains the information for synchronizing viewport between Houdini
1719 /// and other applications. When SessionSync is enabled, Houdini will
1720 /// update this struct with its viewport state. It will also update
1721 /// its own viewport if this struct has changed.
1722 /// The data stored is in Houdini's right-handed Y-up coordinate system.
1723 ///
1725 {
1726  /// The world position of the viewport camera's pivot.
1727  float position[ HAPI_POSITION_VECTOR_SIZE ];
1728 
1729  /// The direction of the viewport camera stored as a quaternion.
1730  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
1731 
1732  /// The offset from the pivot to the viewport camera's
1733  /// actual world position.
1734  float offset;
1735 };
1737 
1738 /// @struct HAPI_SessionSyncInfo
1739 ///
1740 /// Contains the information for synchronizing general SessionSync
1741 /// state between Houdini and other applications. When SessionSync
1742 /// is enabled, Houdini will update this struct with its state.
1743 /// It will also update its internal state if this struct has
1744 /// changed.
1745 ///
1747 {
1748  /// Specifies whether Houdini's current time is used for Houdini Engine
1749  /// cooks. This is automatically enabled in SessionSync where
1750  /// Houdini's viewport forces cooks to use Houdini's current time.
1751  /// This is disabled in non-SessionSync mode, but can be toggled to
1752  /// override default behaviour.
1754 
1755  /// Specifies whether viewport synchronization is enabled. If enabled,
1756  /// in SessionSync, Houdini will update its own viewport using
1757  /// ::HAPI_Viewport.
1759 };
1761 
1762 #endif // __HAPI_COMMON_h__
HAPI_License
Definition: HAPI_Common.h:153
HAPI_NodeId objectNodeId
Definition: HAPI_Common.h:932
"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:731
HAPI_StringHandle disabledConditionSH
Definition: HAPI_Common.h:1287
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1391
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1195
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1688
SOP Node Specific Flags.
Definition: HAPI_Common.h:460
HAPI_StringHandle labelSH
This is what any end user should be shown.
Definition: HAPI_Common.h:939
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1433
HAPI_Bool isInstancer
See Instancing.
Definition: HAPI_Common.h:1359
HAPI_ImageDataFormat dataFormat
Definition: HAPI_Common.h:1553
int parmStringValueCount
Definition: HAPI_Common.h:1098
HAPI_Bool clearErrorsAndWarnings
Definition: HAPI_Common.h:1022
Recursive Flag.
Definition: HAPI_Common.h:446
Recursive Flag.
Definition: HAPI_Common.h:445
HAPI_ChoiceListType choiceListType
Definition: HAPI_Common.h:1177
int HAPI_NodeTypeBits
Definition: HAPI_Common.h:436
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1339
HAPI_NodeId objectToInstanceId
Definition: HAPI_Common.h:1382
HAPI_Bool refineCurveToLinear
Definition: HAPI_Common.h:1013
HAPI_PDG_WorkitemId workitemId
id of related node
Definition: HAPI_Common.h:1689
Equivalent to HAPI_STATUSVERBOSITY_1.
Definition: HAPI_Common.h:186
HAPI_ParmId id
Definition: HAPI_Common.h:1135
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:1400
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:1278
HAPI_PackedPrimInstancingMode packedPrimInstancingMode
Definition: HAPI_Common.h:1043
HAPI_SessionEnvIntType
Definition: HAPI_Common.h:711
"toggle", "embed"
Definition: HAPI_Common.h:359
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1067
#define HAPI_API
Definition: HAPI_API.h:79
OBJ Node Specific Flags.
Definition: HAPI_Common.h:454
int resultTagSH
result string data
Definition: HAPI_Common.h:1709
HAPI_NodeFlags
Definition: HAPI_Common.h:441
HAPI_GeoType
Definition: HAPI_Common.h:542
int instanceCount
The number of instances in a multiparm.
Definition: HAPI_Common.h:1273
HAPI_StringHandle visibilityConditionSH
Definition: HAPI_Common.h:1283
HAPI_Bool hasEverCooked
Definition: HAPI_Common.h:936
int eventType
(HAPI_PDG_WorkItemState) value of last state for state change
Definition: HAPI_Common.h:1693
HAPI_Bool haveMaterialsChanged
Definition: HAPI_Common.h:973
HAPI_NodeType inputNodeType
Definition: HAPI_Common.h:1258
HAPI_StringHandle typeNameSH
Definition: HAPI_Common.h:1313
HAPI_Bool isPeriodic
Whether the curves in this curve mesh are periodic.
Definition: HAPI_Common.h:1657
HAPI_RSTOrder
Definition: HAPI_Common.h:616
int parmFloatValueCount
Definition: HAPI_Common.h:1097
"intvector", "intvector3"
Definition: HAPI_Common.h:365
HAPI_CurveType
Definition: HAPI_Common.h:490
HAPI_PDG_State
Used with PDG functions.
Definition: HAPI_Common.h:764
HAPI_AttributeOwner owner
Definition: HAPI_Common.h:1476
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:862
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1396
int uniqueHoudiniNodeId
Definition: HAPI_Common.h:1081
Single Channel.
Definition: HAPI_Common.h:659
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1524
HAPI_ImageDataFormat
Definition: HAPI_Common.h:642
int handleCount
See Handles.
Definition: HAPI_Common.h:947
HAPI_PartType
Definition: HAPI_Common.h:566
int currentState
id of related workitem dependency
Definition: HAPI_Common.h:1691
HAPI_EnvIntType
Definition: HAPI_Common.h:678
HAPI_Bool isRational
Whether the curves in this curve mesh are rational.
Definition: HAPI_Common.h:1659
HAPI_Bool isValid
Definition: HAPI_Common.h:1073
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:874
HAPI_PackedPrimInstancingMode
Definition: HAPI_Common.h:257
HAPI_StringHandle labelSH
The label string for the parameter.
Definition: HAPI_Common.h:1198
Max cache memory limit in MB.
Definition: HAPI_Common.h:732
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
TOP Node Specific Flags.
Definition: HAPI_Common.h:464
True if it actually has a minimum size.
Definition: HAPI_Common.h:729
HAPI_Bool cookTemplatedGeos
Decide whether to recursively cook all templated geos or not.
Definition: HAPI_Common.h:1025
HAPI_StringHandle helpSH
The help string for this parameter.
Definition: HAPI_Common.h:1211
HAPI_Bool autoClose
Close the server automatically when all clients disconnect from it.
Definition: HAPI_Common.h:896
HAPI_StringHandle templateNameSH
Definition: HAPI_Common.h:1208
HAPI_AttributeOwner
Definition: HAPI_Common.h:479
HAPI_StringHandle fullOpNameSH
Full asset name and namespace.
Definition: HAPI_Common.h:942
RGBA Reversed.
Definition: HAPI_Common.h:664
Only some objects failed.
Definition: HAPI_Common.h:246
HAPI_ErrorCode
Definition: HAPI_Common.h:223
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1534
HAPI_Bool createdPostAssetLoad
Definition: HAPI_Common.h:1118
HAPI_Bool splitGeosByAttribute
Definition: HAPI_Common.h:1001
HAPI_NodeType
Definition: HAPI_Common.h:421
HAPI_CurveType curveType
Definition: HAPI_Common.h:1652
int knotCount
The number of knots for all curves.
Definition: HAPI_Common.h:1655
HAPI_Bool hasUIMax
Definition: HAPI_Common.h:1218
HAPI_StringHandle handleParmNameSH
Definition: HAPI_Common.h:1327
int HAPI_StringHandle
Definition: HAPI_Common.h:129
HAPI_StatusVerbosity
Definition: HAPI_Common.h:174
HAPI_AttributeOwner originalOwner
Definition: HAPI_Common.h:1488
Equivalent to HAPI_STATUSVERBOSITY_0.
Definition: HAPI_Common.h:184
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:893
Total number of supported parameter types.
Definition: HAPI_Common.h:320
See Attributes.
Definition: HAPI_Common.h:1472
HAPI_ChoiceListType
Definition: HAPI_Common.h:402
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1467
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1447
Everything cook successfully without errors.
Definition: HAPI_Common.h:244
HAPI_Bool spare
Definition: HAPI_Common.h:1241
Menu Only, Single Selection.
Definition: HAPI_Common.h:405
HAPI_XYZOrder rotationOrder
Definition: HAPI_Common.h:873
int curveCount
The number of curves contained in this curve mesh.
Definition: HAPI_Common.h:1653
HAPI_PrmScriptType
Definition: HAPI_Common.h:349
HAPI_Bool hasKnots
Whether the curve has knots.
Definition: HAPI_Common.h:1663
HAPI_XYZOrder
Definition: HAPI_Common.h:629
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1312
int HAPI_ParmId
Definition: HAPI_Common.h:138
int numResults
index of the workitem
Definition: HAPI_Common.h:1701
HAPI_ParmId parentId
Parameter id of the parent of this parameter.
Definition: HAPI_Common.h:1138
int HAPI_ErrorCodeBits
Definition: HAPI_Common.h:229
HAPI_AttributeTypeInfo typeInfo
Definition: HAPI_Common.h:1510
int order
Order of 1 is invalid. 0 means there is a varying order.
Definition: HAPI_Common.h:1661
int instancedPartCount
Definition: HAPI_Common.h:1453
int tagCount
Number of tags on this paramter.
Definition: HAPI_Common.h:1165
int transformInputCount
Definition: HAPI_Common.h:953
int outputCount
The number of outputs this specific node has.
Definition: HAPI_Common.h:1113
HAPI_Bool handleSpherePartTypes
Definition: HAPI_Common.h:1048
int instanceStartOffset
First instance's HAPI_ParmInfo::instanceNum. Either 0 or 1.
Definition: HAPI_Common.h:1276
int childIndex
Child index within its immediate parent parameter.
Definition: HAPI_Common.h:1141
HAPI_NodeId id
Definition: HAPI_Common.h:1065
HAPI_ImagePacking
Definition: HAPI_Common.h:656
HAPI_Transform transform
Definition: HAPI_Common.h:1615
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:1477
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:1271
int instanceLength
The number of parms in a multiparm instance.
Definition: HAPI_Common.h:1272
int lastState
(HAPI_PDG_WorkItemState) value of current state for state change
Definition: HAPI_Common.h:1692
HAPI_Permissions permissions
Definition: HAPI_Common.h:1162
HAPI_PDG_WorkitemState
Used with PDG functions.
Definition: HAPI_Common.h:835
HAPI_VolumeType
Definition: HAPI_Common.h:500
HAPI_ParmType type
The HAPI type of the parm.
Definition: HAPI_Common.h:1144
License Type. See HAPI_License.
Definition: HAPI_Common.h:716
HAPI_StringHandle descriptionSH
Definition: HAPI_Common.h:1535
HAPI_PDG_WorkitemId dependencyId
id of related workitem
Definition: HAPI_Common.h:1690
HAPI_HeightFieldSampling
Type of sampling for heightfield.
Definition: HAPI_Common.h:756
Field + Multiple Selection Menu.
Definition: HAPI_Common.h:408
HAPI_ImagePacking packing
Definition: HAPI_Common.h:1556
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:1245
HAPI_GeoType type
Definition: HAPI_Common.h:1390
HAPI_SessionId id
Definition: HAPI_Common.h:888
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:588
HAPI_Bool invisible
Definition: HAPI_Common.h:1232
HAPI_Bool joinNext
the next parm.
Definition: HAPI_Common.h:1243
HAPI_StringHandle splitAttrSH
Definition: HAPI_Common.h:1002
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1528
HAPI_PartType type
Definition: HAPI_Common.h:1434
HAPI_StringHandle valueSH
Definition: HAPI_Common.h:1298
HAPI_Bool haveGeosChanged
Definition: HAPI_Common.h:1350
HAPI_StringHandle versionSH
User-defined asset version.
Definition: HAPI_Common.h:941
HAPI_StorageType
Definition: HAPI_Common.h:509
HAPI_STATIC_ASSERT(sizeof(HAPI_Int64)==8, unsupported_size_of_long)
HAPI_Bool hasMax
Definition: HAPI_Common.h:1216
HAPI_NodeId nodeId
Definition: HAPI_Common.h:923
HAPI_StringHandle defaultExtensionSH
Definition: HAPI_Common.h:1536
HAPI_StringHandle assetParmNameSH
Definition: HAPI_Common.h:1328
HAPI_Bool isDisplayGeo
Final Result (Display SOP).
Definition: HAPI_Common.h:1406
HAPI_Bool isTimeDependent
Indicates if this node will change over time.
Definition: HAPI_Common.h:1121
HAPI_Bool hasGeoChanged
For incremental updates.
Definition: HAPI_Common.h:1409
int vertexCount
The number of control vertices (CVs) for all curves.
Definition: HAPI_Common.h:1654
HAPI_StringHandle imageFileFormatNameSH
Definition: HAPI_Common.h:1548
HAPI_Bool hasMaterialChanged
Definition: HAPI_Common.h:1416
HAPI_NodeId parentId
Definition: HAPI_Common.h:1066
Min cache memory limit in MB.
Definition: HAPI_Common.h:730
HAPI_Bool isTemplated
Has the templated flag turned on which means "expose as read-only".
Definition: HAPI_Common.h:1403
Looks for Guide Geometry.
Definition: HAPI_Common.h:461
int totalCookCount
Total number of cooks of this node.
Definition: HAPI_Common.h:1076
HAPI_StringHandle filePathSH
Path to the .otl library file.
Definition: HAPI_Common.h:940
HAPI_Bool checkPartChanges
Definition: HAPI_Common.h:1054
char HAPI_Bool
Definition: HAPI_Common.h:110
HAPI_Bool hasUIMin
Definition: HAPI_Common.h:1217
HAPI_StringHandle typeInfoSH
Definition: HAPI_Common.h:1155
HAPI_NodeType type
Definition: HAPI_Common.h:1068
HAPI_StatusType
Definition: HAPI_Common.h:165
int extraFlags
For internal use only. :)
Definition: HAPI_Common.h:1057
HAPI_PresetType
Definition: HAPI_Common.h:412
HAPI_StringHandle labelSH
Definition: HAPI_Common.h:1294
HAPI_Bool interleaved
ex: true = RGBRGBRGB, false = RRRGGGBBB
Definition: HAPI_Common.h:1555
int inputCount
The number of inputs this specific node has.
Definition: HAPI_Common.h:1110
HAPI_StringHandle helpURLSH
Asset help URL.
Definition: HAPI_Common.h:944
HAPI_Int64 resultHash
result tag
Definition: HAPI_Common.h:1710
HAPI_ParmId parentParmId
Definition: HAPI_Common.h:1293
"int", "integer"
Definition: HAPI_Common.h:351
HAPI_Result
Definition: HAPI_Common.h:193
HAPI_InputType
Definition: HAPI_Common.h:579
RGB Reversed.
Definition: HAPI_Common.h:662
HAPI_Bool splitGeosByGroup
Definition: HAPI_Common.h:992
HAPI_State
Definition: HAPI_Common.h:242
HAPI_VolumeType type
Definition: HAPI_Common.h:1588
int objectCount
See Objects.
Definition: HAPI_Common.h:946
HAPI_StringHandle helpTextSH
Asset help marked-up text.
Definition: HAPI_Common.h:943
int HAPI_PDG_WorkitemId
Use this with PDG functions.
Definition: HAPI_Common.h:145
HAPI_Bool splitPointsByVertexAttributes
Definition: HAPI_Common.h:1039
HAPI_StorageType storage
Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT.
Definition: HAPI_Common.h:1607
int HAPI_NodeFlagsBits
Definition: HAPI_Common.h:468
Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:188
HAPI_AttributeTypeInfo
Definition: HAPI_Common.h:521
HAPI_Bool haveObjectsChanged
Definition: HAPI_Common.h:969
#define HAPI_EULER_VECTOR_SIZE
Definition: HAPI_Common.h:21
HAPI_Bool cookUsingHoudiniTime
Definition: HAPI_Common.h:1753
HAPI_Bool hasTaper
Definition: HAPI_Common.h:1619
HAPI_GroupType
Definition: HAPI_Common.h:470
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1586
#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:1356
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:1432
HAPI_CacheProperty
[HAPI_CacheProperty]
Definition: HAPI_Common.h:723
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1365
You should abort the cook.
Definition: HAPI_Common.h:245
int primitiveGroupCount
Definition: HAPI_Common.h:1421
HAPI_PrmScriptType scriptType
The Houdini script-type of the parm.
Definition: HAPI_Common.h:1147
HAPI_StringHandle nameSH
Instance name (the label + a number).
Definition: HAPI_Common.h:938
HAPI_StringHandle nameSH
number of results reported
Definition: HAPI_Common.h:1702
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:598
HAPI_Bool hasTransformChanged
Definition: HAPI_Common.h:1346
HAPI_StringHandle objectInstancePathSH
(deprecated)
Definition: HAPI_Common.h:1342
HAPI_Bool hasMin
Definition: HAPI_Common.h:1215
HAPI_StringHandle internalNodePathSH
Definition: HAPI_Common.h:1086
HAPI_Bool disabled
Whether this parm should appear enabled or disabled.
Definition: HAPI_Common.h:1235
HAPI_Bool handleBoxPartTypes
Definition: HAPI_Common.h:1047
HAPI_StringHandle msgSH
(HAPI_PDG_EventType) event type
Definition: HAPI_Common.h:1694
HAPI_SessionType type
Definition: HAPI_Common.h:884
HAPI_NodeFlags inputNodeFlag
Definition: HAPI_Common.h:1265
int HAPI_PartId
Definition: HAPI_Common.h:142
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1377
HAPI_Bool isChildOfMultiParm
Definition: HAPI_Common.h:1269