#include <splineAPI.h>

Inheritance diagram for UsdRiSplineAPI:

Public Member Functions
	UsdRiSplineAPI (const UsdPrim &prim=UsdPrim())
	Construct a UsdRiSplineAPI on UsdPrim `prim` .

	UsdRiSplineAPI (const UsdSchemaBase &schemaObj)
	Construct a UsdRiSplineAPI on the prim held by `schemaObj` .

virtual USDRI_API	~UsdRiSplineAPI ()
	Destructor.

	UsdRiSplineAPI (const UsdPrim &prim, const TfToken &splineName, const SdfValueTypeName &valuesTypeName, bool doesDuplicateBSplineEndpoints)
	Construct a UsdRiSplineAPI with the given `splineName` on the UsdPrim `prim` .

	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` .

USDRI_API bool	DoesDuplicateBSplineEndpoints () const
	Returns true if this UsdRiSplineAPI is configured to ensure the endpoints are duplicated when using a bspline basis.

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

USDRI_API UsdAttribute	GetInterpolationAttr () const
	Interpolation method for the spline.

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.

USDRI_API UsdAttribute	GetPositionsAttr () const
	Positions of the knots.

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.

USDRI_API UsdAttribute	GetValuesAttr () const
	Values of the knots.

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.

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.

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdAPISchemaBase on UsdPrim `prim` .

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
	Construct a UsdAPISchemaBase on the prim held by `schemaObj` .

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.

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.

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.

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.

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`.

static USDRI_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given `prim`.

static USDRI_API UsdRiSplineAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`.

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.

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDRI_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim `prim` with the specified `instanceName`.

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by `schemaObj` with the given `instanceName`.

const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.

USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.

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)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

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 57 of file splineAPI.h.

Constructor & Destructor Documentation

◆ UsdRiSplineAPI() [1/4]

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 69 of file splineAPI.h.

◆ UsdRiSplineAPI() [2/4]

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 77 of file splineAPI.h.

◆ ~UsdRiSplineAPI()

virtual USDRI_API ~UsdRiSplineAPI ( )

virtual

Destructor.

◆ UsdRiSplineAPI() [3/4]

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 179 of file splineAPI.h.

◆ UsdRiSplineAPI() [4/4]

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 191 of file splineAPI.h.

Member Function Documentation

◆ _GetSchemaKind()

USDRI_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

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

◆ CanApply()

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

◆ CreateInterpolationAttr()

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.

◆ CreatePositionsAttr()

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.

◆ CreateValuesAttr()

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.

◆ DoesDuplicateBSplineEndpoints()

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

◆ Get()

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

UsdRiSplineAPI

Definition: splineAPI.h:58

◆ GetInterpolationAttr()

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]

◆ GetPositionsAttr()

USDRI_API UsdAttribute GetPositionsAttr ( ) const

Positions of the knots.

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

◆ GetSchemaAttributeNames()

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.

◆ GetValuesAttr()

USDRI_API UsdAttribute GetValuesAttr ( ) const

Values of the knots.

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

◆ GetValuesTypeName()

USDRI_API SdfValueTypeName GetValuesTypeName ( ) const

inline

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

Definition at line 214 of file splineAPI.h.

◆ Validate()

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

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 155 of file splineAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See also: UsdSchemaKind

Definition at line 63 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

◆ UsdRiSplineAPI() [1/4]

◆ UsdRiSplineAPI() [2/4]

◆ ~UsdRiSplineAPI()

◆ UsdRiSplineAPI() [3/4]

◆ UsdRiSplineAPI() [4/4]

Member Function Documentation

◆ _GetSchemaKind()

◆ Apply()

◆ CanApply()

◆ CreateInterpolationAttr()

◆ CreatePositionsAttr()

◆ CreateValuesAttr()

◆ DoesDuplicateBSplineEndpoints()

◆ Get()

◆ GetInterpolationAttr()

◆ GetPositionsAttr()

◆ GetSchemaAttributeNames()

◆ GetValuesAttr()

◆ GetValuesTypeName()

◆ Validate()

Friends And Related Function Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind