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

Ogre::TerrainRenderable Class Reference

Represents a terrain tile. More...

#include <OgreTerrainRenderable.h>

Inheritance diagram for Ogre::TerrainRenderable:

Ogre::Renderable Ogre::MovableObject Ogre::ShadowCaster 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< ShadowRenderableListShadowRenderableListIterator

Public Member Functions

 TerrainRenderable (const String &name)
 ~TerrainRenderable ()
void deleteGeometry ()
void initialise (int startx, int startz, Real *pageHeightData)
 Initializes the TerrainRenderable.

virtual const StringgetName (void) const
 Returns the name of the TerrainRenderable.

virtual const StringgetMovableType (void) const
 Returns the type of the movable.

const AxisAlignedBoxgetBoundingBox (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 MaterialPtrgetMaterial (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 QuaterniongetWorldOrientation (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 Vector3getWorldPosition (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 LightListgetLights (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.

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

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

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

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

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

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

virtual const PlaneListgetClipPlanes () 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 Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index.

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

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

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

virtual SceneNodegetParentSceneNode (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 AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates.

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

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

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

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

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

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

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

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

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

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

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

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

EdgeDatagetEdgeList (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 AxisAlignedBoxgetLightCapBounds (void) const
 Overridden member from ShadowCaster.

const AxisAlignedBoxgetDarkCapBounds (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.


Static Public Member Functions

TerrainBufferCache_getIndexCache (void)
 Get the static list of indexes cached (internal use only).

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

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)
void _initLevelIndexes ()
void _destroyLevelIndexes ()
bool _checkSize (int n)
void _calculateMinLevelDist2 (Real C)
Real _calculateCFactor ()
IndexDatagetIndexData (void)
 Gets the index data for this tile based on current settings.

IndexDatagenerateTriStripIndexes (unsigned int stitchFlags)
 Internal method for generating stripified terrain indexes.

IndexDatagenerateTriListIndexes (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.


Protected Attributes

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

RealmMinLevelDistSqr
 List of squared distances at which LODs change.

TerrainRenderablemNeighbors [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.

String mName
 Name of this renderable.

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.

HardwareVertexBufferSharedPtrmDeltaBuffers
 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 mRenderDetailOverrideable
NodemParentNode
 node to which this object is attached

bool mParentIsTagPoint
bool mVisible
 Is this object visible?

UserDefinedObjectmUserObject
 User defined object which is linked to this object.

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

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

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

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

TerrainBufferCache msIndexCache
 Static list of index buffers.

const TerrainOptionsmsOptions
 Static link to static shared options.

String mType
 The MovableObject type.

LevelArray mLevelIndex
 Shared array of IndexData (reuse indexes across tiles).

bool mLevelInit
 Whether the level array as been initialised yet.

const PlaneList msDummyPlaneList

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<size_t, Vector4> Ogre::Renderable::CustomParameterMap [protected, inherited]
 

Definition at line 251 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  ) 
 

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::_destroyLevelIndexes  )  [protected]
 

void Ogre::TerrainRenderable::_generateVertexLighting const Vector3 sun,
ColourValue  ambient
 

Generates terrain shadows and lighting using vertex colors.

TerrainBufferCache& Ogre::TerrainRenderable::_getIndexCache void   )  [static]
 

Get the static list of indexes cached (internal use only).

Definition at line 294 of file OgreTerrainRenderable.h.

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

Returns the neighbor TerrainRenderable.

Definition at line 258 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 327 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 302 of file OgreTerrainRenderable.h.

void Ogre::TerrainRenderable::_initLevelIndexes  )  [protected]
 

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::TerrainRenderable::_notifyCurrentCamera Camera cam  )  [virtual]
 

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

Implements Ogre::MovableObject.

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

Definition at line 314 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 251 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 308 of file OgreTerrainRenderable.h.

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

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

Definition at line 203 of file OgreMovableObject.h.

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.

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

Returns the bounding box of this TerrainRenderable.

Implements Ogre::MovableObject.

Definition at line 198 of file OgreTerrainRenderable.h.

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

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 284 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 238 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 154 of file OgreRenderable.h.

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

Definition at line 146 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 180 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.

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

Definition at line 213 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 216 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 192 of file OgreTerrainRenderable.h.

References Ogre::String.

virtual const String& Ogre::TerrainRenderable::getName void   )  const [virtual]
 

Returns the name of the TerrainRenderable.

Implements Ogre::MovableObject.

Definition at line 186 of file OgreTerrainRenderable.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 138 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 unsigned long Ogre::MovableObject::getQueryFlags void   )  const [virtual, inherited]
 

Returns the query flags relevant for this object.

Definition at line 210 of file OgreMovableObject.h.

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

Returns the preferred rasterisation mode of this renderable.

Reimplemented in Ogre::SubEntity.

Definition at line 135 of file OgreRenderable.h.

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

virtual bool Ogre::Renderable::getRenderDetailOverrideable 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 243 of file OgreRenderable.h.

int Ogre::TerrainRenderable::getRenderLevel  )  const
 

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

Definition at line 227 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 RenderQueueGroupID 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, 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.

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

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

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.

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 207 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 236 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 171 of file OgreRenderable.h.

void Ogre::TerrainRenderable::setForcedRenderLevel int  i  ) 
 

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

Definition at line 233 of file OgreTerrainRenderable.h.

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

Definition at line 264 of file OgreTerrainRenderable.h.

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

Sets the query flags for this object.

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

Definition at line 199 of file OgreMovableObject.h.

virtual void Ogre::Renderable::setRenderDetailOverrideable 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 235 of file OgreRenderable.h.

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

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

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

Real Ogre::TerrainRenderable::mBoundingRadius [protected]
 

The bounding radius of this tile.

Definition at line 367 of file OgreTerrainRenderable.h.

AxisAlignedBox Ogre::TerrainRenderable::mBounds [protected]
 

Bounding box of this tile.

Definition at line 369 of file OgreTerrainRenderable.h.

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

Does this object cast shadows?

Definition at line 67 of file OgreMovableObject.h.

Vector3 Ogre::TerrainRenderable::mCenter [protected]
 

The center point of this tile.

Definition at line 371 of file OgreTerrainRenderable.h.

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

Definition at line 252 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 387 of file OgreTerrainRenderable.h.

int Ogre::TerrainRenderable::mForcedRenderLevel [protected]
 

Forced rendering LOD level, optional.

Definition at line 391 of file OgreTerrainRenderable.h.

bool Ogre::TerrainRenderable::mInit [protected]
 

Whether this tile has been initialised.

Definition at line 379 of file OgreTerrainRenderable.h.

int Ogre::TerrainRenderable::mLastNextLevel [protected]
 

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

Definition at line 355 of file OgreTerrainRenderable.h.

LevelArray Ogre::TerrainRenderable::mLevelIndex [static, protected]
 

Shared array of IndexData (reuse indexes across tiles).

Definition at line 381 of file OgreTerrainRenderable.h.

bool Ogre::TerrainRenderable::mLevelInit [static, protected]
 

Whether the level array as been initialised yet.

Definition at line 383 of file OgreTerrainRenderable.h.

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

Cached light list.

Definition at line 365 of file OgreTerrainRenderable.h.

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

Whether light list need to re-calculate.

Definition at line 363 of file OgreTerrainRenderable.h.

Real Ogre::TerrainRenderable::mLODMorphFactor [protected]
 

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

Definition at line 357 of file OgreTerrainRenderable.h.

HardwareVertexBufferSharedPtr Ogre::TerrainRenderable::mMainBuffer [protected]
 

The buffer with all the renderable geometry in it.

Definition at line 385 of file OgreTerrainRenderable.h.

MaterialPtr Ogre::TerrainRenderable::mMaterial [protected]
 

Current material used by this tile.

Definition at line 377 of file OgreTerrainRenderable.h.

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

List of squared distances at which LODs change.

Definition at line 359 of file OgreTerrainRenderable.h.

String Ogre::TerrainRenderable::mName [protected]
 

Name of this renderable.

Definition at line 373 of file OgreTerrainRenderable.h.

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

Connection to tiles four neighbours.

Definition at line 361 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 394 of file OgreTerrainRenderable.h.

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

Definition at line 49 of file OgreMovableObject.h.

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

node to which this object is attached

Definition at line 48 of file OgreMovableObject.h.

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

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

Definition at line 389 of file OgreTerrainRenderable.h.

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

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

Definition at line 59 of file OgreMovableObject.h.

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

Definition at line 253 of file OgreRenderable.h.

int Ogre::TerrainRenderable::mRenderLevel [protected]
 

The current LOD level.

Definition at line 353 of file OgreTerrainRenderable.h.

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

The render queue to use when rendering this object.

Definition at line 55 of file OgreMovableObject.h.

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

Flags whether the RenderQueue's default should be used.

Definition at line 57 of file OgreMovableObject.h.

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

Definition at line 250 of file OgreRenderable.h.

TerrainBufferCache Ogre::TerrainRenderable::msIndexCache [static, protected]
 

Static list of index buffers.

Definition at line 297 of file OgreTerrainRenderable.h.

const TerrainOptions* Ogre::TerrainRenderable::msOptions [static, protected]
 

Static link to static shared options.

Definition at line 299 of file OgreTerrainRenderable.h.

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

Definition at line 350 of file OgreTerrainRenderable.h.

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

The MovableObject type.

Definition at line 375 of file OgreTerrainRenderable.h.

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

User defined object which is linked to this object.

Definition at line 53 of file OgreMovableObject.h.

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

Is this object visible?

Definition at line 51 of file OgreMovableObject.h.

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

Cached world AABB of this object.

Reimplemented in Ogre::ParticleSystem.

Definition at line 61 of file OgreMovableObject.h.

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

Definition at line 63 of file OgreMovableObject.h.

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

World space AABB of this object's dark cap.

Definition at line 65 of file OgreMovableObject.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:06:35 2006