pxr package

Ar module

class pxr.Ar.DefaultResolver

Bases: pxr.Ar.Resolver

Raises an exception This class cannot be instantiated from Python

static SetDefaultSearchPath()
class pxr.Ar.DefaultResolverContext

Bases: Boost.Python.instance

GetSearchPath()
class pxr.Ar.Resolver

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

AnchorRelativePath()
ConfigureResolverForAsset()
CreateDefaultContext()
CreateDefaultContextForAsset()
GetCurrentContext()
GetExtension()
IsRelativePath()
RefreshContext()
Resolve()
class pxr.Ar.ResolverContextBinder

Bases: Boost.Python.instance

class pxr.Ar.ResolverScopedCache

Bases: Boost.Python.instance

CameraUtil module

Camera utilities.

class pxr.CameraUtil.ConformWindowPolicy

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (CameraUtil.MatchVertically, CameraUtil.MatchHorizontally, CameraUtil.Fit, CameraUtil.Crop, CameraUtil.DontConform)
class pxr.CameraUtil.ScreenWindowParameters

Bases: Boost.Python.instance

property fieldOfView
property screenWindow
property zFacingViewMatrix

Garch module

garch

class pxr.Garch.GLPlatformDebugContext

Bases: Boost.Python.instance

property expired

True if this object has expired, False otherwise.

makeCurrent()

Gf module

Graphics Foundation This package defines classes for fundamental graphics types and operations.

class pxr.Gf.BBox3d

Bases: Boost.Python.instance

Arbitrarily oriented 3D bounding box

static Combine()
ComputeAlignedBox()
ComputeAlignedRange()
ComputeCentroid()
GetBox()
GetInverseMatrix()
GetMatrix()
GetRange()
GetVolume()
HasZeroAreaPrimitives()
Set()
SetHasZeroAreaPrimitives()
SetMatrix()
SetRange()
Transform()
property box
property hasZeroAreaPrimitives
property matrix
class pxr.Gf.Camera

Bases: Boost.Python.instance

APERTURE_UNIT = 0.1
DEFAULT_HORIZONTAL_APERTURE = 20.955
DEFAULT_VERTICAL_APERTURE = 15.290799999999999
FOCAL_LENGTH_UNIT = 0.1
class FOVDirection

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Gf.Camera.FOVHorizontal, Gf.Camera.FOVVertical)
FOVHorizontal = Gf.Camera.FOVHorizontal
FOVVertical = Gf.Camera.FOVVertical
GetFieldOfView()
Orthographic = Gf.Camera.Orthographic
Perspective = Gf.Camera.Perspective
class Projection

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Gf.Camera.Perspective, Gf.Camera.Orthographic)
SetOrthographicFromAspectRatioAndSize()
SetPerspectiveFromAspectRatioAndFieldOfView()
property aspectRatio
property clippingPlanes
property clippingRange
property fStop
property focalLength
property focusDistance
property frustum
property horizontalAperture
property horizontalApertureOffset
property horizontalFieldOfView
property projection
property transform
property verticalAperture
property verticalApertureOffset
property verticalFieldOfView
class pxr.Gf.Frustum

Bases: Boost.Python.instance

Basic view frustum

ComputeAspectRatio()
ComputeCorners()
ComputeCornersAtDistance()
ComputeLookAtPoint()
ComputeNarrowedFrustum()
ComputePickRay()
ComputeProjectionMatrix()
ComputeUpVector()
ComputeViewDirection()
ComputeViewFrame()
ComputeViewInverse()
ComputeViewMatrix()
FitToSphere()
GetFOV()

Returns the horizontal fov of the frustum. The fov of the frustum is not necessarily the same value as displayed in the viewer. The displayed fov is a function of the focal length or FOV avar. The frustum’s fov may be different due to things like lens breathing.

If the frustum is not of type GfFrustum::Perspective, the returned FOV will be 0.0.

GetNearFar()
GetOrthographic()
GetPerspective()

Returns the current perspective frustum values suitable for use by SetPerspective. If the current frustum is a perspective projection, the return value is a tuple of fieldOfView, aspectRatio, nearDistance, farDistance). If the current frustum is not perspective, the return value is None.

GetPosition()
GetProjectionType()
static GetReferencePlaneDepth()
GetRotation()
GetViewDistance()
GetWindow()
Intersects()
static IntersectsViewVolume()
Orthographic = Gf.Frustum.Orthographic
Perspective = Gf.Frustum.Perspective
class ProjectionType

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Gf.Frustum.Orthographic, Gf.Frustum.Perspective)
SetNearFar()
SetOrthographic()
SetPerspective()
SetPosition()
SetPositionAndRotationFromMatrix()
SetProjectionType()
SetRotation()
SetViewDistance()
SetWindow()
Transform()
property nearFar
property position
property projectionType
property rotation
property viewDistance
property window
class pxr.Gf.Interval

Bases: Boost.Python.instance

Basic mathematical interval class

Create a closed interval representing the single point [val,val].

Create a closed interval representing the range [v1,v2].

Create the interval.

Contains()

Returns true if x is inside the interval.

Returns true if x is inside the interval.

static GetFullInterval()
GetMax()

Get the maximum value.

GetMin()

Get the minimum value.

GetSize()

The width of the interval

In()

Returns true if x is inside the interval.

Intersects()
IsEmpty()

True if the interval is empty.

IsFinite()
IsMaxClosed()
IsMaxFinite()
IsMaxOpen()
IsMinClosed()
IsMinFinite()
IsMinOpen()
SetMax()

Set the maximum value.

Set the maximum value and boundary condition.

SetMin()

Set the minimum value.

Set the minimum value and boundary condition.

property finite
property isEmpty

True if the interval is empty.

property max

The maximum value.

property maxClosed
property maxFinite
property maxOpen
property min

The minimum value.

property minClosed
property minFinite
property minOpen
property size

The width of the interval.

class pxr.Gf.Line

Bases: Boost.Python.instance

Line class

FindClosestPoint()
GetDirection()
GetPoint()
Set()
property direction
class pxr.Gf.LineSeg

Bases: Boost.Python.instance

Line segment class

FindClosestPoint()
GetDirection()
GetLength()
GetPoint()
property direction
property length
class pxr.Gf.Matrix2d

Bases: Boost.Python.instance

GetColumn()
GetDeterminant()
GetInverse()
GetRow()
GetTranspose()
Set()
SetColumn()
SetDiagonal()
SetIdentity()
SetRow()
SetZero()
dimension = (2, 2)
class pxr.Gf.Matrix2f

Bases: Boost.Python.instance

GetColumn()
GetDeterminant()
GetInverse()
GetRow()
GetTranspose()
Set()
SetColumn()
SetDiagonal()
SetIdentity()
SetRow()
SetZero()
dimension = (2, 2)
class pxr.Gf.Matrix3d

Bases: Boost.Python.instance

ExtractRotation()
GetColumn()
GetDeterminant()
GetHandedness()
GetInverse()
GetOrthonormalized()
GetRow()
GetTranspose()
IsLeftHanded()
IsRightHanded()
Orthonormalize()
Set()
SetColumn()
SetDiagonal()
SetIdentity()
SetRotate()
SetRow()
SetScale()
SetZero()
dimension = (3, 3)
class pxr.Gf.Matrix3f

Bases: Boost.Python.instance

ExtractRotation()
GetColumn()
GetDeterminant()
GetHandedness()
GetInverse()
GetOrthonormalized()
GetRow()
GetTranspose()
IsLeftHanded()
IsRightHanded()
Orthonormalize()
Set()
SetColumn()
SetDiagonal()
SetIdentity()
SetRotate()
SetRow()
SetScale()
SetZero()
dimension = (3, 3)
class pxr.Gf.Matrix4d

Bases: Boost.Python.instance

ExtractRotation()
ExtractRotationMatrix()
ExtractRotationQuat()
ExtractTranslation()
Factor()
GetColumn()
GetDeterminant()
GetDeterminant3()
GetHandedness()
GetInverse()
GetOrthonormalized()
GetRow()
GetRow3()
GetTranspose()
HasOrthogonalRows3()
IsLeftHanded()
IsRightHanded()
Orthonormalize()
RemoveScaleShear()
Set()
SetColumn()
SetDiagonal()
SetIdentity()
SetLookAt()
SetRotate()
SetRotateOnly()
SetRow()
SetRow3()
SetScale()
SetTransform()
SetTranslate()
SetTranslateOnly()
SetZero()
Transform()
TransformAffine()
TransformDir()
dimension = (4, 4)
class pxr.Gf.Matrix4f

Bases: Boost.Python.instance

ExtractRotation()
ExtractRotationMatrix()
ExtractRotationQuat()
ExtractTranslation()
Factor()
GetColumn()
GetDeterminant()
GetDeterminant3()
GetHandedness()
GetInverse()
GetOrthonormalized()
GetRow()
GetRow3()
GetTranspose()
HasOrthogonalRows3()
IsLeftHanded()
IsRightHanded()
Orthonormalize()
RemoveScaleShear()
Set()
SetColumn()
SetDiagonal()
SetIdentity()
SetLookAt()
SetRotate()
SetRotateOnly()
SetRow()
SetRow3()
SetScale()
SetTransform()
SetTranslate()
SetTranslateOnly()
SetZero()
Transform()
TransformAffine()
TransformDir()
dimension = (4, 4)
class pxr.Gf.MultiInterval

Bases: Boost.Python.instance

Add()
ArithmeticAdd()
Clear()
Contains()

Returns true if x is inside the multi-interval.

Returns true if x is inside the multi-interval.

Returns true if x is inside the multi-interval.

GetBounds()
GetComplement()
static GetFullInterval()
GetSize()
Intersect()
IsEmpty()
Remove()
property bounds
property isEmpty
property size
class pxr.Gf.Plane

Bases: Boost.Python.instance

GetDistance()
GetDistanceFromOrigin()
GetEquation()
GetNormal()
IntersectsPositiveHalfSpace()
Project()
Reorient()
Set()
Transform()
property distanceFromOrigin
property normal
class pxr.Gf.Quatd

Bases: Boost.Python.instance

GetConjugate()
static GetIdentity()
GetImaginary()
GetInverse()
GetLength()
GetNormalized()
GetReal()
Normalize()
SetImaginary()
SetReal()
property imaginary
property real
class pxr.Gf.Quaternion

Bases: Boost.Python.instance

Quaternion class

static GetIdentity()
GetImaginary()
GetInverse()
GetLength()
GetNormalized()
GetReal()
Normalize()
property imaginary
property real
class pxr.Gf.Quatf

Bases: Boost.Python.instance

GetConjugate()
static GetIdentity()
GetImaginary()
GetInverse()
GetLength()
GetNormalized()
GetReal()
Normalize()
SetImaginary()
SetReal()
property imaginary
property real
class pxr.Gf.Quath

Bases: Boost.Python.instance

GetConjugate()
static GetIdentity()
GetImaginary()
GetInverse()
GetLength()
GetNormalized()
GetReal()
Normalize()
SetImaginary()
SetReal()
property imaginary
property real
class pxr.Gf.Range1d

Bases: Boost.Python.instance

Contains()
GetDistanceSquared()
static GetIntersection()
GetMax()
GetMidpoint()
GetMin()
GetSize()
static GetUnion()
IntersectWith()
IsEmpty()
SetEmpty()
SetMax()
SetMin()
UnionWith()
dimension = 1
property max
property min
class pxr.Gf.Range1f

Bases: Boost.Python.instance

Contains()
GetDistanceSquared()
static GetIntersection()
GetMax()
GetMidpoint()
GetMin()
GetSize()
static GetUnion()
IntersectWith()
IsEmpty()
SetEmpty()
SetMax()
SetMin()
UnionWith()
dimension = 1
property max
property min
class pxr.Gf.Range2d

Bases: Boost.Python.instance

Contains()
GetCorner()
GetDistanceSquared()
static GetIntersection()
GetMax()
GetMidpoint()
GetMin()
GetQuadrant()
GetSize()
static GetUnion()
IntersectWith()
IsEmpty()
SetEmpty()
SetMax()
SetMin()
UnionWith()
dimension = 2
property max
property min
unitSquare = Gf.Range2d(Gf.Vec2d(0.0, 0.0), Gf.Vec2d(1.0, 1.0))
class pxr.Gf.Range2f

Bases: Boost.Python.instance

Contains()
GetCorner()
GetDistanceSquared()
static GetIntersection()
GetMax()
GetMidpoint()
GetMin()
GetQuadrant()
GetSize()
static GetUnion()
IntersectWith()
IsEmpty()
SetEmpty()
SetMax()
SetMin()
UnionWith()
dimension = 2
property max
property min
unitSquare = Gf.Range2f(Gf.Vec2f(0.0, 0.0), Gf.Vec2f(1.0, 1.0))
class pxr.Gf.Range3d

Bases: Boost.Python.instance

Contains()
GetCorner()
GetDistanceSquared()
static GetIntersection()
GetMax()
GetMidpoint()
GetMin()
GetOctant()
GetSize()
static GetUnion()
IntersectWith()
IsEmpty()
SetEmpty()
SetMax()
SetMin()
UnionWith()
dimension = 3
property max
property min
unitCube = Gf.Range3d(Gf.Vec3d(0.0, 0.0, 0.0), Gf.Vec3d(1.0, 1.0, 1.0))
class pxr.Gf.Range3f

Bases: Boost.Python.instance

Contains()
GetCorner()
GetDistanceSquared()
static GetIntersection()
GetMax()
GetMidpoint()
GetMin()
GetOctant()
GetSize()
static GetUnion()
IntersectWith()
IsEmpty()
SetEmpty()
SetMax()
SetMin()
UnionWith()
dimension = 3
property max
property min
unitCube = Gf.Range3f(Gf.Vec3f(0.0, 0.0, 0.0), Gf.Vec3f(1.0, 1.0, 1.0))
class pxr.Gf.Ray

Bases: Boost.Python.instance

FindClosestPoint()
GetPoint()
Intersect(p0, p1, p2) → tuple<intersects = bool, dist =

float, barycentric = GfVec3d, frontFacing = bool>

Intersects the ray with the triangle formed by points p0, p1, and p2. The first item in the tuple is true if the ray intersects the triangle. dist is the the parametric distance to the intersection point, the barycentric coordinates of the intersection point, and the front-facing flag. The barycentric coordinates are defined with respect to the three vertices taken in order. The front-facing flag is True if the intersection hit the side of the triangle that is formed when the vertices are ordered counter-clockwise (right-hand rule).

Barycentric coordinates are defined to sum to 1 and satisfy this relationsip:

intersectionPoint = (barycentricCoords[0] * p0 +

barycentricCoords[1] * p1 + barycentricCoords[2] * p2);

Intersect( plane ) -> tuple<intersects = bool, dist = float, frontFacing = bool>

Intersects the ray with the Gf.Plane. The first item in the returned tuple is true if the ray intersects the plane. dist is the parametric distance to the intersection point and frontfacing is true if the intersection is on the side of the plane toward which the plane’s normal points. ———————————————————————-

Intersect( range3d ) -> tuple<intersects = bool, enterDist = float, exitDist = float> Intersects the plane with an axis-aligned box in a Gf.Range3d. intersects is true if the ray intersects it at all within bounds. If there is an intersection then enterDist and exitDist will be the parametric distances to the two intersection points. ———————————————————————-

Intersect( bbox3d ) -> tuple<intersects = bool, enterDist = float, exitDist = float> Intersects the plane with an oriented box in a Gf.BBox3d. intersects is true if the ray intersects it at all within bounds. If there is an intersection then enterDist and exitDist will be the parametric distances to the two intersection points. ———————————————————————-

Intersect( center, radius ) -> tuple<intersects = bool, enterDist = float, exitDist = float>

Intersects the plane with an sphere. intersects is true if the ray intersects it at all within the sphere. If there is an intersection then enterDist and exitDist will be the parametric distances to the two intersection points. ———————————————————————-

Intersect( origin, axis, radius ) -> tuple<intersects = bool, enterDist = float, exitDist = float>

Intersects the plane with an infinite cylinder. intersects is true if the ray intersects it at all within the sphere. If there is an intersection then enterDist and exitDist will be the parametric distances to the two intersection points. ———————————————————————-

Intersect( origin, axis, radius, height ) -> tuple<intersects = bool, enterDist = float, exitDist = float>

Intersects the plane with an cylinder. intersects is true if the ray intersects it at all within the sphere. If there is an intersection then enterDist and exitDist will be the parametric distances to the two intersection points. ———————————————————————-

SetEnds()
SetPointAndDirection()
Transform()
property direction
property startPoint
class pxr.Gf.Rect2i

Bases: Boost.Python.instance

Contains()
GetArea()
GetBottom()
GetCenter()
GetHeight()
GetHigher()
GetIntersection()
GetLeft()
GetLower()
GetNormalized()
GetRight()
GetSize()
GetTop()
GetUnion()
GetWidth()
IsEmpty()
IsNull()
IsValid()
SetBottom()
SetHigher()
SetLeft()
SetLower()
SetRight()
SetTop()
Translate()
property bottom
property higher
property left
property lower
property right
property top
class pxr.Gf.Rotation

Bases: Boost.Python.instance

3-space rotation

Decompose()
static DecomposeRotation()
static DecomposeRotation3()
GetAngle()
GetAxis()
GetInverse()
GetQuat()
GetQuaternion()
static RotateOntoProjected()
SetAxisAngle()
SetIdentity()
SetQuat()
SetQuaternion()
SetRotateInto()
TransformDir()
property angle
property axis
class pxr.Gf.Size2

Bases: Boost.Python.instance

A 2D size class

Set()
dimension = 2
class pxr.Gf.Size3

Bases: Boost.Python.instance

A 3D size class

Set()
dimension = 3
class pxr.Gf.Transform

Bases: Boost.Python.instance

Initializer used by 3x code.

Initializer used by old 2x code. (Deprecated)

Initializer used by old 2x code. (Deprecated)

GetMatrix()
GetPivotOrientation()
GetPivotPosition()
GetRotation()
GetScale()
GetTranslation()
Set()

Set method used by old 2x code. (Deprecated)

SetIdentity()
SetMatrix()
SetPivotOrientation()
SetPivotPosition()
SetRotation()
SetScale()
SetTranslation()
property pivotOrientation
property pivotPosition
property rotation
property scale
property translation
class pxr.Gf.Vec2d

Bases: Boost.Python.instance

static Axis()
GetComplement()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static XAxis()
static YAxis()
dimension = 2
class pxr.Gf.Vec2f

Bases: Boost.Python.instance

static Axis()
GetComplement()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static XAxis()
static YAxis()
dimension = 2
class pxr.Gf.Vec2h

Bases: Boost.Python.instance

static Axis()
GetComplement()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static XAxis()
static YAxis()
dimension = 2
class pxr.Gf.Vec2i

Bases: Boost.Python.instance

static Axis()
GetDot()
static XAxis()
static YAxis()
dimension = 2
class pxr.Gf.Vec3d

Bases: Boost.Python.instance

static Axis()
BuildOrthonormalFrame()
GetComplement()
GetCross()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static OrthogonalizeBasis()
static XAxis()
static YAxis()
static ZAxis()
dimension = 3
class pxr.Gf.Vec3f

Bases: Boost.Python.instance

static Axis()
BuildOrthonormalFrame()
GetComplement()
GetCross()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static OrthogonalizeBasis()
static XAxis()
static YAxis()
static ZAxis()
dimension = 3
class pxr.Gf.Vec3h

Bases: Boost.Python.instance

static Axis()
BuildOrthonormalFrame()
GetComplement()
GetCross()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static OrthogonalizeBasis()
static XAxis()
static YAxis()
static ZAxis()
dimension = 3
class pxr.Gf.Vec3i

Bases: Boost.Python.instance

static Axis()
GetDot()
static XAxis()
static YAxis()
static ZAxis()
dimension = 3
class pxr.Gf.Vec4d

Bases: Boost.Python.instance

static Axis()
GetComplement()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static WAxis()
static XAxis()
static YAxis()
static ZAxis()
dimension = 4
class pxr.Gf.Vec4f

Bases: Boost.Python.instance

static Axis()
GetComplement()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static WAxis()
static XAxis()
static YAxis()
static ZAxis()
dimension = 4
class pxr.Gf.Vec4h

Bases: Boost.Python.instance

static Axis()
GetComplement()
GetDot()
GetLength()
GetNormalized()
GetProjection()
Normalize()
static WAxis()
static XAxis()
static YAxis()
static ZAxis()
dimension = 4
class pxr.Gf.Vec4i

Bases: Boost.Python.instance

static Axis()
GetDot()
static WAxis()
static XAxis()
static YAxis()
static ZAxis()
dimension = 4

Kind module

Python bindings for libKind

class pxr.Kind.Registry

Bases: Boost.Python.instance

static GetAllKinds()
static GetBaseKind()
static HasKind()
static IsA()
property expired

True if this object has expired, False otherwise.

class pxr.Kind.Tokens

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

assembly = 'assembly'
component = 'component'
group = 'group'
model = 'model'
subcomponent = 'subcomponent'

Ndr module

Python bindings for libNdr

class pxr.Ndr.DiscoveryPlugin

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

DiscoverNodes()
GetSearchURIs()
property expired

True if this object has expired, False otherwise.

class pxr.Ndr.DiscoveryPluginContext

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

GetSourceType()
property expired

True if this object has expired, False otherwise.

class pxr.Ndr.DiscoveryPluginList

Bases: Boost.Python.instance

append()
extend()
class pxr.Ndr.Node

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

GetContext()
GetFamily()
GetIdentifier()
GetInfoString()
GetInput()
GetInputNames()
GetMetadata()
GetName()
GetOutput()
GetOutputNames()
GetResolvedDefinitionURI()
GetResolvedImplementationURI()
GetSourceCode()
GetSourceType()
GetVersion()
IsValid()
class pxr.Ndr.NodeDiscoveryResult

Bases: Boost.Python.instance

property blindData
property discoveryType
property family
property identifier
property metadata
property name
property resolvedUri
property sourceCode
property sourceType
property subIdentifier
property uri
property version
class pxr.Ndr.NodeList

Bases: Boost.Python.instance

append()
extend()
class pxr.Ndr.Property

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

CanConnectTo()
GetArraySize()
GetDefaultValue()
GetInfoString()
GetMetadata()
GetName()
GetType()
GetTypeAsSdfType()
IsArray()
IsConnectable()
IsDynamicArray()
IsOutput()
class pxr.Ndr.Registry

Bases: Boost.Python.instance

GetAllNodeSourceTypes()
GetNodeByIdentifier()
GetNodeByIdentifierAndType()
GetNodeByName()
GetNodeByNameAndType()
GetNodeFromAsset()
GetNodeFromSourceCode()
GetNodeIdentifiers()
GetNodeNames()
GetNodesByFamily()
GetNodesByIdentifier()
GetNodesByName()
GetSearchURIs()
SetExtraDiscoveryPlugins()
SetExtraParserPlugins()
property expired

True if this object has expired, False otherwise.

class pxr.Ndr.Version

Bases: Boost.Python.instance

GetAsDefault()
GetMajor()
GetMinor()
GetStringSuffix()
IsDefault()
class pxr.Ndr.VersionFilter

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Ndr.VersionFilterDefaultOnly, Ndr.VersionFilterAllVersions)

Pcp module

class pxr.Pcp.ArcType

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Pcp.ArcTypeRoot, Pcp.ArcTypeInherit, Pcp.ArcTypeRelocate, Pcp.ArcTypeVariant, Pcp.ArcTypeReference, Pcp.ArcTypePayload, Pcp.ArcTypeSpecialize)
class pxr.Pcp.Cache

Bases: Boost.Python.instance

ComputeAttributeConnectionPaths()
ComputeLayerStack()
ComputePrimIndex()
ComputePropertyIndex()
ComputeRelationshipTargetPaths()
FindAllLayerStacksUsingLayer()
FindPrimIndex()
FindPropertyIndex()
FindSiteDependencies()
GetDynamicFileFormatArgumentDependencyData()
GetLayerStackIdentifier()
GetMutedLayers()
GetUsedLayers()
GetVariantFallbacks()
HasAnyDynamicFileFormatArgumentDependencies()
IsInvalidAssetPath()
IsInvalidSublayerIdentifier()
IsLayerMuted()
IsPayloadIncluded()
IsPossibleDynamicFileFormatArgumentField()
PrintStatistics()
Reload()
RequestLayerMuting()
RequestPayloads()
SetVariantFallbacks()
property fileFormatTarget
property layerStack
class pxr.Pcp.Dependency

Bases: Boost.Python.instance

property indexPath
property mapFunc
property sitePath
class pxr.Pcp.DependencyType

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Pcp.DependencyTypeNone, Pcp.DependencyTypeRoot, Pcp.DependencyTypePurelyDirect, Pcp.DependencyTypePartlyDirect, Pcp.DependencyTypeDirect, Pcp.DependencyTypeAncestral, Pcp.DependencyTypeVirtual, Pcp.DependencyTypeNonVirtual, Pcp.DependencyTypeAnyNonVirtual, Pcp.DependencyTypeAnyIncludingVirtual)
class pxr.Pcp.DynamicFileFormatDependencyData

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

CanFieldChangeAffectFileFormatArguments()
GetRelevantFieldNames()
IsEmpty()
class pxr.Pcp.ErrorArcCycle

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorArcPermissionDenied

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorBase

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property errorType
class pxr.Pcp.ErrorInconsistentAttributeType

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInconsistentAttributeVariability

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInconsistentPropertyType

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInternalAssetPath

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidAssetPath

Bases: pxr.Pcp.ErrorInvalidAssetPathBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidAssetPathBase

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidExternalTargetPath

Bases: pxr.Pcp.ErrorTargetPathBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidInstanceTargetPath

Bases: pxr.Pcp.ErrorTargetPathBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidPrimPath

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidReferenceOffset

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidSublayerOffset

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidSublayerOwnership

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidSublayerPath

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidTargetPath

Bases: pxr.Pcp.ErrorTargetPathBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorInvalidVariantSelection

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorMutedAssetPath

Bases: pxr.Pcp.ErrorInvalidAssetPathBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorOpinionAtRelocationSource

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorPrimPermissionDenied

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorPropertyPermissionDenied

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorSublayerCycle

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorTargetPathBase

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorTargetPermissionDenied

Bases: pxr.Pcp.ErrorTargetPathBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.ErrorType

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Pcp.ErrorType_ArcCycle, Pcp.ErrorType_ArcPermissionDenied, Pcp.ErrorType_InconsistentPropertyType, Pcp.ErrorType_InconsistentAttributeType, Pcp.ErrorType_InconsistentAttributeVariability, Pcp.ErrorType_InternalAssetPath, Pcp.ErrorType_InvalidPrimPath, Pcp.ErrorType_InvalidAssetPath, Pcp.ErrorType_InvalidInstanceTargetPath, Pcp.ErrorType_InvalidExternalTargetPath, Pcp.ErrorType_InvalidTargetPath, Pcp.ErrorType_InvalidReferenceOffset, Pcp.ErrorType_InvalidSublayerOffset, Pcp.ErrorType_InvalidSublayerOwnership, Pcp.ErrorType_InvalidSublayerPath, Pcp.ErrorType_InvalidVariantSelection, Pcp.ErrorType_OpinionAtRelocationSource, Pcp.ErrorType_PrimPermissionDenied, Pcp.ErrorType_PropertyPermissionDenied, Pcp.ErrorType_SublayerCycle, Pcp.ErrorType_TargetPermissionDenied, Pcp.ErrorType_UnresolvedPrimPath)
class pxr.Pcp.ErrorUnresolvedPrimPath

Bases: pxr.Pcp.ErrorBase

Raises an exception This class cannot be instantiated from Python

class pxr.Pcp.InstanceKey

Bases: Boost.Python.instance

class pxr.Pcp.LayerStack

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property expired

True if this object has expired, False otherwise.

property identifier
property incrementalRelocatesSourceToTarget
property incrementalRelocatesTargetToSource
property layerOffsets
property layerTree
property layers
property localErrors
property pathsToPrimsWithRelocates
property relocatesSourceToTarget
property relocatesTargetToSource
class pxr.Pcp.LayerStackIdentifier

Bases: Boost.Python.instance

property pathResolverContext
property rootLayer
property sessionLayer
class pxr.Pcp.LayerStackSite

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property layerStack
property path
class pxr.Pcp.MapExpression

Bases: Boost.Python.instance

AddRootIdentity()
Compose()
static Constant()
Evaluate()
static Identity()
static Inverse()
MapSourceToTarget()
MapTargetToSource()
property isIdentity
property isNull
property timeOffset
class pxr.Pcp.MapFunction

Bases: Boost.Python.instance

Compose()
ComposeOffset()
GetInverse()
static Identity()
static IdentityPathMap()
MapSourceToTarget()
MapTargetToSource()
property isIdentity
property isNull
property sourceToTargetMap
property timeOffset
class pxr.Pcp.NodeRef

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

CanContributeSpecs()
GetDepthBelowIntroduction()
GetIntroPath()
GetOriginRootNode()
GetPathAtIntroduction()
GetRootNode()
IsDueToAncestor()
IsRootNode()
property arcType
property children
property hasSpecs
property hasSymmetry
property isCulled
property isInert
property isRestricted
property layerStack
property mapToParent
property mapToRoot
property namespaceDepth
property origin
property parent
property path
property permission
property siblingNumAtOrigin
property site
class pxr.Pcp.PrimIndex

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ComposeAuthoredVariantSelections()
ComputePrimChildNames()
ComputePrimPropertyNames()
DumpToDotGraph()
DumpToString()
GetSelectionAppliedForVariantSet()
IsInstanceable()
IsValid()
PrintStatistics()
property hasAnyPayloads
property localErrors
property primStack
property rootNode
class pxr.Pcp.PropertyIndex

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property localErrors
property localPropertyStack
property propertyStack
class pxr.Pcp.Site

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property layerStack
property path

PhysicsSchema module

PhysicsSchemaTools module

pxr.PhysicsSchemaTools.addActor()
pxr.PhysicsSchemaTools.addBoxCollisionShape()
pxr.PhysicsSchemaTools.addCollisionShape()
pxr.PhysicsSchemaTools.addDensity()
pxr.PhysicsSchemaTools.addDisplayColor()
pxr.PhysicsSchemaTools.addGroundPlane()
pxr.PhysicsSchemaTools.addGroundTriMesh()
pxr.PhysicsSchemaTools.addOrientation()
pxr.PhysicsSchemaTools.addPhysicsScene()
pxr.PhysicsSchemaTools.addPosition()
pxr.PhysicsSchemaTools.addRigidBody()
pxr.PhysicsSchemaTools.addRigidBox()
pxr.PhysicsSchemaTools.addRigidBoxForInstancing()
pxr.PhysicsSchemaTools.addRigidCapsule()
pxr.PhysicsSchemaTools.addRigidCone()
pxr.PhysicsSchemaTools.addRigidCylinder()
pxr.PhysicsSchemaTools.addRigidSphere()
pxr.PhysicsSchemaTools.addVelocity()
pxr.PhysicsSchemaTools.createMesh()
pxr.PhysicsSchemaTools.createMeshBox()
pxr.PhysicsSchemaTools.createMeshCapsule()
pxr.PhysicsSchemaTools.createMeshCylinder()
pxr.PhysicsSchemaTools.createMeshSphere()
pxr.PhysicsSchemaTools.createMeshSquare()
pxr.PhysicsSchemaTools.decodeSdfPath()
pxr.PhysicsSchemaTools.encodeSdfPath()

Plug module

This package defines facilities for dealing with plugins.

class pxr.Plug.Notice

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class Base

Bases: pxr.Tf.Notice

Raises an exception This class cannot be instantiated from Python

class DidRegisterPlugins

Bases: pxr.Plug.Base

Raises an exception This class cannot be instantiated from Python

GetNewPlugins()
class pxr.Plug.Plugin

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

DeclaresType()
FindPluginResource()
GetMetadataForType()
Load()
MakeResourcePath()
property expired

True if this object has expired, False otherwise.

property isLoaded
property isPythonModule
property isResource
property metadata
property name
property path
property resourcePath
class pxr.Plug.Registry

Bases: Boost.Python.instance

static FindDerivedTypeByName()
static FindTypeByName()
static GetAllDerivedTypes()
GetAllPlugins()
static GetDirectlyDerivedTypes()
GetPluginForType()
GetPluginWithName()
GetStringFromPluginMetaData()
RegisterPlugins()
property expired

True if this object has expired, False otherwise.

Sdf module

class pxr.Sdf.AngularUnit

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.AngularUnitDegrees, Sdf.AngularUnitRadians)
class pxr.Sdf.AssetPath

Bases: Boost.Python.instance

property path
property resolvedPath
class pxr.Sdf.AssetPathArray(values)

Bases: Boost.Python.instance

An array of type SdfAssetPath.

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

__init__(values)

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

__init__(values)

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

class pxr.Sdf.AttributeSpec(ownerPrimSpec, name, typeName, variability=Sd.VariabilityVarying, declaresCustom=False)

Bases: pxr.Sdf.PropertySpec

ownerPrimSpec : PrimSpec name : string typeName : SdfValueTypeName variability : SdfVariability declaresCustom : bool

Create a custom attribute spec that is an attribute of ownerPrimSpec with the given name and type.

ClearColorSpace()
ConnectionPathsKey = 'connectionPaths'
DefaultValueKey = 'default'
DisplayUnitKey = 'displayUnit'
HasColorSpace()
property allowedTokens

The allowed value tokens for this property

property colorSpace

The color-space in which the attribute value is authored.

property connectionPathList

A PathListEditor for the attribute’s connection paths.

The list of the connection paths for this attribute may be modified with this PathListEditor.

A PathListEditor may express a list either as an explicit value or as a set of list editing operations. See GdListEditor for more information.

property displayUnit

The display unit for this attribute.

property expired
property roleName

The roleName for this attribute’s typeName.

property typeName

The typename of this attribute.

property valueType

The value type of this attribute.

class pxr.Sdf.BatchNamespaceEdit

Bases: Boost.Python.instance

Add()
Process()
property edits
class pxr.Sdf.ChangeBlock

Bases: Boost.Python.instance

class pxr.Sdf.ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec___

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec___

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec___

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec___

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec___

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

get()
index()
items()
keys()
values()
class pxr.Sdf.CleanupEnabler

Bases: Boost.Python.instance

class pxr.Sdf.DimensionlessUnit

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.DimensionlessUnitPercent, Sdf.DimensionlessUnitDefault)
class pxr.Sdf.FastUpdateList

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class FastUpdate

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property path
property value
property fastUpdates
property hasCompositionDependents
class pxr.Sdf.FileFormat

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

CanRead()
static FindAllFileFormatExtensions()
static FindByExtension()
static FindById()
static GetFileExtension()
GetFileExtensions()
IsPackage()
IsSupportedExtension()
static RegisterFileFormat()
class Tokens

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

TargetArg = 'target'
property expired

True if this object has expired, False otherwise.

property fileCookie
property formatId
property primaryFileExtension
property target
pxr.Sdf.Find(layerFileName, scenePath)object

layerFileName: string scenePath: Path

If given a single string argument, returns the menv layer with the given filename. If given two arguments (a string and a Path), finds the menv layer with the given filename and returns the scene object within it at the given path.

class pxr.Sdf.Int64ListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.IntListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.Layer

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

static AddToMutedLayers()
Apply()
ApplyRootPrimOrder()
CanApply()
Clear()
ClearColorConfiguration()
ClearColorManagementSystem()
ClearCustomLayerData()
ClearDefaultPrim()
ClearEndTimeCode()
ClearFramePrecision()
ClearFramesPerSecond()
ClearOwner()
ClearSessionOwner()
ClearStartTimeCode()
ClearTimeCodesPerSecond()
ColorConfigurationKey = 'colorConfiguration'
ColorManagementSystemKey = 'colorManagementSystem'
CommentKey = 'comment'
ComputeAbsolutePath()
static CreateAnonymous()
static CreateIdentifier()
static CreateNew()
DocumentationKey = 'documentation'
static DumpLayerInfo()

Debug helper to examine content of the current layer registry and the asset/real path of all layers in the registry.

EndFrameKey = 'endFrame'
EndTimeCodeKey = 'endTimeCode'
EraseTimeSample()
Export()
ExportToString()

Returns the string representation of the layer.

static Find(filename) → LayerPtr

filename : string

Returns the open layer with the given filename, or None. Note that this is a static class method.

static FindOrOpen()
static FindRelativeToLayer()

Returns the open layer with the given filename, or None. If the filename is a relative path then it’s found relative to the given layer. Note that this is a static class method.

FramePrecisionKey = 'framePrecision'
FramesPerSecondKey = 'framesPerSecond'
GetAssetInfo()
GetAssetName()
GetAttributeAtPath()
GetBracketingTimeSamples()
GetBracketingTimeSamplesForPath()
GetDisplayName()
static GetDisplayNameFromIdentifier()
GetExternalReferences()

Return a list of asset paths for this layer.

GetFileFormat()
GetFileFormatArguments()
static GetLoadedLayers()

Return list of loaded layers.

static GetMutedLayers()

Return list of muted layers.

GetNumTimeSamplesForPath()
GetObjectAtPath()
GetPrimAtPath()
GetPropertyAtPath()
GetRelationshipAtPath()
HasColorConfiguration()
HasColorManagementSystem()
HasCustomLayerData()
HasDefaultPrim()
HasEndTimeCode()
HasFramePrecision()
HasFramesPerSecond()
HasOwnedSubLayers = 'hasOwnedSubLayers'
HasOwner()
HasSessionOwner()
HasStartTimeCode()
HasTimeCodesPerSecond()
Import()
ImportFromString()
static IsAnonymousLayerIdentifier()
IsMuted()
ListAllTimeSamples()
ListTimeSamplesForPath()
static New()
static OpenAsAnonymous()
OwnerKey = 'owner'
QueryTimeSample()
Reload()
static ReloadLayers()
static RemoveFromMutedLayers()
RemoveInertSceneDescription()
Save()
ScheduleRemoveIfInert()
SessionOwnerKey = 'sessionOwner'
SetMuted()
SetPermissionToEdit()
SetPermissionToSave()
SetTimeSample()
static SplitIdentifier()
StartFrameKey = 'startFrame'
StartTimeCodeKey = 'startTimeCode'
TimeCodesPerSecondKey = 'timeCodesPerSecond'
TransferContent()
Traverse()
UpdateAssetInfo()
UpdateExternalReference()
property anonymous
property colorConfiguration

The color configuration asset-path of this layer.

property colorManagementSystem

The name of the color management system used to interpret the colorConfiguration asset.

property comment

The layer’s comment string.

property customLayerData

The customLayerData dictionary associated with this layer.

property defaultPrim

The layer’s default reference target token.

property dirty
property documentation

The layer’s documentation string.

property empty
property endTimeCode

The end timeCode of this layer.

The end timeCode of a layer is not a hard limit, but is more of a hint. A layer’s time-varying content is not limited to the timeCode range of the layer.

property expired

True if this object has expired, False otherwise.

property externalReferences

Return unique list of asset paths of external references for given layer.

property fileExtension

The layer’s file extension.

property framePrecision

The number of digits of precision used in times in this layer.

property framesPerSecond

The frames per second used in this layer.

property hasOwnedSubLayers

Whether this layer’s sub layers are expected to have owners.

property identifier

The layer’s identifier.

property owner

The owner of this layer.

property permissionToEdit

Return true if permitted to be edited (modified), false otherwise.

property permissionToSave

Return true if permitted to be saved, false otherwise.

property pseudoRoot

The pseudo-root of the layer.

property realPath

The layer’s canonical full path. This path is guaranteed to be valid.

property repositoryPath

The layer’s associated repository path

property rootPrimOrder

Get/set the list of root prim names for this layer’s ‘reorder rootPrims’ statement.

property rootPrims

The root prims of this layer, as an ordered dictionary.

The prims may be accessed by index or by name. Although this property claims it is read only, you can modify the contents of this dictionary to add, remove, or reorder the contents.

property sessionOwner

The session owner of this layer. Only intended for use with session layers.

property startTimeCode

The start timeCode of this layer.

The start timeCode of a layer is not a hard limit, but is more of a hint. A layer’s time-varying content is not limited to the timeCode range of the layer.

property subLayerOffsets

The sublayer offsets of this layer, as a list. Although this property is claimed to be read only, you can modify the contents of this list by assigning new layer offsets to specific indices.

property subLayerPaths

The sublayer paths of this layer, as a list. Although this property is claimed to be read only, you can modify the contents of this list.

property timeCodesPerSecond

The timeCodes per second used in this layer.

property version

The layer’s version.

class pxr.Sdf.LayerOffset

Bases: Boost.Python.instance

GetInverse()
IsIdentity()
property offset
property scale
class pxr.Sdf.LayerTree

Bases: Boost.Python.instance

property childTrees
property expired

True if this object has expired, False otherwise.

property layer
property offset
class pxr.Sdf.LengthUnit

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.LengthUnitMillimeter, Sdf.LengthUnitCentimeter, Sdf.LengthUnitDecimeter, Sdf.LengthUnitMeter, Sdf.LengthUnitKilometer, Sdf.LengthUnitInch, Sdf.LengthUnitFoot, Sdf.LengthUnitYard, Sdf.LengthUnitMile)
class pxr.Sdf.ListEditorProxy_SdfNameKeyPolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Add()
Append()
ApplyEditsToList()
ClearEdits()
ClearEditsAndMakeExplicit()
ContainsItemEdit()
CopyItems()
Erase()
GetAddedOrExplicitItems()
ModifyItemEdits()
Prepend()
Remove()
RemoveItemEdits()
ReplaceItemEdits()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExpired
property isExplicit
property isOrderedOnly
property orderedItems
property prependedItems
class pxr.Sdf.ListEditorProxy_SdfPathKeyPolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Add()
Append()
ApplyEditsToList()
ClearEdits()
ClearEditsAndMakeExplicit()
ContainsItemEdit()
CopyItems()
Erase()
GetAddedOrExplicitItems()
ModifyItemEdits()
Prepend()
Remove()
RemoveItemEdits()
ReplaceItemEdits()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExpired
property isExplicit
property isOrderedOnly
property orderedItems
property prependedItems
class pxr.Sdf.ListEditorProxy_SdfPayloadTypePolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Add()
Append()
ApplyEditsToList()
ClearEdits()
ClearEditsAndMakeExplicit()
ContainsItemEdit()
CopyItems()
Erase()
GetAddedOrExplicitItems()
ModifyItemEdits()
Prepend()
Remove()
RemoveItemEdits()
ReplaceItemEdits()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExpired
property isExplicit
property isOrderedOnly
property orderedItems
property prependedItems
class pxr.Sdf.ListEditorProxy_SdfReferenceTypePolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Add()
Append()
ApplyEditsToList()
ClearEdits()
ClearEditsAndMakeExplicit()
ContainsItemEdit()
CopyItems()
Erase()
GetAddedOrExplicitItems()
ModifyItemEdits()
Prepend()
Remove()
RemoveItemEdits()
ReplaceItemEdits()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExpired
property isExplicit
property isOrderedOnly
property orderedItems
property prependedItems
class pxr.Sdf.ListOpType

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.ListOpTypeExplicit, Sdf.ListOpTypeAdded, Sdf.ListOpTypePrepended, Sdf.ListOpTypeAppended, Sdf.ListOpTypeDeleted, Sdf.ListOpTypeOrdered)
class pxr.Sdf.ListProxy_SdfNameKeyPolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
property expired
index()
insert()
remove()
replace()
class pxr.Sdf.ListProxy_SdfNameTokenKeyPolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
property expired
index()
insert()
remove()
replace()
class pxr.Sdf.ListProxy_SdfPathKeyPolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
property expired
index()
insert()
remove()
replace()
class pxr.Sdf.ListProxy_SdfPayloadTypePolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
property expired
index()
insert()
remove()
replace()
class pxr.Sdf.ListProxy_SdfReferenceTypePolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
property expired
index()
insert()
remove()
replace()
class pxr.Sdf.ListProxy_SdfSubLayerTypePolicy

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
property expired
index()
insert()
remove()
replace()
class pxr.Sdf.MapEditProxy_VtDictionary

Bases: Boost.Python.instance

class MapEditProxy_VtDictionary_Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class MapEditProxy_VtDictionary_KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class MapEditProxy_VtDictionary_ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

clear()
copy()
property expired
get()
items()
keys()
pop()
popitem()
setdefault()
update()
values()
class pxr.Sdf.MapEditProxy_map_SdfPath__SdfPath__less_SdfPath___allocator_pair_SdfPath_const__SdfPath_____

Bases: Boost.Python.instance

class MapEditProxy_map_SdfPath__SdfPath__less_SdfPath___allocator_pair_SdfPath_const__SdfPath______Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class MapEditProxy_map_SdfPath__SdfPath__less_SdfPath___allocator_pair_SdfPath_const__SdfPath______KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class MapEditProxy_map_SdfPath__SdfPath__less_SdfPath___allocator_pair_SdfPath_const__SdfPath______ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

clear()
copy()
property expired
get()
items()
keys()
pop()
popitem()
setdefault()
update()
values()
class pxr.Sdf.MapEditProxy_map_string__string__less_string___allocator_pair_stringconst__string_____

Bases: Boost.Python.instance

class MapEditProxy_map_string__string__less_string___allocator_pair_stringconst__string______Iterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class MapEditProxy_map_string__string__less_string___allocator_pair_stringconst__string______KeyIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class MapEditProxy_map_string__string__less_string___allocator_pair_stringconst__string______ValueIterator

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

clear()
copy()
property expired
get()
items()
keys()
pop()
popitem()
setdefault()
update()
values()
class pxr.Sdf.NamespaceEdit

Bases: Boost.Python.instance

static Remove()
static Rename()
static Reorder()
static Reparent()
static ReparentAndRename()
atEnd = -1
property currentPath
property index
property newPath
same = -2
class pxr.Sdf.NamespaceEditDetail

Bases: Boost.Python.instance

Error = Sdf.NamespaceEditDetail.Error
Okay = Sdf.NamespaceEditDetail.Okay
class Result

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.NamespaceEditDetail.Error, Sdf.NamespaceEditDetail.Unbatched, Sdf.NamespaceEditDetail.Okay)
Unbatched = Sdf.NamespaceEditDetail.Unbatched
property edit
property reason
property result
class pxr.Sdf.Notice

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class Base

Bases: pxr.Tf.Notice

Raises an exception This class cannot be instantiated from Python

class LayerDidReloadContent

Bases: pxr.Sdf.LayerDidReplaceContent

Raises an exception This class cannot be instantiated from Python

class LayerDidReplaceContent

Bases: pxr.Sdf.Base

Raises an exception This class cannot be instantiated from Python

class LayerDirtinessChanged

Bases: pxr.Sdf.Base

Raises an exception This class cannot be instantiated from Python

class LayerIdentifierDidChange

Bases: pxr.Sdf.Base

Raises an exception This class cannot be instantiated from Python

property newIdentifier
property oldIdentifier
class LayerInfoDidChange

Bases: pxr.Sdf.Base

Raises an exception This class cannot be instantiated from Python

key()
class LayerMutenessChanged

Bases: pxr.Sdf.Base

Raises an exception This class cannot be instantiated from Python

property layerPath
property wasMuted
class LayersDidChange

Bases: pxr.Sdf.Base

Raises an exception This class cannot be instantiated from Python

GetLayers()
GetSerialNumber()
class LayersDidChangeSentPerLayer

Bases: pxr.Sdf.Base

Raises an exception This class cannot be instantiated from Python

GetLayers()
GetSerialNumber()
class pxr.Sdf.Path

Bases: Boost.Python.instance

class AncestorsRange

Bases: Boost.Python.instance

GetPath()
AppendChild()
AppendElementString()
AppendExpression()
AppendMapper()
AppendMapperArg()
AppendPath()
AppendProperty()
AppendRelationalAttribute()
AppendTarget()
AppendVariantSelection()
ContainsPrimVariantSelection()
ContainsPropertyElements()
ContainsTargetPath()
static FindLongestPrefix()
static FindLongestStrictPrefix()
static FindPrefixedRange()
GetAbsoluteRootOrPrimPath()
GetAllTargetPathsRecursively()
GetAncestorsRange()
GetCommonPrefix()
static GetConciseRelativePaths()
GetParentPath()
GetPrefixes()

Returns the prefix paths of this path.

GetPrimOrPrimVariantSelectionPath()
GetPrimPath()
GetVariantSelection()
HasPrefix()
IsAbsolutePath()
IsAbsoluteRootOrPrimPath()
IsAbsoluteRootPath()
IsExpressionPath()
IsMapperArgPath()
IsMapperPath()
IsNamespacedPropertyPath()
IsPrimPath()
IsPrimPropertyPath()
IsPrimVariantSelectionPath()
IsPropertyPath()
IsRelationalAttributePath()
IsRootPrimPath()
IsTargetPath()
static IsValidIdentifier()
static IsValidNamespacedIdentifier()
static IsValidPathString()
static JoinIdentifier()
MakeAbsolutePath()
MakeRelativePath()
static RemoveAncestorPaths()
RemoveCommonSuffix()
static RemoveDescendentPaths()
ReplaceName()
ReplacePrefix()
ReplaceTargetPath()
StripAllVariantSelections()
static StripNamespace()
static StripPrefixNamespace()
static TokenizeIdentifier()
absoluteIndicator = '/'
absoluteRootPath = Sdf.Path('/')
childDelimiter = '/'
property elementString

The string representation of the terminal component of this path. This path can be reconstructed via thisPath.GetParentPath().AppendElementString(thisPath.element). None of absoluteRootPath, reflexiveRelativePath, nor emptyPath possess the above quality; their .elementString is the empty string.

emptyPath = Sdf.Path.emptyPath
expressionIndicator = 'expression'
property isEmpty
mapperArgDelimiter = '.'
mapperIndicator = 'mapper'
menvaEnd = '>'
menvaStart = '<'
property name

The name of the prim, property or relational attribute identified by the path.

‘’ for EmptyPath. ‘.’ for ReflexiveRelativePath. ‘..’ for a path ending in ParentPathElement.

namespaceDelimiter = ':'
parentPathElement = '..'
property pathElementCount

The number of path elements in this path.

property pathString

The string representation of this path.

propertyDelimiter = '.'
reflexiveRelativePath = Sdf.Path('.')
relationshipTargetEnd = ']'
relationshipTargetStart = '['
property targetPath

The relational attribute target path for this path.

EmptyPath if this is not a relational attribute path.

class pxr.Sdf.PathArray(values)

Bases: Boost.Python.instance

An array of type SdfPath.

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

__init__(values)

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

__init__(values)

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

class pxr.Sdf.PathListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.Payload

Bases: Boost.Python.instance

property assetPath
property layerOffset
property primPath
class pxr.Sdf.PayloadListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.Permission

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.PermissionPublic, Sdf.PermissionPrivate)
class pxr.Sdf.PrimSpec

Bases: pxr.Sdf.Spec

ActiveKey = 'active'
AnyTypeToken = '__AnyType__'
ApplyNameChildrenOrder()
ApplyPropertyOrder()
CanSetName()
ClearActive()
ClearInstanceable()
ClearKind()
ClearPayloadList()

Clears the payloads for this prim.

ClearReferenceList()

Clears the references for this prim.

CommentKey = 'comment'
CustomDataKey = 'customData'
DocumentationKey = 'documentation'
GetAttributeAtPath()
GetObjectAtPath(path)object

path: Path

Returns a prim or property given its namespace path.

If path is relative then it will be interpreted as relative to this prim. If it is absolute then it will be interpreted as absolute in this prim’s layer. The return type can be either PrimSpecPtr or PropertySpecPtr.

GetPrimAtPath()
GetPropertyAtPath()
GetRelationshipAtPath()
GetVariantNames()
HasActive()
HasInstanceable()
HasKind()
HiddenKey = 'hidden'
InheritPathsKey = 'inheritPaths'
KindKey = 'kind'
PayloadKey = 'payload'
PermissionKey = 'permission'
PrefixKey = 'prefix'
PrefixSubstitutionsKey = 'prefixSubstitutions'
PrimOrderKey = 'primOrder'
PropertyOrderKey = 'propertyOrder'
ReferencesKey = 'references'
RelocatesKey = 'relocates'
RemoveProperty()
SpecializesKey = 'specializes'
SpecifierKey = 'specifier'
SymmetricPeerKey = 'symmetricPeer'
SymmetryArgumentsKey = 'symmetryArguments'
SymmetryFunctionKey = 'symmetryFunction'
TypeNameKey = 'typeName'
VariantSelectionKey = 'variantSelection'
VariantSetNamesKey = 'variantSetNames'
property active

Whether this prim spec is active. The default value is true.

property assetInfo

Returns the asset info dictionary for this prim.

The default value is an empty dictionary.

The asset info dictionary is used to annotate prims representing the root-prims of assets (generally organized as models) with various data related to asset management. For example, asset name, root layer identifier, asset version etc.

property attributes

The attributes of this prim, as an ordered dictionary.

property comment

The prim’s comment string.

property customData

The custom data for this prim.

The default value for custom data is an empty dictionary.

Custom data is for use by plugins or other non-tools supplied extensions that need to be able to store data attached to arbitrary scene objects. Note that if the only objects you want to store data on are prims, using custom attributes is probably a better choice. But if you need to possibly store this data on attributes or relationships or as annotations on reference arcs, then custom data is an appropriate choice.

property documentation

The prim’s documentation string.

property expired
property hasPayloads

Returns true if this prim has payloads set.

property hasReferences

Returns true if this prim has references set.

property hidden

Whether this prim spec will be hidden in browsers. The default value is false.

property inheritPathList

A PathListEditor for the prim’s inherit paths.

The list of the inherit paths for this prim may be modified with this PathListEditor.

A PathListEditor may express a list either as an explicit value or as a set of list editing operations. See PathListEditor for more information.

property instanceable

Whether this prim spec is flagged as instanceable. The default value is false.

property kind

What kind of model this prim spec represents, if any. The default is an empty string

property name

The prim’s name.

property nameChildren

The prim name children of this prim, as an ordered dictionary.

Note that although this property is described as being read-only, you can modify the contents to add, remove, or reorder children.

property nameChildrenOrder

Get/set the list of child names for this prim’s ‘reorder nameChildren’ statement.

property nameParent

The name parent of this prim.

property nameRoot

The name pseudo-root of this prim.

property payloadList

A PayloadListEditor for the prim’s payloads.

The list of the payloads for this prim may be modified with this PayloadListEditor.

A PayloadListEditor may express a list either as an explicit value or as a set of list editing operations. See PayloadListEditor for more information.

property permission

The prim’s permission restriction. The default value is SdfPermissionPublic.

property prefix

The prim’s prefix.

property prefixSubstitutions

Dictionary of prefix substitutions.

property properties

The properties of this prim, as an ordered dictionary.

Note that although this property is described as being read-only, you can modify the contents to add, remove, or reorder properties.

property propertyOrder

Get/set the list of property names for this prim’s ‘reorder properties’ statement.

property realNameParent

The name parent of this prim.

property referenceList

A ReferenceListEditor for the prim’s references.

The list of the references for this prim may be modified with this ReferenceListEditor.

A ReferenceListEditor may express a list either as an explicit value or as a set of list editing operations. See ReferenceListEditor for more information.

property relationships

The relationships of this prim, as an ordered dictionary.

property relocates

An editing proxy for the prim’s map of relocation paths.

The map of source-to-target paths specifying namespace relocation may be set or cleared whole, or individual map entries may be added, removed, or edited.

property specializesList

A PathListEditor for the prim’s specializes.

The list of the specializes for this prim may be modified with this PathListEditor.

A PathListEditor may express a list either as an explicit value or as a set of list editing operations. See PathListEditor for more information.

property specifier

The prim’s specifier (SpecifierDef or SpecifierOver). The default value is SpecifierOver.

property suffix

The prim’s suffix.

property suffixSubstitutions

Dictionary of prefix substitutions.

property symmetricPeer

The prims’s symmetric peer.

property symmetryArguments

Dictionary with prim symmetry arguments.

Although this property is marked read-only, you can modify the contents to add, change, and clear symmetry arguments.

property symmetryFunction

The prim’s symmetry function.

property typeName

The type of this prim.

property variantSelections

Dictionary whose keys are variant set names and whose values are the variants chosen for each set.

Although this property is marked read-only, you can modify the contents to add, change, and clear variants.

property variantSetNameList

A StringListEditor for the names of the variant sets for this prim.

The list of the names of the variants sets of this prim may be modified with this StringListEditor.

A StringListEditor may express a list either as an explicit value or as a set of list editing operations. See StringListEditor for more information.

Although this property is marked as read-only, the returned object is modifiable.

property variantSets

The VariantSetSpecs for this prim indexed by name.

Although this property is marked as read-only, you can modify the contents to remove variant sets. New variant sets are created by creating them with the prim as the owner.

Although this property is marked as read-only, the returned object is modifiable.

class pxr.Sdf.PropertySpec

Bases: pxr.Sdf.Spec

Raises an exception This class cannot be instantiated from Python

AssetInfoKey = 'assetInfo'
ClearDefaultValue()
CommentKey = 'comment'
CustomDataKey = 'customData'
CustomKey = 'custom'
DisplayGroupKey = 'displayGroup'
DisplayNameKey = 'displayName'
DocumentationKey = 'documentation'
HasDefaultValue()
HiddenKey = 'hidden'
PermissionKey = 'permission'
PrefixKey = 'prefix'
SymmetricPeerKey = 'symmetricPeer'
SymmetryArgumentsKey = 'symmetryArguments'
SymmetryFunctionKey = 'symmetryFunction'
property assetInfo

Returns the asset info dictionary for this property.

The default value is an empty dictionary.

The asset info dictionary is used to annotate SdfAssetPath-valued attributes pointing to the root-prims of assets (generally organized as models) with various data related to asset management. For example, asset name, root layer identifier, asset version etc.

Note: It is only valid to author assetInfo on attributes that are of type SdfAssetPath.

property comment

A comment describing the property.

property custom

Whether this property spec declares a custom attribute.

property customData

The property’s custom data.

The default value for custom data is an empty dictionary.

Custom data is for use by plugins or other non-tools supplied extensions that need to be able to store data attached to arbitrary scene objects. Note that if the only objects you want to store data on are prims, using custom attributes is probably a better choice. But if you need to possibly store this data on attributes or relationships or as annotations on reference arcs, then custom data is an appropriate choice.

property default

The default value of this property.

property displayGroup

DisplayGroup for the property.

property displayName

DisplayName for the property.

property documentation

Documentation for the property.

property expired
property hasOnlyRequiredFields

Indicates whether this spec has any significant data other than just what is necessary for instantiation.

This is a less strict version of isInert, returning True if the spec contains as much as the type and name.

property hidden

Whether this property will be hidden in browsers.

property name

The name of the property.

property owner

The owner of this property. Either a relationship or a prim.

property permission

The property’s permission restriction.

property prefix

Prefix for the property.

property symmetricPeer

The property’s symmetric peer.

property symmetryArguments

Dictionary with property symmetry arguments.

Although this property is marked read-only, you can modify the contents to add, change, and clear symmetry arguments.

property symmetryFunction

The property’s symmetry function.

property variability

Returns the variability of the property.

An attribute’s variability may be Varying Uniform, Config or Computed. For an attribute, the default is Varying, for a relationship the default is Uniform.

Varying relationships may be directly authored ‘animating’ targetpaths over time. Varying attributes may be directly authored, animated and affected on by Actions. They are the most flexible.

Uniform attributes may be authored only with non-animated values (default values). They cannot be affected by Actions, but they can be connected to other Uniform attributes.

Config attributes are the same as Uniform except that a Prim can choose to alter its collection of built-in properties based on the values of its Config attributes.

Computed attributes may not be authored in scene description. Prims determine the values of their Computed attributes through Prim-specific computation. They may not be connected.

class pxr.Sdf.PseudoRootSpec

Bases: pxr.Sdf.PrimSpec

Raises an exception This class cannot be instantiated from Python

property expired
class pxr.Sdf.Reference

Bases: Boost.Python.instance

IsInternal()
property assetPath
property customData
property layerOffset
property primPath
class pxr.Sdf.ReferenceListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.RelationshipSpec(ownerPrimSpec, name, custom=True, variability=Sd.VariabilityUniform)

Bases: pxr.Sdf.PropertySpec

ownerPrimSpec: PrimSpec name : string custom : bool varibility : Sd.Variability

RemoveTargetPath()
ReplaceTargetPath()
TargetsKey = 'targetPaths'
property expired
property noLoadHint

whether the target must be loaded to load the prim this relationship is attached to.

property targetPathList

A PathListEditor for the relationship’s target paths.

The list of the target paths for this relationship may be modified with this PathListEditor.

A PathListEditor may express a list either as an explicit value or as a set of list editing operations. See PathListEditor for more information.

class pxr.Sdf.Spec

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ClearInfo(key)

key : string nClears the value for scene spec info with the given key. After calling this, HasInfo() will return false. To make HasInfo() return true, set a value for that scene spec info.

GetAsText()
GetFallbackForInfo(key)

key : string

Returns the fallback value for the given key.

GetInfo()
GetMetaDataDisplayGroup()
GetMetaDataInfoKeys()
GetTypeForInfo(key)

key : string

Returns the type of value for the given key.

HasInfo(key)bool

key : string

Returns whether there is a setting for the scene spec info with the given key.

When asked for a value for one of its scene spec info, a valid value will always be returned. But if this API returns false for a scene spec info, the value of that info will be the defined default value.

(XXX: This may change such that it is an error to ask for a value when there is none).

When dealing with a composedLayer, it is not necessary to worry about whether a scene spec info ‘has a value’ because the composed layer will always have a valid value, even if it is the default.

A spec may or may not have an expressed value for some of its scene spec info.

IsInert()

Indicates whether this spec has any significant data. If ignoreChildren is true, child scenegraph objects will be ignored.

ListInfoKeys()
SetInfo()
SetInfoDictionaryValue()
property expired
property isInert

Indicates whether this spec has any significant data. This is for backwards compatibility, use IsInert instead.

Compatibility note: prior to presto 1.9, isInert (then isEmpty) was true for otherwise inert PrimSpecs with inert inherits, references, or variant sets. isInert is now false in such conditions.

property layer

The owning layer.

property path

The absolute scene path.

class pxr.Sdf.SpecType

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.SpecTypeUnknown, Sdf.SpecTypeAttribute, Sdf.SpecTypeConnection, Sdf.SpecTypeExpression, Sdf.SpecTypeMapper, Sdf.SpecTypeMapperArg, Sdf.SpecTypePrim, Sdf.SpecTypePseudoRoot, Sdf.SpecTypeRelationship, Sdf.SpecTypeRelationshipTarget, Sdf.SpecTypeVariant, Sdf.SpecTypeVariantSet)
class pxr.Sdf.Specifier

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.SpecifierDef, Sdf.SpecifierOver, Sdf.SpecifierClass)
class pxr.Sdf.StringListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.TimeCode

Bases: Boost.Python.instance

GetValue()
class pxr.Sdf.TimeCodeArray(values)

Bases: Boost.Python.instance

An array of type SdfTimeCode.

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

__init__(values)

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

__init__(values)

values: a sequence (tuple, list, or another VtArray with element type convertible to the new array’s element type)

class pxr.Sdf.TokenListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.UInt64ListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.UIntListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.UnregisteredValue

Bases: Boost.Python.instance

property value
class pxr.Sdf.UnregisteredValueListOp

Bases: Boost.Python.instance

ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.ValueBlock

Bases: Boost.Python.instance

class pxr.Sdf.ValueRoleNames

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Color = 'Color'
EdgeIndex = 'EdgeIndex'
FaceIndex = 'FaceIndex'
Frame = 'Frame'
Normal = 'Normal'
Point = 'Point'
PointIndex = 'PointIndex'
TextureCoordinate = 'TextureCoordinate'
Transform = 'Transform'
Vector = 'Vector'
class pxr.Sdf.ValueTypeName

Bases: Boost.Python.instance

property aliasesAsStrings
property arrayType
property cppTypeName
property defaultUnit
property defaultValue
property isArray
property isScalar
property role
property scalarType
property type
class pxr.Sdf.ValueTypeNames

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Asset = <pxr.Sdf.ValueTypeName object>
AssetArray = <pxr.Sdf.ValueTypeName object>
Bool = <pxr.Sdf.ValueTypeName object>
BoolArray = <pxr.Sdf.ValueTypeName object>
Color3d = <pxr.Sdf.ValueTypeName object>
Color3dArray = <pxr.Sdf.ValueTypeName object>
Color3f = <pxr.Sdf.ValueTypeName object>
Color3fArray = <pxr.Sdf.ValueTypeName object>
Color3h = <pxr.Sdf.ValueTypeName object>
Color3hArray = <pxr.Sdf.ValueTypeName object>
Color4d = <pxr.Sdf.ValueTypeName object>
Color4dArray = <pxr.Sdf.ValueTypeName object>
Color4f = <pxr.Sdf.ValueTypeName object>
Color4fArray = <pxr.Sdf.ValueTypeName object>
Color4h = <pxr.Sdf.ValueTypeName object>
Color4hArray = <pxr.Sdf.ValueTypeName object>
Double = <pxr.Sdf.ValueTypeName object>
Double2 = <pxr.Sdf.ValueTypeName object>
Double2Array = <pxr.Sdf.ValueTypeName object>
Double3 = <pxr.Sdf.ValueTypeName object>
Double3Array = <pxr.Sdf.ValueTypeName object>
Double4 = <pxr.Sdf.ValueTypeName object>
Double4Array = <pxr.Sdf.ValueTypeName object>
DoubleArray = <pxr.Sdf.ValueTypeName object>
static Find()
Float = <pxr.Sdf.ValueTypeName object>
Float2 = <pxr.Sdf.ValueTypeName object>
Float2Array = <pxr.Sdf.ValueTypeName object>
Float3 = <pxr.Sdf.ValueTypeName object>
Float3Array = <pxr.Sdf.ValueTypeName object>
Float4 = <pxr.Sdf.ValueTypeName object>
Float4Array = <pxr.Sdf.ValueTypeName object>
FloatArray = <pxr.Sdf.ValueTypeName object>
Frame4d = <pxr.Sdf.ValueTypeName object>
Frame4dArray = <pxr.Sdf.ValueTypeName object>
Half = <pxr.Sdf.ValueTypeName object>
Half2 = <pxr.Sdf.ValueTypeName object>
Half2Array = <pxr.Sdf.ValueTypeName object>
Half3 = <pxr.Sdf.ValueTypeName object>
Half3Array = <pxr.Sdf.ValueTypeName object>
Half4 = <pxr.Sdf.ValueTypeName object>
Half4Array = <pxr.Sdf.ValueTypeName object>
HalfArray = <pxr.Sdf.ValueTypeName object>
Int = <pxr.Sdf.ValueTypeName object>
Int2 = <pxr.Sdf.ValueTypeName object>
Int2Array = <pxr.Sdf.ValueTypeName object>
Int3 = <pxr.Sdf.ValueTypeName object>
Int3Array = <pxr.Sdf.ValueTypeName object>
Int4 = <pxr.Sdf.ValueTypeName object>
Int4Array = <pxr.Sdf.ValueTypeName object>
Int64 = <pxr.Sdf.ValueTypeName object>
Int64Array = <pxr.Sdf.ValueTypeName object>
IntArray = <pxr.Sdf.ValueTypeName object>
Matrix2d = <pxr.Sdf.ValueTypeName object>
Matrix2dArray = <pxr.Sdf.ValueTypeName object>
Matrix3d = <pxr.Sdf.ValueTypeName object>
Matrix3dArray = <pxr.Sdf.ValueTypeName object>
Matrix4d = <pxr.Sdf.ValueTypeName object>
Matrix4dArray = <pxr.Sdf.ValueTypeName object>
Normal3d = <pxr.Sdf.ValueTypeName object>
Normal3dArray = <pxr.Sdf.ValueTypeName object>
Normal3f = <pxr.Sdf.ValueTypeName object>
Normal3fArray = <pxr.Sdf.ValueTypeName object>
Normal3h = <pxr.Sdf.ValueTypeName object>
Normal3hArray = <pxr.Sdf.ValueTypeName object>
Point3d = <pxr.Sdf.ValueTypeName object>
Point3dArray = <pxr.Sdf.ValueTypeName object>
Point3f = <pxr.Sdf.ValueTypeName object>
Point3fArray = <pxr.Sdf.ValueTypeName object>
Point3h = <pxr.Sdf.ValueTypeName object>
Point3hArray = <pxr.Sdf.ValueTypeName object>
Quatd = <pxr.Sdf.ValueTypeName object>
QuatdArray = <pxr.Sdf.ValueTypeName object>
Quatf = <pxr.Sdf.ValueTypeName object>
QuatfArray = <pxr.Sdf.ValueTypeName object>
Quath = <pxr.Sdf.ValueTypeName object>
QuathArray = <pxr.Sdf.ValueTypeName object>
String = <pxr.Sdf.ValueTypeName object>
StringArray = <pxr.Sdf.ValueTypeName object>
TexCoord2d = <pxr.Sdf.ValueTypeName object>
TexCoord2dArray = <pxr.Sdf.ValueTypeName object>
TexCoord2f = <pxr.Sdf.ValueTypeName object>
TexCoord2fArray = <pxr.Sdf.ValueTypeName object>
TexCoord2h = <pxr.Sdf.ValueTypeName object>
TexCoord2hArray = <pxr.Sdf.ValueTypeName object>
TexCoord3d = <pxr.Sdf.ValueTypeName object>
TexCoord3dArray = <pxr.Sdf.ValueTypeName object>
TexCoord3f = <pxr.Sdf.ValueTypeName object>
TexCoord3fArray = <pxr.Sdf.ValueTypeName object>
TexCoord3h = <pxr.Sdf.ValueTypeName object>
TexCoord3hArray = <pxr.Sdf.ValueTypeName object>
TimeCode = <pxr.Sdf.ValueTypeName object>
TimeCodeArray = <pxr.Sdf.ValueTypeName object>
Token = <pxr.Sdf.ValueTypeName object>
TokenArray = <pxr.Sdf.ValueTypeName object>
UChar = <pxr.Sdf.ValueTypeName object>
UCharArray = <pxr.Sdf.ValueTypeName object>
UInt = <pxr.Sdf.ValueTypeName object>
UInt64 = <pxr.Sdf.ValueTypeName object>
UInt64Array = <pxr.Sdf.ValueTypeName object>
UIntArray = <pxr.Sdf.ValueTypeName object>
Vector3d = <pxr.Sdf.ValueTypeName object>
Vector3dArray = <pxr.Sdf.ValueTypeName object>
Vector3f = <pxr.Sdf.ValueTypeName object>
Vector3fArray = <pxr.Sdf.ValueTypeName object>
Vector3h = <pxr.Sdf.ValueTypeName object>
Vector3hArray = <pxr.Sdf.ValueTypeName object>
class pxr.Sdf.Variability

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Sdf.VariabilityVarying, Sdf.VariabilityUniform)
class pxr.Sdf.VariantSetSpec

Bases: pxr.Sdf.Spec

RemoveVariant()
property expired
property name

The variant set’s name.

property owner

The prim that this variant set belongs to.

property variantList

The variants in this variant set as a list.

property variants

The variants in this variant set as a dict.

class pxr.Sdf.VariantSpec

Bases: pxr.Sdf.Spec

GetVariantNames()
property expired
property name

The variant’s name.

property owner

The variant set that this variant belongs to.

property primSpec

The root prim of this variant.

property variantSets

Sdr module

Python bindings for libSdr

class pxr.Sdr.NodeContext

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Displacement = 'displacement'
Light = 'light'
LightFilter = 'lightFilter'
Pattern = 'pattern'
PixelFilter = 'pixelFilter'
SampleFilter = 'sampleFilter'
Surface = 'surface'
Volume = 'volume'
class pxr.Sdr.NodeMetadata

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Category = 'category'
Departments = 'departments'
Help = 'help'
ImplementationName = '__SDR__implementationName'
Label = 'label'
Pages = 'pages'
Primvars = 'primvars'
Role = 'role'
Target = '__SDR__target'
class pxr.Sdr.NodeRole

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Field = 'field'
Math = 'math'
Primvar = 'primvar'
Texture = 'texture'
class pxr.Sdr.PropertyMetadata

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Colorspace = '__SDR__colorspace'
Connectable = 'connectable'
DefaultInput = '__SDR__defaultinput'
Help = 'help'
Hints = 'hints'
ImplementationName = '__SDR__implementationName'
IsAssetIdentifier = '__SDR__isAssetIdentifier'
IsDynamicArray = 'isDynamicArray'
Label = 'label'
Options = 'options'
Page = 'page'
RenderType = 'renderType'
Role = 'role'
Target = '__SDR__target'
ValidConnectionTypes = 'validConnectionTypes'
VstructConditionalExpr = 'vstructConditionalExpr'
VstructMemberName = 'vstructMemberName'
VstructMemberOf = 'vstructMemberOf'
Widget = 'widget'
class pxr.Sdr.PropertyRole

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

None = 'none'
class pxr.Sdr.PropertyTypes

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

Color = 'color'
Float = 'float'
Int = 'int'
Matrix = 'matrix'
Normal = 'normal'
Point = 'point'
String = 'string'
Struct = 'struct'
Terminal = 'terminal'
Unknown = 'unknown'
Vector = 'vector'
Vstruct = 'vstruct'
class pxr.Sdr.Registry

Bases: pxr.Ndr.Registry

GetShaderNodeByIdentifier()
GetShaderNodeByIdentifierAndType()
GetShaderNodeByName()
GetShaderNodeByNameAndType()
GetShaderNodeFromAsset()
GetShaderNodeFromSourceCode()
GetShaderNodesByFamily()
GetShaderNodesByIdentifier()
GetShaderNodesByName()
property expired

True if this object has expired, False otherwise.

class pxr.Sdr.ShaderNode

Bases: pxr.Ndr.Node

Raises an exception This class cannot be instantiated from Python

GetAdditionalPrimvarProperties()
GetAllVstructNames()
GetAssetIdentifierInputNames()
GetCategory()
GetDefaultInput()
GetDepartments()
GetHelp()
GetImplementationName()
GetLabel()
GetPages()
GetPrimvars()
GetPropertyNamesForPage()
GetRole()
GetShaderInput()
GetShaderOutput()
class pxr.Sdr.ShaderNodeList

Bases: Boost.Python.instance

append()
extend()
class pxr.Sdr.ShaderProperty

Bases: pxr.Ndr.Property

Raises an exception This class cannot be instantiated from Python

GetHelp()
GetHints()
GetImplementationName()
GetLabel()
GetOptions()
GetPage()
GetVStructConditionalExpr()
GetVStructMemberName()
GetVStructMemberOf()
GetValidConnectionTypes()
GetWidget()
IsAssetIdentifier()
IsDefaultInput()
IsVStruct()
IsVStructMember()

Tf module

Tf – Tools Foundation

class pxr.Tf.CallContext

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property file
property function
property line
property prettyFunction
class pxr.Tf.Debug

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

static GetDebugSymbolDescription()
static GetDebugSymbolDescriptions()
static GetDebugSymbolNames()
static IsDebugSymbolNameEnabled()
static SetDebugSymbolsByName()
static SetOutputFile()
class pxr.Tf.DiagnosticType

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Tf.TF_DIAGNOSTIC_CODING_ERROR_TYPE, Tf.TF_DIAGNOSTIC_FATAL_CODING_ERROR_TYPE, Tf.TF_DIAGNOSTIC_RUNTIME_ERROR_TYPE, Tf.TF_DIAGNOSTIC_FATAL_ERROR_TYPE, Tf.TF_DIAGNOSTIC_NONFATAL_ERROR_TYPE, Tf.TF_DIAGNOSTIC_WARNING_TYPE, Tf.TF_DIAGNOSTIC_STATUS_TYPE, Tf.TF_APPLICATION_EXIT_TYPE)
class pxr.Tf.Enum

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

static GetValueFromFullName()
class pxr.Tf.Error

Bases: pxr.Tf._DiagnosticBase

Raises an exception This class cannot be instantiated from Python

class Mark

Bases: Boost.Python.instance

Clear()
GetErrors()

A list of the errors held by this mark.

IsClean()
SetMark()
property errorCode

The error code posted for this error.

property errorCodeString

The error code posted for this error, as a string.

exception pxr.Tf.ErrorException(*args)

Bases: RuntimeError

pxr.Tf.Fatal(msg)

Raise a fatal error to the Tf Diagnostic system.

pxr.Tf.GetCodeLocation(framesUp)

Returns a tuple (moduleName, functionName, fileName, lineNo).

To trace the current location of python execution, use GetCodeLocation(). By default, the information is returned at the current stack-frame; thus

info = GetCodeLocation()

will return information about the line that GetCodeLocation() was called from. One can write:

def genericDebugFacility():

info = GetCodeLocation(1) # print out data

def someCode():

… if bad:

genericDebugFacility()

and genericDebugFacility() will get information associated with its caller, i.e. the function someCode().

class pxr.Tf.MallocTag

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class CallTree

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class CallSite

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property nBytes
property name
GetCallSites()
GetPrettyPrintString()
GetRoot()
LogReport()
class PathNode

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

GetChildren()
property nAllocations
property nBytes
property nBytesDirect
property siteName
Report()
static GetCallStacks()
static GetCallTree()
static GetMaxTotalBytes()
static GetTotalBytes()
static Initialize()
static IsInitialized()
static SetCapturedMallocStacksMatchList()
static SetDebugMatchList()
class pxr.Tf.NamedTemporaryFile(suffix='', prefix='', dir=None, text=False)

Bases: object

A named temporary file which keeps the internal file handle closed. A class which constructs a temporary file(that isn’t open) on __enter__, provides its name as an attribute, and deletes it on __exit__.

Note: The constructor args for this object match those of python’s tempfile.mkstemp() function, and will have the same effect on the underlying file created.

property name

The path for the temporary file created.

class pxr.Tf.Notice

Bases: Boost.Python.instance

class Listener

Bases: Boost.Python.instance

Represents the Notice connection between senders and receivers of notices. When a Listener object expires the connection is broken. You can also use the Revoke() function to break the connection. A Listener object is returned from the Register() and RegisterGlobally() functions.

Raises an exception This class cannot be instantiated from Python

Revoke()

Revoke()

Revoke interest by a notice listener. This function revokes interest in the particular notice type and call-back method that its Listener object was registered for.

static Register(noticeType, callback, sender) → Listener

noticeType : Tf.Notice callback : function sender : object

Register a listener as being interested in a TfNotice type from a specific sender. Notice listener will get sender as an argument. Registration of interest in a notice class N automatically registers interest in all classes derived from N. When a notice of appropriate type is received, the listening object’s member-function method is called with the notice. To reverse the registration, call Revoke() on the Listener object returned by this call.

Register( noticeType, callback, sender ) -> Listener

noticeType : Tf.Notice callback : function sender : object

Register a listener as being interested in a TfNotice type from a specific sender. Notice listener will get sender as an argument. Registration of interest in a notice class N automatically registers interest in all classes derived from N. When a notice of appropriate type is received, the listening object’s member-function method is called with the notice. To reverse the registration, call Revoke() on the Listener object returned by this call.

static RegisterGlobally(noticeType, callback) → Listener

noticeType : Tf.Notice callback : function

Register a listener as being interested in a TfNotice type from any sender. The notice listener does not get sender as an argument.

Send()

Send(sender)

sender : object

Deliver the notice to interested listeners, returning the number of interested listeners. This is the recommended form of Send. It takes the sender as an argument. Listeners that registered for the given sender AND listeners that registered globally will get the notice.

Send(sender)

sender : object

Deliver the notice to interested listeners, returning the number of interested listeners. This is the recommended form of Send. It takes the sender as an argument. Listeners that registered for the given sender AND listeners that registered globally will get the notice.

SendGlobally()

SendGlobally()

Deliver the notice to interested listeners. For most clients it is recommended to use the Send(sender) version of Send() rather than this one. Clients that use this form of Send will prevent listeners from being able to register to receive notices based on the sender of the notice. ONLY listeners that registered globally will get the notice.

pxr.Tf.PrepareModule(module, result)

PrepareModule(module, result) – Prepare an extension module at import time. Generally, this should only be called by the __init__.py script for a module upon loading a boost python module (generally ‘_LibName.so’).

class pxr.Tf.PyModuleWasLoaded

Bases: pxr.Tf.Notice

Raises an exception This class cannot be instantiated from Python

name()
pxr.Tf.RaiseCodingError(msg)

Raise a coding error to the Tf Diagnostic system.

pxr.Tf.RaiseRuntimeError(msg)

Raise a runtime error to the Tf Diagnostic system.

class pxr.Tf.RefPtrTracker

Bases: Boost.Python.instance

GetAllTracesReport()
GetAllWatchedCountsReport()
GetTracesReportForWatched()
property expired

True if this object has expired, False otherwise.

class pxr.Tf.ScopeDescription

Bases: Boost.Python.instance

SetDescription()
class pxr.Tf.ScriptModuleLoader

Bases: Boost.Python.instance

GetModuleNames()
GetModulesDict()
WriteDotFile()
property expired

True if this object has expired, False otherwise.

class pxr.Tf.Singleton

Bases: Boost.Python.instance

pxr.Tf.Status(msg, verbose=True)

Issues a status update to the Tf diagnostic system.

If verbose is True (the default) then information about where in the code the status update was issued from is included.

class pxr.Tf.StatusObject

Bases: pxr.Tf._DiagnosticBase

Raises an exception This class cannot be instantiated from Python

class pxr.Tf.Stopwatch

Bases: Boost.Python.instance

AddFrom()
Reset()
Start()
Stop()
property microseconds
property milliseconds
property nanoseconds
property sampleCount
property seconds
class pxr.Tf.TemplateString

Bases: Boost.Python.instance

GetEmptyMapping()
GetParseErrors()
SafeSubstitute()
Substitute()
property template
property valid
class pxr.Tf.Tf_PyEnumWrapper

Bases: pxr.Tf.Enum

Raises an exception This class cannot be instantiated from Python

property displayName
property fullName
property name
property value
class pxr.Tf.Tf_TestAnnotatedBoolResult

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property annotation
class pxr.Tf.Tf_TestPyContainerConversions

Bases: Boost.Python.instance

static GetPairTimesTwo()
static GetTokens()
static GetVectorTimesTwo()
class pxr.Tf.Tf_TestPyOptional

Bases: Boost.Python.instance

static TakesOptional()
static TestOptionalChar()
static TestOptionalDouble()
static TestOptionalFloat()
static TestOptionalInt()
static TestOptionalLong()
static TestOptionalShort()
static TestOptionalString()
static TestOptionalStringVector()
static TestOptionalUChar()
static TestOptionalUInt()
static TestOptionalULong()
static TestOptionalUShort()
class pxr.Tf.Type

Bases: Boost.Python.instance

AddAlias()
static Define()
static Find()
static FindByName()
FindDerivedByName()
GetAliases()
GetAllAncestorTypes()
GetAllDerivedTypes()
static GetRoot()
IsA()
Unknown = Tf.Type.Unknown
property baseTypes
property derivedTypes
property isEnumType
property isPlainOldDataType
property isUnknown
property pythonClass
property sizeof
property typeName
pxr.Tf.Warn(msg, template='')

Issue a warning via the TfDiagnostic system.

At this time, template is ignored.

class pxr.Tf.Warning

Bases: pxr.Tf._DiagnosticBase

Raises an exception This class cannot be instantiated from Python

Trace module

Trace – Utilities for counting and recording events.

class pxr.Trace.AggregateNode

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

property children
property count
property exclusiveCount
property exclusiveTime
property expanded
property expired

True if this object has expired, False otherwise.

property id
property inclusiveTime
property key
class pxr.Trace.Collector

Bases: Boost.Python.instance

BeginEvent()
BeginEventAtTime()
Clear()
EndEvent()
EndEventAtTime()
GetLabel()
property enabled
property expired

True if this object has expired, False otherwise.

property pythonTracingEnabled
class pxr.Trace.Reporter

Bases: Boost.Python.instance

ClearTree()
GetLabel()
Report()
ReportChromeTracing()
ReportChromeTracingToFile()
ReportTimes()
UpdateTraceTrees()
property aggregateTreeRoot
property expired

True if this object has expired, False otherwise.

property foldRecursiveCalls
globalReporter = <pxr.Trace.Reporter object>
property groupByFunction
pxr.Trace.TraceFunction(obj)

A decorator that enables tracing the function that it decorates. If you decorate with ‘TraceFunction’ the function will be traced in the global collector.

pxr.Trace.TraceMethod(obj)

A convenience. Same as TraceFunction but changes the recorded label to use the term ‘method’ rather than ‘function’.

pxr.Trace.TraceScope(label)

A context manager that calls BeginEvent on the global collector on enter and EndEvent on exit.

Usd module

class pxr.Usd.APISchemaBase

Bases: pxr.Usd.SchemaBase

Raises an exception This class cannot be instantiated from Python

static GetSchemaAttributeNames()
class pxr.Usd.AssetInfoKeys

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

identifier = 'identifier'
name = 'name'
payloadAssetDependencies = 'payloadAssetDependencies'
version = 'version'
class pxr.Usd.Attribute

Bases: pxr.Usd.Property

AddConnection()
Block()
BlockConnections()
Clear()
ClearAtTime()
ClearColorSpace()
ClearConnections()
ClearDefault()
Get()
GetBracketingTimeSamples()
GetColorSpace()
GetConnections()
GetNumTimeSamples()
GetResolveInfo()
GetRoleName()
GetTimeSamples()
GetTimeSamplesInInterval()
GetTypeName()
static GetUnionedTimeSamples()
static GetUnionedTimeSamplesInInterval()
GetVariability()
HasAuthoredConnections()
HasAuthoredValue()
HasAuthoredValueOpinion()
HasColorSpace()
HasFallbackValue()
HasValue()
RemoveConnection()
Set()
SetColorSpace()
SetConnections()
SetTypeName()
SetVariability()
ValueMightBeTimeVarying()
class pxr.Usd.AttributeQuery

Bases: Boost.Python.instance

static CreateQueries()
Get()
GetAttribute()
GetBracketingTimeSamples()
GetNumTimeSamples()
GetTimeSamples()
GetTimeSamplesInInterval()
static GetUnionedTimeSamples()
static GetUnionedTimeSamplesInInterval()
HasAuthoredValue()
HasAuthoredValueOpinion()
HasFallbackValue()
HasValue()
IsValid()
ValueMightBeTimeVarying()
class pxr.Usd.ClipsAPI

Bases: pxr.Usd.APISchemaBase

ComputeClipAssetPaths()
GenerateClipManifest()
static GenerateClipManifestFromLayers()
static Get()
GetClipActive()
GetClipAssetPaths()
GetClipManifestAssetPath()
GetClipPrimPath()
GetClipSets()
GetClipTemplateActiveOffset()
GetClipTemplateAssetPath()
GetClipTemplateEndTime()
GetClipTemplateStartTime()
GetClipTemplateStride()
GetClipTimes()
GetClips()
GetInterpolateMissingClipValues()
static GetSchemaAttributeNames()
SetClipActive()
SetClipAssetPaths()
SetClipManifestAssetPath()
SetClipPrimPath()
SetClipSets()
SetClipTemplateActiveOffset()
SetClipTemplateAssetPath()
SetClipTemplateEndTime()
SetClipTemplateStartTime()
SetClipTemplateStride()
SetClipTimes()
SetClips()
SetInterpolateMissingClipValues()
class pxr.Usd.CollectionAPI

Bases: pxr.Usd.APISchemaBase

static ApplyCollection()
BlockCollection()
static ComputeIncludedObjects()
static ComputeIncludedPaths()
ComputeMembershipQuery()
CreateExcludesRel()
CreateExpansionRuleAttr()
CreateIncludeRootAttr()
CreateIncludesRel()
ExcludePath()
static Get()
static GetAllCollections()
static GetCollection()
GetCollectionPath()
GetExcludesRel()
GetExpansionRuleAttr()
GetIncludeRootAttr()
GetIncludesRel()
GetName()
static GetNamedCollectionPath()
static GetSchemaAttributeNames()
HasNoIncludedPaths()
IncludePath()
static IsCollectionAPIPath()
static IsSchemaPropertyBaseName()
ResetCollection()
Validate()
class pxr.Usd.CompositionArc

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

GetArcType()
GetIntroducingLayer()
GetIntroducingListEditor()
GetIntroducingNode()
GetIntroducingPrimPath()
GetTargetNode()
HasSpecs()
IsAncestral()
IsImplicit()
IsIntroducedInRootLayerPrimSpec()
IsIntroducedInRootLayerStack()
class pxr.Usd.CrateInfo

Bases: Boost.Python.instance

GetFileVersion()
GetSections()
GetSoftwareVersion()
GetSummaryStats()
static Open()
class Section

Bases: Boost.Python.instance

property name
property size
property start
class SummaryStats

Bases: Boost.Python.instance

property numSpecs
property numUniqueFieldSets
property numUniqueFields
property numUniquePaths
property numUniqueStrings
property numUniqueTokens
class pxr.Usd.EditContext

Bases: Boost.Python.instance

class pxr.Usd.EditTarget

Bases: Boost.Python.instance

ComposeOver()
static ForLocalDirectVariant()
GetLayer()
GetMapFunction()
GetPrimSpecForScenePath()
GetPropertySpecForScenePath()
GetSpecForScenePath()
IsNull()
IsValid()
MapToSpecPath()
class pxr.Usd.Inherits

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

AddInherit()
ClearInherits()
GetAllDirectInherits()
GetPrim()
RemoveInherit()
SetInherits()
class pxr.Usd.InterpolationType

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Usd.InterpolationTypeHeld, Usd.InterpolationTypeLinear)
class pxr.Usd.ListPosition

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Usd.ListPositionFrontOfPrependList, Usd.ListPositionBackOfPrependList, Usd.ListPositionFrontOfAppendList, Usd.ListPositionBackOfAppendList)
class pxr.Usd.LoadPolicy

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Usd.LoadWithDescendants, Usd.LoadWithoutDescendants)
class pxr.Usd.ModelAPI

Bases: pxr.Usd.APISchemaBase

static Get()
GetAssetIdentifier()
GetAssetInfo()
GetAssetName()
GetAssetVersion()
GetKind()
GetPayloadAssetDependencies()
static GetSchemaAttributeNames()
IsGroup()
IsKind()
IsModel()
class KindValidation

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Usd.ModelAPI.KindValidationNone, Usd.ModelAPI.KindValidationModelHierarchy)
KindValidationModelHierarchy = Usd.ModelAPI.KindValidationModelHierarchy
KindValidationNone = Usd.ModelAPI.KindValidationNone
SetAssetIdentifier()
SetAssetInfo()
SetAssetName()
SetAssetVersion()
SetKind()
SetPayloadAssetDependencies()
class pxr.Usd.Notice

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

class ObjectsChanged

Bases: pxr.Usd.StageNotice

Raises an exception This class cannot be instantiated from Python

AffectedObject()
ChangedInfoOnly()
GetChangedFields()
GetChangedInfoOnlyPaths()
GetFastUpdates()
GetResyncedPaths()
HasChangedFields()
ResyncedObject()
class StageContentsChanged

Bases: pxr.Usd.StageNotice

Raises an exception This class cannot be instantiated from Python

class StageEditTargetChanged

Bases: pxr.Usd.StageNotice

Raises an exception This class cannot be instantiated from Python

class StageNotice

Bases: pxr.Tf.Notice

Raises an exception This class cannot be instantiated from Python

GetStage()
class pxr.Usd.Object

Bases: Boost.Python.instance

ClearAssetInfo()
ClearAssetInfoByKey()
ClearCustomData()
ClearCustomDataByKey()
ClearDocumentation()
ClearHidden()
ClearMetadata()
ClearMetadataByDictKey()
GetAllAuthoredMetadata()
GetAllMetadata()
GetAssetInfo()
GetAssetInfoByKey()
GetCustomData()
GetCustomDataByKey()
GetDescription()
GetDocumentation()
GetMetadata()
GetMetadataByDictKey()
GetName()
static GetNamespaceDelimiter()
GetPath()
GetPrim()
GetPrimPath()
GetStage()
HasAssetInfo()
HasAssetInfoKey()
HasAuthoredAssetInfo()
HasAuthoredAssetInfoKey()
HasAuthoredCustomData()
HasAuthoredCustomDataKey()
HasAuthoredDocumentation()
HasAuthoredHidden()
HasAuthoredMetadata()
HasAuthoredMetadataDictKey()
HasCustomData()
HasCustomDataKey()
HasMetadata()
HasMetadataDictKey()
IsHidden()
IsValid()
SetAssetInfo()
SetAssetInfoByKey()
SetCustomData()
SetCustomDataByKey()
SetDocumentation()
SetHidden()
SetMetadata()
SetMetadataByDictKey()
class pxr.Usd.Payloads

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

AddInternalPayload()
AddPayload()
ClearPayloads()
GetPrim()
RemovePayload()
SetPayloads()
class pxr.Usd.Prim

Bases: pxr.Usd.Object

AddAppliedSchema()
ApplyAPI()
ClearActive()
ClearInstanceable()
ClearPayload()
ClearTypeName()
ComputeExpandedPrimIndex()
CreateAttribute()
CreateRelationship()
FindAllAttributeConnectionPaths()
FindAllRelationshipTargetPaths()
GetAllChildren()
GetAppliedSchemas()
GetAttribute()
GetAttributeAtPath()
GetAttributes()
GetAuthoredAttributes()
GetAuthoredProperties()
GetAuthoredPropertiesInNamespace()
GetAuthoredPropertyNames()
GetAuthoredRelationships()
GetChild()
GetChildren()
GetFilteredChildren()
GetFilteredNextSibling()
GetInherits()
GetInstances()
GetMaster()
GetNextSibling()
GetObjectAtPath()
GetParent()
GetPayloads()
GetPrimAtPath()
GetPrimDefinition()
GetPrimInMaster()
GetPrimIndex()
GetPrimStack()
GetPrimTypeInfo()
GetProperties()
GetPropertiesInNamespace()
GetProperty()
GetPropertyAtPath()
GetPropertyNames()
GetPropertyOrder()
GetReferences()
GetRelationship()
GetRelationshipAtPath()
GetRelationships()
GetSpecializes()
GetSpecifier()
GetTypeName()
GetVariantSet()
GetVariantSets()
HasAPI()
HasAttribute()
HasAuthoredActive()
HasAuthoredInherits()
HasAuthoredInstanceable()
HasAuthoredPayloads()
HasAuthoredReferences()
HasAuthoredSpecializes()
HasAuthoredTypeName()
HasDefiningSpecifier()
HasPayload()
HasProperty()
HasRelationship()
HasVariantSets()
IsA()
IsAbstract()
IsActive()
IsDefined()
IsGroup()
IsInMaster()
IsInstance()
IsInstanceProxy()
IsInstanceable()
IsLoaded()
IsMaster()
IsModel()
IsPseudoRoot()
Load()
RemoveAPI()
RemoveAppliedSchema()
RemoveProperty()
SetActive()
SetInstanceable()
SetPayload()
SetPropertyOrder()
SetSpecifier()
SetTypeName()
Unload()
class pxr.Usd.PrimCompositionQuery

Bases: Boost.Python.instance

class ArcIntroducedFilter

Bases: Boost.Python.enum

All = pxr.Usd.ArcIntroducedFilter.All
IntroducedInRootLayerPrimSpec = pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerPrimSpec
IntroducedInRootLayerStack = pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerStack
names = {'All': pxr.Usd.ArcIntroducedFilter.All, 'IntroducedInRootLayerPrimSpec': pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerPrimSpec, 'IntroducedInRootLayerStack': pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerStack}
values = {0: pxr.Usd.ArcIntroducedFilter.All, 1: pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerStack, 2: pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerPrimSpec}
class ArcTypeFilter

Bases: Boost.Python.enum

All = pxr.Usd.ArcTypeFilter.All
Inherit = pxr.Usd.ArcTypeFilter.Inherit
InheritOrSpecialize = pxr.Usd.ArcTypeFilter.InheritOrSpecialize
NotInheritOrSpecialize = pxr.Usd.ArcTypeFilter.NotInheritOrSpecialize
NotReferenceOrPayload = pxr.Usd.ArcTypeFilter.NotReferenceOrPayload
NotVariant = pxr.Usd.ArcTypeFilter.NotVariant
Payload = pxr.Usd.ArcTypeFilter.Payload
Reference = pxr.Usd.ArcTypeFilter.Reference
ReferenceOrPayload = pxr.Usd.ArcTypeFilter.ReferenceOrPayload
Specialize = pxr.Usd.ArcTypeFilter.Specialize
Variant = pxr.Usd.ArcTypeFilter.Variant
names = {'All': pxr.Usd.ArcTypeFilter.All, 'Inherit': pxr.Usd.ArcTypeFilter.Inherit, 'InheritOrSpecialize': pxr.Usd.ArcTypeFilter.InheritOrSpecialize, 'NotInheritOrSpecialize': pxr.Usd.ArcTypeFilter.NotInheritOrSpecialize, 'NotReferenceOrPayload': pxr.Usd.ArcTypeFilter.NotReferenceOrPayload, 'NotVariant': pxr.Usd.ArcTypeFilter.NotVariant, 'Payload': pxr.Usd.ArcTypeFilter.Payload, 'Reference': pxr.Usd.ArcTypeFilter.Reference, 'ReferenceOrPayload': pxr.Usd.ArcTypeFilter.ReferenceOrPayload, 'Specialize': pxr.Usd.ArcTypeFilter.Specialize, 'Variant': pxr.Usd.ArcTypeFilter.Variant}
values = {0: pxr.Usd.ArcTypeFilter.All, 1: pxr.Usd.ArcTypeFilter.Reference, 2: pxr.Usd.ArcTypeFilter.Payload, 3: pxr.Usd.ArcTypeFilter.Inherit, 4: pxr.Usd.ArcTypeFilter.Specialize, 5: pxr.Usd.ArcTypeFilter.Variant, 6: pxr.Usd.ArcTypeFilter.ReferenceOrPayload, 7: pxr.Usd.ArcTypeFilter.InheritOrSpecialize, 8: pxr.Usd.ArcTypeFilter.NotReferenceOrPayload, 9: pxr.Usd.ArcTypeFilter.NotInheritOrSpecialize, 10: pxr.Usd.ArcTypeFilter.NotVariant}
class DependencyTypeFilter

Bases: Boost.Python.enum

All = pxr.Usd.DependencyTypeFilter.All
Ancestral = pxr.Usd.DependencyTypeFilter.Ancestral
Direct = pxr.Usd.DependencyTypeFilter.Direct
names = {'All': pxr.Usd.DependencyTypeFilter.All, 'Ancestral': pxr.Usd.DependencyTypeFilter.Ancestral, 'Direct': pxr.Usd.DependencyTypeFilter.Direct}
values = {0: pxr.Usd.DependencyTypeFilter.All, 1: pxr.Usd.DependencyTypeFilter.Direct, 2: pxr.Usd.DependencyTypeFilter.Ancestral}
class Filter

Bases: Boost.Python.instance

property arcIntroducedFilter
property arcTypeFilter
property dependencyTypeFilter
property hasSpecsFilter
GetCompositionArcs()
static GetDirectInherits()
static GetDirectReferences()
static GetDirectRootLayerArcs()
class HasSpecsFilter

Bases: Boost.Python.enum

All = pxr.Usd.HasSpecsFilter.All
HasNoSpecs = pxr.Usd.HasSpecsFilter.HasNoSpecs
HasSpecs = pxr.Usd.HasSpecsFilter.HasSpecs
names = {'All': pxr.Usd.HasSpecsFilter.All, 'HasNoSpecs': pxr.Usd.HasSpecsFilter.HasNoSpecs, 'HasSpecs': pxr.Usd.HasSpecsFilter.HasSpecs}
values = {0: pxr.Usd.HasSpecsFilter.All, 1: pxr.Usd.HasSpecsFilter.HasSpecs, 2: pxr.Usd.HasSpecsFilter.HasNoSpecs}
property filter
class pxr.Usd.PrimDefinition

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

GetAppliedAPISchemas()
GetAttributeFallbackValue()
GetDocumentation()
GetMetadata()
GetMetadataByDictKey()
GetPropertyDocumentation()
GetPropertyMetadata()
GetPropertyMetadataByDictKey()
GetPropertyNames()
GetSchemaAttributeSpec()
GetSchemaPrimSpec()
GetSchemaPropertySpec()
GetSchemaRelationshipSpec()
ListMetadataFields()
ListPropertyMetadataFields()
class pxr.Usd.PrimRange

Bases: Boost.Python.instance

static AllPrims()
static AllPrimsPreAndPostVisit()
IsValid()

true if the iterator is not yet exhausted

static PreAndPostVisit()
static Stage()
class pxr.Usd.PrimTypeInfo

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

GetAppliedAPISchemas()
static GetEmptyPrimType()
GetPrimDefinition()
GetSchemaType()
GetSchemaTypeName()
GetTypeName()
class pxr.Usd.Property

Bases: pxr.Usd.Object

ClearDisplayGroup()
ClearDisplayName()
FlattenTo()
GetBaseName()
GetDisplayGroup()
GetDisplayName()
GetNamespace()
GetNestedDisplayGroups()
GetPropertyStack()
HasAuthoredDisplayGroup()
HasAuthoredDisplayName()
IsAuthored()
IsAuthoredAt()
IsCustom()
IsDefined()
SetCustom()
SetDisplayGroup()
SetDisplayName()
SetNestedDisplayGroups()
SplitName()
class pxr.Usd.References

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

AddInternalReference()
AddReference()
ClearReferences()
GetPrim()
RemoveReference()
SetReferences()
class pxr.Usd.Relationship

Bases: pxr.Usd.Property

AddTarget()
BlockTargets()
ClearTargets()
GetForwardedTargets()
GetTargets()
HasAuthoredTargets()
RemoveTarget()
SetTargets()
class pxr.Usd.ResolveInfo

Bases: Boost.Python.instance

GetNode()
GetSource()
ValueIsBlocked()
class pxr.Usd.ResolveInfoSource

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Usd.ResolveInfoSourceNone, Usd.ResolveInfoSourceFallback, Usd.ResolveInfoSourceDefault, Usd.ResolveInfoSourceTimeSamples, Usd.ResolveInfoSourceValueClips)
class pxr.Usd.SchemaBase

Bases: Boost.Python.instance

GetPath()
GetPrim()
static GetSchemaAttributeNames()
GetSchemaClassPrimDefinition()
GetSchemaType()
IsAPISchema()
IsAppliedAPISchema()
IsConcrete()
IsMultipleApplyAPISchema()
IsTyped()
class pxr.Usd.SchemaRegistry

Bases: Boost.Python.instance

BuildComposedPrimDefinition()
FindAppliedAPIPrimDefinition()
FindConcretePrimDefinition()
static GetAPISchemaTypeName()
static GetAPITypeFromSchemaTypeName()
static GetConcreteSchemaTypeName()
static GetConcreteTypeFromSchemaTypeName()
GetEmptyPrimDefinition()
GetFallbackPrimTypes()
static GetSchemaTypeName()
static GetTypeFromName()
static GetTypeFromSchemaTypeName()
IsAppliedAPISchema()
IsConcrete()
static IsDisallowedField()
IsMultipleApplyAPISchema()
static IsTyped()
property expired

True if this object has expired, False otherwise.

class pxr.Usd.SchemaType

Bases: Boost.Python.enum

AbstractBase = pxr.Usd.SchemaType.AbstractBase
AbstractTyped = pxr.Usd.SchemaType.AbstractTyped
ConcreteTyped = pxr.Usd.SchemaType.ConcreteTyped
MultipleApplyAPI = pxr.Usd.SchemaType.MultipleApplyAPI
NonAppliedAPI = pxr.Usd.SchemaType.NonAppliedAPI
SingleApplyAPI = pxr.Usd.SchemaType.SingleApplyAPI
names = {'AbstractBase': pxr.Usd.SchemaType.AbstractBase, 'AbstractTyped': pxr.Usd.SchemaType.AbstractTyped, 'ConcreteTyped': pxr.Usd.SchemaType.ConcreteTyped, 'MultipleApplyAPI': pxr.Usd.SchemaType.MultipleApplyAPI, 'NonAppliedAPI': pxr.Usd.SchemaType.NonAppliedAPI, 'SingleApplyAPI': pxr.Usd.SchemaType.SingleApplyAPI}
values = {0: pxr.Usd.SchemaType.AbstractBase, 1: pxr.Usd.SchemaType.AbstractTyped, 2: pxr.Usd.SchemaType.ConcreteTyped, 3: pxr.Usd.SchemaType.NonAppliedAPI, 4: pxr.Usd.SchemaType.SingleApplyAPI, 5: pxr.Usd.SchemaType.MultipleApplyAPI}
class pxr.Usd.Specializes

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

AddSpecialize()
ClearSpecializes()
GetPrim()
RemoveSpecialize()
SetSpecializes()
class pxr.Usd.Stage

Bases: Boost.Python.instance

Raises an exception This class cannot be instantiated from Python

ClearDefaultPrim()
ClearMetadata()
ClearMetadataByDictKey()
CreateClassPrim()
static CreateInMemory()
static CreateNew()
DefinePrim()
ExpandPopulationMask()
Export()
ExportToString()
FindLoadable()
Flatten()
GetAttributeAtPath()
static GetColorConfigFallbacks()
GetColorConfiguration()
GetColorManagementSystem()
GetDefaultPrim()
GetEditTarget()
GetEditTargetForLocalLayer()
GetEndTimeCode()
GetFramesPerSecond()
static GetGlobalVariantFallbacks()
GetInterpolationType()
GetLayerStack()
GetLoadRules()
GetLoadSet()
GetMasters()
GetMetadata()
GetMetadataByDictKey()
GetMutedLayers()
GetObjectAtPath()
GetPathResolverContext()
GetPopulationMask()
GetPrimAtPath()
GetPropertyAtPath()
GetPseudoRoot()
GetRelationshipAtPath()
GetRootLayer()
GetSessionLayer()
GetStartTimeCode()
GetTimeCodesPerSecond()
GetUsedLayers()
HasAuthoredMetadata()
HasAuthoredMetadataDictKey()
HasAuthoredTimeCodeRange()
HasDefaultPrim()
HasLocalLayer()
HasMetadata()
HasMetadataDictKey()
class InitialLoadSet

Bases: pxr.Tf.Tf_PyEnumWrapper

Raises an exception This class cannot be instantiated from Python

static GetValueFromName()
allValues = (Usd.Stage.LoadAll, Usd.Stage.LoadNone)
IsLayerMuted()
static IsSupportedFile()
Load()
LoadAll = Usd.Stage.LoadAll
LoadAndUnload()
LoadNone = Usd.Stage.LoadNone
MuteAndUnmuteLayers()
MuteLayer()
static Open()
static OpenMasked()
OverridePrim()
Reload()
RemovePrim()
ResolveIdentifierToEditTarget()
Save()
SaveSessionLayers()
static SetColorConfigFallbacks()
SetColorConfiguration()
SetColorManagementSystem()
SetDefaultPrim()
SetEditTarget()
SetEndTimeCode()
SetFramesPerSecond()
static SetGlobalVariantFallbacks()
SetInterpolationType()
SetLoadRules()
SetMetadata()
SetMetadataByDictKey()
SetPopulationMask()
SetStartTimeCode()
SetTimeCodesPerSecond()
Traverse()
TraverseAll()
Unload()
UnmuteLayer()
WriteFallbackPrimTypes()
property expired

True if this object has expired, False otherwise.

class pxr.Usd.StageCache

Bases: Boost.Python.instance

Clear()
Contains()
Erase()
EraseAll()
Find()
FindAllMatching()