PhysX SDK 3.2 API Reference: PxParticleSystem Class Reference

PhysX SDK 3.2 API

PxParticleSystem Class Reference
[Particles]

The particle system class represents the main module for particle based simulation. More...

#include <PxParticleSystem.h>

Inheritance diagram for PxParticleSystem:
Collaboration diagram for PxParticleSystem:

List of all members.


Public Member Functions

virtual const char * getConcreteTypeName () const
 returns string name of dynamic type.

Protected Member Functions

 PxParticleSystem (PxRefResolver &v)
PX_INLINE PxParticleSystem ()
virtual ~PxParticleSystem ()
virtual bool isKindOf (const char *name) const

Detailed Description

The particle system class represents the main module for particle based simulation.

This class inherits the properties of the PxParticleBase class.

The particle system class manages a set of particles. Particles can be created, released and updated directly through the API. When a particle is created the user gets an id for it which can be used to address the particle until it is released again.

Particles collide with static and dynamic shapes. They are also affected by the scene gravity and a user force, as well as global velocity damping. When a particle collides, a particle flag is raised corresponding to the type of actor, static or dynamic, it collided with. Additionally a shape can be flagged as a drain (See PxShapeFlag), in order to get a corresponding particle flag raised when a collision occurs. This information can be used to delete particles.

The particles of a particle system don't collide with each other. In order to simulate particle-particle interactions use the subclass PxParticleFluid.

See also:
PxParticleBase, PxParticleReadData

Constructor & Destructor Documentation

PxParticleSystem::PxParticleSystem ( PxRefResolver v  )  [inline, protected]

PX_INLINE PxParticleSystem::PxParticleSystem (  )  [inline, protected]

virtual PxParticleSystem::~PxParticleSystem (  )  [inline, protected, virtual]


Member Function Documentation

virtual const char* PxParticleSystem::getConcreteTypeName (  )  const [inline, virtual]

returns string name of dynamic type.

Returns:
class name of most derived type of this object.

Reimplemented from PxSerializable.

virtual bool PxParticleSystem::isKindOf ( const char *  name  )  const [inline, protected, virtual]

Reimplemented from PxParticleBase.

References PxParticleBase::isKindOf().


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



Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com