#include <OgreVolumeCacheSource.h>

Inheritance diagram for Ogre::Volume::CacheSource:

Public Member Functions
	CacheSource (const Source *src)
	Constructor.
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.
virtual Real	getValue (const Vector3 &position) const
	Overridden from Source.
virtual Vector4	getValueAndGradient (const Vector3 &position) const
	Overridden from Source.
Real	getVolumeSpaceToWorldSpaceFactor (void) const
	Gets a factor to come from volume coordinate to world coordinate.
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.
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.
Static Public Attributes
static const size_t	SERIALIZATION_CHUNK_SIZE
	The amount of items being written as one chunk during serialization.
static const uint32	VOLUME_CHUNK_ID
	The id of volume files.
static const uint16	VOLUME_CHUNK_VERSION
	The version of volume files.
Protected Types
typedef map< Vector3, Vector4 > ::type	UMapPositionValue
	Map for the cache.
Protected Member Functions
Vector4	getFromCache (const Vector3 &position) const
	Gets a density value and gradient from the cache.
virtual Vector3	getIntersectionEnd (const Ray &ray, Real maxDistance) const
	Gets the end vector of an intersection.
virtual Vector3	getIntersectionStart (const Ray &ray, Real maxDistance) const
	Gets the start vector of an intersection.
Protected Attributes
UMapPositionValue	mCache
const Source *	mSrc
	The source to cache.

Detailed Description

A caching Source.

Definition at line 52 of file OgreVolumeCacheSource.h.

Member Typedef Documentation

typedef map<Vector3, Vector4>::type Ogre::Volume::CacheSource::UMapPositionValue [protected]

Map for the cache.

Definition at line 57 of file OgreVolumeCacheSource.h.

Constructor & Destructor Documentation

Ogre::Volume::CacheSource::CacheSource ( const Source * src )

Constructor.

Parameters:

src	The source to cache.

Member Function Documentation

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:

ray	The ray.
result	Will hold the intersection point if there is an intersection.
scale	The scaling of the volume compared to the world.
maxIterations	The maximum amount of iterations on the ray before giving up.
maxDistance	The maximum distance of the intersection point.

Vector4 Ogre::Volume::CacheSource::getFromCache ( const Vector3 & position ) const [protected]

Gets a density value and gradient from the cache.

Parameters:

position The position of the density value and gradient.

Returns:: The density value (w-component) and the gradient (x, y and z component).

Definition at line 69 of file OgreVolumeCacheSource.h.

virtual Vector3 Ogre::Volume::Source::getIntersectionEnd	(	const Ray &	ray,
		Real	maxDistance
	)		const `[protected, virtual, inherited]`

Gets the end vector of an intersection.

This is needed for restricted volumes like discreet grids.

Parameters:

ray	The ray of the intersection.
maxDistance	The maximum distance to query the ray for intersections.

Returns:: The end point of the intersection ray.

Reimplemented in Ogre::Volume::GridSource.

virtual Vector3 Ogre::Volume::Source::getIntersectionStart	(	const Ray &	ray,
		Real	maxDistance
	)		const `[protected, virtual, inherited]`

Gets the start vector of an intersection.

This is needed for restricted volumes like discreet grids.

Parameters:

ray	The ray of the intersection.
maxDistance	The maximum distance to query the ray for intersections.

Returns:: The start point of the intersection ray.

Reimplemented in Ogre::Volume::GridSource.

virtual Real Ogre::Volume::CacheSource::getValue ( const Vector3 & position ) const [virtual]

Overridden from Source.

Implements Ogre::Volume::Source.

virtual Vector4 Ogre::Volume::CacheSource::getValueAndGradient ( const Vector3 & position ) const [virtual]

Overridden from Source.

Implements Ogre::Volume::Source.

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.

Reimplemented in Ogre::Volume::GridSource.

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:

from	The start point to scan the volume.
to	The end point to scan the volume.
voxelWidth	The width of a single cube in the density grid.
file	The file to write the grid to.

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:

from	The start point to scan the volume.
to	The end point to scan the volume.
voxelWidth	The width of a single cube in the density grid.
maxClampedAbsoluteDensity	The maximum absolute density value to be written into the file, influencing the compression rate.
file	The file to write the grid to.