WARNING: This is a draft API; the design is not fixed and may change in the future. More...

Inherits UsdAPISchemaBase.

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

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

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxParticleSamplingAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetSamplingDistanceAttr () const
	The distance between the sampled positions. More...

PHYSXSCHEMA_API UsdAttribute	CreateSamplingDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSamplingDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetVolumeAttr () const
	Whether to sample points inside the mesh or not. More...

PHYSXSCHEMA_API UsdAttribute	CreateVolumeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVolumeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetMaxSamplesAttr () const
	Approximate upper bound on the number of samples. More...

PHYSXSCHEMA_API UsdAttribute	CreateMaxSamplesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxSamplesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdRelationship	GetParticlesRel () const
	Relationship to the particle set sampled from the mesh. More...

PHYSXSCHEMA_API UsdRelationship	CreateParticlesRel () const
	See GetParticlesRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static PHYSXSCHEMA_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 PHYSXSCHEMA_API PhysxSchemaPhysxParticleSamplingAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxParticleSamplingAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_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`. More...

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

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

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

Friends
class	UsdSchemaRegistry

Detailed Description

WARNING: This is a draft API; the design is not fixed and may change in the future.

Applied to a UsdGeomMesh which is Poisson-sampled to generate particles in the particles relationship.

Definition at line 58 of file physxParticleSamplingAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxParticleSamplingAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxParticleSamplingAPI on UsdPrim prim .

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

Definition at line 70 of file physxParticleSamplingAPI.h.

PhysxSchemaPhysxParticleSamplingAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxParticleSamplingAPI on the prim held by schemaObj .

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

Definition at line 78 of file physxParticleSamplingAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxParticleSamplingAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

static PHYSXSCHEMA_API PhysxSchemaPhysxParticleSamplingAPI Apply ( const UsdPrim & prim )

static

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

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

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

PHYSXSCHEMA_API UsdAttribute CreateMaxSamplesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

PHYSXSCHEMA_API UsdRelationship CreateParticlesRel ( ) const

See GetParticlesRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.

PHYSXSCHEMA_API UsdAttribute CreateSamplingDistanceAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

PHYSXSCHEMA_API UsdAttribute CreateVolumeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetVolumeAttr(), 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 PHYSXSCHEMA_API PhysxSchemaPhysxParticleSamplingAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

* PhysxSchemaPhysxParticleSamplingAPI(stage->GetPrimAtPath(path));

*

PHYSXSCHEMA_API UsdAttribute GetMaxSamplesAttr ( ) const

Approximate upper bound on the number of samples.

Zero means unbounded. Range: [0, inf)


Declaration	`int physxParticleSampling:maxSamples = 50000`
C++ Type	int
Usd Type	SdfValueTypeNames->Int

PHYSXSCHEMA_API UsdRelationship GetParticlesRel ( ) const

Relationship to the particle set sampled from the mesh.

PHYSXSCHEMA_API UsdAttribute GetSamplingDistanceAttr ( ) const

The distance between the sampled positions.

In general, choose a value larger than the corresponding particle rest offset. Default value zero means that a suitable value is auto-determined. Range: [0, inf) Units: distance


Declaration	`float physxParticleSampling:samplingDistance = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

static PHYSXSCHEMA_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.

PHYSXSCHEMA_API UsdAttribute GetVolumeAttr ( ) const

Whether to sample points inside the mesh or not.


Declaration	`bool physxParticleSampling:volume = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 64 of file physxParticleSamplingAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxParticleSamplingAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation