HDK
|
#include "GA_API.h"
#include <UT/UT_Assert.h>
#include <UT/UT_ValArray.h>
#include <SYS/SYS_Math.h>
#include <SYS/SYS_Types.h>
Go to the source code of this file.
Macros | |
#define | __GA_Types__ |
#define | GA_MAX_ORDER 11 |
#define | GA_PAGE_BITS 10 |
Attributes may paritition their data in pages of GA_PAGE_SIZE offsets. More... | |
#define | GA_PAGE_SIZE (1 << GA_PAGE_BITS) |
#define | GA_PAGE_MASK (GA_PAGE_SIZE - 1) |
#define | GA_DEFRAGMENT_OCCUPANCY 1.00 |
#define | GA_INVALID_INDEX GA_Index(-1) |
#define | GA_INVALID_OFFSET GA_Offset(-1) |
#define | GA_DETAIL_INDEX GA_Index(0) |
Details are always at index and offset zero in their own detail index map. More... | |
#define | GA_DETAIL_OFFSET GA_Offset(0) |
Typedefs | |
typedef exint | GA_Size |
Defines the bit width for index and offset types in GA. More... | |
typedef GA_Size | GA_Index |
Define the strictness of GA_Offset/GA_Index. More... | |
typedef GA_Size | GA_Offset |
typedef GA_Size | GA_PageNum |
typedef GA_Size | GA_PageOff |
typedef UT_ValArray< GA_Index > | GA_IndexArray |
typedef UT_ValArray< GA_Offset > | GA_OffsetArray |
Functions | |
bool | GAisValid (GA_Size v) |
GA_PageNum | GAgetPageNum (GA_Offset v) |
GA_PageOff | GAgetPageOff (GA_Offset v) |
bool | GAisFullPage (GA_Offset start, GA_Offset end) |
GA_Offset | GAgetPageBoundary (const GA_Offset &start, const GA_Offset &end) |
GA_API unsigned | GAsizeof (GA_Storage store) |
Lookup the size in bytes of a storage type (inaccurate for bool) More... | |
GA_API int | GAcomparePrecision (GA_Storage a, GA_Storage b) |
GA_API const char * | GAowner (GA_AttributeOwner owner) |
Lookup the owner name from the owner type. More... | |
GA_API GA_AttributeOwner | GAowner (const char *owner) |
Lookup the owner type from the owner name. More... | |
GA_API const char * | GAscope (GA_AttributeScope scope) |
Lookup the scope name from the scope type. More... | |
GA_API GA_AttributeScope | GAscope (const char *scope) |
Lookup the scope type from the scope name. More... | |
GA_API const char * | GAstorage (GA_Storage store) |
Lookup the storage name from the storage type. More... | |
GA_API GA_Storage | GAstorage (const char *store) |
Lookup the storage type from the storage name. More... | |
GA_API const char * | GAstorageLabel (GA_Storage store) |
Lookup the storage label (descriptive name) from the storage type. More... | |
GA_API GA_Storage | GAstorageLabel (const char *store) |
Lookup the storage type from the storage label. More... | |
GA_API const char * | GAstorageClass (GA_StorageClass store) |
Lookup the storage name from the storage type. More... | |
GA_API GA_StorageClass | GAstorageClass (const char *store) |
Lookup the intrinsic storage type from the storage name. More... | |
GA_API const char * | GAtypeinfo (GA_TypeInfo type) |
Lookup the type-info name from the type-info type. More... | |
GA_API GA_TypeInfo | GAtypeinfo (const char *type) |
Lookup the type-info type from the type-info name. More... | |
GA_API const char * | GAtypeinfoLabel (GA_TypeInfo type) |
Lookup the type-info label (descriptive name) from the type-info type. More... | |
GA_API GA_TypeInfo | GAtypeinfoLabel (const char *type) |
Lookup the type-info type from the type-info label (descriptive name) More... | |
GA_API const char * | GAgroupType (GA_GroupType owner) |
Lookup the owner name from the owner type. More... | |
GA_API GA_GroupType | GAgroupType (const char *owner) |
Lookup the owner type from the owner name. More... | |
#define | GA_INVALID_INTRINSIC_HANDLE -1 |
typedef int | GA_LocalIntrinsic |
typedef int | GA_GlobalIntrinsic |
#define __GA_Types__ |
Definition at line 14 of file GA_Types.h.
#define GA_DEFRAGMENT_OCCUPANCY 1.00 |
Definition at line 202 of file GA_Types.h.
#define GA_DETAIL_INDEX GA_Index(0) |
Details are always at index and offset zero in their own detail index map.
Definition at line 657 of file GA_Types.h.
#define GA_DETAIL_OFFSET GA_Offset(0) |
Definition at line 658 of file GA_Types.h.
#define GA_INVALID_INDEX GA_Index(-1) |
Definition at line 653 of file GA_Types.h.
#define GA_INVALID_INTRINSIC_HANDLE -1 |
At the current time, intrinsic handles are an integer. This may change in the future.
Definition at line 668 of file GA_Types.h.
#define GA_INVALID_OFFSET GA_Offset(-1) |
Definition at line 654 of file GA_Types.h.
#define GA_MAX_ORDER 11 |
Definition at line 163 of file GA_Types.h.
#define GA_PAGE_BITS 10 |
Attributes may paritition their data in pages of GA_PAGE_SIZE offsets.
Definition at line 199 of file GA_Types.h.
#define GA_PAGE_MASK (GA_PAGE_SIZE - 1) |
Definition at line 201 of file GA_Types.h.
#define GA_PAGE_SIZE (1 << GA_PAGE_BITS) |
Definition at line 200 of file GA_Types.h.
typedef int GA_GlobalIntrinsic |
At the current time, intrinsic handles are an integer. This may change in the future.
Definition at line 667 of file GA_Types.h.
Define the strictness of GA_Offset/GA_Index.
GA_Index is a contiguous index into an element in a GA_Detail structure. Since the list of elements can contain gaps, the index should be translated into a GA_Offset prior to lookup. The index remains constant if the element list is defragmented, but will be invalid if an element, prior to a given index, is inserted or deleted.
Definition at line 611 of file GA_Types.h.
typedef UT_ValArray<GA_Index> GA_IndexArray |
Definition at line 660 of file GA_Types.h.
typedef int GA_LocalIntrinsic |
At the current time, intrinsic handles are an integer. This may change in the future.
Definition at line 666 of file GA_Types.h.
GA_Offset is a, possibly, non-contiguous offset to an element in a GA_Detail structure. GA_Offsets remain constant even if an element prior to it is deleted, but will be invalidated if an element is inserted prior to it, or if the element list is defragmented.
Definition at line 617 of file GA_Types.h.
typedef UT_ValArray<GA_Offset> GA_OffsetArray |
Definition at line 661 of file GA_Types.h.
typedef GA_Size GA_PageNum |
Definition at line 620 of file GA_Types.h.
typedef GA_Size GA_PageOff |
Definition at line 621 of file GA_Types.h.
Defines the bit width for index and offset types in GA.
Definition at line 211 of file GA_Types.h.
enum GA_AttributeOwner |
The GA_AttributeOwner enum is used to differentiate between the different types of attribute arrays stored in a GA_Detail. The different classes represent
Enumerator | |
---|---|
GA_ATTRIB_VERTEX | |
GA_ATTRIB_POINT | |
GA_ATTRIB_PRIMITIVE | |
GA_ATTRIB_GLOBAL | |
GA_ATTRIB_OWNER_N | |
GA_ATTRIB_DETAIL | |
GA_ATTRIB_INVALID |
Definition at line 33 of file GA_Types.h.
enum GA_AttributeScope |
Scope qualifiers on attributes. Each valid scope has its own namespace, along with other consequences.
Enumerator | |
---|---|
GA_SCOPE_INVALID |
Data has no numeric representation. |
GA_SCOPE_PUBLIC |
Standard user attribute level. |
GA_SCOPE_PRIVATE | |
GA_SCOPE_GROUP |
Definition at line 121 of file GA_Types.h.
enum GA_DataIdStrategy |
Strategies that may be used for attribute data IDs, usually when merging or copying attributes.
Enumerator | |
---|---|
GA_DATA_ID_BUMP |
The default strategy, where the caller does not have to explicitly worry about attribute data IDs. |
GA_DATA_ID_CLONE |
Attributes should inherit the data IDs from their corresponding source attribute. The caller will typically call GA_Attribute::bumpDataId() on any attributes that they later modify. |
Definition at line 186 of file GA_Types.h.
enum GA_GroupMaskType |
Currently SOP_Node::parseAllGroups takes a mask of different types of groups. This enum allows group types to be packed into a bit field.
Enumerator | |
---|---|
GA_GMASK_NONE | |
GA_GMASK_POINT | |
GA_GMASK_PRIMITIVE | |
GA_GMASK_EDGE | |
GA_GMASK_BREAKPOINT | |
GA_GMASK_VERTEX | |
GA_GMASK_FULL_MASK |
Definition at line 151 of file GA_Types.h.
enum GA_GroupType |
An ordinal enum for the different types of groups in GA.
Enumerator | |
---|---|
GA_GROUP_INVALID | |
GA_GROUP_POINT | |
GA_GROUP_PRIMITIVE | |
GA_GROUP_EDGE | |
GA_GROUP_BREAKPOINT | |
GA_GROUP_VERTEX | |
GA_GROUP_N |
Definition at line 138 of file GA_Types.h.
enum GA_KnotSpaceType |
Enumerator | |
---|---|
GA_KNOT_SPACE_UNIFORM | |
GA_KNOT_SPACE_AVERAGING |
Definition at line 166 of file GA_Types.h.
Enumerator | |
---|---|
GA_PARAMETERIZATION_UNIFORM | |
GA_PARAMETERIZATION_CHORD | |
GA_PARAMETERIZATION_CENTRIPETAL | |
GA_PARAMETERIZATION_APPROXARC |
Definition at line 173 of file GA_Types.h.
enum GA_Storage |
Attributes (and other data) may be stored with different precision and storage types.
Enumerator | |
---|---|
GA_STORE_INVALID | |
GA_STORE_BOOL | |
GA_STORE_UINT8 | |
GA_STORE_INT8 | |
GA_STORE_INT16 | |
GA_STORE_INT32 | |
GA_STORE_INT64 | |
GA_STORE_REAL16 | |
GA_STORE_REAL32 | |
GA_STORE_REAL64 | |
GA_STORE_STRING |
Definition at line 48 of file GA_Types.h.
enum GA_StorageClass |
Often one does not care about the precision. In this case the storage class gives a good idea which AIFs will be supported.
Enumerator | |
---|---|
GA_STORECLASS_INVALID | |
GA_STORECLASS_INT | |
GA_STORECLASS_REAL | |
GA_STORECLASS_FLOAT | |
GA_STORECLASS_STRING | |
GA_STORECLASS_OTHER |
Definition at line 68 of file GA_Types.h.
enum GA_TypeInfo |
Type qualifiers on attributes. These qualifiers can help to interpret the data associated with an attribute, but are not required.
Definition at line 80 of file GA_Types.h.
GA_API int GAcomparePrecision | ( | GA_Storage | a, |
GA_Storage | b | ||
) |
Compare precision of GA_Storage types. The function will return: -2 invalid comparison (i.e. comparing a string to a float) -1 if a is less precise than b 0 if a and be have the same precision 1 if a is more precise than b
Definition at line 647 of file GA_Types.h.
|
inline |
Definition at line 632 of file GA_Types.h.
|
inline |
Definition at line 636 of file GA_Types.h.
GA_API const char* GAgroupType | ( | GA_GroupType | owner | ) |
Lookup the owner name from the owner type.
GA_API GA_GroupType GAgroupType | ( | const char * | owner | ) |
Lookup the owner type from the owner name.
Definition at line 640 of file GA_Types.h.
|
inline |
Definition at line 625 of file GA_Types.h.
GA_API const char* GAowner | ( | GA_AttributeOwner | owner | ) |
Lookup the owner name from the owner type.
GA_API GA_AttributeOwner GAowner | ( | const char * | owner | ) |
Lookup the owner type from the owner name.
GA_API const char* GAscope | ( | GA_AttributeScope | scope | ) |
Lookup the scope name from the scope type.
GA_API GA_AttributeScope GAscope | ( | const char * | scope | ) |
Lookup the scope type from the scope name.
GA_API unsigned GAsizeof | ( | GA_Storage | store | ) |
Lookup the size in bytes of a storage type (inaccurate for bool)
GA_API const char* GAstorage | ( | GA_Storage | store | ) |
Lookup the storage name from the storage type.
GA_API GA_Storage GAstorage | ( | const char * | store | ) |
Lookup the storage type from the storage name.
GA_API const char* GAstorageClass | ( | GA_StorageClass | store | ) |
Lookup the storage name from the storage type.
GA_API GA_StorageClass GAstorageClass | ( | const char * | store | ) |
Lookup the intrinsic storage type from the storage name.
GA_API const char* GAstorageLabel | ( | GA_Storage | store | ) |
Lookup the storage label (descriptive name) from the storage type.
GA_API GA_Storage GAstorageLabel | ( | const char * | store | ) |
Lookup the storage type from the storage label.
GA_API const char* GAtypeinfo | ( | GA_TypeInfo | type | ) |
Lookup the type-info name from the type-info type.
GA_API GA_TypeInfo GAtypeinfo | ( | const char * | type | ) |
Lookup the type-info type from the type-info name.
GA_API const char* GAtypeinfoLabel | ( | GA_TypeInfo | type | ) |
Lookup the type-info label (descriptive name) from the type-info type.
GA_API GA_TypeInfo GAtypeinfoLabel | ( | const char * | type | ) |
Lookup the type-info type from the type-info label (descriptive name)