Subclass of BillboardChain which automatically leaves a trail behind one or more Node instances. More...

#include <OgreRibbonTrail.h>

Inheritance diagram for Ogre::RibbonTrail:

Collaboration diagram for Ogre::RibbonTrail:

Public Types
typedef vector< Element >::type	ElementList

typedef ConstVectorIterator < NodeList >	NodeIterator

typedef vector< Node * >::type	NodeList

typedef vector < ShadowRenderable * >::type	ShadowRenderableList

typedef VectorIterator < ShadowRenderableList >	ShadowRenderableListIterator

enum	TexCoordDirection { TCD_U, TCD_V }
	The direction in which texture coordinates from elements of the chain are used. More...

Public Member Functions
	RibbonTrail (const String &name, size_t maxElements=20, size_t numberOfChains=1, bool useTextureCoords=true, bool useVertexColours=true)
	Constructor (don't use directly, use factory) More...

virtual	~RibbonTrail ()
	destructor More...

virtual MovableObjectFactory *	_getCreator (void) const
	Get the creator of this object, if any (internal use only) More...

virtual LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object. More...

virtual SceneManager *	_getManager (void) const
	Get the manager of this object, if any (internal use only) More...

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

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

virtual void	_notifyCreator (MovableObjectFactory *fact)
	Notify the object of it's creator (internal use only) More...

virtual void	_notifyCurrentCamera (Camera *cam)
	Internal method to notify the object of the camera to be used for the next rendering operation. More...

virtual void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only) More...

virtual void	_notifyMoved (void)
	Internal method called to notify the object that it has been moved. More...

virtual void	_timeUpdate (Real time)
	Perform any fading / width delta required; internal method. More...

virtual void	_updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
	Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More...

void	_updateRenderQueue (RenderQueue *)
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...

virtual void	addChainElement (size_t chainIndex, const Element &billboardChainElement)
	Add an element to the 'head' of a chain. More...

virtual void	addNode (Node *n)
	Add a node to be tracked. More...

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

virtual void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...

virtual void	clearAllChains (void)
	Remove all elements from all chains (but leave the chains themselves intact). More...

void	clearChain (size_t chainIndex)
	Remove all elements of a given chain (but leave the chain intact). More...

virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value. More...

virtual void	detachFromParent (void)
	Detaches an object from a parent SceneNode or TagPoint, if attached. More...

const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object. More...

const AxisAlignedBox &	getBoundingBox (void) const
	Retrieves the local axis-aligned bounding box for this object. More...

Real	getBoundingRadius (void) const
	Retrieves the radius of the origin-centered bounding sphere for this object. More...

bool	getCastShadows (void) const
	Returns whether shadow casting is enabled for this object. More...

virtual bool	getCastsShadows (void) const
	Method which reports whether this renderable would normally cast a shadow. More...

virtual const Element &	getChainElement (size_t chainIndex, size_t elementIndex) const
	Get the detail of a chain element. More...

virtual size_t	getChainIndexForNode (const Node *n)
	Get the chain index for a given Node being tracked. More...

virtual const ColourValue &	getColourChange (size_t chainIndex) const
	Get the per-second fading amount. More...

const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index. More...

const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
	Overridden member from ShadowCaster. More...

virtual bool	getDynamic (void) const
	Gets whether or not the buffers created for this object are suitable for dynamic alteration. More...

EdgeData *	getEdgeList (void)
	Define a default implementation of method from ShadowCaster which implements no shadows. More...

virtual const ColourValue &	getInitialColour (size_t chainIndex) const
	Get the starting ribbon colour. More...

virtual Real	getInitialWidth (size_t chainIndex) const
	Get the starting ribbon width in world units. More...

const AxisAlignedBox &	getLightCapBounds (void) const
	Overridden member from ShadowCaster. More...

virtual uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object. More...

const LightList &	getLights (void) const
	Gets a list of lights, ordered relative to how close they are to this renderable. More...

virtual Listener *	getListener (void) const
	Gets the current listener for this object. More...

const MaterialPtr &	getMaterial (void) const
	Retrieves a weak reference to the material this renderable object uses. More...

virtual const String &	getMaterialName (void) const
	Get the material name in use. More...

virtual size_t	getMaxChainElements (void) const
	Get the maximum number of chain elements per chain. More...

const String &	getMovableType (void) const
	Overridden from MovableObject. More...

virtual const String &	getName (void) const
	Returns the name of this object. More...

virtual NodeIterator	getNodeIterator (void) const
	Get an iterator over the nodes which are being tracked. More...

virtual size_t	getNumberOfChains (void) const
	Get the number of chain segments (this class can render multiple chains at once using the same material). More...

virtual size_t	getNumChainElements (size_t chainIndex) const
	Returns the number of chain elements. More...

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

virtual const Real *	getOtherTextureCoordRange (void) const
	Get the range of the texture coordinates generated across the width of the chain elements. More...

virtual Node *	getParentNode (void) const
	Returns the node to which this object is attached. More...

virtual SceneNode *	getParentSceneNode (void) const
	Returns the scene node to which this object is attached. More...

Real	getPointExtrusionDistance (const Light *l) const
	Get the distance to extrude for a point/spot light. More...

virtual bool	getPolygonModeOverrideable (void) const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...

virtual uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object. More...

bool	getReceivesShadows ()
	Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...

virtual Real	getRenderingDistance (void) const
	Gets the distance at which batches are no longer rendered. More...

virtual Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...

void	getRenderOperation (RenderOperation &)
	Gets the render operation required to send this object to the frame buffer. More...

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

virtual RenderSystemData *	getRenderSystemData () const
	Gets RenderSystem private data. More...

ShadowRenderableListIterator	getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light light, HardwareIndexBufferSharedPtr indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
	Define a default implementation of method from ShadowCaster which implements no shadows. More...

Real	getSquaredViewDepth (const Camera *cam) const
	Returns the camera-relative squared depth of this renderable. More...

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

virtual TexCoordDirection	getTextureCoordDirection (void)
	Gets the direction in which texture coords specified on each element are deemed to run. More...

virtual Real	getTrailLength (void) const
	Get the length of the trail. More...

virtual uint32	getTypeFlags (void) const
	Get the 'type flags' for this MovableObject. More...

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

bool	getUseIdentityView (void) const
	Returns whether or not to use an 'identity' view. More...

virtual OGRE_DEPRECATED const Any &	getUserAny (void) const

virtual OGRE_DEPRECATED const Any &	getUserAny (void) const

UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class. More...

const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class. More...

UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class. More...

const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class. More...

virtual bool	getUseTextureCoords (void) const
	Gets whether texture coordinate information should be included in the final buffers generated. More...

virtual bool	getUseVertexColours (void) const
	Gets whether vertex colour information should be included in the final buffers generated. More...

virtual uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object. More...

virtual bool	getVisible (void) const
	Gets this object whether to be visible or not, if it has a renderable component. More...

virtual Real	getWidthChange (size_t chainIndex) const
	Get the change in ribbon width per second. More...

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

virtual const Sphere &	getWorldBoundingSphere (bool derive=false) const
	Retrieves the worldspace bounding sphere for this object. More...

void	getWorldTransforms (Matrix4 *) const
	Gets the world transform matrix / matrices for this renderable object. More...

bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index. More...

bool	hasEdgeList (void)
	Define a default implementation of method from ShadowCaster which implements no shadows. More...

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

virtual bool	isDebugDisplayEnabled (void) const
	Gets whether debug display of this object is enabled. More...

virtual bool	isInScene (void) const
	Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More...

virtual bool	isParentTagPoint () const
	Gets whether the parent node is a TagPoint (or a SceneNode) More...

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

virtual void	nodeAttached (const Node *)
	Node has been attached to a parent. More...

void	nodeDestroyed (const Node *node)

virtual void	nodeDetached (const Node *)
	Node has been detached from a parent. More...

void	nodeUpdated (const Node *node)

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)

virtual void	postRender (SceneManager sm, RenderSystem rsys)
	Called immediately after the Renderable has been rendered. More...

virtual bool	preRender (SceneManager sm, RenderSystem rsys)
	Called just prior to the Renderable being rendered. More...

virtual const LightList &	queryLights (void) const
	Gets a list of lights, ordered relative to how close they are to this movable object. More...

virtual void	removeChainElement (size_t chainIndex)
	Remove an element from the 'tail' of a chain. More...

void	removeCustomParameter (size_t index)
	Removes a custom value which is associated with this Renderable at the given index. More...

virtual void	removeNode (Node *n)
	Remove tracking on a given node. More...

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

virtual void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...

void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows. More...

virtual void	setColourChange (size_t chainIndex, const ColourValue &valuePerSecond)
	Enables / disables fading the trail using colour. More...

virtual void	setColourChange (size_t chainIndex, Real r, Real g, Real b, Real a)
	Enables / disables fading the trail using colour. More...

void	setCustomParameter (size_t index, const Vector4 &value)
	Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...

virtual void	setDebugDisplayEnabled (bool enabled)
	Sets whether or not the debug display of this object is enabled. More...

virtual void	setDynamic (bool dyn)
	Sets whether or not the buffers created for this object are suitable for dynamic alteration. More...

void	setFaceCamera (bool faceCamera, const Vector3 &normalVector=Vector3::UNIT_X)
	Sets whether the billboard should always be facing the camera or a custom direction set by each point element. More...

virtual void	setInitialColour (size_t chainIndex, const ColourValue &col)
	Set the starting ribbon colour for a given segment. More...

virtual void	setInitialColour (size_t chainIndex, Real r, Real g, Real b, Real a=1.0)
	Set the starting ribbon colour. More...

virtual void	setInitialWidth (size_t chainIndex, Real width)
	Set the starting ribbon width in world units. More...

virtual void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object. More...

virtual void	setListener (Listener *listener)
	Sets a listener for this object. More...

virtual void	setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Set the material name to use for rendering. More...

void	setMaxChainElements (size_t maxElements)
	Set the maximum number of chain elements per chain. More...

void	setNumberOfChains (size_t numChains)
	Set the number of chain segments (this class can render multiple chains at once using the same material). More...

virtual void	setOtherTextureCoordRange (Real start, Real end)
	Set the range of the texture coordinates generated across the width of the chain elements. More...

virtual void	setPolygonModeOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...

virtual void	setQueryFlags (uint32 flags)
	Sets the query flags for this object. More...

virtual void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered. More...

virtual void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...

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

virtual void	setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
	Sets the render queue group and group priority this entity will be rendered through. More...

virtual void	setRenderSystemData (RenderSystemData *val) const
	Sets RenderSystem private data. More...

virtual void	setTextureCoordDirection (TexCoordDirection dir)
	Sets the direction in which texture coords specified on each element are deemed to run along the length of the chain. More...

virtual void	setTrailLength (Real len)
	Set the length of the trail. More...

void	setUseIdentityProjection (bool useIdentityProjection)
	Sets whether or not to use an 'identity' projection. More...

void	setUseIdentityView (bool useIdentityView)
	Sets whether or not to use an 'identity' view. More...

virtual OGRE_DEPRECATED void	setUserAny (const Any &anything)

virtual OGRE_DEPRECATED void	setUserAny (const Any &anything)

virtual void	setUseTextureCoords (bool use)
	Sets whether texture coordinate information should be included in the final buffers generated. More...

virtual void	setUseVertexColours (bool use)
	Sets whether vertex colour information should be included in the final buffers generated. More...

virtual void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object. More...

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

virtual void	setWidthChange (size_t chainIndex, Real widthDeltaPerSecond)
	Set the change in ribbon width per second. More...

virtual void	updateChainElement (size_t chainIndex, size_t elementIndex, const Element &billboardChainElement)
	Update the details of an existing chain element. More...

void	visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
	Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...

Static Public Member Functions
static void	extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
	Utility method for extruding vertices based on a light. More...

static uint32	getDefaultQueryFlags ()
	Get the default query flags for all future MovableObject instances. More...

static uint32	getDefaultVisibilityFlags ()
	Get the default visibility flags for all future MovableObject instances. More...

static void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances. More...

static void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances. More...

Protected Types
typedef map< String, StringVector >::type	AnimableDictionaryMap

typedef vector< ChainSegment > ::type	ChainSegmentList

typedef vector< ColourValue >::type	ColourValueList

typedef map< size_t, Vector4 > ::type	CustomParameterMap

typedef vector< size_t >::type	IndexVector
	Mapping of nodes to chain segments. More...

typedef map< const Node *, size_t >::type	NodeToChainSegmentMap

typedef vector< Real >::type	RealList

Protected Member Functions
StringVector &	_getAnimableValueNames (void)
	Get an updateable reference to animable value list. More...

void	createAnimableDictionary (void) const
	Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More...

virtual void	extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
	Utility method for extruding a bounding box. More...

virtual void	generateShadowVolume (EdgeData edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, size_t &indexBufferUsedSize, const Light light, ShadowRenderableList &shadowRenderables, unsigned long flags)
	Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it. More...

virtual const String &	getAnimableDictionaryName (void) const
	Get the name of the animable dictionary for this class. More...

Real	getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
	Helper method for calculating extrusion distance. More...

virtual void	initialiseAnimableDictionary (StringVector &) const
	Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...

virtual void	manageController (void)
	Manage updates to the time controller. More...

virtual void	resetAllTrails (void)
	Reset all tracked chains to initial state. More...

virtual void	resetTrail (size_t index, const Node *node)
	Reset the tracked chain to initial state. More...

virtual void	setupBuffers (void)
	Setup buffers. More...

virtual void	setupChainContainers (void)
	Setup the STL collections. More...

virtual void	setupVertexDeclaration (void)
	Setup vertex declaration. More...

virtual void	updateBoundingBox (void) const

virtual void	updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)
	Tells the caster to perform the tasks necessary to update the edge data's light listing. More...

virtual void	updateIndexBuffer (void)
	Update the contents of the index buffer. More...

virtual void	updateTrail (size_t index, const Node *node)
	Node has changed position, update. More...

virtual void	updateVertexBuffer (Camera *cam)
	Update the contents of the vertex buffer. More...

Protected Attributes
AxisAlignedBox	mAABB
	AABB. More...

bool	mBeyondFarDistance
	Hidden because of distance? More...

bool	mBoundsDirty
	Do the bounds need redefining? More...

bool	mBuffersNeedRecreating
	Do the buffers need recreating? More...

bool	mCastShadows
	Does this object cast shadows? More...

size_t	mChainCount
	Number of chains. More...

ElementList	mChainElementList
	The list holding the chain elements. More...

ChainSegmentList	mChainSegmentList

MovableObjectFactory *	mCreator
	Creator of this object (if created by a factory) More...

CustomParameterMap	mCustomParameters

bool	mDebugDisplay
	Is debug display enabled? More...

ColourValueList	mDeltaColour
	fade amount per second More...

RealList	mDeltaWidth
	Delta width of the ribbon. More...

bool	mDynamic
	Dynamic use? More...

Real	mElemLength
	length of each element More...

bool	mFaceCamera
	When true, the billboards always face the camera. More...

Controller< Real > *	mFadeController
	controller used to hook up frame time to fader More...

IndexVector	mFreeChains

bool	mIndexContentDirty
	Is the index buffer dirty? More...

IndexData *	mIndexData
	Index data (to allow multiple unconnected chains) More...

ColourValueList	mInitialColour
	Initial colour of the ribbon. More...

RealList	mInitialWidth
	Initial width of the ribbon. More...

LightList	mLightList
	List of lights for this object. More...

ulong	mLightListUpdated
	The last frame that this light list was updated in. More...

uint32	mLightMask
	the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More...

Listener *	mListener
	MovableObject listener - only one allowed (no list) for size & performance reasons. */. More...

SceneManager *	mManager
	SceneManager holding this object (if applicable) More...

MaterialPtr	mMaterial

String	mMaterialName
	Material. More...

size_t	mMaxElementsPerChain
	Maximum length of each chain. More...

Real	mMinPixelSize

String	mName
	Name of this object. More...

NodeList	mNodeList
	List of nodes being trailed. More...

IndexVector	mNodeToChainSegment
	Ordered like mNodeList, contains chain index. More...

NodeToChainSegmentMap	mNodeToSegMap

Vector3	mNormalBase
	Used when mFaceCamera == false; determines the billboard's "normal". More...

Real	mOtherTexCoordRange [2]
	Other texture coord range. More...

bool	mParentIsTagPoint

Node *	mParentNode
	node to which this object is attached More...

bool	mPolygonModeOverrideable

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

Real	mRadius
	Bounding radius. More...

bool	mRenderingDisabled
	Does rendering this object disabled by listener? More...

uint8	mRenderQueueID
	The render queue to use when rendering this object. More...

bool	mRenderQueueIDSet
	Flags whether the RenderQueue's default should be used. More...

ushort	mRenderQueuePriority
	The render queue group to use when rendering this object. More...

bool	mRenderQueuePrioritySet
	Flags whether the RenderQueue's default should be used. More...

RenderSystemData *	mRenderSystemData
	User objects binding. More...

Real	mSquaredElemLength
	Squared length of each element. More...

Real	mSquaredUpperDistance

TexCoordDirection	mTexCoordDir
	Texture coord direction. More...

ControllerValueRealPtr	mTimeControllerValue
	controller value for hooking up frame time to fader More...

Real	mTrailLength
	Total length of trail in world units. More...

Real	mUpperDistance
	Upper distance to still render. More...

bool	mUseIdentityProjection

bool	mUseIdentityView

UserObjectBindings	mUserObjectBindings
	User objects binding. More...

UserObjectBindings	mUserObjectBindings

bool	mUseTexCoords
	Use texture coords? More...

bool	mUseVertexColour
	Use vertex colour? More...

Camera *	mVertexCameraUsed
	Camera last used to build the vertex buffer. More...

bool	mVertexContentDirty
	Is the vertex buffer dirty? More...

VertexData *	mVertexData
	Vertex data. More...

bool	mVertexDeclDirty
	Is the vertex declaration dirty? More...

uint32	mVisibilityFlags
	Flags determining whether this object is visible (compared to SceneManager mask) More...

bool	mVisible
	Is this object visible? More...

AxisAlignedBox	mWorldAABB
	Cached world AABB of this object. More...

Sphere	mWorldBoundingSphere

AxisAlignedBox	mWorldDarkCapBounds
	World space AABB of this object's dark cap. More...

Static Protected Attributes
static AnimableDictionaryMap	msAnimableDictionary
	Static map of class name to list of animable value names. More...

static uint32	msDefaultQueryFlags
	Default query flags. More...

static uint32	msDefaultVisibilityFlags
	Default visibility flags. More...

static const size_t	SEGMENT_EMPTY
	Chain segment has no elements. More...

Detailed Description

Subclass of BillboardChain which automatically leaves a trail behind one or more Node instances.

Remarks: An instance of this class will watch one or more Node instances, and automatically generate a trail behind them as they move. Because this class can monitor multiple modes, it generates its own geometry in world space and thus, even though it has to be attached to a SceneNode to be visible, changing the position of the scene node it is attached to makes no difference to the geometry rendered.

: The 'head' element grows smoothly in size until it reaches the required size, then a new element is added. If the segment is full, the tail element shrinks by the same proportion as the head grows before disappearing.

: Elements can be faded out on a time basis, either by altering their colour or altering their alpha. The width can also alter over time.

: 'v' texture coordinates are fixed at 0.0 if used, meaning that you can use a 1D texture to 'smear' a colour pattern along the ribbon if you wish. The 'u' coordinates are by default (0.0, 1.0), but you can alter this using setOtherTexCoordRange if you wish.

Definition at line 71 of file OgreRibbonTrail.h.

Member Typedef Documentation

typedef map<String, StringVector>::type Ogre::AnimableObject::AnimableDictionaryMap

protectedinherited

Definition at line 241 of file OgreAnimable.h.

typedef vector<ChainSegment>::type Ogre::BillboardChain::ChainSegmentList

protectedinherited

Definition at line 345 of file OgreBillboardChain.h.

typedef vector<ColourValue>::type Ogre::RibbonTrail::ColourValueList

protected

Definition at line 199 of file OgreRibbonTrail.h.

typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap

protectedinherited

Definition at line 414 of file OgreRenderable.h.

typedef vector<Element>::type Ogre::BillboardChain::ElementList

inherited

Definition at line 106 of file OgreBillboardChain.h.

typedef vector<size_t>::type Ogre::RibbonTrail::IndexVector

protected

Mapping of nodes to chain segments.

Definition at line 182 of file OgreRibbonTrail.h.

typedef ConstVectorIterator<NodeList> Ogre::RibbonTrail::NodeIterator

Definition at line 89 of file OgreRibbonTrail.h.

typedef vector<Node*>::type Ogre::RibbonTrail::NodeList

Definition at line 88 of file OgreRibbonTrail.h.

typedef map<const Node*, size_t>::type Ogre::RibbonTrail::NodeToChainSegmentMap

protected

Definition at line 190 of file OgreRibbonTrail.h.

typedef vector<Real>::type Ogre::RibbonTrail::RealList

protected

Definition at line 200 of file OgreRibbonTrail.h.

typedef vector<ShadowRenderable*>::type Ogre::ShadowCaster::ShadowRenderableList

inherited

Definition at line 136 of file OgreShadowCaster.h.

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator

inherited

Definition at line 137 of file OgreShadowCaster.h.

Member Enumeration Documentation

enum Ogre::BillboardChain::TexCoordDirection

inherited

The direction in which texture coordinates from elements of the chain are used.

Enumerator
TCD_U	Tex coord in elements is treated as the 'u' texture coordinate.
TCD_V	Tex coord in elements is treated as the 'v' texture coordinate.

Definition at line 151 of file OgreBillboardChain.h.

Constructor & Destructor Documentation

Ogre::RibbonTrail::RibbonTrail	(	const String &	name,
		size_t	maxElements = `20`,
		size_t	numberOfChains = `1`,
		bool	useTextureCoords = `true`,
		bool	useVertexColours = `true`
	)

Constructor (don't use directly, use factory)

Parameters

name	The name to give this object
maxElements	The maximum number of elements per chain
numberOfChains	The number of separate chain segments contained in this object, ie the maximum number of nodes that can have trails attached
useTextureCoords	If true, use texture coordinates from the chain elements
useVertexColours	If true, use vertex colours from the chain elements (must be true if you intend to use fading)

virtual Ogre::RibbonTrail::~RibbonTrail ( )

virtual

destructor

Member Function Documentation

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void )

inlineprotectedinherited

Get an updateable reference to animable value list.

Definition at line 267 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

virtual MovableObjectFactory* Ogre::MovableObject::_getCreator ( void ) const

inlinevirtualinherited

Get the creator of this object, if any (internal use only)

Definition at line 186 of file OgreMovableObject.h.

virtual LightList* Ogre::MovableObject::_getLightList ( )

inlinevirtualinherited

Returns a pointer to the current list of lights for this object.

Remarks: You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

Definition at line 491 of file OgreMovableObject.h.

virtual SceneManager* Ogre::MovableObject::_getManager ( void ) const

inlinevirtualinherited

Get the manager of this object, if any (internal use only)

Definition at line 190 of file OgreMovableObject.h.

virtual const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform ( void ) const

virtualinherited

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

Reimplemented in Ogre::InstancedEntity.

virtual void Ogre::MovableObject::_notifyAttached	(	Node *	parent,
		bool	isTagPoint = `false`
	)

virtualinherited

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

Reimplemented in Ogre::Entity, Ogre::ParticleSystem, Ogre::Light, Ogre::PortalBase, and Ogre::InstancedEntity.

Referenced by Ogre::PortalBase::_notifyAttached().

virtual void Ogre::MovableObject::_notifyCreator ( MovableObjectFactory * fact )

inlinevirtualinherited

Notify the object of it's creator (internal use only)

Definition at line 184 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyCurrentCamera ( Camera * cam )

virtualinherited

Internal method to notify the object of the camera to be used for the next rendering operation.

Remarks: Certain objects may want to do specific processing based on the camera position. This method notifies them in case they wish to do this.

Reimplemented in Ogre::BillboardSet, Ogre::InstancedGeometry::BatchInstance, Ogre::Frustum, Ogre::StaticGeometry::Region, Ogre::Entity, Ogre::ParticleSystem, Ogre::InstanceBatch, Ogre::SimpleRenderable, and Ogre::MovablePlane.

virtual void Ogre::MovableObject::_notifyManager ( SceneManager * man )

inlinevirtualinherited

Notify the object of it's manager (internal use only)

Definition at line 188 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyMoved ( void )

virtualinherited

Internal method called to notify the object that it has been moved.

Reimplemented in Ogre::Light, Ogre::PortalBase, Ogre::InstancedEntity, and Ogre::PCZLight.

virtual void Ogre::RibbonTrail::_timeUpdate ( Real time )

virtual

Perform any fading / width delta required; internal method.

virtual void Ogre::Renderable::_updateCustomGpuParameter	(	const GpuProgramParameters::AutoConstantEntry &	constantEntry,
		GpuProgramParameters *	params
	)		const

inlinevirtualinherited

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks: This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.

: You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.

Parameters

constantEntry	The auto constant entry referring to the parameter being updated
params	The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

Definition at line 307 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.

void Ogre::BillboardChain::_updateRenderQueue ( RenderQueue * queue )

virtualinherited

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

Remarks: The engine will call this method when this object is to be rendered. The object must then create one or more Renderable subclass instances which it places on the passed in Queue for rendering.

Implements Ogre::MovableObject.

virtual void Ogre::BillboardChain::addChainElement	(	size_t	chainIndex,
		const Element &	billboardChainElement
	)

virtualinherited

Add an element to the 'head' of a chain.

Remarks: If this causes the number of elements to exceed the maximum elements per chain, the last element in the chain (the 'tail') will be removed to allow the additional element to be added.

Parameters

chainIndex	The index of the chain
billboardChainElement	The details to add

virtual void Ogre::RibbonTrail::addNode ( Node * n )

virtual

Add a node to be tracked.

Parameters

n	The node that will be tracked.

virtual void Ogre::MovableObject::addQueryFlags ( uint32 flags )

inlinevirtualinherited

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

Definition at line 396 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::addVisibilityFlags ( uint32 flags )

inlinevirtualinherited

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

Definition at line 424 of file OgreMovableObject.h.

virtual void Ogre::BillboardChain::clearAllChains ( void )

virtualinherited

Remove all elements from all chains (but leave the chains themselves intact).

void Ogre::RibbonTrail::clearChain ( size_t chainIndex )

virtual

Remove all elements of a given chain (but leave the chain intact).

Reimplemented from Ogre::BillboardChain.

void Ogre::AnimableObject::createAnimableDictionary ( void ) const

inlineprotectedinherited

Internal method for creating a dictionary of animable value names for the class, if it does not already exist.

Definition at line 254 of file OgreAnimable.h.

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String & valueName )

inlinevirtualinherited

Create a reference-counted AnimableValuePtr for the named value.

Remarks: You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 320 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

virtual void Ogre::MovableObject::detachFromParent ( void )

virtualinherited

Detaches an object from a parent SceneNode or TagPoint, if attached.

virtual void Ogre::ShadowCaster::extrudeBounds	(	AxisAlignedBox &	box,
		const Vector4 &	lightPos,
		Real	extrudeDist
	)		const

protectedvirtualinherited

Utility method for extruding a bounding box.

Parameters

box	Original bounding box, will be updated in-place.
lightPos	4D light position in object space, when w=0.0f this represents a directional light.
extrudeDist	The distance to extrude.

static void Ogre::ShadowCaster::extrudeVertices	(	const HardwareVertexBufferSharedPtr &	vertexBuffer,
		size_t	originalVertexCount,
		const Vector4 &	lightPos,
		Real	extrudeDist
	)

staticinherited

Utility method for extruding vertices based on a light.

Remarks: Unfortunately, because D3D cannot handle homogeneous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.

Parameters

vertexBuffer	The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
originalVertexCount	The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
lightPos	4D light position in object space, when w=0.0f this represents a directional light.
extrudeDist	The distance to extrude.

virtual void Ogre::ShadowCaster::generateShadowVolume	(	EdgeData *	edgeData,
		const HardwareIndexBufferSharedPtr &	indexBuffer,
		size_t &	indexBufferUsedSize,
		const Light *	light,
		ShadowRenderableList &	shadowRenderables,
		unsigned long	flags
	)

protectedvirtualinherited

Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.

Parameters

edgeData	The edge information to use.
indexBuffer	The buffer into which to write data into; current contents are assumed to be discardable.
indexBufferUsedSize	If the rest of buffer is enough than it would be locked with HBL_NO_OVERWRITE semantic and indexBufferUsedSize would be increased, otherwise HBL_DISCARD would be used and indexBufferUsedSize would be reset.
light	The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
shadowRenderables	A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
flags	Additional controller flags, see ShadowRenderableFlags.

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void ) const

inlineprotectedvirtualinherited

Get the name of the animable dictionary for this class.

Remarks: Subclasses must override this if they want to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 249 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void ) const

inlineinherited

Gets a list of animable value names for this object.

Definition at line 295 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

const AxisAlignedBox& Ogre::BillboardChain::getBoundingBox ( void ) const

virtualinherited

Retrieves the local axis-aligned bounding box for this object.

Remarks: This bounding box is in local coordinates.

Implements Ogre::MovableObject.

Real Ogre::BillboardChain::getBoundingRadius ( void ) const

virtualinherited

Retrieves the radius of the origin-centered bounding sphere for this object.

Implements Ogre::MovableObject.

bool Ogre::MovableObject::getCastShadows ( void ) const

inlinevirtualinherited

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 521 of file OgreMovableObject.h.

virtual bool Ogre::Renderable::getCastsShadows ( void ) const

inlinevirtualinherited

Method which reports whether this renderable would normally cast a shadow.

Remarks: Subclasses should override this if they could have been used to generate a shadow.

Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, and Ogre::StaticGeometry::GeometryBucket.

Definition at line 224 of file OgreRenderable.h.

virtual const Element& Ogre::BillboardChain::getChainElement	(	size_t	chainIndex,
		size_t	elementIndex
	)		const

virtualinherited

Get the detail of a chain element.

Parameters

chainIndex	The index of the chain
elementIndex	The element index within the chain, measured from the 'head' of the chain

virtual size_t Ogre::RibbonTrail::getChainIndexForNode ( const Node * n )

virtual

Get the chain index for a given Node being tracked.

virtual const ColourValue& Ogre::RibbonTrail::getColourChange ( size_t chainIndex ) const

virtual

Get the per-second fading amount.

const Vector4& Ogre::Renderable::getCustomParameter ( size_t index ) const

inlineinherited

Gets the custom value associated with this Renderable at the given index.

Parameters

index Index of the parameter to retrieve.

See also: setCustomParameter for full details.

Definition at line 268 of file OgreRenderable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds	(	const Light &	light,
		Real	dirLightExtrusionDist
	)		const

virtualinherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )

inlinestaticinherited

Get the default query flags for all future MovableObject instances.

Definition at line 411 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )

inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 439 of file OgreMovableObject.h.

virtual bool Ogre::BillboardChain::getDynamic ( void ) const

inlinevirtualinherited

Gets whether or not the buffers created for this object are suitable for dynamic alteration.

Definition at line 199 of file OgreBillboardChain.h.

EdgeData* Ogre::MovableObject::getEdgeList ( void )

inlinevirtualinherited

Define a default implementation of method from ShadowCaster which implements no shadows.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 494 of file OgreMovableObject.h.

Real Ogre::ShadowCaster::getExtrusionDistance	(	const Vector3 &	objectPos,
		const Light *	light
	)		const

protectedinherited

Helper method for calculating extrusion distance.

virtual const ColourValue& Ogre::RibbonTrail::getInitialColour ( size_t chainIndex ) const

virtual

Get the starting ribbon colour.

virtual Real Ogre::RibbonTrail::getInitialWidth ( size_t chainIndex ) const

virtual

Get the starting ribbon width in world units.

const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds ( void ) const

virtualinherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

virtual uint32 Ogre::MovableObject::getLightMask ( ) const

inlinevirtualinherited

Get a bitwise mask which will filter the lights affecting this object.

Remarks: By default, this mask is fully set meaning all lights will affect this object

Definition at line 476 of file OgreMovableObject.h.

const LightList& Ogre::BillboardChain::getLights ( void ) const

virtualinherited

Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks: Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.

virtual Listener* Ogre::MovableObject::getListener ( void ) const

inlinevirtualinherited

Gets the current listener for this object.

Definition at line 450 of file OgreMovableObject.h.

const MaterialPtr& Ogre::BillboardChain::getMaterial ( void ) const

virtualinherited

Retrieves a weak reference to the material this renderable object uses.

Remarks: Note that the Renderable also has the option to override the getTechnique method to specify a particular Technique to use instead of the best one available.

Implements Ogre::Renderable.

virtual const String& Ogre::BillboardChain::getMaterialName ( void ) const

inlinevirtualinherited

Get the material name in use.

Definition at line 257 of file OgreBillboardChain.h.

virtual size_t Ogre::BillboardChain::getMaxChainElements ( void ) const

inlinevirtualinherited

Get the maximum number of chain elements per chain.

Definition at line 126 of file OgreBillboardChain.h.

const String& Ogre::RibbonTrail::getMovableType ( void ) const

virtual

Overridden from MovableObject.

Reimplemented from Ogre::BillboardChain.

virtual const String& Ogre::MovableObject::getName ( void ) const

inlinevirtualinherited

Returns the name of this object.

Definition at line 193 of file OgreMovableObject.h.

virtual NodeIterator Ogre::RibbonTrail::getNodeIterator ( void ) const

virtual

Get an iterator over the nodes which are being tracked.

virtual size_t Ogre::BillboardChain::getNumberOfChains ( void ) const

inlinevirtualinherited

Get the number of chain segments (this class can render multiple chains at once using the same material).

Definition at line 134 of file OgreBillboardChain.h.

virtual size_t Ogre::BillboardChain::getNumChainElements ( size_t chainIndex ) const

virtualinherited

Returns the number of chain elements.

virtual unsigned short Ogre::Renderable::getNumWorldTransforms ( void ) const

inlinevirtualinherited

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::BorderRenderable, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.

Definition at line 153 of file OgreRenderable.h.

virtual const Real* Ogre::BillboardChain::getOtherTextureCoordRange ( void ) const

inlinevirtualinherited

Get the range of the texture coordinates generated across the width of the chain elements.

Definition at line 177 of file OgreBillboardChain.h.

virtual Node* Ogre::MovableObject::getParentNode ( void ) const

virtualinherited

Returns the node to which this object is attached.

Remarks: A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. Both are Node subclasses so this method will return either.

virtual SceneNode* Ogre::MovableObject::getParentSceneNode ( void ) const

virtualinherited

Returns the scene node to which this object is attached.

Remarks: A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. This method will return the scene node of the parent entity if the latter is true.

Real Ogre::MovableObject::getPointExtrusionDistance ( const Light * l ) const

virtualinherited

Get the distance to extrude for a point/spot light.

Implements Ogre::ShadowCaster.

virtual bool Ogre::Renderable::getPolygonModeOverrideable ( void ) const

inlinevirtualinherited

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Reimplemented in Ogre::BorderRenderable.

Definition at line 332 of file OgreRenderable.h.

virtual uint32 Ogre::MovableObject::getQueryFlags ( void ) const

inlinevirtualinherited

Returns the query flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 403 of file OgreMovableObject.h.

bool Ogre::MovableObject::getReceivesShadows ( )

inherited

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

virtual Real Ogre::MovableObject::getRenderingDistance ( void ) const

inlinevirtualinherited

Gets the distance at which batches are no longer rendered.

Definition at line 305 of file OgreMovableObject.h.

virtual Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const

inlinevirtualinherited

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Definition at line 318 of file OgreMovableObject.h.

void Ogre::BillboardChain::getRenderOperation ( RenderOperation & op )

virtualinherited

Gets the render operation required to send this object to the frame buffer.

Implements Ogre::Renderable.

virtual uint8 Ogre::MovableObject::getRenderQueueGroup ( void ) const

virtualinherited

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

virtual RenderSystemData* Ogre::Renderable::getRenderSystemData ( ) const

inlinevirtualinherited

Gets RenderSystem private data.

Remarks: This should only be used by a RenderSystem

Definition at line 399 of file OgreRenderable.h.

ShadowRenderableListIterator Ogre::MovableObject::getShadowVolumeRenderableIterator	(	ShadowTechnique	shadowTechnique,
		const Light *	light,
		HardwareIndexBufferSharedPtr *	indexBuffer,
		size_t *	indexBufferUsedSize,
		bool	extrudeVertices,
		Real	extrusionDist,
		unsigned long	flags = `0`
	)

virtualinherited

Define a default implementation of method from ShadowCaster which implements no shadows.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Real Ogre::BillboardChain::getSquaredViewDepth ( const Camera * cam ) const

virtualinherited

Returns the camera-relative squared depth of this renderable.

Remarks: Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result.

Implements Ogre::Renderable.

virtual Technique* Ogre::Renderable::getTechnique ( void ) const

inlinevirtualinherited

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::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 94 of file OgreRenderable.h.

virtual TexCoordDirection Ogre::BillboardChain::getTextureCoordDirection ( void )

inlinevirtualinherited

Gets the direction in which texture coords specified on each element are deemed to run.

Definition at line 166 of file OgreBillboardChain.h.

virtual Real Ogre::RibbonTrail::getTrailLength ( void ) const

inlinevirtual

Get the length of the trail.

Definition at line 110 of file OgreRibbonTrail.h.

virtual uint32 Ogre::MovableObject::getTypeFlags ( void ) const

virtualinherited

Get the 'type flags' for this MovableObject.

Remarks: A type flag identifies the type of the MovableObject as a bitpattern. This is used for categorical inclusion / exclusion in SceneQuery objects. By default, this method returns all ones for objects not created by a MovableObjectFactory (hence always including them); otherwise it returns the value assigned to the MovableObjectFactory. Custom objects which don't use MovableObjectFactory will need to override this if they want to be included in queries.

Reimplemented in Ogre::BillboardSet, Ogre::Entity, Ogre::ParticleSystem, Ogre::Frustum, Ogre::StaticGeometry::Region, and Ogre::Light.

bool Ogre::Renderable::getUseIdentityProjection ( void ) const

inlineinherited

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 change this.

See also: Renderable::setUseIdentityProjection

Definition at line 178 of file OgreRenderable.h.

bool Ogre::Renderable::getUseIdentityView ( void ) const

inlineinherited

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

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 change this.

See also: Renderable::setUseIdentityView

Definition at line 203 of file OgreRenderable.h.

virtual OGRE_DEPRECATED const Any& Ogre::MovableObject::getUserAny ( void ) const

inlinevirtualinherited

Deprecated:: use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 334 of file OgreMovableObject.h.

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny ( void ) const

inlinevirtualinherited

Deprecated:: use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 349 of file OgreRenderable.h.

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( )

inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

Definition at line 340 of file OgreMovableObject.h.

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const

inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

Definition at line 346 of file OgreMovableObject.h.

UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( )

inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

Definition at line 355 of file OgreRenderable.h.

const UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( ) const

inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

Definition at line 361 of file OgreRenderable.h.

virtual bool Ogre::BillboardChain::getUseTextureCoords ( void ) const

inlinevirtualinherited

Gets whether texture coordinate information should be included in the final buffers generated.

Definition at line 146 of file OgreBillboardChain.h.

virtual bool Ogre::BillboardChain::getUseVertexColours ( void ) const

inlinevirtualinherited

Gets whether vertex colour information should be included in the final buffers generated.

Definition at line 189 of file OgreBillboardChain.h.

virtual uint32 Ogre::MovableObject::getVisibilityFlags ( void ) const

inlinevirtualinherited

Returns the visibility flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 431 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::getVisible ( void ) const

virtualinherited

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

Remarks: Returns the value set by MovableObject::setVisible only.

virtual Real Ogre::RibbonTrail::getWidthChange ( size_t chainIndex ) const

virtual

Get the change in ribbon width per second.

virtual const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox ( bool derive = false ) const

virtualinherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, and Ogre::PortalBase.

virtual const Sphere& Ogre::MovableObject::getWorldBoundingSphere ( bool derive = false ) const

virtualinherited

Retrieves the worldspace bounding sphere for this object.

Reimplemented in Ogre::Entity, and Ogre::PortalBase.

void Ogre::BillboardChain::getWorldTransforms ( Matrix4 * xform ) const

virtualinherited

Gets the world transform matrix / matrices for this renderable object.

Remarks: If the object has any derived transforms, these are expected to be up to date as long as all the SceneNode structures have been updated before this is called.

: This method will populate transform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.

Note: Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.

See also: Matrix4::isAffine.

Implements Ogre::Renderable.

bool Ogre::Renderable::hasCustomParameter ( size_t index ) const

inlineinherited

Checks whether a custom value is associated with this Renderable at the given index.

Parameters

index Index of the parameter to check for existence.

See also: setCustomParameter for full details.

Definition at line 259 of file OgreRenderable.h.

bool Ogre::MovableObject::hasEdgeList ( void )

inlinevirtualinherited

Define a default implementation of method from ShadowCaster which implements no shadows.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 496 of file OgreMovableObject.h.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector & ) const

inlineprotectedvirtualinherited

Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Reimplemented in Ogre::Light.

Definition at line 287 of file OgreAnimable.h.

virtual bool Ogre::MovableObject::isAttached ( void ) const

virtualinherited

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

virtual bool Ogre::MovableObject::isDebugDisplayEnabled ( void ) const

inlinevirtualinherited

Gets whether debug display of this object is enabled.

Definition at line 565 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::isInScene ( void ) const

virtualinherited

Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.

Reimplemented in Ogre::InstancedEntity.

virtual bool Ogre::MovableObject::isParentTagPoint ( ) const

inlinevirtualinherited

Gets whether the parent node is a TagPoint (or a SceneNode)

Definition at line 216 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::isVisible ( void ) const

virtualinherited

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

Remarks: Takes into account both upper rendering distance and visible flag.

Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.

virtual void Ogre::RibbonTrail::manageController ( void )

protectedvirtual

Manage updates to the time controller.

virtual void Ogre::Node::Listener::nodeAttached ( const Node * )

inlinevirtualinherited

Node has been attached to a parent.

Definition at line 100 of file OgreNode.h.

void Ogre::RibbonTrail::nodeDestroyed ( const Node * node )

virtual

See also: Node::Listener::nodeDestroyed

Reimplemented from Ogre::Node::Listener.

virtual void Ogre::Node::Listener::nodeDetached ( const Node * )

inlinevirtualinherited

Node has been detached from a parent.

Definition at line 102 of file OgreNode.h.

void Ogre::RibbonTrail::nodeUpdated ( const Node * node )

virtual

See also: Node::Listener::nodeUpdated

Reimplemented from Ogre::Node::Listener.

template<class Alloc >

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

inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Renderable::postRender	(	SceneManager *	sm,
		RenderSystem *	rsys
	)

inlinevirtualinherited

Called immediately after the Renderable has been rendered.

Definition at line 128 of file OgreRenderable.h.

virtual bool Ogre::BillboardChain::preRender	(	SceneManager *	sm,
		RenderSystem *	rsys
	)

virtualinherited

Called just prior to the Renderable being rendered.

Remarks: OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.

: This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.

Returns: true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Reimplemented from Ogre::Renderable.

virtual const LightList& Ogre::MovableObject::queryLights ( void ) const

virtualinherited

Gets a list of lights, ordered relative to how close they are to this movable object.

Remarks: By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.

: The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (

See also: SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.

: This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.

Returns: The list of lights use to lighting this object.

virtual void Ogre::BillboardChain::removeChainElement ( size_t chainIndex )

virtualinherited

Remove an element from the 'tail' of a chain.

Parameters

chainIndex The index of the chain

void Ogre::Renderable::removeCustomParameter ( size_t index )

inlineinherited

Removes a custom value which is associated with this Renderable at the given index.

Parameters

index Index of the parameter to remove.

See also: setCustomParameter for full details.

Definition at line 250 of file OgreRenderable.h.

virtual void Ogre::RibbonTrail::removeNode ( Node * n )

virtual

Remove tracking on a given node.

virtual void Ogre::MovableObject::removeQueryFlags ( uint32 flags )

inlinevirtualinherited

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

Definition at line 400 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::removeVisibilityFlags ( uint32 flags )

inlinevirtualinherited

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

Definition at line 428 of file OgreMovableObject.h.

virtual void Ogre::RibbonTrail::resetAllTrails ( void )

protectedvirtual

Reset all tracked chains to initial state.

virtual void Ogre::RibbonTrail::resetTrail	(	size_t	index,
		const Node *	node
	)

protectedvirtual

Reset the tracked chain to initial state.

void Ogre::MovableObject::setCastShadows ( bool enabled )

inlineinherited

Sets whether or not this object will cast shadows.

Remarks: This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.

Note: This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

Definition at line 519 of file OgreMovableObject.h.

virtual void Ogre::RibbonTrail::setColourChange	(	size_t	chainIndex,
		const ColourValue &	valuePerSecond
	)

virtual

Enables / disables fading the trail using colour.

Parameters

chainIndex	The index of the chain
valuePerSecond	The amount to subtract from colour each second

virtual void Ogre::RibbonTrail::setColourChange	(	size_t	chainIndex,
		Real	r,
		Real	g,
		Real	b,
		Real	a
	)

virtual

Enables / disables fading the trail using colour.

Parameters

chainIndex	The index of the chain
r,g,b,a	The amount to subtract from each colour channel per second

void Ogre::Renderable::setCustomParameter	(	size_t	index,
		const Vector4 &	value
	)

inlineinherited

Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

Remarks: Calling this method simply associates a numeric index with a 4-dimensional value for this specific Renderable. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.

Parameters

index	The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.
value	The value to associate.

Definition at line 241 of file OgreRenderable.h.

virtual void Ogre::MovableObject::setDebugDisplayEnabled ( bool enabled )

inlinevirtualinherited

Sets whether or not the debug display of this object is enabled.

Remarks: Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

Definition at line 563 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32 flags )

inlinestaticinherited

Set the default query flags for all future MovableObject instances.

Definition at line 407 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32 flags )

inlinestaticinherited

Set the default visibility flags for all future MovableObject instances.

Definition at line 435 of file OgreMovableObject.h.

virtual void Ogre::BillboardChain::setDynamic ( bool dyn )

virtualinherited

Sets whether or not the buffers created for this object are suitable for dynamic alteration.

void Ogre::BillboardChain::setFaceCamera	(	bool	faceCamera,
		const Vector3 &	normalVector = `Vector3::UNIT_X`
	)

inherited

Sets whether the billboard should always be facing the camera or a custom direction set by each point element.

Remarks: Billboards facing the camera are useful for smoke trails, light beams, etc by simulating a cylinder. However, because of this property, wide trails can cause several artefacts unless the head is properly covered. Therefore, non-camera-facing billboards are much more convenient for leaving big trails of movement from thin objects, for example a sword swing as seen in many fighting games.

Parameters

faceCamera	True to be always facing the camera (Default value: True)
normalVector	Only used when faceCamera == false. Must be a non-zero vector. This vector is the "point of reference" for each point orientation. For example, if normalVector is Vector3::UNIT_Z, and the point's orientation is an identity matrix, the segment corresponding to that point will be facing towards UNIT_Z This vector is internally normalized.

virtual void Ogre::RibbonTrail::setInitialColour	(	size_t	chainIndex,
		const ColourValue &	col
	)

virtual

Set the starting ribbon colour for a given segment.

Parameters

chainIndex	The index of the chain
col	The initial colour

Note: Only used if this instance is using vertex colours.

virtual void Ogre::RibbonTrail::setInitialColour	(	size_t	chainIndex,
		Real	r,
		Real	g,
		Real	b,
		Real	a = `1.0`
	)

virtual

Set the starting ribbon colour.

Parameters

chainIndex	The index of the chain
r,b,g,a	The initial colour

Note: Only used if this instance is using vertex colours.

virtual void Ogre::RibbonTrail::setInitialWidth	(	size_t	chainIndex,
		Real	width
	)

virtual

Set the starting ribbon width in world units.

Parameters

chainIndex	The index of the chain
width	The initial width of the ribbon

virtual void Ogre::MovableObject::setLightMask ( uint32 lightMask )

virtualinherited

Set a bitwise mask which will filter the lights affecting this object.

Remarks: This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object

virtual void Ogre::MovableObject::setListener ( Listener * listener )

inlinevirtualinherited

Sets a listener for this object.

Remarks: Note for size and performance reasons only one listener per object is allowed.

Definition at line 446 of file OgreMovableObject.h.

virtual void Ogre::BillboardChain::setMaterialName	(	const String &	name,
		const String &	groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
	)

virtualinherited

Set the material name to use for rendering.

void Ogre::RibbonTrail::setMaxChainElements ( size_t maxElements )

virtual

Set the maximum number of chain elements per chain.

Reimplemented from Ogre::BillboardChain.

void Ogre::RibbonTrail::setNumberOfChains ( size_t numChains )

virtual

Set the number of chain segments (this class can render multiple chains at once using the same material).

Reimplemented from Ogre::BillboardChain.

virtual void Ogre::BillboardChain::setOtherTextureCoordRange	(	Real	start,
		Real	end
	)

virtualinherited

Set the range of the texture coordinates generated across the width of the chain elements.

Parameters

start	Start coordinate, default 0.0
end	End coordinate, default 1.0

virtual void Ogre::Renderable::setPolygonModeOverrideable ( bool override )

inlinevirtualinherited

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Parameters

override true means that a lower camera detail will override this renderables detail level, false means it won't.

Definition at line 324 of file OgreRenderable.h.

virtual void Ogre::MovableObject::setQueryFlags ( uint32 flags )

inlinevirtualinherited

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 392 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderingDistance ( Real dist )

inlinevirtualinherited

Sets the distance at which the object is no longer rendered.

Note: Camera::setUseRenderingDistance() needs to be called for this parameter to be used.

Parameters

dist	Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

Definition at line 299 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderingMinPixelSize ( Real pixelSize )

inlinevirtualinherited

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note: Camera::setUseMinPixelSize() needs to be called for this parameter to be used.

Parameters

pixelSize Number of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 312 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderQueueGroup ( uint8 queueID )

virtualinherited

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 the default queue (RenderQueue::getDefaultQueueGroup), 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. See the enum RenderQueueGroupID for what kind of values can be used here.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

virtual void Ogre::MovableObject::setRenderQueueGroupAndPriority	(	uint8	queueID,
		ushort	priority
	)

virtualinherited

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

Remarks: Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), 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. See the enum RenderQueueGroupID for what kind of values can be used here.
priority	The priority within a group to use.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData * val ) const

inlinevirtualinherited

Sets RenderSystem private data.

Remarks: This should only be used by a RenderSystem

Definition at line 407 of file OgreRenderable.h.

virtual void Ogre::BillboardChain::setTextureCoordDirection ( TexCoordDirection dir )

virtualinherited

Sets the direction in which texture coords specified on each element are deemed to run along the length of the chain.

Parameters

dir	The direction, default is TCD_U.

virtual void Ogre::RibbonTrail::setTrailLength ( Real len )

virtual

Set the length of the trail.

Remarks: This sets the length of the trail, in world units. It also sets how far apart each segment will be, ie length / max_elements.

Parameters

len	The length of the trail in world units

virtual void Ogre::BillboardChain::setupBuffers ( void )

protectedvirtualinherited

Setup buffers.

virtual void Ogre::BillboardChain::setupChainContainers ( void )

protectedvirtualinherited

Setup the STL collections.

virtual void Ogre::BillboardChain::setupVertexDeclaration ( void )

protectedvirtualinherited

Setup vertex declaration.

void Ogre::Renderable::setUseIdentityProjection ( bool useIdentityProjection )

inlineinherited

Sets 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 change this. The default is false.

See also: Renderable::getUseIdentityProjection

Definition at line 164 of file OgreRenderable.h.

void Ogre::Renderable::setUseIdentityView ( bool useIdentityView )

inlineinherited

Sets whether or not to use an 'identity' view.

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 change this. The default is false.

See also: Renderable::getUseIdentityView

Definition at line 189 of file OgreRenderable.h.

virtual OGRE_DEPRECATED void Ogre::MovableObject::setUserAny ( const Any & anything )

inlinevirtualinherited

Deprecated:: use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

Remarks: This method allows you to associate any user value you like with this MovableObject. This can be a pointer back to one of your own classes for instance.

Definition at line 329 of file OgreMovableObject.h.

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any & anything )

inlinevirtualinherited

Deprecated:: use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

Remarks: This method allows you to associate any user value you like with this Renderable. This can be a pointer back to one of your own classes for instance.

Definition at line 344 of file OgreRenderable.h.

virtual void Ogre::BillboardChain::setUseTextureCoords ( bool use )

virtualinherited

Sets whether texture coordinate information should be included in the final buffers generated.

Note: You must use either texture coordinates or vertex colour since the vertices have no normals and without one of these there is no source of colour for the vertices.

virtual void Ogre::BillboardChain::setUseVertexColours ( bool use )

virtualinherited

Sets whether vertex colour information should be included in the final buffers generated.

Note: You must use either texture coordinates or vertex colour since the vertices have no normals and without one of these there is no source of colour for the vertices.

virtual void Ogre::MovableObject::setVisibilityFlags ( uint32 flags )

inlinevirtualinherited

Sets the visibility flags for this object.

Remarks: As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags which when 'and'ed with the SceneManager's visibility mask can also make an object invisible.

Definition at line 420 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setVisible ( bool visible )

virtualinherited

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

Note: An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.

Reimplemented in Ogre::Light.

virtual void Ogre::RibbonTrail::setWidthChange	(	size_t	chainIndex,
		Real	widthDeltaPerSecond
	)

virtual

Set the change in ribbon width per second.

Parameters

chainIndex	The index of the chain
widthDeltaPerSecond	The amount the width will reduce by per second

virtual void Ogre::BillboardChain::updateBoundingBox ( void ) const

protectedvirtualinherited

virtual void Ogre::BillboardChain::updateChainElement	(	size_t	chainIndex,
		size_t	elementIndex,
		const Element &	billboardChainElement
	)

virtualinherited

Update the details of an existing chain element.

Parameters

chainIndex	The index of the chain
elementIndex	The element index within the chain, measured from the 'head' of the chain
billboardChainElement	The details to set

virtual void Ogre::ShadowCaster::updateEdgeListLightFacing	(	EdgeData *	edgeData,
		const Vector4 &	lightPos
	)

protectedvirtualinherited

Tells the caster to perform the tasks necessary to update the edge data's light listing.

Can be overridden if the subclass needs to do additional things.

Parameters

edgeData	The edge information to update.
lightPos	4D vector representing the light, a directional light has w=0.0.

virtual void Ogre::BillboardChain::updateIndexBuffer ( void )

protectedvirtualinherited

Update the contents of the index buffer.

virtual void Ogre::RibbonTrail::updateTrail	(	size_t	index,
		const Node *	node
	)

protectedvirtual

Node has changed position, update.

virtual void Ogre::BillboardChain::updateVertexBuffer ( Camera * cam )

protectedvirtualinherited

Update the contents of the vertex buffer.

void Ogre::BillboardChain::visitRenderables	(	Renderable::Visitor *	visitor,
		bool	debugRenderables = `false`
	)

virtualinherited

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters

visitor	Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderables	If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

Member Data Documentation

AxisAlignedBox Ogre::BillboardChain::mAABB

mutableprotectedinherited

AABB.

Definition at line 306 of file OgreBillboardChain.h.

bool Ogre::MovableObject::mBeyondFarDistance

protectedinherited

Hidden because of distance?

Definition at line 128 of file OgreMovableObject.h.

bool Ogre::BillboardChain::mBoundsDirty

mutableprotectedinherited

Do the bounds need redefining?

Definition at line 300 of file OgreBillboardChain.h.

bool Ogre::BillboardChain::mBuffersNeedRecreating

protectedinherited

Do the buffers need recreating?

Definition at line 298 of file OgreBillboardChain.h.

bool Ogre::MovableObject::mCastShadows

protectedinherited

Does this object cast shadows?

Definition at line 150 of file OgreMovableObject.h.

size_t Ogre::BillboardChain::mChainCount

protectedinherited

Number of chains.

Definition at line 284 of file OgreBillboardChain.h.

ElementList Ogre::BillboardChain::mChainElementList

protectedinherited

The list holding the chain elements.

Definition at line 327 of file OgreBillboardChain.h.

ChainSegmentList Ogre::BillboardChain::mChainSegmentList

protectedinherited

Definition at line 346 of file OgreBillboardChain.h.

MovableObjectFactory* Ogre::MovableObject::mCreator

protectedinherited

Creator of this object (if created by a factory)

Definition at line 112 of file OgreMovableObject.h.

CustomParameterMap Ogre::Renderable::mCustomParameters

protectedinherited

Definition at line 415 of file OgreRenderable.h.

bool Ogre::MovableObject::mDebugDisplay

protectedinherited

Is debug display enabled?

Definition at line 121 of file OgreMovableObject.h.

ColourValueList Ogre::RibbonTrail::mDeltaColour

protected

fade amount per second

Definition at line 204 of file OgreRibbonTrail.h.

RealList Ogre::RibbonTrail::mDeltaWidth

protected

Delta width of the ribbon.

Definition at line 208 of file OgreRibbonTrail.h.

bool Ogre::BillboardChain::mDynamic

protectedinherited

Dynamic use?

Definition at line 290 of file OgreBillboardChain.h.

Real Ogre::RibbonTrail::mElemLength

protected

length of each element

Definition at line 196 of file OgreRibbonTrail.h.

bool Ogre::BillboardChain::mFaceCamera

protectedinherited

When true, the billboards always face the camera.

Definition at line 319 of file OgreBillboardChain.h.

Controller<Real>* Ogre::RibbonTrail::mFadeController

protected

controller used to hook up frame time to fader

Definition at line 210 of file OgreRibbonTrail.h.

IndexVector Ogre::RibbonTrail::mFreeChains

protected

Definition at line 186 of file OgreRibbonTrail.h.

bool Ogre::BillboardChain::mIndexContentDirty

protectedinherited

Is the index buffer dirty?

Definition at line 302 of file OgreBillboardChain.h.

IndexData* Ogre::BillboardChain::mIndexData

protectedinherited

Index data (to allow multiple unconnected chains)

Definition at line 294 of file OgreBillboardChain.h.

ColourValueList Ogre::RibbonTrail::mInitialColour

protected

Initial colour of the ribbon.

Definition at line 202 of file OgreRibbonTrail.h.

RealList Ogre::RibbonTrail::mInitialWidth

protected

Initial width of the ribbon.

Definition at line 206 of file OgreRibbonTrail.h.

LightList Ogre::MovableObject::mLightList

mutableprotectedinherited

List of lights for this object.

Definition at line 158 of file OgreMovableObject.h.

ulong Ogre::MovableObject::mLightListUpdated

mutableprotectedinherited

The last frame that this light list was updated in.

Definition at line 160 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::mLightMask

protectedinherited

the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable

Definition at line 163 of file OgreMovableObject.h.

Listener* Ogre::MovableObject::mListener

protectedinherited

MovableObject listener - only one allowed (no list) for size & performance reasons. */.

Definition at line 155 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::mManager

protectedinherited

SceneManager holding this object (if applicable)

Definition at line 114 of file OgreMovableObject.h.

MaterialPtr Ogre::BillboardChain::mMaterial

protectedinherited

Definition at line 311 of file OgreBillboardChain.h.

String Ogre::BillboardChain::mMaterialName

protectedinherited

Material.

Definition at line 310 of file OgreBillboardChain.h.

size_t Ogre::BillboardChain::mMaxElementsPerChain

protectedinherited

Maximum length of each chain.

Definition at line 282 of file OgreBillboardChain.h.

Real Ogre::MovableObject::mMinPixelSize

protectedinherited

Definition at line 126 of file OgreMovableObject.h.

String Ogre::MovableObject::mName

protectedinherited

Name of this object.

Definition at line 110 of file OgreMovableObject.h.

NodeList Ogre::RibbonTrail::mNodeList

protected

List of nodes being trailed.

Definition at line 180 of file OgreRibbonTrail.h.

IndexVector Ogre::RibbonTrail::mNodeToChainSegment

protected

Ordered like mNodeList, contains chain index.

Definition at line 184 of file OgreRibbonTrail.h.

NodeToChainSegmentMap Ogre::RibbonTrail::mNodeToSegMap

protected

Definition at line 191 of file OgreRibbonTrail.h.

Vector3 Ogre::BillboardChain::mNormalBase

protectedinherited

Used when mFaceCamera == false; determines the billboard's "normal".

i.e. when the orientation is identity, the billboard is perpendicular to this vector

Definition at line 323 of file OgreBillboardChain.h.

Real Ogre::BillboardChain::mOtherTexCoordRange[2]

protectedinherited

Other texture coord range.

Definition at line 315 of file OgreBillboardChain.h.

bool Ogre::MovableObject::mParentIsTagPoint

protectedinherited

Definition at line 117 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode

protectedinherited

node to which this object is attached

Definition at line 116 of file OgreMovableObject.h.

bool Ogre::Renderable::mPolygonModeOverrideable

protectedinherited

Definition at line 416 of file OgreRenderable.h.

uint32 Ogre::MovableObject::mQueryFlags

protectedinherited

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

Definition at line 140 of file OgreMovableObject.h.

Real Ogre::BillboardChain::mRadius

mutableprotectedinherited

Bounding radius.

Definition at line 308 of file OgreBillboardChain.h.

bool Ogre::MovableObject::mRenderingDisabled

protectedinherited

Does rendering this object disabled by listener?

Definition at line 153 of file OgreMovableObject.h.

uint8 Ogre::MovableObject::mRenderQueueID

protectedinherited

The render queue to use when rendering this object.

Definition at line 132 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderQueueIDSet

protectedinherited

Flags whether the RenderQueue's default should be used.

Definition at line 134 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority

protectedinherited

The render queue group to use when rendering this object.

Definition at line 136 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderQueuePrioritySet

protectedinherited

Flags whether the RenderQueue's default should be used.

Definition at line 138 of file OgreMovableObject.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData

mutableprotectedinherited

User objects binding.

Definition at line 420 of file OgreRenderable.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary

staticprotectedinherited

Static map of class name to list of animable value names.

Definition at line 243 of file OgreAnimable.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags

staticprotectedinherited

Default query flags.

Definition at line 167 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags

staticprotectedinherited

Default visibility flags.

Definition at line 169 of file OgreMovableObject.h.

Real Ogre::RibbonTrail::mSquaredElemLength

protected

Squared length of each element.

Definition at line 198 of file OgreRibbonTrail.h.

Real Ogre::MovableObject::mSquaredUpperDistance

protectedinherited

Definition at line 124 of file OgreMovableObject.h.

TexCoordDirection Ogre::BillboardChain::mTexCoordDir

protectedinherited

Texture coord direction.

Definition at line 313 of file OgreBillboardChain.h.

ControllerValueRealPtr Ogre::RibbonTrail::mTimeControllerValue

protected

controller value for hooking up frame time to fader

Definition at line 212 of file OgreRibbonTrail.h.

Real Ogre::RibbonTrail::mTrailLength

protected

Total length of trail in world units.

Definition at line 194 of file OgreRibbonTrail.h.

Real Ogre::MovableObject::mUpperDistance

protectedinherited

Upper distance to still render.

Definition at line 123 of file OgreMovableObject.h.

bool Ogre::Renderable::mUseIdentityProjection

protectedinherited

Definition at line 417 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView

protectedinherited

Definition at line 418 of file OgreRenderable.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings

protectedinherited

User objects binding.

Definition at line 130 of file OgreMovableObject.h.

UserObjectBindings Ogre::Renderable::mUserObjectBindings

protectedinherited

Definition at line 419 of file OgreRenderable.h.

bool Ogre::BillboardChain::mUseTexCoords

protectedinherited

Use texture coords?

Definition at line 286 of file OgreBillboardChain.h.

bool Ogre::BillboardChain::mUseVertexColour

protectedinherited

Use vertex colour?

Definition at line 288 of file OgreBillboardChain.h.

Camera* Ogre::BillboardChain::mVertexCameraUsed

protectedinherited

Camera last used to build the vertex buffer.

Definition at line 317 of file OgreBillboardChain.h.

bool Ogre::BillboardChain::mVertexContentDirty

protectedinherited

Is the vertex buffer dirty?

Definition at line 304 of file OgreBillboardChain.h.

VertexData* Ogre::BillboardChain::mVertexData

protectedinherited

Vertex data.

Definition at line 292 of file OgreBillboardChain.h.

bool Ogre::BillboardChain::mVertexDeclDirty

protectedinherited

Is the vertex declaration dirty?

Definition at line 296 of file OgreBillboardChain.h.

uint32 Ogre::MovableObject::mVisibilityFlags

protectedinherited

Flags determining whether this object is visible (compared to SceneManager mask)

Definition at line 142 of file OgreMovableObject.h.

bool Ogre::MovableObject::mVisible

protectedinherited

Is this object visible?

Definition at line 119 of file OgreMovableObject.h.

AxisAlignedBox Ogre::MovableObject::mWorldAABB

mutableprotectedinherited

Cached world AABB of this object.

Definition at line 144 of file OgreMovableObject.h.

Sphere Ogre::MovableObject::mWorldBoundingSphere

mutableprotectedinherited

Definition at line 146 of file OgreMovableObject.h.

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds

mutableprotectedinherited

World space AABB of this object's dark cap.

Definition at line 148 of file OgreMovableObject.h.

const size_t Ogre::BillboardChain::SEGMENT_EMPTY

staticprotectedinherited

Chain segment has no elements.

Definition at line 361 of file OgreBillboardChain.h.

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

OgreRibbonTrail.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation