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.

  1. 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.

  2. 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.

  3. 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.

  1. 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.

  2. 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.

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

  2. __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.

  1. __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.

  2. __init__(self: usg._usg.Value, data: str) -> None

    Create a Value of type String with given data.

  3. __init__(self: usg._usg.Value, data: usg._usg.Token) -> None

    Create a Value of type Token with given input data.

  4. __init__(self: usg._usg.Value, arg0: usg._usg.AssetPath) -> None

    Create a Value of type AssetPath with given input data.

  5. __init__(self: usg._usg.Value, arg0: usg._usg.Path) -> None

    Create a Value of type Path with given input data.

  6. __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.

  7. __init__(self: usg._usg.Value, data: usg::Array<usg::Token>) -> None

    Create a Value of type TokenArray with given input data.

  8. __init__(self: usg._usg.Value, data: bool) -> None

    Create a Value of type Bool with given input data.

  9. __init__(self: usg._usg.Value, data: int) -> None

    Create a Value of type Int with given input data.

  10. __init__(self: usg._usg.Value, data: usg::Array<int>) -> None

    Create a Value of type IntArray with given input data.

  11. __init__(self: usg._usg.Value, data: usg::Array<long>) -> None

    Create a Value of type Int64Array with given input data.

  12. __init__(self: usg._usg.Value, data: usg::Array<unsigned int>) -> None

    Create a Value of type UIntArray with given input data.

  13. __init__(self: usg._usg.Value, data: usg::Array<unsigned long>) -> None

    Create a Value of type UInt64Array with given input data.

  14. __init__(self: usg._usg.Value, data: fdk::half) -> None

    Create a Value of type half with given input data.

  15. __init__(self: usg._usg.Value, data: float) -> None

    Create a Value of type Double with given input data.

  16. __init__(self: usg._usg.Value, data: usg::Array<float>) -> None

    Create a Value of type FloatArray with given input data.

  17. __init__(self: usg._usg.Value, data: usg::Array<double>) -> None

    Create a Value of type DoubleArray with given input data.

  18. __init__(self: usg._usg.Value, data: fdk::Vec2<fdk::half>) -> None

    Create a Value of type Half2 with given input data.

  19. __init__(self: usg._usg.Value, data: fdk::Vec2<float>) -> None

    Create a Value of type Float2 with given input data.

  20. __init__(self: usg._usg.Value, data: fdk::Vec2<double>) -> None

    Create a Value of type Double2 with given input data.

  21. __init__(self: usg._usg.Value, data: fdk::Vec2<int>) -> None

    Create a Value of type Int2 with given data.

  22. __init__(self: usg._usg.Value, data: fdk::Vec3<fdk::half>) -> None

    Create a Value of type Half3 with given input data.

  23. __init__(self: usg._usg.Value, data: fdk::Vec3<float>) -> None

    Create a Value of type Float3 with given input data.

  24. __init__(self: usg._usg.Value, data: fdk::Vec3<double>) -> None

    Create a Value of type Double3 with given input data.

  25. __init__(self: usg._usg.Value, data: fdk::Vec3<int>) -> None

    Create a Value of type Int3 with given data.

  26. __init__(self: usg._usg.Value, data: fdk::Vec4<fdk::half>) -> None

    Create a Value of type Half4 with given input data.

  27. __init__(self: usg._usg.Value, data: fdk::Vec4<float>) -> None

    Create a Value of type Float4 with given input data.

  28. __init__(self: usg._usg.Value, data: fdk::Vec4<double>) -> None

    Create a Value of type Double4 with given input data.

  29. __init__(self: usg._usg.Value, data: fdk::Vec4<int>) -> None

    Create a Value of type Int4 with given data.

  30. __init__(self: usg._usg.Value, data: fdk::Quat<fdk::half>) -> None

    Create a Value of type Quath with given data.

  31. __init__(self: usg._usg.Value, data: fdk::Quat<float>) -> None

    Create a Value of type Quatf with given input data.

  32. __init__(self: usg._usg.Value, data: fdk::Quat<double>) -> None

    Create a Value of type Quatd with given input data.

  33. __init__(self: usg._usg.Value, data: fdk::Mat4<double>) -> None

    Create a Value of type Matrix4d with given input data.

  34. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec2<fdk::half> >) -> None

    Create a Value of type Half2Array with given input data.

  35. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec2<float> >) -> None

    Create a Value of type Float2Array with given input data.

  36. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec2<double> >) -> None

    Create a Value of type Double2Array with given input data.

  37. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec2<int> >) -> None

    Create a Value of type Int2Array with given data.

  38. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec3<fdk::half> >) -> None

    Create a Value of type Half3Array with given input data.

  39. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec3<float> >) -> None

    Create a Value of type Float3Array with given input data.

  40. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec3<double> >) -> None

    Create a Value of type Double3Array with given input data.

  41. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec3<int> >) -> None

    Create a Value of type Int3Array with given data.

  42. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec4<fdk::half> >) -> None

    Create a Value of type Half4Array with given input data.

  43. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec4<float> >) -> None

    Create a Value of type Float4Array with given input data.

  44. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec4<double> >) -> None

    Create a Value of type Double4Array with given input data.

  45. __init__(self: usg._usg.Value, data: usg::Array<fdk::Vec4<int> >) -> None

    Create a Value of type Int4Array with given data.

  46. __init__(self: usg._usg.Value, data: usg::Array<fdk::Quat<fdk::half> >) -> None

    Create a Value of type QuathArray with given data.

  47. __init__(self: usg._usg.Value, data: usg::Array<fdk::Quat<float> >) -> None

    Create a Value of type QuatfArray with given input data.

  48. __init__(self: usg._usg.Value, data: usg::Array<fdk::Quat<double> >) -> None

    Create a Value of type QuatdArray with given input data.

  49. __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

Other Prims

class usg.BasisCurvesPrim

Bases: CurvesPrim

__init__(arg0: usg._usg.Prim) None
createBasisAttr(arg0: usg._usg.Value) usg._usg.Attribute
createTypeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createWrapAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.BasisCurvesPrim
getBasis(time: float = nan) usg._usg.Token
getBasisAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.BasisCurvesPrim
getType(time: float = nan) usg._usg.Token
getTypeAttr() usg._usg.Attribute
getWrap(time: float = nan) usg._usg.Token
getWrapAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.BasisCurvesPrim
setBasis(value: usg._usg.Token, time: float = nan) None
setType(value: usg._usg.Token, time: float = nan) None
setWrap(value: usg._usg.Token, time: float = nan) None
class usg.BoundablePrim

Bases: XformablePrim

__init__(arg0: usg._usg.Prim) None
createExtentAttr(arg0: usg._usg.Value) usg._usg.Attribute
getExtent(time: float = nan) usg._usg.Vec3fArray
getExtentAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.BoundablePrim
overrideInLayer(arg0: usg._usg.Prim) usg._usg.BoundablePrim
setExtent(value: usg._usg.Vec3fArray, time: float = nan) None
class usg.CameraPrim

Bases: XformablePrim

__init__(arg0: usg._usg.Prim) None
createClippingPlanesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createClippingRangeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createCloseAttr(arg0: usg._usg.Value) usg._usg.Attribute
createExposureAttr(arg0: usg._usg.Value) usg._usg.Attribute
createFStopAttr(arg0: usg._usg.Value) usg._usg.Attribute
createFocalLengthAttr(arg0: usg._usg.Value) usg._usg.Attribute
createFocusDistanceAttr(arg0: usg._usg.Value) usg._usg.Attribute
createHorizontalApertureAttr(arg0: usg._usg.Value) usg._usg.Attribute
createHorizontalApertureOffsetAttr(arg0: usg._usg.Value) usg._usg.Attribute
createOpenAttr(arg0: usg._usg.Value) usg._usg.Attribute
createProjectionAttr(arg0: usg._usg.Value) usg._usg.Attribute
createStereoRoleAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVerticalApertureAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVerticalApertureOffsetAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.CameraPrim
getClippingPlanes(time: float = nan) usg._usg.Vec4fArray
getClippingPlanesAttr() usg._usg.Attribute
getClippingRange(time: float = nan) usg._usg.Vec2f
getClippingRangeAttr() usg._usg.Attribute
getClose(time: float = nan) float
getCloseAttr() usg._usg.Attribute
getExposure(time: float = nan) float
getExposureAttr() usg._usg.Attribute
getFStop(time: float = nan) float
getFStopAttr() usg._usg.Attribute
getFocalLength(time: float = nan) float
getFocalLengthAttr() usg._usg.Attribute
getFocusDistance(time: float = nan) float
getFocusDistanceAttr() usg._usg.Attribute
getHorizontalAperture(time: float = nan) float
getHorizontalApertureAttr() usg._usg.Attribute
getHorizontalApertureOffset(time: float = nan) float
getHorizontalApertureOffsetAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.CameraPrim
getOpen(time: float = nan) float
getOpenAttr() usg._usg.Attribute
getProjection(time: float = nan) usg._usg.Token
getProjectionAttr() usg._usg.Attribute
getStereoRole(time: float = nan) usg._usg.Token
getStereoRoleAttr() usg._usg.Attribute
getVerticalAperture(time: float = nan) float
getVerticalApertureAttr() usg._usg.Attribute
getVerticalApertureOffset(time: float = nan) float
getVerticalApertureOffsetAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.CameraPrim
setClippingPlanes(value: usg._usg.Vec4fArray, time: float = nan) None
setClippingRange(value: usg._usg.Vec2f, time: float = nan) None
setClose(value: float, time: float = nan) None
setExposure(value: float, time: float = nan) None
setFStop(value: float, time: float = nan) None
setFocalLength(value: float, time: float = nan) None
setFocusDistance(value: float, time: float = nan) None
setHorizontalAperture(value: float, time: float = nan) None
setHorizontalApertureOffset(value: float, time: float = nan) None
setOpen(value: float, time: float = nan) None
setProjection(value: usg._usg.Token, time: float = nan) None
setStereoRole(value: usg._usg.Token, time: float = nan) None
setVerticalAperture(value: float, time: float = nan) None
setVerticalApertureOffset(value: float, time: float = nan) None
class usg.CapsulePrim

Bases: GprimPrim

__init__(arg0: usg._usg.Prim) None
createAxisAttr(arg0: usg._usg.Value) usg._usg.Attribute
createHeightAttr(arg0: usg._usg.Value) usg._usg.Attribute
createRadiusAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.CapsulePrim
getAxis(time: float = nan) usg._usg.Token
getAxisAttr() usg._usg.Attribute
getHeight(time: float = nan) float
getHeightAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.CapsulePrim
getRadius(time: float = nan) float
getRadiusAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.CapsulePrim
setAxis(value: usg._usg.Token, time: float = nan) None
setHeight(value: float, time: float = nan) None
setRadius(value: float, time: float = nan) None
class usg.ConePrim

Bases: GprimPrim

__init__(arg0: usg._usg.Prim) None
createAxisAttr(arg0: usg._usg.Value) usg._usg.Attribute
createHeightAttr(arg0: usg._usg.Value) usg._usg.Attribute
createRadiusAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.ConePrim
getAxis(time: float = nan) usg._usg.Token
getAxisAttr() usg._usg.Attribute
getHeight(time: float = nan) float
getHeightAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.ConePrim
getRadius(time: float = nan) float
getRadiusAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.ConePrim
setAxis(value: usg._usg.Token, time: float = nan) None
setHeight(value: float, time: float = nan) None
setRadius(value: float, time: float = nan) None
class usg.CubePrim

Bases: GprimPrim

__init__(arg0: usg._usg.Prim) None
createSizeAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.CubePrim
getInStage(arg0: usg._usg.Path) usg._usg.CubePrim
getSize(time: float = nan) float
getSizeAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.CubePrim
setSize(value: float, time: float = nan) None
class usg.CurvesPrim

Bases: PointBasedPrim

__init__(arg0: usg._usg.Prim) None
createCurveVertexCountsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createWidthsAttr(arg0: usg._usg.Value) usg._usg.Attribute
getCurveVertexCounts(time: float = nan) usg._usg.IntArray
getCurveVertexCountsAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.CurvesPrim
getWidths(time: float = nan) usg._usg.FloatArray
getWidthsAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.CurvesPrim
setCurveVertexCounts(value: usg._usg.IntArray, time: float = nan) None
setWidths(value: usg._usg.FloatArray, time: float = nan) None
class usg.CylinderPrim

Bases: GprimPrim

__init__(arg0: usg._usg.Prim) None
createAxisAttr(arg0: usg._usg.Value) usg._usg.Attribute
createHeightAttr(arg0: usg._usg.Value) usg._usg.Attribute
createRadiusAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.CylinderPrim
getAxis(time: float = nan) usg._usg.Token
getAxisAttr() usg._usg.Attribute
getHeight(time: float = nan) float
getHeightAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.CylinderPrim
getRadius(time: float = nan) float
getRadiusAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.CylinderPrim
setAxis(value: usg._usg.Token, time: float = nan) None
setHeight(value: float, time: float = nan) None
setRadius(value: float, time: float = nan) None
class usg.GeomSubsetPrim

Bases: pybind11_object

__init__(arg0: usg._usg.Prim) None
createElementTypeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createFamilyNameAttr(arg0: usg._usg.Value) usg._usg.Attribute
createIndicesAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.GeomSubsetPrim
getElementType(time: float = nan) usg._usg.Token
getElementTypeAttr() usg._usg.Attribute
getFamilyName(time: float = nan) usg._usg.Token
getFamilyNameAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.GeomSubsetPrim
getIndices(time: float = nan) usg._usg.IntArray
getIndicesAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.GeomSubsetPrim
setElementType(value: usg._usg.Token, time: float = nan) None
setFamilyName(value: usg._usg.Token, time: float = nan) None
setIndices(value: usg._usg.IntArray, time: float = nan) None
class usg.GprimPrim

Bases: BoundablePrim

__init__(arg0: usg._usg.Prim) None
createDisplayColorAttr(arg0: usg._usg.Value) usg._usg.Attribute
createDisplayOpacityAttr(arg0: usg._usg.Value) usg._usg.Attribute
createDoubleSidedAttr(arg0: usg._usg.Value) usg._usg.Attribute
createOrientationAttr(arg0: usg._usg.Value) usg._usg.Attribute
getDisplayColor(time: float = nan) usg._usg.Vec3fArray
getDisplayColorAttr() usg._usg.Attribute
getDisplayOpacity(time: float = nan) usg._usg.FloatArray
getDisplayOpacityAttr() usg._usg.Attribute
getDoubleSided(time: float = nan) bool
getDoubleSidedAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.GprimPrim
getOrientation(time: float = nan) usg._usg.Token
getOrientationAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.GprimPrim
setDisplayColor(value: usg._usg.Vec3fArray, time: float = nan) None
setDisplayOpacity(value: usg._usg.FloatArray, time: float = nan) None
setDoubleSided(value: bool, time: float = nan) None
setOrientation(value: usg._usg.Token, time: float = nan) None
class usg.HermiteCurvesPrim

Bases: CurvesPrim

__init__(arg0: usg._usg.Prim) None
createTangentsAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.HermiteCurvesPrim
getInStage(arg0: usg._usg.Path) usg._usg.HermiteCurvesPrim
getTangents(time: float = nan) usg._usg.Vec3fArray
getTangentsAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.HermiteCurvesPrim
setTangents(value: usg._usg.Vec3fArray, time: float = nan) None
class usg.ImageablePrim

Bases: pybind11_object

__init__(arg0: usg._usg.Prim) None
createProxyPrimRel() usg._usg.Relationship
createPurposeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVisibilityAttr(arg0: usg._usg.Value) usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.ImageablePrim
getProxyPrimRel() usg._usg.Relationship
getPurpose(time: float = nan) usg._usg.Token
getPurposeAttr() usg._usg.Attribute
getVisibility(time: float = nan) usg._usg.Token
getVisibilityAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.ImageablePrim
setPurpose(value: usg._usg.Token, time: float = nan) None
setVisibility(value: usg._usg.Token, time: float = nan) None
class usg.MeshPrim

Bases: PointBasedPrim

__init__(arg0: usg._usg.Prim) None
createCornerIndicesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createCornerSharpnessesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createCreaseIndicesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createCreaseLengthsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createCreaseSharpnessesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createFaceVaryingLinearInterpolationAttr(arg0: usg._usg.Value) usg._usg.Attribute
createFaceVertexCountsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createFaceVertexIndicesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createHoleIndicesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createInterpolateBoundaryAttr(arg0: usg._usg.Value) usg._usg.Attribute
createSubdivisionSchemeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createTriangleSubdivisionRuleAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.MeshPrim
getCornerIndices(time: float = nan) usg._usg.IntArray
getCornerIndicesAttr() usg._usg.Attribute
getCornerSharpnesses(time: float = nan) usg._usg.FloatArray
getCornerSharpnessesAttr() usg._usg.Attribute
getCreaseIndices(time: float = nan) usg._usg.IntArray
getCreaseIndicesAttr() usg._usg.Attribute
getCreaseLengths(time: float = nan) usg._usg.IntArray
getCreaseLengthsAttr() usg._usg.Attribute
getCreaseSharpnesses(time: float = nan) usg._usg.FloatArray
getCreaseSharpnessesAttr() usg._usg.Attribute
getFaceVaryingLinearInterpolation(time: float = nan) usg._usg.Token
getFaceVaryingLinearInterpolationAttr() usg._usg.Attribute
getFaceVertexCounts(time: float = nan) usg._usg.IntArray
getFaceVertexCountsAttr() usg._usg.Attribute
getFaceVertexIndices(time: float = nan) usg._usg.IntArray
getFaceVertexIndicesAttr() usg._usg.Attribute
getHoleIndices(time: float = nan) usg._usg.IntArray
getHoleIndicesAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.MeshPrim
getInterpolateBoundary(time: float = nan) usg._usg.Token
getInterpolateBoundaryAttr() usg._usg.Attribute
getSubdivisionScheme(time: float = nan) usg._usg.Token
getSubdivisionSchemeAttr() usg._usg.Attribute
getTriangleSubdivisionRule(time: float = nan) usg._usg.Token
getTriangleSubdivisionRuleAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.MeshPrim
setCornerIndices(value: usg._usg.IntArray, time: float = nan) None
setCornerSharpnesses(value: usg._usg.FloatArray, time: float = nan) None
setCreaseIndices(value: usg._usg.IntArray, time: float = nan) None
setCreaseLengths(value: usg._usg.IntArray, time: float = nan) None
setCreaseSharpnesses(value: usg._usg.FloatArray, time: float = nan) None
setFaceVaryingLinearInterpolation(value: usg._usg.Token, time: float = nan) None
setFaceVertexCounts(value: usg._usg.IntArray, time: float = nan) None
setFaceVertexIndices(value: usg._usg.IntArray, time: float = nan) None
setHoleIndices(value: usg._usg.IntArray, time: float = nan) None
setInterpolateBoundary(value: usg._usg.Token, time: float = nan) None
setSubdivisionScheme(value: usg._usg.Token, time: float = nan) None
setTriangleSubdivisionRule(value: usg._usg.Token, time: float = nan) None
class usg.NurbsCurvesPrim

Bases: CurvesPrim

__init__(arg0: usg._usg.Prim) None
createKnotsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createOrderAttr(arg0: usg._usg.Value) usg._usg.Attribute
createRangesAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.NurbsCurvesPrim
getInStage(arg0: usg._usg.Path) usg._usg.NurbsCurvesPrim
getKnots(time: float = nan) usg._usg.DoubleArray
getKnotsAttr() usg._usg.Attribute
getOrder(time: float = nan) usg._usg.IntArray
getOrderAttr() usg._usg.Attribute
getRanges(time: float = nan) usg._usg.Vec2dArray
getRangesAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.NurbsCurvesPrim
setKnots(value: usg._usg.DoubleArray, time: float = nan) None
setOrder(value: usg._usg.IntArray, time: float = nan) None
setRanges(value: usg._usg.Vec2dArray, time: float = nan) None
class usg.NurbsPatchPrim

Bases: PointBasedPrim

__init__(arg0: usg._usg.Prim) None
createCountsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createKnotsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createOrdersAttr(arg0: usg._usg.Value) usg._usg.Attribute
createPointWeightsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createPointsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createRangesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createUFormAttr(arg0: usg._usg.Value) usg._usg.Attribute
createUKnotsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createUOrderAttr(arg0: usg._usg.Value) usg._usg.Attribute
createURangeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createUVertexCountAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVFormAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVKnotsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVOrderAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVRangeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVVertexCountAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVertexCountsAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.NurbsPatchPrim
getCounts(time: float = nan) usg._usg.IntArray
getCountsAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.NurbsPatchPrim
getKnots(time: float = nan) usg._usg.DoubleArray
getKnotsAttr() usg._usg.Attribute
getOrders(time: float = nan) usg._usg.IntArray
getOrdersAttr() usg._usg.Attribute
getPointWeights(time: float = nan) usg._usg.DoubleArray
getPointWeightsAttr() usg._usg.Attribute
getPoints(time: float = nan) usg._usg.Vec3dArray
getPointsAttr() usg._usg.Attribute
getRanges(time: float = nan) usg._usg.Vec2dArray
getRangesAttr() usg._usg.Attribute
getUForm(time: float = nan) usg._usg.Token
getUFormAttr() usg._usg.Attribute
getUKnots(time: float = nan) usg._usg.DoubleArray
getUKnotsAttr() usg._usg.Attribute
getUOrder(time: float = nan) int
getUOrderAttr() usg._usg.Attribute
getURange(time: float = nan) usg._usg.Vec2d
getURangeAttr() usg._usg.Attribute
getUVertexCount(time: float = nan) int
getUVertexCountAttr() usg._usg.Attribute
getVForm(time: float = nan) usg._usg.Token
getVFormAttr() usg._usg.Attribute
getVKnots(time: float = nan) usg._usg.DoubleArray
getVKnotsAttr() usg._usg.Attribute
getVOrder(time: float = nan) int
getVOrderAttr() usg._usg.Attribute
getVRange(time: float = nan) usg._usg.Vec2d
getVRangeAttr() usg._usg.Attribute
getVVertexCount(time: float = nan) int
getVVertexCountAttr() usg._usg.Attribute
getVertexCounts(time: float = nan) usg._usg.IntArray
getVertexCountsAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.NurbsPatchPrim
setCounts(value: usg._usg.IntArray, time: float = nan) None
setKnots(value: usg._usg.DoubleArray, time: float = nan) None
setOrders(value: usg._usg.IntArray, time: float = nan) None
setPointWeights(value: usg._usg.DoubleArray, time: float = nan) None
setPoints(value: usg._usg.Vec3dArray, time: float = nan) None
setRanges(value: usg._usg.Vec2dArray, time: float = nan) None
setUForm(value: usg._usg.Token, time: float = nan) None
setUKnots(value: usg._usg.DoubleArray, time: float = nan) None
setUOrder(value: int, time: float = nan) None
setURange(value: usg._usg.Vec2d, time: float = nan) None
setUVertexCount(value: int, time: float = nan) None
setVForm(value: usg._usg.Token, time: float = nan) None
setVKnots(value: usg._usg.DoubleArray, time: float = nan) None
setVOrder(value: int, time: float = nan) None
setVRange(value: usg._usg.Vec2d, time: float = nan) None
setVVertexCount(value: int, time: float = nan) None
setVertexCounts(value: usg._usg.IntArray, time: float = nan) None
class usg.PointBasedPrim

Bases: GprimPrim

__init__(arg0: usg._usg.Prim) None
createAccelerationsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createNormalsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createPointsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVelocitiesAttr(arg0: usg._usg.Value) usg._usg.Attribute
getAccelerations(time: float = nan) usg._usg.Vec3fArray
getAccelerationsAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.PointBasedPrim
getNormals(time: float = nan) usg._usg.Vec3fArray
getNormalsAttr() usg._usg.Attribute
getPoints(time: float = nan) usg._usg.Vec3fArray
getPointsAttr() usg._usg.Attribute
getVelocities(time: float = nan) usg._usg.Vec3fArray
getVelocitiesAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.PointBasedPrim
setAccelerations(value: usg._usg.Vec3fArray, time: float = nan) None
setNormals(value: usg._usg.Vec3fArray, time: float = nan) None
setPoints(value: usg._usg.Vec3fArray, time: float = nan) None
setVelocities(value: usg._usg.Vec3fArray, time: float = nan) None
class usg.PointInstancerPrim

Bases: BoundablePrim

__init__(arg0: usg._usg.Prim) None
createAccelerationsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createAngularVelocitiesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createIdsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createInvisibleIdsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createOrientationsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createPositionsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createProtoIndicesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createPrototypesRel() usg._usg.Relationship
createScalesAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVelocitiesAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.PointInstancerPrim
getAccelerations(time: float = nan) usg._usg.Vec3fArray
getAccelerationsAttr() usg._usg.Attribute
getAngularVelocities(time: float = nan) usg._usg.Vec3fArray
getAngularVelocitiesAttr() usg._usg.Attribute
getIds(time: float = nan) usg._usg.Int64Array
getIdsAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.PointInstancerPrim
getInvisibleIds(time: float = nan) usg._usg.Int64Array
getInvisibleIdsAttr() usg._usg.Attribute
getOrientations(time: float = nan) usg._usg.QuathArray
getOrientationsAttr() usg._usg.Attribute
getPositions(time: float = nan) usg._usg.Vec3fArray
getPositionsAttr() usg._usg.Attribute
getProtoIndices(time: float = nan) usg._usg.IntArray
getProtoIndicesAttr() usg._usg.Attribute
getPrototypesRel() usg._usg.Relationship
getScales(time: float = nan) usg._usg.Vec3fArray
getScalesAttr() usg._usg.Attribute
getVelocities(time: float = nan) usg._usg.Vec3fArray
getVelocitiesAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.PointInstancerPrim
setAccelerations(value: usg._usg.Vec3fArray, time: float = nan) None
setAngularVelocities(value: usg._usg.Vec3fArray, time: float = nan) None
setIds(value: usg._usg.Int64Array, time: float = nan) None
setInvisibleIds(value: usg._usg.Int64Array, time: float = nan) None
setOrientations(value: usg._usg.QuathArray, time: float = nan) None
setPositions(value: usg._usg.Vec3fArray, time: float = nan) None
setProtoIndices(value: usg._usg.IntArray, time: float = nan) None
setScales(value: usg._usg.Vec3fArray, time: float = nan) None
setVelocities(value: usg._usg.Vec3fArray, time: float = nan) None
class usg.PointsPrim

Bases: PointBasedPrim

__init__(arg0: usg._usg.Prim) None
createIdsAttr(arg0: usg._usg.Value) usg._usg.Attribute
createWidthsAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.PointsPrim
getIds(time: float = nan) usg._usg.Int64Array
getIdsAttr() usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.PointsPrim
getWidths(time: float = nan) usg._usg.FloatArray
getWidthsAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.PointsPrim
setIds(value: usg._usg.Int64Array, time: float = nan) None
setWidths(value: usg._usg.FloatArray, time: float = nan) None
class usg.ScopePrim

Bases: ImageablePrim

__init__(arg0: usg._usg.Prim) None
defineInLayer(arg0: usg._usg.Path) usg._usg.ScopePrim
getInStage(arg0: usg._usg.Path) usg._usg.ScopePrim
overrideInLayer(arg0: usg._usg.Prim) usg._usg.ScopePrim
class usg.SpherePrim

Bases: GprimPrim

__init__(arg0: usg._usg.Prim) None
createRadiusAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.SpherePrim
getInStage(arg0: usg._usg.Path) usg._usg.SpherePrim
getRadius(time: float = nan) float
getRadiusAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.SpherePrim
setRadius(value: float, time: float = nan) None
class usg.XformablePrim

Bases: ImageablePrim

__init__(arg0: usg._usg.Prim) None
createXformOpOrderAttr(arg0: usg._usg.Value) usg._usg.Attribute
getInStage(arg0: usg._usg.Path) usg._usg.XformablePrim
getXformOpOrder(time: float = nan) usg._usg.TokenArray
getXformOpOrderAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.XformablePrim
setXformOpOrder(value: usg._usg.TokenArray, time: float = nan) None
class usg.XformPrim

Bases: XformablePrim

__init__(arg0: usg._usg.Prim) None
defineInLayer(arg0: usg._usg.Path) usg._usg.XformPrim
getInStage(arg0: usg._usg.Path) usg._usg.XformPrim
overrideInLayer(arg0: usg._usg.Prim) usg._usg.XformPrim

Lux Prims

Classes dealing with lights

class usg.lux.BoundableLightBasePrim

Bases: pybind11_object

__init__(arg0: usg._usg.Prim) None
getInStage(arg0: usg._usg.Path) usg._usg.lux.BoundableLightBasePrim
overrideInLayer(arg0: usg._usg.Prim) usg._usg.lux.BoundableLightBasePrim
class usg.lux.CylinderLightPrim

Bases: BoundableLightBasePrim

__init__(arg0: usg._usg.Prim) None
createColorAttr(arg0: usg._usg.Value) usg._usg.Attribute
createColorTemperatureAttr(arg0: usg._usg.Value) usg._usg.Attribute
createDiffuseAttr(arg0: usg._usg.Value) usg._usg.Attribute
createEnableColorTemperatureAttr(arg0: usg._usg.Value) usg._usg.Attribute
createExposureAttr(arg0: usg._usg.Value) usg._usg.Attribute
createFiltersRel() usg._usg.Relationship
createIntensityAttr(arg0: usg._usg.Value) usg._usg.Attribute
createLengthAttr(arg0: usg._usg.Value) usg._usg.Attribute
createNormalizeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createProxyPrimRel() usg._usg.Relationship
createPurposeAttr(arg0: usg._usg.Value) usg._usg.Attribute
createRadiusAttr(arg0: usg._usg.Value) usg._usg.Attribute
createShaderIdAttr(arg0: usg._usg.Value) usg._usg.Attribute
createSpecularAttr(arg0: usg._usg.Value) usg._usg.Attribute
createTreatAsLineAttr(arg0: usg._usg.Value) usg._usg.Attribute
createVisibilityAttr(arg0: usg._usg.Value) usg._usg.Attribute
createXformOpOrderAttr(arg0: usg._usg.Value) usg._usg.Attribute
defineInLayer(arg0: usg._usg.Path) usg._usg.lux.CylinderLightPrim
getColor(time: float = nan) usg._usg.Vec3f
getColorAttr() usg._usg.Attribute
getColorTemperature(time: float = nan) float
getColorTemperatureAttr() usg._usg.Attribute
getDiffuse(time: float = nan) float
getDiffuseAttr() usg._usg.Attribute
getEnableColorTemperature(time: float = nan) bool
getEnableColorTemperatureAttr() usg._usg.Attribute
getExposure(time: float = nan) float
getExposureAttr() usg._usg.Attribute
getFiltersRel() usg._usg.Relationship
getInStage(arg0: usg._usg.Path) usg._usg.lux.CylinderLightPrim
getIntensity(time: float = nan) float
getIntensityAttr() usg._usg.Attribute
getLength(time: float = nan) float
getLengthAttr() usg._usg.Attribute
getNormalize(time: float = nan) bool
getNormalizeAttr() usg._usg.Attribute
getProxyPrimRel() usg._usg.Relationship
getPurpose(time: float = nan) usg._usg.Token
getPurposeAttr() usg._usg.Attribute
getRadius(time: float = nan) float
getRadiusAttr() usg._usg.Attribute
getShaderId(time: float = nan) usg._usg.Token
getShaderIdAttr() usg._usg.Attribute
getSpecular(time: float = nan) float
getSpecularAttr() usg._usg.Attribute
getTreatAsLine(time: float = nan) bool
getTreatAsLineAttr() usg._usg.Attribute
getVisibility(time: float = nan) usg._usg.Token
getVisibilityAttr() usg._usg.Attribute
getXformOpOrder(time: float = nan) usg._usg.TokenArray
getXformOpOrderAttr() usg._usg.Attribute
overrideInLayer(arg0: usg._usg.Prim) usg._usg.lux.CylinderLightPrim
setColor(value: usg._usg.Vec3f, time: float = nan) None
setColorTemperature(value: float, time: float = nan) None
setDiffuse(value: float, time: float = nan) None
setEnableColorTemperature(value: bool, time: float = nan) None
setExposure(value: float, time: float = nan) None
setIntensity(value: float, time: float = nan) None
setLength(value: float, time: float = nan) None
setNormalize(value: bool, time: float = nan) None
setPurpose(value: usg._usg.Token, time: float = nan) None
setRadius(value: float, time: float = nan) None
setShaderId(value: usg._usg.Token, time: float = nan) None
setSpecular(value: float, time: float = nan) None