OGRE  1.10.12
Object-Oriented Graphics Rendering Engine
Ogre::Volume::CSGNoiseSource Class Reference

#include <OgreVolumeCSGSource.h>

+ Inheritance diagram for Ogre::Volume::CSGNoiseSource:

Public Member Functions

 CSGNoiseSource (const Source *src, Real *frequencies, Real *amplitudes, size_t numOctaves, long seed)
 Constructor. More...
 
 CSGNoiseSource (const Source *src, Real *frequencies, Real *amplitudes, size_t numOctaves)
 Constructor with current time as seed. More...
 
bool getFirstRayIntersection (const Ray &ray, Vector3 &result, Real scale=(Real) 1.0, size_t maxIterations=5000, Real maxDistance=(Real) 10000.0) const
 Gets the first intersection of a ray with the volume. More...
 
long getSeed (void) const
 Gets the initial seed. More...
 
virtual const SourcegetSource (void) const
 Gets the source. More...
 
virtual Real getValue (const Vector3 &position) const
 Overridden from Source. More...
 
virtual Vector4 getValueAndGradient (const Vector3 &position) const
 Overridden from Source. More...
 
Real getVolumeSpaceToWorldSpaceFactor (void) const
 Gets a factor to come from volume coordinate to world coordinate. More...
 
void serialize (const Vector3 &from, const Vector3 &to, float voxelWidth, const String &file)
 Serializes a volume source to a discrete grid file with deflated compression. More...
 
void serialize (const Vector3 &from, const Vector3 &to, float voxelWidth, Real maxClampedAbsoluteDensity, const String &file)
 Same as the other serialize function but with a user definable maximum absolute density value. More...
 
virtual void setSource (Source *a)
 Sets the source. More...
 

Static Public Attributes

static const size_t SERIALIZATION_CHUNK_SIZE
 The amount of items being written as one chunk during serialization. More...
 
static const uint32 VOLUME_CHUNK_ID
 The id of volume files. More...
 
static const uint16 VOLUME_CHUNK_VERSION
 The version of volume files. More...
 

Constructor & Destructor Documentation

◆ CSGNoiseSource() [1/2]

Ogre::Volume::CSGNoiseSource::CSGNoiseSource ( const Source src,
Real frequencies,
Real amplitudes,
size_t  numOctaves,
long  seed 
)

Constructor.

Parameters
srcThe source to add the noise to.
frequenciesThe frequencies of the added noise octaves.
amplitudesThe amplitudes of the added noise octaves.
numOctavesThe amount of octaves.
seedThe seed to initialize the random number generator with.

◆ CSGNoiseSource() [2/2]

Ogre::Volume::CSGNoiseSource::CSGNoiseSource ( const Source src,
Real frequencies,
Real amplitudes,
size_t  numOctaves 
)

Constructor with current time as seed.

Parameters
srcThe source to add the noise to.
frequenciesThe frequencies of the added noise octaves.
amplitudesThe amplitudes of the added noise octaves.
numOctavesThe amount of octaves.

Member Function Documentation

◆ getValueAndGradient()

virtual Vector4 Ogre::Volume::CSGNoiseSource::getValueAndGradient ( const Vector3 position) const
virtual

Overridden from Source.

Implements Ogre::Volume::Source.

◆ getValue()

virtual Real Ogre::Volume::CSGNoiseSource::getValue ( const Vector3 position) const
virtual

Overridden from Source.

Implements Ogre::Volume::Source.

◆ getSeed()

long Ogre::Volume::CSGNoiseSource::getSeed ( void  ) const

Gets the initial seed.

Returns
The initial seed.

◆ getSource()

virtual const Source* Ogre::Volume::CSGUnarySource::getSource ( void  ) const
virtualinherited

Gets the source.

Returns
The source.

◆ setSource()

virtual void Ogre::Volume::CSGUnarySource::setSource ( Source a)
virtualinherited

Sets the source.

Parameters
aThe source.

◆ serialize() [1/2]

void Ogre::Volume::Source::serialize ( const Vector3 from,
const Vector3 to,
float  voxelWidth,
const String file 
)
inherited

Serializes a volume source to a discrete grid file with deflated compression.

To achieve better compression, all density values are clamped within a maximum absolute value of (to - from).length() / 16.0. The values are scanned in this inner-loop-order: z, x, y. y last because there is usually the least isosurface intersection to be expected in the use case of terrain and so more often the maximum density value hit. The values are written as 16 Bit floats to save space. Note that this process is not lossless, the tradeoff is between accuracy of the source-reproduction (smaller voxelWidth) and smaller filesize (bigger voxelWidth).

Parameters
fromThe start point to scan the volume.
toThe end point to scan the volume.
voxelWidthThe width of a single cube in the density grid.
fileThe file to write the grid to.

◆ serialize() [2/2]

void Ogre::Volume::Source::serialize ( const Vector3 from,
const Vector3 to,
float  voxelWidth,
Real  maxClampedAbsoluteDensity,
const String file 
)
inherited

Same as the other serialize function but with a user definable maximum absolute density value.

Parameters
fromThe start point to scan the volume.
toThe end point to scan the volume.
voxelWidthThe width of a single cube in the density grid.
maxClampedAbsoluteDensityThe maximum absolute density value to be written into the file, influencing the compression rate.
fileThe file to write the grid to.

◆ getFirstRayIntersection()

bool Ogre::Volume::Source::getFirstRayIntersection ( const Ray ray,
Vector3 result,
Real  scale = (Real) 1.0,
size_t  maxIterations = 5000,
Real  maxDistance = (Real) 10000.0 
) const
inherited

Gets the first intersection of a ray with the volume.

If you are using this together with the VolumeChunk: Beware of the possible scaling or other transformations you did on the Chunk! Do the inverse first on the ray origin. Example of a scaling with the factor 10: ray.setOrigin(ray.getOrigin() / (Real)10.0);

Parameters
rayThe ray.
resultWill hold the intersection point if there is an intersection.
scaleThe scaling of the volume compared to the world.
maxIterationsThe maximum amount of iterations on the ray before giving up.
maxDistanceThe maximum distance of the intersection point.

◆ getVolumeSpaceToWorldSpaceFactor()

Real Ogre::Volume::Source::getVolumeSpaceToWorldSpaceFactor ( void  ) const
inherited

Gets a factor to come from volume coordinate to world coordinate.

Returns
The factor, 1.0 in the default implementation.

Member Data Documentation

◆ VOLUME_CHUNK_ID

const uint32 Ogre::Volume::Source::VOLUME_CHUNK_ID
staticinherited

The id of volume files.

◆ VOLUME_CHUNK_VERSION

const uint16 Ogre::Volume::Source::VOLUME_CHUNK_VERSION
staticinherited

The version of volume files.

◆ SERIALIZATION_CHUNK_SIZE

const size_t Ogre::Volume::Source::SERIALIZATION_CHUNK_SIZE
staticinherited

The amount of items being written as one chunk during serialization.


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