OGRE-Next  3.0.0
Object-Oriented Graphics Rendering Engine
Ogre::Volume::ChunkParameters Struct Reference

Parameters for loading the volume. More...

#include <OgreVolumeChunk.h>

Public Member Functions

 ChunkParameters ()
 Constructor. More...
 

Public Attributes

bool async
 Whether to load the chunks async. if set to false, the call to load waits for the whole chunk. false is the default. More...
 
Real baseError
 The smallest allowed geometric error of the highest LOD. More...
 
bool createDualGridVisualization
 Whether to create the dualgrid debug visualization entity with false as default. More...
 
size_t createGeometryFromLevel
 The first LOD level to create geometry for. For scenarios where the lower levels won't be visible anyway. 0 is the default and switches this off. More...
 
bool createOctreeVisualization
 Whether to create the octree debug visualization entity with false as default. More...
 
Real errorMultiplicator
 The error multiplicator per LOD level with 1.0 as default. More...
 
MeshBuilderCallbacklodCallback
 Callback for a specific LOD level. More...
 
Real maxScreenSpaceError
 The maximum accepted screen space error when choosing the LOD levels to render. More...
 
Real scale
 The scale of the volume with 1.0 as default. More...
 
SceneManagersceneManager
 The scenemanager to construct the entity with. More...
 
Real skirtFactor
 Factor for the skirt length generation. More...
 
Sourcesrc
 The volume source. More...
 
Vector3 updateFrom
 If an existing chunktree is to be partially updated, set this to the back lower left point of the (sub-)cube to be reloaded. Else, set both update vectors to zero (initial load). 1.5 is the default. More...
 
Vector3 updateTo
 If an existing chunktree is to be partially updated, set this to the front upper right point of the (sub-)cube to be reloaded. Else, set both update vectors to zero (initial load). More...
 

Detailed Description

Parameters for loading the volume.

Constructor & Destructor Documentation

◆ ChunkParameters()

Ogre::Volume::ChunkParameters::ChunkParameters ( )
inline

Constructor.

Member Data Documentation

◆ async

bool Ogre::Volume::ChunkParameters::async

Whether to load the chunks async. if set to false, the call to load waits for the whole chunk. false is the default.

◆ baseError

Real Ogre::Volume::ChunkParameters::baseError

The smallest allowed geometric error of the highest LOD.

◆ createDualGridVisualization

bool Ogre::Volume::ChunkParameters::createDualGridVisualization

Whether to create the dualgrid debug visualization entity with false as default.

◆ createGeometryFromLevel

size_t Ogre::Volume::ChunkParameters::createGeometryFromLevel

The first LOD level to create geometry for. For scenarios where the lower levels won't be visible anyway. 0 is the default and switches this off.

◆ createOctreeVisualization

bool Ogre::Volume::ChunkParameters::createOctreeVisualization

Whether to create the octree debug visualization entity with false as default.

◆ errorMultiplicator

Real Ogre::Volume::ChunkParameters::errorMultiplicator

The error multiplicator per LOD level with 1.0 as default.

◆ lodCallback

MeshBuilderCallback* Ogre::Volume::ChunkParameters::lodCallback

Callback for a specific LOD level.

◆ maxScreenSpaceError

Real Ogre::Volume::ChunkParameters::maxScreenSpaceError

The maximum accepted screen space error when choosing the LOD levels to render.

◆ scale

Real Ogre::Volume::ChunkParameters::scale

The scale of the volume with 1.0 as default.

◆ sceneManager

SceneManager* Ogre::Volume::ChunkParameters::sceneManager

The scenemanager to construct the entity with.

◆ skirtFactor

Real Ogre::Volume::ChunkParameters::skirtFactor

Factor for the skirt length generation.

◆ src

Source* Ogre::Volume::ChunkParameters::src

The volume source.

◆ updateFrom

Vector3 Ogre::Volume::ChunkParameters::updateFrom

If an existing chunktree is to be partially updated, set this to the back lower left point of the (sub-)cube to be reloaded. Else, set both update vectors to zero (initial load). 1.5 is the default.

◆ updateTo

Vector3 Ogre::Volume::ChunkParameters::updateTo

If an existing chunktree is to be partially updated, set this to the front upper right point of the (sub-)cube to be reloaded. Else, set both update vectors to zero (initial load).


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