Ogre::Particle Class Reference
[Effects]

Class representing a single particle instance. More...

#include <OgreParticle.h>

Inheritance diagram for Ogre::Particle:

Public Types
enum	ParticleType { Visual, Emitter }
	Type of particle. More...
Public Member Functions
	Particle ()
void	setDimensions (Real width, Real height)
	Sets the width and height for this particle.
bool	hasOwnDimensions (void) const
	Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e.
Real	getOwnWidth (void) const
	Retrieves the particle's personal width, if hasOwnDimensions is true.
Real	getOwnHeight (void) const
	Retrieves the particle's personal width, if hasOwnDimensions is true.
void	setRotation (const Radian &rad)
	Sets the current rotation.
const Radian &	getRotation (void) const
void	_notifyOwner (ParticleSystem *owner)
	Internal method for notifying the particle of it's owner.
void	_notifyVisualData (ParticleVisualData *vis)
	Internal method for notifying the particle of it's optional visual data.
ParticleVisualData *	getVisualData (void) const
	Get the optional visual data associated with the class.
void	resetDimensions (void)
	Utility method to reset this particle.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
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 *)
Public Attributes
bool	mOwnDimensions
	Does this particle have it's own dimensions?
Real	mWidth
	Personal width if mOwnDimensions == true.
Real	mHeight
	Personal height if mOwnDimensions == true.
Radian	rotation
	Current rotation value.
Vector3	position
	World position.
Vector3	direction
	Direction (and speed).
ColourValue	colour
	Current colour.
Real	timeToLive
	Time to live, number of seconds left of particles natural life.
Real	totalTimeToLive
	Total Time to live, number of seconds of particles natural life.
Radian	rotationSpeed
	Speed of rotation in radians/sec.
ParticleType	particleType
	Determines the type of particle.
Protected Attributes
ParticleSystem *	mParentSystem
	Parent ParticleSystem.
ParticleVisualData *	mVisual
	Additional visual data you might want to associate with the Particle.

Detailed Description

Class representing a single particle instance.

Definition at line 60 of file OgreParticle.h.

Member Enumeration Documentation

enum Ogre::Particle::ParticleType

Type of particle.

Enumerator:

Visual
Emitter

Definition at line 69 of file OgreParticle.h.

Constructor & Destructor Documentation

Ogre::Particle::Particle ( )

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 )

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

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

Definition at line 128 of file OgreParticle.h.

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

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

Definition at line 133 of file OgreParticle.h.

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

Get the optional visual data associated with the class.

Definition at line 144 of file OgreParticle.h.

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

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,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

array operator new, with debug line info

Definition at line 85 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.