Apex emitter actor class. Emits particles within a given shape. More...
#include <NxApexEmitterActor.h>
Classes | |
| class | NxApexEmitterValidateCallback |
Public Member Functions | |
| virtual NxApexEmitterAsset * | getEmitterAsset () const =0 |
| Returns the asset the instance has been created from. | |
| virtual NxEmitterExplicitGeom * | isExplicitGeom ()=0 |
| Returns the explicit geometry for THIS ACTOR only. | |
| virtual physx::PxMat44 | getGlobalPose () const =0 |
| Gets the global pose. | |
| virtual void | setCurrentPose (const physx::PxMat44 &pose)=0 |
| Sets the curent pose of the emitter. | |
| virtual void | setCurrentPosition (const physx::PxVec3 &pos)=0 |
| Sets the curent position of the emitter. | |
| virtual void | setAttachActor (NxActor *)=0 |
| PhysX SDK 2.8.X. Attaches the emitter to an actor NxActor pointer can be NULL to detach existing actor. | |
| virtual void | setAttachActor (PxActor *)=0 |
| PhysX SDK 3.X. Attaches the emitter to an actor PxActor pointer can be NULL to detach existing actor. | |
| virtual void | setAttachRelativePose (const physx::PxMat44 &pose)=0 |
| sets the relative pose of the emitter in the space of the actor to which it is attached | |
| virtual const NxActor * | getAttachActor () const =0 |
| PhysX SDK 2.8.X. Retrieves the actor, to which the emitter is attached. NULL is returned for an unattached emitter. | |
| virtual const PxActor * | getAttachActor () const =0 |
| PhysX SDK 3.X. Retrieves the actor, to which the emitter is attached. NULL is returned for an unattached emitter. | |
| virtual const physx::PxMat44 | getAttachRelativePose () const =0 |
| Retrieves the relative pose of the emitter in the space of the actor to which it is attached. | |
| virtual physx::PxF32 | getObjectRadius () const =0 |
| Retrieves the particle radius. | |
| virtual void | setOverlapTestCollisionGroups (physx::PxU32)=0 |
| Sets collision groups used to reject particles that overlap the geometry. | |
| virtual void | setOverlapTestCollisionGroupsMask (NxGroupsMask *)=0 |
| PhysX SDK 2.8.X only. Sets collision groups mask. | |
| virtual physx::PxU32 | getOverlapTestCollisionGroups () const =0 |
| Gets collision groups used to reject particles that overlap the geometry. | |
| virtual const NxGroupsMask * | getOverlapTestCollisionGroupsMask () const =0 |
| PhysX SDK 2.8.X only. Gets collision groups mask. | |
| virtual void | startEmit (bool persistent=true)=0 |
| virtual void | stopEmit ()=0 |
| stop emitting particles | |
| virtual bool | isEmitting ()=0 |
| true if the emitter is emitting particles | |
| virtual const NxEmitterLodParamDesc & | getLodParamDesc () const =0 |
| Gets LOD settings. | |
| virtual void | setLodParamDesc (const NxEmitterLodParamDesc &)=0 |
| Sets LOD settings. | |
| virtual void | setDensityRange (const NxRange< physx::PxF32 > &)=0 |
| Sets the range from which the density of particles within the volume is randomly chosen. | |
| virtual void | setRateRange (const NxRange< physx::PxF32 > &)=0 |
| Sets the range from which the emission rate is randomly chosen. | |
| virtual void | setVelocityRange (const NxRange< physx::PxVec3 > &)=0 |
| Sets the range from which the velocity of a particle is randomly chosen. | |
| virtual void | setLifetimeRange (const NxRange< physx::PxF32 > &)=0 |
| Sets the range from which the lifetime of a particle is randomly chosen. | |
| virtual void | emitAssetParticles (bool enable)=0 |
| Sets whether or not authored asset particles are emitted. | |
| virtual bool | getEmitAssetParticles () const =0 |
| Gets whether or not authored asset particles are emitted. | |
| virtual void | setPreferredRenderVolume (NxApexRenderVolume *volume)=0 |
| virtual void | getRateRange (NxRange< physx::PxF32 > &) const =0 |
| Gets the range from which the emission rate is randomly chosen. | |
| virtual PxU32 | getSimParticlesCount () const =0 |
| virtual PxU32 | getActiveParticleCount () const =0 |
| Returns the number of particles still alive. | |
| virtual void | setDensityGridPosition (const physx::PxVec3 &pos)=0 |
| Sets the origin of the density grid used by this emitter. Important, this density grid may be shared with lots of other emitters as well, it is based on the underlying IOS. | |
| virtual void | setApexEmitterValidateCallback (NxApexEmitterValidateCallback *callback)=0 |
| Sets the ApexEmitterPosition validation callback interface. | |
Protected Member Functions | |
| virtual | ~NxApexEmitterActor () |
Apex emitter actor class. Emits particles within a given shape.
| virtual physx::apex::NxApexEmitterActor::~NxApexEmitterActor | ( | ) | [inline, protected, virtual] |
| virtual void physx::apex::NxApexEmitterActor::emitAssetParticles | ( | bool | enable | ) | [pure virtual] |
Sets whether or not authored asset particles are emitted.
| virtual PxU32 physx::apex::NxApexEmitterActor::getActiveParticleCount | ( | ) | const [pure virtual] |
Returns the number of particles still alive.
| virtual const PxActor* physx::apex::NxApexEmitterActor::getAttachActor | ( | ) | const [pure virtual] |
PhysX SDK 3.X. Retrieves the actor, to which the emitter is attached. NULL is returned for an unattached emitter.
| virtual const NxActor* physx::apex::NxApexEmitterActor::getAttachActor | ( | ) | const [pure virtual] |
PhysX SDK 2.8.X. Retrieves the actor, to which the emitter is attached. NULL is returned for an unattached emitter.
| virtual const physx::PxMat44 physx::apex::NxApexEmitterActor::getAttachRelativePose | ( | ) | const [pure virtual] |
Retrieves the relative pose of the emitter in the space of the actor to which it is attached.
| virtual bool physx::apex::NxApexEmitterActor::getEmitAssetParticles | ( | ) | const [pure virtual] |
Gets whether or not authored asset particles are emitted.
| virtual NxApexEmitterAsset* physx::apex::NxApexEmitterActor::getEmitterAsset | ( | ) | const [pure virtual] |
Returns the asset the instance has been created from.
| virtual physx::PxMat44 physx::apex::NxApexEmitterActor::getGlobalPose | ( | ) | const [pure virtual] |
Gets the global pose.
| virtual const NxEmitterLodParamDesc& physx::apex::NxApexEmitterActor::getLodParamDesc | ( | ) | const [pure virtual] |
Gets LOD settings.
| virtual physx::PxF32 physx::apex::NxApexEmitterActor::getObjectRadius | ( | ) | const [pure virtual] |
Retrieves the particle radius.
| virtual physx::PxU32 physx::apex::NxApexEmitterActor::getOverlapTestCollisionGroups | ( | ) | const [pure virtual] |
Gets collision groups used to reject particles that overlap the geometry.
| virtual const NxGroupsMask* physx::apex::NxApexEmitterActor::getOverlapTestCollisionGroupsMask | ( | ) | const [pure virtual] |
PhysX SDK 2.8.X only. Gets collision groups mask.
| virtual void physx::apex::NxApexEmitterActor::getRateRange | ( | NxRange< physx::PxF32 > & | ) | const [pure virtual] |
Gets the range from which the emission rate is randomly chosen.
| virtual PxU32 physx::apex::NxApexEmitterActor::getSimParticlesCount | ( | ) | const [pure virtual] |
| virtual bool physx::apex::NxApexEmitterActor::isEmitting | ( | ) | [pure virtual] |
true if the emitter is emitting particles
| virtual NxEmitterExplicitGeom* physx::apex::NxApexEmitterActor::isExplicitGeom | ( | ) | [pure virtual] |
Returns the explicit geometry for THIS ACTOR only.
| virtual void physx::apex::NxApexEmitterActor::setApexEmitterValidateCallback | ( | NxApexEmitterValidateCallback * | callback | ) | [pure virtual] |
Sets the ApexEmitterPosition validation callback interface.
| virtual void physx::apex::NxApexEmitterActor::setAttachActor | ( | PxActor * | ) | [pure virtual] |
PhysX SDK 3.X. Attaches the emitter to an actor PxActor pointer can be NULL to detach existing actor.
| virtual void physx::apex::NxApexEmitterActor::setAttachActor | ( | NxActor * | ) | [pure virtual] |
PhysX SDK 2.8.X. Attaches the emitter to an actor NxActor pointer can be NULL to detach existing actor.
| virtual void physx::apex::NxApexEmitterActor::setAttachRelativePose | ( | const physx::PxMat44 & | pose | ) | [pure virtual] |
sets the relative pose of the emitter in the space of the actor to which it is attached
| virtual void physx::apex::NxApexEmitterActor::setCurrentPose | ( | const physx::PxMat44 & | pose | ) | [pure virtual] |
Sets the curent pose of the emitter.
| virtual void physx::apex::NxApexEmitterActor::setCurrentPosition | ( | const physx::PxVec3 & | pos | ) | [pure virtual] |
Sets the curent position of the emitter.
| virtual void physx::apex::NxApexEmitterActor::setDensityGridPosition | ( | const physx::PxVec3 & | pos | ) | [pure virtual] |
Sets the origin of the density grid used by this emitter. Important, this density grid may be shared with lots of other emitters as well, it is based on the underlying IOS.
| virtual void physx::apex::NxApexEmitterActor::setDensityRange | ( | const NxRange< physx::PxF32 > & | ) | [pure virtual] |
Sets the range from which the density of particles within the volume is randomly chosen.
| virtual void physx::apex::NxApexEmitterActor::setLifetimeRange | ( | const NxRange< physx::PxF32 > & | ) | [pure virtual] |
Sets the range from which the lifetime of a particle is randomly chosen.
| virtual void physx::apex::NxApexEmitterActor::setLodParamDesc | ( | const NxEmitterLodParamDesc & | ) | [pure virtual] |
Sets LOD settings.
| virtual void physx::apex::NxApexEmitterActor::setOverlapTestCollisionGroups | ( | physx::PxU32 | ) | [pure virtual] |
Sets collision groups used to reject particles that overlap the geometry.
| virtual void physx::apex::NxApexEmitterActor::setOverlapTestCollisionGroupsMask | ( | NxGroupsMask * | ) | [pure virtual] |
PhysX SDK 2.8.X only. Sets collision groups mask.
| virtual void physx::apex::NxApexEmitterActor::setPreferredRenderVolume | ( | NxApexRenderVolume * | volume | ) | [pure virtual] |
Emitted particles are injected to specified render volume on initial frame. This will work only if you have one renderVolume for each emitter. Set to NULL to clear the preferred volume.
| virtual void physx::apex::NxApexEmitterActor::setRateRange | ( | const NxRange< physx::PxF32 > & | ) | [pure virtual] |
Sets the range from which the emission rate is randomly chosen.
| virtual void physx::apex::NxApexEmitterActor::setVelocityRange | ( | const NxRange< physx::PxVec3 > & | ) | [pure virtual] |
Sets the range from which the velocity of a particle is randomly chosen.
| virtual void physx::apex::NxApexEmitterActor::startEmit | ( | bool | persistent = true | ) | [pure virtual] |
| virtual void physx::apex::NxApexEmitterActor::stopEmit | ( | ) | [pure virtual] |
stop emitting particles