Represents a terrain tile. More...
#include <OgreTerrainRenderable.h>
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 StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. More... | |
const AxisAlignedBox & | getBoundingBox (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 Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const |
Overridden member from ShadowCaster. More... | |
EdgeData * | getEdgeList (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 AxisAlignedBox & | getLightCapBounds (void) const |
Overridden member from ShadowCaster. More... | |
virtual uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. More... | |
const LightList & | getLights (void) const |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
virtual Listener * | getListener (void) const |
Gets the current listener for this object. More... | |
virtual const MaterialPtr & | getMaterial (void) const |
Retrieves a weak reference to the material this renderable object uses. More... | |
virtual const String & | getMovableType (void) const |
Returns the type of the movable. More... | |
virtual const String & | getName (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 Node * | getParentNode (void) const |
Returns the node to which this object is attached. More... | |
virtual SceneNode * | getParentSceneNode (void) const |
Returns the scene node to which this object is attached. More... | |
Real | getPointExtrusionDistance (const Light *l) const |
Get the distance to extrude for a point/spot light. More... | |
virtual bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
virtual uint32 | getQueryFlags (void) const |
Returns the query flags relevant for this object. More... | |
bool | getReceivesShadows () |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More... | |
virtual Real | getRenderingDistance (void) const |
Gets the distance at which batches are no longer rendered. More... | |
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 RenderSystemData * | getRenderSystemData () 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 Technique * | getTechnique (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 Any & | getUserAny (void) const |
virtual const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
virtual 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 AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const |
Retrieves the axis-aligned bounding box for this object in world coordinates. More... | |
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const |
Retrieves the worldspace bounding sphere for this object. More... | |
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 LightList & | queryLights (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... | |
IndexData * | generateTriListIndexes (unsigned int stitchFlags) |
Internal method for generating triangle list terrain indexes. More... | |
IndexData * | generateTriStripIndexes (unsigned int stitchFlags) |
Internal method for generating stripified terrain indexes. More... | |
virtual const String & | getAnimableDictionaryName (void) const |
Get the name of the animable dictionary for this class. More... | |
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const |
Helper method for calculating extrusion distance. More... | |
IndexData * | getIndexData (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... | |
MovableObjectFactory * | mCreator |
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... | |
Listener * | mListener |
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... | |
SceneManager * | mManager |
SceneManager holding this object (if applicable) More... | |
MaterialPtr | mMaterial |
Current material used by this tile. More... | |
Real * | mMinLevelDistSqr |
List of squared distances at which LODs change. More... | |
String | mName |
Name of this object. More... | |
TerrainRenderable * | mNeighbors [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 TerrainOptions * | mOptions |
Link to shared options. More... | |
bool | mParentIsTagPoint |
Node * | mParentNode |
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... | |
RenderSystemData * | mRenderSystemData |
TerrainSceneManager * | mSceneManager |
Parent SceneManager. More... | |
Real | mSquaredUpperDistance |
VertexData * | mTerrain |
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... | |
Represents a terrain tile.
Definition at line 156 of file OgreTerrainRenderable.h.
|
protectedinherited |
Definition at line 240 of file OgreAnimable.h.
|
protectedinherited |
Definition at line 395 of file OgreRenderable.h.
|
inherited |
Definition at line 128 of file OgreShadowCaster.h.
|
inherited |
Definition at line 129 of file OgreShadowCaster.h.
|
protected |
Optional set of delta buffers, used to morph from one LOD to the next.
Definition at line 372 of file OgreTerrainRenderable.h.
Enumerator | |
---|---|
NORTH | |
SOUTH | |
EAST | |
WEST | |
HERE |
Definition at line 165 of file OgreTerrainRenderable.h.
Ogre::TerrainRenderable::TerrainRenderable | ( | const String & | name, |
TerrainSceneManager * | tsm | ||
) |
Ogre::TerrainRenderable::~TerrainRenderable | ( | ) |
|
protected |
|
protected |
|
protected |
void Ogre::TerrainRenderable::_calculateNormals | ( | ) |
Calculates static normals for lighting the terrain.
|
protected |
void Ogre::TerrainRenderable::_generateVertexLighting | ( | const Vector3 & | sunlight, |
ColourValue | ambient | ||
) |
Generates terrain shadows and lighting using vertex colors.
|
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.
|
inlinevirtualinherited |
Get the creator of this object, if any (internal use only)
Definition at line 183 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns a pointer to the current list of lights for this object.
Definition at line 472 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Get the manager of this object, if any (internal use only)
Definition at line 187 of file OgreMovableObject.h.
|
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.
|
virtualinherited |
return the full transformation of the parent sceneNode or the attachingPoint node
|
inlineprotected |
Definition at line 321 of file OgreTerrainRenderable.h.
|
inlineprotected |
Returns the index into the height array for the given coords.
Definition at line 296 of file OgreTerrainRenderable.h.
|
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().
|
inlinevirtualinherited |
Notify the object of it's creator (internal use only)
Definition at line 181 of file OgreMovableObject.h.
|
virtual |
Updates the level of detail to be used for rendering this TerrainRenderable based on the passed in Camera.
Reimplemented from Ogre::MovableObject.
|
inlinevirtualinherited |
Notify the object of it's manager (internal use only)
Definition at line 185 of file OgreMovableObject.h.
|
virtualinherited |
Internal method called to notify the object that it has been moved.
Reimplemented in Ogre::Light, Ogre::PortalBase, and Ogre::PCZLight.
|
inlineprotected |
Definition at line 308 of file OgreTerrainRenderable.h.
|
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.
|
virtual |
Overridden from Renderable to allow the morph LOD entry to be set.
Reimplemented from Ogre::Renderable.
|
virtual |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
Implements Ogre::MovableObject.
|
inlineprotected |
Returns the vertex coord for the given coordinates.
Definition at line 302 of file OgreTerrainRenderable.h.
|
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.
|
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.
|
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.
|
inlinevirtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
Definition at line 319 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
protected |
Create a blank delta buffer for usein morphing.
void Ogre::TerrainRenderable::deleteGeometry | ( | ) |
|
virtualinherited |
|
protectedvirtualinherited |
Utility method for extruding a bounding box.
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 |
|
staticinherited |
Utility method for extruding vertices based on a light.
vertexBuffer | The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long. |
originalVertexCount | The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer. |
lightPos | 4D light position in object space, when w=0.0f this represents a directional light |
extrudeDist | The distance to extrude |
|
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.
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 |
|
protected |
Internal method for generating triangle list terrain indexes.
|
protected |
Internal method for generating stripified terrain indexes.
|
inlineprotectedvirtualinherited |
Get the name of the animable dictionary for this class.
Reimplemented in Ogre::Light.
Definition at line 248 of file OgreAnimable.h.
References Ogre::StringUtil::BLANK.
|
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.
|
inlinevirtual |
Returns the bounding box of this TerrainRenderable.
Implements Ogre::MovableObject.
Definition at line 191 of file OgreTerrainRenderable.h.
|
inlinevirtual |
Overridden from MovableObject.
Implements Ogre::MovableObject.
Definition at line 278 of file OgreTerrainRenderable.h.
|
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.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 223 of file OgreRenderable.h.
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
see setCustomParameter for full details. |
Definition at line 249 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
Definition at line 392 of file OgreMovableObject.h.
|
inlinestaticinherited |
Get the default visibility flags for all future MovableObject instances.
Definition at line 420 of file OgreMovableObject.h.
|
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.
|
protectedinherited |
Helper method for calculating extrusion distance.
float Ogre::TerrainRenderable::getHeightAt | ( | float | x, |
float | y | ||
) |
Returns the terrain height at the given coordinates.
|
protected |
Gets the index data for this tile based on current settings.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Get a bitwise mask which will filter the lights affecting this object.
Definition at line 457 of file OgreMovableObject.h.
|
virtual |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
Gets the current listener for this object.
Definition at line 431 of file OgreMovableObject.h.
|
inlinevirtual |
Retrieves a weak reference to the material this renderable object uses.
Implements Ogre::Renderable.
Definition at line 213 of file OgreTerrainRenderable.h.
|
inlinevirtual |
Returns the type of the movable.
Implements Ogre::MovableObject.
Definition at line 185 of file OgreTerrainRenderable.h.
|
inlinevirtualinherited |
Returns the name of this object.
Definition at line 190 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 152 of file OgreRenderable.h.
|
virtualinherited |
Returns the node to which this object is attached.
|
virtualinherited |
Returns the scene node to which this object is attached.
Get the distance to extrude for a point/spot light.
Implements Ogre::ShadowCaster.
|
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.
|
inlinevirtualinherited |
Returns the query flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 384 of file OgreMovableObject.h.
|
inherited |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
|
inlinevirtualinherited |
Gets the distance at which batches are no longer rendered.
Definition at line 301 of file OgreMovableObject.h.
|
inline |
Returns the mipmap level that will be rendered for this frame.
Definition at line 221 of file OgreTerrainRenderable.h.
|
virtual |
Constructs a RenderOperation to render the TerrainRenderable.
Implements Ogre::Renderable.
|
virtualinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
inlinevirtualinherited |
Sets render system private data.
Definition at line 380 of file OgreRenderable.h.
|
virtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Overridden, see Renderable.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 93 of file OgreRenderable.h.
|
virtual |
Reimplemented from Ogre::MovableObject.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
Definition at line 177 of file OgreRenderable.h.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
Definition at line 202 of file OgreRenderable.h.
|
inlinevirtualinherited |
Definition at line 315 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Definition at line 330 of file OgreRenderable.h.
|
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.
Definition at line 321 of file OgreMovableObject.h.
|
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.
Definition at line 327 of file OgreMovableObject.h.
|
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.
Definition at line 336 of file OgreRenderable.h.
|
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.
Definition at line 342 of file OgreRenderable.h.
|
inlinevirtualinherited |
Returns the visibility flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 412 of file OgreMovableObject.h.
|
virtualinherited |
Gets this object whether to be visible or not, if it has a renderable component.
|
virtualinherited |
Retrieves the axis-aligned bounding box for this object in world coordinates.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtualinherited |
Retrieves the worldspace bounding sphere for this object.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtual |
Gets the world transform matrix / matrices for this renderable object.
Implements Ogre::Renderable.
|
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.
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 |
|
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.
|
virtualinherited |
|
inlinevirtualinherited |
Gets whether debug display of this object is enabled.
Definition at line 546 of file OgreMovableObject.h.
|
virtualinherited |
|
inlinevirtualinherited |
Gets whether the parent node is a TagPoint (or a SceneNode)
Definition at line 213 of file OgreMovableObject.h.
|
virtualinherited |
Returns whether or not this object is supposed to be visible or not.
Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
Definition at line 127 of file OgreRenderable.h.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Definition at line 122 of file OgreRenderable.h.
|
virtualinherited |
Gets a list of lights, ordered relative to how close they are to this movable object.
|
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.
|
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.
|
inlineinherited |
Sets whether or not this object will cast shadows.
Definition at line 500 of file OgreMovableObject.h.
|
inlineinherited |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program 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 240 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets whether or not the debug display of this object is enabled.
Definition at line 544 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
Definition at line 388 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default visibility flags for all future MovableObject instances.
Definition at line 416 of file OgreMovableObject.h.
|
inline |
Forces the LOD to the given level from this point on.
Definition at line 227 of file OgreTerrainRenderable.h.
|
virtualinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlinevirtualinherited |
Sets a listener for this object.
Definition at line 427 of file OgreMovableObject.h.
|
inline |
Definition at line 258 of file OgreTerrainRenderable.h.
|
inlinevirtualinherited |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
override | true 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.
|
inlinevirtualinherited |
Sets the query flags for this object.
Definition at line 373 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the distance at which the object is no longer rendered.
dist | Distance 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.
|
virtualinherited |
Sets the render queue group this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
|
virtualinherited |
Sets the render queue group and group priority this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
priority | The priority within a group to use. |
Reimplemented in Ogre::Entity.
|
inlinevirtualinherited |
gets render system private data
Definition at line 388 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
Definition at line 163 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
Definition at line 188 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 310 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 325 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets the visiblity flags for this object.
Definition at line 401 of file OgreMovableObject.h.
|
virtualinherited |
Tells this object whether to be visible or not, if it has a renderable component.
Reimplemented in Ogre::Light.
|
protected |
Utility method to generate stitching indexes on the edge of a tile.
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) |
|
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.
edgeData | The edge information to update |
lightPos | 4D vector representing the light, a directional light has w=0.0 |
|
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.
visitor | Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this. |
debugRenderables | If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too. |
Implements Ogre::MovableObject.
|
protectedinherited |
Hidden because of distance?
Definition at line 125 of file OgreMovableObject.h.
|
protected |
The bounding radius of this tile.
Definition at line 358 of file OgreTerrainRenderable.h.
|
protected |
Bounding box of this tile.
Definition at line 360 of file OgreTerrainRenderable.h.
|
protectedinherited |
Does this object cast shadows?
Definition at line 147 of file OgreMovableObject.h.
|
protected |
The center point of this tile.
Definition at line 362 of file OgreTerrainRenderable.h.
|
protectedinherited |
Creator of this object (if created by a factory)
Definition at line 111 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 396 of file OgreRenderable.h.
|
protectedinherited |
Is debug display enabled?
Definition at line 120 of file OgreMovableObject.h.
|
protected |
Definition at line 373 of file OgreTerrainRenderable.h.
|
protected |
Forced rendering LOD level, optional.
Definition at line 377 of file OgreTerrainRenderable.h.
|
protected |
Whether this tile has been initialised.
Definition at line 368 of file OgreTerrainRenderable.h.
|
protected |
The previous 'next' LOD level down, for frame coherency.
Definition at line 346 of file OgreTerrainRenderable.h.
|
mutableprotected |
Cached light list.
Definition at line 356 of file OgreTerrainRenderable.h.
|
mutableprotected |
Whether light list need to re-calculate.
Definition at line 354 of file OgreTerrainRenderable.h.
|
mutableprotectedinherited |
The last frame that this light list was updated in.
Definition at line 157 of file OgreMovableObject.h.
|
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.
|
protectedinherited |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 152 of file OgreMovableObject.h.
|
protected |
The morph factor between this and the next LOD level down.
Definition at line 348 of file OgreTerrainRenderable.h.
|
protected |
The buffer with all the renderable geometry in it.
Definition at line 370 of file OgreTerrainRenderable.h.
|
protectedinherited |
SceneManager holding this object (if applicable)
Definition at line 113 of file OgreMovableObject.h.
|
protected |
Current material used by this tile.
Definition at line 366 of file OgreTerrainRenderable.h.
|
protected |
List of squared distances at which LODs change.
Definition at line 350 of file OgreTerrainRenderable.h.
|
protectedinherited |
Name of this object.
Definition at line 109 of file OgreMovableObject.h.
|
protected |
Connection to tiles four neighbours.
Definition at line 352 of file OgreTerrainRenderable.h.
|
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.
|
protected |
Link to shared options.
Definition at line 293 of file OgreTerrainRenderable.h.
|
protectedinherited |
Definition at line 116 of file OgreMovableObject.h.
|
protectedinherited |
node to which this object is attached
Definition at line 115 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 397 of file OgreRenderable.h.
|
protected |
System-memory buffer with just positions in it, for CPU operations.
Definition at line 375 of file OgreTerrainRenderable.h.
|
protectedinherited |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 137 of file OgreMovableObject.h.
|
protectedinherited |
Does rendering this object disabled by listener?
Definition at line 150 of file OgreMovableObject.h.
|
protected |
The current LOD level.
Definition at line 344 of file OgreTerrainRenderable.h.
|
protectedinherited |
The render queue to use when rendering this object.
Definition at line 129 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 131 of file OgreMovableObject.h.
|
protectedinherited |
The render queue group to use when rendering this object.
Definition at line 133 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 135 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 401 of file OgreRenderable.h.
|
staticprotectedinherited |
Static map of class name to list of animable value names.
Definition at line 242 of file OgreAnimable.h.
|
protected |
Parent SceneManager.
Definition at line 291 of file OgreTerrainRenderable.h.
|
staticprotectedinherited |
Default query flags.
Definition at line 164 of file OgreMovableObject.h.
|
staticprotectedinherited |
Default visibility flags.
Definition at line 166 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 123 of file OgreMovableObject.h.
|
protected |
Definition at line 341 of file OgreTerrainRenderable.h.
|
staticprotected |
The MovableObject type.
Definition at line 364 of file OgreTerrainRenderable.h.
|
protectedinherited |
Upper distance to still render.
Definition at line 122 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 398 of file OgreRenderable.h.
|
protectedinherited |
Definition at line 399 of file OgreRenderable.h.
|
protectedinherited |
User objects binding.
Definition at line 127 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 400 of file OgreRenderable.h.
|
protectedinherited |
Flags determining whether this object is visible (compared to SceneManager mask)
Definition at line 139 of file OgreMovableObject.h.
|
protectedinherited |
Is this object visible?
Definition at line 118 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Cached world AABB of this object.
Definition at line 141 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 143 of file OgreMovableObject.h.
|
mutableprotectedinherited |
World space AABB of this object's dark cap.
Definition at line 145 of file OgreMovableObject.h.