OGRE  1.7
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Ogre::TerrainRenderable Class Reference

Represents a terrain tile. More...

#include <OgreTerrainRenderable.h>

+ Inheritance diagram for Ogre::TerrainRenderable:
+ Collaboration diagram for Ogre::TerrainRenderable:

Public Types

enum  Neighbor {
  NORTH = 0, SOUTH = 1, EAST = 2, WEST = 3,
  HERE = 4
}
 
typedef vector
< ShadowRenderable * >::type 
ShadowRenderableList
 
typedef VectorIterator
< ShadowRenderableList
ShadowRenderableListIterator
 

Public Member Functions

 TerrainRenderable (const String &name, TerrainSceneManager *tsm)
 
 ~TerrainRenderable ()
 
void _calculateNormals ()
 Calculates static normals for lighting the terrain. More...
 
void _generateVertexLighting (const Vector3 &sunlight, ColourValue ambient)
 Generates terrain shadows and lighting using vertex colors. More...
 
virtual MovableObjectFactory_getCreator (void) const
 Get the creator of this object, if any (internal use only) More...
 
virtual LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
virtual SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
TerrainRenderable_getNeighbor (Neighbor n)
 Returns the neighbor TerrainRenderable. More...
 
void _getNormalAt (float x, float y, Vector3 *result)
 Calculates the normal at the given location. More...
 
virtual const Matrix4_getParentNodeFullTransform (void) const
 return the full transformation of the parent sceneNode or the attachingPoint node More...
 
virtual void _notifyAttached (Node *parent, bool isTagPoint=false)
 Internal method called to notify the object that it has been attached to a node. More...
 
virtual void _notifyCreator (MovableObjectFactory *fact)
 Notify the object of it's creator (internal use only) More...
 
virtual void _notifyCurrentCamera (Camera *cam)
 Updates the level of detail to be used for rendering this TerrainRenderable based on the passed in Camera. More...
 
virtual void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _notifyMoved (void)
 Internal method called to notify the object that it has been moved. More...
 
void _setNeighbor (Neighbor n, TerrainRenderable *t)
 Sets the appropriate neighbor for this TerrainRenderable. More...
 
void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Overridden from Renderable to allow the morph LOD entry to be set. More...
 
virtual void _updateRenderQueue (RenderQueue *queue)
 Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...
 
virtual void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
virtual void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
void deleteGeometry ()
 
virtual void detachFromParent (void)
 Detaches an object from a parent SceneNode or TagPoint, if attached. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 
const AxisAlignedBoxgetBoundingBox (void) const
 Returns the bounding box of this TerrainRenderable. More...
 
Real getBoundingRadius (void) const
 Overridden from MovableObject. More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
const AxisAlignedBoxgetDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
 Overridden member from ShadowCaster. More...
 
EdgeDatagetEdgeList (void)
 Define a default implementation of method from ShadowCaster which implements no shadows. More...
 
float getHeightAt (float x, float y)
 Returns the terrain height at the given coordinates. More...
 
const AxisAlignedBoxgetLightCapBounds (void) const
 Overridden member from ShadowCaster. More...
 
virtual uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
const LightListgetLights (void) const
 Gets a list of lights, ordered relative to how close they are to this renderable. More...
 
virtual ListenergetListener (void) const
 Gets the current listener for this object. More...
 
virtual const MaterialPtrgetMaterial (void) const
 Retrieves a weak reference to the material this renderable object uses. More...
 
virtual const StringgetMovableType (void) const
 Returns the type of the movable. More...
 
virtual const StringgetName (void) const
 Returns the name of this object. More...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. More...
 
virtual NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
virtual SceneNodegetParentSceneNode (void) const
 Returns the scene node to which this object is attached. More...
 
Real getPointExtrusionDistance (const Light *l) const
 Get the distance to extrude for a point/spot light. More...
 
virtual bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
virtual uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
virtual Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
int getRenderLevel () const
 Returns the mipmap level that will be rendered for this frame. More...
 
virtual void getRenderOperation (RenderOperation &rend)
 Constructs a RenderOperation to render the TerrainRenderable. More...
 
virtual uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
virtual RenderSystemDatagetRenderSystemData () const
 Sets render system private data. More...
 
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. More...
 
Real getSquaredViewDepth (const Camera *cam) const
 Overridden, see Renderable. More...
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. More...
 
uint32 getTypeFlags (void) const
 
bool getUseIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection. More...
 
bool getUseIdentityView (void) const
 Returns whether or not to use an 'identity' view. More...
 
virtual const AnygetUserAny (void) const
 
virtual const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
virtual uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
virtual bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates. More...
 
virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object. More...
 
virtual void getWorldTransforms (Matrix4 *xform) const
 Gets the world transform matrix / matrices for this renderable object. More...
 
bool hasEdgeList (void)
 Define a default implementation of method from ShadowCaster which implements no shadows. More...
 
void initialise (int startx, int startz, Real *pageHeightData)
 Initializes the TerrainRenderable. More...
 
bool intersectSegment (const Vector3 &start, const Vector3 &end, Vector3 *result)
 Intersects the segment witht he terrain tile. More...
 
virtual bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint. More...
 
virtual bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
virtual bool isInScene (void) const
 Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More...
 
virtual bool isParentTagPoint () const
 Gets whether the parent node is a TagPoint (or a SceneNode) More...
 
virtual bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered. More...
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered. More...
 
virtual const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
virtual void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
virtual void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setCustomParameter (size_t index, const Vector4 &value)
 Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...
 
virtual void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
void setForcedRenderLevel (int i)
 Forces the LOD to the given level from this point on. More...
 
virtual void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
virtual void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setMaterial (const MaterialPtr &m)
 
virtual void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
virtual void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
virtual void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
virtual void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through. More...
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
virtual void setRenderSystemData (RenderSystemData *val) const
 gets render system private data More...
 
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection. More...
 
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view. More...
 
virtual void setUserAny (const Any &anything)
 
virtual void setUserAny (const Any &anything)
 
virtual void setVisibilityFlags (uint32 flags)
 Sets the visiblity flags for this object. More...
 
virtual void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...
 

Static Public Member Functions

static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 Utility method for extruding vertices based on a light. More...
 
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 

Protected Types

typedef map< String,
StringVector >::type 
AnimableDictionaryMap
 
typedef map< size_t, Vector4 >
::type 
CustomParameterMap
 
typedef vector
< HardwareVertexBufferSharedPtr >
::type 
VertexBufferList
 Optional set of delta buffers, used to morph from one LOD to the next. More...
 

Protected Member Functions

void _adjustRenderLevel (int i)
 
Real _calculateCFactor ()
 
void _calculateMinLevelDist2 (Real C)
 
bool _checkSize (int n)
 
StringVector_getAnimableValueNames (void)
 Get an updateable reference to animable value list. More...
 
bool _hasNeighborRenderLevel (int i) const
 
size_t _index (int x, int z) const
 Returns the index into the height array for the given coords. More...
 
int _numNeighbors () const
 
float _vertex (int x, int z, int n)
 Returns the vertex coord for the given coordinates. More...
 
void createAnimableDictionary (void) const
 Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More...
 
HardwareVertexBufferSharedPtr createDeltaBuffer (void)
 Create a blank delta buffer for usein morphing. More...
 
virtual void extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
 Utility method for extruding a bounding box. More...
 
virtual void generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags)
 Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it. More...
 
IndexDatagenerateTriListIndexes (unsigned int stitchFlags)
 Internal method for generating triangle list terrain indexes. More...
 
IndexDatagenerateTriStripIndexes (unsigned int stitchFlags)
 Internal method for generating stripified terrain indexes. More...
 
virtual const StringgetAnimableDictionaryName (void) const
 Get the name of the animable dictionary for this class. More...
 
Real getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
 Helper method for calculating extrusion distance. More...
 
IndexDatagetIndexData (void)
 Gets the index data for this tile based on current settings. More...
 
virtual void initialiseAnimableDictionary (StringVector &) const
 Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...
 
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. More...
 
virtual void updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)
 Tells the caster to perform the tasks necessary to update the edge data's light listing. More...
 

Protected Attributes

bool mBeyondFarDistance
 Hidden because of distance? More...
 
Real mBoundingRadius
 The bounding radius of this tile. More...
 
AxisAlignedBox mBounds
 Bounding box of this tile. More...
 
bool mCastShadows
 Does this object cast shadows? More...
 
Vector3 mCenter
 The center point of this tile. More...
 
MovableObjectFactorymCreator
 Creator of this object (if created by a factory) More...
 
CustomParameterMap mCustomParameters
 
bool mDebugDisplay
 Is debug display enabled? More...
 
VertexBufferList mDeltaBuffers
 
int mForcedRenderLevel
 Forced rendering LOD level, optional. More...
 
bool mInit
 Whether this tile has been initialised. More...
 
int mLastNextLevel
 The previous 'next' LOD level down, for frame coherency. More...
 
LightList mLightList
 Cached light list. More...
 
bool mLightListDirty
 Whether light list need to re-calculate. More...
 
ulong mLightListUpdated
 The last frame that this light list was updated in. More...
 
uint32 mLightMask
 the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More...
 
ListenermListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. */. More...
 
Real mLODMorphFactor
 The morph factor between this and the next LOD level down. More...
 
HardwareVertexBufferSharedPtr mMainBuffer
 The buffer with all the renderable geometry in it. More...
 
SceneManagermManager
 SceneManager holding this object (if applicable) More...
 
MaterialPtr mMaterial
 Current material used by this tile. More...
 
RealmMinLevelDistSqr
 List of squared distances at which LODs change. More...
 
String mName
 Name of this object. More...
 
TerrainRenderablemNeighbors [4]
 Connection to tiles four neighbours. More...
 
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) More...
 
const TerrainOptionsmOptions
 Link to shared options. More...
 
bool mParentIsTagPoint
 
NodemParentNode
 node to which this object is attached More...
 
bool mPolygonModeOverrideable
 
float * mPositionBuffer
 System-memory buffer with just positions in it, for CPU operations. More...
 
uint32 mQueryFlags
 Flags determining whether this object is included / excluded from scene queries. More...
 
bool mRenderingDisabled
 Does rendering this object disabled by listener? More...
 
int mRenderLevel
 The current LOD level. More...
 
uint8 mRenderQueueID
 The render queue to use when rendering this object. More...
 
bool mRenderQueueIDSet
 Flags whether the RenderQueue's default should be used. More...
 
ushort mRenderQueuePriority
 The render queue group to use when rendering this object. More...
 
bool mRenderQueuePrioritySet
 Flags whether the RenderQueue's default should be used. More...
 
RenderSystemDatamRenderSystemData
 
TerrainSceneManagermSceneManager
 Parent SceneManager. More...
 
Real mSquaredUpperDistance
 
VertexDatamTerrain
 
Real mUpperDistance
 Upper distance to still render. More...
 
bool mUseIdentityProjection
 
bool mUseIdentityView
 
UserObjectBindings mUserObjectBindings
 User objects binding. More...
 
UserObjectBindings mUserObjectBindings
 
uint32 mVisibilityFlags
 Flags determining whether this object is visible (compared to SceneManager mask) More...
 
bool mVisible
 Is this object visible? More...
 
AxisAlignedBox mWorldAABB
 Cached world AABB of this object. More...
 
Sphere mWorldBoundingSphere
 
AxisAlignedBox mWorldDarkCapBounds
 World space AABB of this object's dark cap. More...
 

Static Protected Attributes

static AnimableDictionaryMap msAnimableDictionary
 Static map of class name to list of animable value names. More...
 
static uint32 msDefaultQueryFlags
 Default query flags. More...
 
static uint32 msDefaultVisibilityFlags
 Default visibility flags. More...
 
static String mType
 The MovableObject type. More...
 

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 156 of file OgreTerrainRenderable.h.

Member Typedef Documentation

Definition at line 240 of file OgreAnimable.h.

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

Definition at line 395 of file OgreRenderable.h.

Definition at line 128 of file OgreShadowCaster.h.

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

Definition at line 372 of file OgreTerrainRenderable.h.

Member Enumeration Documentation

Enumerator
NORTH 
SOUTH 
EAST 
WEST 
HERE 

Definition at line 165 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 sunlight,
ColourValue  ambient 
)

Generates terrain shadows and lighting using vertex colors.

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

Get an updateable reference to animable value list.

Definition at line 266 of file OgreAnimable.h.

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

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

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

Definition at line 183 of file OgreMovableObject.h.

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

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

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

Definition at line 472 of file OgreMovableObject.h.

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

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

Definition at line 187 of file OgreMovableObject.h.

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

Returns the neighbor TerrainRenderable.

Definition at line 252 of file OgreTerrainRenderable.h.

void Ogre::TerrainRenderable::_getNormalAt ( float  x,
float  y,
Vector3 result 
)

Calculates the normal at the given location.

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

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

bool Ogre::TerrainRenderable::_hasNeighborRenderLevel ( int  i) const
inlineprotected

Definition at line 321 of file OgreTerrainRenderable.h.

size_t Ogre::TerrainRenderable::_index ( int  x,
int  z 
) const
inlineprotected

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

Definition at line 296 of file OgreTerrainRenderable.h.

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

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

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

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

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

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

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

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

Definition at line 185 of file OgreMovableObject.h.

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

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

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

int Ogre::TerrainRenderable::_numNeighbors ( ) const
inlineprotected

Definition at line 308 of file OgreTerrainRenderable.h.

void Ogre::TerrainRenderable::_setNeighbor ( Neighbor  n,
TerrainRenderable t 
)
inline

Sets the appropriate neighbor for this TerrainRenderable.

Neighbors are necessary to know when to bridge between LODs.

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

Returns the vertex coord for the given coordinates.

Definition at line 302 of file OgreTerrainRenderable.h.

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

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

Definition at line 377 of file OgreMovableObject.h.

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

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

Definition at line 405 of file OgreMovableObject.h.

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

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

Definition at line 253 of file OgreAnimable.h.

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

Create a reference-counted AnimableValuePtr for the named value.

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

Reimplemented in Ogre::Light.

Definition at line 319 of file OgreAnimable.h.

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

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

Create a blank delta buffer for usein morphing.

void Ogre::TerrainRenderable::deleteGeometry ( )
virtual void Ogre::MovableObject::detachFromParent ( void  )
virtualinherited

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

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

Utility method for extruding a bounding box.

Parameters
boxOriginal bounding box, will be updated in-place
lightPos4D light position in object space, when w=0.0f this represents a directional light
extrudeDistThe distance to extrude
static void Ogre::ShadowCaster::extrudeVertices ( const HardwareVertexBufferSharedPtr vertexBuffer,
size_t  originalVertexCount,
const Vector4 lightPos,
Real  extrudeDist 
)
staticinherited

Utility method for extruding vertices based on a light.

Remarks
Unfortunately, because D3D cannot handle homogeneous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.
Parameters
vertexBufferThe vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
originalVertexCountThe count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
lightPos4D light position in object space, when w=0.0f this represents a directional light
extrudeDistThe distance to extrude
virtual void Ogre::ShadowCaster::generateShadowVolume ( EdgeData edgeData,
const HardwareIndexBufferSharedPtr indexBuffer,
const Light light,
ShadowRenderableList shadowRenderables,
unsigned long  flags 
)
protectedvirtualinherited

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

Parameters
edgeDataThe edge information to use
indexBufferThe buffer into which to write data into; current contents are assumed to be discardable.
lightThe light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
shadowRenderablesA list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
flagsAdditional 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
inlineprotectedvirtualinherited

Get the name of the animable dictionary for this class.

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

Reimplemented in Ogre::Light.

Definition at line 248 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

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

Gets a list of animable value names for this object.

Definition at line 294 of file OgreAnimable.h.

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

const AxisAlignedBox& Ogre::TerrainRenderable::getBoundingBox ( void  ) const
inlinevirtual

Returns the bounding box of this TerrainRenderable.

Implements Ogre::MovableObject.

Definition at line 191 of file OgreTerrainRenderable.h.

Real Ogre::TerrainRenderable::getBoundingRadius ( void  ) const
inlinevirtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

Definition at line 278 of file OgreTerrainRenderable.h.

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

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 502 of file OgreMovableObject.h.

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

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

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

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

Definition at line 223 of file OgreRenderable.h.

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

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

Parameters
see setCustomParameter for full details.

Definition at line 249 of file OgreRenderable.h.

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

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

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )
inlinestaticinherited

Get the default query flags for all future MovableObject instances.

Definition at line 392 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )
inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 420 of file OgreMovableObject.h.

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

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 475 of file OgreMovableObject.h.

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

Helper method 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
virtualinherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

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

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

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

Definition at line 457 of file OgreMovableObject.h.

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

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

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

Implements Ogre::Renderable.

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

Gets the current listener for this object.

Definition at line 431 of file OgreMovableObject.h.

virtual const MaterialPtr& Ogre::TerrainRenderable::getMaterial ( void  ) const
inlinevirtual

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 213 of file OgreTerrainRenderable.h.

virtual const String& Ogre::TerrainRenderable::getMovableType ( void  ) const
inlinevirtual

Returns the type of the movable.

Implements Ogre::MovableObject.

Definition at line 185 of file OgreTerrainRenderable.h.

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

Returns the name of this object.

Definition at line 190 of file OgreMovableObject.h.

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

Returns the number of world transform matrices this renderable requires.

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

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

Definition at line 152 of file OgreRenderable.h.

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

Returns the node to which this object is attached.

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

Returns the scene node to which this object is attached.

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

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

Implements Ogre::ShadowCaster.

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

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 313 of file OgreRenderable.h.

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

Returns the query flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 384 of file OgreMovableObject.h.

bool Ogre::MovableObject::getReceivesShadows ( )
inherited

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

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

Gets the distance at which batches are no longer rendered.

Definition at line 301 of file OgreMovableObject.h.

int Ogre::TerrainRenderable::getRenderLevel ( ) const
inline

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

Definition at line 221 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
virtualinherited

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

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

Sets render system private data.

Remarks
This should only be used by a render system

Definition at line 380 of file OgreRenderable.h.

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

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Real Ogre::TerrainRenderable::getSquaredViewDepth ( const Camera cam) const
virtual

Overridden, see Renderable.

Implements Ogre::Renderable.

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

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

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

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

Definition at line 93 of file OgreRenderable.h.

uint32 Ogre::TerrainRenderable::getTypeFlags ( void  ) const
virtual
See also
MovableObject

Reimplemented from Ogre::MovableObject.

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

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

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

Definition at line 177 of file OgreRenderable.h.

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

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

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

Definition at line 202 of file OgreRenderable.h.

virtual const Any& Ogre::MovableObject::getUserAny ( void  ) const
inlinevirtualinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 315 of file OgreMovableObject.h.

virtual const Any& Ogre::Renderable::getUserAny ( void  ) const
inlinevirtualinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 330 of file OgreRenderable.h.

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

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

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

See also
UserObjectBindings::setUserAny.

Definition at line 321 of file OgreMovableObject.h.

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

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

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

See also
UserObjectBindings::setUserAny.

Definition at line 327 of file OgreMovableObject.h.

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

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

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

See also
UserObjectBindings::setUserAny.

Definition at line 336 of file OgreRenderable.h.

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

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

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

See also
UserObjectBindings::setUserAny.

Definition at line 342 of file OgreRenderable.h.

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

Returns the visibility flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 412 of file OgreMovableObject.h.

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

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

Remarks
Returns the value set by MovableObject::setVisible only.
virtual const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox ( bool  derive = false) const
virtualinherited

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

Implements Ogre::ShadowCaster.

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

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

Retrieves the worldspace bounding sphere for this object.

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

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.
Note
Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.
See also
Matrix4::isAffine.

Implements Ogre::Renderable.

bool Ogre::MovableObject::hasEdgeList ( void  )
inlinevirtualinherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 477 of file OgreMovableObject.h.

void Ogre::TerrainRenderable::initialise ( int  startx,
int  startz,
Real pageHeightData 
)

Initializes the TerrainRenderable.

Parameters
startx,startzThe starting points of the top-left of this tile, in terms of the number of vertices.
pageHeightDataThe source height data for the entire parent page
virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector ) const
inlineprotectedvirtualinherited

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

Reimplemented in Ogre::Light.

Definition at line 286 of file OgreAnimable.h.

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
virtualinherited

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

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

Gets whether debug display of this object is enabled.

Definition at line 546 of file OgreMovableObject.h.

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

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

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

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

Definition at line 213 of file OgreMovableObject.h.

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

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

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

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

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

Definition at line 95 of file OgreMemoryAllocatedObject.h.

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

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

Definition at line 112 of file OgreMemoryAllocatedObject.h.

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

Definition at line 118 of file OgreMemoryAllocatedObject.h.

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

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

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

Definition at line 72 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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

Called immediately after the Renderable has been rendered.

Definition at line 127 of file OgreRenderable.h.

virtual bool Ogre::Renderable::preRender ( SceneManager sm,
RenderSystem rsys 
)
inlinevirtualinherited

Called just prior to the Renderable being rendered.

Remarks
OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.
This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.
Returns
true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Definition at line 122 of file OgreRenderable.h.

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

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

Remarks
By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.
The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (
See also
SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.
This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.
Returns
The list of lights use to lighting this object.
virtual void Ogre::MovableObject::removeQueryFlags ( uint32  flags)
inlinevirtualinherited

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

Definition at line 381 of file OgreMovableObject.h.

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

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

Definition at line 409 of file OgreMovableObject.h.

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

Sets whether or not this object will cast shadows.

Remarks
This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.
Note
This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

Definition at line 500 of file OgreMovableObject.h.

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

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

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

Definition at line 240 of file OgreRenderable.h.

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

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

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

Definition at line 544 of file OgreMovableObject.h.

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

Set the default query flags for all future MovableObject instances.

Definition at line 388 of file OgreMovableObject.h.

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

Set the default visibility flags for all future MovableObject instances.

Definition at line 416 of file OgreMovableObject.h.

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

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

Definition at line 227 of file OgreTerrainRenderable.h.

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

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

Remarks
This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object
virtual void Ogre::MovableObject::setListener ( Listener listener)
inlinevirtualinherited

Sets a listener for this object.

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

Definition at line 427 of file OgreMovableObject.h.

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

Definition at line 258 of file OgreTerrainRenderable.h.

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

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

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

Definition at line 305 of file OgreRenderable.h.

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

Sets the query flags for this object.

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

Definition at line 373 of file OgreMovableObject.h.

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

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

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

Definition at line 295 of file OgreMovableObject.h.

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

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

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

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

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

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

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
priorityThe priority within a group to use.

Reimplemented in Ogre::Entity.

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

gets render system private data

Remarks
This should only be used by a render system

Definition at line 388 of file OgreRenderable.h.

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

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

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

Definition at line 163 of file OgreRenderable.h.

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

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

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

Definition at line 188 of file OgreRenderable.h.

virtual void Ogre::MovableObject::setUserAny ( const Any anything)
inlinevirtualinherited
Deprecated:
use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

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

Definition at line 310 of file OgreMovableObject.h.

virtual void Ogre::Renderable::setUserAny ( const Any anything)
inlinevirtualinherited
Deprecated:
use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

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

Definition at line 325 of file OgreRenderable.h.

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

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

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

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

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

Reimplemented in Ogre::Light.

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
neighborThe neighbor direction to stitch
hiLODThe LOD of this tile
loLODThe LOD of the neighbor
omitFirstTriWhether 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
omitLastTriWhether 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
pIdxPointer 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 
)
protectedvirtualinherited

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

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

Parameters
edgeDataThe edge information to update
lightPos4D vector representing the light, a directional light has w=0.0
void Ogre::TerrainRenderable::visitRenderables ( Renderable::Visitor visitor,
bool  debugRenderables = false 
)
virtual

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

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

Implements Ogre::MovableObject.

Member Data Documentation

bool Ogre::MovableObject::mBeyondFarDistance
protectedinherited

Hidden because of distance?

Definition at line 125 of file OgreMovableObject.h.

Real Ogre::TerrainRenderable::mBoundingRadius
protected

The bounding radius of this tile.

Definition at line 358 of file OgreTerrainRenderable.h.

AxisAlignedBox Ogre::TerrainRenderable::mBounds
protected

Bounding box of this tile.

Definition at line 360 of file OgreTerrainRenderable.h.

bool Ogre::MovableObject::mCastShadows
protectedinherited

Does this object cast shadows?

Definition at line 147 of file OgreMovableObject.h.

Vector3 Ogre::TerrainRenderable::mCenter
protected

The center point of this tile.

Definition at line 362 of file OgreTerrainRenderable.h.

MovableObjectFactory* Ogre::MovableObject::mCreator
protectedinherited

Creator of this object (if created by a factory)

Definition at line 111 of file OgreMovableObject.h.

CustomParameterMap Ogre::Renderable::mCustomParameters
protectedinherited

Definition at line 396 of file OgreRenderable.h.

bool Ogre::MovableObject::mDebugDisplay
protectedinherited

Is debug display enabled?

Definition at line 120 of file OgreMovableObject.h.

VertexBufferList Ogre::TerrainRenderable::mDeltaBuffers
protected

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 368 of file OgreTerrainRenderable.h.

int Ogre::TerrainRenderable::mLastNextLevel
protected

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

Definition at line 346 of file OgreTerrainRenderable.h.

LightList Ogre::TerrainRenderable::mLightList
mutableprotected

Cached light list.

Definition at line 356 of file OgreTerrainRenderable.h.

bool Ogre::TerrainRenderable::mLightListDirty
mutableprotected

Whether light list need to re-calculate.

Definition at line 354 of file OgreTerrainRenderable.h.

ulong Ogre::MovableObject::mLightListUpdated
mutableprotectedinherited

The last frame that this light list was updated in.

Definition at line 157 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::mLightMask
protectedinherited

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

Definition at line 160 of file OgreMovableObject.h.

Listener* Ogre::MovableObject::mListener
protectedinherited

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

Definition at line 152 of file OgreMovableObject.h.

Real Ogre::TerrainRenderable::mLODMorphFactor
protected

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

Definition at line 348 of file OgreTerrainRenderable.h.

HardwareVertexBufferSharedPtr Ogre::TerrainRenderable::mMainBuffer
protected

The buffer with all the renderable geometry in it.

Definition at line 370 of file OgreTerrainRenderable.h.

SceneManager* Ogre::MovableObject::mManager
protectedinherited

SceneManager holding this object (if applicable)

Definition at line 113 of file OgreMovableObject.h.

MaterialPtr Ogre::TerrainRenderable::mMaterial
protected

Current material used by this tile.

Definition at line 366 of file OgreTerrainRenderable.h.

Real* Ogre::TerrainRenderable::mMinLevelDistSqr
protected

List of squared distances at which LODs change.

Definition at line 350 of file OgreTerrainRenderable.h.

String Ogre::MovableObject::mName
protectedinherited

Name of this object.

Definition at line 109 of file OgreMovableObject.h.

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

Connection to tiles four neighbours.

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

bool Ogre::MovableObject::mParentIsTagPoint
protectedinherited

Definition at line 116 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode
protectedinherited

node to which this object is attached

Definition at line 115 of file OgreMovableObject.h.

bool Ogre::Renderable::mPolygonModeOverrideable
protectedinherited

Definition at line 397 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
protectedinherited

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

Definition at line 137 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderingDisabled
protectedinherited

Does rendering this object disabled by listener?

Definition at line 150 of file OgreMovableObject.h.

int Ogre::TerrainRenderable::mRenderLevel
protected

The current LOD level.

Definition at line 344 of file OgreTerrainRenderable.h.

uint8 Ogre::MovableObject::mRenderQueueID
protectedinherited

The render queue to use when rendering this object.

Definition at line 129 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderQueueIDSet
protectedinherited

Flags whether the RenderQueue's default should be used.

Definition at line 131 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority
protectedinherited

The render queue group to use when rendering this object.

Definition at line 133 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderQueuePrioritySet
protectedinherited

Flags whether the RenderQueue's default should be used.

Definition at line 135 of file OgreMovableObject.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData
mutableprotectedinherited

Definition at line 401 of file OgreRenderable.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary
staticprotectedinherited

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

Definition at line 242 of file OgreAnimable.h.

TerrainSceneManager* Ogre::TerrainRenderable::mSceneManager
protected

Parent SceneManager.

Definition at line 291 of file OgreTerrainRenderable.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags
staticprotectedinherited

Default query flags.

Definition at line 164 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags
staticprotectedinherited

Default visibility flags.

Definition at line 166 of file OgreMovableObject.h.

Real Ogre::MovableObject::mSquaredUpperDistance
protectedinherited

Definition at line 123 of file OgreMovableObject.h.

VertexData* Ogre::TerrainRenderable::mTerrain
protected

Definition at line 341 of file OgreTerrainRenderable.h.

String Ogre::TerrainRenderable::mType
staticprotected

The MovableObject type.

Definition at line 364 of file OgreTerrainRenderable.h.

Real Ogre::MovableObject::mUpperDistance
protectedinherited

Upper distance to still render.

Definition at line 122 of file OgreMovableObject.h.

bool Ogre::Renderable::mUseIdentityProjection
protectedinherited

Definition at line 398 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView
protectedinherited

Definition at line 399 of file OgreRenderable.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings
protectedinherited

User objects binding.

Definition at line 127 of file OgreMovableObject.h.

UserObjectBindings Ogre::Renderable::mUserObjectBindings
protectedinherited

Definition at line 400 of file OgreRenderable.h.

uint32 Ogre::MovableObject::mVisibilityFlags
protectedinherited

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

Definition at line 139 of file OgreMovableObject.h.

bool Ogre::MovableObject::mVisible
protectedinherited

Is this object visible?

Definition at line 118 of file OgreMovableObject.h.

AxisAlignedBox Ogre::MovableObject::mWorldAABB
mutableprotectedinherited

Cached world AABB of this object.

Definition at line 141 of file OgreMovableObject.h.

Sphere Ogre::MovableObject::mWorldBoundingSphere
mutableprotectedinherited

Definition at line 143 of file OgreMovableObject.h.

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds
mutableprotectedinherited

World space AABB of this object's dark cap.

Definition at line 145 of file OgreMovableObject.h.


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