#include <splineAPI.h>

Inheritance diagram for UsdRiSplineAPI:

Public Member Functions
	UsdRiSplineAPI (const UsdPrim &prim=UsdPrim())

	UsdRiSplineAPI (const UsdSchemaBase &schemaObj)

virtual USDRI_API	~UsdRiSplineAPI ()
	Destructor. More...

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

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

USDRI_API bool	DoesDuplicateBSplineEndpoints () const

USDRI_API SdfValueTypeName	GetValuesTypeName () const
	Returns the intended typename of the values attribute of the spline. More...

USDRI_API UsdAttribute	GetInterpolationAttr () const

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

USDRI_API UsdAttribute	GetPositionsAttr () const

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

USDRI_API UsdAttribute	GetValuesAttr () const

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

Spline Validation API
API for validating the properties of a spline.
USDRI_API bool	Validate (std::string *reason) 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 UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDRI_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

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

static USDRI_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)

static USDRI_API UsdRiSplineAPI	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 TfTokenVector &	GetSchemaAttributeNames (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
USDRI_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

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)

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->catmullRom)

Definition at line 74 of file splineAPI.h.

Constructor & Destructor Documentation

UsdRiSplineAPI::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::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::~UsdRiSplineAPI ( )

virtual

Destructor.

UsdRiSplineAPI::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 196 of file splineAPI.h.

UsdRiSplineAPI::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 208 of file splineAPI.h.

Member Function Documentation

USDRI_API UsdSchemaKind UsdRiSplineAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiSplineAPI 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::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

static USDRI_API bool UsdRiSplineAPI::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()

USDRI_API UsdAttribute UsdRiSplineAPI::CreateInterpolationAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetInterpolationAttr(), 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.

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

See GetPositionsAttr(), 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.

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

See GetValuesAttr(), 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.

USDRI_API bool UsdRiSplineAPI::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 225 of file splineAPI.h.

static USDRI_API UsdRiSplineAPI 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 UsdRiSplineAPI::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 UsdRiSplineAPI::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& UsdRiSplineAPI::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 UsdRiSplineAPI::GetValuesAttr ( ) const

Values of the knots.

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

USDRI_API SdfValueTypeName UsdRiSplineAPI::GetValuesTypeName ( ) const

inline

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

Definition at line 231 of file splineAPI.h.

USDRI_API bool UsdRiSplineAPI::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

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 172 of file splineAPI.h.

Member Data Documentation

const UsdSchemaKind UsdRiSplineAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 80 of file splineAPI.h.

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

pxr/usd/usdRi/splineAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation