HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdGeomMotionAPI Class Reference

#include <motionAPI.h>

+ Inheritance diagram for UsdGeomMotionAPI:

Public Member Functions

 UsdGeomMotionAPI (const UsdPrim &prim=UsdPrim())
 
 UsdGeomMotionAPI (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomMotionAPI ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetMotionBlurScaleAttr () const
 
USDGEOM_API UsdAttribute CreateMotionBlurScaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetVelocityScaleAttr () const
 
USDGEOM_API UsdAttribute CreateVelocityScaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetNonlinearSampleCountAttr () const
 
USDGEOM_API UsdAttribute CreateNonlinearSampleCountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API float ComputeVelocityScale (UsdTimeCode time=UsdTimeCode::Default()) const
 
USDGEOM_API int ComputeNonlinearSampleCount (UsdTimeCode time=UsdTimeCode::Default()) const
 
USDGEOM_API float ComputeMotionBlurScale (UsdTimeCode time=UsdTimeCode::Default()) const
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 
bool IsTyped () const
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 
bool IsMultipleApplyAPISchema () const
 
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is. More...
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomMotionAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
 
static USDGEOM_API UsdGeomMotionAPI Apply (const UsdPrim &prim)
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 

Protected Member Functions

USDGEOM_API UsdSchemaKind _GetSchemaKind () const override
 
- Protected Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 
const TfToken_GetInstanceName () const
 
USD_API bool _IsCompatible () const override
 
- Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind _GetSchemaType () const
 
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Detailed Description

UsdGeomMotionAPI encodes data that can live on any prim that may affect computations involving:

  • computed motion for motion blur
  • sampling for motion blur

The motion:blurScale attribute allows artists to scale the amount of motion blur to be rendered for parts of the scene without changing the recorded animation. See UsdGeomMotionAPI_blurScale for use and implementation details.

Definition at line 67 of file motionAPI.h.

Constructor & Destructor Documentation

UsdGeomMotionAPI::UsdGeomMotionAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdGeomMotionAPI on UsdPrim prim . Equivalent to UsdGeomMotionAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 79 of file motionAPI.h.

UsdGeomMotionAPI::UsdGeomMotionAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdGeomMotionAPI on the prim held by schemaObj . Should be preferred over UsdGeomMotionAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 87 of file motionAPI.h.

virtual USDGEOM_API UsdGeomMotionAPI::~UsdGeomMotionAPI ( )
virtual

Destructor.

Member Function Documentation

USDGEOM_API UsdSchemaKind UsdGeomMotionAPI::_GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDGEOM_API UsdGeomMotionAPI UsdGeomMotionAPI::Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim. This information is stored by adding "MotionAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid UsdGeomMotionAPI object is returned upon success. An invalid (or empty) UsdGeomMotionAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
static USDGEOM_API bool UsdGeomMotionAPI::CanApply ( const UsdPrim prim,
std::string whyNot = nullptr 
)
static

Returns true if this single-apply API schema can be applied to the given prim. If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
USDGEOM_API float UsdGeomMotionAPI::ComputeMotionBlurScale ( UsdTimeCode  time = UsdTimeCode::Default()) const

Compute the inherited value of motion:blurScale at time, i.e. the authored value on the prim closest to this prim in namespace, resolved upwards through its ancestors in namespace.

Returns
the inherited value, or 1.0 if neither the prim nor any of its ancestors possesses an authored value.
Note
this is a reference implementation that is not particularly efficient if evaluating over many prims, because it does not share inherited results.
USDGEOM_API int UsdGeomMotionAPI::ComputeNonlinearSampleCount ( UsdTimeCode  time = UsdTimeCode::Default()) const

Compute the inherited value of nonlinearSampleCount at time, i.e. the authored value on the prim closest to this prim in namespace, resolved upwards through its ancestors in namespace.

Returns
the inherited value, or 3 if neither the prim nor any of its ancestors possesses an authored value.
Note
this is a reference implementation that is not particularly efficient if evaluating over many prims, because it does not share inherited results.
USDGEOM_API float UsdGeomMotionAPI::ComputeVelocityScale ( UsdTimeCode  time = UsdTimeCode::Default()) const
Deprecated:

Compute the inherited value of velocityScale at time, i.e. the authored value on the prim closest to this prim in namespace, resolved upwards through its ancestors in namespace.

Returns
the inherited value, or 1.0 if neither the prim nor any of its ancestors possesses an authored value.
Note
this is a reference implementation that is not particularly efficient if evaluating over many prims, because it does not share inherited results.
USDGEOM_API UsdAttribute UsdGeomMotionAPI::CreateMotionBlurScaleAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetMotionBlurScaleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDGEOM_API UsdAttribute UsdGeomMotionAPI::CreateNonlinearSampleCountAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetNonlinearSampleCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDGEOM_API UsdAttribute UsdGeomMotionAPI::CreateVelocityScaleAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetVelocityScaleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

static USDGEOM_API UsdGeomMotionAPI UsdGeomMotionAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdGeomMotionAPI holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdGeomMotionAPI(stage->GetPrimAtPath(path));
USDGEOM_API UsdAttribute UsdGeomMotionAPI::GetMotionBlurScaleAttr ( ) const

BlurScale is an inherited float attribute that stipulates the rendered motion blur (as typically specified via UsdGeomCamera's shutter:open and shutter:close properties) should be scaled for all objects at and beneath the prim in namespace on which the motion:blurScale value is specified.

Without changing any other data in the scene, blurScale allows artists to "dial in" the amount of blur on a per-object basis. A blurScale value of zero removes all blur, a value of 0.5 reduces blur by half, and a value of 2.0 doubles the blur. The legal range for blurScale is [0, inf), although very high values may result in extremely expensive renders, and may exceed the capabilities of some renderers.

Although renderers are free to implement this feature however they see fit, see UsdGeomMotionAPI_blurScale for our guidance on implementing the feature universally and efficiently.

See Also
ComputeMotionBlurScale()
Declaration float motion:blurScale = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDGEOM_API UsdAttribute UsdGeomMotionAPI::GetNonlinearSampleCountAttr ( ) const

Determines the number of position or transformation samples created when motion is described by attributes contributing non-linear terms.

To give an example, imagine an application (such as a renderer) consuming 'points' and the USD document also contains 'accelerations' for the same prim. Unless the application can consume these 'accelerations' itself, an intermediate layer has to compute samples within the sampling interval for the point positions based on the value of 'points', 'velocities' and 'accelerations'. The number of these samples is given by 'nonlinearSampleCount'. The samples are equally spaced within the sampling interval.

Another example involves the PointInstancer where 'nonlinearSampleCount' is relevant when 'angularVelocities' or 'accelerations' are authored.

'nonlinearSampleCount' is an inherited attribute, also see ComputeNonlinearSampleCount()

Declaration int motion:nonlinearSampleCount = 3
C++ Type int
Usd Type SdfValueTypeNames->Int
static USDGEOM_API const TfTokenVector& UsdGeomMotionAPI::GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

USDGEOM_API UsdAttribute UsdGeomMotionAPI::GetVelocityScaleAttr ( ) const
Deprecated:

VelocityScale is an inherited float attribute that velocity-based schemas (e.g. PointBased, PointInstancer) can consume to compute interpolated positions and orientations by applying velocity and angularVelocity, which is required for interpolating between samples when topology is varying over time. Although these quantities are generally physically computed by a simulator, sometimes we require more or less motion-blur to achieve the desired look. VelocityScale allows artists to dial-in, as a post-sim correction, a scale factor to be applied to the velocity prior to computing interpolated positions from it.

Declaration float motion:velocityScale = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 165 of file motionAPI.h.

Member Data Documentation

const UsdSchemaKind UsdGeomMotionAPI::schemaKind = UsdSchemaKind::SingleApplyAPI
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaKind

Definition at line 73 of file motionAPI.h.


The documentation for this class was generated from the following file: