OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::Particle Class Reference

Class representing a single particle instance. More...

#include <OgreParticle.h>

+ Inheritance diagram for Ogre::Particle:
+ Collaboration diagram for Ogre::Particle:

Public Types

enum  ParticleType { Visual, Emitter }
 Type of particle. More...
 

Public Member Functions

 Particle ()
 
void _notifyOwner (ParticleSystem *owner)
 Internal method for notifying the particle of it's owner. More...
 
void _notifyVisualData (ParticleVisualData *vis)
 Internal method for notifying the particle of it's optional visual data. More...
 
Real getOwnHeight (void) const
 Retrieves the particle's personal width, if hasOwnDimensions is true. More...
 
Real getOwnWidth (void) const
 Retrieves the particle's personal width, if hasOwnDimensions is true. More...
 
const RadiangetRotation (void) const
 
ParticleVisualDatagetVisualData (void) const
 Get the optional visual data associated with the class. More...
 
bool hasOwnDimensions (void) const
 Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
void resetDimensions (void)
 Utility method to reset this particle. More...
 
void setDimensions (Real width, Real height)
 Sets the width and height for this particle. More...
 
void setRotation (const Radian &rad)
 Sets the current rotation. More...
 

Public Attributes

ColourValue mColour
 Current colour. More...
 
Vector3 mDirection
 Direction (and speed) More...
 
Real mHeight
 Personal height if mOwnDimensions == true. More...
 
bool mOwnDimensions
 Does this particle have it's own dimensions? More...
 
ParticleType mParticleType
 Determines the type of particle. More...
 
Vector3 mPosition
 World position. More...
 
Radian mRotation
 Current rotation value. More...
 
Radian mRotationSpeed
 Speed of rotation in radians/sec. More...
 
Real mTimeToLive
 Time to live, number of seconds left of particles natural life. More...
 
Real mTotalTimeToLive
 Total Time to live, number of seconds of particles natural life. More...
 
Real mWidth
 Personal width if mOwnDimensions == true. More...
 

Protected Attributes

ParticleSystemmParentSystem
 Parent ParticleSystem. More...
 
ParticleVisualDatamVisual
 Additional visual data you might want to associate with the Particle. More...
 

Detailed Description

Class representing a single particle instance.

Definition at line 60 of file OgreParticle.h.

Member Enumeration Documentation

Type of particle.

Enumerator
Visual 
Emitter 

Definition at line 69 of file OgreParticle.h.

Constructor & Destructor Documentation

Ogre::Particle::Particle ( )
inline

Definition at line 100 of file OgreParticle.h.

Member Function Documentation

void Ogre::Particle::_notifyOwner ( ParticleSystem owner)

Internal method for notifying the particle of it's owner.

void Ogre::Particle::_notifyVisualData ( ParticleVisualData vis)
inline

Internal method for notifying the particle of it's optional visual data.

Definition at line 141 of file OgreParticle.h.

Real Ogre::Particle::getOwnHeight ( void  ) const
inline

Retrieves the particle's personal width, if hasOwnDimensions is true.

Definition at line 128 of file OgreParticle.h.

Real Ogre::Particle::getOwnWidth ( void  ) const
inline

Retrieves the particle's personal width, if hasOwnDimensions is true.

Definition at line 125 of file OgreParticle.h.

const Radian& Ogre::Particle::getRotation ( void  ) const
inline

Definition at line 133 of file OgreParticle.h.

ParticleVisualData* Ogre::Particle::getVisualData ( void  ) const
inline

Get the optional visual data associated with the class.

Definition at line 144 of file OgreParticle.h.

bool Ogre::Particle::hasOwnDimensions ( void  ) const
inline

Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e.

if the particle::setDimensions method has been called for this instance).

See also
particle::setDimensions

Definition at line 122 of file OgreParticle.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::Particle::resetDimensions ( void  )

Utility method to reset this particle.

Referenced by Ogre::ParticleEmitter::_initParticle().

void Ogre::Particle::setDimensions ( Real  width,
Real  height 
)

Sets the width and height for this particle.

Remarks
Note that it is most efficient for every particle in a ParticleSystem to have the same dimensions. If you choose to alter the dimensions of an individual particle the set will be less efficient. Do not call this method unless you really need to have different particle dimensions within the same set. Otherwise just call the ParticleSystem::setDefaultDimensions method instead.
void Ogre::Particle::setRotation ( const Radian rad)

Sets the current rotation.

Member Data Documentation

ColourValue Ogre::Particle::mColour

Current colour.

Definition at line 90 of file OgreParticle.h.

Vector3 Ogre::Particle::mDirection

Direction (and speed)

Definition at line 88 of file OgreParticle.h.

Real Ogre::Particle::mHeight

Personal height if mOwnDimensions == true.

Definition at line 80 of file OgreParticle.h.

bool Ogre::Particle::mOwnDimensions

Does this particle have it's own dimensions?

Definition at line 76 of file OgreParticle.h.

ParticleSystem* Ogre::Particle::mParentSystem
protected

Parent ParticleSystem.

Definition at line 64 of file OgreParticle.h.

ParticleType Ogre::Particle::mParticleType

Determines the type of particle.

Definition at line 98 of file OgreParticle.h.

Vector3 Ogre::Particle::mPosition

World position.

Definition at line 86 of file OgreParticle.h.

Radian Ogre::Particle::mRotation

Current rotation value.

Definition at line 82 of file OgreParticle.h.

Radian Ogre::Particle::mRotationSpeed

Speed of rotation in radians/sec.

Definition at line 96 of file OgreParticle.h.

Real Ogre::Particle::mTimeToLive

Time to live, number of seconds left of particles natural life.

Definition at line 92 of file OgreParticle.h.

Real Ogre::Particle::mTotalTimeToLive

Total Time to live, number of seconds of particles natural life.

Definition at line 94 of file OgreParticle.h.

ParticleVisualData* Ogre::Particle::mVisual
protected

Additional visual data you might want to associate with the Particle.

Definition at line 66 of file OgreParticle.h.

Real Ogre::Particle::mWidth

Personal width if mOwnDimensions == true.

Definition at line 78 of file OgreParticle.h.


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