Ogre::Volume::Chunk Class Reference

A single volume chunk mesh. More...

`#include <OgreVolumeChunk.h>`

Inheritance diagram for Ogre::Volume::Chunk:
[legend]

## Public Types

typedef vector< ShadowRenderable * >::type | ShadowRenderableList
typedef VectorIterator< ShadowRenderableList > | ShadowRenderableListIterator
typedef vector< const Chunk * >::type | VecChunk
| A list of Chunks. More...

## Public Member Functions

| Chunk (void)
| Constructor. More...
virtual | ~Chunk (void)
| Destructor. 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...
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)
| Internal method to notify the object of the camera to be used for the next rendering operation. 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...
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. 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...
virtual Chunk * | createInstance (void)
| Overridable factory method. More...
virtual void | detachFromParent (void)
| Detaches an object from a parent SceneNode or TagPoint, if attached. More...
virtual bool | frameEnded (const FrameEvent &evt)
| Called just after a frame has been rendered. More...
virtual bool | frameRenderingQueued (const FrameEvent &evt)
| Called after all render targets have had their rendering commands issued, but before render windows have been asked to flip their buffers over. More...
virtual bool | frameStarted (const FrameEvent &evt)
| Overridden from FrameListener. More...
const StringVector & | getAnimableValueNames (void) const
| Gets a list of animable value names for this object. More...
virtual const AxisAlignedBox & | getBoundingBox (void) const
| Retrieves the local axis-aligned bounding box for this object. More...
virtual Real | getBoundingRadius () 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...
ChunkParameters * | getChunkParameters (void)
| Gets the parameters with which the chunktree got loaded. More...
virtual void | getChunksOfLevel (const size_t level, VecChunk &result) const
| Gathers all visible chunks (containing triangles) of a specific LOD level. 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...
virtual bool | getDualGridVisible (void) const
| Gets whether the debug visualization entity of the dualgrid is visible. More...
EdgeData * | getEdgeList (void)
| Define a default implementation of method from ShadowCaster which implements no shadows. 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
| Overridden from MovableObject. 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 bool | getOctreeVisible (void) const
| Gets whether the debug visualization entity of the octree is visible. 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...
virtual Real | getRenderingMinPixelSize () const
| Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
virtual void | getRenderOperation (RenderOperation &op)
| Gets the render operation required to send this object to the frame buffer. More...
virtual uint8 | getRenderQueueGroup (void) const
| Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
virtual RenderSystemData * | getRenderSystemData () const
| Gets RenderSystem private data. More...
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
| Define a default implementation of method from ShadowCaster which implements no shadows. More...
virtual Real | getSquaredViewDepth (const Camera *camera) const
| Overridden from Renderable. More...
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses. More...
virtual uint32 | getTypeFlags (void) const
| Get the 'type flags' for this MovableObject. More...
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 OGRE_DEPRECATED const Any & | getUserAny (void) const
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const
UserObjectBindings & | getUserObjectBindings ()
| Return an instance of user objects binding associated with this class. 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 bool | getVolumeVisible (void) const
| Gets whether the volume mesh is visible. 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 | hasCustomParameter (size_t index) const
| Checks whether a custom value is associated with this Renderable at the given index. More...
bool | hasEdgeList (void)
| Define a default implementation of method from ShadowCaster which implements no shadows. 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...
virtual void | load (SceneNode *parent, const Vector3 &from, const Vector3 &to, size_t level, const ChunkParameters *parameters)
| Loads the volume mesh with all LODs. More...
virtual void | load (SceneNode *parent, SceneManager *sceneManager, const String &filename, bool validSourceResult=false, MeshBuilderCallback *lodCallback=0, const String &resourceGroup=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
| Loads a TextureSource volume scene from a config file. 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...
void | removeCustomParameter (size_t index)
| Removes a custom value which is associated with this Renderable at the given index. 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 | setBoundingBox (const AxisAlignedBox &box)
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...
virtual void | setDualGridVisible (const bool visible)
| Shows the debug visualization entity of the dualgrid. 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...
virtual void | setMaterial (const String &matName)
| Overridden from SimpleRenderable. More...
virtual void | setMaterialOfLevel (size_t level, const String &matName)
| Sets the material of all chunks of a specific level in the tree. More...
virtual void | setOctreeVisible (const bool visible)
| Shows the debug visualization entity of the octree. More...
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 | setRenderingMinPixelSize (Real pixelSize)
| Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
virtual void | setRenderOperation (const RenderOperation &rend)
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
| Sets RenderSystem 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 OGRE_DEPRECATED void | setUserAny (const Any &anything)
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything)
virtual void | setVisibilityFlags (uint32 flags)
| Sets the visibility 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...
virtual void | setVolumeVisible (const bool visible)
| Sets whether the volume mesh is visible. More...
void | setWorldTransform (const Matrix4 &xform)
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...

## Static Public Attributes

static const String | MOVABLE_TYPE_NAME
| The type name. More...

## Protected Types

typedef map< String, StringVector >::type | AnimableDictionaryMap
typedef map< size_t, Vector4 >::type | CustomParameterMap

## Protected Member Functions

StringVector & | _getAnimableValueNames (void)
| Get an updateable reference to animable value list. More...
virtual bool | contributesToVolumeMesh (const Vector3 &from, const Vector3 &to) const
| Whether the center of the given cube (from -> to) will contribute something to the total volume mesh. 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...
virtual void | doLoad (SceneNode *parent, const Vector3 &from, const Vector3 &to, const Vector3 &totalFrom, const Vector3 &totalTo, const size_t level, const size_t maxLevels)
| Actually loads the volume tree with all LODs. 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, size_t &indexBufferUsedSize, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags)
| Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it. 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...
virtual void | initialiseAnimableDictionary (StringVector &) const
| Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...
virtual void | loadChildren (SceneNode *parent, const Vector3 &from, const Vector3 &to, const Vector3 &totalFrom, const Vector3 &totalTo, const size_t level, const size_t maxLevels)
| Loads the tree children of the current node. More...
virtual void | loadChunk (SceneNode *parent, const Vector3 &from, const Vector3 &to, const Vector3 &totalFrom, const Vector3 &totalTo, const size_t level, const size_t maxLevels)
| Loads a single chunk of the tree. More...
virtual void | loadGeometry (MeshBuilder *meshBuilder, DualGridGenerator *dualGridGenerator, OctreeNode *root, size_t level, bool isUpdate)
| Loads the actual geometry when the processing is done. More...
virtual void | prepareGeometry (size_t level, OctreeNode *root, DualGridGenerator *dualGridGenerator, MeshBuilder *meshBuilder, const Vector3 &totalFrom, const Vector3 &totalTo)
| Prepares the geometry of the chunk request. More...
void | setChunkVisible (const bool visible, const bool applyToChildren)
| Sets the visibility of this chunk. 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 | isRoot
| Whether this chunk is the root of the tree. More...
bool | mBeyondFarDistance
| Hidden because of distance? More...
AxisAlignedBox | mBox
Camera * | mCamera
| The camera for the current frame. More...
bool | mCastShadows
| Does this object cast shadows? More...
Chunk ** | mChildren
| The more detailed children chunks. More...
MovableObjectFactory * | mCreator
| Creator of this object (if created by a factory) More...
CustomParameterMap | mCustomParameters
bool | mDebugDisplay
| Is debug display enabled? More...
Entity * | mDualGrid
| Holds the dualgrid debug visualization. More...
Real | mError
| Holds the error associated with this chunk. More...
bool | mInvisible
| Flag whether this node will never be shown. More...
LightList | mLightList
| List of lights for this object. 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...
SceneManager * | mManager
| SceneManager holding this object (if applicable) More...
MaterialPtr | mMaterial
String | mMatName
Real | mMinPixelSize
String | mName
| Name of this object. More...
SceneNode * | mNode
| To attach this node to. More...
Entity * | mOctree
| The debug visualization of the octree. More...
bool | mParentIsTagPoint
Node * | mParentNode
| node to which this object is attached More...
SceneManager * | mParentSceneManager
| The scene manager for the current frame. More...
bool | mPolygonModeOverrideable
uint32 | mQueryFlags
| Flags determining whether this object is included / excluded from scene queries. More...
bool | mRenderingDisabled
| Does rendering this object disabled by listener? More...
RenderOperation | mRenderOp
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
| User objects binding. More...
ChunkTreeSharedData * | mShared
| Holds some shared data among all chunks of the tree. More...
Real | mSquaredUpperDistance
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...
Matrix4 | mWorldTransform

## Static Protected Attributes

static ChunkHandler | mChunkHandler
| To handle the WorkQueue. More...
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 uint | msGenNameCount
| Static member used to automatically generate names for SimpleRendaerable objects. More...

## Friends

class | ChunkHandler
| So the actual loading functions can be called. More...

## Detailed Description

A single volume chunk mesh.

Definition at line 142 of file OgreVolumeChunk.h.

## Member Typedef Documentation

## AnimableDictionaryMap

typedef map<String, StringVector>::type Ogre::AnimableObject::AnimableDictionaryMap

protected inherited

Definition at line 241 of file OgreAnimable.h.

## CustomParameterMap

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

protected inherited

Definition at line 414 of file OgreRenderable.h.

## ShadowRenderableList

typedef vector<ShadowRenderable*>::type Ogre::ShadowCaster::ShadowRenderableList

inherited

Definition at line 136 of file OgreShadowCaster.h.

## ShadowRenderableListIterator

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator

inherited

Definition at line 137 of file OgreShadowCaster.h.

## VecChunk

typedef vector<const Chunk*>::type Ogre::Volume::Chunk::VecChunk

A list of Chunks.

Definition at line 434 of file OgreVolumeChunk.h.

## Constructor & Destructor Documentation

## Chunk()

Ogre::Volume::Chunk::Chunk | ( | void |  | ) |

Constructor.

## ~Chunk()

virtual Ogre::Volume::Chunk::~Chunk | ( | void |  | ) |

virtual

Destructor.

## Member Function Documentation

## _getAnimableValueNames()

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

protected inherited

Get an updateable reference to animable value list.

Definition at line 267 of file OgreAnimable.h.

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

## _getCreator()

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

virtual inherited

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

Definition at line 186 of file OgreMovableObject.h.

## _getLightList()

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

virtual inherited

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

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

Definition at line 491 of file OgreMovableObject.h.

## _getManager()

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

virtual inherited

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

Definition at line 190 of file OgreMovableObject.h.

## _getParentNodeFullTransform()

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

virtual inherited

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

Reimplemented in Ogre::InstancedEntity.

## _notifyAttached()

virtual void Ogre::MovableObject::_notifyAttached | ( | Node * | parent,
|  | bool | isTagPoint = `false`
| ) |  |

virtual inherited

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

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

## _notifyCreator()

virtual void Ogre::MovableObject::_notifyCreator | ( | MovableObjectFactory * | fact | ) |

virtual inherited

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

Definition at line 184 of file OgreMovableObject.h.

## _notifyCurrentCamera()

virtual void Ogre::SimpleRenderable::_notifyCurrentCamera | ( | Camera * | cam | ) |

virtual inherited

Internal method to notify the object of the camera to be used for the next rendering operation.

Remarks
  Certain objects may want to do specific processing based on the camera position. This method notifies them in case they wish to do this.

Reimplemented from Ogre::MovableObject.

## _notifyManager()

virtual void Ogre::MovableObject::_notifyManager | ( | SceneManager * | man | ) |

virtual inherited

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

Definition at line 188 of file OgreMovableObject.h.

## _notifyMoved()

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

virtual inherited

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

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

## _updateCustomGpuParameter()

virtual void Ogre::Renderable::_updateCustomGpuParameter | ( | const GpuProgramParameters::AutoConstantEntry & | constantEntry,
|  | GpuProgramParameters * | params
| ) |  | const

virtual inherited

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks
  This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.

  You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.

Parameters

  constantEntry | The auto constant entry referring to the parameter being updated
  params | The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

Definition at line 307 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.

## _updateRenderQueue()

virtual void Ogre::SimpleRenderable::_updateRenderQueue | ( | RenderQueue * | queue | ) |

virtual inherited

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.

## addQueryFlags()

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

virtual inherited

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

Definition at line 396 of file OgreMovableObject.h.

## addVisibilityFlags()

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

virtual inherited

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

Definition at line 424 of file OgreMovableObject.h.

## contributesToVolumeMesh()

virtual bool Ogre::Volume::Chunk::contributesToVolumeMesh | ( | const Vector3 & | from,
|  | const Vector3 & | to
| ) |  | const

protected virtual

Whether the center of the given cube (from -> to) will contribute something to the total volume mesh.

Parameters

  from | The back lower left corner of the cell.
  to | The front upper right corner of the cell.

Returns
  true if triangles might be generated

## createAnimableDictionary()

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

protected inherited

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

Definition at line 254 of file OgreAnimable.h.

## createAnimableValue()

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue | ( | const String & | valueName | ) |

virtual inherited

Create a reference-counted AnimableValuePtr for the named value.

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

Reimplemented in Ogre::Light.

Definition at line 320 of file OgreAnimable.h.

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

## createInstance()

virtual Chunk* Ogre::Volume::Chunk::createInstance | ( | void |  | ) |

virtual

Overridable factory method.

Returns
  The created chunk.

## detachFromParent()

virtual void Ogre::MovableObject::detachFromParent | ( | void |  | ) |

virtual inherited

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

## doLoad()

virtual void Ogre::Volume::Chunk::doLoad | ( | SceneNode * | parent,
|  | const Vector3 & | from,
|  | const Vector3 & | to,
|  | const Vector3 & | totalFrom,
|  | const Vector3 & | totalTo,
|  | const size_t | level,
|  | const size_t | maxLevels
| ) |  |

protected virtual

Actually loads the volume tree with all LODs.

Parameters

  parent | The parent scene node for the volume
  from | The back lower left corner of the cell.
  to | The front upper right corner of the cell.
  totalFrom | The back lower left corner of the world.
  totalTo | The front upper rightcorner of the world.
  level | The current LOD level.
  maxLevels | The maximum amount of levels.

## extrudeBounds()

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

protected virtual inherited

Utility method for extruding a bounding box.

Parameters

  box | Original bounding box, will be updated in-place.
  lightPos | 4D light position in object space, when w=0.0f this represents a directional light.
  extrudeDist | The distance to extrude.

## extrudeVertices()

static void Ogre::ShadowCaster::extrudeVertices | ( | const HardwareVertexBufferSharedPtr & | vertexBuffer,
|  | size_t | originalVertexCount,
|  | const Vector4 & | lightPos,
|  | Real | extrudeDist
| ) |  |

static inherited

Utility method for extruding vertices based on a light.

Remarks
  Unfortunately, because D3D cannot handle homogeneous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.

Parameters

  vertexBuffer | The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
  originalVertexCount | The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
  lightPos | 4D light position in object space, when w=0.0f this represents a directional light.
  extrudeDist | The distance to extrude.

## frameEnded()

virtual bool Ogre::FrameListener::frameEnded | ( | const FrameEvent & | evt | ) |

virtual inherited

Called just after a frame has been rendered.

Remarks
  This event happens after all render targets have been fully updated and the buffers switched.

Returns
  True to continue with the next frame, false to drop out of the rendering loop.

Reimplemented in Ogre::PageManager::EventRouter, and Ogre::FrameTimeControllerValue.

Definition at line 127 of file OgreFrameListener.h.

## frameRenderingQueued()

virtual bool Ogre::FrameListener::frameRenderingQueued | ( | const FrameEvent & | evt | ) |

virtual inherited

Called after all render targets have had their rendering commands issued, but before render windows have been asked to flip their buffers over.

Remarks
  The usefulness of this event comes from the fact that rendering commands are queued for the GPU to process. These can take a little while to finish, and so while that is happening the CPU can be doing useful things. Once the request to 'flip buffers' happens, the thread requesting it will block until the GPU is ready, which can waste CPU cycles. Therefore, it is often a good idea to use this callback to perform per-frame processing. Of course because the frame's rendering commands have already been issued, any changes you make will only take effect from the next frame, but in most cases that's not noticeable.

Returns
  True to continue rendering, false to drop out of the rendering loop.

Definition at line 116 of file OgreFrameListener.h.

## frameStarted()

virtual bool Ogre::Volume::Chunk::frameStarted | ( | const FrameEvent & | evt | ) |

virtual

Overridden from FrameListener.

Reimplemented from Ogre::FrameListener.

## generateShadowVolume()

virtual void Ogre::ShadowCaster::generateShadowVolume | ( | EdgeData * | edgeData,
|  | const HardwareIndexBufferSharedPtr & | indexBuffer,
|  | size_t & | indexBufferUsedSize,
|  | const Light * | light,
|  | ShadowRenderableList & | shadowRenderables,
|  | unsigned long | flags
| ) |  |

protected virtual inherited

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

Parameters

  edgeData | The edge information to use.
  indexBuffer | The buffer into which to write data into; current contents are assumed to be discardable.
  indexBufferUsedSize | If the rest of buffer is enough than it would be locked with HBL_NO_OVERWRITE semantic and indexBufferUsedSize would be increased, otherwise HBL_DISCARD would be used and indexBufferUsedSize would be reset.
  light | The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
  shadowRenderables | A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
  flags | Additional controller flags, see ShadowRenderableFlags.

## getAnimableDictionaryName()

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName | ( | void |  | ) | const

protected virtual inherited

Get the name of the animable dictionary for this class.

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

Reimplemented in Ogre::Light.

Definition at line 249 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

## getAnimableValueNames()

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

inherited

Gets a list of animable value names for this object.

Definition at line 295 of file OgreAnimable.h.

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

## getBoundingBox()

virtual const AxisAlignedBox& Ogre::SimpleRenderable::getBoundingBox | ( | void |  | ) | const

virtual inherited

Retrieves the local axis-aligned bounding box for this object.

Remarks
  This bounding box is in local coordinates.

Implements Ogre::MovableObject.

## getBoundingRadius()

virtual Real Ogre::Volume::Chunk::getBoundingRadius | ( |  | ) | const

virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

## getCastShadows()

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

virtual inherited

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 521 of file OgreMovableObject.h.

## getCastsShadows()

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

virtual inherited

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

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

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

Definition at line 224 of file OgreRenderable.h.

## getChunkParameters()

ChunkParameters* Ogre::Volume::Chunk::getChunkParameters | ( | void |  | ) |

Gets the parameters with which the chunktree got loaded.

Returns
  The parameters.

## getChunksOfLevel()

virtual void Ogre::Volume::Chunk::getChunksOfLevel | ( | const size_t | level,
|  | VecChunk & | result
| ) |  | const

virtual

Gathers all visible chunks (containing triangles) of a specific LOD level.

Parameters

  level | The desired chunk level, 0 based. 0 means the chunk with the lowest level of detail. If the chunks are loaded with a level amount of 5, valid values here are 0-4.
  result | Vector where the chunks will be added to.

## getCustomParameter()

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

inherited

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

Parameters

  index | Index of the parameter to retrieve.

See also
  setCustomParameter for full details.

Definition at line 268 of file OgreRenderable.h.

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

## getDarkCapBounds()

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

virtual inherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

## getDefaultQueryFlags()

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

static inherited

Get the default query flags for all future MovableObject instances.

Definition at line 411 of file OgreMovableObject.h.

## getDefaultVisibilityFlags()

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

static inherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 439 of file OgreMovableObject.h.

## getDualGridVisible()

virtual bool Ogre::Volume::Chunk::getDualGridVisible | ( | void |  | ) | const

virtual

Gets whether the debug visualization entity of the dualgrid is visible.

Returns
  true if visible.

## getEdgeList()

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

virtual inherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 494 of file OgreMovableObject.h.

## getExtrusionDistance()

Real Ogre::ShadowCaster::getExtrusionDistance | ( | const Vector3 & | objectPos,
|  | const Light * | light
| ) |  | const

protected inherited

Helper method for calculating extrusion distance.

## getLightCapBounds()

const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds | ( | void |  | ) | const

virtual inherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

## getLightMask()

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

virtual inherited

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

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

Definition at line 476 of file OgreMovableObject.h.

## getLights()

const LightList& Ogre::SimpleRenderable::getLights | ( | void |  | ) | const

virtual inherited

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.

## getListener()

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

virtual inherited

Gets the current listener for this object.

Definition at line 450 of file OgreMovableObject.h.

## getMaterial()

virtual const MaterialPtr& Ogre::SimpleRenderable::getMaterial | ( | void |  | ) | const

virtual inherited

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.

Reimplemented in Ogre::InstancedGeometry::GeometryBucket.

## getMovableType()

virtual const String& Ogre::Volume::Chunk::getMovableType | ( | void |  | ) | const

virtual

Overridden from MovableObject.

Reimplemented from Ogre::SimpleRenderable.

## getName()

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

virtual inherited

Returns the name of this object.

Definition at line 193 of file OgreMovableObject.h.

## getNumWorldTransforms()

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

virtual inherited

Returns the number of world transform matrices this renderable requires.

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

Reimplemented in Ogre::BorderRenderable, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.

Definition at line 153 of file OgreRenderable.h.

## getOctreeVisible()

virtual bool Ogre::Volume::Chunk::getOctreeVisible | ( | void |  | ) | const

virtual

Gets whether the debug visualization entity of the octree is visible.

Returns
  true if visible.

## getParentNode()

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

virtual inherited

Returns the node to which this object is attached.

Remarks
  A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. Both are Node subclasses so this method will return either.

## getParentSceneNode()

virtual SceneNode* Ogre::MovableObject::getParentSceneNode | ( | void |  | ) | const

virtual inherited

Returns the scene node to which this object is attached.

Remarks
  A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. This method will return the scene node of the parent entity if the latter is true.

## getPointExtrusionDistance()

Real Ogre::MovableObject::getPointExtrusionDistance | ( | const Light * | l | ) | const

virtual inherited

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

Implements Ogre::ShadowCaster.

## getPolygonModeOverrideable()

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

virtual inherited

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 332 of file OgreRenderable.h.

Referenced by Ogre::BorderRenderable::getPolygonModeOverrideable().

## getQueryFlags()

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

virtual inherited

Returns the query flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 403 of file OgreMovableObject.h.

## getReceivesShadows()

bool Ogre::MovableObject::getReceivesShadows | ( |  | ) |

inherited

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

## getRenderingDistance()

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

virtual inherited

Gets the distance at which batches are no longer rendered.

Definition at line 305 of file OgreMovableObject.h.

## getRenderingMinPixelSize()

virtual Real Ogre::MovableObject::getRenderingMinPixelSize | ( |  | ) | const

virtual inherited

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Definition at line 318 of file OgreMovableObject.h.

## getRenderOperation()

virtual void Ogre::SimpleRenderable::getRenderOperation | ( | RenderOperation & | op | ) |

virtual inherited

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

Implements Ogre::Renderable.

## getRenderQueueGroup()

virtual uint8 Ogre::MovableObject::getRenderQueueGroup | ( | void |  | ) | const

virtual inherited

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

## getRenderSystemData()

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

virtual inherited

Gets RenderSystem private data.

Remarks
  This should only be used by a RenderSystem

Definition at line 399 of file OgreRenderable.h.

## getShadowVolumeRenderableIterator()

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

virtual inherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

## getSquaredViewDepth()

virtual Real Ogre::Volume::Chunk::getSquaredViewDepth | ( | const Camera * | camera | ) | const

virtual

Overridden from Renderable.

Implements Ogre::Renderable.

## getTechnique()

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

virtual inherited

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

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

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

Definition at line 94 of file OgreRenderable.h.

## getTypeFlags()

virtual uint32 Ogre::MovableObject::getTypeFlags | ( | void |  | ) | const

virtual inherited

Get the 'type flags' for this MovableObject.

Remarks
  A type flag identifies the type of the MovableObject as a bitpattern. This is used for categorical inclusion / exclusion in SceneQuery objects. By default, this method returns all ones for objects not created by a MovableObjectFactory (hence always including them); otherwise it returns the value assigned to the MovableObjectFactory. Custom objects which don't use MovableObjectFactory will need to override this if they want to be included in queries.

Reimplemented in Ogre::BillboardSet, Ogre::Entity, Ogre::ParticleSystem, Ogre::Frustum, Ogre::StaticGeometry::Region, and Ogre::Light.

## getUseIdentityProjection()

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

inherited

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

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

See also
  Renderable::setUseIdentityProjection

Definition at line 178 of file OgreRenderable.h.

## getUseIdentityView()

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

inherited

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

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

See also
  Renderable::setUseIdentityView

Definition at line 203 of file OgreRenderable.h.

## getUserAny() [1/2]

virtual OGRE_DEPRECATED const Any& Ogre::MovableObject::getUserAny | ( | void |  | ) | const

virtual inherited

Deprecated:
  use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Definition at line 334 of file OgreMovableObject.h.

## getUserAny() [2/2]

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny | ( | void |  | ) | const

virtual inherited

Deprecated:
  use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Definition at line 349 of file OgreRenderable.h.

Referenced by Ogre::InstanceBatch::getRenderOperation().

## getUserObjectBindings() [1/4]

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

inherited

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

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

See also
  UserObjectBindings::setUserAny.

Definition at line 340 of file OgreMovableObject.h.

## getUserObjectBindings() [2/4]

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

inherited

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

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

See also
  UserObjectBindings::setUserAny.

Definition at line 346 of file OgreMovableObject.h.

## getUserObjectBindings() [3/4]

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

inherited

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

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

See also
  UserObjectBindings::setUserAny.

Definition at line 355 of file OgreRenderable.h.

## getUserObjectBindings() [4/4]

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

inherited

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

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

See also
  UserObjectBindings::setUserAny.

Definition at line 361 of file OgreRenderable.h.

## getVisibilityFlags()

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

virtual inherited

Returns the visibility flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 431 of file OgreMovableObject.h.

## getVisible()

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

virtual inherited

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

Remarks
  Returns the value set by MovableObject::setVisible only.

## getVolumeVisible()

virtual bool Ogre::Volume::Chunk::getVolumeVisible | ( | void |  | ) | const

virtual

Gets whether the volume mesh is visible.

Returns
  true if visible

## getWorldBoundingBox()

virtual const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox | ( | bool | derive = `false` | ) | const

virtual inherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity.

## getWorldBoundingSphere()

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

virtual inherited

Retrieves the worldspace bounding sphere for this object.

Reimplemented in Ogre::Entity.

## getWorldTransforms()

virtual void Ogre::SimpleRenderable::getWorldTransforms | ( | Matrix4 * | xform | ) | const

virtual inherited

Gets the world transform matrix / matrices for this renderable object.

Remarks
  If the object has any derived transforms, these are expected to be up to date as long as all the SceneNode structures have been updated before this is called.

  This method will populate transform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.

Note
  Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.

See also
  Matrix4::isAffine.

Implements Ogre::Renderable.

Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::Rectangle2D, and Ogre::WireBoundingBox.

## hasCustomParameter()

bool Ogre::Renderable::hasCustomParameter | ( | size_t | index | ) | const

inherited

Checks whether a custom value is associated with this Renderable at the given index.

Parameters

  index | Index of the parameter to check for existence.

See also
  setCustomParameter for full details.

Definition at line 259 of file OgreRenderable.h.

## hasEdgeList()

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

virtual inherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 496 of file OgreMovableObject.h.

## initialiseAnimableDictionary()

virtual void Ogre::AnimableObject::initialiseAnimableDictionary | ( | StringVector & |  | ) | const

protected virtual inherited

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

Reimplemented in Ogre::Light.

Definition at line 287 of file OgreAnimable.h.

## isAttached()

virtual bool Ogre::MovableObject::isAttached | ( | void |  | ) | const

virtual inherited

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

## isDebugDisplayEnabled()

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

virtual inherited

Gets whether debug display of this object is enabled.

Definition at line 565 of file OgreMovableObject.h.

## isInScene()

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

virtual inherited

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

Reimplemented in Ogre::InstancedEntity.

## isParentTagPoint()

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

virtual inherited

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

Definition at line 216 of file OgreMovableObject.h.

## isVisible()

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

virtual inherited

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

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

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

## load() [1/2]

virtual void Ogre::Volume::Chunk::load | ( | SceneNode * | parent,
|  | const Vector3 & | from,
|  | const Vector3 & | to,
|  | size_t | level,
|  | const ChunkParameters * | parameters
| ) |  |

virtual

Loads the volume mesh with all LODs.

Parameters

  parent | The parent scene node for the volume
  from | The back lower left corner of the cell.
  to | The front upper right corner of the cell.
  level | The amount of LOD level.
  parameters | The parameters to use while loading.

## load() [2/2]

virtual void Ogre::Volume::Chunk::load | ( | SceneNode * | parent,
|  | SceneManager * | sceneManager,
|  | const String & | filename,
|  | bool | validSourceResult = `false`,
|  | MeshBuilderCallback * | lodCallback = `0`,
|  | const String & | resourceGroup = `ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME`
| ) |  |

virtual

Loads a TextureSource volume scene from a config file.

Parameters

  parent | The parent scene node for the volume.
  sceneManager | The scenemanager to construct the entity with.
  filename | The filename of the configuration file.
  validSourceResult | If you want to use the loaded source afterwards of the parameters, set this to true. Beware, that you will have to delete the pointer on your own then! On false here, it internally frees the memory for you
  lodCallback | Callback for a specific LOD level.
  resourceGroup | The resource group where to search for the configuration file.

## loadChildren()

virtual void Ogre::Volume::Chunk::loadChildren | ( | SceneNode * | parent,
|  | const Vector3 & | from,
|  | const Vector3 & | to,
|  | const Vector3 & | totalFrom,
|  | const Vector3 & | totalTo,
|  | const size_t | level,
|  | const size_t | maxLevels
| ) |  |

protected virtual

Loads the tree children of the current node.

Parameters

  parent | The parent scene node for the volume
  from | The back lower left corner of the cell.
  to | The front upper right corner of the cell.
  totalFrom | The back lower left corner of the world.
  totalTo | The front upper rightcorner of the world.
  level | The current LOD level.
  maxLevels | The maximum amount of levels.

## loadChunk()

virtual void Ogre::Volume::Chunk::loadChunk | ( | SceneNode * | parent,
|  | const Vector3 & | from,
|  | const Vector3 & | to,
|  | const Vector3 & | totalFrom,
|  | const Vector3 & | totalTo,
|  | const size_t | level,
|  | const size_t | maxLevels
| ) |  |

protected virtual

Loads a single chunk of the tree.

Parameters

  parent | The parent scene node for the volume
  from | The back lower left corner of the cell.
  to | The front upper right corner of the cell.
  totalFrom | The back lower left corner of the world.
  totalTo | The front upper rightcorner of the world.
  level | The current LOD level.
  maxLevels | The maximum amount of levels.

## loadGeometry()

virtual void Ogre::Volume::Chunk::loadGeometry | ( | MeshBuilder * | meshBuilder,
|  | DualGridGenerator * | dualGridGenerator,
|  | OctreeNode * | root,
|  | size_t | level,
|  | bool | isUpdate
| ) |  |

protected virtual

Loads the actual geometry when the processing is done.

Parameters

  meshBuilder | The MeshBuilder holding the geometry.
  dualGridGenerator | The DualGridGenerator to build up the debug visualization of the DualGrid.
  root | The root node of the Octree to build up the debug visualization of the Otree.
  level | The current LOD level.
  isUpdate | Whether this loading is updating an existing ChunkTree.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## postRender()

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

virtual inherited

Called immediately after the Renderable has been rendered.

Definition at line 128 of file OgreRenderable.h.

## prepareGeometry()

virtual void Ogre::Volume::Chunk::prepareGeometry | ( | size_t | level,
|  | OctreeNode * | root,
|  | DualGridGenerator * | dualGridGenerator,
|  | MeshBuilder * | meshBuilder,
|  | const Vector3 & | totalFrom,
|  | const Vector3 & | totalTo
| ) |  |

protected virtual

Prepares the geometry of the chunk request.

To be called in a different thread.

Parameters

  level | The current LOD level.
  root | The root of the upcoming Octree (in here) of the chunk.
  dualGridGenerator | The DualGrid.
  meshBuilder | The MeshBuilder which will contain the geometry.
  totalFrom | The back lower left corner of the world.
  totalTo | The front upper rightcorner of the world.

## preRender()

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

virtual inherited

Called just prior to the Renderable being rendered.

Remarks
  OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.

  This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.

Returns
  true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Reimplemented in Ogre::BillboardChain.

Definition at line 123 of file OgreRenderable.h.

## queryLights()

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

virtual inherited

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

Remarks
  By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.

  The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (

See also
  SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.

  This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.

Returns
  The list of lights use to lighting this object.

## removeCustomParameter()

void Ogre::Renderable::removeCustomParameter | ( | size_t | index | ) |

inherited

Removes a custom value which is associated with this Renderable at the given index.

Parameters

  index | Index of the parameter to remove.

See also
  setCustomParameter for full details.

Definition at line 250 of file OgreRenderable.h.

## removeQueryFlags()

virtual void Ogre::MovableObject::removeQueryFlags | ( | uint32 | flags | ) |

virtual inherited

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

Definition at line 400 of file OgreMovableObject.h.

## removeVisibilityFlags()

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

virtual inherited

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

Definition at line 428 of file OgreMovableObject.h.

## setBoundingBox()

void Ogre::SimpleRenderable::setBoundingBox | ( | const AxisAlignedBox & | box | ) |

inherited

## setCastShadows()

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

inherited

Sets whether or not this object will cast shadows.

Remarks
  This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.

Note
  This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

Definition at line 519 of file OgreMovableObject.h.

## setChunkVisible()

void Ogre::Volume::Chunk::setChunkVisible | ( | const bool | visible,
|  | const bool | applyToChildren
| ) |  |

protected

Sets the visibility of this chunk.

Parameters

  visible | Whether this chunk is visible or not.
  applyToChildren | Whether all children and subchildren should have their visibility changed, too.

Definition at line 278 of file OgreVolumeChunk.h.

References Ogre::Volume::ChunkTreeSharedData::dualGridVisible, Ogre::Volume::ChunkTreeSharedData::octreeVisible, setChunkVisible(), Ogre::MovableObject::setVisible(), and Ogre::Volume::ChunkTreeSharedData::volumeVisible.

Referenced by setChunkVisible().

## setCustomParameter()

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

inherited

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

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

Parameters

  index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.
  value | The value to associate.

Definition at line 241 of file OgreRenderable.h.

## setDebugDisplayEnabled()

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

virtual inherited

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

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

Definition at line 563 of file OgreMovableObject.h.

## setDefaultQueryFlags()

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

static inherited

Set the default query flags for all future MovableObject instances.

Definition at line 407 of file OgreMovableObject.h.

## setDefaultVisibilityFlags()

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

static inherited

Set the default visibility flags for all future MovableObject instances.

Definition at line 435 of file OgreMovableObject.h.

## setDualGridVisible()

virtual void Ogre::Volume::Chunk::setDualGridVisible | ( | const bool | visible | ) |

virtual

Shows the debug visualization entity of the dualgrid.

Parameters

  visible | Whether the grid should be visible.

## setLightMask()

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

virtual inherited

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

Remarks
  This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object

## setListener()

virtual void Ogre::MovableObject::setListener | ( | Listener * | listener | ) |

virtual inherited

Sets a listener for this object.

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

Definition at line 446 of file OgreMovableObject.h.

## setMaterial()

virtual void Ogre::Volume::Chunk::setMaterial | ( | const String & | matName | ) |

virtual

Overridden from SimpleRenderable.

Sets the material of this chunk and all of his children.

Reimplemented from Ogre::SimpleRenderable.

## setMaterialOfLevel()

virtual void Ogre::Volume::Chunk::setMaterialOfLevel | ( | size_t | level,
|  | const String & | matName
| ) |  |

virtual

Sets the material of all chunks of a specific level in the tree.

This allows LODs where the lower levels (== less detail and more far away) have simpler materials.

Parameters

  level | The tree level getting the material, 0 based. 0 means the chunk with the lowest level of detail.
  matName | The material name to set.

## setOctreeVisible()

virtual void Ogre::Volume::Chunk::setOctreeVisible | ( | const bool | visible | ) |

virtual

Shows the debug visualization entity of the octree.

Parameters

  visible | Whether the octree should be visible.

## setPolygonModeOverrideable()

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

virtual inherited

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

Parameters

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

Definition at line 324 of file OgreRenderable.h.

## setQueryFlags()

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

virtual inherited

Sets the query flags for this object.

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

Definition at line 392 of file OgreMovableObject.h.

## setRenderingDistance()

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

virtual inherited

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

Note
  Camera::setUseRenderingDistance() needs to be called for this parameter to be used.

Parameters

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

Definition at line 299 of file OgreMovableObject.h.

## setRenderingMinPixelSize()

virtual void Ogre::MovableObject::setRenderingMinPixelSize | ( | Real | pixelSize | ) |

virtual inherited

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note
  Camera::setUseMinPixelSize() needs to be called for this parameter to be used.

Parameters

  pixelSize | Number of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 312 of file OgreMovableObject.h.

## setRenderOperation()

virtual void Ogre::SimpleRenderable::setRenderOperation | ( | const RenderOperation & | rend | ) |

virtual inherited

## setRenderQueueGroup()

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

virtual inherited

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

Remarks
  Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

  See RenderQueue for more details.

Parameters

  queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

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

## setRenderQueueGroupAndPriority()

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

virtual inherited

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

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

  See RenderQueue for more details.

Parameters

  queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
  priority | The priority within a group to use.

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

## setRenderSystemData()

virtual void Ogre::Renderable::setRenderSystemData | ( | RenderSystemData * | val | ) | const

virtual inherited

Sets RenderSystem private data.

Remarks
  This should only be used by a RenderSystem

Definition at line 407 of file OgreRenderable.h.

## setUseIdentityProjection()

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

inherited

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

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

See also
  Renderable::getUseIdentityProjection

Definition at line 164 of file OgreRenderable.h.

## setUseIdentityView()

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

inherited

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

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

See also
  Renderable::getUseIdentityView

Definition at line 189 of file OgreRenderable.h.

## setUserAny() [1/2]

virtual OGRE_DEPRECATED void Ogre::MovableObject::setUserAny | ( | const Any & | anything | ) |

virtual inherited

Deprecated:
  use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

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

Definition at line 329 of file OgreMovableObject.h.

## setUserAny() [2/2]

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny | ( | const Any & | anything | ) |

virtual inherited

Deprecated:
  use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

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

Definition at line 344 of file OgreRenderable.h.

Referenced by Ogre::InstanceBatch::getRenderOperation().

## setVisibilityFlags()

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

virtual inherited

Sets the visibility flags for this object.

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

Definition at line 420 of file OgreMovableObject.h.

## setVisible()

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

virtual inherited

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

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

Reimplemented in Ogre::Light.

Referenced by setChunkVisible().

## setVolumeVisible()

virtual void Ogre::Volume::Chunk::setVolumeVisible | ( | const bool | visible | ) |

virtual

Sets whether the volume mesh is visible.

Parameters

  visible | true if visible

## setWorldTransform()

void Ogre::SimpleRenderable::setWorldTransform | ( | const Matrix4 & | xform | ) |

inherited

## updateEdgeListLightFacing()

virtual void Ogre::ShadowCaster::updateEdgeListLightFacing | ( | EdgeData * | edgeData,
|  | const Vector4 & | lightPos
| ) |  |

protected virtual inherited

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

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

Parameters

  edgeData | The edge information to update.
  lightPos | 4D vector representing the light, a directional light has w=0.0.

## visitRenderables()

void Ogre::SimpleRenderable::visitRenderables | ( | Renderable::Visitor * | visitor,
|  | bool | debugRenderables = `false`
| ) |  |

virtual inherited

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

Parameters

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

Implements Ogre::MovableObject.

## Friends And Related Function Documentation

## ChunkHandler

friend class ChunkHandler

friend

So the actual loading functions can be called.

Definition at line 146 of file OgreVolumeChunk.h.

## Member Data Documentation

## isRoot

bool Ogre::Volume::Chunk::isRoot

protected

Whether this chunk is the root of the tree.

Definition at line 172 of file OgreVolumeChunk.h.

## mBeyondFarDistance

bool Ogre::MovableObject::mBeyondFarDistance

protected inherited

Hidden because of distance?

Definition at line 128 of file OgreMovableObject.h.

## mBox

AxisAlignedBox Ogre::SimpleRenderable::mBox

protected inherited

Definition at line 56 of file OgreSimpleRenderable.h.

## mCamera

Camera* Ogre::SimpleRenderable::mCamera

protected inherited

The camera for the current frame.

Definition at line 65 of file OgreSimpleRenderable.h.

## mCastShadows

bool Ogre::MovableObject::mCastShadows

protected inherited

Does this object cast shadows?

Definition at line 150 of file OgreMovableObject.h.

## mChildren

Chunk** Ogre::Volume::Chunk::mChildren

protected

The more detailed children chunks.

Definition at line 166 of file OgreVolumeChunk.h.

## mChunkHandler

ChunkHandler Ogre::Volume::Chunk::mChunkHandler

static protected

To handle the WorkQueue.

Definition at line 151 of file OgreVolumeChunk.h.

## mCreator

MovableObjectFactory* Ogre::MovableObject::mCreator

protected inherited

Creator of this object (if created by a factory)

Definition at line 112 of file OgreMovableObject.h.

## mCustomParameters

CustomParameterMap Ogre::Renderable::mCustomParameters

protected inherited

Definition at line 415 of file OgreRenderable.h.

## mDebugDisplay

bool Ogre::MovableObject::mDebugDisplay

protected inherited

Is debug display enabled?

Definition at line 121 of file OgreMovableObject.h.

## mDualGrid

Entity* Ogre::Volume::Chunk::mDualGrid

protected

Holds the dualgrid debug visualization.

Definition at line 160 of file OgreVolumeChunk.h.

## mError

Real Ogre::Volume::Chunk::mError

protected

Holds the error associated with this chunk.

Definition at line 157 of file OgreVolumeChunk.h.

## mInvisible

bool Ogre::Volume::Chunk::mInvisible

protected

Flag whether this node will never be shown.

Definition at line 169 of file OgreVolumeChunk.h.

## mLightList

LightList Ogre::MovableObject::mLightList

mutable protected inherited

List of lights for this object.

Definition at line 158 of file OgreMovableObject.h.

## mLightListUpdated

ulong Ogre::MovableObject::mLightListUpdated

mutable protected inherited

The last frame that this light list was updated in.

Definition at line 160 of file OgreMovableObject.h.

## mLightMask

uint32 Ogre::MovableObject::mLightMask

protected inherited

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

Definition at line 163 of file OgreMovableObject.h.

## mListener

Listener* Ogre::MovableObject::mListener

protected inherited

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

Definition at line 155 of file OgreMovableObject.h.

## mManager

SceneManager* Ogre::MovableObject::mManager

protected inherited

SceneManager holding this object (if applicable)

Definition at line 114 of file OgreMovableObject.h.

## mMaterial

MaterialPtr Ogre::SimpleRenderable::mMaterial

protected inherited

Definition at line 59 of file OgreSimpleRenderable.h.

## mMatName

String Ogre::SimpleRenderable::mMatName

protected inherited

Definition at line 58 of file OgreSimpleRenderable.h.

## mMinPixelSize

Real Ogre::MovableObject::mMinPixelSize

protected inherited

Definition at line 126 of file OgreMovableObject.h.

## mName

String Ogre::MovableObject::mName

protected inherited

Name of this object.

Definition at line 110 of file OgreMovableObject.h.

## mNode

SceneNode* Ogre::Volume::Chunk::mNode

protected

To attach this node to.

Definition at line 154 of file OgreVolumeChunk.h.

## mOctree

Entity* Ogre::Volume::Chunk::mOctree

protected

The debug visualization of the octree.

Definition at line 163 of file OgreVolumeChunk.h.

## MOVABLE_TYPE_NAME

const String Ogre::Volume::Chunk::MOVABLE_TYPE_NAME

static

The type name.

Definition at line 315 of file OgreVolumeChunk.h.

## mParentIsTagPoint

bool Ogre::MovableObject::mParentIsTagPoint

protected inherited

Definition at line 117 of file OgreMovableObject.h.

## mParentNode

Node* Ogre::MovableObject::mParentNode

protected inherited

node to which this object is attached

Definition at line 116 of file OgreMovableObject.h.

## mParentSceneManager

SceneManager* Ogre::SimpleRenderable::mParentSceneManager

protected inherited

The scene manager for the current frame.

Definition at line 62 of file OgreSimpleRenderable.h.

## mPolygonModeOverrideable

bool Ogre::Renderable::mPolygonModeOverrideable

protected inherited

Definition at line 416 of file OgreRenderable.h.

## mQueryFlags

uint32 Ogre::MovableObject::mQueryFlags

protected inherited

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

Definition at line 140 of file OgreMovableObject.h.

## mRenderingDisabled

bool Ogre::MovableObject::mRenderingDisabled

protected inherited

Does rendering this object disabled by listener?

Definition at line 153 of file OgreMovableObject.h.

## mRenderOp

RenderOperation Ogre::SimpleRenderable::mRenderOp

protected inherited

Definition at line 53 of file OgreSimpleRenderable.h.

## mRenderQueueID

uint8 Ogre::MovableObject::mRenderQueueID

protected inherited

The render queue to use when rendering this object.

Definition at line 132 of file OgreMovableObject.h.

## mRenderQueueIDSet

bool Ogre::MovableObject::mRenderQueueIDSet

protected inherited

Flags whether the RenderQueue's default should be used.

Definition at line 134 of file OgreMovableObject.h.

## mRenderQueuePriority

ushort Ogre::MovableObject::mRenderQueuePriority

protected inherited

The render queue group to use when rendering this object.

Definition at line 136 of file OgreMovableObject.h.

## mRenderQueuePrioritySet

bool Ogre::MovableObject::mRenderQueuePrioritySet

protected inherited

Flags whether the RenderQueue's default should be used.

Definition at line 138 of file OgreMovableObject.h.

## mRenderSystemData

RenderSystemData* Ogre::Renderable::mRenderSystemData

mutable protected inherited

User objects binding.

Definition at line 420 of file OgreRenderable.h.

## msAnimableDictionary

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary

static protected inherited

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

Definition at line 243 of file OgreAnimable.h.

## msDefaultQueryFlags

uint32 Ogre::MovableObject::msDefaultQueryFlags

static protected inherited

Default query flags.

Definition at line 167 of file OgreMovableObject.h.

## msDefaultVisibilityFlags

uint32 Ogre::MovableObject::msDefaultVisibilityFlags

static protected inherited

Default visibility flags.

Definition at line 169 of file OgreMovableObject.h.

## msGenNameCount

uint Ogre::SimpleRenderable::msGenNameCount

static protected inherited

Static member used to automatically generate names for SimpleRendaerable objects.

Definition at line 68 of file OgreSimpleRenderable.h.

## mShared

ChunkTreeSharedData* Ogre::Volume::Chunk::mShared

protected

Holds some shared data among all chunks of the tree.

Definition at line 175 of file OgreVolumeChunk.h.

## mSquaredUpperDistance

Real Ogre::MovableObject::mSquaredUpperDistance

protected inherited

Definition at line 124 of file OgreMovableObject.h.

## mUpperDistance

Real Ogre::MovableObject::mUpperDistance

protected inherited

Upper distance to still render.

Definition at line 123 of file OgreMovableObject.h.

## mUseIdentityProjection

bool Ogre::Renderable::mUseIdentityProjection

protected inherited

Definition at line 417 of file OgreRenderable.h.

## mUseIdentityView

bool Ogre::Renderable::mUseIdentityView

protected inherited

Definition at line 418 of file OgreRenderable.h.

## mUserObjectBindings [1/2]

UserObjectBindings Ogre::MovableObject::mUserObjectBindings

protected inherited

User objects binding.

Definition at line 130 of file OgreMovableObject.h.

## mUserObjectBindings [2/2]

UserObjectBindings Ogre::Renderable::mUserObjectBindings

protected inherited

Definition at line 419 of file OgreRenderable.h.

## mVisibilityFlags

uint32 Ogre::MovableObject::mVisibilityFlags

protected inherited

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

Definition at line 142 of file OgreMovableObject.h.

## mVisible

bool Ogre::MovableObject::mVisible

protected inherited

Is this object visible?

Definition at line 119 of file OgreMovableObject.h.

## mWorldAABB

AxisAlignedBox Ogre::MovableObject::mWorldAABB

mutable protected inherited

Cached world AABB of this object.

Definition at line 144 of file OgreMovableObject.h.

## mWorldBoundingSphere

Sphere Ogre::MovableObject::mWorldBoundingSphere

mutable protected inherited

Definition at line 146 of file OgreMovableObject.h.

## mWorldDarkCapBounds

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds

mutable protected inherited

World space AABB of this object's dark cap.

Definition at line 148 of file OgreMovableObject.h.

## mWorldTransform

Matrix4 Ogre::SimpleRenderable::mWorldTransform

protected inherited

Definition at line 55 of file OgreSimpleRenderable.h.

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

- OgreVolumeChunk.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.