Ogre::Particle Class Reference
Core » Effects

Class representing a single particle instance. More...

`#include <OgreParticle.h>`

Inheritance diagram for Ogre::Particle:
[legend]

## 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 Radian & | getRotation (void) const
ParticleVisualData * | getVisualData (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 | colour
| Current colour. More...
Vector3 | direction
| Direction (and speed) More...
Real | mHeight
| Personal height if mOwnDimensions == true. More...
bool | mOwnDimensions
| Does this particle have it's own dimensions? More...
Real | mWidth
| Personal width if mOwnDimensions == true. More...
ParticleType | particleType
| Determines the type of particle. More...
Vector3 | position
| World position. More...
Radian | rotation
| Current rotation value. More...
Radian | rotationSpeed
| Speed of rotation in radians/sec. More...
Real | timeToLive
| Time to live, number of seconds left of particles natural life. More...
Real | totalTimeToLive
| Total Time to live, number of seconds of particles natural life. More...

## Protected Attributes

ParticleSystem * | mParentSystem
| Parent ParticleSystem. More...
ParticleVisualData * | mVisual
| Additional visual data you might want to associate with the Particle. More...

## Detailed Description

Class representing a single particle instance.

Definition at line 61 of file OgreParticle.h.

## Member Enumeration Documentation

## ParticleType

enum Ogre::Particle::ParticleType

Type of particle.

Enumerator
Visual |
Emitter |

Definition at line 70 of file OgreParticle.h.

## Constructor & Destructor Documentation

## Particle()

Ogre::Particle::Particle | ( |  | ) |

Definition at line 101 of file OgreParticle.h.

## Member Function Documentation

## _notifyOwner()

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

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

## _notifyVisualData()

void Ogre::Particle::_notifyVisualData | ( | ParticleVisualData * | vis | ) |

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

Definition at line 142 of file OgreParticle.h.

## getOwnHeight()

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

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

Definition at line 129 of file OgreParticle.h.

## getOwnWidth()

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

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

Definition at line 126 of file OgreParticle.h.

## getRotation()

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

Definition at line 134 of file OgreParticle.h.

## getVisualData()

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

Get the optional visual data associated with the class.

Definition at line 145 of file OgreParticle.h.

## hasOwnDimensions()

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 123 of file OgreParticle.h.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

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 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

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 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## resetDimensions()

void Ogre::Particle::resetDimensions | ( | void |  | ) |

Utility method to reset this particle.

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

## setDimensions()

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.

## setRotation()

void Ogre::Particle::setRotation | ( | const Radian & | rad | ) |

Sets the current rotation.

## Member Data Documentation

## colour

ColourValue Ogre::Particle::colour

Current colour.

Definition at line 91 of file OgreParticle.h.

## direction

Vector3 Ogre::Particle::direction

Direction (and speed)

Definition at line 89 of file OgreParticle.h.

## mHeight

Real Ogre::Particle::mHeight

Personal height if mOwnDimensions == true.

Definition at line 81 of file OgreParticle.h.

## mOwnDimensions

bool Ogre::Particle::mOwnDimensions

Does this particle have it's own dimensions?

Definition at line 77 of file OgreParticle.h.

## mParentSystem

ParticleSystem* Ogre::Particle::mParentSystem

protected

Parent ParticleSystem.

Definition at line 65 of file OgreParticle.h.

## mVisual

ParticleVisualData* Ogre::Particle::mVisual

protected

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

Definition at line 67 of file OgreParticle.h.

## mWidth

Real Ogre::Particle::mWidth

Personal width if mOwnDimensions == true.

Definition at line 79 of file OgreParticle.h.

## particleType

ParticleType Ogre::Particle::particleType

Determines the type of particle.

Definition at line 99 of file OgreParticle.h.

## position

Vector3 Ogre::Particle::position

World position.

Definition at line 87 of file OgreParticle.h.

## rotation

Radian Ogre::Particle::rotation

Current rotation value.

Definition at line 83 of file OgreParticle.h.

## rotationSpeed

Radian Ogre::Particle::rotationSpeed

Speed of rotation in radians/sec.

Definition at line 97 of file OgreParticle.h.

## timeToLive

Real Ogre::Particle::timeToLive

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

Definition at line 93 of file OgreParticle.h.

## totalTimeToLive

Real Ogre::Particle::totalTimeToLive

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

Definition at line 95 of file OgreParticle.h.

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

- OgreParticle.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.