NifEmitter Class Reference

List of all members.

Classes
class	CmdDepth
class	CmdHeight
class	CmdHorizontalAngle
class	CmdHorizontalDir
class	CmdVerticalAngle
class	CmdVerticalDir
class	CmdWidth
Public Member Functions
Ogre::ParticleSystem *	getPartSys ()
	NifEmitter (Ogre::ParticleSystem *psys)
unsigned short	_getEmissionCount (Ogre::Real timeElapsed)
void	_initParticle (Ogre::Particle *particle)
void	setDirection (const Ogre::Vector3 &dir)
void	setSize (const Ogre::Vector3 &size)
void	setSize (Ogre::Real x, Ogre::Real y, Ogre::Real z)
void	setWidth (Ogre::Real width)
Ogre::Real	getWidth (void) const
void	setHeight (Ogre::Real height)
Ogre::Real	getHeight (void) const
void	setDepth (Ogre::Real depth)
Ogre::Real	getDepth (void) const
void	setVerticalDirection (Ogre::Radian vdir)
Ogre::Radian	getVerticalDirection (void) const
void	setVerticalAngle (Ogre::Radian vangle)
Ogre::Radian	getVerticalAngle (void) const
void	setHorizontalDirection (Ogre::Radian hdir)
Ogre::Radian	getHorizontalDirection (void) const
void	setHorizontalAngle (Ogre::Radian hangle)
Ogre::Radian	getHorizontalAngle (void) const
Public Attributes
Ogre::Bone *	mEmitterBone
Ogre::Bone *	mParticleBone
Protected Member Functions
void	genAreaAxes (void)
	Internal method for generating the area axes.
bool	initDefaults (const Ogre::String &t)
Protected Attributes
Ogre::Vector3	mSize
	Size of the area.
Ogre::Radian	mVerticalDir
Ogre::Radian	mVerticalAngle
Ogre::Radian	mHorizontalDir
Ogre::Radian	mHorizontalAngle
Ogre::Vector3	mXRange
	Local axes, not normalised, their magnitude reflects area size.
Ogre::Vector3	mYRange
Ogre::Vector3	mZRange
Static Protected Attributes
static CmdWidth	msWidthCmd
	Command objects.
static CmdHeight	msHeightCmd
static CmdDepth	msDepthCmd
static CmdVerticalDir	msVerticalDirCmd
static CmdVerticalAngle	msVerticalAngleCmd
static CmdHorizontalDir	msHorizontalDirCmd
static CmdHorizontalAngle	msHorizontalAngleCmd

---

Constructor & Destructor Documentation

NifEmitter::NifEmitter

(

Ogre::ParticleSystem *

psys

)

[inline]

---

Member Function Documentation

unsigned short NifEmitter::_getEmissionCount

(

Ogre::Real

timeElapsed

)

[inline]

See Ogre::ParticleEmitter.

void NifEmitter::_initParticle

(

Ogre::Particle *

particle

)

[inline]

See Ogre::ParticleEmitter.

void NifEmitter::genAreaAxes

(

void

)

[inline, protected]

Internal method for generating the area axes.

Ogre::Real NifEmitter::getDepth

(

void

)

const [inline]

Gets the depth (local y size) of the emitter.

Ogre::Real NifEmitter::getHeight

(

void

)

const [inline]

Gets the height (local y size) of the emitter.

Ogre::Radian NifEmitter::getHorizontalAngle

(

void

)

const [inline]

Ogre::Radian NifEmitter::getHorizontalDirection

(

void

)

const [inline]

Ogre::ParticleSystem* NifEmitter::getPartSys

(

)

[inline]

Ogre::Radian NifEmitter::getVerticalAngle

(

void

)

const [inline]

Ogre::Radian NifEmitter::getVerticalDirection

(

void

)

const [inline]

Ogre::Real NifEmitter::getWidth

(

void

)

const [inline]

Gets the width (local x size) of the emitter.

bool NifEmitter::initDefaults

(

const Ogre::String &

t

)

[inline, protected]

Internal for initializing some defaults and parameters

Returns:

True if custom parameters need initialising

void NifEmitter::setDepth

(

Ogre::Real

depth

)

[inline]

Sets the depth (local y size) of the emitter.

void NifEmitter::setDirection

(

const Ogre::Vector3 &

dir

)

[inline]

Overloaded to update the trans. matrix

void NifEmitter::setHeight

(

Ogre::Real

height

)

[inline]

Sets the height (local y size) of the emitter.

void NifEmitter::setHorizontalAngle

(

Ogre::Radian

hangle

)

[inline]

void NifEmitter::setHorizontalDirection

(

Ogre::Radian

hdir

)

[inline]

void NifEmitter::setSize

(

const Ogre::Vector3 &

size

)

[inline]

Sets the size of the area from which particles are emitted.

Parameters:

size	Vector describing the size of the area. The area extends around the center point by half the x, y and z components of this vector. The box is aligned such that it's local Z axis points along it's direction (see setDirection)

void NifEmitter::setSize	(	Ogre::Real	x,
		Ogre::Real	y,
		Ogre::Real	z
	)		[inline]

Sets the size of the area from which particles are emitted.

Parameters:

x,y,z

Individual axis lengths describing the size of the area. The area extends around the center point by half the x, y and z components of this vector. The box is aligned such that it's local Z axis points along it's direction (see setDirection)

void NifEmitter::setVerticalAngle

(

Ogre::Radian

vangle

)

[inline]

void NifEmitter::setVerticalDirection

(

Ogre::Radian

vdir

)

[inline]

void NifEmitter::setWidth

(

Ogre::Real

width

)

[inline]

Sets the width (local x size) of the emitter.

---

Member Data Documentation

Ogre::Bone* NifEmitter::mEmitterBone

Ogre::Radian NifEmitter::mHorizontalAngle [protected]

Ogre::Radian NifEmitter::mHorizontalDir [protected]

Ogre::Bone* NifEmitter::mParticleBone

NifEmitter::CmdDepth NifEmitter::msDepthCmd [static, protected]

NifEmitter::CmdHeight NifEmitter::msHeightCmd [static, protected]

NifEmitter::CmdHorizontalAngle NifEmitter::msHorizontalAngleCmd [static, protected]

NifEmitter::CmdHorizontalDir NifEmitter::msHorizontalDirCmd [static, protected]

Ogre::Vector3 NifEmitter::mSize [protected]

Size of the area.

NifEmitter::CmdVerticalAngle NifEmitter::msVerticalAngleCmd [static, protected]

NifEmitter::CmdVerticalDir NifEmitter::msVerticalDirCmd [static, protected]

NifEmitter::CmdWidth NifEmitter::msWidthCmd [static, protected]

Command objects.

Ogre::Radian NifEmitter::mVerticalAngle [protected]

Ogre::Radian NifEmitter::mVerticalDir [protected]

Ogre::Vector3 NifEmitter::mXRange [protected]

Local axes, not normalised, their magnitude reflects area size.

Ogre::Vector3 NifEmitter::mYRange [protected]

Ogre::Vector3 NifEmitter::mZRange [protected]

---

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

• components/nifogre/particles.cpp