Ogre::TerrainRenderable Class Reference

Represents a terrain tile. More...

#include <OgreTerrainRenderable.h>

Inheritance diagram for Ogre::TerrainRenderable:

List of all members.


Public Types
enum	Neighbor { NORTH = 0, SOUTH = 1, EAST = 2, WEST = 3, HERE = 4 }
typedef std::vector< ShadowRenderable * >	ShadowRenderableList
typedef VectorIterator< ShadowRenderableList >	ShadowRenderableListIterator
Public Member Functions
	TerrainRenderable (const String &name, TerrainSceneManager *tsm)
	~TerrainRenderable ()
void	deleteGeometry ()
void	initialise (int startx, int startz, Real *pageHeightData)
	Initializes the TerrainRenderable.
virtual const String &	getMovableType (void) const
	Returns the type of the movable.
const AxisAlignedBox &	getBoundingBox (void) const
	Returns the bounding box of this TerrainRenderable.
virtual void	_notifyCurrentCamera (Camera *cam)
	Updates the level of detail to be used for rendering this TerrainRenderable based on the passed in Camera.
virtual void	_updateRenderQueue (RenderQueue *queue)
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
virtual void	getRenderOperation (RenderOperation &rend)
	Constructs a RenderOperation to render the TerrainRenderable.
virtual const MaterialPtr &	getMaterial (void) const
	Retrieves a weak reference to the material this renderable object uses.
virtual void	getWorldTransforms (Matrix4 *xform) const
	Gets the world transform matrix / matrices for this renderable object.
virtual const Quaternion &	getWorldOrientation (void) const
	Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
virtual const Vector3 &	getWorldPosition (void) const
	Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
int	getRenderLevel () const
	Returns the mipmap level that will be rendered for this frame.
void	setForcedRenderLevel (int i)
	Forces the LOD to the given level from this point on.
void	_getNormalAt (float x, float y, Vector3 *result)
	Calculates the normal at the given location.
float	getHeightAt (float x, float y)
	Returns the terrain height at the given coordinates.
bool	intersectSegment (const Vector3 &start, const Vector3 &end, Vector3 *result)
	Intersects the segment witht he terrain tile.
void	_setNeighbor (Neighbor n, TerrainRenderable *t)
	Sets the appropriate neighbor for this TerrainRenderable.
TerrainRenderable *	_getNeighbor (Neighbor n)
	Returns the neighbor TerrainRenderable.
void	setMaterial (const MaterialPtr &m)
void	_calculateNormals ()
	Calculates static normals for lighting the terrain.
void	_generateVertexLighting (const Vector3 &sun, ColourValue ambient)
	Generates terrain shadows and lighting using vertex colors.
Real	getSquaredViewDepth (const Camera *cam) const
	Overridden, see Renderable.
Real	getBoundingRadius (void) const
	Overridden from MovableObject.
const LightList &	getLights (void) const
	Remarks: Directional lights, which have no position, will always be first on this list.
void	_updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
	Overridden from Renderable to allow the morph LOD entry to be set.
uint32	getTypeFlags (void) const
	MovableObject.
virtual Technique *	getTechnique (void) const
	Retrieves a pointer to the Material Technique this renderable object uses.
virtual unsigned short	getNumWorldTransforms (void) const
	Returns the number of world transform matrices this renderable requires.
virtual bool	useIdentityProjection (void) const
	Returns whether or not to use an 'identity' projection.
virtual bool	useIdentityView (void) const
	Returns whether or not to use an 'identity' projection.
virtual bool	getNormaliseNormals (void) const
	Returns whether or not this Renderable wishes the hardware to normalise normals.
virtual const PlaneList &	getClipPlanes () const
virtual bool	getCastsShadows (void) const
	Method which reports whether this renderable would normally cast a shadow.
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.
const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index.
virtual void	setPolygonModeOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual bool	getPolygonModeOverrideable (void) const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual void	_notifyCreator (MovableObjectFactory *fact)
	Notify the object of it's creator (internal use only).
virtual void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only).
virtual SceneManager *	_getManager (void) const
	Get the manager of this object, if any (internal use only).
virtual const String &	getName (void) const
	Returns the name of this object.
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.
virtual void	_notifyAttached (Node *parent, bool isTagPoint=false)
	Internal method called to notify the object that it has been attached to a node.
virtual bool	isAttached (void) const
	Returns true if this object is attached to a SceneNode or TagPoint.
virtual 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 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.
virtual void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component.
virtual bool	isVisible (void) const
	Returns whether or not this object is supposed to be visible or not.
virtual void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered.
virtual Real	getRenderingDistance (void) const
	Gets the distance at which batches are no longer rendered.
virtual void	setUserObject (UserDefinedObject *obj)
	Call this to associate your own custom user object instance with this MovableObject.
virtual UserDefinedObject *	getUserObject (void)
	Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.
virtual void	setUserAny (const Any &anything)
	Sets any kind of user value on this object.
virtual const Any &	getUserAny (void) const
	Retrieves the custom user value associated with this object.
virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through.
virtual uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity, see setRenderQueueGroup for full details.
virtual Matrix4	_getParentNodeFullTransform (void) const
	return the full transformation of the parent sceneNode or the attachingPoint node
virtual void	setQueryFlags (uint32 flags)
	Sets the query flags for this object.
virtual void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
virtual void	removeQueryFlags (unsigned long flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
virtual uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object.
virtual void	setVisibilityFlags (uint32 flags)
	Sets the visiblity flags for 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	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
virtual uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object.
EdgeData *	getEdgeList (void)
	Define a default implementation of method from ShadowCaster which implements no shadows.
ShadowRenderableListIterator	getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light light, HardwareIndexBufferSharedPtr indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
	Define a default implementation of method from ShadowCaster which implements no shadows.
const AxisAlignedBox &	getLightCapBounds (void) const
	Overridden member from ShadowCaster.
const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
	Overridden member from ShadowCaster.
void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows.
bool	getCastShadows (void) const
	Returns whether shadow casting is enabled for this object.
Real	getPointExtrusionDistance (const Light *l) const
	Get the distance to extrude for a point/spot light.
const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object.
virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value.
Static Public Member Functions
void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances.
uint32	getDefaultQueryFlags (uint32 flags)
	Get the default query flags for all future MovableObject instances.
void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances.
uint32	getDefaultVisibilityFlags (uint32 flags)
	Get the default visibility flags for all future MovableObject instances.
void	extrudeVertices (HardwareVertexBufferSharedPtr vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
	Utility method for extruding vertices based on a light.
Protected Types
typedef std::map< size_t, Vector4 >	CustomParameterMap
typedef std::map< String, StringVector >	AnimableDictionaryMap
Protected Member Functions
size_t	_index (int x, int z) const
	Returns the index into the height array for the given coords.
float	_vertex (int x, int z, int n)
	Returns the vertex coord for the given coordinates.
int	_numNeighbors () const
bool	_hasNeighborRenderLevel (int i) const
void	_adjustRenderLevel (int i)
bool	_checkSize (int n)
void	_calculateMinLevelDist2 (Real C)
Real	_calculateCFactor ()
IndexData *	getIndexData (void)
	Gets the index data for this tile based on current settings.
IndexData *	generateTriStripIndexes (unsigned int stitchFlags)
	Internal method for generating stripified terrain indexes.
IndexData *	generateTriListIndexes (unsigned int stitchFlags)
	Internal method for generating triangle list terrain indexes.
int	stitchEdge (Neighbor neighbor, int hiLOD, int loLOD, bool omitFirstTri, bool omitLastTri, unsigned short **ppIdx)
	Utility method to generate stitching indexes on the edge of a tile.
HardwareVertexBufferSharedPtr	createDeltaBuffer (void)
	Create a blank delta buffer for usein morphing.
Real	getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
	Helper moethod for calculating extrusion distance.
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	generateShadowVolume (EdgeData edgeData, HardwareIndexBufferSharedPtr indexBuffer, 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 void	extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
	Utility method for extruding a bounding box.
virtual const String &	getAnimableDictionaryName (void) const
	Get the name of the animable dictionary for this class.
void	createAnimableDictionary (void) const
	Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
StringVector &	getAnimableValueNames (void)
	Get an updateable reference to animable value list.
virtual void	initialiseAnimableDictionary (StringVector &vec) const
	Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Protected Attributes
TerrainSceneManager *	mSceneManager
	Parent SceneManager.
const TerrainOptions *	mOptions
	Link to shared options.
VertexData *	mTerrain
int	mRenderLevel
	The current LOD level.
int	mLastNextLevel
	The previous 'next' LOD level down, for frame coherency.
Real	mLODMorphFactor
	The morph factor between this and the next LOD level down.
Real *	mMinLevelDistSqr
	List of squared distances at which LODs change.
TerrainRenderable *	mNeighbors [4]
	Connection to tiles four neighbours.
bool	mLightListDirty
	Whether light list need to re-calculate.
LightList	mLightList
	Cached light list.
Real	mBoundingRadius
	The bounding radius of this tile.
AxisAlignedBox	mBounds
	Bounding box of this tile.
Vector3	mCenter
	The center point of this tile.
MaterialPtr	mMaterial
	Current material used by this tile.
bool	mInit
	Whether this tile has been initialised.
HardwareVertexBufferSharedPtr	mMainBuffer
	The buffer with all the renderable geometry in it.
HardwareVertexBufferSharedPtr *	mDeltaBuffers
	Optional set of delta buffers, used to morph from one LOD to the next.
float *	mPositionBuffer
	System-memory buffer with just positions in it, for CPU operations.
int	mForcedRenderLevel
	Forced rendering LOD level, optional.
int	mNextLevelDown [10]
	Array of LOD indexes specifying which LOD is the next one down (deals with clustered error metrics which cause LODs to be skipped).
CustomParameterMap	mCustomParameters
bool	mPolygonModeOverrideable
String	mName
	Name of this object.
MovableObjectFactory *	mCreator
	Creator of this object (if created by a factory).
SceneManager *	mManager
	SceneManager holding this object (if applicable).
Node *	mParentNode
	node to which this object is attached
bool	mParentIsTagPoint
bool	mVisible
	Is this object visible?
Real	mUpperDistance
	Upper distance to still render.
Real	mSquaredUpperDistance
bool	mBeyondFarDistance
	Hidden because of distance?
Any	mUserAny
	User defined link to another object / value / whatever.
uint8	mRenderQueueID
	The render queue to use when rendering this object.
bool	mRenderQueueIDSet
	Flags whether the RenderQueue's default should be used.
uint32	mQueryFlags
	Flags determining whether this object is included / excluded from scene queries.
uint32	mVisibilityFlags
	Flags determining whether this object is visible (compared to SceneManager mask).
AxisAlignedBox	mWorldAABB
	Cached world AABB of this object.
Sphere	mWorldBoundingSphere
AxisAlignedBox	mWorldDarkCapBounds
	World space AABB of this object's dark cap.
bool	mCastShadows
	Does this object cast shadows?
Static Protected Attributes
String	mType
	The MovableObject type.
const PlaneList	msDummyPlaneList
uint32	msDefaultQueryFlags
	Default query flags.
uint32	msDefaultVisibilityFlags
	Default visibility flags.
AnimableDictionaryMap	msAnimableDictionary
	Static map of class name to list of animable value names.

Detailed Description

Represents a terrain tile.

Remarks:: A TerrainRenderable represents a tile used to render a block of terrain using the geomipmap approach for LOD.

Author:: Jon Anderson

Definition at line 158 of file OgreTerrainRenderable.h.

Member Typedef Documentation

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

Definition at line 202 of file OgreAnimable.h.

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

Definition at line 247 of file OgreRenderable.h.

typedef std::vector<ShadowRenderable*> Ogre::ShadowCaster::ShadowRenderableList [inherited]

Definition at line 121 of file OgreShadowCaster.h.

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator [inherited]

Definition at line 122 of file OgreShadowCaster.h.

Member Enumeration Documentation

enum Ogre::TerrainRenderable::Neighbor

Enumeration values:

NORTH

SOUTH

EAST

WEST

HERE

Definition at line 167 of file OgreTerrainRenderable.h.

Constructor & Destructor Documentation

Ogre::TerrainRenderable::TerrainRenderable ( const String & name,

TerrainSceneManager * tsm

)

Ogre::TerrainRenderable::~TerrainRenderable ( )

Member Function Documentation

void Ogre::TerrainRenderable::_adjustRenderLevel ( int i ) [protected]

Real Ogre::TerrainRenderable::_calculateCFactor ( ) [protected]

void Ogre::TerrainRenderable::_calculateMinLevelDist2 ( Real C ) [protected]

void Ogre::TerrainRenderable::_calculateNormals ( )

Calculates static normals for lighting the terrain.

bool Ogre::TerrainRenderable::_checkSize ( int n ) [protected]

void Ogre::TerrainRenderable::_generateVertexLighting ( const Vector3 & sun,

ColourValue ambient

)

Generates terrain shadows and lighting using vertex colors.

virtual SceneManager* Ogre::MovableObject::_getManager ( void ) const [virtual, inherited]

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

Definition at line 111 of file OgreMovableObject.h.

TerrainRenderable* Ogre::TerrainRenderable::_getNeighbor ( Neighbor n )

Returns the neighbor TerrainRenderable.

Definition at line 253 of file OgreTerrainRenderable.h.

void Ogre::TerrainRenderable::_getNormalAt ( float x,

float y,

Vector3 * result

)

Calculates the normal at the given location.

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

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

bool Ogre::TerrainRenderable::_hasNeighborRenderLevel ( int i ) const [protected]

Definition at line 322 of file OgreTerrainRenderable.h.

size_t Ogre::TerrainRenderable::_index ( int x,

int z

) const [protected]

Returns the index into the height array for the given coords.

Definition at line 297 of file OgreTerrainRenderable.h.

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, and Ogre::ParticleSystem.

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

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

Definition at line 107 of file OgreMovableObject.h.

virtual void Ogre::TerrainRenderable::_notifyCurrentCamera ( Camera * cam ) [virtual]

Updates the level of detail to be used for rendering this TerrainRenderable based on the passed in Camera.

Reimplemented from Ogre::MovableObject.

virtual void Ogre::MovableObject::_notifyManager ( SceneManager * man ) [virtual, inherited]

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

Definition at line 109 of file OgreMovableObject.h.

int Ogre::TerrainRenderable::_numNeighbors ( ) const [protected]

Definition at line 309 of file OgreTerrainRenderable.h.

void Ogre::TerrainRenderable::_setNeighbor ( Neighbor n,

TerrainRenderable * t

)

Sets the appropriate neighbor for this TerrainRenderable.
Neighbors are necessary to know when to bridge between LODs.
Definition at line 246 of file OgreTerrainRenderable.h.

void Ogre::TerrainRenderable::_updateCustomGpuParameter ( const GpuProgramParameters::AutoConstantEntry & constantEntry,

GpuProgramParameters * params

) const [virtual]

Overridden from Renderable to allow the morph LOD entry to be set.

Reimplemented from Ogre::Renderable.

virtual void Ogre::TerrainRenderable::_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.

float Ogre::TerrainRenderable::_vertex ( int x,

int z,

int n

) [protected]

Returns the vertex coord for the given coordinates.

Definition at line 303 of file OgreTerrainRenderable.h.

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 268 of file OgreMovableObject.h.
References Ogre::uint32.

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 296 of file OgreMovableObject.h.
References Ogre::uint32.

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 215 of file OgreAnimable.h.
References Ogre::StringVector.

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 281 of file OgreAnimable.h.
References Ogre::AnimableValuePtr, OGRE_EXCEPT, and Ogre::String.

HardwareVertexBufferSharedPtr Ogre::TerrainRenderable::createDeltaBuffer ( void ) [protected]

Create a blank delta buffer for usein morphing.

void Ogre::TerrainRenderable::deleteGeometry ( )

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

void Ogre::ShadowCaster::extrudeVertices ( 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 homogenous (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, ie 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,

HardwareIndexBufferSharedPtr indexBuffer,

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.

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

IndexData* Ogre::TerrainRenderable::generateTriListIndexes ( unsigned int stitchFlags ) [protected]

Internal method for generating triangle list terrain indexes.

IndexData* Ogre::TerrainRenderable::generateTriStripIndexes ( unsigned int stitchFlags ) [protected]

Internal method for generating stripified terrain indexes.

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 210 of file OgreAnimable.h.
References Ogre::String.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void ) const [inherited]

Gets a list of animable value names for this object.

Definition at line 256 of file OgreAnimable.h.
References OGRE_EXCEPT, and Ogre::StringVector.

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

Get an updateable reference to animable value list.

Definition at line 228 of file OgreAnimable.h.
References OGRE_EXCEPT, and Ogre::StringVector.

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

Returns the bounding box of this TerrainRenderable.

Implements Ogre::MovableObject.
Definition at line 193 of file OgreTerrainRenderable.h.

Real Ogre::TerrainRenderable::getBoundingRadius ( void ) const [virtual]

Overridden from MovableObject.

Implements Ogre::MovableObject.
Definition at line 279 of file OgreTerrainRenderable.h.
References Ogre::Real.

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

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.
Definition at line 339 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::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 150 of file OgreRenderable.h.

virtual const PlaneList& Ogre::Renderable::getClipPlanes ( ) const [virtual, inherited]

Definition at line 142 of file OgreRenderable.h.
References Ogre::PlaneList.

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

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

Parameters:

@see setCustomParaemter for full details.

Definition at line 176 of file OgreRenderable.h.
References OGRE_EXCEPT.

const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds ( const Light & light,

Real dirLightExtrusionDist

) const [virtual, inherited]

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

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

Get the default query flags for all future MovableObject instances.

Definition at line 283 of file OgreMovableObject.h.
References Ogre::uint32.

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

Get the default visibility flags for all future MovableObject instances.

Definition at line 311 of file OgreMovableObject.h.
References Ogre::uint32.

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::ManualObject, and Ogre::StaticGeometry::Region.
Definition at line 314 of file OgreMovableObject.h.

Real Ogre::ShadowCaster::getExtrusionDistance ( const Vector3 & objectPos,

const Light * light

) const [protected, inherited]

Helper moethod for calculating extrusion distance.

float Ogre::TerrainRenderable::getHeightAt ( float x,

float y

)

Returns the terrain height at the given coordinates.

IndexData* Ogre::TerrainRenderable::getIndexData ( void ) [protected]

Gets the index data for this tile based on current settings.

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

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

const LightList& Ogre::TerrainRenderable::getLights ( void ) const [virtual]

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

Implements Ogre::Renderable.

virtual const MaterialPtr& Ogre::TerrainRenderable::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.
Definition at line 211 of file OgreTerrainRenderable.h.

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

Returns the type of the movable.

Implements Ogre::MovableObject.
Definition at line 187 of file OgreTerrainRenderable.h.
References Ogre::String.

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

Returns the name of this object.

Reimplemented in Ogre::Camera.
Definition at line 114 of file OgreMovableObject.h.
References Ogre::String.

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

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

Reimplemented in Ogre::SubEntity.
Definition at line 134 of file OgreRenderable.h.

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, and Ogre::SubEntity.
Definition at line 104 of file OgreRenderable.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 239 of file OgreRenderable.h.

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

Returns the query flags relevant for this object.

Definition at line 275 of file OgreMovableObject.h.
References Ogre::uint32.

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

Gets the distance at which batches are no longer rendered.

Definition at line 208 of file OgreMovableObject.h.
References Ogre::Real.

int Ogre::TerrainRenderable::getRenderLevel ( ) const

Returns the mipmap level that will be rendered for this frame.

Definition at line 222 of file OgreTerrainRenderable.h.

virtual void Ogre::TerrainRenderable::getRenderOperation ( RenderOperation & rend ) [virtual]

Constructs a RenderOperation to render the TerrainRenderable.

Remarks:
Each TerrainRenderable has a block of vertices that represent the terrain. Index arrays are dynamically created for mipmap level, and then cached.

Implements Ogre::Renderable.

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

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

ShadowRenderableListIterator Ogre::MovableObject::getShadowVolumeRenderableIterator ( ShadowTechnique shadowTechnique,

const Light * light,

HardwareIndexBufferSharedPtr * indexBuffer,

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::ManualObject, and Ogre::StaticGeometry::Region.

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

Overridden, see Renderable.

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::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 69 of file OgreRenderable.h.

uint32 Ogre::TerrainRenderable::getTypeFlags ( void ) const [virtual]

MovableObject.

Reimplemented from Ogre::MovableObject.

virtual const Any& Ogre::MovableObject::getUserAny ( void ) const [virtual, inherited]

Retrieves the custom user value associated with this object.

Definition at line 236 of file OgreMovableObject.h.

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

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

Definition at line 220 of file OgreMovableObject.h.

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

Returns the visibility flags relevant for this object.

Definition at line 303 of file OgreMovableObject.h.
References Ogre::uint32.

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.

virtual const Quaternion& Ogre::TerrainRenderable::getWorldOrientation ( void ) const [virtual]

Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.

Implements Ogre::Renderable.

virtual const Vector3& Ogre::TerrainRenderable::getWorldPosition ( void ) const [virtual]

Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.

Implements Ogre::Renderable.

virtual void Ogre::TerrainRenderable::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 xform 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.

Implements Ogre::Renderable.

void Ogre::TerrainRenderable::initialise ( int startx,

int startz,

Real * pageHeightData

)

Initializes the TerrainRenderable.

Parameters:

startx,startz The starting points of the top-left of this tile, in terms of the number of vertices.

pageHeightData The source height data for the entire parent page

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector & vec ) 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 248 of file OgreAnimable.h.
References Ogre::StringVector.

bool Ogre::TerrainRenderable::intersectSegment ( const Vector3 & start,

const Vector3 & end,

Vector3 * result

)

Intersects the segment witht he terrain tile.

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::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.

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::StaticGeometry::Region.

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

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

Definition at line 272 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 300 of file OgreMovableObject.h.
References Ogre::uint32.

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 337 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 167 of file OgreRenderable.h.

void Ogre::MovableObject::setDefaultQueryFlags ( uint32 flags ) [static, inherited]

Set the default query flags for all future MovableObject instances.

Definition at line 279 of file OgreMovableObject.h.
References Ogre::uint32.

void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32 flags ) [static, inherited]

Set the default visibility flags for all future MovableObject instances.

Definition at line 307 of file OgreMovableObject.h.
References Ogre::uint32.

void Ogre::TerrainRenderable::setForcedRenderLevel ( int i )

Forces the LOD to the given level from this point on.

Definition at line 228 of file OgreTerrainRenderable.h.

void Ogre::TerrainRenderable::setMaterial ( const MaterialPtr & m )

Definition at line 259 of file OgreTerrainRenderable.h.

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 231 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 264 of file OgreMovableObject.h.
References Ogre::uint32.

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

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

Parameters:

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

Definition at line 202 of file OgreMovableObject.h.
References Ogre::Real.

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.

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

virtual void Ogre::MovableObject::setUserAny ( const Any & anything ) [virtual, inherited]

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.

Note:
This value is shared with setUserObject so don't use both!

Definition at line 232 of file OgreMovableObject.h.

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

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

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

Definition at line 216 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setVisibilityFlags ( uint32 flags ) [virtual, inherited]

Sets the visiblity flags for this object.

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

Definition at line 292 of file OgreMovableObject.h.
References Ogre::uint32.

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 visbility 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 visbility changes are best done using this method; large or more longer term changes are best done by detaching.

Reimplemented in Ogre::Light.

int Ogre::TerrainRenderable::stitchEdge ( Neighbor neighbor,

int hiLOD,

int loLOD,

bool omitFirstTri,

bool omitLastTri,

unsigned short ** ppIdx

) [protected]

Utility method to generate stitching indexes on the edge of a tile.

Parameters:

neighbor The neighbor direction to stitch

hiLOD The LOD of this tile

loLOD The LOD of the neighbor

omitFirstTri Whether the first tri of the stitch (always clockwise relative to the centre of this tile) is to be omitted because an adjoining edge is also being stitched

omitLastTri Whether the last tri of the stitch (always clockwise relative to the centre of this tile) is to be omitted because an adjoining edge is also being stitched

pIdx Pointer to a pointer to the index buffer to push the results into (this pointer will be updated)

Returns:
The number of indexes added

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 bool Ogre::Renderable::useIdentityProjection ( void ) const [virtual, inherited]

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

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

Reimplemented in Ogre::BorderRenderable, Ogre::OverlayElement, and Ogre::Rectangle2D.
Definition at line 114 of file OgreRenderable.h.

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

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

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

Reimplemented in Ogre::BorderRenderable, Ogre::OverlayElement, and Ogre::Rectangle2D.
Definition at line 124 of file OgreRenderable.h.

Member Data Documentation

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

Hidden because of distance?

Definition at line 68 of file OgreMovableObject.h.

Real Ogre::TerrainRenderable::mBoundingRadius [protected]

The bounding radius of this tile.

Definition at line 359 of file OgreTerrainRenderable.h.

AxisAlignedBox Ogre::TerrainRenderable::mBounds [protected]

Bounding box of this tile.

Definition at line 361 of file OgreTerrainRenderable.h.

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

Does this object cast shadows?

Definition at line 86 of file OgreMovableObject.h.

Vector3 Ogre::TerrainRenderable::mCenter [protected]

The center point of this tile.

Definition at line 363 of file OgreTerrainRenderable.h.

MovableObjectFactory* Ogre::MovableObject::mCreator [protected, inherited]

Creator of this object (if created by a factory).

Definition at line 56 of file OgreMovableObject.h.

CustomParameterMap Ogre::Renderable::mCustomParameters [protected, inherited]

Definition at line 248 of file OgreRenderable.h.

HardwareVertexBufferSharedPtr* Ogre::TerrainRenderable::mDeltaBuffers [protected]

Optional set of delta buffers, used to morph from one LOD to the next.

Definition at line 373 of file OgreTerrainRenderable.h.

int Ogre::TerrainRenderable::mForcedRenderLevel [protected]

Forced rendering LOD level, optional.

Definition at line 377 of file OgreTerrainRenderable.h.

bool Ogre::TerrainRenderable::mInit [protected]

Whether this tile has been initialised.

Definition at line 369 of file OgreTerrainRenderable.h.

int Ogre::TerrainRenderable::mLastNextLevel [protected]

The previous 'next' LOD level down, for frame coherency.

Definition at line 347 of file OgreTerrainRenderable.h.

LightList Ogre::TerrainRenderable::mLightList [mutable, protected]

Cached light list.

Definition at line 357 of file OgreTerrainRenderable.h.

bool Ogre::TerrainRenderable::mLightListDirty [mutable, protected]

Whether light list need to re-calculate.

Definition at line 355 of file OgreTerrainRenderable.h.

Real Ogre::TerrainRenderable::mLODMorphFactor [protected]

The morph factor between this and the next LOD level down.

Definition at line 349 of file OgreTerrainRenderable.h.

HardwareVertexBufferSharedPtr Ogre::TerrainRenderable::mMainBuffer [protected]

The buffer with all the renderable geometry in it.

Definition at line 371 of file OgreTerrainRenderable.h.

SceneManager* Ogre::MovableObject::mManager [protected, inherited]

SceneManager holding this object (if applicable).

Definition at line 58 of file OgreMovableObject.h.

MaterialPtr Ogre::TerrainRenderable::mMaterial [protected]

Current material used by this tile.

Definition at line 367 of file OgreTerrainRenderable.h.

Real* Ogre::TerrainRenderable::mMinLevelDistSqr [protected]

List of squared distances at which LODs change.

Definition at line 351 of file OgreTerrainRenderable.h.

String Ogre::MovableObject::mName [protected, inherited]

Name of this object.

Reimplemented in Ogre::Camera.
Definition at line 54 of file OgreMovableObject.h.

TerrainRenderable* Ogre::TerrainRenderable::mNeighbors[ 4 ] [protected]

Connection to tiles four neighbours.

Definition at line 353 of file OgreTerrainRenderable.h.

int Ogre::TerrainRenderable::mNextLevelDown[10] [protected]

Array of LOD indexes specifying which LOD is the next one down (deals with clustered error metrics which cause LODs to be skipped).

Definition at line 380 of file OgreTerrainRenderable.h.

const TerrainOptions* Ogre::TerrainRenderable::mOptions [protected]

Link to shared options.

Definition at line 294 of file OgreTerrainRenderable.h.

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

Definition at line 61 of file OgreMovableObject.h.

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

node to which this object is attached

Definition at line 60 of file OgreMovableObject.h.

bool Ogre::Renderable::mPolygonModeOverrideable [protected, inherited]

Definition at line 249 of file OgreRenderable.h.

float* Ogre::TerrainRenderable::mPositionBuffer [protected]

System-memory buffer with just positions in it, for CPU operations.

Definition at line 375 of file OgreTerrainRenderable.h.

uint32 Ogre::MovableObject::mQueryFlags [protected, inherited]

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

Definition at line 76 of file OgreMovableObject.h.

int Ogre::TerrainRenderable::mRenderLevel [protected]

The current LOD level.

Definition at line 345 of file OgreTerrainRenderable.h.

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

The render queue to use when rendering this object.

Definition at line 72 of file OgreMovableObject.h.

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

Flags whether the RenderQueue's default should be used.

Definition at line 74 of file OgreMovableObject.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary [static, protected, inherited]

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

Definition at line 204 of file OgreAnimable.h.

TerrainSceneManager* Ogre::TerrainRenderable::mSceneManager [protected]

Parent SceneManager.

Definition at line 292 of file OgreTerrainRenderable.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags [static, protected, inherited]

Default query flags.

Definition at line 90 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags [static, protected, inherited]

Default visibility flags.

Definition at line 92 of file OgreMovableObject.h.

const PlaneList Ogre::Renderable::msDummyPlaneList [static, protected, inherited]

Definition at line 246 of file OgreRenderable.h.

Real Ogre::MovableObject::mSquaredUpperDistance [protected, inherited]

Definition at line 66 of file OgreMovableObject.h.

VertexData* Ogre::TerrainRenderable::mTerrain [protected]

Definition at line 342 of file OgreTerrainRenderable.h.

String Ogre::TerrainRenderable::mType [static, protected]

The MovableObject type.

Definition at line 365 of file OgreTerrainRenderable.h.

Real Ogre::MovableObject::mUpperDistance [protected, inherited]

Upper distance to still render.

Definition at line 65 of file OgreMovableObject.h.

Any Ogre::MovableObject::mUserAny [protected, inherited]

User defined link to another object / value / whatever.

Definition at line 70 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::mVisibilityFlags [protected, inherited]

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

Definition at line 78 of file OgreMovableObject.h.

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

Is this object visible?

Definition at line 63 of file OgreMovableObject.h.

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

Cached world AABB of this object.

Reimplemented in Ogre::ParticleSystem.
Definition at line 80 of file OgreMovableObject.h.

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

Definition at line 82 of file OgreMovableObject.h.

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds [mutable, protected, inherited]

World space AABB of this object's dark cap.

Definition at line 84 of file OgreMovableObject.h.

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

OgreTerrainRenderable.h

Ogre::TerrainRenderable Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes