HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HAPI_Helpers.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  * COMMENTS:
7  */
8 
9 #ifndef __HAPI_HELPERS_h__
10 #define __HAPI_HELPERS_h__
11 
12 #include "HAPI_API.h"
13 #include "HAPI_Common.h"
14 
15 // TIME ---------------------------------------------------------------------
16 
17 HAPI_DECL_RETURN( void )
21 
22 // ASSETS -------------------------------------------------------------------
23 
24 HAPI_DECL_RETURN( void )
28 
29 HAPI_DECL_RETURN( void )
36  const HAPI_CookOptions * right );
37 
38 // NODES --------------------------------------------------------------------
39 
40 HAPI_DECL_RETURN( void )
44 
45 // PARAMETERS ---------------------------------------------------------------
46 
47 /// Clears the struct to default values.
48 HAPI_DECL_RETURN( void )
50 
51 /// Creates a struct with default values and returns it.
54 
55 /// Convenience function that checks on the value of the ::HAPI_ParmInfo::type
56 /// field to tell you the underlying data type.
57 /// @{
68 /// @}
69 
70 /// Parameter has no underlying No data type. Examples of this are UI items
71 /// such as folder lists and separators.
74 
75 /// Convenience function. If the parameter can be represented by this data
76 /// type, it returns ::HAPI_ParmInfo::size, and zero otherwise.
77 /// @{
78 HAPI_DECL_RETURN( int )
80 HAPI_DECL_RETURN( int )
82 HAPI_DECL_RETURN( int )
84 /// @}
85 
86 HAPI_DECL_RETURN( void )
90 
91 // HANDLES ------------------------------------------------------------------
92 
93 HAPI_DECL_RETURN( void )
97 
98 HAPI_DECL_RETURN( void )
102 
103 // OBJECTS ------------------------------------------------------------------
104 
105 HAPI_DECL_RETURN( void )
109 
110 // GEOMETRY -----------------------------------------------------------------
111 
112 HAPI_DECL_RETURN( void )
116 HAPI_DECL_RETURN( int )
119 
120 HAPI_DECL_RETURN( void )
124 HAPI_DECL_RETURN( int )
126  HAPI_PartInfo * in, HAPI_AttributeOwner owner );
127 HAPI_DECL_RETURN( int )
129  HAPI_PartInfo * in, HAPI_GroupType type );
130 HAPI_DECL_RETURN( int )
132  HAPI_PartInfo * in, HAPI_AttributeOwner owner );
133 
134 HAPI_DECL_RETURN( void )
138 
139 // MATERIALS ----------------------------------------------------------------
140 
141 HAPI_DECL_RETURN( void )
145 
146 HAPI_DECL_RETURN( void )
150 
151 HAPI_DECL_RETURN( void )
155 
156 // ANIMATION ----------------------------------------------------------------
157 
158 HAPI_DECL_RETURN( void )
162 
163 // VOLUMES ------------------------------------------------------------------
164 
165 HAPI_DECL_RETURN( void )
169 
170 HAPI_DECL_RETURN( void )
174 
175 // CURVES -------------------------------------------------------------------
176 
177 HAPI_DECL_RETURN( void )
181 
182 // TRANSFORMS ---------------------------------------------------------------
183 
184 HAPI_DECL_RETURN( void )
186 
189 
190 HAPI_DECL_RETURN( void )
192 
195 
196 #endif // __HAPI_HELPERS_h__
HAPI_AssetInfo_Create()
HAPI_MaterialInfo_Init(HAPI_MaterialInfo *in)
HAPI_Keyframe_Init(HAPI_Keyframe *in)
HAPI_PartInfo_GetElementCountByAttributeOwner(HAPI_PartInfo *in, HAPI_AttributeOwner owner)
HAPI_HandleBindingInfo_Init(HAPI_HandleBindingInfo *in)
HAPI_ParmChoiceInfo_Init(HAPI_ParmChoiceInfo *in)
HAPI_ParmInfo_GetFloatValueCount(const HAPI_ParmInfo *in)
HAPI_AttributeInfo_Create()
GLint left
Definition: glcorearb.h:2004
HAPI_ParmInfo_GetIntValueCount(const HAPI_ParmInfo *in)
HAPI_VolumeTileInfo_Init(HAPI_VolumeTileInfo *in)
HAPI_ObjectInfo_Init(HAPI_ObjectInfo *in)
HAPI_PartInfo_Create()
HAPI_MaterialInfo_Create()
HAPI_Keyframe_Create()
HAPI_Transform_Create()
HAPI_CookOptions_AreEqual(const HAPI_CookOptions *left, const HAPI_CookOptions *right)
HAPI_TransformEuler_Init(HAPI_TransformEuler *in)
HAPI_ObjectInfo_Create()
HAPI_GeoInfo_Create()
HAPI_AttributeOwner
Definition: HAPI_Common.h:409
HAPI_TimelineOptions_Create()
HAPI_NodeInfo_Init(HAPI_NodeInfo *in)
HAPI_ParmInfo_IsNode(const HAPI_ParmInfo *in)
HAPI_ParmInfo_IsNonValue(const HAPI_ParmInfo *in)
HAPI_ImageInfo_Init(HAPI_ImageInfo *in)
HAPI_ParmInfo_IsFloat(const HAPI_ParmInfo *in)
See HAPI_Attributes.
Definition: HAPI_Common.h:1256
HAPI_CookOptions_Create()
HAPI_CurveInfo_Init(HAPI_CurveInfo *in)
HAPI_Transform_Init(HAPI_Transform *in)
HAPI_PartInfo_GetElementCountByGroupType(HAPI_PartInfo *in, HAPI_GroupType type)
HAPI_VolumeInfo_Create()
HAPI_VolumeTileInfo_Create()
HAPI_ImageFileFormat_Init(HAPI_ImageFileFormat *in)
HAPI_ParmInfo_IsString(const HAPI_ParmInfo *in)
HAPI_ParmInfo_IsPath(const HAPI_ParmInfo *in)
HAPI_AssetInfo_Init(HAPI_AssetInfo *in)
HAPI_HandleInfo_Init(HAPI_HandleInfo *in)
HAPI_ParmChoiceInfo_Create()
HAPI_AttributeInfo_Init(HAPI_AttributeInfo *in)
HAPI_ImageInfo_Create()
HAPI_GeoInfo_GetGroupCountByType(HAPI_GeoInfo *in, HAPI_GroupType type)
HAPI_ParmInfo_Create()
Creates a struct with default values and returns it.
HAPI_HandleInfo_Create()
HAPI_CurveInfo_Create()
HAPI_ParmInfo_Init(HAPI_ParmInfo *in)
Clears the struct to default values.
HAPI_VolumeInfo_Init(HAPI_VolumeInfo *in)
#define HAPI_DECL_RETURN(r)
Definition: HAPI_API.h:96
HAPI_ImageFileFormat_Create()
HAPI_TransformEuler_Create()
HAPI_ParmInfo_IsInt(const HAPI_ParmInfo *in)
char HAPI_Bool
Definition: HAPI_Common.h:110
HAPI_TimelineOptions_Init(HAPI_TimelineOptions *in)
HAPI_HandleBindingInfo_Create()
HAPI_PartInfo_GetAttributeCountByOwner(HAPI_PartInfo *in, HAPI_AttributeOwner owner)
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
[HAPI_CacheProperty]
Definition: HAPI_Common.h:690
#define const
Definition: zconf.h:214
HAPI_GroupType
Definition: HAPI_Common.h:400
HAPI_CookOptions_Init(HAPI_CookOptions *in)
HAPI_GeoInfo_Init(HAPI_GeoInfo *in)
HAPI_ParmInfo_GetStringValueCount(const HAPI_ParmInfo *in)
HAPI_NodeInfo_Create()
HAPI_PartInfo_Init(HAPI_PartInfo *in)