Houdini Engine 2.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator 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  * Produced by:
7  * Side Effects Software Inc
8  * 123 Front Street West, Suite 1401
9  * Toronto, Ontario
10  * Canada M5J 2M2
11  * 416-504-9876
12  *
13  * COMMENTS:
14  */
15 
16 #ifndef __HAPI_HELPERS_h__
17 #define __HAPI_HELPERS_h__
18 
19 #include "HAPI_API.h"
20 #include "HAPI_Common.h"
21 
22 // TIME ---------------------------------------------------------------------
23 
24 HAPI_DECL_RETURN( void )
28 
29 // ASSETS -------------------------------------------------------------------
30 
31 HAPI_DECL_RETURN( void )
35 
36 HAPI_DECL_RETURN( void )
42  const HAPI_CookOptions * left,
43  const HAPI_CookOptions * right );
44 
45 // NODES --------------------------------------------------------------------
46 
47 HAPI_DECL_RETURN( void )
51 
52 // PARAMETERS ---------------------------------------------------------------
53 
54 /// Clears the struct to default values.
55 HAPI_DECL_RETURN( void )
57 
58 /// Creates a struct with default values and returns it.
61 
62 /// Convenience function that checks on the value of the ::HAPI_ParmInfo::type
63 /// field to tell you the underlying data type.
64 /// @{
66  HAPI_ParmInfo_IsInt( const HAPI_ParmInfo * in );
72  HAPI_ParmInfo_IsPath( const HAPI_ParmInfo * in );
77 /// @}
78 
79 /// Parameter has no underlying No data type. Examples of this are UI items
80 /// such as folder lists and separators.
83 
84 /// Convenience function. If the parameter can be represented by this data
85 /// type, it returns ::HAPI_ParmInfo::size, and zero otherwise.
86 /// @{
87 HAPI_DECL_RETURN( int )
89 HAPI_DECL_RETURN( int )
91 HAPI_DECL_RETURN( int )
93 /// @}
94 
95 HAPI_DECL_RETURN( void )
99 
100 // HANDLES ------------------------------------------------------------------
101 
102 HAPI_DECL_RETURN( void )
106 
107 HAPI_DECL_RETURN( void )
111 
112 // OBJECTS ------------------------------------------------------------------
113 
114 HAPI_DECL_RETURN( void )
118 
119 // GEOMETRY -----------------------------------------------------------------
120 
121 HAPI_DECL_RETURN( void )
125 HAPI_DECL_RETURN( int )
127  HAPI_GeoInfo * in, HAPI_GroupType type );
128 
129 HAPI_DECL_RETURN( void )
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 #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_ParmInfo_IsNodePath(const HAPI_ParmInfo *in)
HAPI_ParmChoiceInfo_Init(HAPI_ParmChoiceInfo *in)
HAPI_ParmInfo_GetFloatValueCount(const HAPI_ParmInfo *in)
HAPI_GeoInputInfo_Init(HAPI_GeoInputInfo *in)
HAPI_AttributeInfo_Create()
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_CookOptions_AreEqual(const HAPI_CookOptions *left, const HAPI_CookOptions *right)
HAPI_ObjectInfo_Create()
HAPI_GeoInfo_Create()
HAPI_AttributeOwner
Definition: HAPI_Common.h:407
HAPI_TimelineOptions_Create()
HAPI_NodeInfo_Init(HAPI_NodeInfo *in)
HAPI_ParmInfo_IsNonValue(const HAPI_ParmInfo *in)
HAPI_ImageInfo_Init(HAPI_ImageInfo *in)
HAPI_ParmInfo_IsFloat(const HAPI_ParmInfo *in)
See Attributes.
Definition: HAPI_Common.h:1226
HAPI_CookOptions_Create()
HAPI_CurveInfo_Init(HAPI_CurveInfo *in)
HAPI_ParmInfo_IsFilePath(const HAPI_ParmInfo *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:103
HAPI_ImageFileFormat_Create()
HAPI_ParmInfo_IsInt(const HAPI_ParmInfo *in)
char HAPI_Bool
Definition: HAPI_Common.h:116
HAPI_GeoInputInfo_Create()
HAPI_TimelineOptions_Init(HAPI_TimelineOptions *in)
HAPI_HandleBindingInfo_Create()
HAPI_PartInfo_GetAttributeCountByOwner(HAPI_PartInfo *in, HAPI_AttributeOwner owner)
HAPI_GroupType
Definition: HAPI_Common.h:398
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)