Usg Python API¶

AssetPath¶

class usg.AssetPath¶

Bases: pybind11_object

A path to an external asset.

__init__(text: str) → None¶: Create an asset path from the given string.

assetPath() → str¶: Return the asset path.

resolvedPath() → str¶: Return the resolved asset path.

Attribute¶

class usg.Attribute¶

Bases: pybind11_object

An attribute.

block() → None¶: Unsets any authored value on the attribute.

clear() → None¶: Unsets any authored value on the attribute.

clearAllTimeSamples() → None¶: Removes all time samples from the attribute, leaving the default value unaffected.

clearAtTime(arg0: float) → None¶: Removes a specific time sample, ignoring default value.

clearDefault() → None¶: Removes the default value, leaving time samples unaffected.

get(time: float = nan) → object¶: Return the value of this attribute as an int, float, vector, Token, AssetPath…

getAllowedTokens() → usg::Array<usg::Token>¶: Returns an array of the allowed Tokens for this Attribute.

getField(arg0: usg::Token) → usg::Value¶: Return a field of the attribute.

getInterpolation() → usg::Token¶: Return the interpolation of the attribute.

getName() → str¶: Return the name of this attribute.

getNumDataElements() → int¶: Returns the number of data elements for each value. For example, 3 for a Vector3 or 16 for a Matrix4.

getPath() → usg::Path¶: Return the path of this attribute.

getTimeSamples() → std::vector<double, std::allocator<double> >¶: Return the list of authored time samples for this attribute.

getType() → usg::Value::Type¶: Return the type of this attribute.

getTypeName() → str¶: Return the type of this attribute as a string.

getUsgValue(time: float = nan) → usg::Value¶: Return the underlying usg::Value of this attribute.

hasAllowedTokens() → bool¶: Returns true if this Attribute has a set of allowed Tokens.

hasValue() → bool¶: Returns true if the attribute has any authored values, either a default or time samples, or if there’s a fallback value provided by a schema. Returns false if the attribute has been blocked and there is no fallback value.

isAuthored() → bool¶: Return whether there are any authored opinions for this property in any layer that contributes to this stage.

isValid() → bool¶: Return whether this attribute is valid or not.

set(value: object, time: float = nan) → None¶: Set the value of this attribute with an int, float, vector, Token, AssetPath…

setField(arg0: usg::Token, arg1: usg::Value) → bool¶: Set a field of the attribute.

setInterpolation(arg0: usg::Token) → None¶: Set the interpolation of the attribute.

Layer¶

class usg.Layer¶

Bases: pybind11_object

The wrapper class for a reference to a USD layer.

clearOwner() → None¶: Clears the layer’s owner.

property colorConfiguration¶: Property for the documentation metadata.

property colorManagementSystem¶: Property for the documentation metadata.

property comment¶: Property for the comment metadata.

static create(identifier: str, file_args: usg._usg.KeyValueMapSorted = KeyValueMapSorted{}) → usg._usg.Layer¶: Creates a new layer with the given identifier.

static createAnonymous(identifier: str, file_args: usg._usg.KeyValueMapSorted = KeyValueMapSorted{}) → usg._usg.Layer¶: Creates a new layer with the given identifier.

property defaultPrim¶: Property for the default prim metadata.

definePrim(path: usg::Path, typeName: usg::Token) → usg::Prim¶

Define an abstract prim in this layer. The ‘typeName’ is the prim’s schema name like ‘Mesh’, ‘Scope’, ‘Xform’, etc.

If a prim already exists at ‘path’ it is returned unchanged.

property documentation¶: Property for the documentation metadata.

property endTimeCode¶: Property for the end time code metadata.

exportToFile(filepath: str, comment: str, fileFormatArgs: usg._usg.KeyValueMapSorted) → bool¶: Exports the flattened layer to a file.

exportToString() → object¶: Return the flattened layer as a string.

static findOrOpen(identifier: str, file_args: usg._usg.KeyValueMapSorted = KeyValueMapSorted{}) → usg._usg.Layer¶: Searches for a layer with the given identifier in the layer cache, opening it if it’s not already.

property framePrecision¶: Property for the frame precision metadata.

property framesPerSecond¶: Property for the frames per second metadata.

getIdentifier() → str¶

static getLoadedLayers() → usg._usg.LayerRefSet¶: Returns all loaded layers.

getUsdLayer() → object¶: Returns the underlying USD py::object of the usg::Layer

isAnonymous() → bool¶: Returns true if the layer is anonymous (in-memory).

isValid() → bool¶: Return true if the layer is valid (has a valid object binding).

overridePrim(*args, **kwargs)¶

Overloaded function.

overridePrim(self: usg._usg.Layer, path: usg::Path) -> usg::Prim

Same as definePrim() but the created prim will have an ‘over’ specifier with no Type.
overridePrim(self: usg._usg.Layer, path: usg::Path, typeName: usg::Token) -> usg::Prim

Same as definePrim() but the created prim will have an ‘over’ specifier.
overridePrim(self: usg._usg.Layer, src_prim: usg::Prim) -> usg::Prim

Similar to definePrim() but the created Prim will have an ‘over’ specifier and the schema class is taken from the provided source Prim.

property owner¶: Property for the owner metadata.

reload() → None¶: Reloads the layer.

property sessionOwner¶: Property for the session owner metadata.

setOwner(owner: str) → None¶: Sets the layer’s owner.

property startTimeCode¶: Property for the start time code metadata.

property timeCodesPerSecond¶: Property for the time codes per second metadata.

transferContent(layer: usg._usg.Layer) → None¶: Transfers the content of the layer into this layer.

property upAxis¶: Property for the documentation metadata.

Path¶

class usg.Path¶

Bases: pybind11_object

A path value used to locate objects in layers or scenegraphs.

static IsValidPathString(arg0: str) → tuple¶: Static method to return whether the given string path would be valid and an error message if not.

__init__(text: str) → None¶

Create a path from the given string.

Create an empty path if the given string does not represent a valid path.

appendChild(*args, **kwargs)¶

Overloaded function.

appendChild(self: usg._usg.Path, suffix: usg::Token) -> usg._usg.Path

Create a path by appending an element to this path.

This path must be a prim path, the AbsoluteRootPath or the ReflexiveRelativePath. If it is not, or the child is not a valid prim name return an empty path.
appendChild(self: usg._usg.Path, suffix: str) -> usg._usg.Path

Create a path by appending an element to this path.

This path must be a prim path, the AbsoluteRootPath or the ReflexiveRelativePath. If it is not, or the child is not a valid prim name return an empty path.

appendPath(path: usg._usg.Path) → usg._usg.Path¶

Create a path by appending a given relative path to this path.

This path must be a prim path or the ReflexiveRelativePath. If it is not, return an empty path.

appendProperty(property: usg::Token) → usg._usg.Path¶

Create a path by appending a property to this path.

This path must be a prim path or the ReflexiveRelativePath. If it is not, return an empty path.

clear() → None¶: Clear the path so that it is empty.

empty() → bool¶: Return True if this is an empty path or False otherwise.

isValidPath() → tuple¶: Return whether this path is valid and an error message if not.

makeAbsolutePath(anchor: usg._usg.Path) → usg._usg.Path¶

Return the absolute form of this path using another path as the relative basis.

If this path is already an absolute path, return a copy.

makeRelativePath(anchor: usg._usg.Path) → usg._usg.Path¶: Return the relative form of this path using another path as the relative basis.

name() → str¶: Return the name of the prim, property or relational attribute identified by the path.

parent() → usg._usg.Path¶: Return the path that identifies this path’s namespace parent.

Prim¶

class usg.Prim¶

Bases: pybind11_object

The wrapper class for a reference to a USD prim.

createCustomAttr(name: usg::Token, type: usg::Value::Type, is_time_varying: usg::TimeVariability) → usg::Attribute¶

Create a attach a custom attribute to this prim. If the named GeomAttr object already exists return it at its current value.

If this Prim has just been defined on a GeomLayer then the new attribute will be defined on that GeomLayer.

If this Prim is being edited then the attribute will be created on the editable GeomStage and saved to the GeomStage’s current edit target GeomLayer.

defineInLayer(path: usg::Path, typeName: usg::Token) → usg._usg.Prim¶: Add this prim to a given layer.

getAttr(name: str) → object¶: Return named attribute if it exists on the prim. Otherwise return None.

getAttributeNames() → list¶: Returns the list of attribute names.

getAttributes() → list¶: Returns the list of attributes.

getKind() → usg::Token¶: Return the kind of this prim.

getMetadata(arg0: str) → object¶: Return metadata value for prim for a given key.

getName() → str¶: Return the name of this prim.

getPath() → usg::Path¶: Get geometry path (location) of this prim.

getRelationship(name: str) → object¶: Return named relationship if it exists on the prim. Otherwise return None.

getRelationshipNames() → list¶: Returns the list of relationship names.

getRelationships() → list¶: Returns the list of relationships.

getTypeName() → usg::Token¶: Get the type of this prim as a string.

getVariantSelection(arg0: str) → str¶: Return the variant selection for a given variant set name.

getVariantSets() → std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >¶: Get variant sets from prim as a StringArray.

getVariants(arg0: str) → std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >¶: Get variants for a given variant set name as a StringArray.

isActive() → bool¶: Return true if this prim is active.

isLoaded() → bool¶: Return true if this prim is active, and either it is loadable and it is loaded, or its nearest loadable ancestor is loaded, or it has no loadable ancestor; false otherwise.

isValid() → bool¶: Return whether this prim is valid or not.

Relationship¶

class usg.Relationship¶

Bases: pybind11_object

The wrapper class for a reference to a Relationship.

getName() → str¶: Return the name of this Relationship.

getPath() → usg::Path¶: Full path including the Prim parent.

getTarget() → usg::Path¶: Retrieve the first target path.

getTargets() → usg::Array<usg::Path>¶: Retrieves the relationship’s target paths.

isValid() → bool¶: Return whether this Relationship is valid or not.

setTarget(arg0: usg::Path) → None¶: Sets the relationship’s target path to a single path.

setTargets(arg0: usg::Array<usg::Path>) → None¶: Sets the relationship’s target paths.

Stage¶

class usg.Stage¶

Bases: pybind11_object

The wrapper class for a reference to a stage.

static create(sessionLayer: usg::Layer) → usg._usg.Stage¶: Creates a new Stage from the session layer.

static createMasked(sessionLayer: usg::Layer, maskPaths: usg::Array<usg::Path>) → usg._usg.Stage¶: Creates a new Stage from the session layer.

exportToString() → object¶: Return the flattened stage as a string.

flatten(addComment: bool = True) → usg::Layer¶: Return an anonymous layer containing the flattened stage.

getLayerStack() → std::vector<std::shared_ptr<usg::Layer>, std::allocator<std::shared_ptr<usg::Layer> > >¶: Returns the layer stack.

getPrimAtPath(path: str) → object¶: Return prim at given path from that stage. Otherwise return None.

getRootLayer() → usg::Layer¶: Return this stage’s root layer.

getUsdStage() → object¶: Returns the underlying USD py::object of the usg::Stage

isValid() → bool¶: Return true if the stage is valid (has a valid binding to a USD stage).

StageNotifications¶

class usg.StageNotifications¶

Bases: pybind11_object

Stage notifications

__init__(arg0: usg._usg.Stage) → None¶

clearChanged() → None¶

isChanged() → bool¶

Token¶

class usg.Token¶

Bases: pybind11_object

The wrapper class for PXR_NS::TfToken.

__init__(text: str) → None¶: Create a token from the given text.

Value¶

class usg.Value¶

Bases: pybind11_object

An object which can hold many types of value.

ASSETPATH_DATA = <DataType.ASSETPATH_DATA: 2>¶

AssetPath = <Type.AssetPath: 6>¶

AssetPathArray = <Type.AssetPathArray: 7>¶

Bool = <Type.Bool: 8>¶

BoolArray = <Type.BoolArray: 9>¶

Channel = <Type.Channel: 64>¶

ChannelArray = <Type.ChannelArray: 65>¶

Color = <Type.Color: 66>¶

Color3d = <Type.Color3d: 72>¶

Color3dArray = <Type.Color3dArray: 73>¶

Color3f = <Type.Color3f: 70>¶

Color3fArray = <Type.Color3fArray: 71>¶

Color3h = <Type.Color3h: 68>¶

Color3hArray = <Type.Color3hArray: 69>¶

Color4d = <Type.Color4d: 78>¶

Color4dArray = <Type.Color4dArray: 79>¶

Color4f = <Type.Color4f: 76>¶

Color4fArray = <Type.Color4fArray: 77>¶

Color4h = <Type.Color4h: 74>¶

Color4hArray = <Type.Color4hArray: 75>¶

ColorArray = <Type.ColorArray: 67>¶

DOUBLE_DATA = <DataType.DOUBLE_DATA: 9>¶

class DataType¶

Bases: pybind11_object

Members:

STRING_DATA

TOKEN_DATA

ASSETPATH_DATA

INT8_DATA

INT16_DATA

INT32_DATA

INT64_DATA

HALF_DATA

FLOAT_DATA

DOUBLE_DATA

ASSETPATH_DATA = <DataType.ASSETPATH_DATA: 2>¶

DOUBLE_DATA = <DataType.DOUBLE_DATA: 9>¶

FLOAT_DATA = <DataType.FLOAT_DATA: 8>¶

HALF_DATA = <DataType.HALF_DATA: 7>¶

INT16_DATA = <DataType.INT16_DATA: 4>¶

INT32_DATA = <DataType.INT32_DATA: 5>¶

INT64_DATA = <DataType.INT64_DATA: 6>¶

INT8_DATA = <DataType.INT8_DATA: 3>¶

STRING_DATA = <DataType.STRING_DATA: 0>¶

TOKEN_DATA = <DataType.TOKEN_DATA: 1>¶

__init__(value: int) → None¶

property name¶

property value¶

Double = <Type.Double: 24>¶

Double2 = <Type.Double2: 34>¶

Double2Array = <Type.Double2Array: 35>¶

Double3 = <Type.Double3: 42>¶

Double3Array = <Type.Double3Array: 43>¶

Double4 = <Type.Double4: 50>¶

Double4Array = <Type.Double4Array: 51>¶

DoubleArray = <Type.DoubleArray: 25>¶

FLOAT_DATA = <DataType.FLOAT_DATA: 8>¶

Float = <Type.Float: 22>¶

Float2 = <Type.Float2: 32>¶

Float2Array = <Type.Float2Array: 33>¶

Float3 = <Type.Float3: 40>¶

Float3Array = <Type.Float3Array: 41>¶

Float4 = <Type.Float4: 48>¶

Float4Array = <Type.Float4Array: 49>¶

FloatArray = <Type.FloatArray: 23>¶

Frame4d = <Type.Frame4d: 118>¶

Frame4dArray = <Type.Frame4dArray: 119>¶

HALF_DATA = <DataType.HALF_DATA: 7>¶

Half = <Type.Half: 20>¶

Half2 = <Type.Half2: 30>¶

Half2Array = <Type.Half2Array: 31>¶

Half3 = <Type.Half3: 38>¶

Half3Array = <Type.Half3Array: 39>¶

Half4 = <Type.Half4: 46>¶

Half4Array = <Type.Half4Array: 47>¶

HalfArray = <Type.HalfArray: 21>¶

INT16_DATA = <DataType.INT16_DATA: 4>¶

INT32_DATA = <DataType.INT32_DATA: 5>¶

INT64_DATA = <DataType.INT64_DATA: 6>¶

INT8_DATA = <DataType.INT8_DATA: 3>¶

Int = <Type.Int: 10>¶

Int2 = <Type.Int2: 28>¶

Int2Array = <Type.Int2Array: 29>¶

Int3 = <Type.Int3: 36>¶

Int3Array = <Type.Int3Array: 37>¶

Int4 = <Type.Int4: 44>¶

Int4Array = <Type.Int4Array: 45>¶

Int64 = <Type.Int64: 12>¶

Int64Array = <Type.Int64Array: 13>¶

IntArray = <Type.IntArray: 11>¶

InvalidType = <Type.InvalidType: 126>¶

Matrix = <Type.Matrix: 116>¶

Matrix2d = <Type.Matrix2d: 52>¶

Matrix2dArray = <Type.Matrix2dArray: 53>¶

Matrix3d = <Type.Matrix3d: 54>¶

Matrix3dArray = <Type.Matrix3dArray: 55>¶

Matrix4d = <Type.Matrix4d: 56>¶

Matrix4dArray = <Type.Matrix4dArray: 57>¶

MatrixArray = <Type.MatrixArray: 117>¶

Normal = <Type.Normal: 80>¶

Normal3d = <Type.Normal3d: 86>¶

Normal3dArray = <Type.Normal3dArray: 87>¶

Normal3f = <Type.Normal3f: 84>¶

Normal3fArray = <Type.Normal3fArray: 85>¶

Normal3h = <Type.Normal3h: 82>¶

Normal3hArray = <Type.Normal3hArray: 83>¶

NormalArray = <Type.NormalArray: 81>¶

Point = <Type.Point: 88>¶

Point3d = <Type.Point3d: 94>¶

Point3dArray = <Type.Point3dArray: 95>¶

Point3f = <Type.Point3f: 92>¶

Point3fArray = <Type.Point3fArray: 93>¶

Point3h = <Type.Point3h: 90>¶

Point3hArray = <Type.Point3hArray: 91>¶

PointArray = <Type.PointArray: 89>¶

Quatd = <Type.Quatd: 62>¶

QuatdArray = <Type.QuatdArray: 63>¶

Quatf = <Type.Quatf: 60>¶

QuatfArray = <Type.QuatfArray: 61>¶

Quath = <Type.Quath: 58>¶

QuathArray = <Type.QuathArray: 59>¶

STRING_DATA = <DataType.STRING_DATA: 0>¶

String = <Type.String: 0>¶

StringArray = <Type.StringArray: 1>¶

Struct = <Type.Struct: 120>¶

StructArray = <Type.StructArray: 121>¶

TOKEN_DATA = <DataType.TOKEN_DATA: 1>¶

Terminal = <Type.Terminal: 122>¶

TerminalArray = <Type.TerminalArray: 123>¶

TexCoord2d = <Type.TexCoord2d: 108>¶

TexCoord2dArray = <Type.TexCoord2dArray: 109>¶

TexCoord2f = <Type.TexCoord2f: 106>¶

TexCoord2fArray = <Type.TexCoord2fArray: 107>¶

TexCoord2h = <Type.TexCoord2h: 104>¶

TexCoord2hArray = <Type.TexCoord2hArray: 105>¶

TexCoord3d = <Type.TexCoord3d: 114>¶

TexCoord3dArray = <Type.TexCoord3dArray: 115>¶

TexCoord3f = <Type.TexCoord3f: 112>¶

TexCoord3fArray = <Type.TexCoord3fArray: 113>¶

TexCoord3h = <Type.TexCoord3h: 110>¶

TexCoord3hArray = <Type.TexCoord3hArray: 111>¶

TimeCode = <Type.TimeCode: 26>¶

TimeCodeArray = <Type.TimeCodeArray: 27>¶

Token = <Type.Token: 2>¶

TokenArray = <Type.TokenArray: 3>¶

class Type¶

Bases: pybind11_object

Members:

String

StringArray

Token

TokenArray

AssetPath

AssetPathArray

Bool

BoolArray

Int

IntArray

Int64

Int64Array

UChar

UCharArray

UInt

UIntArray

UInt64

UInt64Array

Half

HalfArray

Float

FloatArray

Double

DoubleArray

TimeCode

TimeCodeArray

Int2

Int2Array

Half2

Half2Array

Float2

Float2Array

Double2

Double2Array

Int3

Int3Array

Half3

Half3Array

Float3

Float3Array

Double3

Double3Array

Int4

Int4Array

Half4

Half4Array

Float4

Float4Array

Double4

Double4Array

Matrix2d

Matrix2dArray

Matrix3d

Matrix3dArray

Matrix4d

Matrix4dArray

Quath

QuathArray

Quatf

QuatfArray

Quatd

QuatdArray

Channel

ChannelArray

Color

ColorArray

Color3h

Color3hArray

Color3f

Color3fArray

Color3d

Color3dArray

Color4h

Color4hArray

Color4f

Color4fArray

Color4d

Color4dArray

Normal

NormalArray

Normal3h

Normal3hArray

Normal3f

Normal3fArray

Normal3d

Normal3dArray

Point

PointArray

Point3h

Point3hArray

Point3f

Point3fArray

Point3d

Point3dArray

Vector

VectorArray

Vector3h

Vector3hArray

Vector3f

Vector3fArray

Vector3d

Vector3dArray

TexCoord2h

TexCoord2hArray

TexCoord2f

TexCoord2fArray

TexCoord2d

TexCoord2dArray

TexCoord3h

TexCoord3hArray

TexCoord3f

TexCoord3fArray

TexCoord3d

TexCoord3dArray

Matrix

MatrixArray

Frame4d

Frame4dArray

Struct

StructArray

Terminal

TerminalArray

Vstruct

VstructArray

InvalidType

AssetPath = <Type.AssetPath: 6>¶

AssetPathArray = <Type.AssetPathArray: 7>¶

Bool = <Type.Bool: 8>¶

BoolArray = <Type.BoolArray: 9>¶

Channel = <Type.Channel: 64>¶

ChannelArray = <Type.ChannelArray: 65>¶

Color = <Type.Color: 66>¶

Color3d = <Type.Color3d: 72>¶

Color3dArray = <Type.Color3dArray: 73>¶

Color3f = <Type.Color3f: 70>¶

Color3fArray = <Type.Color3fArray: 71>¶

Color3h = <Type.Color3h: 68>¶

Color3hArray = <Type.Color3hArray: 69>¶

Color4d = <Type.Color4d: 78>¶

Color4dArray = <Type.Color4dArray: 79>¶

Color4f = <Type.Color4f: 76>¶

Color4fArray = <Type.Color4fArray: 77>¶

Color4h = <Type.Color4h: 74>¶

Color4hArray = <Type.Color4hArray: 75>¶

ColorArray = <Type.ColorArray: 67>¶

Double = <Type.Double: 24>¶

Double2 = <Type.Double2: 34>¶

Double2Array = <Type.Double2Array: 35>¶

Double3 = <Type.Double3: 42>¶

Double3Array = <Type.Double3Array: 43>¶

Double4 = <Type.Double4: 50>¶

Double4Array = <Type.Double4Array: 51>¶

DoubleArray = <Type.DoubleArray: 25>¶

Float = <Type.Float: 22>¶

Float2 = <Type.Float2: 32>¶

Float2Array = <Type.Float2Array: 33>¶

Float3 = <Type.Float3: 40>¶

Float3Array = <Type.Float3Array: 41>¶

Float4 = <Type.Float4: 48>¶

Float4Array = <Type.Float4Array: 49>¶

FloatArray = <Type.FloatArray: 23>¶

Frame4d = <Type.Frame4d: 118>¶

Frame4dArray = <Type.Frame4dArray: 119>¶

Half = <Type.Half: 20>¶

Half2 = <Type.Half2: 30>¶

Half2Array = <Type.Half2Array: 31>¶

Half3 = <Type.Half3: 38>¶

Half3Array = <Type.Half3Array: 39>¶

Half4 = <Type.Half4: 46>¶

Half4Array = <Type.Half4Array: 47>¶

HalfArray = <Type.HalfArray: 21>¶

Int = <Type.Int: 10>¶

Int2 = <Type.Int2: 28>¶

Int2Array = <Type.Int2Array: 29>¶

Int3 = <Type.Int3: 36>¶

Int3Array = <Type.Int3Array: 37>¶

Int4 = <Type.Int4: 44>¶

Int4Array = <Type.Int4Array: 45>¶

Int64 = <Type.Int64: 12>¶

Int64Array = <Type.Int64Array: 13>¶

IntArray = <Type.IntArray: 11>¶

InvalidType = <Type.InvalidType: 126>¶

Matrix = <Type.Matrix: 116>¶

Matrix2d = <Type.Matrix2d: 52>¶

Matrix2dArray = <Type.Matrix2dArray: 53>¶

Matrix3d = <Type.Matrix3d: 54>¶

Matrix3dArray = <Type.Matrix3dArray: 55>¶

Matrix4d = <Type.Matrix4d: 56>¶

Matrix4dArray = <Type.Matrix4dArray: 57>¶

MatrixArray = <Type.MatrixArray: 117>¶

Normal = <Type.Normal: 80>¶

Normal3d = <Type.Normal3d: 86>¶

Normal3dArray = <Type.Normal3dArray: 87>¶

Normal3f = <Type.Normal3f: 84>¶

Normal3fArray = <Type.Normal3fArray: 85>¶

Normal3h = <Type.Normal3h: 82>¶

Normal3hArray = <Type.Normal3hArray: 83>¶

NormalArray = <Type.NormalArray: 81>¶

Point = <Type.Point: 88>¶

Point3d = <Type.Point3d: 94>¶

Point3dArray = <Type.Point3dArray: 95>¶

Point3f = <Type.Point3f: 92>¶

Point3fArray = <Type.Point3fArray: 93>¶

Point3h = <Type.Point3h: 90>¶

Point3hArray = <Type.Point3hArray: 91>¶

PointArray = <Type.PointArray: 89>¶

Quatd = <Type.Quatd: 62>¶

QuatdArray = <Type.QuatdArray: 63>¶

Quatf = <Type.Quatf: 60>¶

QuatfArray = <Type.QuatfArray: 61>¶

Quath = <Type.Quath: 58>¶

QuathArray = <Type.QuathArray: 59>¶

String = <Type.String: 0>¶

StringArray = <Type.StringArray: 1>¶

Struct = <Type.Struct: 120>¶

StructArray = <Type.StructArray: 121>¶

Terminal = <Type.Terminal: 122>¶

TerminalArray = <Type.TerminalArray: 123>¶

TexCoord2d = <Type.TexCoord2d: 108>¶

TexCoord2dArray = <Type.TexCoord2dArray: 109>¶

TexCoord2f = <Type.TexCoord2f: 106>¶

TexCoord2fArray = <Type.TexCoord2fArray: 107>¶

TexCoord2h = <Type.TexCoord2h: 104>¶

TexCoord2hArray = <Type.TexCoord2hArray: 105>¶

TexCoord3d = <Type.TexCoord3d: 114>¶

TexCoord3dArray = <Type.TexCoord3dArray: 115>¶

TexCoord3f = <Type.TexCoord3f: 112>¶

TexCoord3fArray = <Type.TexCoord3fArray: 113>¶

TexCoord3h = <Type.TexCoord3h: 110>¶

TexCoord3hArray = <Type.TexCoord3hArray: 111>¶

TimeCode = <Type.TimeCode: 26>¶

TimeCodeArray = <Type.TimeCodeArray: 27>¶

Token = <Type.Token: 2>¶

TokenArray = <Type.TokenArray: 3>¶

UChar = <Type.UChar: 14>¶

UCharArray = <Type.UCharArray: 15>¶

UInt = <Type.UInt: 16>¶

UInt64 = <Type.UInt64: 18>¶

UInt64Array = <Type.UInt64Array: 19>¶

UIntArray = <Type.UIntArray: 17>¶

Vector = <Type.Vector: 96>¶

Vector3d = <Type.Vector3d: 102>¶

Vector3dArray = <Type.Vector3dArray: 103>¶

Vector3f = <Type.Vector3f: 100>¶

Vector3fArray = <Type.Vector3fArray: 101>¶

Vector3h = <Type.Vector3h: 98>¶

Vector3hArray = <Type.Vector3hArray: 99>¶

VectorArray = <Type.VectorArray: 97>¶

Vstruct = <Type.Vstruct: 124>¶

VstructArray = <Type.VstructArray: 125>¶

__init__(value: int) → None¶

baseDataType() → usg._usg.Value.DataType¶

baseType() → usg._usg.Value.Type¶

name()¶

__str__(*args, **kwargs) Overloaded function.

__str__(self: usg._usg.Value.Type) -> str
__str__(self: handle) -> str

property value¶

UChar = <Type.UChar: 14>¶

UCharArray = <Type.UCharArray: 15>¶

UInt = <Type.UInt: 16>¶

UInt64 = <Type.UInt64: 18>¶

UInt64Array = <Type.UInt64Array: 19>¶

UIntArray = <Type.UIntArray: 17>¶

Vector = <Type.Vector: 96>¶

Vector3d = <Type.Vector3d: 102>¶

Vector3dArray = <Type.Vector3dArray: 103>¶

Vector3f = <Type.Vector3f: 100>¶

Vector3fArray = <Type.Vector3fArray: 101>¶

Vector3h = <Type.Vector3h: 98>¶

Vector3hArray = <Type.Vector3hArray: 99>¶

VectorArray = <Type.VectorArray: 97>¶

Vstruct = <Type.Vstruct: 124>¶

VstructArray = <Type.VstructArray: 125>¶

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: usg._usg.Value, data: object, type: usg::Value::Type) -> None

Create a Value of the Value type specified by the type argument with given data. This method only supports the Types which are implicitly cast, all other types should use the default single argument constructor. The Types this method supports are: UChar, Bool, Int, Int64, UInt, UInt64, Float, Double. Will return an invalid value if the cast failed or the type is not supported.
__init__(self: usg._usg.Value, data: str) -> None

Create a Value of type String with given data.
__init__(self: usg._usg.Value, data: usg._usg.Token) -> None

Create a Value of type Token with given input data.
__init__(self: usg._usg.Value, arg0: usg._usg.AssetPath) -> None

Create a Value of type AssetPath with given input data.
__init__(self: usg._usg.Value, arg0: usg._usg.Path) -> None

Create a Value of type Path with given input data.
__init__(self: usg._usg.Value, data: std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >) -> None

Create a Value of type StringArray with given input data.
__init__(self: usg._usg.Value, data: usg::Array<usg::Token>) -> None

Create a Value of type TokenArray with given input data.
__init__(self: usg._usg.Value, data: bool) -> None

Create a Value of type Bool with given input data.
__init__(self: usg._usg.Value, data: int) -> None

Create a Value of type Int with given input data.
__init__(self: usg._usg.Value, data: usg::Array<int>) -> None

Create a Value of type IntArray with given input data.
__init__(self: usg._usg.Value, data: usg::Array<long>) -> None

Create a Value of type Int64Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<unsigned int>) -> None

Create a Value of type UIntArray with given input data.
__init__(self: usg._usg.Value, data: usg::Array<unsigned long>) -> None

Create a Value of type UInt64Array with given input data.
__init__(self: usg._usg.Value, data: fdk::half) -> None

Create a Value of type half with given input data.
__init__(self: usg._usg.Value, data: float) -> None

Create a Value of type Double with given input data.
__init__(self: usg._usg.Value, data: usg::Array<float>) -> None

Create a Value of type FloatArray with given input data.
__init__(self: usg._usg.Value, data: usg::Array<double>) -> None

Create a Value of type DoubleArray with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec2<fdk::half>) -> None

Create a Value of type Half2 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec2<float>) -> None

Create a Value of type Float2 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec2<double>) -> None

Create a Value of type Double2 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec2<int>) -> None

Create a Value of type Int2 with given data.
__init__(self: usg._usg.Value, data: fdk::Vec3<fdk::half>) -> None

Create a Value of type Half3 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec3<float>) -> None

Create a Value of type Float3 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec3<double>) -> None

Create a Value of type Double3 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec3<int>) -> None

Create a Value of type Int3 with given data.
__init__(self: usg._usg.Value, data: fdk::Vec4<fdk::half>) -> None

Create a Value of type Half4 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec4<float>) -> None

Create a Value of type Float4 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec4<double>) -> None

Create a Value of type Double4 with given input data.
__init__(self: usg._usg.Value, data: fdk::Vec4<int>) -> None

Create a Value of type Int4 with given data.
__init__(self: usg._usg.Value, data: fdk::Quat<fdk::half>) -> None

Create a Value of type Quath with given data.
__init__(self: usg._usg.Value, data: fdk::Quat<float>) -> None

Create a Value of type Quatf with given input data.
__init__(self: usg._usg.Value, data: fdk::Quat<double>) -> None

Create a Value of type Quatd with given input data.
__init__(self: usg._usg.Value, data: fdk::Mat4<double>) -> None

Create a Value of type Matrix4d with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec2<fdk::half> >) -> None

Create a Value of type Half2Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec2<float> >) -> None

Create a Value of type Float2Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec2<double> >) -> None

Create a Value of type Double2Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec2<int> >) -> None

Create a Value of type Int2Array with given data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec3<fdk::half> >) -> None

Create a Value of type Half3Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec3<float> >) -> None

Create a Value of type Float3Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec3<double> >) -> None

Create a Value of type Double3Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec3<int> >) -> None

Create a Value of type Int3Array with given data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec4<fdk::half> >) -> None

Create a Value of type Half4Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec4<float> >) -> None

Create a Value of type Float4Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec4<double> >) -> None

Create a Value of type Double4Array with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Vec4<int> >) -> None

Create a Value of type Int4Array with given data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Quat<fdk::half> >) -> None

Create a Value of type QuathArray with given data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Quat<float> >) -> None

Create a Value of type QuatfArray with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Quat<double> >) -> None

Create a Value of type QuatdArray with given input data.
__init__(self: usg._usg.Value, data: usg::Array<fdk::Mat4<double> >) -> None

Create a Value of type Matrix4dArray with given input data.

get() → object¶: Return value of Value as a python type.

getBaseDataType() → usg::Value::DataType¶: Return the base data type for this Value.

getNumDataElements() → int¶: Return the number of data elements for the Type. For example, 3 for a Vector3 or 16 for a Matrix4. 0 is returned if Value is not valid.

getSize() → int¶: Return the number of values in the Value. 0 is returned if Value not valid. 1 is returned if Value is not an array type, otherwise array size is returned.

getType() → usg::Value::Type¶: Return a usg.Value.Type of the type name stored in the value.

isArray() → bool¶: Return true if Value is valid and an array.

isValid() → bool¶: Return true if Value is valid.

Utils¶

Utility functions

usg.utils.GetConcreteSchemaTypeNames() → usg._usg.StringArray¶: Returns a usg.StringArray of the all the registered Concrete Schema. Will load any associated plugin to discover the total set available in the current USD session.

usg.utils.GetAPISchemaTypeNames() → usg._usg.StringArray¶: Returns a usg.StringArray of the all the registered API Schema types. Will load any associated plugin to discover the total set available in the current USD session.

usg.utils.GetSchemaTfTypeNames() → usg._usg.StringArray¶: Returns a usg.StringArray of the all the registered Schema types. Will load any associated plugin to discover the total set available in the current USD session.

usg.utils.GetDefaultAttributesForType(arg0: usg._usg.Token) → usg._usg.AttributeArray¶: Returns a list of usg.Attributes defined for the a provided name of a Concrete Type

usg.utils.GetDefaultAttributesForAPISchema(arg0: usg._usg.Token) → usg._usg.AttributeArray¶: Returns a list of usg.Attributes defined for the a provided name of an APISchema

usg.utils.GetDefaultRelationshipsForType(arg0: usg._usg.Token) → usg._usg.RelationshipArray¶: Returns a list of usg.Relationships defined for the a provided name of a Concrete Type

usg.utils.GetDefaultRelationshipsForAPISchema(arg0: usg._usg.Token) → usg._usg.RelationshipArray¶: Returns a list of usg.Relationships defined for the a provided name of an APISchema