HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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 // Server -------------------------------------------------------------------
16 
17 HAPI_DECL_RETURN( void )
21 
22 // TIME ---------------------------------------------------------------------
23 
24 HAPI_DECL_RETURN( void )
28 
29 // COMPOSITOR SETTINGS ------------------------------------------------------
30 
31 HAPI_DECL_RETURN( void)
35 
36 // ASSETS -------------------------------------------------------------------
37 
38 HAPI_DECL_RETURN( void )
42 
43 HAPI_DECL_RETURN( void )
51 
52 // NODES --------------------------------------------------------------------
53 
54 HAPI_DECL_RETURN( void )
58 
59 // PARAMETERS ---------------------------------------------------------------
60 
61 /// Clears the struct to default values.
62 HAPI_DECL_RETURN( void )
64 
65 /// Creates a struct with default values and returns it.
68 
69 /// Convenience function that checks on the value of the ::HAPI_ParmInfo::type
70 /// field to tell you the underlying data type.
71 /// @{
82 /// @}
83 
84 /// Parameter has no underlying No data type. Examples of this are UI items
85 /// such as folder lists and separators.
88 
89 /// Convenience function. If the parameter can be represented by this data
90 /// type, it returns ::HAPI_ParmInfo::size, and zero otherwise.
91 /// @{
92 HAPI_DECL_RETURN( int )
94 HAPI_DECL_RETURN( int )
96 HAPI_DECL_RETURN( int )
98 /// @}
99 
100 HAPI_DECL_RETURN( void )
104 
105 // HANDLES ------------------------------------------------------------------
106 
107 HAPI_DECL_RETURN( void )
111 
112 HAPI_DECL_RETURN( void )
116 
117 // OBJECTS ------------------------------------------------------------------
118 
119 HAPI_DECL_RETURN( void )
123 
124 // GEOMETRY -----------------------------------------------------------------
125 
126 HAPI_DECL_RETURN( void )
130 HAPI_DECL_RETURN( int )
133 
134 HAPI_DECL_RETURN( void )
138 HAPI_DECL_RETURN( int )
140  HAPI_PartInfo * in, HAPI_AttributeOwner owner );
141 HAPI_DECL_RETURN( int )
143  HAPI_PartInfo * in, HAPI_GroupType type );
144 HAPI_DECL_RETURN( int )
146  HAPI_PartInfo * in, HAPI_AttributeOwner owner );
147 
148 HAPI_DECL_RETURN( void )
152 
153 // MATERIALS ----------------------------------------------------------------
154 
155 HAPI_DECL_RETURN( void )
159 
160 HAPI_DECL_RETURN( void )
164 
165 HAPI_DECL_RETURN( void )
169 
170 // ANIMATION ----------------------------------------------------------------
171 
172 HAPI_DECL_RETURN( void )
176 
177 // VOLUMES ------------------------------------------------------------------
178 
179 HAPI_DECL_RETURN( void )
183 
184 HAPI_DECL_RETURN( void )
188 
189 // CURVES -------------------------------------------------------------------
190 
191 HAPI_DECL_RETURN( void )
195 
196 // CURVE INPUTS ------------------------------------------------------------
197 
198 HAPI_DECL_RETURN( void )
202 
203 // TRANSFORMS ---------------------------------------------------------------
204 
205 HAPI_DECL_RETURN( void )
207 
210 
211 HAPI_DECL_RETURN( void )
213 
216 
217 // SESSIONSYNC --------------------------------------------------------------
218 
219 HAPI_DECL_RETURN (void )
221 
224 
225 HAPI_DECL_RETURN (void )
227 
230 
231 #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)
Data for an image, used with HAPI_GetImageInfo() and HAPI_SetImageInfo()
Definition: HAPI_Common.h:1747
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_Viewport_Init(HAPI_Viewport *in)
HAPI_CookOptions_AreEqual(const HAPI_CookOptions *left, const HAPI_CookOptions *right)
HAPI_TransformEuler_Init(HAPI_TransformEuler *in)
HAPI_ObjectInfo_Create()
HAPI_GeoInfo_Create()
GLfloat right
Definition: glew.h:15525
Meta-data about an HDA, returned by HAPI_GetAssetInfo()
Definition: HAPI_Common.h:1098
HAPI_AttributeOwner
Definition: HAPI_Common.h:550
HAPI_TimelineOptions_Create()
HAPI_SessionSyncInfo_Create()
GLuint in
Definition: glew.h:11552
HAPI_NodeInfo_Init(HAPI_NodeInfo *in)
HAPI_ParmInfo_IsNode(const HAPI_ParmInfo *in)
Meta-data for an OBJ Node.
Definition: HAPI_Common.h:1528
HAPI_ParmInfo_IsNonValue(const HAPI_ParmInfo *in)
HAPI_InputCurveInfo_Init(HAPI_InputCurveInfo *in)
HAPI_ImageInfo_Init(HAPI_ImageInfo *in)
HAPI_ParmInfo_IsFloat(const HAPI_ParmInfo *in)
HAPI_SessionSyncInfo_Init(HAPI_SessionSyncInfo *in)
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:1070
HAPI_CookOptions_Create()
HAPI_CurveInfo_Init(HAPI_CurveInfo *in)
HAPI_Transform_Init(HAPI_Transform *in)
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
HAPI_ThriftServerOptions_Init(HAPI_ThriftServerOptions *in)
HAPI_Viewport_Create()
Meta-data describing a Geo Part.
Definition: HAPI_Common.h:1621
HAPI_InputCurveInfo_Create()
HAPI_PartInfo_GetElementCountByGroupType(HAPI_PartInfo *in, HAPI_GroupType type)
HAPI_VolumeInfo_Create()
HAPI_VolumeTileInfo_Create()
Meta-data for a Houdini Node.
Definition: HAPI_Common.h:1252
HAPI_ImageFileFormat_Init(HAPI_ImageFileFormat *in)
HAPI_ParmInfo_IsString(const HAPI_ParmInfo *in)
HAPI_ParmInfo_IsPath(const HAPI_ParmInfo *in)
Configuration options for Houdini's compositing context.
Definition: HAPI_Common.h:2027
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.
Options which affect how nodes are cooked.
Definition: HAPI_Common.h:1157
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_CompositorOptions_Init(HAPI_CompositorOptions *in)
Meta-data for a SOP Node.
Definition: HAPI_Common.h:1577
A Transform with Euler rotation.
Definition: HAPI_Common.h:1042
HAPI_TransformEuler_Create()
Data for global timeline, used with HAPI_SetTimelineOptions()
Definition: HAPI_Common.h:1086
HAPI_ParmInfo_IsInt(const HAPI_ParmInfo *in)
char HAPI_Bool
Definition: HAPI_Common.h:117
HAPI_TimelineOptions_Init(HAPI_TimelineOptions *in)
HAPI_HandleBindingInfo_Create()
HAPI_PartInfo_GetAttributeCountByOwner(HAPI_PartInfo *in, HAPI_AttributeOwner owner)
A Transform with Quaternion rotation.
Definition: HAPI_Common.h:1030
HAPI_CompositorOptions_Create()
#define const
Definition: zconf.h:214
HAPI_GroupType
Definition: HAPI_Common.h:540
HAPI_CookOptions_Init(HAPI_CookOptions *in)
HAPI_GeoInfo_Init(HAPI_GeoInfo *in)
Describes an image format, used with HAPI_GetSupportedImageFileFormats()
Definition: HAPI_Common.h:1738
HAPI_ParmInfo_GetStringValueCount(const HAPI_ParmInfo *in)
Data for a single Key Frame.
Definition: HAPI_Common.h:1776
HAPI_NodeInfo_Create()
HAPI_PartInfo_Init(HAPI_PartInfo *in)
HAPI_ThriftServerOptions_Create()
Meta-data for a combo-box / choice parm.
Definition: HAPI_Common.h:1483