PhysxSchemaPhysxDiffuseParticlesAPI Class Reference

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

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxDiffuseParticlesAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxDiffuseParticlesAPI on UsdPrim prim . More...
	PhysxSchemaPhysxDiffuseParticlesAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxDiffuseParticlesAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxDiffuseParticlesAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetDiffuseParticlesEnabledAttr () const
	Enable or disable the creation of diffuse particles. More...
PHYSXSCHEMA_API UsdAttribute	CreateDiffuseParticlesEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDiffuseParticlesEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxDiffuseParticleMultiplierAttr () const
	Maximum number of diffuse particles that can be present in the simulation relative to the number of non-diffuse particles. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxDiffuseParticleMultiplierAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxDiffuseParticleMultiplierAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetThresholdAttr () const
	Kinetic energy threshold a particle must reach to spawn a diffuse particle. More...
PHYSXSCHEMA_API UsdAttribute	CreateThresholdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetLifetimeAttr () const
	Lifetime of a spawned particle before it is removed again. More...
PHYSXSCHEMA_API UsdAttribute	CreateLifetimeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLifetimeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetAirDragAttr () const
	Air drag force factor for spray particles. More...
PHYSXSCHEMA_API UsdAttribute	CreateAirDragAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAirDragAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetBubbleDragAttr () const
	Fluid drag force factor for bubble particles. More...
PHYSXSCHEMA_API UsdAttribute	CreateBubbleDragAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetBubbleDragAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetBuoyancyAttr () const
	Buoyancy force factor for bubble particles. More...
PHYSXSCHEMA_API UsdAttribute	CreateBuoyancyAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetBuoyancyAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetKineticEnergyWeightAttr () const
	Contribution from kinetic energy when deciding diffuse particle creation. More...
PHYSXSCHEMA_API UsdAttribute	CreateKineticEnergyWeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetKineticEnergyWeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPressureWeightAttr () const
	Contribution from pressure when deciding diffuse particle creation. More...
PHYSXSCHEMA_API UsdAttribute	CreatePressureWeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPressureWeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetDivergenceWeightAttr () const
	Contribution from divergence when deciding diffuse particle creation. More...
PHYSXSCHEMA_API UsdAttribute	CreateDivergenceWeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDivergenceWeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetCollisionDecayAttr () const
	Decay factor of diffuse particles' lifetime after they collide with shapes. More...
PHYSXSCHEMA_API UsdAttribute	CreateCollisionDecayAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCollisionDecayAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetUseAccurateVelocityAttr () const
	Enables accurate particle velocity estimation. More...
PHYSXSCHEMA_API UsdAttribute	CreateUseAccurateVelocityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetUseAccurateVelocityAttr(), 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 PhysxSchemaPhysxDiffuseParticlesAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxDiffuseParticlesAPI 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 PhysxSchemaPhysxDiffuseParticlesAPI	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 UsdGeomPoints or UsdGeomPointInstancer primitive with PhysxParticleSetAPI. Defines settings that the particle simulation uses to spawn diffuse particles. The diffuse particles are a render-only effect and do not affect the particle dynamics.

Definition at line 60 of file physxDiffuseParticlesAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxDiffuseParticlesAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxDiffuseParticlesAPI on UsdPrim prim .

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

Definition at line 72 of file physxDiffuseParticlesAPI.h.

PhysxSchemaPhysxDiffuseParticlesAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxDiffuseParticlesAPI on the prim held by schemaObj .

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

Definition at line 80 of file physxDiffuseParticlesAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDiffuseParticlesAPI ( )

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

static

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

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

Returns

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

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

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

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

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

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

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

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

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

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

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

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

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

static

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

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

PHYSXSCHEMA_API UsdAttribute GetAirDragAttr

(

)

const

Air drag force factor for spray particles.

Range: [0, inf) Units: dimensionless

Declaration	float physxDiffuseParticles:airDrag = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetBubbleDragAttr

(

)

const

Fluid drag force factor for bubble particles.

Range: [0, inf) Units: dimensionless

Declaration	float physxDiffuseParticles:bubbleDrag = 0.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetBuoyancyAttr

(

)

const

Buoyancy force factor for bubble particles.

Range: [0, inf) Units: dimensionless

Declaration	float physxDiffuseParticles:buoyancy = 0.8
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetCollisionDecayAttr

(

)

const

Decay factor of diffuse particles' lifetime after they collide with shapes.

0 == lifetime remains unchanged, 1 == particle disappears immediately. Range: [0, 1] Units: dimensionless

Declaration	float physxDiffuseParticles:collisionDecay = 0.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetDiffuseParticlesEnabledAttr

(

)

const

Enable or disable the creation of diffuse particles.

Declaration	bool physxDiffuseParticles:diffuseParticlesEnabled = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetDivergenceWeightAttr

(

)

const

Contribution from divergence when deciding diffuse particle creation.

Range: [0, inf) Units: dimensionless

Declaration	float physxDiffuseParticles:divergenceWeight = 5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetKineticEnergyWeightAttr

(

)

const

Contribution from kinetic energy when deciding diffuse particle creation.

Range: [0, inf) Units: dimensionless

Declaration	float physxDiffuseParticles:kineticEnergyWeight = 0.01
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetLifetimeAttr

(

)

const

Lifetime of a spawned particle before it is removed again.

Range: [0, inf) Units: seconds

Declaration	float physxDiffuseParticles:lifetime = 5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMaxDiffuseParticleMultiplierAttr

(

)

const

Maximum number of diffuse particles that can be present in the simulation relative to the number of non-diffuse particles.

Range: [0.0, inf) Default value -inf means default is picked by the simulation.

Declaration	uniform float physxDiffuseParticles:maxDiffuseParticleMultiplier = -inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

PHYSXSCHEMA_API UsdAttribute GetPressureWeightAttr

(

)

const

Contribution from pressure when deciding diffuse particle creation.

Range: [0, inf) Units: dimensionless

Declaration	float physxDiffuseParticles:pressureWeight = 1
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 GetThresholdAttr

(

)

const

Kinetic energy threshold a particle must reach to spawn a diffuse particle.

Range: [0, inf) Units: energy = mass * distance * distance / seconds / seconds

Declaration	float physxDiffuseParticles:threshold = 0.01
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetUseAccurateVelocityAttr

(

)

const

Enables accurate particle velocity estimation.

Declaration	bool physxDiffuseParticles:useAccurateVelocity = 0
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 66 of file physxDiffuseParticlesAPI.h.

---

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

• C:/g/19412595/omni/schema/source/physxSchema/physxDiffuseParticlesAPI.h