#include <particleFieldSphericalHarmonicsAttributeAPI.h>

Inheritance diagram for UsdVolParticleFieldSphericalHarmonicsAttributeAPI:

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

	UsdVolParticleFieldSphericalHarmonicsAttributeAPI (const UsdSchemaBase &schemaObj)

virtual USDVOL_API	~UsdVolParticleFieldSphericalHarmonicsAttributeAPI ()
	Destructor. More...

USDVOL_API UsdAttribute	GetRadianceSphericalHarmonicsDegreeAttr () const

USDVOL_API UsdAttribute	CreateRadianceSphericalHarmonicsDegreeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDVOL_API UsdAttribute	GetRadianceSphericalHarmonicsCoefficientsAttr () const

USDVOL_API UsdAttribute	CreateRadianceSphericalHarmonicsCoefficientsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

USDVOL_API UsdAttribute	GetRadianceSphericalHarmonicsCoefficientshAttr () const

USDVOL_API UsdAttribute	CreateRadianceSphericalHarmonicsCoefficientshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

ParticleFieldRadianceBaseAPI
Convenience accessors for the built-in UsdVolParticleFieldRadianceBaseAPI
USDVOL_API UsdVolParticleFieldRadianceBaseAPI	ParticleFieldRadianceBaseAPI () 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 USDVOL_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

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

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

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

A ParticleField related applied schema that provides spherical harmonics attributes to define the radiance of the particles.

The spherical harmonics degree is constant across all the particles in the ParticleField.

Attributes are provided in both float and half types for some easy data footprint affordance, data consumers should prefer float version if available.

The length of this attribute is expected to match the length of the provided position data times the per-particle element size derived from the SH degree (specifically element size = (degree+1)*(degree+1)). If it is too long it will be truncated to the number of particles define by the position data. If it is too short it will be ignored.

If it is ignored or not populated, the particle should use a SH coefficient corresponding to a DC signal of (0.5, 0.5, 0.5), with degree 0.

Definition at line 63 of file particleFieldSphericalHarmonicsAttributeAPI.h.

Constructor & Destructor Documentation

UsdVolParticleFieldSphericalHarmonicsAttributeAPI::UsdVolParticleFieldSphericalHarmonicsAttributeAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

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

Definition at line 75 of file particleFieldSphericalHarmonicsAttributeAPI.h.

UsdVolParticleFieldSphericalHarmonicsAttributeAPI::UsdVolParticleFieldSphericalHarmonicsAttributeAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

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

Definition at line 83 of file particleFieldSphericalHarmonicsAttributeAPI.h.

virtual USDVOL_API UsdVolParticleFieldSphericalHarmonicsAttributeAPI::~UsdVolParticleFieldSphericalHarmonicsAttributeAPI ( )

virtual

Destructor.

Member Function Documentation

USDVOL_API UsdSchemaKind UsdVolParticleFieldSphericalHarmonicsAttributeAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDVOL_API UsdVolParticleFieldSphericalHarmonicsAttributeAPI UsdVolParticleFieldSphericalHarmonicsAttributeAPI::Apply ( const UsdPrim & prim )

static

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

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

USDVOL_API UsdAttribute UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsCoefficientsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDVOL_API UsdAttribute UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsCoefficientshAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDVOL_API UsdAttribute UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsDegreeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetRadianceSphericalHarmonicsDegreeAttr(), 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 USDVOL_API UsdVolParticleFieldSphericalHarmonicsAttributeAPI UsdVolParticleFieldSphericalHarmonicsAttributeAPI::Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

UsdVolParticleFieldSphericalHarmonicsAttributeAPI(stage->GetPrimAtPath(path));

USDVOL_API UsdAttribute UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsCoefficientsAttr ( ) const

Flattened array of SH coefficients. The SH coefficients are grouped in the array by particle, meaning each particle has N contiguous coefficients, Y(m,l) sorted first by order (m) and then within the order by index (l). A renderer can compute an element size per particle based on the SH degree, and use that to stripe the array by particle.


Declaration	`float3[] radiance:sphericalHarmonicsCoefficients`
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Float3Array

USDVOL_API UsdAttribute UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsCoefficientshAttr ( ) const

Flattened array of SH coefficients. The SH coefficients are grouped in the array by particle, meaning each particle has N contiguous coefficients, Y(m,l) sorted first by order (m) and then within the order by index (l). A renderer can compute an element size per particle based on the SH degree, and use that to stripe the array by particle.

If the float precision version is available it should be preferred.


Declaration	`half3[] radiance:sphericalHarmonicsCoefficientsh`
C++ Type	VtArray<GfVec3h>
Usd Type	SdfValueTypeNames->Half3Array

USDVOL_API UsdAttribute UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsDegreeAttr ( ) const

The highest degree of the spherical harmonics. A degree of N implies a coefficient element size (per particle) of (N+1)*(N+1) values. The spherical harmonics degree is the same for all particles in the ParticleField.


Declaration	`uniform int radiance:sphericalHarmonicsDegree = 3`
C++ Type	int
Usd Type	SdfValueTypeNames->Int
Variability	SdfVariabilityUniform

static USDVOL_API const TfTokenVector& UsdVolParticleFieldSphericalHarmonicsAttributeAPI::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.

USDVOL_API UsdVolParticleFieldRadianceBaseAPI UsdVolParticleFieldSphericalHarmonicsAttributeAPI::ParticleFieldRadianceBaseAPI ( ) const

Constructs and returns a UsdVolParticleFieldRadianceBaseAPI object. Use this object to access UsdVolParticleFieldRadianceBaseAPI custom methods.