Defines a base-class type applied schema that all applied schema that provide the ParticleField position data will automatically apply. More...

#include <particleFieldPositionBaseAPI.h>

Inheritance diagram for UsdVolParticleFieldPositionBaseAPI:

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

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

virtual USDVOL_API	~UsdVolParticleFieldPositionBaseAPI ()
	Destructor.

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 USDVOL_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 USDVOL_API UsdVolParticleFieldPositionBaseAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdVolParticleFieldPositionBaseAPI holding the prim adhering to this schema at `path` on `stage`.

static USDVOL_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 USDVOL_API UsdVolParticleFieldPositionBaseAPI	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
USDVOL_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

Defines a base-class type applied schema that all applied schema that provide the ParticleField position data will automatically apply.

The purpose of this base class is to allow validation to enforce that an applied schema that defines position is always present for a ParticleField.

The number of positions provided is also used to determine the number of particle in the ParticleField. If no position data is present, then the ParticleField contains no particles. Any other per-particle data provided, such as scale or orientation, is truncated if too long, or if too short the entire data set will be discarded. For these other per-particle data fields, if no data is provided, or it is discarded then its default value will be used.

Definition at line 52 of file particleFieldPositionBaseAPI.h.

Constructor & Destructor Documentation

◆ UsdVolParticleFieldPositionBaseAPI() [1/2]

UsdVolParticleFieldPositionBaseAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdVolParticleFieldPositionBaseAPI on UsdPrim prim .

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

Definition at line 64 of file particleFieldPositionBaseAPI.h.

◆ UsdVolParticleFieldPositionBaseAPI() [2/2]

UsdVolParticleFieldPositionBaseAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdVolParticleFieldPositionBaseAPI on the prim held by schemaObj .

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

Definition at line 72 of file particleFieldPositionBaseAPI.h.

◆ ~UsdVolParticleFieldPositionBaseAPI()

virtual USDVOL_API ~UsdVolParticleFieldPositionBaseAPI ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDVOL_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDVOL_API UsdVolParticleFieldPositionBaseAPI Apply ( const UsdPrim & prim )

static

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

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

Returns: A valid UsdVolParticleFieldPositionBaseAPI object is returned upon success. An invalid (or empty) UsdVolParticleFieldPositionBaseAPI 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 USDVOL_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()

◆ Get()

static USDVOL_API UsdVolParticleFieldPositionBaseAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

UsdVolParticleFieldPositionBaseAPI(stage->GetPrimAtPath(path));

UsdVolParticleFieldPositionBaseAPI

Defines a base-class type applied schema that all applied schema that provide the ParticleField posit...

Definition: particleFieldPositionBaseAPI.h:53