All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdRiSplineAPI Class Reference
+ Inheritance diagram for UsdRiSplineAPI:

Public Member Functions

 UsdRiSplineAPI (const UsdPrim &prim=UsdPrim())
 Construct a UsdRiSplineAPI on UsdPrim prim . More...
 
 UsdRiSplineAPI (const UsdSchemaBase &schemaObj)
 Construct a UsdRiSplineAPI on the prim held by schemaObj . More...
 
virtual USDRI_API ~UsdRiSplineAPI ()
 Destructor. More...
 
 UsdRiSplineAPI (const UsdPrim &prim, const TfToken &splineName, const SdfValueTypeName &valuesTypeName, bool doesDuplicateBSplineEndpoints)
 Construct a UsdRiSplineAPI with the given splineName on the UsdPrim prim . More...
 
 UsdRiSplineAPI (const UsdSchemaBase &schemaObj, const TfToken &splineName, const SdfValueTypeName &valuesTypeName, bool doesDuplicateBSplineEndpoints)
 Construct a UsdRiSplineAPI with the given splineName on the prim held by schemaObj . More...
 
USDRI_API bool DoesDuplicateBSplineEndpoints () const
 Returns true if this UsdRiSplineAPI is configured to ensure the endpoints are duplicated when using a bspline basis. More...
 
USDRI_API SdfValueTypeName GetValuesTypeName () const
 Returns the intended typename of the values attribute of the spline. More...
 
USDRI_API UsdAttribute GetInterpolationAttr () const
 Interpolation method for the spline. More...
 
USDRI_API UsdAttribute CreateInterpolationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetInterpolationAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetPositionsAttr () const
 Positions of the knots. More...
 
USDRI_API UsdAttribute CreatePositionsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetPositionsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetValuesAttr () const
 Values of the knots. More...
 
USDRI_API UsdAttribute CreateValuesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetValuesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
Spline Validation API

API for validating the properties of a spline.

USDRI_API bool Validate (std::string *reason) const
 Validates the attribute values belonging to the spline. More...
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 Construct a UsdAPISchemaBase on UsdPrim prim . More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 Construct a UsdAPISchemaBase on the prim held by schemaObj . More...
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More...
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped. More...
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
UsdSchemaType GetSchemaType () const
 
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
 Return true if this schema object is compatible with its held prim, false otherwise. More...
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null. More...
 

Static Public Member Functions

static USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USDRI_API UsdRiSplineAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdRiSplineAPI holding the prim adhering to this schema at path on stage. More...
 
static USDRI_API UsdRiSplineAPI Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim. More...
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

USDRI_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 
- Protected Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName. More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName. More...
 
const TfToken_GetInstanceName () const
 Returns the instance name of the API schema object belonging to a multiple-apply API schema. More...
 
USD_API bool _IsCompatible () const override
 Check whether this APISchema object is valid for the currently held prim. More...
 
- Protected Member Functions inherited from UsdSchemaBase
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
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 Helper method to apply a single-apply API schema with the given schema name apiSchemaName' and C++ type 'APISchemaType'. More...
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 Helper method to apply a multiple-apply API schema with the given schema name apiSchemaName', C++ type 'APISchemaType' and instance name instanceName. More...
 

Detailed Description

Deprecated:
This API schema will be removed in a future release.

RiSplineAPI is a general purpose API schema used to describe a named spline stored as a set of attributes on a prim.

It is an add-on schema that can be applied many times to a prim with different spline names. All the attributes authored by the schema are namespaced under "$NAME:spline:", with the name of the spline providing a namespace for the attributes.

The spline describes a 2D piecewise cubic curve with a position and value for each knot. This is chosen to give straightforward artistic control over the shape. The supported basis types are:

  • linear (UsdRiTokens->linear)
  • bspline (UsdRiTokens->bspline)
  • Catmull-Rom (UsdRiTokens->catmull_rom)

Definition at line 74 of file splineAPI.h.

Constructor & Destructor Documentation

UsdRiSplineAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiSplineAPI on UsdPrim prim .

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

Definition at line 86 of file splineAPI.h.

UsdRiSplineAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiSplineAPI on the prim held by schemaObj .

Should be preferred over UsdRiSplineAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 94 of file splineAPI.h.

virtual USDRI_API ~UsdRiSplineAPI ( )
virtual

Destructor.

UsdRiSplineAPI ( const UsdPrim prim,
const TfToken splineName,
const SdfValueTypeName valuesTypeName,
bool  doesDuplicateBSplineEndpoints 
)
inlineexplicit

Construct a UsdRiSplineAPI with the given splineName on the UsdPrim prim .

Definition at line 175 of file splineAPI.h.

UsdRiSplineAPI ( const UsdSchemaBase schemaObj,
const TfToken splineName,
const SdfValueTypeName valuesTypeName,
bool  doesDuplicateBSplineEndpoints 
)
inlineexplicit

Construct a UsdRiSplineAPI with the given splineName on the prim held by schemaObj .

Definition at line 187 of file splineAPI.h.

Member Function Documentation

USDRI_API UsdSchemaType _GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiSplineAPI Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim.

This information is stored by adding "RiSplineAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid UsdRiSplineAPI object is returned upon success. An invalid (or empty) UsdRiSplineAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
USDRI_API UsdAttribute CreateInterpolationAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetInterpolationAttr(), and also Create vs Get Property Methods 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.

USDRI_API UsdAttribute CreatePositionsAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetPositionsAttr(), and also Create vs Get Property Methods 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.

USDRI_API UsdAttribute CreateValuesAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetValuesAttr(), and also Create vs Get Property Methods 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.

USDRI_API bool DoesDuplicateBSplineEndpoints ( ) const
inline

Returns true if this UsdRiSplineAPI is configured to ensure the endpoints are duplicated when using a bspline basis.

Duplicating the endpoints ensures that the spline reaches those points at either end of the parameter range.

Definition at line 204 of file splineAPI.h.

static USDRI_API UsdRiSplineAPI Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdRiSplineAPI 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:

* UsdRiSplineAPI(stage->GetPrimAtPath(path));
*
USDRI_API UsdAttribute GetInterpolationAttr ( ) const

Interpolation method for the spline.


C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityUniform
Fallback Value: linear
Allowed Values: [linear, constant, bspline, catmullRom]

USDRI_API UsdAttribute GetPositionsAttr ( ) const

Positions of the knots.


C++ Type: VtArray<float>
Usd Type: SdfValueTypeNames->FloatArray
Variability: SdfVariabilityUniform
Fallback Value: No Fallback

static USDRI_API const TfTokenVector& 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.

USDRI_API UsdAttribute GetValuesAttr ( ) const

Values of the knots.


C++ Type: See GetValuesTypeName()
Usd Type: See GetValuesTypeName()
Variability: SdfVariabilityUniform
Fallback Value: No Fallback

USDRI_API SdfValueTypeName GetValuesTypeName ( ) const
inline

Returns the intended typename of the values attribute of the spline.

Definition at line 210 of file splineAPI.h.

USDRI_API bool Validate ( std::string *  reason) const

Validates the attribute values belonging to the spline.

Returns true if the spline has all valid attribute values. Returns false and populates the reason output argument if the spline has invalid attribute values.

Here's the list of validations performed by this method:

  • the SplineAPI must be fully initialized
  • interpolation attribute must exist and use an allowed value
  • the positions array must be a float array
  • the positions array must be sorted by increasing value
  • the values array must use the correct value type
  • the positions and values array must have the same size

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 80 of file splineAPI.h.


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