UsdGeomXform (const UsdPrim &prim=UsdPrim ())
Construct a UsdGeomXform on UsdPrim prim
.
UsdGeomXform (const UsdSchemaBase &schemaObj)
Construct a UsdGeomXform on the prim held by schemaObj
.
virtual USDGEOM_API ~UsdGeomXform ()
Destructor.
UsdGeomXformable (const UsdPrim &prim=UsdPrim ())
Construct a UsdGeomXformable on UsdPrim prim
.
UsdGeomXformable (const UsdSchemaBase &schemaObj)
Construct a UsdGeomXformable on the prim held by schemaObj
.
virtual USDGEOM_API ~UsdGeomXformable ()
Destructor.
USDGEOM_API UsdAttribute GetXformOpOrderAttr () const
Encodes the sequence of transformation operations in the order in which they should be pushed onto a transform stack while visiting a UsdStage 's prims in a graph traversal that will effect the desired positioning for this prim and its descendant prims.
USDGEOM_API UsdAttribute CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue (), bool writeSparsely=false) const
See GetXformOpOrderAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdGeomXformOp AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add an affine transformation to the local stack represented by this Xformable.
USDGEOM_API UsdGeomXformOp GetXformOp (UsdGeomXformOp::Type const opType, TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get an affine transformation from the local stack represented by this Xformable.
USDGEOM_API UsdGeomXformOp AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a translate operation to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetTranslateOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a translate operation from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a scale operation to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetScaleOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a scale operation from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation about the X-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateXOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation about the X-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation about the Y-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateYOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation about the Y-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation about the Z-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateZOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation about the Z-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation op with XYZ rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateXYZOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation op with XYZ rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation op with XZY rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateXZYOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation op with XZY rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation op with YXZ rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateYXZOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation op with YXZ rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation op with YZX rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateYZXOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation op with YZX rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation op with ZXY rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateZXYOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation op with ZXY rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a rotation op with ZYX rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetRotateZYXOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a rotation op with ZYX rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a orient op (arbitrary axis/angle rotation) to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetOrientOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get an orient op (arbitrary axis/angle rotation) from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble , TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Add a tranform op (4x4 matrix transformation) to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp GetTransformOp (TfToken const &opSuffix=TfToken (), bool isInverseOp=false) const
Get a tranform op (4x4 matrix transformation) from the local stack represented by this xformable.
USDGEOM_API bool SetResetXformStack (bool resetXform) const
Specify whether this prim's transform should reset the transformation stack inherited from its parent prim.
USDGEOM_API bool GetResetXformStack () const
Does this prim reset its parent's inherited transformation?
USDGEOM_API bool SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
Reorder the already-existing transform ops on this prim.
USDGEOM_API std::vector< UsdGeomXformOp > GetOrderedXformOps (bool *resetsXformStack) const
Return the ordered list of transform operations to be applied to this prim, in least-to-most-local order.
USDGEOM_API bool ClearXformOpOrder () const
Clears the local transform stack.
USDGEOM_API UsdGeomXformOp MakeMatrixXform () const
Clears the existing local transform stack and creates a new xform op of type 'transform'.
USDGEOM_API bool TransformMightBeTimeVarying () const
Determine whether there is any possibility that this prim's local transformation may vary over time.
USDGEOM_API bool TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Determine whether there is any possibility that this prim's local transformation may vary over time, using a pre-fetched (cached) list of ordered xform ops supplied by the client.
USDGEOM_API bool GetTimeSamples (std::vector< double > *times) const
Sets times
to the union of all the timesamples at which xformOps that are included in the xformOpOrder attribute are authored.
USDGEOM_API bool GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
Sets times
to the union of all the timesamples in the interval, interval
, at which xformOps that are included in the xformOpOrder attribute are authored.
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default ()) const
Computes the fully-combined, local-to-parent transformation for this prim.
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default ()) const
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the fully-combined, local-to-parent transformation for this prim as efficiently as possible, using a pre-fetched (cached) list of ordered xform ops supplied by the client.
UsdGeomImageable (const UsdPrim &prim=UsdPrim ())
Construct a UsdGeomImageable on UsdPrim prim
.
UsdGeomImageable (const UsdSchemaBase &schemaObj)
Construct a UsdGeomImageable on the prim held by schemaObj
.
virtual USDGEOM_API ~UsdGeomImageable ()
Destructor.
USDGEOM_API UsdAttribute GetVisibilityAttr () const
Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps.
USDGEOM_API UsdAttribute CreateVisibilityAttr (VtValue const &defaultValue=VtValue (), bool writeSparsely=false) const
See GetVisibilityAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdAttribute GetPurposeAttr () const
Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals.
USDGEOM_API UsdAttribute CreatePurposeAttr (VtValue const &defaultValue=VtValue (), bool writeSparsely=false) const
See GetPurposeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdRelationship GetProxyPrimRel () const
The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) purpose="proxy" prim.
USDGEOM_API UsdRelationship CreateProxyPrimRel () const
See GetProxyPrimRel() , and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API void MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default ()) const
Make the imageable visible if it is invisible at the given time.
USDGEOM_API void MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default ()) const
Makes the imageable invisible if it is visible at the given time.
USDGEOM_API TfToken ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default ()) const
Calculate the effective visibility of this prim, as defined by its most ancestral authored "invisible" opinion, if any.
USDGEOM_API UsdAttribute GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens ->default_) const
Return the attribute that is used for expressing visibility opinions for the given purpose
.
USDGEOM_API TfToken ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens ->default_, const UsdTimeCode &time=UsdTimeCode::Default ()) const
Calculate the effective purpose visibility of this prim for the given purpose
, taking into account opinions for the corresponding purpose attribute, along with overall visibility opinions.
USDGEOM_API PurposeInfo ComputePurposeInfo () const
Calculate the effective purpose information about this prim which includes final computed purpose value of the prim as well as whether the purpose value should be inherited by namespace children without their own purpose opinions.
USDGEOM_API PurposeInfo ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective purpose information about this prim, given the computed purpose information of its parent prim.
USDGEOM_API TfToken ComputePurpose () const
Calculate the effective purpose information about this prim.
USDGEOM_API UsdPrim ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
Find the prim whose purpose is proxy that serves as the proxy for this prim, as established by the GetProxyPrimRel() , or an invalid UsdPrim if this prim has no proxy.
USDGEOM_API bool SetProxyPrim (const UsdPrim &proxy) const
Convenience function for authoring the renderProxy rel on this prim to target the given proxy
prim.
USDGEOM_API bool SetProxyPrim (const UsdSchemaBase &proxy) const
USDGEOM_API GfBBox3d ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken (), TfToken const &purpose2=TfToken (), TfToken const &purpose3=TfToken (), TfToken const &purpose4=TfToken ()) const
Compute the bound of this prim in world space, at the specified time
, and for the specified purposes.
USDGEOM_API GfBBox3d ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken (), TfToken const &purpose2=TfToken (), TfToken const &purpose3=TfToken (), TfToken const &purpose4=TfToken ()) const
Compute the bound of this prim in local space, at the specified time
, and for the specified purposes.
USDGEOM_API GfBBox3d ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken (), TfToken const &purpose2=TfToken (), TfToken const &purpose3=TfToken (), TfToken const &purpose4=TfToken ()) const
Compute the untransformed bound of this prim, at the specified time
, and for the specified purposes.
USDGEOM_API GfMatrix4d ComputeLocalToWorldTransform (UsdTimeCode const &time) const
Compute the transformation matrix for this prim at the given time, including the transform authored on the Prim itself, if present.
USDGEOM_API GfMatrix4d ComputeParentToWorldTransform (UsdTimeCode const &time) const
Compute the transformation matrix for this prim at the given time, NOT including the transform authored on the prim itself.
UsdTyped (const UsdPrim &prim=UsdPrim ())
Construct a UsdTyped on UsdPrim prim
.
UsdTyped (const UsdSchemaBase &schemaObj)
Construct a UsdTyped on the prim held by schemaObj
.
virtual USD_API ~UsdTyped ()
Destructor.
bool IsConcrete () const
Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.
bool IsTyped () const
Returns whether or not this class inherits from UsdTyped .
bool IsAPISchema () const
Returns whether this is an API schema or not.
bool IsAppliedAPISchema () const
Returns whether this is an applied API schema or not.
bool IsMultipleApplyAPISchema () const
Returns whether this is an applied API schema or not.
UsdSchemaKind GetSchemaKind () const
Returns the kind of schema this class is.
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim ())
Construct and store prim
as the held prim.
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
Construct and store for the same prim held by otherSchema
.
virtual USD_API ~UsdSchemaBase ()
Destructor.
UsdPrim GetPrim () const
Return this schema object's held prim.
SdfPath GetPath () const
Shorthand for GetPrim() ->GetPath() .
USD_API const UsdPrimDefinition * GetSchemaClassPrimDefinition () const
Return the prim definition associated with this schema instance if one exists, otherwise return null.
USD_API operator bool () const
Return true if this schema object is compatible with its held prim, false otherwise.