OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::Volume::Chunk Class Reference

A single volume chunk mesh. More...

#include <OgreVolumeChunk.h>

+ Inheritance diagram for Ogre::Volume::Chunk:

Public Types

typedef std::vector< const Chunk * > VecChunk
 A list of Chunks. More...
 
- Public Types inherited from Ogre::ShadowCaster
typedef std::vector< ShadowRenderable * > ShadowRenderableList
 
typedef VectorIterator< ShadowRenderableListShadowRenderableListIterator
 
- Public Types inherited from Ogre::Renderable
enum  { DEFAULT_PRIORITY = 100 }
 
typedef SharedPtr< RenderSystemDataRenderSystemDataPtr
 

Public Member Functions

 Chunk (void)
 Constructor. More...
 
virtual ~Chunk (void)
 Destructor. More...
 
virtual ChunkcreateInstance (void)
 Overridable factory method. More...
 
virtual bool frameStarted (const FrameEvent &evt)
 Overridden from FrameListener. More...
 
virtual Real getBoundingRadius () const
 Overridden from MovableObject. More...
 
ChunkParametersgetChunkParameters (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...
 
virtual bool getDualGridVisible (void) const
 Gets whether the debug visualization entity of the dualgrid is visible. More...
 
virtual const StringgetMovableType (void) const
 Overridden from MovableObject. More...
 
virtual bool getOctreeVisible (void) const
 Gets whether the debug visualization entity of the octree is visible. More...
 
virtual Real getSquaredViewDepth (const Camera *camera) const
 Overridden from Renderable. More...
 
virtual bool getVolumeVisible (void) const
 Gets whether the volume mesh is visible. 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::AUTODETECT_RESOURCE_GROUP_NAME)
 Loads a TextureSource volume scene from a config file. More...
 
virtual void setDualGridVisible (const bool visible)
 Shows the debug visualization entity of the dualgrid. More...
 
void setMaterial (const MaterialPtr &mat)
 Overridden from SimpleRenderable. More...
 
void setMaterialOfLevel (size_t level, const MaterialPtr &mat)
 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 setVolumeVisible (const bool visible)
 Sets whether the volume mesh is visible. More...
 
- Public Member Functions inherited from Ogre::SimpleRenderable
 SimpleRenderable ()
 Constructor. More...
 
 SimpleRenderable (const String &name)
 Named constructor. 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 _updateRenderQueue (RenderQueue *queue)
 Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...
 
virtual const AxisAlignedBoxgetBoundingBox (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
const LightListgetLights (void) const override
 Gets a list of lights, ordered relative to how close they are to this renderable. More...
 
virtual const MaterialPtrgetMaterial (void) const
 Retrieves a weak reference to the material this renderable object uses. More...
 
virtual void getRenderOperation (RenderOperation &op)
 Gets the render operation required to send this object to the frame buffer. More...
 
virtual void getWorldTransforms (Matrix4 *xform) const
 Gets the world transform matrix / matrices for this renderable object. More...
 
void setBoundingBox (const AxisAlignedBox &box)
 
virtual void setRenderOperation (const RenderOperation &rend)
 
void setTransform (const Affine3 &xform)
 
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) override
 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...
 
- Public Member Functions inherited from Ogre::MovableObject
 MovableObject ()
 Constructor. More...
 
 MovableObject (const String &name)
 Named constructor. More...
 
virtual ~MovableObject ()
 Virtual destructor - read Scott Meyers if you don't know why this is needed. More...
 
MovableObjectFactory_getCreator (void) const
 Get the creator of this object, if any (internal use only) More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
virtual const Affine3_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 _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 _releaseManualHardwareResources ()
 Notifies the movable object that hardware resources were lost. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies the movable object that hardware resources should be restored. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode or TagPoint, if attached. More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
const AxisAlignedBoxgetDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override
 Gets the world space bounding box of the dark cap, as extruded using the light provided. More...
 
EdgeDatagetEdgeList (void)
 Returns details of the edges which might be used to determine a silhouette. More...
 
const AxisAlignedBoxgetLightCapBounds (void) const override
 Gets the world space bounding box of the light cap. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 Returns the scene node to which this object is attached. More...
 
Real getPointExtrusionDistance (const Light *l) const
 Get the distance to extrude for a point/spot light. More...
 
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...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity. More...
 
const ShadowRenderableListgetShadowVolumeRenderableList (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 uint32 getTypeFlags (void) const
 Get the 'type flags' for this MovableObject. More...
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates. More...
 
virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object. More...
 
bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint. More...
 
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...
 
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...
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
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 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...
 
void setUserAny (const Any &anything)
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
- Public Member Functions inherited from Ogre::ShadowCaster
virtual ~ShadowCaster ()
 
virtual ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0)
 
bool hasEdgeList ()
 Returns whether the object has a valid edge list. More...
 
- Public Member Functions inherited from Ogre::AnimableObject
 AnimableObject ()
 
virtual ~AnimableObject ()
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 
- Public Member Functions inherited from Ogre::Renderable
 Renderable ()
 
virtual ~Renderable ()
 Virtual destructor needed as class has virtual methods. 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 bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. More...
 
bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
const RenderSystemDataPtrgetRenderSystemData () const
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. 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...
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index. More...
 
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...
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index. 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...
 
void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
void setRenderSystemData (RenderSystemDataPtr val) const
 
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...
 
void setUserAny (const Any &anything)
 
- Public Member Functions inherited from Ogre::FrameListener
virtual ~FrameListener ()
 
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...
 

Static Public Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from Ogre::MovableObject
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 Member Functions inherited from Ogre::ShadowCaster
static void clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
 Common implementation of releasing shadow renderables. More...
 
static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 Utility method for extruding vertices based on a light. More...
 

Detailed Description

A single volume chunk mesh.

Member Typedef Documentation

◆ VecChunk

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

A list of Chunks.

Constructor & Destructor Documentation

◆ Chunk()

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

Constructor.

◆ ~Chunk()

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

Destructor.

Member Function Documentation

◆ getMovableType()

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

Overridden from MovableObject.

Reimplemented from Ogre::SimpleRenderable.

◆ getSquaredViewDepth()

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

Overridden from Renderable.

Implements Ogre::Renderable.

◆ getBoundingRadius()

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

Overridden from MovableObject.

Implements Ogre::MovableObject.

◆ 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
parentThe parent scene node for the volume
fromThe back lower left corner of the cell.
toThe front upper right corner of the cell.
levelThe amount of LOD level.
parametersThe 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::AUTODETECT_RESOURCE_GROUP_NAME 
)
virtual

Loads a TextureSource volume scene from a config file.

Parameters
parentThe parent scene node for the volume.
sceneManagerThe scenemanager to construct the entity with.
filenameThe filename of the configuration file.
validSourceResultIf 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
lodCallbackCallback for a specific LOD level.
resourceGroupThe resource group where to search for the configuration file.

◆ setDualGridVisible()

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

Shows the debug visualization entity of the dualgrid.

Parameters
visibleWhether the grid should be visible.

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

◆ setOctreeVisible()

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

Shows the debug visualization entity of the octree.

Parameters
visibleWhether the octree should be visible.

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

◆ setVolumeVisible()

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

Sets whether the volume mesh is visible.

Parameters
visibletrue if visible

◆ getVolumeVisible()

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

Gets whether the volume mesh is visible.

Returns
true if visible

◆ frameStarted()

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

Overridden from FrameListener.

Reimplemented from Ogre::FrameListener.

◆ createInstance()

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

Overridable factory method.

Returns
The created chunk.

◆ setMaterial()

void Ogre::Volume::Chunk::setMaterial ( const MaterialPtr mat)
virtual

Overridden from SimpleRenderable.

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

Reimplemented from Ogre::SimpleRenderable.

◆ setMaterialOfLevel()

void Ogre::Volume::Chunk::setMaterialOfLevel ( size_t  level,
const MaterialPtr mat 
)

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
levelThe tree level getting the material, 0 based. 0 means the chunk with the lowest level of detail.
matThe material name to set.

◆ 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
levelThe 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.
resultVector where the chunks will be added to.

◆ getChunkParameters()

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

Gets the parameters with which the chunktree got loaded.

Returns
The parameters.

Member Data Documentation

◆ MOVABLE_TYPE_NAME

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

The type name.


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