AttributeKeys

class omni.graph.tools.ogn.AttributeKeys

Bases: object

Container for the text for all of the .ogn keywords used at the attribute definition level

Methods

Attributes

ALLOWED_TOKENS	Metadata list of all allowed tokens on a token-type attribute
CUDA_POINTERS	Metadata of the type of array pointers for GPU data
DEFAULT	Default value of the attribute
DEPRECATED	Is the attribute deprecated?
DESCRIPTION	Full description of the attribute
MANDATORY	Attribute keywords required to exist for all attributes
MAXIMUM	Maximum value the numeric attribute can use
MEMORY_TYPE	Memory location preferred by the generated attribute access code
METADATA	General string-based metadata
MINIMUM	Minimum value the numeric attribute can use
OPTIONAL	The attribute is not required to be valid to allow compute
PROCESSED	Attribute keys that are always directly processed, not relying on AttributeManager derived classes to do it
TYPE	The type of attribute data
UI_NAME	The name of the attribute as it will appear in the UI
UNVALIDATED	True if an extended attribute does not have to be resolved to allow compute

__init__()

ALLOWED_TOKENS = 'allowedTokens'

Metadata list of all allowed tokens on a token-type attribute

CUDA_POINTERS = 'cudaPointers'

Metadata of the type of array pointers for GPU data

DEFAULT = 'default'

Default value of the attribute

DEPRECATED = 'deprecated'

Is the attribute deprecated?

DESCRIPTION = 'description'

Full description of the attribute

MANDATORY = ['description', 'type']

Attribute keywords required to exist for all attributes

MAXIMUM = 'maximum'

Maximum value the numeric attribute can use

MEMORY_TYPE = 'memoryType'

Memory location preferred by the generated attribute access code

METADATA = 'metadata'

General string-based metadata

MINIMUM = 'minimum'

Minimum value the numeric attribute can use

OPTIONAL = 'optional'

The attribute is not required to be valid to allow compute

PROCESSED = ['description', 'type', 'cudaPointers', 'default', 'deprecated', 'memoryType', 'metadata', 'optional', 'uiName', 'unvalidated', 'allowedTokens']

Attribute keys that are always directly processed, not relying on AttributeManager derived classes to do it

TYPE = 'type'

The type of attribute data

UI_NAME = 'uiName'

The name of the attribute as it will appear in the UI

UNVALIDATED = 'unvalidated'

True if an extended attribute does not have to be resolved to allow compute