Ground Emitter actor. Uses raycasts against ground to spawn particles. More...
#include <NxGroundEmitterActor.h>
Public Member Functions | |
| virtual NxGroundEmitterAsset * | getEmitterAsset () const =0 |
| Returns the asset the instance has been created from. | |
| virtual const physx::PxMat44 | getPose () const =0 |
| Returns the pose of the emitter. | |
| virtual void | setPose (const physx::PxMat44 &pos)=0 |
| Sets the pose of the emitter. | |
| virtual void | setMaterialLookupCallback (NxMaterialLookupCallback *)=0 |
| Set the material lookup callback method that replaces raycasts. | |
| virtual NxMaterialLookupCallback * | getMaterialLookupCallback () const =0 |
| Get the material lookup callback method that replaces raycasts. | |
| virtual void | setAttachActor (NxActor *)=0 |
| 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 NxActor pointer can be NULL to detach existing actor. | |
| virtual void | setAttachRelativePosition (const physx::PxVec3 &pos)=0 |
| sets the relative position 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::PxVec3 & | getAttachRelativePosition () const =0 |
| Retrieves the relative position of the emitter in the space of the actor to which it is attached. | |
| 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 | setRadius (physx::PxF32)=0 |
| Sets the radius. The ground emitter actor will create objects within a circle of size 'radius'. | |
| virtual void | setMaxRaycastsPerFrame (physx::PxU32)=0 |
| Sets The maximum raycasts number per frame. | |
| virtual void | setRaycastHeight (physx::PxF32)=0 |
| Sets the height from which the ground emitter will cast rays at terrain/objects opposite of the 'upDirection'. | |
| virtual void | setSpawnHeight (physx::PxF32)=0 |
| Sets the height above the ground to emit particles. If greater than 0, the ground emitter will refresh a disc above the player's position rather than refreshing a circle around the player's position. | |
| virtual const NxRange < physx::PxF32 > & | getDensityRange () const =0 |
| Gets the range from which the density of particles within the volume is randomly chosen. | |
| virtual physx::PxF32 | getRadius () const =0 |
| Gets the radius. The ground emitter actor will create objects within a circle of size 'radius'. | |
| virtual physx::PxU32 | getMaxRaycastsPerFrame () const =0 |
| Gets The maximum raycasts number per frame. | |
| virtual physx::PxF32 | getRaycastHeight () const =0 |
| Gets the height from which the ground emitter will cast rays at terrain/objects opposite of the 'upDirection'. | |
| virtual physx::PxF32 | getSpawnHeight () const =0 |
| Gets the height above the ground to emit particles. If greater than 0, the ground emitter will refresh a disc above the player's position rather than refreshing a circle around the player's position. | |
| virtual void | setRaycastCollisionGroups (physx::PxU32)=0 |
| Sets collision groups used to cast rays. | |
| virtual void | setRaycastCollisionGroupsMask (NxGroupsMask *)=0 |
| PHYSX SDK 2.8.X. Sets collision groups mask. | |
| virtual void | setRaycastCollisionGroupsMask (physx::PxFilterData *)=0 |
| PHYSX SDK 3.X. Sets collision groups mask. | |
| virtual physx::PxU32 | getRaycastCollisionGroups () const =0 |
| Gets collision groups used to cast rays. | |
| virtual const NxGroupsMask * | getRaycastCollisionGroupsMask () const =0 |
| PHYSX SDK 2.8.X only. Gets collision groups mask. | |
| virtual void | setPreferredRenderVolume (NxApexRenderVolume *volume)=0 |
Protected Member Functions | |
| virtual | ~NxGroundEmitterActor () |
Ground Emitter actor. Uses raycasts against ground to spawn particles.
| virtual physx::apex::NxGroundEmitterActor::~NxGroundEmitterActor | ( | ) | [inline, protected, virtual] |
| virtual const NxActor* physx::apex::NxGroundEmitterActor::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 PxActor* physx::apex::NxGroundEmitterActor::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 physx::PxVec3& physx::apex::NxGroundEmitterActor::getAttachRelativePosition | ( | ) | const [pure virtual] |
Retrieves the relative position of the emitter in the space of the actor to which it is attached.
| virtual const NxRange<physx::PxF32>& physx::apex::NxGroundEmitterActor::getDensityRange | ( | ) | const [pure virtual] |
Gets the range from which the density of particles within the volume is randomly chosen.
| virtual NxGroundEmitterAsset* physx::apex::NxGroundEmitterActor::getEmitterAsset | ( | ) | const [pure virtual] |
Returns the asset the instance has been created from.
| virtual NxMaterialLookupCallback* physx::apex::NxGroundEmitterActor::getMaterialLookupCallback | ( | ) | const [pure virtual] |
Get the material lookup callback method that replaces raycasts.
| virtual physx::PxU32 physx::apex::NxGroundEmitterActor::getMaxRaycastsPerFrame | ( | ) | const [pure virtual] |
Gets The maximum raycasts number per frame.
| virtual const physx::PxMat44 physx::apex::NxGroundEmitterActor::getPose | ( | ) | const [pure virtual] |
Returns the pose of the emitter.
| virtual physx::PxF32 physx::apex::NxGroundEmitterActor::getRadius | ( | ) | const [pure virtual] |
Gets the radius. The ground emitter actor will create objects within a circle of size 'radius'.
| virtual physx::PxU32 physx::apex::NxGroundEmitterActor::getRaycastCollisionGroups | ( | ) | const [pure virtual] |
Gets collision groups used to cast rays.
| virtual const NxGroupsMask* physx::apex::NxGroundEmitterActor::getRaycastCollisionGroupsMask | ( | ) | const [pure virtual] |
PHYSX SDK 2.8.X only. Gets collision groups mask.
| virtual physx::PxF32 physx::apex::NxGroundEmitterActor::getRaycastHeight | ( | ) | const [pure virtual] |
Gets the height from which the ground emitter will cast rays at terrain/objects opposite of the 'upDirection'.
| virtual physx::PxF32 physx::apex::NxGroundEmitterActor::getSpawnHeight | ( | ) | const [pure virtual] |
Gets the height above the ground to emit particles. If greater than 0, the ground emitter will refresh a disc above the player's position rather than refreshing a circle around the player's position.
| virtual void physx::apex::NxGroundEmitterActor::setAttachActor | ( | NxActor * | ) | [pure virtual] |
Attaches the emitter to an actor NxActor pointer can be NULL to detach existing actor.
PhysX SDK 2.8.X. Attaches the emitter to an actor NxActor pointer can be NULL to detach existing actor
| virtual void physx::apex::NxGroundEmitterActor::setAttachActor | ( | PxActor * | ) | [pure virtual] |
PhysX SDK 3.X. Attaches the emitter to an actor NxActor pointer can be NULL to detach existing actor.
| virtual void physx::apex::NxGroundEmitterActor::setAttachRelativePosition | ( | const physx::PxVec3 & | pos | ) | [pure virtual] |
sets the relative position of the emitter in the space of the actor to which it is attached
| virtual void physx::apex::NxGroundEmitterActor::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::NxGroundEmitterActor::setMaterialLookupCallback | ( | NxMaterialLookupCallback * | ) | [pure virtual] |
Set the material lookup callback method that replaces raycasts.
| virtual void physx::apex::NxGroundEmitterActor::setMaxRaycastsPerFrame | ( | physx::PxU32 | ) | [pure virtual] |
Sets The maximum raycasts number per frame.
| virtual void physx::apex::NxGroundEmitterActor::setPose | ( | const physx::PxMat44 & | pos | ) | [pure virtual] |
Sets the pose of the emitter.
| virtual void physx::apex::NxGroundEmitterActor::setPreferredRenderVolume | ( | NxApexRenderVolume * | volume | ) | [pure virtual] |
Emitted particles are injected to specified render volume on initial frame. Set to NULL to clear the preferred volume.
| virtual void physx::apex::NxGroundEmitterActor::setRadius | ( | physx::PxF32 | ) | [pure virtual] |
Sets the radius. The ground emitter actor will create objects within a circle of size 'radius'.
| virtual void physx::apex::NxGroundEmitterActor::setRaycastCollisionGroups | ( | physx::PxU32 | ) | [pure virtual] |
Sets collision groups used to cast rays.
| virtual void physx::apex::NxGroundEmitterActor::setRaycastCollisionGroupsMask | ( | physx::PxFilterData * | ) | [pure virtual] |
PHYSX SDK 3.X. Sets collision groups mask.
| virtual void physx::apex::NxGroundEmitterActor::setRaycastCollisionGroupsMask | ( | NxGroupsMask * | ) | [pure virtual] |
PHYSX SDK 2.8.X. Sets collision groups mask.
| virtual void physx::apex::NxGroundEmitterActor::setRaycastHeight | ( | physx::PxF32 | ) | [pure virtual] |
Sets the height from which the ground emitter will cast rays at terrain/objects opposite of the 'upDirection'.
| virtual void physx::apex::NxGroundEmitterActor::setSpawnHeight | ( | physx::PxF32 | ) | [pure virtual] |
Sets the height above the ground to emit particles. If greater than 0, the ground emitter will refresh a disc above the player's position rather than refreshing a circle around the player's position.