nvidia::apex::EmitterAsset Class Reference

APEX Emitter asset. Emits particles within some shape. More...

#include <EmitterAsset.h>

List of all members.

Public Member Functions
virtual EmitterGeomExplicit *	isExplicitGeom ()=0
	Returns the explicit geometry for the all actors based on this asset if the asset is explicit, NULL otherwise.
virtual const EmitterGeom *	getGeom () const =0
	Returns the geometry used for the all actors based on this asset.
virtual const char *	getInstancedObjectEffectsAssetName (void) const =0
	Gets IOFX asset name that is used to visualize partices of this emitter.
virtual const char *	getInstancedObjectSimulatorAssetName (void) const =0
	Gets IOS asset name that is used to simulate partices of this emitter.
virtual const char *	getInstancedObjectSimulatorTypeName (void) const =0
	Gets IOS asset class name that is used to simulate partices of this emitter.
virtual const float &	getDensity () const =0
	Gets the range used to choose the density of particles.
virtual const float &	getRate () const =0
	Gets the range used to choose the emission rate.
virtual const PxVec3 &	getVelocityLow () const =0
	Gets the range used to choose the velocity of particles.
virtual const PxVec3 &	getVelocityHigh () const =0
	Gets the range used to choose the velocity of particles.
virtual const float &	getLifetimeLow () const =0
	Gets the range used to choose the lifetime of particles.
virtual const float &	getLifetimeHigh () const =0
	Gets the range used to choose the lifetime of particles.
virtual uint32_t	getMaxSamples () const =0
	For an explicit emitter, Max Samples is ignored. For shaped emitters, it is the maximum number of objects spawned in a step.
virtual float	getEmitDuration () const =0
	Gets the emitter duration in seconds.
virtual const EmitterLodParamDesc &	getLodParamDesc () const =0
	Gets LOD settings for this asset.
Protected Member Functions
virtual	~EmitterAsset ()

---

Detailed Description

APEX Emitter asset. Emits particles within some shape.

---

Constructor & Destructor Documentation

virtual nvidia::apex::EmitterAsset::~EmitterAsset

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual const float& nvidia::apex::EmitterAsset::getDensity

(

)

const [pure virtual]

Gets the range used to choose the density of particles.

virtual float nvidia::apex::EmitterAsset::getEmitDuration

(

)

const [pure virtual]

Gets the emitter duration in seconds.

Note:

If EmitterActor::startEmit() is called with persistent=true, then this duration is ignored.

virtual const EmitterGeom* nvidia::apex::EmitterAsset::getGeom

(

)

const [pure virtual]

Returns the geometry used for the all actors based on this asset.

virtual const char* nvidia::apex::EmitterAsset::getInstancedObjectEffectsAssetName

(

void

)

const [pure virtual]

Gets IOFX asset name that is used to visualize partices of this emitter.

virtual const char* nvidia::apex::EmitterAsset::getInstancedObjectSimulatorAssetName

(

void

)

const [pure virtual]

Gets IOS asset name that is used to simulate partices of this emitter.

virtual const char* nvidia::apex::EmitterAsset::getInstancedObjectSimulatorTypeName

(

void

)

const [pure virtual]

Gets IOS asset class name that is used to simulate partices of this emitter.

virtual const float& nvidia::apex::EmitterAsset::getLifetimeHigh

(

)

const [pure virtual]

Gets the range used to choose the lifetime of particles.

virtual const float& nvidia::apex::EmitterAsset::getLifetimeLow

(

)

const [pure virtual]

Gets the range used to choose the lifetime of particles.

virtual const EmitterLodParamDesc& nvidia::apex::EmitterAsset::getLodParamDesc

(

)

const [pure virtual]

Gets LOD settings for this asset.

virtual uint32_t nvidia::apex::EmitterAsset::getMaxSamples

(

)

const [pure virtual]

For an explicit emitter, Max Samples is ignored. For shaped emitters, it is the maximum number of objects spawned in a step.

virtual const float& nvidia::apex::EmitterAsset::getRate

(

)

const [pure virtual]

Gets the range used to choose the emission rate.

virtual const PxVec3& nvidia::apex::EmitterAsset::getVelocityHigh

(

)

const [pure virtual]

Gets the range used to choose the velocity of particles.

virtual const PxVec3& nvidia::apex::EmitterAsset::getVelocityLow

(

)

const [pure virtual]

Gets the range used to choose the velocity of particles.

virtual EmitterGeomExplicit* nvidia::apex::EmitterAsset::isExplicitGeom

(

)

[pure virtual]

Returns the explicit geometry for the all actors based on this asset if the asset is explicit, NULL otherwise.

---

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

• EmitterAsset.h