Houdini Engine 7.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator 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 // Session ------------------------------------------------------------------
16 
17 HAPI_DECL_RETURN( void )
21 
22 // Server -------------------------------------------------------------------
23 
24 HAPI_DECL_RETURN( void )
28 
29 // TIME ---------------------------------------------------------------------
30 
31 HAPI_DECL_RETURN( void )
35 
36 // COMPOSITOR SETTINGS ------------------------------------------------------
37 
38 HAPI_DECL_RETURN( void)
42 
43 // ASSETS -------------------------------------------------------------------
44 
45 HAPI_DECL_RETURN( void )
49 
50 HAPI_DECL_RETURN( void )
56  const HAPI_CookOptions * left,
57  const HAPI_CookOptions * right );
58 
59 // NODES --------------------------------------------------------------------
60 
61 HAPI_DECL_RETURN( void )
65 
66 // PARAMETERS ---------------------------------------------------------------
67 
68 /// Clears the struct to default values.
69 HAPI_DECL_RETURN( void )
71 
72 /// Creates a struct with default values and returns it.
75 
76 /// Convenience function that checks on the value of the ::HAPI_ParmInfo::type
77 /// field to tell you the underlying data type.
78 /// @{
80  HAPI_ParmInfo_IsInt( const HAPI_ParmInfo * in );
86  HAPI_ParmInfo_IsPath( const HAPI_ParmInfo * in );
88  HAPI_ParmInfo_IsNode( const HAPI_ParmInfo * in );
89 /// @}
90 
91 /// Parameter has no underlying No data type. Examples of this are UI items
92 /// such as folder lists and separators.
95 
96 /// Convenience function. If the parameter can be represented by this data
97 /// type, it returns ::HAPI_ParmInfo::size, and zero otherwise.
98 /// @{
99 HAPI_DECL_RETURN( int )
101 HAPI_DECL_RETURN( int )
103 HAPI_DECL_RETURN( int )
105 /// @}
106 
107 HAPI_DECL_RETURN( void )
111 
112 // HANDLES ------------------------------------------------------------------
113 
114 HAPI_DECL_RETURN( void )
118 
119 HAPI_DECL_RETURN( void )
123 
124 // OBJECTS ------------------------------------------------------------------
125 
126 HAPI_DECL_RETURN( void )
130 
131 // GEOMETRY -----------------------------------------------------------------
132 
133 HAPI_DECL_RETURN( void )
137 HAPI_DECL_RETURN( int )
139  HAPI_GeoInfo * in, HAPI_GroupType type );
140 
141 HAPI_DECL_RETURN( void )
145 HAPI_DECL_RETURN( int )
147  HAPI_PartInfo * in, HAPI_AttributeOwner owner );
148 HAPI_DECL_RETURN( int )
150  HAPI_PartInfo * in, HAPI_GroupType type );
151 HAPI_DECL_RETURN( int )
153  HAPI_PartInfo * in, HAPI_AttributeOwner owner );
154 
155 HAPI_DECL_RETURN( void )
159 
160 // MATERIALS ----------------------------------------------------------------
161 
162 HAPI_DECL_RETURN( void )
166 
167 HAPI_DECL_RETURN( void )
171 
172 HAPI_DECL_RETURN( void )
176 
177 // ANIMATION ----------------------------------------------------------------
178 
179 HAPI_DECL_RETURN( void )
183 
184 // VOLUMES ------------------------------------------------------------------
185 
186 HAPI_DECL_RETURN( void )
190 
191 HAPI_DECL_RETURN( void )
195 
196 // CURVES -------------------------------------------------------------------
197 
198 HAPI_DECL_RETURN( void )
202 
203 // CURVE INPUTS ------------------------------------------------------------
204 
205 HAPI_DECL_RETURN( void )
209 
210 // TRANSFORMS ---------------------------------------------------------------
211 
212 HAPI_DECL_RETURN( void )
214 
217 
218 HAPI_DECL_RETURN( void )
220 
223 
224 // SESSIONSYNC --------------------------------------------------------------
225 
226 HAPI_DECL_RETURN (void )
228 
231 
232 HAPI_DECL_RETURN (void )
234 
237 
238 #endif // __HAPI_HELPERS_h__
HAPI_AssetInfo_Create()
Definition: HAPI_Helpers.C:122
HAPI_MaterialInfo_Init(HAPI_MaterialInfo *in)
Definition: HAPI_Helpers.C:605
HAPI_Keyframe_Init(HAPI_Keyframe *in)
Definition: HAPI_Helpers.C:663
HAPI_PartInfo_GetElementCountByAttributeOwner(HAPI_PartInfo *in, HAPI_AttributeOwner owner)
Definition: HAPI_Helpers.C:529
Data for an image, used with HAPI_GetImageInfo() and HAPI_SetImageInfo()
Definition: HAPI_Common.h:1840
HAPI_HandleBindingInfo_Init(HAPI_HandleBindingInfo *in)
Definition: HAPI_Helpers.C:407
HAPI_ParmChoiceInfo_Init(HAPI_ParmChoiceInfo *in)
Definition: HAPI_Helpers.C:373
HAPI_ParmInfo_GetFloatValueCount(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:355
HAPI_AttributeInfo_Create()
Definition: HAPI_Helpers.C:595
HAPI_ParmInfo_GetIntValueCount(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:346
HAPI_VolumeTileInfo_Init(HAPI_VolumeTileInfo *in)
Definition: HAPI_Helpers.C:714
HAPI_ObjectInfo_Init(HAPI_ObjectInfo *in)
Definition: HAPI_Helpers.C:425
HAPI_PartInfo_Create()
Definition: HAPI_Helpers.C:521
HAPI_MaterialInfo_Create()
Definition: HAPI_Helpers.C:613
HAPI_Keyframe_Create()
Definition: HAPI_Helpers.C:672
HAPI_Transform_Create()
Definition: HAPI_Helpers.C:798
HAPI_Viewport_Init(HAPI_Viewport *in)
Definition: HAPI_Helpers.C:835
HAPI_CookOptions_AreEqual(const HAPI_CookOptions *left, const HAPI_CookOptions *right)
Definition: HAPI_Helpers.C:171
HAPI_TransformEuler_Init(HAPI_TransformEuler *in)
Definition: HAPI_Helpers.C:806
HAPI_ObjectInfo_Create()
Definition: HAPI_Helpers.C:444
HAPI_GeoInfo_Create()
Definition: HAPI_Helpers.C:475
Meta-data about an HDA, returned by HAPI_GetAssetInfo()
Definition: HAPI_Common.h:1187
HAPI_AttributeOwner
Definition: HAPI_Common.h:568
HAPI_TimelineOptions_Create()
Definition: HAPI_Helpers.C:67
HAPI_SessionSyncInfo_Create()
Definition: HAPI_Helpers.C:862
HAPI_NodeInfo_Init(HAPI_NodeInfo *in)
Definition: HAPI_Helpers.C:194
HAPI_ParmInfo_IsNode(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:332
Meta-data for an OBJ Node.
Definition: HAPI_Common.h:1621
HAPI_ParmInfo_IsNonValue(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:339
HAPI_InputCurveInfo_Init(HAPI_InputCurveInfo *in)
Definition: HAPI_Helpers.C:759
HAPI_ImageInfo_Init(HAPI_ImageInfo *in)
Definition: HAPI_Helpers.C:637
HAPI_ParmInfo_IsFloat(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:309
HAPI_SessionSyncInfo_Init(HAPI_SessionSyncInfo *in)
Definition: HAPI_Helpers.C:855
Options to configure a Thrift server being started from HARC.
Definition: HAPI_Common.h:1144
HAPI_CookOptions_Create()
Definition: HAPI_Helpers.C:163
HAPI_CurveInfo_Init(HAPI_CurveInfo *in)
Definition: HAPI_Helpers.C:733
HAPI_Transform_Init(HAPI_Transform *in)
Definition: HAPI_Helpers.C:780
HAPI_ThriftServerOptions_Init(HAPI_ThriftServerOptions *in)
Definition: HAPI_Helpers.C:38
HAPI_Viewport_Create()
Definition: HAPI_Helpers.C:847
Meta-data describing a Geo Part.
Definition: HAPI_Common.h:1714
HAPI_InputCurveInfo_Create()
Definition: HAPI_Helpers.C:770
HAPI_SessionInfo_Init(HAPI_SessionInfo *in)
Definition: HAPI_Helpers.C:17
HAPI_PartInfo_GetElementCountByGroupType(HAPI_PartInfo *in, HAPI_GroupType type)
Definition: HAPI_Helpers.C:546
HAPI_VolumeInfo_Create()
Definition: HAPI_Helpers.C:706
HAPI_VolumeTileInfo_Create()
Definition: HAPI_Helpers.C:723
Meta-data for a Houdini Node.
Definition: HAPI_Common.h:1345
HAPI_ImageFileFormat_Init(HAPI_ImageFileFormat *in)
Definition: HAPI_Helpers.C:621
HAPI_ParmInfo_IsString(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:316
HAPI_ParmInfo_IsPath(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:324
Configuration options for Houdini's compositing context.
Definition: HAPI_Common.h:2151
HAPI_AssetInfo_Init(HAPI_AssetInfo *in)
Definition: HAPI_Helpers.C:94
HAPI_HandleInfo_Init(HAPI_HandleInfo *in)
Definition: HAPI_Helpers.C:391
HAPI_ParmChoiceInfo_Create()
Definition: HAPI_Helpers.C:381
HAPI_AttributeInfo_Init(HAPI_AttributeInfo *in)
Definition: HAPI_Helpers.C:578
HAPI_ImageInfo_Create()
Definition: HAPI_Helpers.C:653
HAPI_GeoInfo_GetGroupCountByType(HAPI_GeoInfo *in, HAPI_GroupType type)
Definition: HAPI_Helpers.C:483
HAPI_ParmInfo_Create()
Creates a struct with default values and returns it.
Definition: HAPI_Helpers.C:292
Configurations for sessions.
Definition: HAPI_Common.h:1117
Options which affect how nodes are cooked.
Definition: HAPI_Common.h:1246
HAPI_HandleInfo_Create()
Definition: HAPI_Helpers.C:399
HAPI_CurveInfo_Create()
Definition: HAPI_Helpers.C:749
HAPI_ParmInfo_Init(HAPI_ParmInfo *in)
Clears the struct to default values.
Definition: HAPI_Helpers.C:231
HAPI_VolumeInfo_Init(HAPI_VolumeInfo *in)
Definition: HAPI_Helpers.C:682
#define HAPI_DECL_RETURN(r)
Definition: HAPI_API.h:96
HAPI_ImageFileFormat_Create()
Definition: HAPI_Helpers.C:629
HAPI_CompositorOptions_Init(HAPI_CompositorOptions *in)
Definition: HAPI_Helpers.C:77
Meta-data for a SOP Node.
Definition: HAPI_Common.h:1670
A Transform with Euler rotation.
Definition: HAPI_Common.h:1089
HAPI_TransformEuler_Create()
Definition: HAPI_Helpers.C:825
Data for global timeline, used with HAPI_SetTimelineOptions()
Definition: HAPI_Common.h:1175
HAPI_ParmInfo_IsInt(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:300
char HAPI_Bool
Definition: HAPI_Common.h:119
HAPI_SessionInfo_Create()
Definition: HAPI_Helpers.C:28
HAPI_TimelineOptions_Init(HAPI_TimelineOptions *in)
Definition: HAPI_Helpers.C:58
HAPI_HandleBindingInfo_Create()
Definition: HAPI_Helpers.C:415
HAPI_PartInfo_GetAttributeCountByOwner(HAPI_PartInfo *in, HAPI_AttributeOwner owner)
Definition: HAPI_Helpers.C:561
A Transform with Quaternion rotation.
Definition: HAPI_Common.h:1077
HAPI_CompositorOptions_Create()
Definition: HAPI_Helpers.C:84
HAPI_GroupType
Definition: HAPI_Common.h:558
HAPI_CookOptions_Init(HAPI_CookOptions *in)
Definition: HAPI_Helpers.C:130
HAPI_GeoInfo_Init(HAPI_GeoInfo *in)
Definition: HAPI_Helpers.C:454
Describes an image format, used with HAPI_GetSupportedImageFileFormats()
Definition: HAPI_Common.h:1831
HAPI_ParmInfo_GetStringValueCount(const HAPI_ParmInfo *in)
Definition: HAPI_Helpers.C:364
Data for a single Key Frame.
Definition: HAPI_Common.h:1869
HAPI_NodeInfo_Create()
Definition: HAPI_Helpers.C:221
HAPI_PartInfo_Init(HAPI_PartInfo *in)
Definition: HAPI_Helpers.C:499
HAPI_ThriftServerOptions_Create()
Definition: HAPI_Helpers.C:48
Meta-data for a combo-box / choice parm.
Definition: HAPI_Common.h:1576