Type

class omni.graph.core.Type

Methods

__init__(self, base_type, tuple_count, ...)

get_base_type_name(self)

Returns string name of just the base data type of this type.

get_ogn_type_name(self)

Returns string name of this type in OGN format, which differs slightly from the USD format.

get_role_name(self)

Returns string name of just the role of this type.

get_type_name(self)

Returns string name of this type.

is_compatible_raw_data(self, arg0)

Does a role-insensitive comparison with the given Type.

is_matrix_type(self)

Checks if the type one of the matrix types, whose tuples are interpreted as a square array?

Attributes

array_depth

Zero for a single value, one for an array, two for an array of arrays.

base_type

Base type of the attribute.

role

The semantic role of the type.

tuple_count

Number of components in each tuple.

__init__(self: omni.graph.core._omni_graph_core.Type, base_type: omni.graph.core._omni_graph_core.BaseDataType, tuple_count: int = 1, array_depth: int = 0, role: omni.graph.core._omni_graph_core.AttributeRole = <AttributeRole.NONE: 0>) None
get_base_type_name(self: omni.graph.core._omni_graph_core.Type) str

Returns string name of just the base data type of this type.

get_ogn_type_name(self: omni.graph.core._omni_graph_core.Type) str

Returns string name of this type in OGN format, which differs slightly from the USD format.

get_role_name(self: omni.graph.core._omni_graph_core.Type) str

Returns string name of just the role of this type.

get_type_name(self: omni.graph.core._omni_graph_core.Type) str

Returns string name of this type.

is_compatible_raw_data(self: omni.graph.core._omni_graph_core.Type, arg0: omni.graph.core._omni_graph_core.Type) bool

Does a role-insensitive comparison with the given Type.

For example double[3] != pointd[3], but are compatible and so would return True.

Returns

Is the given type compatible with this type?

Return type

[bool]

is_matrix_type(self: omni.graph.core._omni_graph_core.Type) bool

Checks if the type one of the matrix types, whose tuples are interpreted as a square array?

Returns

True if this type is one of the matrix types

Return type

[bool]

property array_depth

Zero for a single value, one for an array, two for an array of arrays. (Int)

property base_type

Base type of the attribute. (:class:`omni.graph.core.BaseDataType`)

property role

The semantic role of the type. (:class:`omni.graph.core.AttributeRole`)

property tuple_count

Number of components in each tuple. 1 for a single value (scaler), 3 for a point3d, etc. (Int)