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

Inherits UsdAPISchemaBase.

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

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

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

PHYSXSCHEMA_API UsdAttribute	GetFluidAttr () const
	Flag to toggle simulation as fluid (True) or solid (False). More...

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

PHYSXSCHEMA_API UsdAttribute	GetSimulationPointsAttr () const
	This attribute is read-only and is updated from simulation to capture particle-simulation state while smoothed position data is written to the render position/points attribute of the UsdGeomPointInstancer/UsdGeomPoints. More...

PHYSXSCHEMA_API UsdAttribute	CreateSimulationPointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSimulationPointsAttr(), 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 PhysxSchemaPhysxParticleSetAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxParticleSetAPI 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 PhysxSchemaPhysxParticleSetAPI	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 UsdGeomPointInstancer or a UsdGeomPointBased. Creates a set of particles for granular (i.e. solid-particle) material or fluid simulation with PhysX.

Definition at line 58 of file physxParticleSetAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxParticleSetAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxParticleSetAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxParticleSetAPI::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 physxParticleSetAPI.h.

PhysxSchemaPhysxParticleSetAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxParticleSetAPI on the prim held by schemaObj .

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

Definition at line 78 of file physxParticleSetAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxParticleSetAPI ( )

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 PhysxSchemaPhysxParticleSetAPI Apply ( const UsdPrim & prim )

static

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

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

Returns: A valid PhysxSchemaPhysxParticleSetAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxParticleSetAPI 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 CreateFluidAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetFluidAttr(), 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 CreateSimulationPointsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetSimulationPointsAttr(), 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 PhysxSchemaPhysxParticleSetAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetFluidAttr ( ) const

Flag to toggle simulation as fluid (True) or solid (False).


Declaration	`bool physxParticle:fluid = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

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 GetSimulationPointsAttr ( ) const

This attribute is read-only and is updated from simulation to capture particle-simulation state while smoothed position data is written to the render position/points attribute of the UsdGeomPointInstancer/UsdGeomPoints.


Declaration	`point3f[] physxParticle:simulationPoints`
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

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 physxParticleSetAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxParticleSetAPI.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