OgreVolumeChunk.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __Ogre_Volume_Chunk_H__
29 #define __Ogre_Volume_Chunk_H__
30 
31 #include "OgreSimpleRenderable.h"
32 #include "OgreSceneNode.h"
34 #include "OgreFrameListener.h"
35 
37 #include "OgreVolumeChunkHandler.h"
38 #include "OgreVolumeSource.h"
39 #include "OgreVolumeOctreeNode.h"
41 #include "OgreVolumeMeshBuilder.h"
42 
43 
44 namespace Ogre {
45 namespace Volume {
46 
47  class ChunkHandler;
48 
51  typedef struct ChunkParameters
52  {
55 
58 
61 
64 
67 
70 
73 
76 
79 
82 
85 
88 
91 
93  bool async;
94 
100  updateFrom(Vector3::ZERO), updateTo(Vector3::ZERO), async(false)
101  {
102  }
103  } ChunkParameters;
104 
107  typedef struct ChunkTreeSharedData
108  {
111 
114 
117 
120 
123 
127  {
128  this->parameters = new ChunkParameters(*params);
129  }
130 
134  {
135  delete parameters;
136  }
137 
139 
143  {
144 
146  friend class ChunkHandler;
147 
148  protected:
149 
152 
155 
158 
161 
164 
167 
170 
172  bool isRoot;
173 
176 
193  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);
194 
204  virtual bool contributesToVolumeMesh(const Vector3 &from, const Vector3 &to) const;
205 
222  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);
223 
240  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);
241 
256  virtual void prepareGeometry(size_t level, OctreeNode *root, DualGridGenerator *dualGridGenerator, MeshBuilder *meshBuilder, const Vector3 &totalFrom, const Vector3 &totalTo);
257 
270  virtual void loadGeometry(MeshBuilder *meshBuilder, DualGridGenerator *dualGridGenerator, OctreeNode *root, size_t level, bool isUpdate);
271 
278  inline void setChunkVisible(const bool visible, const bool applyToChildren)
279  {
280  if (mInvisible)
281  {
282  return;
283  }
284  if (mShared->volumeVisible)
285  {
286  mVisible = visible;
287  }
288  if (mOctree)
289  {
290  mOctree->setVisible(mShared->octreeVisible && visible);
291  }
292  if (mDualGrid)
293  {
294  mDualGrid->setVisible(mShared->dualGridVisible && visible);
295  }
296  if (applyToChildren && mChildren)
297  {
298  mChildren[0]->setChunkVisible(visible, applyToChildren);
299  if (mChildren[1])
300  {
301  mChildren[1]->setChunkVisible(visible, applyToChildren);
302  mChildren[2]->setChunkVisible(visible, applyToChildren);
303  mChildren[3]->setChunkVisible(visible, applyToChildren);
304  mChildren[4]->setChunkVisible(visible, applyToChildren);
305  mChildren[5]->setChunkVisible(visible, applyToChildren);
306  mChildren[6]->setChunkVisible(visible, applyToChildren);
307  mChildren[7]->setChunkVisible(visible, applyToChildren);
308  }
309  }
310  }
311 
312  public:
313 
315  static const String MOVABLE_TYPE_NAME;
316 
319  Chunk(void);
320 
323  virtual ~Chunk(void);
324 
327  virtual const String& getMovableType(void) const;
328 
331  virtual Real getSquaredViewDepth(const Camera* camera) const;
332 
335  virtual Real getBoundingRadius() const;
336 
349  virtual void load(SceneNode *parent, const Vector3 &from, const Vector3 &to, size_t level, const ChunkParameters *parameters);
350 
367  virtual void load(SceneNode *parent, SceneManager *sceneManager, const String& filename, bool validSourceResult = false, MeshBuilderCallback *lodCallback = 0, const String& resourceGroup = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);
368 
373  virtual void setDualGridVisible(const bool visible);
374 
380  virtual bool getDualGridVisible(void) const;
381 
386  virtual void setOctreeVisible(const bool visible);
387 
393  virtual bool getOctreeVisible(void) const;
394 
399  virtual void setVolumeVisible(const bool visible);
400 
405  virtual bool getVolumeVisible(void) const;
406 
409  virtual bool frameStarted(const FrameEvent& evt);
410 
415  virtual Chunk* createInstance(void);
416 
420  virtual void setMaterial(const String& matName);
421 
430  virtual void setMaterialOfLevel(size_t level, const String& matName);
431 
435 
443  virtual void getChunksOfLevel(const size_t level, VecChunk &result) const;
444 
449  ChunkParameters* getChunkParameters(void);
450 
451  };
452 }
453 }
454 
455 #endif
Ogre::FrameListener
A interface class defining a listener which can be used to receive notifications of frame events.
Definition: OgreFrameListener.h:79
Ogre::Volume::ChunkParameters::updateFrom
Vector3 updateFrom
If an existing chunktree is to be partially updated, set this to the back lower left point of the (su...
Definition: OgreVolumeChunk.h:87
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::Volume::MeshBuilder
Class to build up a mesh with vertices and indices.
Definition: OgreVolumeMeshBuilder.h:132
Ogre::Volume::ChunkParameters::lodCallback
MeshBuilderCallback * lodCallback
Callback for a specific LOD level.
Definition: OgreVolumeChunk.h:75
Ogre::Volume::ChunkParameters::createDualGridVisualization
bool createDualGridVisualization
Whether to create the dualgrid debug visualization entity with false as default.
Definition: OgreVolumeChunk.h:69
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
Ogre::Volume::ChunkParameters::maxScreenSpaceError
Real maxScreenSpaceError
The maximum accepted screen space error when choosing the LOD levels to render.
Definition: OgreVolumeChunk.h:81
Ogre::Volume::ChunkTreeSharedData::dualGridVisible
bool dualGridVisible
Flag whether the dualgrid is visible or not.
Definition: OgreVolumeChunk.h:113
Ogre::Volume::ChunkParameters::updateTo
Vector3 updateTo
If an existing chunktree is to be partially updated, set this to the front upper right point of the (...
Definition: OgreVolumeChunk.h:90
Ogre::Volume::Chunk::mError
Real mError
Holds the error associated with this chunk.
Definition: OgreVolumeChunk.h:157
Ogre::Volume::Chunk::MOVABLE_TYPE_NAME
static const String MOVABLE_TYPE_NAME
The type name.
Definition: OgreVolumeChunk.h:315
Ogre::Volume::ChunkParameters::ChunkParameters
ChunkParameters(void)
Constructor.
Definition: OgreVolumeChunk.h:97
Ogre::Volume::Chunk::VecChunk
vector< const Chunk * >::type VecChunk
A list of Chunks.
Definition: OgreVolumeChunk.h:434
OgreVolumeDualGridGenerator.h
Ogre::Volume::ChunkTreeSharedData
struct Ogre::Volume::ChunkTreeSharedData ChunkTreeSharedData
Internal shared values of the chunks which are equal in the whole tree.
Ogre::Volume::ChunkTreeSharedData
Internal shared values of the chunks which are equal in the whole tree.
Definition: OgreVolumeChunk.h:107
OgreVolumeSource.h
OgreSimpleRenderable.h
OgreVolumeChunkHandler.h
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::Volume::Chunk
A single volume chunk mesh.
Definition: OgreVolumeChunk.h:142
Ogre::Volume::ChunkHandler
Handles the WorkQueue management of the chunks.
Definition: OgreVolumeChunkHandler.h:90
OgreResourceGroupManager.h
Ogre::Volume::MeshBuilderCallback
Callback class when the user needs information about the triangles of chunks of a LOD level.
Definition: OgreVolumeMeshBuilder.h:110
Ogre::Volume::ChunkParameters::createGeometryFromLevel
size_t createGeometryFromLevel
The first LOD level to create geometry for. For scenarios where the lower levels won't be visible any...
Definition: OgreVolumeChunk.h:84
Ogre::Entity
Defines an instance of a discrete, movable object based on a Mesh.
Definition: OgreEntity.h:82
Ogre::SceneNode
Class representing a node in the scene graph.
Definition: OgreSceneNode.h:58
Ogre::Volume::Chunk::setChunkVisible
void setChunkVisible(const bool visible, const bool applyToChildren)
Sets the visibility of this chunk.
Definition: OgreVolumeChunk.h:278
Ogre::vector::type
std::vector< T, A > type
Definition: OgrePrerequisites.h:494
Ogre::Volume::Chunk::mChildren
Chunk ** mChildren
The more detailed children chunks.
Definition: OgreVolumeChunk.h:166
Ogre::Volume::Chunk::mNode
SceneNode * mNode
To attach this node to.
Definition: OgreVolumeChunk.h:154
OgreFrameListener.h
Ogre::SceneManager
Manages the organisation and rendering of a 'scene' i.e.
Definition: OgreSceneManager.h:143
Ogre::Volume::Chunk::mDualGrid
Entity * mDualGrid
Holds the dualgrid debug visualization.
Definition: OgreVolumeChunk.h:160
Ogre::Volume::Chunk::mInvisible
bool mInvisible
Flag whether this node will never be shown.
Definition: OgreVolumeChunk.h:169
Ogre::Volume::Chunk::mShared
ChunkTreeSharedData * mShared
Holds some shared data among all chunks of the tree.
Definition: OgreVolumeChunk.h:175
Ogre::Volume::ChunkParameters
Parameters for loading the volume.
Definition: OgreVolumeChunk.h:51
Ogre::Volume::Chunk::mOctree
Entity * mOctree
The debug visualization of the octree.
Definition: OgreVolumeChunk.h:163
Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME
static String DEFAULT_RESOURCE_GROUP_NAME
Default resource group name.
Definition: OgreResourceGroupManager.h:266
Ogre::Volume::ChunkParameters::createOctreeVisualization
bool createOctreeVisualization
Whether to create the octree debug visualization entity with false as default.
Definition: OgreVolumeChunk.h:66
Ogre::Volume::ChunkParameters::errorMultiplicator
Real errorMultiplicator
The error multiplicator per LOD level with 1.0 as default.
Definition: OgreVolumeChunk.h:63
Ogre::Volume::ChunkParameters::skirtFactor
Real skirtFactor
Factor for the skirt length generation.
Definition: OgreVolumeChunk.h:72
OgreVolumeMeshBuilder.h
Ogre::Volume::ChunkTreeSharedData::octreeVisible
bool octreeVisible
Flag whether the octree is visible or not.
Definition: OgreVolumeChunk.h:110
OgreSceneNode.h
Ogre::FrameEvent
Struct containing information about a frame event.
Definition: OgreFrameListener.h:44
Ogre::Volume::ChunkParameters::scale
Real scale
The scale of the volume with 1.0 as default.
Definition: OgreVolumeChunk.h:78
Ogre::Volume::ChunkTreeSharedData::volumeVisible
bool volumeVisible
Another visibility flag to be user setable.
Definition: OgreVolumeChunk.h:116
_OgreVolumeExport
#define _OgreVolumeExport
Definition: OgreVolumePrerequisites.h:43
Ogre::Volume::ChunkTreeSharedData::parameters
ChunkParameters * parameters
The parameters with which the chunktree got loaded.
Definition: OgreVolumeChunk.h:122
Ogre::Volume::ChunkTreeSharedData::ChunkTreeSharedData
ChunkTreeSharedData(const ChunkParameters *params)
Constructor.
Definition: OgreVolumeChunk.h:126
Ogre::Volume::Chunk::mChunkHandler
static ChunkHandler mChunkHandler
To handle the WorkQueue.
Definition: OgreVolumeChunk.h:151
Ogre::Volume::ChunkParameters
struct Ogre::Volume::ChunkParameters ChunkParameters
Parameters for loading the volume.
Ogre::Volume::ChunkParameters::sceneManager
SceneManager * sceneManager
The scenemanager to construct the entity with.
Definition: OgreVolumeChunk.h:54
Ogre::Volume::DualGridGenerator
Class for the generation of the DualGrid.
Definition: OgreVolumeDualGridGenerator.h:67
Ogre::SimpleRenderable
Simple implementation of MovableObject and Renderable for single-part custom objects.
Definition: OgreSimpleRenderable.h:50
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::Volume::ChunkParameters::async
bool async
Whether to load the chunks async. if set to false, the call to load waits for the whole chunk....
Definition: OgreVolumeChunk.h:93
OgreVolumePrerequisites.h
OgreVolumeOctreeNode.h
Ogre::Volume::Chunk::isRoot
bool isRoot
Whether this chunk is the root of the tree.
Definition: OgreVolumeChunk.h:172
Ogre::Volume::ChunkTreeSharedData::chunksBeingProcessed
int chunksBeingProcessed
The amount of chunks being processed (== loading).
Definition: OgreVolumeChunk.h:119
Ogre::Volume::ChunkTreeSharedData::~ChunkTreeSharedData
~ChunkTreeSharedData(void)
Destructor.
Definition: OgreVolumeChunk.h:133
Ogre::Volume::ChunkParameters::baseError
Real baseError
The smallest allowed geometric error of the highest LOD.
Definition: OgreVolumeChunk.h:60
Ogre::Vector3
Standard 3-dimensional vector.
Definition: OgreVector3.h:51
Ogre::Volume::Source
Abstract class defining the density function.
Definition: OgreVolumeSource.h:41
Ogre::MovableObject::setVisible
virtual void setVisible(bool visible)
Tells this object whether to be visible or not, if it has a renderable component.
Ogre::Volume::ChunkParameters::src
Source * src
The volume source.
Definition: OgreVolumeChunk.h:57
Ogre::Volume::OctreeNode
A node in the volume octree.
Definition: OgreVolumeOctreeNode.h:45

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Apr 13 2021 08:53:15