Allows the rendering of a chain of connected billboards. More...

#include <OgreBillboardChain.h>

Inheritance diagram for Ogre::BillboardChain:

Classes
struct	ChainSegment
	Simple struct defining a chain segment by referencing a subset of the preallocated buffer (which will be mMaxElementsPerChain * mChainCount long), by it's chain index, and a head and tail value which describe the current chain. More...
class	Element
	Contains the data of an element of the BillboardChain. More...
Public Types
typedef vector< Element >::type	ElementList
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
	BillboardChain (const String &name, size_t maxElements=20, size_t numberOfChains=1, bool useTextureCoords=true, bool useColours=true, bool dynamic=true)
	Constructor (don't use directly, use factory)
virtual	~BillboardChain ()
	Destructor.
virtual MovableObjectFactory *	_getCreator (void) const
	Get the creator of this object, if any (internal use only)
virtual LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object.
virtual SceneManager *	_getManager (void) const
	Get the manager of this object, if any (internal use only)
virtual const Matrix4 &	_getParentNodeFullTransform (void) const
	return the full transformation of the parent sceneNode or the attachingPoint node
virtual void	_notifyAttached (Node *parent, bool isTagPoint=false)
	Internal method called to notify the object that it has been attached to a node.
virtual void	_notifyCreator (MovableObjectFactory *fact)
	Notify the object of it's creator (internal use only)
virtual void	_notifyCurrentCamera (Camera *cam)
	Internal method to notify the object of the camera to be used for the next rendering operation.
virtual void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only)
virtual void	_notifyMoved (void)
	Internal method called to notify the object that it has been moved.
virtual void	_updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
	Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
void	_updateRenderQueue (RenderQueue *)
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
virtual void	addChainElement (size_t chainIndex, const Element &billboardChainElement)
	Add an element to the 'head' of a chain.
virtual void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
virtual void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
virtual void	clearAllChains (void)
	Remove all elements from all chains (but leave the chains themselves intact).
virtual void	clearChain (size_t chainIndex)
	Remove all elements of a given chain (but leave the chain intact).
virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value.
virtual void	detachFromParent (void)
	Detaches an object from a parent SceneNode or TagPoint, if attached.
const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object.
const AxisAlignedBox &	getBoundingBox (void) const
	Retrieves the local axis-aligned bounding box for this object.
Real	getBoundingRadius (void) const
	Retrieves the radius of the origin-centered bounding sphere for this object.
bool	getCastShadows (void) const
	Returns whether shadow casting is enabled for this object.
virtual bool	getCastsShadows (void) const
	Method which reports whether this renderable would normally cast a shadow.
virtual const Element &	getChainElement (size_t chainIndex, size_t elementIndex) const
	Get the detail of a chain element.
const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index.
const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
	Overridden member from ShadowCaster.
virtual bool	getDynamic (void) const
	Gets whether or not the buffers created for this object are suitable for dynamic alteration.
EdgeData *	getEdgeList (void)
	Define a default implementation of method from ShadowCaster which implements no shadows.
const AxisAlignedBox &	getLightCapBounds (void) const
	Overridden member from ShadowCaster.
virtual uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object.
const LightList &	getLights (void) const
	Gets a list of lights, ordered relative to how close they are to this renderable.
virtual Listener *	getListener (void) const
	Gets the current listener for this object.
const MaterialPtr &	getMaterial (void) const
	Retrieves a weak reference to the material this renderable object uses.
virtual const String &	getMaterialName (void) const
	Get the material name in use.
virtual size_t	getMaxChainElements (void) const
	Get the maximum number of chain elements per chain.
const String &	getMovableType (void) const
	Returns the type name of this object.
virtual const String &	getName (void) const
	Returns the name of this object.
virtual size_t	getNumberOfChains (void) const
	Get the number of chain segments (this class can render multiple chains at once using the same material).
virtual size_t	getNumChainElements (size_t chainIndex) const
	Returns the number of chain elements.
virtual unsigned short	getNumWorldTransforms (void) const
	Returns the number of world transform matrices this renderable requires.
virtual const Real *	getOtherTextureCoordRange (void) const
	Get the range of the texture coordinates generated across the width of the chain elements.
virtual Node *	getParentNode (void) const
	Returns the node to which this object is attached.
virtual SceneNode *	getParentSceneNode (void) const
	Returns the scene node to which this object is attached.
Real	getPointExtrusionDistance (const Light *l) const
	Get the distance to extrude for a point/spot light.
virtual bool	getPolygonModeOverrideable (void) const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object.
bool	getReceivesShadows ()
	Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
virtual Real	getRenderingDistance (void) const
	Gets the distance at which batches are no longer rendered.
virtual Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
void	getRenderOperation (RenderOperation &)
	Gets the render operation required to send this object to the frame buffer.
virtual uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity, see setRenderQueueGroup for full details.
virtual RenderSystemData *	getRenderSystemData () const
	Gets RenderSystem private data.
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.
Real	getSquaredViewDepth (const Camera *cam) const
	Returns the camera-relative squared depth of this renderable.
virtual Technique *	getTechnique (void) const
	Retrieves a pointer to the Material Technique this renderable object uses.
virtual TexCoordDirection	getTextureCoordDirection (void)
	Gets the direction in which texture coords specified on each element are deemed to run.
virtual uint32	getTypeFlags (void) const
	Get the 'type flags' for this MovableObject.
bool	getUseIdentityProjection (void) const
	Returns whether or not to use an 'identity' projection.
bool	getUseIdentityView (void) const
	Returns whether or not to use an 'identity' view.
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.
const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class.
UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class.
const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class.
virtual bool	getUseTextureCoords (void) const
	Gets whether texture coordinate information should be included in the final buffers generated.
virtual bool	getUseVertexColours (void) const
	Gets whether vertex colour information should be included in the final buffers generated.
virtual uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object.
virtual bool	getVisible (void) const
	Gets this object whether to be visible or not, if it has a renderable component.
virtual const AxisAlignedBox &	getWorldBoundingBox (bool derive=false) const
	Retrieves the axis-aligned bounding box for this object in world coordinates.
virtual const Sphere &	getWorldBoundingSphere (bool derive=false) const
	Retrieves the worldspace bounding sphere for this object.
void	getWorldTransforms (Matrix4 *) const
	Gets the world transform matrix / matrices for this renderable object.
bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index.
bool	hasEdgeList (void)
	Define a default implementation of method from ShadowCaster which implements no shadows.
virtual bool	isAttached (void) const
	Returns true if this object is attached to a SceneNode or TagPoint.
virtual bool	isDebugDisplayEnabled (void) const
	Gets whether debug display of this object is enabled.
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.
virtual bool	isParentTagPoint () const
	Gets whether the parent node is a TagPoint (or a SceneNode)
virtual bool	isVisible (void) const
	Returns whether or not this object is supposed to be visible or not.
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
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
virtual void	postRender (SceneManager sm, RenderSystem rsys)
	Called immediately after the Renderable has been rendered.
virtual bool	preRender (SceneManager sm, RenderSystem rsys)
	Called just prior to the Renderable being rendered.
virtual const LightList &	queryLights (void) const
	Gets a list of lights, ordered relative to how close they are to this movable object.
virtual void	removeChainElement (size_t chainIndex)
	Remove an element from the 'tail' of a chain.
void	removeCustomParameter (size_t index)
	Removes a custom value which is associated with this Renderable at the given index.
virtual void	removeQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
virtual void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows.
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.
virtual void	setDebugDisplayEnabled (bool enabled)
	Sets whether or not the debug display of this object is enabled.
virtual void	setDynamic (bool dyn)
	Sets whether or not the buffers created for this object are suitable for dynamic alteration.
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.
virtual void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object.
virtual void	setListener (Listener *listener)
	Sets a listener for this object.
virtual void	setMaterialName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Set the material name to use for rendering.
virtual void	setMaxChainElements (size_t maxElements)
	Set the maximum number of chain elements per chain.
virtual void	setNumberOfChains (size_t numChains)
	Set the number of chain segments (this class can render multiple chains at once using the same material).
virtual void	setOtherTextureCoordRange (Real start, Real end)
	Set the range of the texture coordinates generated across the width of the chain elements.
virtual void	setPolygonModeOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual void	setQueryFlags (uint32 flags)
	Sets the query flags for this object.
virtual void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered.
virtual void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through.
virtual void	setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
	Sets the render queue group and group priority this entity will be rendered through.
virtual void	setRenderSystemData (RenderSystemData *val) const
	Sets RenderSystem private data.
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.
void	setUseIdentityProjection (bool useIdentityProjection)
	Sets whether or not to use an 'identity' projection.
void	setUseIdentityView (bool useIdentityView)
	Sets whether or not to use an 'identity' view.
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.
virtual void	setUseVertexColours (bool use)
	Sets whether vertex colour information should be included in the final buffers generated.
virtual void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object.
virtual void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component.
virtual void	updateChainElement (size_t chainIndex, size_t elementIndex, const Element &billboardChainElement)
	Update the details of an existing chain element.
void	visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
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.
static uint32	getDefaultQueryFlags ()
	Get the default query flags for all future MovableObject instances.
static uint32	getDefaultVisibilityFlags ()
	Get the default visibility flags for all future MovableObject instances.
static void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances.
static void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances.
Protected Types
typedef map< String, StringVector >::type	AnimableDictionaryMap
typedef vector< ChainSegment > ::type	ChainSegmentList
typedef map< size_t, Vector4 > ::type	CustomParameterMap
Protected Member Functions
StringVector &	_getAnimableValueNames (void)
	Get an updateable reference to animable value list.
void	createAnimableDictionary (void) const
	Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
virtual void	extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
	Utility method for extruding a bounding box.
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.
virtual const String &	getAnimableDictionaryName (void) const
	Get the name of the animable dictionary for this class.
Real	getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
	Helper method for calculating extrusion distance.
virtual void	initialiseAnimableDictionary (StringVector &) const
	Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
virtual void	setupBuffers (void)
	Setup buffers.
virtual void	setupChainContainers (void)
	Setup the STL collections.
virtual void	setupVertexDeclaration (void)
	Setup vertex declaration.
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.
virtual void	updateIndexBuffer (void)
	Update the contents of the index buffer.
virtual void	updateVertexBuffer (Camera *cam)
	Update the contents of the vertex buffer.
Protected Attributes
AxisAlignedBox	mAABB
	AABB.
bool	mBeyondFarDistance
	Hidden because of distance?
bool	mBoundsDirty
	Do the bounds need redefining?
bool	mBuffersNeedRecreating
	Do the buffers need recreating?
bool	mCastShadows
	Does this object cast shadows?
size_t	mChainCount
	Number of chains.
ElementList	mChainElementList
	The list holding the chain elements.
ChainSegmentList	mChainSegmentList
MovableObjectFactory *	mCreator
	Creator of this object (if created by a factory)
CustomParameterMap	mCustomParameters
bool	mDebugDisplay
	Is debug display enabled?
bool	mDynamic
	Dynamic use?
bool	mFaceCamera
	When true, the billboards always face the camera.
bool	mIndexContentDirty
	Is the index buffer dirty?
IndexData *	mIndexData
	Index data (to allow multiple unconnected chains)
LightList	mLightList
	List of lights for this object.
ulong	mLightListUpdated
	The last frame that this light list was updated in.
uint32	mLightMask
	the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable
Listener *	mListener
	MovableObject listener - only one allowed (no list) for size & performance reasons. */.
SceneManager *	mManager
	SceneManager holding this object (if applicable)
MaterialPtr	mMaterial
String	mMaterialName
	Material.
size_t	mMaxElementsPerChain
	Maximum length of each chain.
Real	mMinPixelSize
String	mName
	Name of this object.
Vector3	mNormalBase
	Used when mFaceCamera == false; determines the billboard's "normal".
Real	mOtherTexCoordRange [2]
	Other texture coord range.
bool	mParentIsTagPoint
Node *	mParentNode
	node to which this object is attached
bool	mPolygonModeOverrideable
uint32	mQueryFlags
	Flags determining whether this object is included / excluded from scene queries.
Real	mRadius
	Bounding radius.
bool	mRenderingDisabled
	Does rendering this object disabled by listener?
uint8	mRenderQueueID
	The render queue to use when rendering this object.
bool	mRenderQueueIDSet
	Flags whether the RenderQueue's default should be used.
ushort	mRenderQueuePriority
	The render queue group to use when rendering this object.
bool	mRenderQueuePrioritySet
	Flags whether the RenderQueue's default should be used.
RenderSystemData *	mRenderSystemData
	User objects binding.
Real	mSquaredUpperDistance
TexCoordDirection	mTexCoordDir
	Texture coord direction.
Real	mUpperDistance
	Upper distance to still render.
bool	mUseIdentityProjection
bool	mUseIdentityView
UserObjectBindings	mUserObjectBindings
	User objects binding.
UserObjectBindings	mUserObjectBindings
bool	mUseTexCoords
	Use texture coords?
bool	mUseVertexColour
	Use vertex colour?
Camera *	mVertexCameraUsed
	Camera last used to build the vertex buffer.
bool	mVertexContentDirty
	Is the vertex buffer dirty?
VertexData *	mVertexData
	Vertex data.
bool	mVertexDeclDirty
	Is the vertex declaration dirty?
uint32	mVisibilityFlags
	Flags determining whether this object is visible (compared to SceneManager mask)
bool	mVisible
	Is this object visible?
AxisAlignedBox	mWorldAABB
	Cached world AABB of this object.
Sphere	mWorldBoundingSphere
AxisAlignedBox	mWorldDarkCapBounds
	World space AABB of this object's dark cap.
Static Protected Attributes
static AnimableDictionaryMap	msAnimableDictionary
	Static map of class name to list of animable value names.
static uint32	msDefaultQueryFlags
	Default query flags.
static uint32	msDefaultVisibilityFlags
	Default visibility flags.
static const size_t	SEGMENT_EMPTY
	Chain segment has no elements.

Detailed Description

Allows the rendering of a chain of connected billboards.

Remarks:: A billboard chain operates much like a traditional billboard, i.e. its segments always face the camera; the difference being that instead of a set of disconnected quads, the elements in this class are connected together in a chain which must always stay in a continuous strip. This kind of effect is useful for creating effects such as trails, beams, lightning effects, etc.

: A single instance of this class can actually render multiple separate chain segments in a single render operation, provided they all use the same material. To clarify the terminology: a 'segment' is a separate sub-part of the chain with its own start and end (called the 'head' and the 'tail'). An 'element' is a single position / colour / texcoord entry in a segment. You can add items to the head of a chain, and remove them from the tail, very efficiently. Each segment has a max size, and if adding an element to the segment would exceed this size, the tail element is automatically removed and re-used as the new item on the head.

: This class has no auto-updating features to do things like alter the colour of the elements or to automatically add / remove elements over time - you have to do all this yourself as a user of the class. Subclasses can however be used to provide this kind of behaviour automatically.

See also:: RibbonTrail

Definition at line 77 of file OgreBillboardChain.h.

Member Typedef Documentation

typedef map<String, StringVector>::type Ogre::AnimableObject::AnimableDictionaryMap [protected, inherited]

Definition at line 241 of file OgreAnimable.h.

typedef vector<ChainSegment>::type Ogre::BillboardChain::ChainSegmentList [protected]

Definition at line 345 of file OgreBillboardChain.h.

typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap [protected, inherited]

Definition at line 414 of file OgreRenderable.h.

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

Definition at line 106 of file OgreBillboardChain.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

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::BillboardChain::BillboardChain	(	const String &	name,
		size_t	maxElements = `20`,
		size_t	numberOfChains = `1`,
		bool	useTextureCoords = `true`,
		bool	useColours = `true`,
		bool	dynamic = `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
useTextureCoords	If true, use texture coordinates from the chain elements
useColours	If true, use vertex colours from the chain elements
dynamic	If true, buffers are created with the intention of being updated

virtual Ogre::BillboardChain::~BillboardChain ( ) [virtual]

Destructor.

Member Function Documentation

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void ) [protected, inherited]

Get an updateable reference to animable value list.

Definition at line 267 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND.

virtual MovableObjectFactory* Ogre::MovableObject::_getCreator ( void ) const [virtual, inherited]

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

Definition at line 186 of file OgreMovableObject.h.

virtual LightList* Ogre::MovableObject::_getLightList ( ) [virtual, inherited]

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 [virtual, inherited]

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 [virtual, inherited]

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`
	)		`[virtual, inherited]`

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

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

virtual void Ogre::MovableObject::_notifyCreator ( MovableObjectFactory * fact ) [virtual, inherited]

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 ) [virtual, inherited]

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 ) [virtual, inherited]

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

Definition at line 188 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyMoved ( void ) [virtual, inherited]

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

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

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

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 ) [virtual]

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
	)		`[virtual]`

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::MovableObject::addQueryFlags ( uint32 flags ) [virtual, inherited]

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 ) [virtual, inherited]

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 ) [virtual]

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

virtual void Ogre::BillboardChain::clearChain ( size_t chainIndex ) [virtual]

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

Reimplemented in Ogre::RibbonTrail.

void Ogre::AnimableObject::createAnimableDictionary ( void ) const [protected, inherited]

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 ) [virtual, inherited]

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.

virtual void Ogre::MovableObject::detachFromParent ( void ) [virtual, inherited]

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

virtual void Ogre::ShadowCaster::extrudeBounds	(	AxisAlignedBox &	box,
		const Vector4 &	lightPos,
		Real	extrudeDist
	)		const `[protected, virtual, inherited]`

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
	)		`[static, inherited]`

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
	)		`[protected, virtual, inherited]`

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 [protected, virtual, inherited]

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 [inherited]

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.

const AxisAlignedBox& Ogre::BillboardChain::getBoundingBox ( void ) const [virtual]

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 [virtual]

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

Implements Ogre::MovableObject.

bool Ogre::MovableObject::getCastShadows ( void ) const [virtual, inherited]

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 [virtual, inherited]

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 `[virtual]`

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

const Vector4& Ogre::Renderable::getCustomParameter ( size_t index ) const [inherited]

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.

const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds	(	const Light &	light,
		Real	dirLightExtrusionDist
	)		const `[virtual, inherited]`

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( ) [static, inherited]

Get the default query flags for all future MovableObject instances.

Definition at line 411 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( ) [static, inherited]

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 [virtual]

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 ) [virtual, inherited]

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::StaticGeometry::Region, and Ogre::ManualObject.

Definition at line 494 of file OgreMovableObject.h.

Real Ogre::ShadowCaster::getExtrusionDistance	(	const Vector3 &	objectPos,
		const Light *	light
	)		const `[protected, inherited]`

Helper method for calculating extrusion distance.

const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds ( void ) const [virtual, inherited]

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

virtual uint32 Ogre::MovableObject::getLightMask ( ) const [virtual, inherited]

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 [virtual]

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 [virtual, inherited]

Gets the current listener for this object.

Definition at line 450 of file OgreMovableObject.h.

const MaterialPtr& Ogre::BillboardChain::getMaterial ( void ) const [virtual]

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 [virtual]

Get the material name in use.

Definition at line 257 of file OgreBillboardChain.h.

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

Get the maximum number of chain elements per chain.

Definition at line 126 of file OgreBillboardChain.h.

const String& Ogre::BillboardChain::getMovableType ( void ) const [virtual]

Returns the type name of this object.

Implements Ogre::MovableObject.

Reimplemented in Ogre::RibbonTrail.

virtual const String& Ogre::MovableObject::getName ( void ) const [virtual, inherited]

Returns the name of this object.

Definition at line 193 of file OgreMovableObject.h.

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

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 [virtual]

Returns the number of chain elements.

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

Returns the number of world transform matrices this renderable requires.

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

Reimplemented in Ogre::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 [virtual]

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 [virtual, inherited]

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 [virtual, inherited]

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 [virtual, inherited]

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

Implements Ogre::ShadowCaster.

virtual bool Ogre::Renderable::getPolygonModeOverrideable ( void ) const [virtual, inherited]

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 [virtual, inherited]

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 [virtual, inherited]

Gets the distance at which batches are no longer rendered.

Definition at line 305 of file OgreMovableObject.h.

virtual Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const [virtual, inherited]

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 ) [virtual]

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

Implements Ogre::Renderable.

virtual uint8 Ogre::MovableObject::getRenderQueueGroup ( void ) const [virtual, inherited]

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

virtual RenderSystemData* Ogre::Renderable::getRenderSystemData ( ) const [virtual, inherited]

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`
	)		`[virtual, inherited]`

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::StaticGeometry::Region, and Ogre::ManualObject.

Real Ogre::BillboardChain::getSquaredViewDepth ( const Camera * cam ) const [virtual]

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 [virtual, inherited]

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

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

Reimplemented in Ogre::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 ) [virtual]

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

Definition at line 166 of file OgreBillboardChain.h.

virtual uint32 Ogre::MovableObject::getTypeFlags ( void ) const [virtual, inherited]

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 [inherited]

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

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

See also:: Renderable::setUseIdentityProjection

Definition at line 178 of file OgreRenderable.h.

bool Ogre::Renderable::getUseIdentityView ( void ) const [inherited]

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 [virtual, inherited]

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 [virtual, inherited]

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 ( ) [inherited]

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 [inherited]

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 ( ) [inherited]

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 [inherited]

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 [virtual]

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 [virtual]

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 [virtual, inherited]

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 [virtual, inherited]

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 const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox ( bool derive = false ) const [virtual, inherited]

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity.

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

Retrieves the worldspace bounding sphere for this object.

Reimplemented in Ogre::Entity.

void Ogre::BillboardChain::getWorldTransforms ( Matrix4 * xform ) const [virtual]

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 [inherited]

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 ) [virtual, inherited]

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::StaticGeometry::Region, and Ogre::ManualObject.

Definition at line 496 of file OgreMovableObject.h.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector & ) const [protected, virtual, inherited]

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 [virtual, inherited]

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

virtual bool Ogre::MovableObject::isDebugDisplayEnabled ( void ) const [virtual, inherited]

Gets whether debug display of this object is enabled.

Definition at line 565 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::isInScene ( void ) const [virtual, inherited]

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 [virtual, inherited]

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 [virtual, inherited]

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.

template<class Alloc >

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

placement operator new

Definition at line 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
	)		`[inherited]`

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 ) [inherited]

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Renderable::postRender	(	SceneManager *	sm,
		RenderSystem *	rsys
	)		`[virtual, inherited]`

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
	)		`[virtual]`

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 [virtual, inherited]

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 ) [virtual]

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

Parameters:

chainIndex The index of the chain

void Ogre::Renderable::removeCustomParameter ( size_t index ) [inherited]

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::MovableObject::removeQueryFlags ( uint32 flags ) [virtual, inherited]

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 ) [virtual, inherited]

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.

void Ogre::MovableObject::setCastShadows ( bool enabled ) [inherited]

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.

void Ogre::Renderable::setCustomParameter	(	size_t	index,
		const Vector4 &	value
	)		`[inherited]`

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 ) [virtual, inherited]

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 ) [static, inherited]

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 ) [static, inherited]

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 ) [virtual]

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`
	)

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::MovableObject::setLightMask ( uint32 lightMask ) [virtual, inherited]

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 ) [virtual, inherited]

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`
	)		`[virtual]`

Set the material name to use for rendering.

virtual void Ogre::BillboardChain::setMaxChainElements ( size_t maxElements ) [virtual]

Set the maximum number of chain elements per chain.

Reimplemented in Ogre::RibbonTrail.

virtual void Ogre::BillboardChain::setNumberOfChains ( size_t numChains ) [virtual]

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

Reimplemented in Ogre::RibbonTrail.

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

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 ) [virtual, inherited]

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 ) [virtual, inherited]

Sets the query flags for this object.

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

Definition at line 392 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderingDistance ( Real dist ) [virtual, inherited]

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 ) [virtual, inherited]

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 ) [virtual, inherited]

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

Remarks:: Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to 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
	)		`[virtual, inherited]`

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 [virtual, inherited]

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 ) [virtual]

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::BillboardChain::setupBuffers ( void ) [protected, virtual]

Setup buffers.

virtual void Ogre::BillboardChain::setupChainContainers ( void ) [protected, virtual]

Setup the STL collections.

virtual void Ogre::BillboardChain::setupVertexDeclaration ( void ) [protected, virtual]

Setup vertex declaration.

void Ogre::Renderable::setUseIdentityProjection ( bool useIdentityProjection ) [inherited]

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 ) [inherited]

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 ) [virtual, inherited]

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 ) [virtual, inherited]

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 ) [virtual]

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 ) [virtual]

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 ) [virtual, inherited]

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 ) [virtual, inherited]

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::BillboardChain::updateBoundingBox ( void ) const [protected, virtual]

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

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
	)		`[protected, virtual, inherited]`

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 ) [protected, virtual]

Update the contents of the index buffer.

virtual void Ogre::BillboardChain::updateVertexBuffer ( Camera * cam ) [protected, virtual]

Update the contents of the vertex buffer.

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

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.