Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::ParticleSystem Class Reference

Class defining particle system based special effects. More...

#include <OgreParticleSystem.h>

Inheritance diagram for Ogre::ParticleSystem:

Inheritance graph
[legend]
Collaboration diagram for Ogre::ParticleSystem:

Collaboration graph
[legend]
List of all members.

Public Methods

 ParticleSystem ()
 Default constructor required for STL creation in manager.

 ParticleSystem (const String &name)
 Creates a particle system with no emitters or affectors.

virtual ~ParticleSystem ()
virtual const StringgetName (void) const
 Gets the name of this particle system.

ParticleEmitteraddEmitter (const String &emitterType)
 Adds an emitter to this particle system.

ParticleEmittergetEmitter (unsigned short index) const
 Retrieves an emitter by it's index (zero-based).

unsigned short getNumEmitters (void) const
 Returns the number of emitters for this particle system.

void removeEmitter (unsigned short index)
 Removes an emitter from the system.

void removeAllEmitters (void)
 Removes all the emitters from this system.

ParticleAffectoraddAffector (const String &affectorType)
 Adds an affector to this particle system.

ParticleAffectorgetAffector (unsigned short index) const
 Retrieves an affector by it's index (zero-based).

unsigned short getNumAffectors (void) const
 Returns the number of affectors for this particle system.

void removeAffector (unsigned short index)
 Removes an affector from the system.

void removeAllAffectors (void)
 Removes all the affectors from this system.

unsigned int getNumParticles (void) const
 Gets the number of individual particles in the system right now.

unsigned int getParticleQuota (void) const
 Returns the maximum number of particles this system is allowed to have active at once.

void setParticleQuota (unsigned int quota)
 Sets the maximum number of particles this system is allowed to have active at once.

ParticleSystem & operator= (const ParticleSystem &rhs)
 Assignment operator for copying.

void _update (Real timeElapsed)
 Updates the particles in the system based on time elapsed.

ParticleIterator _getIterator (void)
 Returns an iterator for stepping through all particles in this system.

void getWorldTransforms (Matrix4 *xform) const
 Overridden from MovableObject.

const QuaterniongetWorldOrientation (void) const
 @copydoc Renderable::getWorldOrientation

const Vector3getWorldPosition (void) const
 @copydoc Renderable::getWorldPosition

void _updateBounds (void)
 Overridden from BillboardSet.

void fastForward (Real time, Real interval=0.1)
 Fast-forwards this system by the required number of seconds.

virtual const StringgetMovableType (void) const
 Overridden from MovableObject.

BillboardcreateBillboard (const Vector3 &position, const ColourValue &colour=ColourValue::White)
 Creates a new billboard and adds it to this set.

BillboardcreateBillboard (Real x, Real y, Real z, const ColourValue &colour=ColourValue::White)
 Creates a new billboard and adds it to this set.

virtual int getNumBillboards (void) const
 Returns the number of active billboards which currently make up this set.

virtual void setAutoextend (bool autoextend)
 Tells the set whether to allow automatic extension of the pool of billboards.

virtual bool getAutoextend (void) const
 Returns true if the billboard pool automatically extends.

virtual void setPoolSize (unsigned int size)
 Adjusts the size of the pool of billboards available in this set.

virtual unsigned int getPoolSize (void) const
 Returns the current size of the billboard pool.

virtual void clear ()
 Empties this set of all billboards.

virtual BillboardgetBillboard (unsigned int index) const
 Returns a pointer to the billboard at the supplied index.

virtual void removeBillboard (unsigned int index)
 Removes the billboard at the supplied index.

virtual void removeBillboard (Billboard *pBill)
 Removes a billboard from the set.

virtual void setBillboardOrigin (BillboardOrigin origin)
 Sets the point which acts as the origin point for all billboards in this set.

virtual BillboardOrigin getBillboardOrigin (void) const
 Gets the point which acts as the origin point for all billboards in this set.

virtual void setDefaultDimensions (Real width, Real height)
 Sets the default dimensions of the billboards in this set.

virtual void setDefaultWidth (Real width)
 See setDefaultDimensions - this sets 1 component individually.

virtual Real getDefaultWidth (void) const
 See setDefaultDimensions - this gets 1 component individually.

virtual void setDefaultHeight (Real height)
 See setDefaultDimensions - this sets 1 component individually.

virtual Real getDefaultHeight (void) const
 See setDefaultDimensions - this gets 1 component individually.

virtual void setMaterialName (const String &name)
 Sets the name of the material to be used for this billboard set.

virtual const StringgetMaterialName (void) const
 Sets the name of the material to be used for this billboard set.

virtual void _notifyCurrentCamera (Camera *cam)
 Overridden from MovableObject.

virtual const AxisAlignedBoxgetBoundingBox (void) const
 Overridden from MovableObject.

virtual Real getBoundingRadius (void) const
 Overridden from MovableObject.

virtual void _updateRenderQueue (RenderQueue *queue)
 Overridden from MovableObject.

virtual MaterialgetMaterial (void) const
 Overridden from MovableObject.

virtual void getRenderOperation (RenderOperation &op)
 Overridden from MovableObject.

virtual void _notifyBillboardResized (void)
 Internal callback used by Billboards to notify their parent that they have been resized.

virtual void _notifyBillboardTextureCoordsModified (void)
 Notifies the billboardset that texture coordinates will be modified for this set.

virtual bool getCullIndividually (void) const
 Returns whether or not billbards in this are tested individually for culling.

virtual void setCullIndividually (bool cullIndividual)
 Sets whether culling tests billboards in this individually as well as in a group.

virtual void setBillboardType (BillboardType bbt)
 Sets the type of billboard to render.

virtual BillboardType getBillboardType (void) const
 Returns the billboard type in use.

virtual void setCommonDirection (const Vector3 &vec)
 Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON.

virtual const Vector3getCommonDirection (void) const
 Gets the common direction for all billboards (BBT_ORIENTED_COMMON).

Real getSquaredViewDepth (const Camera *cam) const
 Overridden, see Renderable.

const LightListgetLights (void) const
 @copydoc Renderable::getLights

ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class.

const ParamDictionarygetParamDictionary (void) const
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object.

virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method.

virtual String getParameter (const String &name) const
 Generic parameter retrieval method.

virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object.

virtual NodegetParentNode (void) const
 Returns the node to which this object is attached.

virtual void _notifyAttached (Node *parent, bool isTagPoint=false)
 Internal method called to notify the object that it has been attached to a node.

virtual bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint.

virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates.

virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object.

virtual void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component.

virtual bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not.

virtual void setUserObject (UserDefinedObject *obj)
 Call this to associate your own custom user object instance with this MovableObject.

virtual UserDefinedObjectgetUserObject (void)
 Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.

virtual void setRenderQueueGroup (RenderQueueGroupID queueID)
 Sets the render queue group this entity will be rendered through.

virtual RenderQueueGroupID getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details.

virtual Matrix4 _getParentNodeFullTransform (void) const
 return the full transformation of the parent sceneNode or the attachingPoint node

virtual void setQueryFlags (unsigned long flags)
 Sets the query flags for this object.

virtual void addQueryFlags (unsigned long flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

virtual void removeQueryFlags (unsigned long flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

virtual unsigned long getQueryFlags (void) const
 Returns the query flags relevant for this object.

virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses.

virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires.

virtual bool useIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection.

virtual bool useIdentityView (void) const
 Returns whether or not to use an 'identity' projection.

virtual SceneDetailLevel getRenderDetail () const
 Returns the preferred rasterisation mode of this renderable.

virtual bool getNormaliseNormals (void) const
 Returns whether or not this Renderable wishes the hardware to normalise normals.


Protected Types

typedef std::vector< ParticleEmitter * > ParticleEmitterList
typedef std::vector< ParticleAffector * > ParticleAffectorList
typedef std::list< Billboard * > ActiveBillboardList
typedef std::deque< Billboard * > FreeBillboardQueue
typedef std::vector< Billboard * > BillboardPool

Protected Methods

void _expire (Real timeElapsed)
 Internal method used to expire dead particles.

void _triggerEmitters (Real timeElapsed)
 Spawn new particles based on free quota and emitter requirements.

void _applyMotion (Real timeElapsed)
 Updates existing particle based on their momentum.

void _triggerAffectors (Real timeElapsed)
 Applies the effects of affectors.

void increasePool (unsigned int size)
 Overridden from BillboardSet to create Particle instead of Billboard.

ParticleaddParticle (void)
 Internal method for adding a new active particle.

void genBillboardAxes (Camera &cam, Vector3 *pX, Vector3 *pY, const Billboard *pBill=0)
 Overidden from BillboardSet.

void initParameters (void)
 Internal method for initialising string interface.

bool billboardVisible (Camera *cam, ActiveBillboardList::iterator bill)
 Internal method for culling individual billboards.

void getParametricOffsets (Real &left, Real &right, Real &top, Real &bottom)
 Internal method, generates parametric offsets based on origin.

void genVertices (Real **pPos, RGBA **pCol, Real **pTex, const Vector3 *offsets, const Billboard *pBillboard)
 Internal method for generating vertex data.

void genVertOffsets (Real inleft, Real inright, Real intop, Real inbottom, Real width, Real height, const Vector3 &x, const Vector3 &y, Vector3 *pDestVec)
 Internal method generates vertex offsets.

bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist.


Protected Attributes

String mName
 Name of the particle system instance.

ParticleEmitterList mEmitters
 List of particle emitters, ie sources of particles.

ParticleAffectorList mAffectors
 List of particle affectors, ie modifiers of particles.

AxisAlignedBox mAABB
 Bounds of all billboards in this set.

Real mBoundingRadius
 Bounding radius.

BillboardOrigin mOriginType
 Origin of each billboard.

Real mDefaultWidth
 Default width of each billboard.

Real mDefaultHeight
 Default height of each billboard.

String mMaterialName
 Name of the material to use.

MaterialmpMaterial
 Pointer to the material to use.

bool mAllDefaultSize
 True if no billboards in this set have been resized - greater efficiency.

bool mAutoExtendPool
 Flag indicating whether to autoextend pool.

bool mFixedTextureCoords
ActiveBillboardList mActiveBillboards
 Active billboard list.

FreeBillboardQueue mFreeBillboards
 Free billboard queue.

BillboardPool mBillboardPool
 Pool of billboard instances for use and reuse in the active billboard list.

VertexDatamVertexData
 The vertex position data for all billboards in this set.

IndexDatamIndexData
 The vertex index data for all billboards in this set (1 set only).

bool mCullIndividual
 Flag indicating whether each billboard should be culled separately (default: false).

BillboardType mBillboardType
 The type of billboard to render.

Vector3 mCommonDirection
 Common direction for billboards of type BBT_ORIENTED_COMMON.

unsigned short mNumVisibleBillboards
String mParamDictName
 Class name for this instance to be used as a lookup (must be initialised by subclasses).

NodemParentNode
 node to which this object is attached

bool mParentIsTagPoint
bool mVisible
 Is this object visible?

UserDefinedObjectmUserObject
 User defined object which is linked to this object.

RenderQueueGroupID mRenderQueueID
 The render queue to use when rendering this object.

unsigned long mQueryFlags
 Flags determining whether this object is included / excluded from scene queries.

AxisAlignedBox mWorldAABB
 Cached world AABB of this object.

Sphere mWorldBoundingSphere

Static Protected Attributes

CmdCull msCullCmd
 Command objects.

CmdHeight msHeightCmd
CmdMaterial msMaterialCmd
CmdQuota msQuotaCmd
CmdWidth msWidthCmd
CmdBillboardType msBillboardTypeCmd
CmdCommonDirection msCommonDirectionCmd
String msMovableType = "BillboardSet"
 Shared class-level name for Movable type.

ParamDictionaryMap msDictionary
 Dictionary of parameters.


Detailed Description

Class defining particle system based special effects.

Remarks:
Particle systems are special effects generators which are based on a number of moving points which are rendered perhaps using billboards (quads which always face the camera) to create the impression of things like like sparkles, smoke, blood spurts, dust etc.

This class simply manages a single collection of particles with a shared local center point and a bounding box. The visual aspect of the particles is handled by the base BillboardSet class which the ParticleSystem manages automatically.

Particle systems are created using the ParticleSystemManager::createParticleSystem method, never directly. In addition, like all subclasses of MovableObject, the ParticleSystem will only be considered for rendering once it has been attached to a SceneNode.

Definition at line 53 of file OgreParticleSystem.h.


Member Typedef Documentation

typedef std::list<Billboard*> Ogre::BillboardSet::ActiveBillboardList [protected, inherited]
 

Definition at line 117 of file OgreBillboardSet.h.

typedef std::vector<Billboard*> Ogre::BillboardSet::BillboardPool [protected, inherited]
 

Definition at line 119 of file OgreBillboardSet.h.

typedef std::deque<Billboard*> Ogre::BillboardSet::FreeBillboardQueue [protected, inherited]
 

Definition at line 118 of file OgreBillboardSet.h.

typedef std::vector<ParticleAffector*> Ogre::ParticleSystem::ParticleAffectorList [protected]
 

Definition at line 296 of file OgreParticleSystem.h.

typedef std::vector<ParticleEmitter*> Ogre::ParticleSystem::ParticleEmitterList [protected]
 

Definition at line 295 of file OgreParticleSystem.h.


Constructor & Destructor Documentation

Ogre::ParticleSystem::ParticleSystem  
 

Default constructor required for STL creation in manager.

Definition at line 53 of file OgreParticleSystem.cpp.

References initParameters().

Ogre::ParticleSystem::ParticleSystem const String   name
 

Creates a particle system with no emitters or affectors.

Remarks:
You should use the ParticleSystemManager to create particle systems rather than creating them directly.

Definition at line 58 of file OgreParticleSystem.cpp.

References Ogre::BBO_CENTER, initParameters(), Ogre::BillboardSet::mAllDefaultSize, Ogre::BillboardSet::mAutoExtendPool, Ogre::BillboardSet::mCullIndividual, Ogre::BillboardSet::mIndexData, mName, Ogre::BillboardSet::mOriginType, Ogre::BillboardSet::mVertexData, Ogre::BillboardSet::setDefaultDimensions(), Ogre::BillboardSet::setMaterialName(), and Ogre::BillboardSet::setPoolSize().

Ogre::ParticleSystem::~ParticleSystem   [virtual]
 

Definition at line 84 of file OgreParticleSystem.cpp.

References removeAllAffectors(), and removeAllEmitters().


Member Function Documentation

void Ogre::ParticleSystem::_applyMotion Real    timeElapsed [protected]
 

Updates existing particle based on their momentum.

Definition at line 335 of file OgreParticleSystem.cpp.

References Ogre::BillboardSet::mActiveBillboards, Ogre::Billboard::mDirection, Ogre::Billboard::mPosition, and Ogre::Real.

Referenced by _update().

void Ogre::ParticleSystem::_expire Real    timeElapsed [protected]
 

Internal method used to expire dead particles.

Definition at line 240 of file OgreParticleSystem.cpp.

References Ogre::BillboardSet::mActiveBillboards, Ogre::BillboardSet::mFreeBillboards, Ogre::Particle::mTimeToLive, and Ogre::Real.

Referenced by _update().

ParticleIterator Ogre::ParticleSystem::_getIterator void   
 

Returns an iterator for stepping through all particles in this system.

Remarks:
This method is designed to be used by people providing new ParticleAffector subclasses, this is the easiest way to step through all the particles in a system and apply the changes the affector wants to make.

Definition at line 375 of file OgreParticleSystem.cpp.

References Ogre::BillboardSet::mActiveBillboards.

Referenced by Ogre::ScaleAffector::_affectParticles(), Ogre::RotationAffector::_affectParticles(), Ogre::LinearForceAffector::_affectParticles(), Ogre::ColourInterpolatorAffector::_affectParticles(), Ogre::ColourImageAffector::_affectParticles(), Ogre::ColourFaderAffector2::_affectParticles(), and Ogre::ColourFaderAffector::_affectParticles().

Matrix4 Ogre::MovableObject::_getParentNodeFullTransform void    const [virtual, inherited]
 

return the full transformation of the parent sceneNode or the attachingPoint node

Definition at line 92 of file OgreMovableObject.cpp.

References Ogre::Node::_getFullTransform(), and Ogre::MovableObject::mParentNode.

Referenced by Ogre::Entity::cacheBoneMatrices(), Ogre::TagPoint::getParentEntityTransform(), Ogre::MovableObject::getWorldBoundingBox(), Ogre::SubEntity::getWorldTransforms(), and Ogre::BillboardSet::getWorldTransforms().

void Ogre::MovableObject::_notifyAttached Node   parent,
bool    isTagPoint = false
[virtual, inherited]
 

Internal method called to notify the object that it has been attached to a node.

Definition at line 54 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mParentIsTagPoint, and Ogre::MovableObject::mParentNode.

Referenced by Ogre::SceneNode::attachObject(), Ogre::Entity::attachObjectImpl(), Ogre::SceneNode::detachAllObjects(), Ogre::SceneNode::detachObject(), and Ogre::SceneNode::~SceneNode().

void Ogre::BillboardSet::_notifyBillboardResized void    [virtual, inherited]
 

Internal callback used by Billboards to notify their parent that they have been resized.

Definition at line 726 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mAllDefaultSize.

Referenced by Ogre::Billboard::setDimensions().

virtual void Ogre::BillboardSet::_notifyBillboardTextureCoordsModified void    [virtual, inherited]
 

Notifies the billboardset that texture coordinates will be modified for this set.

Definition at line 460 of file OgreBillboardSet.h.

Referenced by Ogre::Billboard::setRotation().

void Ogre::BillboardSet::_notifyCurrentCamera Camera   cam [virtual, inherited]
 

Overridden from MovableObject.

See also:
MovableObject

Implements Ogre::MovableObject.

Definition at line 269 of file OgreBillboardSet.cpp.

References Ogre::BBT_ORIENTED_SELF, Ogre::BillboardSet::billboardVisible(), COLOUR_BINDING, Ogre::BillboardSet::genBillboardAxes(), Ogre::BillboardSet::genVertices(), Ogre::BillboardSet::genVertOffsets(), Ogre::VertexBufferBinding::getBuffer(), Ogre::BillboardSet::getParametricOffsets(), Ogre::BillboardSet::mActiveBillboards, Ogre::BillboardSet::mBillboardType, Ogre::BillboardSet::mDefaultHeight, Ogre::BillboardSet::mDefaultWidth, Ogre::BillboardSet::mFixedTextureCoords, Ogre::BillboardSet::mNumVisibleBillboards, Ogre::BillboardSet::mVertexData, POSITION_BINDING, Ogre::Real, Ogre::RGBA, TEXCOORD_BINDING, and Ogre::VertexData::vertexBufferBinding.

void Ogre::ParticleSystem::_triggerAffectors Real    timeElapsed [protected]
 

Applies the effects of affectors.

Definition at line 349 of file OgreParticleSystem.cpp.

References mAffectors, and Ogre::Real.

Referenced by _update().

void Ogre::ParticleSystem::_triggerEmitters Real    timeElapsed [protected]
 

Spawn new particles based on free quota and emitter requirements.

Definition at line 265 of file OgreParticleSystem.cpp.

References Ogre::Node::_getDerivedOrientation(), Ogre::Node::_getDerivedPosition(), addParticle(), getParticleQuota(), Ogre::BillboardSet::mActiveBillboards, mAffectors, Ogre::Billboard::mDirection, mEmitters, Ogre::MovableObject::mParentNode, Ogre::Billboard::mPosition, and Ogre::Real.

Referenced by _update().

void Ogre::ParticleSystem::_update Real    timeElapsed
 

Updates the particles in the system based on time elapsed.

Remarks:
This is called automatically every frame by OGRE.
Parameters:
timeElapsed  The amount of time, in seconds, since the last frame.

Definition at line 222 of file OgreParticleSystem.cpp.

References _applyMotion(), _expire(), _triggerAffectors(), _triggerEmitters(), _updateBounds(), and Ogre::Real.

Referenced by fastForward().

void Ogre::ParticleSystem::_updateBounds void    [virtual]
 

Overridden from BillboardSet.

Reimplemented from Ogre::BillboardSet.

Definition at line 494 of file OgreParticleSystem.cpp.

References Ogre::Node::_getDerivedOrientation(), Ogre::Node::_getDerivedPosition(), Ogre::AxisAlignedBox::getAllCorners(), Ogre::Quaternion::Inverse(), Ogre::AxisAlignedBox::isNull(), Ogre::BillboardSet::mAABB, Ogre::Vector3::makeCeil(), Ogre::Vector3::makeFloor(), Ogre::MovableObject::mParentNode, and Ogre::AxisAlignedBox::setExtents().

Referenced by _update().

void Ogre::BillboardSet::_updateRenderQueue RenderQueue   queue [virtual, inherited]
 

Overridden from MovableObject.

See also:
MovableObject

Implements Ogre::MovableObject.

Definition at line 525 of file OgreBillboardSet.cpp.

References Ogre::RenderQueue::addRenderable(), Ogre::MovableObject::mRenderQueueID, and RENDERABLE_DEFAULT_PRIORITY.

ParticleAffector * Ogre::ParticleSystem::addAffector const String   affectorType
 

Adds an affector to this particle system.

Remarks:
Particles are modified over time in a particle system by affectors - see the ParticleAffector class for more details.
Parameters:
affectorType  String identifying the affector type to create. Affector types are defined by registering new factories with the manager - see ParticleAffectorFactory for more details. Affector types can be extended by OGRE, plugin authors or application developers.

Definition at line 133 of file OgreParticleSystem.cpp.

References mAffectors.

Referenced by operator=(), and Ogre::ParticleSystemManager::parseNewAffector().

ParticleEmitter * Ogre::ParticleSystem::addEmitter const String   emitterType
 

Adds an emitter to this particle system.

Remarks:
Particles are created in a particle system by emitters - see the ParticleEmitter class for more details.
Parameters:
emitterType  String identifying the emitter type to create. Emitter types are defined by registering new factories with the manager - see ParticleEmitterFactory for more details. Emitter types can be extended by OGRE, plugin authors or application developers.

Definition at line 96 of file OgreParticleSystem.cpp.

References mEmitters.

Referenced by operator=(), and Ogre::ParticleSystemManager::parseNewEmitter().

Particle * Ogre::ParticleSystem::addParticle void    [protected]
 

Internal method for adding a new active particle.

Definition at line 380 of file OgreParticleSystem.cpp.

References Ogre::Billboard::_notifyOwner(), Ogre::BillboardSet::mActiveBillboards, and Ogre::BillboardSet::mFreeBillboards.

Referenced by _triggerEmitters().

virtual void Ogre::MovableObject::addQueryFlags unsigned long    flags [virtual, inherited]
 

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 168 of file OgreMovableObject.h.

bool Ogre::BillboardSet::billboardVisible Camera   cam,
ActiveBillboardList::iterator    bill
[protected, inherited]
 

Internal method for culling individual billboards.

Definition at line 812 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::getWorldTransforms(), Ogre::Camera::isVisible(), Ogre::BillboardSet::mCullIndividual, Ogre::BillboardSet::mDefaultHeight, Ogre::BillboardSet::mDefaultWidth, Ogre::Sphere::setCenter(), and Ogre::Sphere::setRadius().

Referenced by Ogre::BillboardSet::_notifyCurrentCamera().

void Ogre::BillboardSet::clear   [virtual, inherited]
 

Empties this set of all billboards.

Definition at line 140 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mActiveBillboards.

virtual void Ogre::StringInterface::copyParametersTo StringInterface   dest const [virtual, inherited]
 

Method for copying this object's parameters to another object.

Remarks:
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

Any unrecognised parameters will be ignored as with setParameter method.

Parameters:
dest  Pointer to object to have it's parameters set the same as this object.

Definition at line 293 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

Referenced by Ogre::GuiElement::copyFromTemplate(), Ogre::GuiContainer::copyFromTemplate(), and operator=().

Billboard * Ogre::BillboardSet::createBillboard Real    x,
Real    y,
Real    z,
const ColourValue   colour = ColourValue::White
[inherited]
 

Creates a new billboard and adds it to this set.

Remarks:
Behaviour once the billboard pool has been exhausted depends on the BillboardSet::setAutoextendPool option.
Parameters:
x 
y 
z  The position of the new billboard realtive to the certer of the set
colour  Optional base colour of the billboard.
Returns:
On success, a pointer to a newly created Billboard is returned.

On failiure (i.e. no more space and can't autoextend), NULL is returned.

See also:
BillboardSet::setAutoextend

Definition at line 126 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::createBillboard(), and Ogre::Real.

Billboard * Ogre::BillboardSet::createBillboard const Vector3   position,
const ColourValue   colour = ColourValue::White
[inherited]
 

Creates a new billboard and adds it to this set.

Remarks:
Behaviour once the billboard pool has been exhausted depends on the BillboardSet::setAutoextendPool option.
Parameters:
position  The position of the new billboard realtive to the certer of the set
colour  Optional base colour of the billboard.
Returns:
On success, a pointer to a newly created Billboard is returned.

On failiure (i.e. no more space and can't autoextend), NULL is returned.

See also:
BillboardSet::setAutoextend

Definition at line 95 of file OgreBillboardSet.cpp.

References Ogre::Billboard::_notifyOwner(), Ogre::BillboardSet::_updateBounds(), Ogre::BillboardSet::getPoolSize(), Ogre::BillboardSet::mActiveBillboards, Ogre::BillboardSet::mFreeBillboards, Ogre::Billboard::setColour(), Ogre::BillboardSet::setPoolSize(), and Ogre::Billboard::setPosition().

Referenced by Ogre::BillboardSet::createBillboard().

bool Ogre::StringInterface::createParamDictionary const String   className [protected, inherited]
 

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).
Parameters:
className  the name of the class using the dictionary
Returns:
true if a new dictionary was created, false if it was already there

Definition at line 169 of file OgreStringInterface.h.

Referenced by Ogre::BorderButtonGuiElement::BorderButtonGuiElement(), Ogre::BorderPanelGuiElement::BorderPanelGuiElement(), Ogre::ButtonGuiElement::ButtonGuiElement(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::AreaEmitter::initDefaults(), initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::ListGuiElement::ListGuiElement(), Ogre::PanelGuiElement::PanelGuiElement(), Ogre::PointEmitter::PointEmitter(), Ogre::PopupMenuGuiElement::PopupMenuGuiElement(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), Ogre::ScrollBarGuiElement::ScrollBarGuiElement(), Ogre::TextAreaGuiElement::TextAreaGuiElement(), Ogre::TextBoxGuiElement::TextBoxGuiElement(), and Ogre::TTYGuiElement::TTYGuiElement().

void Ogre::ParticleSystem::fastForward Real    time,
Real    interval = 0.1
 

Fast-forwards this system by the required number of seconds.

Remarks:
This method allows you to fast-forward a system so that it effectively looks like it has already been running for the time you specify. This is useful to avoid the 'startup sequence' of a system, when you want the system to be fully populated right from the start.
Parameters:
time  The number of seconds to fast-forward by.
interval  The sampling interval used to generate particles, apply affectors etc. The lower this is the more realistic the fast-forward, but it takes more iterations to do it.

Definition at line 524 of file OgreParticleSystem.cpp.

References _update(), and Ogre::Real.

void Ogre::ParticleSystem::genBillboardAxes Camera   cam,
Vector3   pX,
Vector3   pY,
const Billboard   pBill = 0
[protected, virtual]
 

Overidden from BillboardSet.

See also:
BillboardSet

Reimplemented from Ogre::BillboardSet.

Definition at line 394 of file OgreParticleSystem.cpp.

References Ogre::BBT_ORIENTED_COMMON, Ogre::BBT_ORIENTED_SELF, Ogre::BBT_POINT, Ogre::Vector3::crossProduct(), Ogre::Camera::getDerivedDirection(), Ogre::Camera::getDerivedOrientation(), Ogre::BillboardSet::mCommonDirection, and Ogre::Billboard::mDirection.

void Ogre::BillboardSet::genVertices Real **    pPos,
RGBA **    pCol,
Real **    pTex,
const Vector3   offsets,
const Billboard   pBillboard
[protected, inherited]
 

Internal method for generating vertex data.

Parameters:
pPos  Pointer to pointer to vertex positions, will be updated
pCol  Pointer to pointer to vertex colours, will be updated
offsets  Array of 4 Vector3 offsets
pBillboard  Pointer to billboard
Returns:
new vertex index

Definition at line 911 of file OgreBillboardSet.cpp.

References Ogre::Billboard::mColour, Ogre::BillboardSet::mFixedTextureCoords, Ogre::Billboard::mPosition, Ogre::Billboard::mRotation, Ogre::Real, Ogre::RGBA, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera().

void Ogre::BillboardSet::genVertOffsets Real    inleft,
Real    inright,
Real    intop,
Real    inbottom,
Real    width,
Real    height,
const Vector3   x,
const Vector3   y,
Vector3   pDestVec
[protected, inherited]
 

Internal method generates vertex offsets.

Remarks:
Takes in parametric offsets as generated from getParametericOffsets, width and height values and billboard x and y axes as generated from genBillboardAxes. Fills output array of 4 vectors with vector offsets from origin for left-top, right-top, left-bottom, right-bottom corners.

Definition at line 971 of file OgreBillboardSet.cpp.

References Ogre::Real.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera().

ParticleAffector * Ogre::ParticleSystem::getAffector unsigned short    index const
 

Retrieves an affector by it's index (zero-based).

Remarks:
Used to retrieve a pointer to an affector for a particle system to procedurally change affector parameters etc. You should check how many affectors are registered against this system before calling this method with an arbitrary index using getNumAffectors.
Parameters:
index  Zero-based index of the affector to retrieve.

Definition at line 140 of file OgreParticleSystem.cpp.

References mAffectors.

Referenced by operator=().

bool Ogre::BillboardSet::getAutoextend void    const [virtual, inherited]
 

Returns true if the billboard pool automatically extends.

See also:
BillboardSet::setAutoextend

Definition at line 573 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mAutoExtendPool.

Billboard * Ogre::BillboardSet::getBillboard unsigned int    index const [virtual, inherited]
 

Returns a pointer to the billboard at the supplied index.

Note:
This method requires linear time since the billboard list is a linked list.
Parameters:
index  The index of the billboard that is requested.
Returns:
On success, a valid pointer to the requested billboard is returned.

On failiure, NULL is returned.

Definition at line 147 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mActiveBillboards.

BillboardOrigin Ogre::BillboardSet::getBillboardOrigin void    const [virtual, inherited]
 

Gets the point which acts as the origin point for all billboards in this set.

Returns:
A member of the BillboardOrigin enum specifying the origin for all the billboards in this set.

Definition at line 213 of file OgreBillboardSet.cpp.

References Ogre::BillboardOrigin, and Ogre::BillboardSet::mOriginType.

BillboardType Ogre::BillboardSet::getBillboardType void    const [virtual, inherited]
 

Returns the billboard type in use.

Definition at line 896 of file OgreBillboardSet.cpp.

References Ogre::BillboardType, and Ogre::BillboardSet::mBillboardType.

const AxisAlignedBox & Ogre::BillboardSet::getBoundingBox void    const [virtual, inherited]
 

Overridden from MovableObject.

See also:
MovableObject

Implements Ogre::MovableObject.

Definition at line 519 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mAABB.

Real Ogre::BillboardSet::getBoundingRadius void    const [virtual, inherited]
 

Overridden from MovableObject.

See also:
MovableObject

Implements Ogre::MovableObject.

Definition at line 1009 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mBoundingRadius, and Ogre::Real.

const Vector3 & Ogre::BillboardSet::getCommonDirection void    const [virtual, inherited]
 

Gets the common direction for all billboards (BBT_ORIENTED_COMMON).

Definition at line 906 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mCommonDirection.

Referenced by Ogre::ParticleSystem::CmdCommonDirection::doGet().

bool Ogre::BillboardSet::getCullIndividually void    const [virtual, inherited]
 

Returns whether or not billbards in this are tested individually for culling.

Definition at line 802 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mCullIndividual.

Referenced by Ogre::ParticleSystem::CmdCull::doGet().

Real Ogre::BillboardSet::getDefaultHeight void    const [virtual, inherited]
 

See setDefaultDimensions - this gets 1 component individually.

Definition at line 240 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mDefaultHeight, and Ogre::Real.

Referenced by Ogre::ScaleAffector::_affectParticles(), and Ogre::ParticleSystem::CmdHeight::doGet().

Real Ogre::BillboardSet::getDefaultWidth void    const [virtual, inherited]
 

See setDefaultDimensions - this gets 1 component individually.

Definition at line 230 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mDefaultWidth, and Ogre::Real.

Referenced by Ogre::ScaleAffector::_affectParticles(), and Ogre::ParticleSystem::CmdWidth::doGet().

ParticleEmitter * Ogre::ParticleSystem::getEmitter unsigned short    index const
 

Retrieves an emitter by it's index (zero-based).

Remarks:
Used to retrieve a pointer to an emitter for a particle system to procedurally change emission parameters etc. You should check how many emitters are registered against this system before calling this method with an arbitrary index using getNumEmitters.
Parameters:
index  Zero-based index of the emitter to retrieve.

Definition at line 103 of file OgreParticleSystem.cpp.

References mEmitters.

Referenced by operator=().

const LightList & Ogre::BillboardSet::getLights void    const [virtual, inherited]
 

@copydoc Renderable::getLights

Implements Ogre::Renderable.

Definition at line 1014 of file OgreBillboardSet.cpp.

References Ogre::Node::getLights(), Ogre::LightList, and Ogre::MovableObject::mParentNode.

Material * Ogre::BillboardSet::getMaterial void    const [virtual, inherited]
 

Overridden from MovableObject.

See also:
MovableObject

Implements Ogre::Renderable.

Definition at line 531 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mpMaterial.

const String & Ogre::BillboardSet::getMaterialName void    const [virtual, inherited]
 

Sets the name of the material to be used for this billboard set.

Returns:
The name of the material that is used for this set.

Definition at line 263 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mMaterialName.

const String & Ogre::ParticleSystem::getMovableType void    const [virtual]
 

Overridden from MovableObject.

Reimplemented from Ogre::BillboardSet.

Definition at line 534 of file OgreParticleSystem.cpp.

const String & Ogre::ParticleSystem::getName void    const [virtual]
 

Gets the name of this particle system.

Reimplemented from Ogre::BillboardSet.

Definition at line 91 of file OgreParticleSystem.cpp.

References mName.

Referenced by Ogre::ParticleSystemManager::parseAttrib(), and Ogre::ParticleSystemManager::parseScript().

virtual bool Ogre::Renderable::getNormaliseNormals void    const [virtual, inherited]
 

Returns whether or not this Renderable wishes the hardware to normalise normals.

Reimplemented in Ogre::SubEntity.

Definition at line 132 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::renderSingleObject().

unsigned short Ogre::ParticleSystem::getNumAffectors void    const
 

Returns the number of affectors for this particle system.

Definition at line 146 of file OgreParticleSystem.cpp.

References mAffectors.

Referenced by operator=().

int Ogre::BillboardSet::getNumBillboards void    const [virtual, inherited]
 

Returns the number of active billboards which currently make up this set.

Definition at line 134 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mActiveBillboards.

unsigned short Ogre::ParticleSystem::getNumEmitters void    const
 

Returns the number of emitters for this particle system.

Definition at line 109 of file OgreParticleSystem.cpp.

References mEmitters.

Referenced by operator=().

unsigned int Ogre::ParticleSystem::getNumParticles void    const
 

Gets the number of individual particles in the system right now.

Remarks:
The number of particles active in a system at a point in time depends on the number of emitters, their emission rates, the time-to-live (TTL) each particle is given on emission (and whether any affectors modify that TTL) and the maximum number of particles allowed in this system at once (particle quota).

Definition at line 205 of file OgreParticleSystem.cpp.

References Ogre::BillboardSet::mActiveBillboards.

virtual unsigned short Ogre::Renderable::getNumWorldTransforms void    const [virtual, inherited]
 

Returns the number of world transform matrices this renderable requires.

Remarks:
When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented in Ogre::SubEntity, and Ogre::BorderRenderable.

Definition at line 98 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::renderSingleObject().

const ParamDictionary* Ogre::StringInterface::getParamDictionary void    const [inherited]
 

Definition at line 206 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary void    [inherited]
 

Retrieves the parameter dictionary for this class.

Remarks:
Only valid to call this after createParamDictionary.
Returns:
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 193 of file OgreStringInterface.h.

Referenced by Ogre::TTYGuiElement::addBaseParameters(), Ogre::TextBoxGuiElement::addBaseParameters(), Ogre::TextAreaGuiElement::addBaseParameters(), Ogre::ScrollBarGuiElement::addBaseParameters(), Ogre::PopupMenuGuiElement::addBaseParameters(), Ogre::ParticleEmitter::addBaseParameters(), Ogre::PanelGuiElement::addBaseParameters(), Ogre::ListGuiElement::addBaseParameters(), Ogre::GuiElement::addBaseParameters(), Ogre::CursorGuiElement::addBaseParameters(), Ogre::ButtonGuiElement::addBaseParameters(), Ogre::BorderPanelGuiElement::addBaseParameters(), Ogre::BorderButtonGuiElement::addBaseParameters(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::HollowEllipsoidEmitter::HollowEllipsoidEmitter(), Ogre::AreaEmitter::initDefaults(), initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::RingEmitter::RingEmitter(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), and Ogre::StringInterface::setParameter().

virtual String Ogre::StringInterface::getParameter const String   name const [virtual, inherited]
 

Generic parameter retrieval method.

Remarks:
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters:
name  The name of the parameter to get
Returns:
String value of parameter, blank if not found

Definition at line 262 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

const ParameterList& Ogre::StringInterface::getParameters void    const [inherited]
 

Retrieves a list of parameters valid for this object.

Returns:
A reference to a static list of ParameterDef objects.

Definition at line 224 of file OgreStringInterface.h.

References Ogre::ParamDictionary::getParameters(), and Ogre::ParameterList.

void Ogre::BillboardSet::getParametricOffsets Real   left,
Real   right,
Real   top,
Real   bottom
[protected, inherited]
 

Internal method, generates parametric offsets based on origin.

Definition at line 732 of file OgreBillboardSet.cpp.

References Ogre::BBO_BOTTOM_CENTER, Ogre::BBO_BOTTOM_LEFT, Ogre::BBO_BOTTOM_RIGHT, Ogre::BBO_CENTER, Ogre::BBO_CENTER_LEFT, Ogre::BBO_CENTER_RIGHT, Ogre::BBO_TOP_CENTER, Ogre::BBO_TOP_LEFT, Ogre::BBO_TOP_RIGHT, and Ogre::Real.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera().

Node * Ogre::MovableObject::getParentNode void    const [virtual, inherited]
 

Returns the node to which this object is attached.

Remarks:
An object is not visible in the scene unless attached to a SceneNode.

Attaching an object is done via the SceneNode::attachObject method.

Definition at line 60 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mParentNode.

Referenced by Ogre::TagPoint::_updateFromParent(), Ogre::BspIntersectionSceneQuery::execute(), Ogre::TagPoint::getLights(), Ogre::SubEntity::getLights(), Ogre::SubEntity::getSquaredViewDepth(), Ogre::TagPoint::needUpdate(), and Ogre::BspSceneManager::processVisibleLeaf().

unsigned int Ogre::ParticleSystem::getParticleQuota void    const
 

Returns the maximum number of particles this system is allowed to have active at once.

Remarks:
See ParticleSystem::setParticleQuota for more info.

Definition at line 210 of file OgreParticleSystem.cpp.

References Ogre::BillboardSet::getPoolSize().

Referenced by _triggerEmitters(), Ogre::ParticleSystemManager::createSystem(), and Ogre::ParticleSystem::CmdQuota::doGet().

unsigned int Ogre::BillboardSet::getPoolSize void    const [virtual, inherited]
 

Returns the current size of the billboard pool.

Returns:
The current size of the billboard pool.
See also:
BillboardSet::setAutoextend

Definition at line 720 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mBillboardPool.

Referenced by Ogre::BillboardSet::createBillboard(), getParticleQuota(), and operator=().

virtual unsigned long Ogre::MovableObject::getQueryFlags void    const [virtual, inherited]
 

Returns the query flags relevant for this object.

Definition at line 175 of file OgreMovableObject.h.

Referenced by Ogre::BspIntersectionSceneQuery::execute().

virtual SceneDetailLevel Ogre::Renderable::getRenderDetail   const [virtual, inherited]
 

Returns the preferred rasterisation mode of this renderable.

Reimplemented in Ogre::SubEntity.

Definition at line 129 of file OgreRenderable.h.

References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID.

Referenced by Ogre::SceneManager::renderSingleObject().

void Ogre::BillboardSet::getRenderOperation RenderOperation   op [virtual, inherited]
 

Overridden from MovableObject.

See also:
MovableObject

Implements Ogre::Renderable.

Definition at line 537 of file OgreBillboardSet.cpp.

References Ogre::IndexData::indexCount, Ogre::RenderOperation::indexData, Ogre::IndexData::indexStart, Ogre::BillboardSet::mIndexData, Ogre::BillboardSet::mNumVisibleBillboards, Ogre::BillboardSet::mVertexData, Ogre::RenderOperation::operationType, Ogre::RenderOperation::useIndexes, Ogre::VertexData::vertexCount, Ogre::RenderOperation::vertexData, and Ogre::VertexData::vertexStart.

RenderQueueGroupID Ogre::MovableObject::getRenderQueueGroup void    const [virtual, inherited]
 

Gets the queue group for this entity, see setRenderQueueGroup for full details.

Definition at line 87 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mRenderQueueID, and Ogre::RenderQueueGroupID.

Real Ogre::BillboardSet::getSquaredViewDepth const Camera   cam const [virtual, inherited]
 

Overridden, see Renderable.

Implements Ogre::Renderable.

Definition at line 1003 of file OgreBillboardSet.cpp.

References Ogre::Node::getSquaredViewDepth(), Ogre::MovableObject::mParentNode, and Ogre::Real.

virtual Technique* Ogre::Renderable::getTechnique void    const [virtual, inherited]
 

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks:
This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::SubEntity.

Definition at line 63 of file OgreRenderable.h.

References Ogre::Material::getBestTechnique().

Referenced by Ogre::RenderPriorityGroup::addRenderable().

virtual UserDefinedObject* Ogre::MovableObject::getUserObject void    [virtual, inherited]
 

Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.

Definition at line 136 of file OgreMovableObject.h.

const AxisAlignedBox & Ogre::MovableObject::getWorldBoundingBox bool    derive = false const [virtual, inherited]
 

Retrieves the axis-aligned bounding box for this object in world coordinates.

Definition at line 104 of file OgreMovableObject.cpp.

References Ogre::MovableObject::_getParentNodeFullTransform(), Ogre::MovableObject::getBoundingBox(), Ogre::MovableObject::mWorldAABB, and Ogre::AxisAlignedBox::transform().

Referenced by Ogre::BspIntersectionSceneQuery::execute(), and Ogre::BspSceneManager::processVisibleLeaf().

const Sphere & Ogre::MovableObject::getWorldBoundingSphere bool    derive = false const [virtual, inherited]
 

Retrieves the worldspace bounding sphere for this object.

Definition at line 116 of file OgreMovableObject.cpp.

References Ogre::Node::_getDerivedPosition(), Ogre::MovableObject::getBoundingRadius(), Ogre::MovableObject::mParentNode, Ogre::MovableObject::mWorldBoundingSphere, Ogre::Sphere::setCenter(), and Ogre::Sphere::setRadius().

const Quaternion & Ogre::ParticleSystem::getWorldOrientation void    const [virtual]
 

@copydoc Renderable::getWorldOrientation

Reimplemented from Ogre::BillboardSet.

Definition at line 437 of file OgreParticleSystem.cpp.

References Ogre::Node::_getDerivedOrientation(), and Ogre::MovableObject::mParentNode.

const Vector3 & Ogre::ParticleSystem::getWorldPosition void    const [virtual]
 

@copydoc Renderable::getWorldPosition

Reimplemented from Ogre::BillboardSet.

Definition at line 442 of file OgreParticleSystem.cpp.

References Ogre::Node::_getDerivedPosition(), and Ogre::MovableObject::mParentNode.

void Ogre::ParticleSystem::getWorldTransforms Matrix4   xform const [virtual]
 

Overridden from MovableObject.

See also:
MovableObject

Reimplemented from Ogre::BillboardSet.

Definition at line 430 of file OgreParticleSystem.cpp.

void Ogre::ParticleSystem::increasePool unsigned int    size [protected, virtual]
 

Overridden from BillboardSet to create Particle instead of Billboard.

Reimplemented from Ogre::BillboardSet.

Definition at line 361 of file OgreParticleSystem.cpp.

References Ogre::BillboardSet::mBillboardPool.

void Ogre::ParticleSystem::initParameters void    [protected]
 

Internal method for initialising string interface.

Definition at line 447 of file OgreParticleSystem.cpp.

References Ogre::ParamDictionary::addParameter(), Ogre::StringInterface::createParamDictionary(), Ogre::StringInterface::getParamDictionary(), msBillboardTypeCmd, msCommonDirectionCmd, msCullCmd, msHeightCmd, msMaterialCmd, msQuotaCmd, msWidthCmd, Ogre::PT_BOOL, Ogre::PT_REAL, Ogre::PT_STRING, Ogre::PT_UNSIGNED_INT, and Ogre::PT_VECTOR3.

Referenced by ParticleSystem().

bool Ogre::MovableObject::isAttached void    const [virtual, inherited]
 

Returns true if this object is attached to a SceneNode or TagPoint.

Definition at line 65 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mParentNode.

Referenced by Ogre::Entity::attachObjectToBone().

bool Ogre::MovableObject::isVisible void    const [virtual, inherited]
 

Returns whether or not this object is supposed to be visible or not.

Definition at line 76 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mVisible.

Referenced by Ogre::OctreeNode::_addToRenderQueue(), Ogre::SceneManager::_populateLightList(), and Ogre::BspSceneManager::processVisibleLeaf().

ParticleSystem & Ogre::ParticleSystem::operator= const ParticleSystem &    rhs
 

Assignment operator for copying.

Remarks:
This operator deep copies all particle emitters and effectors, but not particles. The system's name is also not copied.

Definition at line 170 of file OgreParticleSystem.cpp.

References addAffector(), addEmitter(), Ogre::StringInterface::copyParametersTo(), getAffector(), getEmitter(), getNumAffectors(), getNumEmitters(), Ogre::BillboardSet::getPoolSize(), Ogre::ParticleAffector::getType(), Ogre::ParticleEmitter::getType(), Ogre::BillboardSet::mBillboardType, Ogre::BillboardSet::mCommonDirection, Ogre::BillboardSet::mCullIndividual, Ogre::BillboardSet::mDefaultHeight, Ogre::BillboardSet::mDefaultWidth, Ogre::BillboardSet::mMaterialName, Ogre::BillboardSet::mOriginType, removeAllAffectors(), removeAllEmitters(), Ogre::BillboardSet::setMaterialName(), and Ogre::BillboardSet::setPoolSize().

void Ogre::ParticleSystem::removeAffector unsigned short    index
 

Removes an affector from the system.

Remarks:
Drops the affector with the index specified from this system. You should check how many affectors are registered against this system before calling this method with an arbitrary index using getNumAffectors.
Parameters:
index  Zero-based index of the affector to retrieve.

Definition at line 151 of file OgreParticleSystem.cpp.

References mAffectors.

void Ogre::ParticleSystem::removeAllAffectors void   
 

Removes all the affectors from this system.

Definition at line 159 of file OgreParticleSystem.cpp.

References mAffectors.

Referenced by operator=(), and ~ParticleSystem().

void Ogre::ParticleSystem::removeAllEmitters void   
 

Removes all the emitters from this system.

Definition at line 122 of file OgreParticleSystem.cpp.

References mEmitters.

Referenced by operator=(), and ~ParticleSystem().

void Ogre::BillboardSet::removeBillboard Billboard   pBill [virtual, inherited]
 

Removes a billboard from the set.

Note:
This version is more efficient than removing by index.

Definition at line 200 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mActiveBillboards, and Ogre::BillboardSet::mFreeBillboards.

void Ogre::BillboardSet::removeBillboard unsigned int    index [virtual, inherited]
 

Removes the billboard at the supplied index.

Note:
This method requires linear time since the billboard list is a linked list.

Definition at line 172 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mActiveBillboards, and Ogre::BillboardSet::mFreeBillboards.

void Ogre::ParticleSystem::removeEmitter unsigned short    index
 

Removes an emitter from the system.

Remarks:
Drops the emitter with the index specified from this system. You should check how many emitters are registered against this system before calling this method with an arbitrary index using getNumEmitters.
Parameters:
index  Zero-based index of the emitter to retrieve.

Definition at line 114 of file OgreParticleSystem.cpp.

References mEmitters.

virtual void Ogre::MovableObject::removeQueryFlags unsigned long    flags [virtual, inherited]
 

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 172 of file OgreMovableObject.h.

void Ogre::BillboardSet::setAutoextend bool    autoextend [virtual, inherited]
 

Tells the set whether to allow automatic extension of the pool of billboards.

Remarks:
A BillboardSet stores a pool of pre-constructed billboards which are used as needed when a new billboard is requested. This allows applications to create / remove billboards efficiently without incurring construction / destruction costs (a must for sets with lots of billboards like particle effects). This method allows you to configure the behaviour when a new billboard is requested but the billboard pool has been exhausted.

The default behaviour is to allow the pool to extend (typically this allocates double the current pool of billboards when the pool is expended), equivalent to calling this method with autoExtend = true. If you set the parameter to false however, any attempt to create a new billboard when the pool has expired will simply fail silently, returning a null pointer.

Parameters:
autoextend  true to double the pool every time it runs out, false to fail silently.

Definition at line 567 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mAutoExtendPool.

void Ogre::BillboardSet::setBillboardOrigin BillboardOrigin    origin [virtual, inherited]
 

Sets the point which acts as the origin point for all billboards in this set.

Remarks:
This setting controls the fine tuning of where a billboard appears in relation to it's position. It could be that a billboard's position represents it's center (e.g. for fireballs), it could mean the center of the bottom edge (e.g. a tree which is positioned on the ground), the top-left corner (e.g. a cursor).

The default setting is BBO_CENTER.

Parameters:
origin  A member of the BillboardOrigin enum specifying the origin for all the billboards in this set.

Definition at line 207 of file OgreBillboardSet.cpp.

References Ogre::BillboardOrigin, and Ogre::BillboardSet::mOriginType.

void Ogre::BillboardSet::setBillboardType BillboardType    bbt [virtual, inherited]
 

Sets the type of billboard to render.

Remarks:
The default sort of billboard (BBT_POINT), always has both x and y axes parallel to the camera's local axes. This is fine for 'point' style billboards (e.g. flares, smoke, anything which is symmetrical about a central point) but does not look good for billboards which have an orientation (e.g. an elongated raindrop). In this case, the oriented billboards are more suitable (BBT_ORIENTED_COMMON or BBT_ORIENTED_SELF) since they retain an independant Y axis and only the X axis is generated, perpendicular to both the local Y and the camera Z.
Parameters:
bbt  The type of billboard to render

Definition at line 891 of file OgreBillboardSet.cpp.

References Ogre::BillboardType, and Ogre::BillboardSet::mBillboardType.

void Ogre::BillboardSet::setCommonDirection const Vector3   vec [virtual, inherited]
 

Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON.

Remarks:
Use BBT_ORIENTED_COMMON when you want oriented billboards but you know they are always going to be oriented the same way (e.g. rain in calm weather). It is faster for the system to calculate the billboard vertices if they have a common direction.
Parameters:
vec  The direction for all billboards.

Definition at line 901 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mCommonDirection.

void Ogre::BillboardSet::setCullIndividually bool    cullIndividual [virtual, inherited]
 

Sets whether culling tests billboards in this individually as well as in a group.

Remarks:
Billboard sets are always culled as a whole group, based on a bounding box which encloses all billboards in the set. For fairly localised sets, this is enough. However, you can optionally tell the set to also cull individual billboards in the set, i.e. to test each individual billboard before rendering. The default is not to do this.

This is useful when you have a large, fairly distributed set of billboards, like maybe trees on a landscape. You probably still want to group them into more than one set (maybe one set per section of landscape), which will be culled coarsely, but you also want to cull the billboards individually because they are spread out. Whilst you could have lots of single-tree sets which are culled separately, this would be inefficient to render because each tree would be issued as it's own rendering operation.

By calling this method with a parameter of true, you can have large billboard sets which are spaced out and so get the benefit of batch rendering and coarse culling, but also have fine-grained culling so unnecessary rendering is avoided.

Parameters:
cullIndividual  If true, each billboard is tested before being sent to the pipeline as well as the whole set having to pass the coarse group bounding test.

Definition at line 807 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mCullIndividual.

void Ogre::BillboardSet::setDefaultDimensions Real    width,
Real    height
[virtual, inherited]
 

Sets the default dimensions of the billboards in this set.

Remarks:
All billboards in a set are created with these default dimensions. The set will render most efficiently if all the billboards in the set are the default size. It is possible to alter the size of individual billboards at the expense of extra calculation. See the Billboard class for more info.
Parameters:
width  The new default width for the billboards in this set.
height  The new default height for the billboards in this set.

Definition at line 219 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mDefaultHeight, Ogre::BillboardSet::mDefaultWidth, and Ogre::Real.

Referenced by Ogre::BillboardSet::BillboardSet(), and ParticleSystem().

void Ogre::BillboardSet::setDefaultHeight Real    height [virtual, inherited]
 

See setDefaultDimensions - this sets 1 component individually.

Definition at line 235 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mDefaultHeight, and Ogre::Real.

void Ogre::BillboardSet::setDefaultWidth Real    width [virtual, inherited]
 

See setDefaultDimensions - this sets 1 component individually.

Definition at line 225 of file OgreBillboardSet.cpp.

References Ogre::BillboardSet::mDefaultWidth, and Ogre::Real.

void Ogre::BillboardSet::setMaterialName const String   name [virtual, inherited]
 

Sets the name of the material to be used for this billboard set.

Parameters:
name  The new name of the material to use for this set.

Definition at line 245 of file OgreBillboardSet.cpp.

References Except, Ogre::Material::load(), Ogre::BillboardSet::mMaterialName, and Ogre::BillboardSet::mpMaterial.

Referenced by Ogre::BillboardSet::BillboardSet(), operator=(), and ParticleSystem().

bool Ogre::StringInterface::setParameter const String   name,
const String   value
[virtual, inherited]
 

Generic parameter setting method.

Remarks:
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters:
name  The name of the parameter to set
value  String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns:
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Definition at line 33 of file OgreStringInterface.cpp.

References Ogre::ParamCommand::doSet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::StringInterface::getParamDictionary().

Referenced by Ogre::StringInterface::copyParametersTo(), Ogre::Profiler::createContainer(), Ogre::Profiler::createTextArea(), Ogre::MaterialSerializer::finishProgramDefinition(), Ogre::ParticleSystemManager::parseAffectorAttrib(), Ogre::ParticleSystemManager::parseAttrib(), Ogre::OverlayManager::parseElementAttrib(), and Ogre::ParticleSystemManager::parseEmitterAttrib().

void Ogre::ParticleSystem::setParticleQuota unsigned int    quota
 

Sets the maximum number of particles this system is allowed to have active at once.

Remarks:
Particle systems all have a particle quota, i.e. a maximum number of particles they are allowed to have active at a time. This allows the application to set a keep particle systems under control should they be affected by complex parameters which alter their emission rates etc. If a particle system reaches it's particle quota, none of the emitters will be able to emit any more particles. As existing particles die, the spare capacity will be allocated equally across all emitters to be as consistent to the origina particle system style as possible.
Parameters:
quota  The maximum number of particles this system is allowed to have.

Definition at line 216 of file OgreParticleSystem.cpp.

References Ogre::BillboardSet::setPoolSize().

Referenced by Ogre::ParticleSystemManager::createSystem().

void Ogre::BillboardSet::setPoolSize unsigned int    size [virtual, inherited]
 

Adjusts the size of the pool of billboards available in this set.

Remarks:
See the BillboardSet::setAutoextend method for full details of the billboard pool. This method adjusts the preallocated size of the pool. If you try to reduce the size of the pool, the set has the option of ignoring you if too many billboards are already in use. Bear in mind that calling this method will incur significant construction / destruction calls so should be avoided in time-critical code. The same goes for auto-extension, try to avoid it by estimating the pool size correctly up-front.
Parameters:
size  The new size for the pool.

Definition at line 579 of file OgreBillboardSet.cpp.

References Ogre::VertexDeclaration::addElement(), COLOUR_BINDING, Ogre::VertexBufferBinding::getBuffer(), Ogre::VertexDeclaration::getVertexSize(), Ogre::BillboardSet::increasePool(), Ogre::IndexData::indexBuffer, Ogre::IndexData::indexCount, Ogre::IndexData::indexStart, Ogre::BillboardSet::mBillboardPool, Ogre::BillboardSet::mFreeBillboards, Ogre::BillboardSet::mIndexData, Ogre::BillboardSet::mVertexData, POSITION_BINDING, Ogre::Real, Ogre::VertexBufferBinding::setBinding(), TEXCOORD_BINDING, Ogre::ushort, Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::VertexData::vertexDeclaration, Ogre::VertexData::vertexStart, Ogre::VES_DIFFUSE, Ogre::VES_POSITION, Ogre::VES_TEXTURE_COORDINATES, Ogre::VET_COLOUR, Ogre::VET_FLOAT2, and Ogre::VET_FLOAT3.

Referenced by Ogre::BillboardSet::BillboardSet(), Ogre::BillboardSet::createBillboard(), operator=(), ParticleSystem(), and setParticleQuota().

virtual void Ogre::MovableObject::setQueryFlags unsigned long    flags [virtual, inherited]
 

Sets the query flags for this object.

Remarks:
When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

Definition at line 164 of file OgreMovableObject.h.

void Ogre::MovableObject::setRenderQueueGroup RenderQueueGroupID    queueID [virtual, inherited]
 

Sets the render queue group this entity will be rendered through.

Remarks:
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to RENDER_QUEUE_MAIN which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

See RenderQueue for more details.

Parameters:
queueID  Enumerated value of the queue group to use.

Definition at line 82 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mRenderQueueID, and Ogre::RenderQueueGroupID.

virtual void Ogre::MovableObject::setUserObject UserDefinedObject   obj [virtual, inherited]
 

Call this to associate your own custom user object instance with this MovableObject.

Remarks:
By simply making your game / application object a subclass of UserDefinedObject, you can establish a link between an OGRE instance of MovableObject and your own application classes. Call this method to establish the link.

Definition at line 132 of file OgreMovableObject.h.

void Ogre::MovableObject::setVisible bool    visible [virtual, inherited]
 

Tells this object whether to be visible or not, if it has a renderable component.

Reimplemented in Ogre::Light.

Definition at line 71 of file OgreMovableObject.cpp.

References Ogre::MovableObject::mVisible.

virtual bool Ogre::Renderable::useIdentityProjection void    const [virtual, inherited]
 

Returns whether or not to use an 'identity' projection.

Remarks:
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not override this.

Reimplemented in Ogre::GuiElement, and Ogre::BorderRenderable.

Definition at line 108 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::useRenderableViewProjMode().

virtual bool Ogre::Renderable::useIdentityView void    const [virtual, inherited]
 

Returns whether or not to use an 'identity' projection.

Remarks:
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not override this.

Reimplemented in Ogre::GuiElement, and Ogre::BorderRenderable.

Definition at line 118 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::useRenderableViewProjMode().


Member Data Documentation

AxisAlignedBox Ogre::BillboardSet::mAABB [protected, inherited]
 

Bounds of all billboards in this set.

Definition at line 92 of file OgreBillboardSet.h.

Referenced by _updateBounds(), Ogre::BillboardSet::_updateBounds(), and Ogre::BillboardSet::getBoundingBox().

ActiveBillboardList Ogre::BillboardSet::mActiveBillboards [protected, inherited]
 

Active billboard list.

Remarks:
This is a linked list of pointers to billboards in the billboard pool.

This allows very fast instertions and deletions from anywhere in the list to activate / deactivate billboards (required for particle systems etc) as well as resuse of Billboard instances in the pool without construction & destruction which avoids memory thrashing.

Definition at line 129 of file OgreBillboardSet.h.

Referenced by _applyMotion(), _expire(), _getIterator(), Ogre::BillboardSet::_notifyCurrentCamera(), _triggerEmitters(), Ogre::BillboardSet::_updateBounds(), addParticle(), Ogre::BillboardSet::clear(), Ogre::BillboardSet::createBillboard(), Ogre::BillboardSet::getBillboard(), Ogre::BillboardSet::getNumBillboards(), getNumParticles(), and Ogre::BillboardSet::removeBillboard().

ParticleAffectorList Ogre::ParticleSystem::mAffectors [protected]
 

List of particle affectors, ie modifiers of particles.

Definition at line 301 of file OgreParticleSystem.h.

Referenced by _triggerAffectors(), _triggerEmitters(), addAffector(), getAffector(), getNumAffectors(), removeAffector(), and removeAllAffectors().

bool Ogre::BillboardSet::mAllDefaultSize [protected, inherited]
 

True if no billboards in this set have been resized - greater efficiency.

Definition at line 110 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::_notifyBillboardResized(), and ParticleSystem().

bool Ogre::BillboardSet::mAutoExtendPool [protected, inherited]
 

Flag indicating whether to autoextend pool.

Definition at line 113 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::getAutoextend(), ParticleSystem(), and Ogre::BillboardSet::setAutoextend().

BillboardPool Ogre::BillboardSet::mBillboardPool [protected, inherited]
 

Pool of billboard instances for use and reuse in the active billboard list.

Remarks:
This vector will be preallocated with the estimated size of the set,and will extend as required.

Definition at line 144 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::getPoolSize(), increasePool(), Ogre::BillboardSet::increasePool(), Ogre::BillboardSet::setPoolSize(), and Ogre::BillboardSet::~BillboardSet().

BillboardType Ogre::BillboardSet::mBillboardType [protected, inherited]
 

The type of billboard to render.

Definition at line 165 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera(), Ogre::BillboardSet::getBillboardType(), operator=(), and Ogre::BillboardSet::setBillboardType().

Real Ogre::BillboardSet::mBoundingRadius [protected, inherited]
 

Bounding radius.

Definition at line 94 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::_updateBounds(), and Ogre::BillboardSet::getBoundingRadius().

Vector3 Ogre::BillboardSet::mCommonDirection [protected, inherited]
 

Common direction for billboards of type BBT_ORIENTED_COMMON.

Definition at line 168 of file OgreBillboardSet.h.

Referenced by genBillboardAxes(), Ogre::BillboardSet::genBillboardAxes(), Ogre::BillboardSet::getCommonDirection(), operator=(), and Ogre::BillboardSet::setCommonDirection().

bool Ogre::BillboardSet::mCullIndividual [protected, inherited]
 

Flag indicating whether each billboard should be culled separately (default: false).

Definition at line 162 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::billboardVisible(), Ogre::BillboardSet::getCullIndividually(), operator=(), ParticleSystem(), and Ogre::BillboardSet::setCullIndividually().

Real Ogre::BillboardSet::mDefaultHeight [protected, inherited]
 

Default height of each billboard.

Definition at line 102 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera(), Ogre::BillboardSet::_updateBounds(), Ogre::BillboardSet::billboardVisible(), Ogre::BillboardSet::getDefaultHeight(), operator=(), Ogre::BillboardSet::setDefaultDimensions(), and Ogre::BillboardSet::setDefaultHeight().

Real Ogre::BillboardSet::mDefaultWidth [protected, inherited]
 

Default width of each billboard.

Definition at line 100 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera(), Ogre::BillboardSet::_updateBounds(), Ogre::BillboardSet::billboardVisible(), Ogre::BillboardSet::getDefaultWidth(), operator=(), Ogre::BillboardSet::setDefaultDimensions(), and Ogre::BillboardSet::setDefaultWidth().

ParticleEmitterList Ogre::ParticleSystem::mEmitters [protected]
 

List of particle emitters, ie sources of particles.

Definition at line 299 of file OgreParticleSystem.h.

Referenced by _triggerEmitters(), addEmitter(), getEmitter(), getNumEmitters(), removeAllEmitters(), and removeEmitter().

bool Ogre::BillboardSet::mFixedTextureCoords [protected, inherited]
 

Definition at line 115 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera(), and Ogre::BillboardSet::genVertices().

FreeBillboardQueue Ogre::BillboardSet::mFreeBillboards [protected, inherited]
 

Free billboard queue.

Remarks:
This contains a list of the billboards free for use as new instances as required by the set. Billboard instances are preconstructed up to the estimated size in the mBillboardPool vector and are referenced on this deque at startup. As they get used this deque reduces, as they get released back to to the set they get added back to the deque.

Definition at line 138 of file OgreBillboardSet.h.

Referenced by _expire(), addParticle(), Ogre::BillboardSet::createBillboard(), Ogre::BillboardSet::removeBillboard(), and Ogre::BillboardSet::setPoolSize().

IndexData* Ogre::BillboardSet::mIndexData [protected, inherited]
 

The vertex index data for all billboards in this set (1 set only).

Definition at line 159 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::getRenderOperation(), ParticleSystem(), Ogre::BillboardSet::setPoolSize(), and Ogre::BillboardSet::~BillboardSet().

String Ogre::BillboardSet::mMaterialName [protected, inherited]
 

Name of the material to use.

Definition at line 105 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::getMaterialName(), operator=(), and Ogre::BillboardSet::setMaterialName().

String Ogre::ParticleSystem::mName [protected]
 

Name of the particle system instance.

Reimplemented from Ogre::BillboardSet.

Definition at line 293 of file OgreParticleSystem.h.

Referenced by getName(), and ParticleSystem().

unsigned short Ogre::BillboardSet::mNumVisibleBillboards [protected, inherited]
 

Definition at line 174 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera(), and Ogre::BillboardSet::getRenderOperation().

BillboardOrigin Ogre::BillboardSet::mOriginType [protected, inherited]
 

Origin of each billboard.

Definition at line 97 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::getBillboardOrigin(), operator=(), ParticleSystem(), and Ogre::BillboardSet::setBillboardOrigin().

String Ogre::StringInterface::mParamDictName [protected, inherited]
 

Class name for this instance to be used as a lookup (must be initialised by subclasses).

Definition at line 157 of file OgreStringInterface.h.

bool Ogre::MovableObject::mParentIsTagPoint [protected, inherited]
 

Definition at line 48 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::_notifyAttached(), Ogre::MovableObject::MovableObject(), and Ogre::MovableObject::~MovableObject().

Node* Ogre::MovableObject::mParentNode [protected, inherited]
 

node to which this object is attached

Definition at line 47 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::_getParentNodeFullTransform(), Ogre::MovableObject::_notifyAttached(), Ogre::Entity::_notifyCurrentCamera(), _triggerEmitters(), _updateBounds(), Ogre::BillboardSet::_updateBounds(), Ogre::Camera::Camera(), Ogre::Frustum::Frustum(), Ogre::BillboardSet::genBillboardAxes(), Ogre::Entity::getBoundingBox(), Ogre::Entity::getBoundingRadius(), Ogre::TerrainRenderable::getLights(), Ogre::SimpleRenderable::getLights(), Ogre::BillboardSet::getLights(), Ogre::MovableObject::getParentNode(), Ogre::Frustum::getSquaredViewDepth(), Ogre::BillboardSet::getSquaredViewDepth(), Ogre::MovableObject::getWorldBoundingSphere(), Ogre::TerrainRenderable::getWorldOrientation(), Ogre::SubEntity::getWorldOrientation(), Ogre::SimpleRenderable::getWorldOrientation(), getWorldOrientation(), Ogre::Frustum::getWorldOrientation(), Ogre::BillboardSet::getWorldOrientation(), Ogre::TerrainRenderable::getWorldPosition(), Ogre::SubEntity::getWorldPosition(), Ogre::SimpleRenderable::getWorldPosition(), getWorldPosition(), Ogre::Frustum::getWorldPosition(), Ogre::BillboardSet::getWorldPosition(), Ogre::TerrainRenderable::getWorldTransforms(), Ogre::SimpleRenderable::getWorldTransforms(), Ogre::Frustum::getWorldTransforms(), Ogre::MovableObject::isAttached(), Ogre::Frustum::isViewOutOfDate(), Ogre::Camera::isViewOutOfDate(), Ogre::Light::Light(), Ogre::MovableObject::MovableObject(), Ogre::SimpleRenderable::SimpleRenderable(), Ogre::Light::update(), and Ogre::MovableObject::~MovableObject().

Material* Ogre::BillboardSet::mpMaterial [protected, inherited]
 

Pointer to the material to use.

Definition at line 107 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::getMaterial(), and Ogre::BillboardSet::setMaterialName().

unsigned long Ogre::MovableObject::mQueryFlags [protected, inherited]
 

Flags determining whether this object is included / excluded from scene queries.

Definition at line 56 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::MovableObject().

RenderQueueGroupID Ogre::MovableObject::mRenderQueueID [protected, inherited]
 

The render queue to use when rendering this object.

Definition at line 54 of file OgreMovableObject.h.

Referenced by Ogre::Entity::_updateRenderQueue(), Ogre::BillboardSet::_updateRenderQueue(), Ogre::MovableObject::getRenderQueueGroup(), Ogre::MovableObject::MovableObject(), and Ogre::MovableObject::setRenderQueueGroup().

ParticleSystem::CmdBillboardType Ogre::ParticleSystem::msBillboardTypeCmd [static, protected]
 

Definition at line 49 of file OgreParticleSystem.cpp.

Referenced by initParameters().

ParticleSystem::CmdCommonDirection Ogre::ParticleSystem::msCommonDirectionCmd [static, protected]
 

Definition at line 50 of file OgreParticleSystem.cpp.

Referenced by initParameters().

ParticleSystem::CmdCull Ogre::ParticleSystem::msCullCmd [static, protected]
 

Command objects.

Definition at line 44 of file OgreParticleSystem.cpp.

Referenced by initParameters().

ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited]
 

Dictionary of parameters.

Definition at line 30 of file OgreStringInterface.cpp.

ParticleSystem::CmdHeight Ogre::ParticleSystem::msHeightCmd [static, protected]
 

Definition at line 45 of file OgreParticleSystem.cpp.

Referenced by initParameters().

ParticleSystem::CmdMaterial Ogre::ParticleSystem::msMaterialCmd [static, protected]
 

Definition at line 46 of file OgreParticleSystem.cpp.

Referenced by initParameters().

String Ogre::BillboardSet::msMovableType = "BillboardSet" [static, protected, inherited]
 

Shared class-level name for Movable type.

Definition at line 44 of file OgreBillboardSet.cpp.

Referenced by Ogre::BillboardSet::getMovableType().

ParticleSystem::CmdQuota Ogre::ParticleSystem::msQuotaCmd [static, protected]
 

Definition at line 47 of file OgreParticleSystem.cpp.

Referenced by initParameters().

ParticleSystem::CmdWidth Ogre::ParticleSystem::msWidthCmd [static, protected]
 

Definition at line 48 of file OgreParticleSystem.cpp.

Referenced by initParameters().

UserDefinedObject* Ogre::MovableObject::mUserObject [protected, inherited]
 

User defined object which is linked to this object.

Definition at line 52 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::MovableObject().

VertexData* Ogre::BillboardSet::mVertexData [protected, inherited]
 

The vertex position data for all billboards in this set.

Definition at line 149 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardSet::_notifyCurrentCamera(), Ogre::BillboardSet::getRenderOperation(), ParticleSystem(), Ogre::BillboardSet::setPoolSize(), and Ogre::BillboardSet::~BillboardSet().

bool Ogre::MovableObject::mVisible [protected, inherited]
 

Is this object visible?

Definition at line 50 of file OgreMovableObject.h.

Referenced by Ogre::Frustum::Frustum(), Ogre::MovableObject::isVisible(), Ogre::MovableObject::MovableObject(), and Ogre::MovableObject::setVisible().

AxisAlignedBox Ogre::MovableObject::mWorldAABB [protected, inherited]
 

Cached world AABB of this object.

Definition at line 58 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::getWorldBoundingBox(), and Ogre::MovableObject::MovableObject().

Sphere Ogre::MovableObject::mWorldBoundingSphere [protected, inherited]
 

Definition at line 60 of file OgreMovableObject.h.

Referenced by Ogre::MovableObject::getWorldBoundingSphere().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:18:59 2004