HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HAPI_Common.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  */
7 
8 #ifndef __HAPI_COMMON_h__
9 #define __HAPI_COMMON_h__
10 
11 #include "HAPI_API.h"
12 
13 /////////////////////////////////////////////////////////////////////////////
14 // Defines
15 
16 #define HAPI_POSITION_VECTOR_SIZE 3
17 #define HAPI_SCALE_VECTOR_SIZE 3
18 #define HAPI_SHEAR_VECTOR_SIZE 3
19 #define HAPI_NORMAL_VECTOR_SIZE 3
20 #define HAPI_QUATERNION_VECTOR_SIZE 4
21 #define HAPI_EULER_VECTOR_SIZE 3
22 #define HAPI_UV_VECTOR_SIZE 2
23 #define HAPI_COLOR_VECTOR_SIZE 4
24 #define HAPI_CV_VECTOR_SIZE 4
25 
26 #define HAPI_PRIM_MIN_VERTEX_COUNT 1
27 #define HAPI_PRIM_MAX_VERTEX_COUNT 16
28 
29 #define HAPI_INVALID_PARM_ID -1
30 
31 /// Common Default Attributes' Names
32 /// @{
33 #define HAPI_ATTRIB_POSITION "P"
34 #define HAPI_ATTRIB_UV "uv"
35 #define HAPI_ATTRIB_UV2 "uv2"
36 #define HAPI_ATTRIB_NORMAL "N"
37 #define HAPI_ATTRIB_TANGENT "tangentu"
38 #define HAPI_ATTRIB_TANGENT2 "tangentv"
39 #define HAPI_ATTRIB_COLOR "Cd"
40 #define HAPI_ATTRIB_NAME "name"
41 #define HAPI_ATTRIB_INSTANCE "instance"
42 /// @}
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  HAPI_NODEFLAGS_SOP_GUIDE = 1 << 12 ///< Looks for Guide Geometry
463 };
465 typedef int HAPI_NodeFlagsBits;
466 
468 {
473 };
475 
477 {
484 };
486 
488 {
494 };
496 
498 {
503 };
505 
507 {
515 };
517 
519 {
521  HAPI_ATTRIBUTE_TYPE_NONE, // Implicit type based on data
523  HAPI_ATTRIBUTE_TYPE_HPOINT, // Homogeneous position
524  HAPI_ATTRIBUTE_TYPE_VECTOR, // Direction vector
530  HAPI_ATTRIBUTE_TYPE_ST, // Parametric interval
531  HAPI_ATTRIBUTE_TYPE_HIDDEN, // "Private" (hidden)
532  HAPI_ATTRIBUTE_TYPE_BOX2, // 2x2 Bounding box
533  HAPI_ATTRIBUTE_TYPE_BOX, // 3x3 Bounding box
534  HAPI_ATTRIBUTE_TYPE_TEXTURE, // Texture coordinate
536 };
538 
540 {
542 
543  /// Most geos will be of this type which essentially means a geo
544  /// not of the other types.
546 
547  /// An exposed edit node.
548  /// See @ref HAPI_IntermediateAssetsResults.
550 
551  /// An input geo that can accept geometry from the host.
552  /// See @ref HAPI_AssetInputs_MarshallingGeometryIntoHoudini.
554 
555  /// A curve.
556  /// See @ref HAPI_Curves.
558 
560 };
562 
564 {
573 };
575 
577 {
582 };
584 
586 {
592 };
594 
596 {
610 };
612 
614 {
615  HAPI_TRS = 0,
621 
623 };
625 
627 {
628  HAPI_XYZ = 0,
634 
636 };
638 
640 {
648 
650 };
652 
654 {
656  HAPI_IMAGE_PACKING_SINGLE, ///< Single Channel
657  HAPI_IMAGE_PACKING_DUAL, ///< Dual Channel
659  HAPI_IMAGE_PACKING_BGR, ///< RGB Reversed
661  HAPI_IMAGE_PACKING_ABGR, ///< RGBA Reversed
663 
666 };
668 
669 /// This enum is to be used with ::HAPI_GetEnvInt() to retrieve basic
670 /// information about the HAPI implementation currently being linked
671 /// against. Note that as of HAPI version 2.0, these enum values are
672 /// guaranteed never to change so you can reliably get this information from
673 /// any post-2.0 version of HAPI. The same goes for the actual
674 /// ::HAPI_GetEnvInt() API call.
676 {
678 
679  /// The three components of the Houdini version that HAPI is
680  /// expecting to link against.
681  /// @{
686  /// @}
687 
688  /// The two components of the Houdini Engine (marketed) version.
689  /// @{
692  /// @}
693 
694  /// This is a monotonously increasing API version number that can be used
695  /// to lock against a certain API for compatibility purposes. Basically,
696  /// when this number changes code compiled against the HAPI.h methods
697  /// might no longer compile. Semantic changes to the methods will also
698  /// cause this version to increase. This number will be reset to 0
699  /// every time the Houdini Engine version is bumped.
701 
703 };
705 
706 /// This enum is to be used with ::HAPI_GetSessionEnvInt() to retrieve basic
707 /// session-specific information.
709 {
711 
712  /// License Type. See ::HAPI_License.
714 
716 };
718 
719 /// [HAPI_CacheProperty]
721 {
722  /// Current memory usage in MB. Setting this to 0 invokes
723  /// a cache clear.
725 
726  HAPI_CACHEPROP_HAS_MIN, ///< True if it actually has a minimum size.
727  HAPI_CACHEPROP_MIN, ///< Min cache memory limit in MB.
728  HAPI_CACHEPROP_HAS_MAX, ///< True if it actually has a maximum size.
729  HAPI_CACHEPROP_MAX, ///< Max cache memory limit in MB.
730 
731  /// How aggressive to cull memory. This only works for:
732  /// - ::HAPI_CACHE_COP_COOK where:
733  /// 0 -> Never reduce inactive cache.
734  /// 1 -> Always reduce inactive cache.
735  /// - ::HAPI_CACHE_OBJ where:
736  /// 0 -> Never enforce the max memory limit.
737  /// 1 -> Always enforce the max memory limit.
738  /// - ::HAPI_CACHE_SOP where:
739  /// 0 -> When to Unload = Never
740  /// When to Limit Max Memory = Never
741  /// 1-2 -> When to Unload = Based on Flag
742  /// When to Limit Max Memory = Never
743  /// 3-4 -> When to Unload = Based on Flag
744  /// When to Limit Max Memory = Always
745  /// 5 -> When to Unload = Always
746  /// When to Limit Max Memory = Always
748 };
749 
751 
752 /// Used with PDG functions
754 {
758 
760 };
762 
763 /// Used with PDG functions
765 {
767 
771 
774 
777 
779 
782 
785 
787 };
789 
790 /// Used with PDG functions
792 {
802 };
804 
805 /////////////////////////////////////////////////////////////////////////////
806 // Main API Structs
807 
808 // GENERICS -----------------------------------------------------------------
809 
811 {
812  float position[ HAPI_POSITION_VECTOR_SIZE ];
813  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
816 
818 };
820 
822 {
823  float position[ HAPI_POSITION_VECTOR_SIZE ];
824  float rotationEuler[ HAPI_EULER_VECTOR_SIZE ];
827 
830 };
832 
833 // SESSIONS -----------------------------------------------------------------
834 
836 {
837  /// The type of session determines the which implementation will be
838  /// used to communicate with the Houdini Engine library.
840 
841  /// Some session types support multiple simultaneous sessions. This means
842  /// that each session needs to have a unique identifier.
843  HAPI_SessionId id;
844 };
846 
847 /// Options to configure a Thrift server being started from HARC.
849 {
850  /// Close the server automatically when all clients disconnect from it.
852 
853  /// Timeout in milliseconds for waiting on the server to
854  /// signal that it's ready to serve. If the server fails
855  /// to signal within this time interval, the start server call fails
856  /// and the server process is terminated.
857  float timeoutMs;
858 };
860 
861 // TIME ---------------------------------------------------------------------
862 
864 {
865  float fps;
866 
867  float startTime;
868  float endTime;
869 };
871 
872 // ASSETS -------------------------------------------------------------------
873 
875 {
876  /// Use the node id to get the asset's parameters.
877  /// See @ref HAPI_Nodes_Basics.
878  HAPI_NodeId nodeId;
879 
880  /// The objectNodeId differs from the regular nodeId in that for
881  /// geometry based assets (SOPs) it will be the node id of the dummy
882  /// object (OBJ) node instead of the asset node. For object based assets
883  /// the objectNodeId will equal the nodeId. The reason the distinction
884  /// exists is because transforms are always stored on the object node
885  /// but the asset parameters may not be on the asset node if the asset
886  /// is a geometry asset so we need both.
887  HAPI_NodeId objectNodeId;
888 
889  /// It's possible to instantiate an asset without cooking it.
890  /// See @ref HAPI_Assets_Cooking.
892 
893  HAPI_StringHandle nameSH; ///< Instance name (the label + a number).
894  HAPI_StringHandle labelSH; ///< This is what any end user should be shown.
895  HAPI_StringHandle filePathSH; ///< Path to the .otl library file.
896  HAPI_StringHandle versionSH; ///< User-defined asset version.
897  HAPI_StringHandle fullOpNameSH; ///< Full asset name and namespace.
898  HAPI_StringHandle helpTextSH; ///< Asset help marked-up text.
899 
900  int objectCount; ///< See @ref HAPI_Objects.
901  int handleCount; ///< See @ref HAPI_Handles.
902 
903  /// Transform inputs exposed by the asset. For OBJ assets this is the
904  /// number of transform inputs on the OBJ node. For SOP assets, this is
905  /// the singular transform input on the dummy wrapper OBJ node.
906  /// See @ref HAPI_AssetInputs.
908 
909  /// Geometry inputs exposed by the asset. For SOP assets this is
910  /// the number of geometry inputs on the SOP node itself. OBJ assets
911  /// will always have zero geometry inputs.
912  /// See @ref HAPI_AssetInputs.
914 
915  /// Geometry outputs exposed by the asset. For SOP assets this is
916  /// the number of geometry outputs on the SOP node itself. OBJ assets
917  /// will always have zero geometry outputs.
918  /// See @ref HAPI_AssetInputs.
920 
921  /// For incremental updates. Indicates whether any of the assets's
922  /// objects have changed. Refreshed only during an asset cook.
924 
925  /// For incremental updates. Indicates whether any of the asset's
926  /// materials have changed. Refreshed only during an asset cook.
928 };
930 
932 {
933  /// Normally, geos are split into parts in two different ways. First it
934  /// is split by group and within each group it is split by primitive type.
935  ///
936  /// For example, if you have a geo with group1 covering half of the mesh
937  /// and volume1 and group2 covering the other half of the mesh, all of
938  /// curve1, and volume2 you will end up with 5 parts. First two parts
939  /// will be for the half-mesh of group1 and volume1, and the last three
940  /// will cover group2.
941  ///
942  /// This toggle lets you disable the splitting by group and just have
943  /// the geo be split by primitive type alone. By default, this is true
944  /// and therefore geos will be split by group and primitive type. If
945  /// set to false, geos will only be split by primitive type.
947 
948  /// For meshes only, this is enforced by convexing the mesh. Use -1
949  /// to avoid convexing at all and get some performance boost.
951 
952  /// For curves only.
953  /// If this is set to true, then all curves will be refined to a linear
954  /// curve and you can no longer access the original CVs. You can control
955  /// the refinement detail via ::HAPI_CookOptions::curveRefineLOD.
956  /// If it's false, the curve type (NURBS, Bezier etc) will be left as is.
958 
959  /// Controls the number of divisions per unit distance when refining
960  /// a curve to linear. The default in Houdini is 8.0.
962 
963  /// If this option is turned on, then we will recursively clear the
964  /// errors and warnings (and messages) of all nodes before performing
965  /// the cook.
967 
968  /// Decide whether to recursively cook all templated geos or not.
970 
971  /// Decide whether to split points by vertex attributes. This takes
972  /// all vertex attributes and tries to copy them to their respective
973  /// points. If two vertices have any difference in their attribute values,
974  /// the corresponding point is split into two points. This is repeated
975  /// until all the vertex attributes have been copied to the points.
976  ///
977  /// With this option enabled, you can reduce the total number of vertices
978  /// on a game engine side as sharing of attributes (like UVs) is optimized.
979  /// To make full use of this feature, you have to think of Houdini points
980  /// as game engine vertices (sharable). With this option OFF (or before
981  /// this feature existed) you had to map Houdini vertices to game engine
982  /// vertices, to make sure all attribute values are accounted for.
984 
985  /// Choose how you want the cook to handle packed primitives.
986  /// The default is: ::HAPI_PACKEDPRIM_INSTANCING_MODE_DISABLED
988 
989  /// Choose which special part types should be handled. Unhandled special
990  /// part types will just be refined to ::HAPI_PARTTYPE_MESH.
993 
994  /// If enabled, sets the ::HAPI_PartInfo::hasChanged member during the
995  /// cook. If disabled, the member will always be true. Checking for
996  /// part changes can be expensive, so there is a potential performance
997  /// gain when disabled.
999 
1000  /// For internal use only. :)
1002 };
1004 
1005 // NODES --------------------------------------------------------------------
1006 
1008 {
1009  HAPI_NodeId id;
1010  HAPI_NodeId parentId;
1011  HAPI_StringHandle nameSH;
1013 
1014  /// Always true unless the asset's definition has changed due to loading
1015  /// a duplicate asset definition and from another OTL asset library
1016  /// file OR deleting the OTL asset library file used by this node's asset.
1018 
1019  /// Total number of cooks of this node.
1021 
1022  /// Use this unique id to grab the OP_Node pointer for this node.
1023  /// If you're linking against the C++ HDK, include the OP_Node.h header
1024  /// and call OP_Node::lookupNode().
1026 
1027  /// This is the internal node path in the Houdini scene graph. This path
1028  /// is meant to be abstracted away for most client purposes but for
1029  /// advanced uses it can come in handy.
1030  HAPI_StringHandle internalNodePathSH;
1031 
1032  /// Total number of parameters this asset has exposed. Includes hidden
1033  /// parameters.
1034  /// See @ref HAPI_Parameters.
1036 
1037  /// Number of values. A single parameter may have more than one value so
1038  /// this number is more than or equal to ::HAPI_NodeInfo::parmCount.
1039  /// @{
1043  /// @}
1044 
1045  /// The total number of choices among all the combo box parameters.
1046  /// See @ref HAPI_Parameters_ChoiceLists.
1048 
1049  /// The number of child nodes. This is 0 for all nodes that are not
1050  /// node networks.
1052 
1053  /// The number of inputs this specific node has.
1055 
1056  /// The number of outputs this specific node has.
1058 
1059  /// Nodes created via scripts or via ::HAPI_CreateNode() will be have
1060  /// this set to true. Only such nodes can be deleted using
1061  /// ::HAPI_DeleteNode().
1063 
1064  /// Indicates if this node will change over time
1066 };
1068 
1069 // PARAMETERS ---------------------------------------------------------------
1070 
1071 /// @struct HAPI_ParmInfo
1072 ///
1073 /// Contains parameter information like name, label, type, and size.
1074 ///
1076 {
1077  /// The parent id points to the id of the parent parm
1078  /// of this parm. The parent parm is something like a folder.
1079  HAPI_ParmId id;
1080 
1081  /// Parameter id of the parent of this parameter.
1082  HAPI_ParmId parentId;
1083 
1084  /// Child index within its immediate parent parameter.
1086 
1087  /// The HAPI type of the parm
1089 
1090  /// The Houdini script-type of the parm
1092 
1093  /// Some parameter types require additional type information.
1094  /// - File path parameters will indicate what file extensions they
1095  /// expect in a space-separated list of wild-cards. This is set
1096  /// in the Operator Type Properties using the File Pattern
1097  /// parameter property.
1098  /// For example, for filtering by PNG and JPG only: "*.png *.jpg"
1099  HAPI_StringHandle typeInfoSH;
1100 
1101  /// For the majority of parameter types permission will not be applicable.
1102  /// For file path parameters these permissions will indicate how the
1103  /// asset plans to use the file: whether it will only read it, only write
1104  /// to it, or both. This is set in the Operator Type Properties using
1105  /// the Browse Mode parameter property.
1107 
1108  /// Number of tags on this paramter.
1110 
1111  /// Tuple size. For scalar parameters this value is 1, but for vector
1112  /// parameters this value can be greater. For example, a 3 vector would
1113  /// have a size of 3. For folders and folder lists, this value is the
1114  /// number of children they own.
1115  int size;
1116 
1117  /// Any ::HAPI_ParmType can be a choice list. If this is set to
1118  /// ::HAPI_CHOICELISTTYPE_NONE, than this parameter is NOT a choice list.
1119  /// Otherwise, the parameter is a choice list of the indicated type.
1120  /// See @ref HAPI_Parameters_ChoiceLists.
1122 
1123  /// Any ::HAPI_ParmType can be a choice list. If the parameter is a
1124  /// choice list, this tells you how many choices it currently has.
1125  /// Note that some menu parameters can have a dynamic number of choices
1126  /// so it is important that this count is re-checked after every cook.
1127  /// See @ref HAPI_Parameters_ChoiceLists.
1129 
1130  /// Note that folders are not real parameters in Houdini so they do not
1131  /// have names. The folder names given here are generated from the name
1132  /// of the folderlist (or switcher) parameter which is a parameter. The
1133  /// folderlist parameter simply defines how many of the "next" parameters
1134  /// belong to the first folder, how many of the parameters after that
1135  /// belong to the next folder, and so on. This means that folder names
1136  /// can change just by reordering the folders around so don't rely on
1137  /// them too much. The only guarantee here is that the folder names will
1138  /// be unique among all other parameter names.
1139  HAPI_StringHandle nameSH;
1140 
1141  /// The label string for the parameter
1142  HAPI_StringHandle labelSH;
1143 
1144  /// If this parameter is a multiparm instance than the
1145  /// ::HAPI_ParmInfo::templateNameSH will be the hash-templated parm name,
1146  /// containing #'s for the parts of the name that use the instance number.
1147  /// Compared to the ::HAPI_ParmInfo::nameSH, the ::HAPI_ParmInfo::nameSH
1148  /// will be the ::HAPI_ParmInfo::templateNameSH but with the #'s
1149  /// replaced by the instance number. For regular parms, the
1150  /// ::HAPI_ParmInfo::templateNameSH is identical to the
1151  /// ::HAPI_ParmInfo::nameSH.
1152  HAPI_StringHandle templateNameSH;
1153 
1154  /// The help string for this parameter
1155  HAPI_StringHandle helpSH;
1156 
1157  /// Whether min/max exists for the parameter values.
1158  /// @{
1163  /// @}
1164 
1165  /// Parameter value range, shared between int and float parameters.
1166  /// @{
1167  float min;
1168  float max;
1169  float UIMin;
1170  float UIMax;
1171  /// @}
1172 
1173  /// Whether this parm should be hidden from the user entirely. This is
1174  /// mostly used to expose parameters as asset meta-data but not allow the
1175  /// user to directly modify them.
1177 
1178  /// Whether this parm should appear enabled or disabled.
1180 
1181  /// If true, it means this parameter doesn't actually exist on the node
1182  /// in Houdini but was added by Houdini Engine as a spare parameter.
1183  /// This is just for your information. The behaviour of this parameter
1184  /// is not any different than a non-spare parameter.
1186 
1187  HAPI_Bool joinNext; ///< Whether this parm should be on the same line as
1188  ///< the next parm.
1189  HAPI_Bool labelNone; ///< Whether the label should be displayed.
1190 
1191  /// The index to use to look into the values array in order to retrieve
1192  /// the actual value(s) of this parameter.
1193  /// @{
1198  /// @}
1199 
1200  /// If this is a ::HAPI_PARMTYPE_NODE, this tells you what node types
1201  /// this parameter accepts.
1203 
1204  /// The node input parameter could have another subtype filter specified,
1205  /// like "Object: Geometry Only". In this case, this value will specify
1206  /// that extra filter. If the filter demands a node that HAPI does not
1207  /// support, both this and ::HAPI_ParmInfo::inputNodeType will be set to
1208  /// NONE as such a node is not settable through HAPI.
1210 
1211  /// See @ref HAPI_Parameters_MultiParms.
1212  /// @{
1214 
1215  int instanceNum; ///< The index of the instance in the multiparm.
1216  int instanceLength; ///< The number of parms in a multiparm instance.
1217  int instanceCount; ///< The number of instances in a multiparm.
1218 
1219  /// First instance's ::HAPI_ParmInfo::instanceNum. Either 0 or 1.
1221 
1223  /// @}
1224 
1225  /// Provides the raw condition string which is used to evaluate the
1226  /// the visibility of a parm
1227  HAPI_StringHandle visibilityConditionSH;
1228 
1229  /// Provides the raw condition string which is used to evalute whether
1230  /// a parm is enabled or disabled
1231  HAPI_StringHandle disabledConditionSH;
1232 };
1234 
1236 {
1237  HAPI_ParmId parentParmId;
1238  HAPI_StringHandle labelSH;
1239 
1240  /// This evaluates to the value of the token associated with the label
1241  /// applies to string menus only.
1242  HAPI_StringHandle valueSH;
1243 };
1245 
1246 // HANDLES ------------------------------------------------------------------
1247 
1248 /// @struct HAPI_HandleInfo
1249 ///
1250 /// Contains handle information such as the type of handle
1251 /// (translate, rotate, scale, softxform ...etc) and the number of
1252 /// parameters the current handle is bound to.
1253 ///
1255 {
1256  HAPI_StringHandle nameSH;
1257  HAPI_StringHandle typeNameSH;
1258 
1260 };
1262 
1263 /// @struct HAPI_HandleBindingInfo
1264 ///
1265 /// Contains binding information that maps the handle parameter to
1266 /// the asset parameter. The index is only used for int and float vector
1267 /// and colour parms.
1268 ///
1270 {
1271  HAPI_StringHandle handleParmNameSH;
1272  HAPI_StringHandle assetParmNameSH;
1273 
1274  HAPI_ParmId assetParmId;
1276 };
1278 
1279 // OBJECTS ------------------------------------------------------------------
1280 
1282 {
1283  HAPI_StringHandle nameSH;
1284 
1285  /// (deprecated)
1286  HAPI_StringHandle objectInstancePathSH;
1287 
1288  /// For incremental updates. Indicates whether the object's transform
1289  /// has changed. Refreshed only during an asset cook.
1291 
1292  /// For incremental updates. Indicates whether any of the object's
1293  /// geometry nodes have changed. Refreshed only during an asset cook.
1295 
1296  /// Whether the object is hidden and should not be shown. Some objects
1297  /// should be hidden but still brought into the host environment, for
1298  /// example those used only for instancing.
1299  /// See @ref HAPI_Instancing.
1301 
1302  /// See @ref HAPI_Instancing.
1304 
1305  /// Determine if this object is being instanced. Normally, this implies
1306  /// that while this object may not be visible, it should still be
1307  /// brought into the host application because it is needed by an instancer.
1308  /// See @ref HAPI_Instancing.
1310 
1311  /// (deprecated) The number of geometries under this object. For those familiar
1312  /// with Houdini, this number will always include the one visible SOP and any
1313  /// SOPs that were exposed as "editable" or "templated".
1314  /// See @ref HAPI_Geos.
1316 
1317  /// Use the node id to get the node's parameters.
1318  /// Using the HDK, you can also get the raw node C++ pointer for this
1319  /// object's internal node.
1320  /// See @ref HAPI_Nodes_Basics.
1321  HAPI_NodeId nodeId;
1322 
1323  /// If the object is an instancer, this variable gives the object id of
1324  /// the object that should be instanced.
1325  /// See @ref HAPI_Instancing.
1326  HAPI_NodeId objectToInstanceId;
1327 };
1329 
1330 // GEOMETRY -----------------------------------------------------------------
1331 
1333 {
1335  HAPI_StringHandle nameSH;
1336 
1337  /// Use the node id to get the node's parameters.
1338  /// Using the HDK, you can also get the raw node C++ pointer for this
1339  /// object's internal node.
1340  HAPI_NodeId nodeId;
1341 
1342  /// Whether the SOP node has been exposed by dragging it into the
1343  /// editable nodes section of the asset definition.
1345 
1346  /// Has the templated flag turned on which means "expose as read-only".
1348 
1349  /// Final Result (Display SOP).
1351 
1352  /// For incremental updates.
1354 
1355  /// (deprecated) This variable is deprecated and should no longer be used.
1356  /// Materials are now separate from parts. They are maintained at the
1357  /// asset level so you only need to check if the material itself has
1358  /// changed via ::HAPI_MaterialInfo::hasChanged instead of the material
1359  /// on the part.
1361 
1362  /// Groups.
1363  /// @{
1366  /// @}
1367 
1368  /// Total number of parts this geometry contains.
1369  /// See @ref HAPI_Parts.
1371 };
1373 
1375 {
1376  HAPI_PartId id;
1377  HAPI_StringHandle nameSH;
1379 
1382  int pointCount; ///< Number of points. Note that this is NOT the number
1383  ///< of "positions" as "points" may imply. If your
1384  ///< geometry has 3 points then set this to 3 and not 3*3.
1385 
1386  int attributeCounts[ HAPI_ATTROWNER_MAX ];
1387 
1388  /// If this is true, don't display this part. Load its data but then
1389  /// instance it where the corresponding instancer part tells you to
1390  /// instance it.
1392 
1393  /// The number of parts that this instancer part is instancing.
1394  /// For example, if we're instancing a curve and a box, they would come
1395  /// across as two parts, hence this count would be two.
1396  /// Call ::HAPI_GetInstancedPartIds() to get the list of ::HAPI_PartId's.
1398 
1399  /// The number of instances that this instancer part is instancing.
1400  /// Using the same example as with ::HAPI_PartInfo::instancedPartCount,
1401  /// if I'm instancing the merge of a curve and a box 5 times, this count
1402  /// would be 5. To be clear, all instanced parts are instanced the same
1403  /// number of times and with the same transform for each instance.
1404  /// Call ::HAPI_GetInstancerPartTransforms() to get the transform of
1405  /// each instance.
1407 
1408  /// If this is false, the underlying attribute data appear to match that of
1409  /// the previous cook. In this case you may be able to re-used marshaled
1410  /// data from the previous cook.
1412 };
1414 
1415 /// See @ref HAPI_Attributes.
1417 {
1419 
1422 
1423  /// When converting from the Houdini native GA geometry format to the
1424  /// GT geometry format HAPI uses, some attributes might change owners.
1425  /// For example, in Houdini GA curves can have points shared by
1426  /// vertices but the GT format only supports curve vertices
1427  /// (no points). This means that if you had point attributes on a curve
1428  /// in Houdini, when it comes out of HAPI those point attributes will now
1429  /// be vertex attributes. In this case, the ::HAPI_AttributeInfo::owner
1430  /// will be set to ::HAPI_ATTROWNER_VERTEX but the
1431  /// ::HAPI_AttributeInfo::originalOwner will be ::HAPI_ATTROWNER_POINT.
1433 
1434  /// Number of attributes. This count will match the number of values
1435  /// given the owner. For example, if the owner is ::HAPI_ATTROWNER_VERTEX
1436  /// this count will be the same as the ::HAPI_PartInfo::vertexCount.
1437  /// To be clear, this is not the number of values in the attribute, rather
1438  /// it is the number of attributes. If your geometry has three 3D points
1439  /// then this count will be 3 (not 3*3) while the
1440  /// ::HAPI_AttributeInfo::tupleSize will be 3.
1441  int count;
1442 
1443  /// Number of values per attribute.
1444  /// Note that this is NOT the memory size of the attribute. It is the
1445  /// number of values per attributes. Multiplying this by the
1446  /// size of the ::HAPI_AttributeInfo::storage will give you the memory
1447  /// size per attribute.
1449 
1450  /// Attribute type info
1451  /// This is used to help identify the type of data stored in an attribute.
1452  /// Using the type is recommended over using just an attribute's name to identify
1453  /// its purpose.
1455 };
1457 
1458 // MATERIALS ----------------------------------------------------------------
1459 
1461 {
1462  /// This is the HAPI node id for the SHOP node this material is attached
1463  /// to. Use it to get access to the parameters (which contain the
1464  /// texture paths).
1465  /// IMPORTANT: When the ::HAPI_MaterialInfo::hasChanged is true this
1466  /// @p nodeId could have changed. Do not assume ::HAPI_MaterialInfo::nodeId
1467  /// will never change for a specific material.
1468  HAPI_NodeId nodeId;
1469 
1471 
1473 };
1475 
1477 {
1478  HAPI_StringHandle nameSH;
1479  HAPI_StringHandle descriptionSH;
1480  HAPI_StringHandle defaultExtensionSH;
1481 };
1483 
1485 {
1486  /// Unlike the other members of this struct changing imageFileFormatNameSH
1487  /// and giving this struct back to HAPI_SetImageInfo() nothing will happen.
1488  /// Use this member variable to derive which image file format will be used
1489  /// by the HAPI_ExtractImageTo...() functions if called with
1490  /// image_file_format_name set to NULL. This way, you can decide whether
1491  /// to ask for a file format conversion (slower) or not (faster).
1492  HAPI_StringHandle imageFileFormatNameSH; // Read-only
1493 
1494  int xRes;
1495  int yRes;
1496 
1498 
1499  HAPI_Bool interleaved; ///< ex: true = RGBRGBRGB, false = RRRGGGBBB
1501 
1502  /// Adjust the gamma of the image. For anything less than
1503  /// ::HAPI_IMAGE_DATA_INT16, you probably want to leave this as 2.2.
1504  double gamma;
1505 };
1507 
1508 // ANIMATION ----------------------------------------------------------------
1509 
1511 {
1512  float time;
1513  float value;
1514  float inTangent;
1515  float outTangent;
1516 };
1518 
1519 // VOLUMES ------------------------------------------------------------------
1520 
1521 /// @struct HAPI_VolumeInfo
1522 ///
1523 /// This represents a volume primitive but does not contain the actual voxel
1524 /// values, which can be retrieved on a per-tile basis.
1525 ///
1526 /// See @ref HAPI_Volumes.
1527 ///
1529 {
1530  HAPI_StringHandle nameSH;
1531 
1533 
1534  /// Each voxel is identified with an index. The indices will range
1535  /// between:
1536  /// [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )
1537  /// @{
1538  int xLength;
1539  int yLength;
1540  int zLength;
1541  int minX;
1542  int minY;
1543  int minZ;
1544  /// @}
1545 
1546  /// Number of values per voxel.
1547  /// The tuple size field is 1 for scalars and 3 for vector data.
1549 
1550  /// Can be either ::HAPI_STORAGETYPE_INT or ::HAPI_STORAGETYPE_FLOAT.
1552 
1553  /// The dimensions of each tile.
1554  /// This can be 8 or 16, denoting an 8x8x8 or 16x16x16 tiles.
1556 
1557  /// The transform of the volume with respect to the lengths.
1558  /// The volume may be positioned anywhere in space.
1560 
1561  /// Denotes special situations where the volume tiles are not perfect
1562  /// cubes, but are tapered instead.
1564 
1565  /// If there is taper involved, denotes the amount of taper involved.
1566  /// @{
1567  float xTaper;
1568  float yTaper;
1569  /// @}
1570 };
1572 
1573 /// @struct HAPI_VolumeTileInfo
1574 ///
1575 /// A HAPI_VolumeTileInfo represents an cube subarray of the volume.
1576 /// The size of each dimension is HAPI_VoluemInfo::tileSize
1577 /// bbox [(minX, minY, minZ), (minX+tileSize, minY+tileSize, minZ+tileSize))
1578 ///
1580 {
1581  int minX;
1582  int minY;
1583  int minZ;
1585 };
1587 
1588 // CURVES -------------------------------------------------------------------
1589 
1590 /// @struct HAPI_CurveInfo
1591 ///
1592 /// This represents the meta-data associated with a curve mesh (a number
1593 /// of curves of the same type).
1595 {
1597  int curveCount; ///< The number of curves contained in this curve mesh.
1598  int vertexCount; ///< The number of control vertices (CVs) for all curves.
1599  int knotCount; ///< The number of knots for all curves.
1600 
1602  ///< Whether the curves in this curve mesh are periodic.
1604  ///< Whether the curves in this curve mesh are rational.
1605  int order; ///< Order of 1 is invalid. 0 means there is a varying order.
1606 
1607  HAPI_Bool hasKnots; ///< Whether the curve has knots.
1608 };
1610 
1611 // BASIC PRIMITIVES ---------------------------------------------------------
1612 
1614 {
1615  float center[ HAPI_POSITION_VECTOR_SIZE ];
1618 };
1620 
1622 {
1623  float center[ HAPI_POSITION_VECTOR_SIZE ];
1624  float radius;
1625 };
1627 
1628 // PDG Structs ---------------------------------------------------------------
1629 
1631 {
1632  HAPI_NodeId nodeId; /// id of related node
1633  HAPI_PDG_WorkitemId workitemId; /// id of related workitem
1634  HAPI_PDG_WorkitemId dependencyId; /// id of related workitem dependency
1635  int currentState; /// (HAPI_PDG_WorkItemState) value of current state for state change
1636  int lastState; /// (HAPI_PDG_WorkItemState) value of last state for state change
1637  int eventType; /// (HAPI_PDG_EventType) event type
1638 };
1640 
1642 {
1643  int index; /// index of the workitem
1644  int numResults; /// number of results reported
1645  HAPI_StringHandle nameSH; /// name of the workitem
1646 };
1648 
1650 {
1651  int resultSH; /// result string data
1652  int resultTagSH; /// result tag
1653  HAPI_Int64 resultHash; /// hash value of result
1654 };
1656 
1657 #endif // __HAPI_COMMON_h__
HAPI_License
Definition: HAPI_Common.h:153
HAPI_NodeId objectNodeId
Definition: HAPI_Common.h:887
"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:728
HAPI_StringHandle disabledConditionSH
Definition: HAPI_Common.h:1231
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1335
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1139
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1632
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:894
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1377
HAPI_Bool isInstancer
See HAPI_Instancing.
Definition: HAPI_Common.h:1303
HAPI_ImageDataFormat dataFormat
Definition: HAPI_Common.h:1497
int parmStringValueCount
Definition: HAPI_Common.h:1042
HAPI_Bool clearErrorsAndWarnings
Definition: HAPI_Common.h:966
Recursive Flag.
Definition: HAPI_Common.h:447
Recursive Flag.
Definition: HAPI_Common.h:446
HAPI_ChoiceListType choiceListType
Definition: HAPI_Common.h:1121
int HAPI_NodeTypeBits
Definition: HAPI_Common.h:437
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1283
HAPI_NodeId objectToInstanceId
Definition: HAPI_Common.h:1326
HAPI_Bool refineCurveToLinear
Definition: HAPI_Common.h:957
HAPI_PDG_WorkitemId workitemId
id of related node
Definition: HAPI_Common.h:1633
Equivalent to HAPI_STATUSVERBOSITY_1.
Definition: HAPI_Common.h:186
HAPI_ParmId id
Definition: HAPI_Common.h:1079
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:1344
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:1222
MatType shear(Axis axis0, Axis axis1, typename MatType::value_type shear)
Set the matrix to a shear along axis0 by a fraction of axis1.
Definition: Mat.h:720
HAPI_PackedPrimInstancingMode packedPrimInstancingMode
Definition: HAPI_Common.h:987
HAPI_SessionEnvIntType
Definition: HAPI_Common.h:708
"toggle", "embed"
Definition: HAPI_Common.h:359
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1011
#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:1652
HAPI_NodeFlags
Definition: HAPI_Common.h:442
HAPI_GeoType
Definition: HAPI_Common.h:539
int instanceCount
The number of instances in a multiparm.
Definition: HAPI_Common.h:1217
HAPI_StringHandle visibilityConditionSH
Definition: HAPI_Common.h:1227
HAPI_Bool hasEverCooked
Definition: HAPI_Common.h:891
int eventType
(HAPI_PDG_WorkItemState) value of last state for state change
Definition: HAPI_Common.h:1637
HAPI_Bool haveMaterialsChanged
Definition: HAPI_Common.h:927
HAPI_NodeType inputNodeType
Definition: HAPI_Common.h:1202
HAPI_StringHandle typeNameSH
Definition: HAPI_Common.h:1257
HAPI_Bool isPeriodic
Whether the curves in this curve mesh are periodic.
Definition: HAPI_Common.h:1601
HAPI_RSTOrder
Definition: HAPI_Common.h:613
int parmFloatValueCount
Definition: HAPI_Common.h:1041
"intvector", "intvector3"
Definition: HAPI_Common.h:365
HAPI_CurveType
Definition: HAPI_Common.h:487
HAPI_PDG_State
Used with PDG functions.
Definition: HAPI_Common.h:753
HAPI_AttributeOwner owner
Definition: HAPI_Common.h:1420
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:817
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1340
int uniqueHoudiniNodeId
Definition: HAPI_Common.h:1025
Single Channel.
Definition: HAPI_Common.h:656
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1468
HAPI_ImageDataFormat
Definition: HAPI_Common.h:639
int handleCount
See HAPI_Handles.
Definition: HAPI_Common.h:901
HAPI_PartType
Definition: HAPI_Common.h:563
int currentState
id of related workitem dependency
Definition: HAPI_Common.h:1635
HAPI_EnvIntType
Definition: HAPI_Common.h:675
HAPI_Bool isRational
Whether the curves in this curve mesh are rational.
Definition: HAPI_Common.h:1603
HAPI_Bool isValid
Definition: HAPI_Common.h:1017
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:829
HAPI_PackedPrimInstancingMode
Definition: HAPI_Common.h:257
HAPI_StringHandle labelSH
The label string for the parameter.
Definition: HAPI_Common.h:1142
Max cache memory limit in MB.
Definition: HAPI_Common.h:729
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:726
HAPI_Bool cookTemplatedGeos
Decide whether to recursively cook all templated geos or not.
Definition: HAPI_Common.h:969
HAPI_StringHandle helpSH
The help string for this parameter.
Definition: HAPI_Common.h:1155
HAPI_Bool autoClose
Close the server automatically when all clients disconnect from it.
Definition: HAPI_Common.h:851
HAPI_StringHandle templateNameSH
Definition: HAPI_Common.h:1152
HAPI_AttributeOwner
Definition: HAPI_Common.h:476
HAPI_StringHandle fullOpNameSH
Full asset name and namespace.
Definition: HAPI_Common.h:897
RGBA Reversed.
Definition: HAPI_Common.h:661
GLsizeiptr size
Definition: glcorearb.h:663
Only some objects failed.
Definition: HAPI_Common.h:246
HAPI_ErrorCode
Definition: HAPI_Common.h:223
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1478
HAPI_Bool createdPostAssetLoad
Definition: HAPI_Common.h:1062
HAPI_NodeType
Definition: HAPI_Common.h:421
HAPI_CurveType curveType
Definition: HAPI_Common.h:1596
int knotCount
The number of knots for all curves.
Definition: HAPI_Common.h:1599
HAPI_Bool hasUIMax
Definition: HAPI_Common.h:1162
HAPI_StringHandle handleParmNameSH
Definition: HAPI_Common.h:1271
int HAPI_StringHandle
Definition: HAPI_Common.h:129
HAPI_StatusVerbosity
Definition: HAPI_Common.h:174
HAPI_AttributeOwner originalOwner
Definition: HAPI_Common.h:1432
Equivalent to HAPI_STATUSVERBOSITY_0.
Definition: HAPI_Common.h:184
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:848
Total number of supported parameter types.
Definition: HAPI_Common.h:320
See HAPI_Attributes.
Definition: HAPI_Common.h:1416
HAPI_ChoiceListType
Definition: HAPI_Common.h:402
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1411
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1391
GA_API const UT_StringHolder scale
Everything cook successfully without errors.
Definition: HAPI_Common.h:244
HAPI_Bool spare
Definition: HAPI_Common.h:1185
Menu Only, Single Selection.
Definition: HAPI_Common.h:405
HAPI_XYZOrder rotationOrder
Definition: HAPI_Common.h:828
int curveCount
The number of curves contained in this curve mesh.
Definition: HAPI_Common.h:1597
HAPI_PrmScriptType
Definition: HAPI_Common.h:349
HAPI_Bool hasKnots
Whether the curve has knots.
Definition: HAPI_Common.h:1607
HAPI_XYZOrder
Definition: HAPI_Common.h:626
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1256
int HAPI_ParmId
Definition: HAPI_Common.h:138
int numResults
index of the workitem
Definition: HAPI_Common.h:1644
HAPI_ParmId parentId
Parameter id of the parent of this parameter.
Definition: HAPI_Common.h:1082
int HAPI_ErrorCodeBits
Definition: HAPI_Common.h:229
HAPI_AttributeTypeInfo typeInfo
Definition: HAPI_Common.h:1454
int order
Order of 1 is invalid. 0 means there is a varying order.
Definition: HAPI_Common.h:1605
int instancedPartCount
Definition: HAPI_Common.h:1397
int tagCount
Number of tags on this paramter.
Definition: HAPI_Common.h:1109
int transformInputCount
Definition: HAPI_Common.h:907
int outputCount
The number of outputs this specific node has.
Definition: HAPI_Common.h:1057
HAPI_Bool handleSpherePartTypes
Definition: HAPI_Common.h:992
int instanceStartOffset
First instance's HAPI_ParmInfo::instanceNum. Either 0 or 1.
Definition: HAPI_Common.h:1220
int childIndex
Child index within its immediate parent parameter.
Definition: HAPI_Common.h:1085
HAPI_NodeId id
Definition: HAPI_Common.h:1009
HAPI_ImagePacking
Definition: HAPI_Common.h:653
HAPI_Transform transform
Definition: HAPI_Common.h:1559
HAPI_PDG_EventType
Used with PDG functions.
Definition: HAPI_Common.h:764
HAPI_SessionType
Definition: HAPI_Common.h:231
HAPI_StorageType storage
Definition: HAPI_Common.h:1421
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:1215
int instanceLength
The number of parms in a multiparm instance.
Definition: HAPI_Common.h:1216
int lastState
(HAPI_PDG_WorkItemState) value of current state for state change
Definition: HAPI_Common.h:1636
HAPI_Permissions permissions
Definition: HAPI_Common.h:1106
HAPI_PDG_WorkitemState
Used with PDG functions.
Definition: HAPI_Common.h:791
HAPI_VolumeType
Definition: HAPI_Common.h:497
HAPI_ParmType type
The HAPI type of the parm.
Definition: HAPI_Common.h:1088
License Type. See HAPI_License.
Definition: HAPI_Common.h:713
HAPI_StringHandle descriptionSH
Definition: HAPI_Common.h:1479
HAPI_PDG_WorkitemId dependencyId
id of related workitem
Definition: HAPI_Common.h:1634
Field + Multiple Selection Menu.
Definition: HAPI_Common.h:408
HAPI_ImagePacking packing
Definition: HAPI_Common.h:1500
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:1189
HAPI_GeoType type
Definition: HAPI_Common.h:1334
HAPI_SessionId id
Definition: HAPI_Common.h:843
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:585
HAPI_Bool invisible
Definition: HAPI_Common.h:1176
HAPI_Bool joinNext
the next parm.
Definition: HAPI_Common.h:1187
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1472
HAPI_PartType type
Definition: HAPI_Common.h:1378
HAPI_StringHandle valueSH
Definition: HAPI_Common.h:1242
HAPI_Bool haveGeosChanged
Definition: HAPI_Common.h:1294
HAPI_StringHandle versionSH
User-defined asset version.
Definition: HAPI_Common.h:896
HAPI_StorageType
Definition: HAPI_Common.h:506
HAPI_STATIC_ASSERT(sizeof(HAPI_Int64)==8, unsupported_size_of_long)
HAPI_Bool hasMax
Definition: HAPI_Common.h:1160
HAPI_NodeId nodeId
Definition: HAPI_Common.h:878
HAPI_StringHandle defaultExtensionSH
Definition: HAPI_Common.h:1480
HAPI_StringHandle assetParmNameSH
Definition: HAPI_Common.h:1272
HAPI_Bool isDisplayGeo
Final Result (Display SOP).
Definition: HAPI_Common.h:1350
HAPI_Bool isTimeDependent
Indicates if this node will change over time.
Definition: HAPI_Common.h:1065
HAPI_Bool hasGeoChanged
For incremental updates.
Definition: HAPI_Common.h:1353
int vertexCount
The number of control vertices (CVs) for all curves.
Definition: HAPI_Common.h:1598
HAPI_StringHandle imageFileFormatNameSH
Definition: HAPI_Common.h:1492
HAPI_Bool hasMaterialChanged
Definition: HAPI_Common.h:1360
HAPI_NodeId parentId
Definition: HAPI_Common.h:1010
Min cache memory limit in MB.
Definition: HAPI_Common.h:727
HAPI_Bool isTemplated
Has the templated flag turned on which means "expose as read-only".
Definition: HAPI_Common.h:1347
Looks for Guide Geometry.
Definition: HAPI_Common.h:462
int totalCookCount
Total number of cooks of this node.
Definition: HAPI_Common.h:1020
HAPI_StringHandle filePathSH
Path to the .otl library file.
Definition: HAPI_Common.h:895
HAPI_Bool checkPartChanges
Definition: HAPI_Common.h:998
char HAPI_Bool
Definition: HAPI_Common.h:110
HAPI_Bool hasUIMin
Definition: HAPI_Common.h:1161
HAPI_StringHandle typeInfoSH
Definition: HAPI_Common.h:1099
HAPI_NodeType type
Definition: HAPI_Common.h:1012
HAPI_StatusType
Definition: HAPI_Common.h:165
int extraFlags
For internal use only. :)
Definition: HAPI_Common.h:1001
HAPI_PresetType
Definition: HAPI_Common.h:412
HAPI_StringHandle labelSH
Definition: HAPI_Common.h:1238
HAPI_Bool interleaved
ex: true = RGBRGBRGB, false = RRRGGGBBB
Definition: HAPI_Common.h:1499
int inputCount
The number of inputs this specific node has.
Definition: HAPI_Common.h:1054
HAPI_Int64 resultHash
result tag
Definition: HAPI_Common.h:1653
HAPI_ParmId parentParmId
Definition: HAPI_Common.h:1237
"int", "integer"
Definition: HAPI_Common.h:351
HAPI_Result
Definition: HAPI_Common.h:193
HAPI_InputType
Definition: HAPI_Common.h:576
RGB Reversed.
Definition: HAPI_Common.h:659
HAPI_Bool splitGeosByGroup
Definition: HAPI_Common.h:946
HAPI_State
Definition: HAPI_Common.h:242
HAPI_VolumeType type
Definition: HAPI_Common.h:1532
int objectCount
See HAPI_Objects.
Definition: HAPI_Common.h:900
HAPI_StringHandle helpTextSH
Asset help marked-up text.
Definition: HAPI_Common.h:898
int HAPI_PDG_WorkitemId
Use this with PDG functions.
Definition: HAPI_Common.h:145
HAPI_Bool splitPointsByVertexAttributes
Definition: HAPI_Common.h:983
HAPI_StorageType storage
Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT.
Definition: HAPI_Common.h:1551
int HAPI_NodeFlagsBits
Definition: HAPI_Common.h:465
Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:188
HAPI_AttributeTypeInfo
Definition: HAPI_Common.h:518
HAPI_Bool haveObjectsChanged
Definition: HAPI_Common.h:923
#define HAPI_EULER_VECTOR_SIZE
Definition: HAPI_Common.h:21
HAPI_Bool hasTaper
Definition: HAPI_Common.h:1563
HAPI_GroupType
Definition: HAPI_Common.h:467
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1530
#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:1300
Field + Single Selection Menu.
Definition: HAPI_Common.h:407
int HAPI_NodeId
See HAPI_Nodes_Basics.
Definition: HAPI_Common.h:134
HAPI_PartId id
Definition: HAPI_Common.h:1376
HAPI_CacheProperty
[HAPI_CacheProperty]
Definition: HAPI_Common.h:720
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1309
You should abort the cook.
Definition: HAPI_Common.h:245
int primitiveGroupCount
Definition: HAPI_Common.h:1365
HAPI_PrmScriptType scriptType
The Houdini script-type of the parm.
Definition: HAPI_Common.h:1091
HAPI_StringHandle nameSH
Instance name (the label + a number).
Definition: HAPI_Common.h:893
HAPI_StringHandle nameSH
number of results reported
Definition: HAPI_Common.h:1645
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:595
HAPI_Bool hasTransformChanged
Definition: HAPI_Common.h:1290
HAPI_StringHandle objectInstancePathSH
(deprecated)
Definition: HAPI_Common.h:1286
HAPI_Bool hasMin
Definition: HAPI_Common.h:1159
HAPI_StringHandle internalNodePathSH
Definition: HAPI_Common.h:1030
HAPI_Bool disabled
Whether this parm should appear enabled or disabled.
Definition: HAPI_Common.h:1179
HAPI_Bool handleBoxPartTypes
Definition: HAPI_Common.h:991
HAPI_SessionType type
Definition: HAPI_Common.h:839
HAPI_NodeFlags inputNodeFlag
Definition: HAPI_Common.h:1209
int HAPI_PartId
Definition: HAPI_Common.h:142
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1321
int maxVerticesPerPrimitive
Definition: HAPI_Common.h:950
HAPI_Bool isChildOfMultiParm
Definition: HAPI_Common.h:1213
MatType rotation(const Quat< typename MatType::value_type > &q, typename MatType::value_type eps=static_cast< typename MatType::value_type >(1.0e-8))
Return the rotation matrix specified by the given quaternion.
Definition: Mat.h:204