HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends 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 /////////////////////////////////////////////////////////////////////////////
145 // Enums
146 
148 {
156 };
158 
160 {
165 };
167 
169 {
173 
175  ///< Equivalent to ::HAPI_STATUSVERBOSITY_2.
176 
177  // Used for Results.
179  ///< Equivalent to ::HAPI_STATUSVERBOSITY_0.
181  ///< Equivalent to ::HAPI_STATUSVERBOSITY_1.
183  ///< Equivalent to ::HAPI_STATUSVERBOSITY_2.
184 };
186 
188 {
200 
207 
210 
212 
214 };
216 
218 {
221 };
223 typedef int HAPI_ErrorCodeBits;
224 
226 {
233 };
235 
237 {
238  HAPI_STATE_READY, ///< Everything cook successfully without errors.
239  HAPI_STATE_READY_WITH_FATAL_ERRORS, ///< You should abort the cook.
240  HAPI_STATE_READY_WITH_COOK_ERRORS, ///< Only some objects failed.
246 
248 };
250 
252 {
258 };
260 
262 {
268 };
270 
272 {
277 };
279 
280 /// As you can see, some of these high level types share the same underlying
281 /// raw data type. For instance, both string and file parameter types can be
282 /// represented with strings, yet semantically they are different. We will
283 /// group high level parameter types that share an underlying raw data type
284 /// together, so you can always check the raw data type of a parameter based
285 /// on its high level data type by checking a range of values.
287 {
292 
295 
300 
302 
305 
309 
310  // Helpers
311 
312  HAPI_PARMTYPE_MAX, ///< Total number of supported parameter types.
313 
316 
319 
322 
325 
328 
331 
334 };
336 
337 
339 {
340  HAPI_PRM_SCRIPT_TYPE_INT = 0, // "int", "integer"
348  HAPI_PRM_SCRIPT_TYPE_TOGGLE, // "toggle", "embed"
351  HAPI_PRM_SCRIPT_TYPE_VECTOR3, // "vector", "vector3"
354  HAPI_PRM_SCRIPT_TYPE_INTVECTOR3, // "intvector", "intvector3"
358  HAPI_PRM_SCRIPT_TYPE_DIR, // "dir", "direction"
359  HAPI_PRM_SCRIPT_TYPE_COLOR, // "color", "rgb"
360  HAPI_PRM_SCRIPT_TYPE_COLOR4, // "color4", "rgba"
382 
383  // The following apply to HAPI_PARMTYPE_FOLDER parms
388 };
390 
392 {
393  HAPI_CHOICELISTTYPE_NONE, ///< Parameter is not a menu.
394  HAPI_CHOICELISTTYPE_NORMAL, ///< Menu Only, Single Selection
395  HAPI_CHOICELISTTYPE_MINI, ///< Mini Menu Only, Single Selection
396  HAPI_CHOICELISTTYPE_REPLACE, ///< Field + Single Selection Menu
397  HAPI_CHOICELISTTYPE_TOGGLE ///< Field + Multiple Selection Menu
398 };
400 
402 {
404  HAPI_PRESETTYPE_BINARY = 0, ///< Just the presets binary blob.
405  HAPI_PRESETTYPE_IDX, ///< Presets blob within an .idx file format.
407 };
409 
411 {
423 };
425 typedef int HAPI_NodeTypeBits;
426 
427 /// Flags used to filter compositions of node lists. Flags marked
428 /// 'Recursive Flag' will exclude children whos parent does not
429 /// satisfy the flag, even if the children themselves satisfy the flag.
431 {
434  HAPI_NODEFLAGS_DISPLAY = 1 << 0, ///< Recursive Flag
435  HAPI_NODEFLAGS_RENDER = 1 << 1, ///< Recursive Flag
441 
442  /// OBJ Node Specific Flags
447 
448  /// SOP Node Specific Flags
449  HAPI_NODEFLAGS_SOP_CURVE = 1 << 11 ///< Looks for "curve".
450 };
452 typedef int HAPI_NodeFlagsBits;
453 
455 {
460 };
462 
464 {
471 };
473 
475 {
481 };
483 
485 {
490 };
492 
494 {
502 };
504 
506 {
508  HAPI_ATTRIBUTE_TYPE_NONE, // Implicit type based on data
510  HAPI_ATTRIBUTE_TYPE_HPOINT, // Homogeneous position
511  HAPI_ATTRIBUTE_TYPE_VECTOR, // Direction vector
517  HAPI_ATTRIBUTE_TYPE_ST, // Parametric interval
518  HAPI_ATTRIBUTE_TYPE_HIDDEN, // "Private" (hidden)
519  HAPI_ATTRIBUTE_TYPE_BOX2, // 2x2 Bounding box
520  HAPI_ATTRIBUTE_TYPE_BOX, // 3x3 Bounding box
521  HAPI_ATTRIBUTE_TYPE_TEXTURE, // Texture coordinate
523 };
525 
527 {
529 
530  /// Most geos will be of this type which essentially means a geo
531  /// not of the other types.
533 
534  /// An exposed edit node.
535  /// See @ref HAPI_IntermediateAssetsResults.
537 
538  /// An input geo that can accept geometry from the host.
539  /// See @ref HAPI_AssetInputs_MarshallingGeometryIntoHoudini.
541 
542  /// A curve.
543  /// See @ref HAPI_Curves.
545 
547 };
549 
551 {
560 };
562 
564 {
569 };
571 
573 {
579 };
581 
583 {
597 };
599 
601 {
602  HAPI_TRS = 0,
608 
610 };
612 
614 {
615  HAPI_XYZ = 0,
621 
623 };
625 
627 {
635 
637 };
639 
641 {
643  HAPI_IMAGE_PACKING_SINGLE, ///< Single Channel
644  HAPI_IMAGE_PACKING_DUAL, ///< Dual Channel
646  HAPI_IMAGE_PACKING_BGR, ///< RGB Reversed
648  HAPI_IMAGE_PACKING_ABGR, ///< RGBA Reversed
650 
653 };
655 
656 /// This enum is to be used with ::HAPI_GetEnvInt() to retrieve basic
657 /// information about the HAPI implementation currently being linked
658 /// against. Note that as of HAPI version 2.0, these enum values are
659 /// guaranteed never to change so you can reliably get this information from
660 /// any post-2.0 version of HAPI. The same goes for the actual
661 /// ::HAPI_GetEnvInt() API call.
663 {
665 
666  /// The three components of the Houdini version that HAPI is
667  /// expecting to link against.
668  /// @{
673  /// @}
674 
675  /// The two components of the Houdini Engine (marketed) version.
676  /// @{
679  /// @}
680 
681  /// This is a monotonously increasing API version number that can be used
682  /// to lock against a certain API for compatibility purposes. Basically,
683  /// when this number changes code compiled against the HAPI.h methods
684  /// might no longer compile. Semantic changes to the methods will also
685  /// cause this version to increase. This number will be reset to 0
686  /// every time the Houdini Engine version is bumped.
688 
690 };
692 
693 /// This enum is to be used with ::HAPI_GetSessionEnvInt() to retrieve basic
694 /// session-specific information.
696 {
698 
699  /// License Type. See ::HAPI_License.
701 
703 };
705 
706 /// [HAPI_CacheProperty]
708 {
709  /// Current memory usage in MB. Setting this to 0 invokes
710  /// a cache clear.
712 
713  HAPI_CACHEPROP_HAS_MIN, ///< True if it actually has a minimum size.
714  HAPI_CACHEPROP_MIN, ///< Min cache memory limit in MB.
715  HAPI_CACHEPROP_HAS_MAX, ///< True if it actually has a maximum size.
716  HAPI_CACHEPROP_MAX, ///< Max cache memory limit in MB.
717 
718  /// How aggressive to cull memory. This only works for:
719  /// - ::HAPI_CACHE_COP_COOK where:
720  /// 0 -> Never reduce inactive cache.
721  /// 1 -> Always reduce inactive cache.
722  /// - ::HAPI_CACHE_OBJ where:
723  /// 0 -> Never enforce the max memory limit.
724  /// 1 -> Always enforce the max memory limit.
725  /// - ::HAPI_CACHE_SOP where:
726  /// 0 -> When to Unload = Never
727  /// When to Limit Max Memory = Never
728  /// 1-2 -> When to Unload = Based on Flag
729  /// When to Limit Max Memory = Never
730  /// 3-4 -> When to Unload = Based on Flag
731  /// When to Limit Max Memory = Always
732  /// 5 -> When to Unload = Always
733  /// When to Limit Max Memory = Always
735 };
736 /// [HAPI_CacheProperty]
738 
739 /////////////////////////////////////////////////////////////////////////////
740 // Main API Structs
741 
742 // GENERICS -----------------------------------------------------------------
743 
745 {
746  float position[ HAPI_POSITION_VECTOR_SIZE ];
747  float rotationQuaternion[ HAPI_QUATERNION_VECTOR_SIZE ];
750 
752 };
754 
756 {
757  float position[ HAPI_POSITION_VECTOR_SIZE ];
758  float rotationEuler[ HAPI_EULER_VECTOR_SIZE ];
761 
764 };
766 
767 // SESSIONS -----------------------------------------------------------------
768 
770 {
771  /// The type of session determines the which implementation will be
772  /// used to communicate with the Houdini Engine library.
774 
775  /// Some session types support multiple simultaneous sessions. This means
776  /// that each session needs to have a unique identifier.
777  HAPI_SessionId id;
778 };
780 
781 /// Options to configure a Thrift server being started from HARC.
783 {
784  /// Close the server automatically when all clients disconnect from it.
786 
787  /// Timeout in milliseconds for waiting on the server to
788  /// signal that it's ready to serve. If the server fails
789  /// to signal within this time interval, the start server call fails
790  /// and the server process is terminated.
791  float timeoutMs;
792 };
794 
795 // TIME ---------------------------------------------------------------------
796 
798 {
799  float fps;
800 
801  float startTime;
802  float endTime;
803 };
805 
806 // ASSETS -------------------------------------------------------------------
807 
809 {
810  /// Use the node id to get the asset's parameters.
811  /// See @ref HAPI_Nodes_Basics.
812  HAPI_NodeId nodeId;
813 
814  /// The objectNodeId differs from the regular nodeId in that for
815  /// geometry based assets (SOPs) it will be the node id of the dummy
816  /// object (OBJ) node instead of the asset node. For object based assets
817  /// the objectNodeId will equal the nodeId. The reason the distinction
818  /// exists is because transforms are always stored on the object node
819  /// but the asset parameters may not be on the asset node if the asset
820  /// is a geometry asset so we need both.
821  HAPI_NodeId objectNodeId;
822 
823  /// It's possible to instantiate an asset without cooking it.
824  /// See @ref HAPI_Assets_Cooking.
826 
827  HAPI_StringHandle nameSH; ///< Instance name (the label + a number).
828  HAPI_StringHandle labelSH; ///< This is what any end user should be shown.
829  HAPI_StringHandle filePathSH; ///< Path to the .otl library file.
830  HAPI_StringHandle versionSH; ///< User-defined asset version.
831  HAPI_StringHandle fullOpNameSH; ///< Full asset name and namespace.
832  HAPI_StringHandle helpTextSH; ///< Asset help marked-up text.
833 
834  int objectCount; ///< See @ref HAPI_Objects.
835  int handleCount; ///< See @ref HAPI_Handles.
836 
837  /// Transform inputs exposed by the asset. For OBJ assets this is the
838  /// number of transform inputs on the OBJ node. For SOP assets, this is
839  /// the singular transform input on the dummy wrapper OBJ node.
840  /// See @ref HAPI_AssetInputs.
842 
843  /// Geometry inputs exposed by the asset. For SOP assets this is
844  /// the number of geometry inputs on the SOP node itself. OBJ assets
845  /// will always have zero geometry inputs.
846  /// See @ref HAPI_AssetInputs.
848 
849  /// Geometry outputs exposed by the asset. For SOP assets this is
850  /// the number of geometry outputs on the SOP node itself. OBJ assets
851  /// will always have zero geometry outputs.
852  /// See @ref HAPI_AssetInputs.
854 
855  /// For incremental updates. Indicates whether any of the assets's
856  /// objects have changed. Refreshed only during an asset cook.
858 
859  /// For incremental updates. Indicates whether any of the asset's
860  /// materials have changed. Refreshed only during an asset cook.
862 };
864 
866 {
867  /// Normally, geos are split into parts in two different ways. First it
868  /// is split by group and within each group it is split by primitive type.
869  ///
870  /// For example, if you have a geo with group1 covering half of the mesh
871  /// and volume1 and group2 covering the other half of the mesh, all of
872  /// curve1, and volume2 you will end up with 5 parts. First two parts
873  /// will be for the half-mesh of group1 and volume1, and the last three
874  /// will cover group2.
875  ///
876  /// This toggle lets you disable the splitting by group and just have
877  /// the geo be split by primitive type alone. By default, this is true
878  /// and therefore geos will be split by group and primitive type. If
879  /// set to false, geos will only be split by primitive type.
881 
882  /// For meshes only, this is enforced by convexing the mesh. Use -1
883  /// to avoid convexing at all and get some performance boost.
885 
886  /// For curves only.
887  /// If this is set to true, then all curves will be refined to a linear
888  /// curve and you can no longer access the original CVs. You can control
889  /// the refinement detail via ::HAPI_CookOptions::curveRefineLOD.
890  /// If it's false, the curve type (NURBS, Bezier etc) will be left as is.
892 
893  /// Controls the number of divisions per unit distance when refining
894  /// a curve to linear. The default in Houdini is 8.0.
896 
897  /// If this option is turned on, then we will recursively clear the
898  /// errors and warnings (and messages) of all nodes before performing
899  /// the cook.
901 
902  /// Decide whether to recursively cook all templated geos or not.
904 
905  /// Decide whether to split points by vertex attributes. This takes
906  /// all vertex attributes and tries to copy them to their respective
907  /// points. If two vertices have any difference in their attribute values,
908  /// the corresponding point is split into two points. This is repeated
909  /// until all the vertex attributes have been copied to the points.
910  ///
911  /// With this option enabled, you can reduce the total number of vertices
912  /// on a game engine side as sharing of attributes (like UVs) is optimized.
913  /// To make full use of this feature, you have to think of Houdini points
914  /// as game engine vertices (sharable). With this option OFF (or before
915  /// this feature existed) you had to map Houdini vertices to game engine
916  /// vertices, to make sure all attribute values are accounted for.
918 
919  /// Choose how you want the cook to handle packed primitives.
920  /// The default is: ::HAPI_PACKEDPRIM_INSTANCING_MODE_DISABLED
922 
923  /// Choose which special part types should be handled. Unhandled special
924  /// part types will just be refined to ::HAPI_PARTTYPE_MESH.
927 
928  /// If enabled, sets the ::HAPI_PartInfo::hasChanged member during the
929  /// cook. If disabled, the member will always be true. Checking for
930  /// part changes can be expensive, so there is a potential performance
931  /// gain when disabled.
933 
934  /// For internal use only. :)
936 };
938 
939 // NODES --------------------------------------------------------------------
940 
942 {
943  HAPI_NodeId id;
944  HAPI_NodeId parentId;
945  HAPI_StringHandle nameSH;
947 
948  /// Always true unless the asset's definition has changed due to loading
949  /// a duplicate asset definition and from another OTL asset library
950  /// file OR deleting the OTL asset library file used by this node's asset.
952 
953  /// Total number of cooks of this node.
955 
956  /// Use this unique id to grab the OP_Node pointer for this node.
957  /// If you're linking against the C++ HDK, include the OP_Node.h header
958  /// and call OP_Node::lookupNode().
960 
961  /// This is the internal node path in the Houdini scene graph. This path
962  /// is meant to be abstracted away for most client purposes but for
963  /// advanced uses it can come in handy.
964  HAPI_StringHandle internalNodePathSH;
965 
966  /// Total number of parameters this asset has exposed. Includes hidden
967  /// parameters.
968  /// See @ref HAPI_Parameters.
970 
971  /// Number of values. A single parameter may have more than one value so
972  /// this number is more than or equal to ::HAPI_NodeInfo::parmCount.
973  /// @{
977  /// @}
978 
979  /// The total number of choices among all the combo box parameters.
980  /// See @ref HAPI_Parameters_ChoiceLists.
982 
983  /// The number of child nodes. This is 0 for all nodes that are not
984  /// node networks.
986 
987  /// The number of inputs this specific node has.
989 
990  /// The number of outputs this specific node has.
992 
993  /// Nodes created via scripts or via ::HAPI_CreateNode() will be have
994  /// this set to true. Only such nodes can be deleted using
995  /// ::HAPI_DeleteNode().
997 
998  /// Indicates if this node will change over time
1000 };
1002 
1003 // PARAMETERS ---------------------------------------------------------------
1004 
1005 /// @struct HAPI_ParmInfo
1006 ///
1007 /// Contains parameter information like name, label, type, and size.
1008 ///
1010 {
1011  /// The parent id points to the id of the parent parm
1012  /// of this parm. The parent parm is something like a folder.
1013  HAPI_ParmId id;
1014 
1015  /// Parameter id of the parent of this parameter.
1016  HAPI_ParmId parentId;
1017 
1018  /// Child index within its immediate parent parameter.
1020 
1021  /// The HAPI parm type
1023 
1024  /// The script-type
1026 
1027  /// Some parameter types require additional type information.
1028  /// - File path parameters will indicate what file extensions they
1029  /// expect in a space-separated list of wild-cards. This is set
1030  /// in the Operator Type Properties using the File Pattern
1031  /// parameter property.
1032  /// For example, for filtering by PNG and JPG only: "*.png *.jpg"
1033  HAPI_StringHandle typeInfoSH;
1034 
1035  /// For the majority of parameter types permission will not be applicable.
1036  /// For file path parameters these permissions will indicate how the
1037  /// asset plans to use the file: whether it will only read it, only write
1038  /// to it, or both. This is set in the Operator Type Properties using
1039  /// the Browse Mode parameter property.
1041 
1042  /// Number of tags on this paramter.
1044 
1045  /// Tuple size. For scalar parameters this value is 1, but for vector
1046  /// parameters this value can be greater. For example, a 3 vector would
1047  /// have a size of 3. For folders and folder lists, this value is the
1048  /// number of children they own.
1049  int size;
1050 
1051  /// Any ::HAPI_ParmType can be a choice list. If this is set to
1052  /// ::HAPI_CHOICELISTTYPE_NONE, than this parameter is NOT a choice list.
1053  /// Otherwise, the parameter is a choice list of the indicated type.
1054  /// See @ref HAPI_Parameters_ChoiceLists.
1056 
1057  /// Any ::HAPI_ParmType can be a choice list. If the parameter is a
1058  /// choice list, this tells you how many choices it currently has.
1059  /// Note that some menu parameters can have a dynamic number of choices
1060  /// so it is important that this count is re-checked after every cook.
1061  /// See @ref HAPI_Parameters_ChoiceLists.
1063 
1064  /// Note that folders are not real parameters in Houdini so they do not
1065  /// have names. The folder names given here are generated from the name
1066  /// of the folderlist (or switcher) parameter which is a parameter. The
1067  /// folderlist parameter simply defines how many of the "next" parameters
1068  /// belong to the first folder, how many of the parameters after that
1069  /// belong to the next folder, and so on. This means that folder names
1070  /// can change just by reordering the folders around so don't rely on
1071  /// them too much. The only guarantee here is that the folder names will
1072  /// be unique among all other parameter names.
1073  HAPI_StringHandle nameSH;
1074 
1075  HAPI_StringHandle labelSH;
1076 
1077  /// If this parameter is a multiparm instance than the
1078  /// ::HAPI_ParmInfo::templateNameSH will be the hash-templated parm name,
1079  /// containing #'s for the parts of the name that use the instance number.
1080  /// Compared to the ::HAPI_ParmInfo::nameSH, the ::HAPI_ParmInfo::nameSH
1081  /// will be the ::HAPI_ParmInfo::templateNameSH but with the #'s
1082  /// replaced by the instance number. For regular parms, the
1083  /// ::HAPI_ParmInfo::templateNameSH is identical to the
1084  /// ::HAPI_ParmInfo::nameSH.
1085  HAPI_StringHandle templateNameSH;
1086 
1087  /// The help string for this parameter
1088  HAPI_StringHandle helpSH;
1089 
1090  /// Whether min/max exists for the parameter values.
1091  /// @{
1096  /// @}
1097 
1098  /// Parameter value range, shared between int and float parameters.
1099  /// @{
1100  float min;
1101  float max;
1102  float UIMin;
1103  float UIMax;
1104  /// @}
1105 
1106  /// Whether this parm should be hidden from the user entirely. This is
1107  /// mostly used to expose parameters as asset meta-data but not allow the
1108  /// user to directly modify them.
1110 
1111  /// Whether this parm should appear enabled or disabled.
1113 
1114  /// If true, it means this parameter doesn't actually exist on the node
1115  /// in Houdini but was added by Houdini Engine as a spare parameter.
1116  /// This is just for your information. The behaviour of this parameter
1117  /// is not any different than a non-spare parameter.
1119 
1120  HAPI_Bool joinNext; ///< Whether this parm should be on the same line as
1121  ///< the next parm.
1122  HAPI_Bool labelNone; ///< Whether the label should be displayed.
1123 
1124  /// The index to use to look into the values array in order to retrieve
1125  /// the actual value(s) of this parameter.
1126  /// @{
1131  /// @}
1132 
1133  /// If this is a ::HAPI_PARMTYPE_NODE, this tells you what node types
1134  /// this parameter accepts.
1136 
1137  /// The node input parameter could have another subtype filter specified,
1138  /// like "Object: Geometry Only". In this case, this value will specify
1139  /// that extra filter. If the filter demands a node that HAPI does not
1140  /// support, both this and ::HAPI_ParmInfo::inputNodeType will be set to
1141  /// NONE as such a node is not settable through HAPI.
1143 
1144  /// See @ref HAPI_Parameters_MultiParms.
1145  /// @{
1147 
1148  int instanceNum; ///< The index of the instance in the multiparm.
1149  int instanceLength; ///< The number of parms in a multiparm instance.
1150  int instanceCount; ///< The number of instances in a multiparm.
1151 
1152  /// First instance's ::HAPI_ParmInfo::instanceNum. Either 0 or 1.
1154 
1156  /// @}
1157 
1158  /// Provides the raw condition string which is used to evaluate the
1159  /// the visibility of a parm
1160  HAPI_StringHandle visibilityConditionSH;
1161 
1162  /// Provides the raw condition string which is used to evalute whether
1163  /// a parm is enabled or disabled
1164  HAPI_StringHandle disabledConditionSH;
1165 };
1167 
1169 {
1170  HAPI_ParmId parentParmId;
1171  HAPI_StringHandle labelSH;
1172 
1173  /// This evaluates to the value of the token associated with the label
1174  /// applies to string menus only.
1175  HAPI_StringHandle valueSH;
1176 };
1178 
1179 // HANDLES ------------------------------------------------------------------
1180 
1181 /// @struct HAPI_HandleInfo
1182 ///
1183 /// Contains handle information such as the type of handle
1184 /// (translate, rotate, scale, softxform ...etc) and the number of
1185 /// parameters the current handle is bound to.
1186 ///
1188 {
1189  HAPI_StringHandle nameSH;
1190  HAPI_StringHandle typeNameSH;
1191 
1193 };
1195 
1196 /// @struct HAPI_HandleBindingInfo
1197 ///
1198 /// Contains binding information that maps the handle parameter to
1199 /// the asset parameter
1200 ///
1202 {
1203  HAPI_StringHandle handleParmNameSH;
1204  HAPI_StringHandle assetParmNameSH;
1205 
1206  HAPI_ParmId assetParmId;
1207 };
1209 
1210 // OBJECTS ------------------------------------------------------------------
1211 
1213 {
1214  HAPI_StringHandle nameSH;
1215  HAPI_StringHandle objectInstancePathSH;
1216 
1217  /// For incremental updates. Indicates whether the object's transform
1218  /// has changed. Refreshed only during an asset cook.
1220 
1221  /// For incremental updates. Indicates whether any of the object's
1222  /// geometry nodes have changed. Refreshed only during an asset cook.
1224 
1225  /// Whether the object is hidden and should not be shown. Some objects
1226  /// should be hidden but still brought into the host environment, for
1227  /// example those used only for instancing.
1228  /// See @ref HAPI_Instancing.
1230 
1231  /// See @ref HAPI_Instancing.
1233 
1234  /// Determine if this object is being instanced. Normally, this implies
1235  /// that while this object may not be visible, it should still be
1236  /// brought into the host application because it is needed by an instancer.
1237  /// See @ref HAPI_Instancing.
1239 
1240  /// (deprecated) The number of geometries under this object. For those familiar
1241  /// with Houdini, this number will always include the one visible SOP and any
1242  /// SOPs that were exposed as "editable" or "templated".
1243  /// See @ref HAPI_Geos.
1245 
1246  /// Use the node id to get the node's parameters.
1247  /// Using the HDK, you can also get the raw node C++ pointer for this
1248  /// object's internal node.
1249  /// See @ref HAPI_Nodes_Basics.
1250  HAPI_NodeId nodeId;
1251 
1252  /// If the object is an instancer, this variable gives the object id of
1253  /// the object that should be instanced.
1254  /// See @ref HAPI_Instancing.
1255  HAPI_NodeId objectToInstanceId;
1256 };
1258 
1259 // GEOMETRY -----------------------------------------------------------------
1260 
1262 {
1264  HAPI_StringHandle nameSH;
1265 
1266  /// Use the node id to get the node's parameters.
1267  /// Using the HDK, you can also get the raw node C++ pointer for this
1268  /// object's internal node.
1269  HAPI_NodeId nodeId;
1270 
1271  /// Whether the SOP node has been exposed by dragging it into the
1272  /// editable nodes section of the asset definition.
1274 
1275  /// Has the templated flag turned on which means "expose as read-only".
1277 
1278  /// Final Result (Display SOP).
1280 
1281  /// For incremental updates.
1283 
1284  /// (deprecated) This variable is deprecated and should no longer be used.
1285  /// Materials are now separate from parts. They are maintained at the
1286  /// asset level so you only need to check if the material itself has
1287  /// changed via ::HAPI_MaterialInfo::hasChanged instead of the material
1288  /// on the part.
1290 
1291  /// Groups.
1292  /// @{
1295  /// @}
1296 
1297  /// Total number of parts this geometry contains.
1298  /// See @ref HAPI_Parts.
1300 };
1302 
1304 {
1305  HAPI_PartId id;
1306  HAPI_StringHandle nameSH;
1308 
1311  int pointCount; ///< Number of points. Note that this is NOT the number
1312  ///< of "positions" as "points" may imply. If your
1313  ///< geometry has 3 points then set this to 3 and not 3*3.
1314 
1315  int attributeCounts[ HAPI_ATTROWNER_MAX ];
1316 
1317  /// If this is true, don't display this part. Load its data but then
1318  /// instance it where the corresponding instancer part tells you to
1319  /// instance it.
1321 
1322  /// The number of parts that this instancer part is instancing.
1323  /// For example, if we're instancing a curve and a box, they would come
1324  /// across as two parts, hence this count would be two.
1325  /// Call ::HAPI_GetInstancedPartIds() to get the list of ::HAPI_PartId's.
1327 
1328  /// The number of instances that this instancer part is instancing.
1329  /// Using the same example as with ::HAPI_PartInfo::instancedPartCount,
1330  /// if I'm instancing the merge of a curve and a box 5 times, this count
1331  /// would be 5. To be clear, all instanced parts are instanced the same
1332  /// number of times and with the same transform for each instance.
1333  /// Call ::HAPI_GetInstancerPartTransforms() to get the transform of
1334  /// each instance.
1336 
1337  /// If this is false, the underlying attribute data appear to match that of
1338  /// the previous cook. In this case you may be able to re-used marshaled
1339  /// data from the previous cook.
1341 };
1343 
1344 /// See @ref HAPI_Attributes.
1346 {
1348 
1351 
1352  /// When converting from the Houdini native GA geometry format to the
1353  /// GT geometry format HAPI uses, some attributes might change owners.
1354  /// For example, in Houdini GA curves can have points shared by
1355  /// vertices but the GT format only supports curve vertices
1356  /// (no points). This means that if you had point attributes on a curve
1357  /// in Houdini, when it comes out of HAPI those point attributes will now
1358  /// be vertex attributes. In this case, the ::HAPI_AttributeInfo::owner
1359  /// will be set to ::HAPI_ATTROWNER_VERTEX but the
1360  /// ::HAPI_AttributeInfo::originalOwner will be ::HAPI_ATTROWNER_POINT.
1362 
1363  /// Number of attributes. This count will match the number of values
1364  /// given the owner. For example, if the owner is ::HAPI_ATTROWNER_VERTEX
1365  /// this count will be the same as the ::HAPI_PartInfo::vertexCount.
1366  /// To be clear, this is not the number of values in the attribute, rather
1367  /// it is the number of attributes. If your geometry has three 3D points
1368  /// then this count will be 3 (not 3*3) while the
1369  /// ::HAPI_AttributeInfo::tupleSize will be 3.
1370  int count;
1371 
1372  /// Number of values per attribute.
1373  /// Note that this is NOT the memory size of the attribute. It is the
1374  /// number of values per attributes. Multiplying this by the
1375  /// size of the ::HAPI_AttributeInfo::storage will give you the memory
1376  /// size per attribute.
1378 
1379  /// Attribute type info
1380  /// This is used to help identify the type of data stored in an attribute.
1381  /// Using the type is recommended over using just an attribute's name to identify
1382  /// its purpose.
1384 };
1386 
1387 // MATERIALS ----------------------------------------------------------------
1388 
1390 {
1391  /// This is the HAPI node id for the SHOP node this material is attached
1392  /// to. Use it to get access to the parameters (which contain the
1393  /// texture paths).
1394  /// IMPORTANT: When the ::HAPI_MaterialInfo::hasChanged is true this
1395  /// @p nodeId could have changed. Do not assume ::HAPI_MaterialInfo::nodeId
1396  /// will never change for a specific material.
1397  HAPI_NodeId nodeId;
1398 
1400 
1402 };
1404 
1406 {
1407  HAPI_StringHandle nameSH;
1408  HAPI_StringHandle descriptionSH;
1409  HAPI_StringHandle defaultExtensionSH;
1410 };
1412 
1414 {
1415  /// Unlike the other members of this struct changing imageFileFormatNameSH
1416  /// and giving this struct back to HAPI_SetImageInfo() nothing will happen.
1417  /// Use this member variable to derive which image file format will be used
1418  /// by the HAPI_ExtractImageTo...() functions if called with
1419  /// image_file_format_name set to NULL. This way, you can decide whether
1420  /// to ask for a file format conversion (slower) or not (faster).
1421  HAPI_StringHandle imageFileFormatNameSH; // Read-only
1422 
1423  int xRes;
1424  int yRes;
1425 
1427 
1428  HAPI_Bool interleaved; ///< ex: true = RGBRGBRGB, false = RRRGGGBBB
1430 
1431  /// Adjust the gamma of the image. For anything less than
1432  /// ::HAPI_IMAGE_DATA_INT16, you probably want to leave this as 2.2.
1433  double gamma;
1434 };
1436 
1437 // ANIMATION ----------------------------------------------------------------
1438 
1440 {
1441  float time;
1442  float value;
1443  float inTangent;
1444  float outTangent;
1445 };
1447 
1448 // VOLUMES ------------------------------------------------------------------
1449 
1450 /// @struct HAPI_VolumeInfo
1451 ///
1452 /// This represents a volume primitive but does not contain the actual voxel
1453 /// values, which can be retrieved on a per-tile basis.
1454 ///
1455 /// See @ref HAPI_Volumes.
1456 ///
1458 {
1459  HAPI_StringHandle nameSH;
1460 
1462 
1463  /// Each voxel is identified with an index. The indices will range
1464  /// between:
1465  /// [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )
1466  /// @{
1467  int xLength;
1468  int yLength;
1469  int zLength;
1470  int minX;
1471  int minY;
1472  int minZ;
1473  /// @}
1474 
1475  /// Number of values per voxel.
1476  /// The tuple size field is 1 for scalars and 3 for vector data.
1478 
1479  /// Can be either ::HAPI_STORAGETYPE_INT or ::HAPI_STORAGETYPE_FLOAT.
1481 
1482  /// The dimensions of each tile.
1483  /// This can be 8 or 16, denoting an 8x8x8 or 16x16x16 tiles.
1485 
1486  /// The transform of the volume with respect to the lengths.
1487  /// The volume may be positioned anywhere in space.
1489 
1490  /// Denotes special situations where the volume tiles are not perfect
1491  /// cubes, but are tapered instead.
1493 
1494  /// If there is taper involved, denotes the amount of taper involved.
1495  /// @{
1496  float xTaper;
1497  float yTaper;
1498  /// @}
1499 };
1501 
1502 /// @struct HAPI_VolumeTileInfo
1503 ///
1504 /// A HAPI_VolumeTileInfo represents an cube subarray of the volume.
1505 /// The size of each dimension is HAPI_VoluemInfo::tileSize
1506 /// bbox [(minX, minY, minZ), (minX+tileSize, minY+tileSize, minZ+tileSize))
1507 ///
1509 {
1510  int minX;
1511  int minY;
1512  int minZ;
1514 };
1516 
1517 // CURVES -------------------------------------------------------------------
1518 
1519 /// @struct HAPI_CurveInfo
1520 ///
1521 /// This represents the meta-data associated with a curve mesh (a number
1522 /// of curves of the same type).
1524 {
1526  int curveCount; ///< The number of curves contained in this curve mesh.
1527  int vertexCount; ///< The number of control vertices (CVs) for all curves.
1528  int knotCount; ///< The number of knots for all curves.
1529 
1531  ///< Whether the curves in this curve mesh are periodic.
1533  ///< Whether the curves in this curve mesh are rational.
1534  int order; ///< Order of 1 is invalid. 0 means there is a varying order.
1535 
1536  HAPI_Bool hasKnots; ///< Whether the curve has knots.
1537 };
1539 
1540 // BASIC PRIMITIVES ---------------------------------------------------------
1541 
1543 {
1544  float center[ HAPI_POSITION_VECTOR_SIZE ];
1547 };
1549 
1551 {
1552  float center[ HAPI_POSITION_VECTOR_SIZE ];
1553  float radius;
1554 };
1556 
1557 #endif // __HAPI_COMMON_h__
HAPI_License
Definition: HAPI_Common.h:147
HAPI_NodeId objectNodeId
Definition: HAPI_Common.h:821
#define HAPI_QUATERNION_VECTOR_SIZE
Definition: HAPI_Common.h:20
True if it actually has a maximum size.
Definition: HAPI_Common.h:715
HAPI_StringHandle disabledConditionSH
Definition: HAPI_Common.h:1164
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1264
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1073
SOP Node Specific Flags.
Definition: HAPI_Common.h:449
HAPI_StringHandle labelSH
This is what any end user should be shown.
Definition: HAPI_Common.h:828
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1306
HAPI_Bool isInstancer
See HAPI_Instancing.
Definition: HAPI_Common.h:1232
HAPI_ImageDataFormat dataFormat
Definition: HAPI_Common.h:1426
int parmStringValueCount
Definition: HAPI_Common.h:976
HAPI_Bool clearErrorsAndWarnings
Definition: HAPI_Common.h:900
Recursive Flag.
Definition: HAPI_Common.h:435
Recursive Flag.
Definition: HAPI_Common.h:434
HAPI_ChoiceListType choiceListType
Definition: HAPI_Common.h:1055
int HAPI_NodeTypeBits
Definition: HAPI_Common.h:425
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1214
HAPI_NodeId objectToInstanceId
Definition: HAPI_Common.h:1255
HAPI_Bool refineCurveToLinear
Definition: HAPI_Common.h:891
Equivalent to HAPI_STATUSVERBOSITY_1.
Definition: HAPI_Common.h:180
HAPI_ParmId id
Definition: HAPI_Common.h:1013
Just the presets binary blob.
Definition: HAPI_Common.h:404
HAPI_Bool isEditable
Definition: HAPI_Common.h:1273
#define HAPI_POSITION_VECTOR_SIZE
Definition: HAPI_Common.h:16
HAPI_RampType rampType
Definition: HAPI_Common.h:1155
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:683
HAPI_PackedPrimInstancingMode packedPrimInstancingMode
Definition: HAPI_Common.h:921
HAPI_SessionEnvIntType
Definition: HAPI_Common.h:695
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:945
#define HAPI_API
Definition: HAPI_API.h:79
OBJ Node Specific Flags.
Definition: HAPI_Common.h:443
HAPI_NodeFlags
Definition: HAPI_Common.h:430
HAPI_GeoType
Definition: HAPI_Common.h:526
int instanceCount
The number of instances in a multiparm.
Definition: HAPI_Common.h:1150
HAPI_StringHandle visibilityConditionSH
Definition: HAPI_Common.h:1160
HAPI_Bool hasEverCooked
Definition: HAPI_Common.h:825
HAPI_Bool haveMaterialsChanged
Definition: HAPI_Common.h:861
HAPI_NodeType inputNodeType
Definition: HAPI_Common.h:1135
HAPI_StringHandle typeNameSH
Definition: HAPI_Common.h:1190
HAPI_Bool isPeriodic
Whether the curves in this curve mesh are periodic.
Definition: HAPI_Common.h:1530
HAPI_RSTOrder
Definition: HAPI_Common.h:600
int parmFloatValueCount
Definition: HAPI_Common.h:975
HAPI_CurveType
Definition: HAPI_Common.h:474
HAPI_AttributeOwner owner
Definition: HAPI_Common.h:1349
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:751
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1269
int uniqueHoudiniNodeId
Definition: HAPI_Common.h:959
Single Channel.
Definition: HAPI_Common.h:643
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1397
HAPI_ImageDataFormat
Definition: HAPI_Common.h:626
int handleCount
See HAPI_Handles.
Definition: HAPI_Common.h:835
HAPI_PartType
Definition: HAPI_Common.h:550
HAPI_EnvIntType
Definition: HAPI_Common.h:662
HAPI_Bool isRational
Whether the curves in this curve mesh are rational.
Definition: HAPI_Common.h:1532
HAPI_Bool isValid
Definition: HAPI_Common.h:951
HAPI_RSTOrder rstOrder
Definition: HAPI_Common.h:763
HAPI_PackedPrimInstancingMode
Definition: HAPI_Common.h:251
HAPI_StringHandle labelSH
Definition: HAPI_Common.h:1075
Max cache memory limit in MB.
Definition: HAPI_Common.h:716
HAPI_Permissions
Definition: HAPI_Common.h:261
#define HAPI_SHEAR_VECTOR_SIZE
Definition: HAPI_Common.h:18
Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:174
True if it actually has a minimum size.
Definition: HAPI_Common.h:713
HAPI_Bool cookTemplatedGeos
Decide whether to recursively cook all templated geos or not.
Definition: HAPI_Common.h:903
HAPI_StringHandle helpSH
The help string for this parameter.
Definition: HAPI_Common.h:1088
HAPI_Bool autoClose
Close the server automatically when all clients disconnect from it.
Definition: HAPI_Common.h:785
HAPI_StringHandle templateNameSH
Definition: HAPI_Common.h:1085
HAPI_AttributeOwner
Definition: HAPI_Common.h:463
HAPI_StringHandle fullOpNameSH
Full asset name and namespace.
Definition: HAPI_Common.h:831
RGBA Reversed.
Definition: HAPI_Common.h:648
GLsizeiptr size
Definition: glcorearb.h:663
Only some objects failed.
Definition: HAPI_Common.h:240
HAPI_ErrorCode
Definition: HAPI_Common.h:217
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1407
HAPI_Bool createdPostAssetLoad
Definition: HAPI_Common.h:996
HAPI_NodeType
Definition: HAPI_Common.h:410
HAPI_CurveType curveType
Definition: HAPI_Common.h:1525
int knotCount
The number of knots for all curves.
Definition: HAPI_Common.h:1528
HAPI_Bool hasUIMax
Definition: HAPI_Common.h:1095
HAPI_StringHandle handleParmNameSH
Definition: HAPI_Common.h:1203
int HAPI_StringHandle
Definition: HAPI_Common.h:129
HAPI_StatusVerbosity
Definition: HAPI_Common.h:168
HAPI_AttributeOwner originalOwner
Definition: HAPI_Common.h:1361
Equivalent to HAPI_STATUSVERBOSITY_0.
Definition: HAPI_Common.h:178
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:782
Total number of supported parameter types.
Definition: HAPI_Common.h:312
See HAPI_Attributes.
Definition: HAPI_Common.h:1345
HAPI_ChoiceListType
Definition: HAPI_Common.h:391
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1340
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1320
GA_API const UT_StringHolder scale
Everything cook successfully without errors.
Definition: HAPI_Common.h:238
HAPI_Bool spare
Definition: HAPI_Common.h:1118
Menu Only, Single Selection.
Definition: HAPI_Common.h:394
HAPI_XYZOrder rotationOrder
Definition: HAPI_Common.h:762
int curveCount
The number of curves contained in this curve mesh.
Definition: HAPI_Common.h:1526
HAPI_PrmScriptType
Definition: HAPI_Common.h:338
HAPI_Bool hasKnots
Whether the curve has knots.
Definition: HAPI_Common.h:1536
HAPI_XYZOrder
Definition: HAPI_Common.h:613
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1189
int HAPI_ParmId
Definition: HAPI_Common.h:138
HAPI_ParmId parentId
Parameter id of the parent of this parameter.
Definition: HAPI_Common.h:1016
int HAPI_ErrorCodeBits
Definition: HAPI_Common.h:223
HAPI_AttributeTypeInfo typeInfo
Definition: HAPI_Common.h:1383
int order
Order of 1 is invalid. 0 means there is a varying order.
Definition: HAPI_Common.h:1534
int instancedPartCount
Definition: HAPI_Common.h:1326
int tagCount
Number of tags on this paramter.
Definition: HAPI_Common.h:1043
int transformInputCount
Definition: HAPI_Common.h:841
int outputCount
The number of outputs this specific node has.
Definition: HAPI_Common.h:991
HAPI_Bool handleSpherePartTypes
Definition: HAPI_Common.h:926
int instanceStartOffset
First instance's HAPI_ParmInfo::instanceNum. Either 0 or 1.
Definition: HAPI_Common.h:1153
int childIndex
Child index within its immediate parent parameter.
Definition: HAPI_Common.h:1019
HAPI_NodeId id
Definition: HAPI_Common.h:943
HAPI_ImagePacking
Definition: HAPI_Common.h:640
HAPI_Transform transform
Definition: HAPI_Common.h:1488
HAPI_SessionType
Definition: HAPI_Common.h:225
HAPI_StorageType storage
Definition: HAPI_Common.h:1350
Presets blob within an .idx file format.
Definition: HAPI_Common.h:405
int instanceNum
The index of the instance in the multiparm.
Definition: HAPI_Common.h:1148
int instanceLength
The number of parms in a multiparm instance.
Definition: HAPI_Common.h:1149
HAPI_Permissions permissions
Definition: HAPI_Common.h:1040
HAPI_VolumeType
Definition: HAPI_Common.h:484
HAPI_ParmType type
The HAPI parm type.
Definition: HAPI_Common.h:1022
License Type. See HAPI_License.
Definition: HAPI_Common.h:700
HAPI_StringHandle descriptionSH
Definition: HAPI_Common.h:1408
Field + Multiple Selection Menu.
Definition: HAPI_Common.h:397
HAPI_ImagePacking packing
Definition: HAPI_Common.h:1429
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:1122
HAPI_GeoType type
Definition: HAPI_Common.h:1263
HAPI_SessionId id
Definition: HAPI_Common.h:777
int HAPI_ProcessId
Definition: HAPI_Common.h:121
HAPI_RampType
Definition: HAPI_Common.h:271
HAPI_ParmType
Definition: HAPI_Common.h:286
HAPI_CurveOrders
Definition: HAPI_Common.h:572
HAPI_Bool invisible
Definition: HAPI_Common.h:1109
HAPI_Bool joinNext
the next parm.
Definition: HAPI_Common.h:1120
HAPI_Bool hasChanged
Definition: HAPI_Common.h:1401
int parmIntValueCount
Definition: HAPI_Common.h:974
HAPI_PartType type
Definition: HAPI_Common.h:1307
HAPI_StringHandle valueSH
Definition: HAPI_Common.h:1175
HAPI_Bool haveGeosChanged
Definition: HAPI_Common.h:1223
HAPI_StringHandle versionSH
User-defined asset version.
Definition: HAPI_Common.h:830
HAPI_StorageType
Definition: HAPI_Common.h:493
HAPI_STATIC_ASSERT(sizeof(HAPI_Int64)==8, unsupported_size_of_long)
HAPI_Bool hasMax
Definition: HAPI_Common.h:1093
HAPI_NodeId nodeId
Definition: HAPI_Common.h:812
HAPI_StringHandle defaultExtensionSH
Definition: HAPI_Common.h:1409
HAPI_StringHandle assetParmNameSH
Definition: HAPI_Common.h:1204
HAPI_Bool isDisplayGeo
Final Result (Display SOP).
Definition: HAPI_Common.h:1279
HAPI_Bool isTimeDependent
Indicates if this node will change over time.
Definition: HAPI_Common.h:999
HAPI_Bool hasGeoChanged
For incremental updates.
Definition: HAPI_Common.h:1282
int vertexCount
The number of control vertices (CVs) for all curves.
Definition: HAPI_Common.h:1527
HAPI_StringHandle imageFileFormatNameSH
Definition: HAPI_Common.h:1421
HAPI_Bool hasMaterialChanged
Definition: HAPI_Common.h:1289
HAPI_NodeId parentId
Definition: HAPI_Common.h:944
Min cache memory limit in MB.
Definition: HAPI_Common.h:714
HAPI_Bool isTemplated
Has the templated flag turned on which means "expose as read-only".
Definition: HAPI_Common.h:1276
int totalCookCount
Total number of cooks of this node.
Definition: HAPI_Common.h:954
HAPI_StringHandle filePathSH
Path to the .otl library file.
Definition: HAPI_Common.h:829
HAPI_Bool checkPartChanges
Definition: HAPI_Common.h:932
char HAPI_Bool
Definition: HAPI_Common.h:110
HAPI_Bool hasUIMin
Definition: HAPI_Common.h:1094
HAPI_StringHandle typeInfoSH
Definition: HAPI_Common.h:1033
HAPI_NodeType type
Definition: HAPI_Common.h:946
HAPI_StatusType
Definition: HAPI_Common.h:159
int extraFlags
For internal use only. :)
Definition: HAPI_Common.h:935
HAPI_PresetType
Definition: HAPI_Common.h:401
HAPI_StringHandle labelSH
Definition: HAPI_Common.h:1171
HAPI_Bool interleaved
ex: true = RGBRGBRGB, false = RRRGGGBBB
Definition: HAPI_Common.h:1428
int inputCount
The number of inputs this specific node has.
Definition: HAPI_Common.h:988
HAPI_ParmId parentParmId
Definition: HAPI_Common.h:1170
HAPI_Result
Definition: HAPI_Common.h:187
HAPI_InputType
Definition: HAPI_Common.h:563
RGB Reversed.
Definition: HAPI_Common.h:646
HAPI_Bool splitGeosByGroup
Definition: HAPI_Common.h:880
HAPI_State
Definition: HAPI_Common.h:236
HAPI_VolumeType type
Definition: HAPI_Common.h:1461
int objectCount
See HAPI_Objects.
Definition: HAPI_Common.h:834
HAPI_StringHandle helpTextSH
Asset help marked-up text.
Definition: HAPI_Common.h:832
HAPI_Bool splitPointsByVertexAttributes
Definition: HAPI_Common.h:917
HAPI_StorageType storage
Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT.
Definition: HAPI_Common.h:1480
int HAPI_NodeFlagsBits
Definition: HAPI_Common.h:452
Equivalent to HAPI_STATUSVERBOSITY_2.
Definition: HAPI_Common.h:182
HAPI_AttributeTypeInfo
Definition: HAPI_Common.h:505
HAPI_Bool haveObjectsChanged
Definition: HAPI_Common.h:857
[HAPI_CacheProperty]
Definition: HAPI_Common.h:744
#define HAPI_EULER_VECTOR_SIZE
Definition: HAPI_Common.h:21
HAPI_Bool hasTaper
Definition: HAPI_Common.h:1492
HAPI_GroupType
Definition: HAPI_Common.h:454
HAPI_StringHandle nameSH
Definition: HAPI_Common.h:1459
#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:1229
Field + Single Selection Menu.
Definition: HAPI_Common.h:396
int HAPI_NodeId
See HAPI_Nodes_Basics.
Definition: HAPI_Common.h:134
HAPI_PartId id
Definition: HAPI_Common.h:1305
HAPI_CacheProperty
[HAPI_CacheProperty]
Definition: HAPI_Common.h:707
HAPI_Bool isInstanced
Definition: HAPI_Common.h:1238
You should abort the cook.
Definition: HAPI_Common.h:239
int primitiveGroupCount
Definition: HAPI_Common.h:1294
HAPI_PrmScriptType scriptType
The script-type.
Definition: HAPI_Common.h:1025
HAPI_StringHandle nameSH
Instance name (the label + a number).
Definition: HAPI_Common.h:827
Mini Menu Only, Single Selection.
Definition: HAPI_Common.h:395
int HAPI_AssetLibraryId
Definition: HAPI_Common.h:131
Parameter is not a menu.
Definition: HAPI_Common.h:393
#define HAPI_C_ENUM_TYPEDEF(enum_name)
[HAPI_CACHE]
Definition: HAPI_Common.h:97
HAPI_TransformComponent
Definition: HAPI_Common.h:582
HAPI_Bool hasTransformChanged
Definition: HAPI_Common.h:1219
HAPI_StringHandle objectInstancePathSH
Definition: HAPI_Common.h:1215
HAPI_Bool hasMin
Definition: HAPI_Common.h:1092
HAPI_StringHandle internalNodePathSH
Definition: HAPI_Common.h:964
HAPI_Bool disabled
Whether this parm should appear enabled or disabled.
Definition: HAPI_Common.h:1112
HAPI_Bool handleBoxPartTypes
Definition: HAPI_Common.h:925
HAPI_SessionType type
Definition: HAPI_Common.h:773
HAPI_NodeFlags inputNodeFlag
Definition: HAPI_Common.h:1142
int HAPI_PartId
Definition: HAPI_Common.h:142
HAPI_NodeId nodeId
Definition: HAPI_Common.h:1250
int maxVerticesPerPrimitive
Definition: HAPI_Common.h:884
HAPI_Bool isChildOfMultiParm
Definition: HAPI_Common.h:1146
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:169