Ogre::Volume::HalfFloatGridSource Class Reference

A volume source from a 16 Bit float 3D grid capable of loading volume serializations. More...

`#include <OgreVolumeHalfFloatGridSource.h>`

Inheritance diagram for Ogre::Volume::HalfFloatGridSource:
[legend]

## Public Member Functions

| HalfFloatGridSource (const String &serializedVolumeFile, const bool trilinearValue=true, const bool trilinearGradient=false, const bool sobelGradient=false)
| Constructur. More...
| ~HalfFloatGridSource (void)
| Destructor. More...
virtual void | combineWithSource (CSGOperationSource *operation, Source *source, const Vector3 &center, Real radius)
| Updates this grid with another source in a certain area. More...
size_t | getDepth (void) const
| Gets the depth of the texture. 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...
size_t | getHeight (void) const
| Gets the height of the texture. More...
Real | getMaxClampedAbsoluteDensity (void) const
| Gets the maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization. More...
virtual Real | getValue (const Vector3 &position) const
| Overridden from VolumeSource. More...
virtual Vector4 | getValueAndGradient (const Vector3 &position) const
| Overridden from VolumeSource. More...
Real | getVolumeSpaceToWorldSpaceFactor (void) const
| Overridden from VolumeSource. More...
size_t | getWidth (void) const
| Gets the width of the texture. 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...
void | setMaxClampedAbsoluteDensity (Real maxClampedAbsoluteDensity)
| Sets the maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization. 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...

## Protected Member Functions

const Vector3 | getGradient (size_t x, size_t y, size_t z) const
| Gets a gradient of a point with optional sobel blurring. More...
virtual Vector3 | getIntersectionEnd (const Ray &ray, Real maxDistance) const
| Overridden from VolumeSource. More...
virtual Vector3 | getIntersectionStart (const Ray &ray, Real maxDistance) const
| Overridden from VolumeSource. More...
virtual float | getVolumeGridValue (size_t x, size_t y, size_t z) const
| Overridden from GridSource. More...
virtual void | setVolumeGridValue (int x, int y, int z, float value)
| Overridden from GridSource. More...

## Protected Attributes

uint16 * | mData
| The raw volume data. More...
size_t | mDepth
| The texture depth. More...
int | mDepthTimesHeight
| To have a little bit faster data access. More...
size_t | mHeight
| The texture height. More...
Real | mMaxClampedAbsoluteDensity
| The maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization. More...
Real | mPosXScale
| The scale of the position based on the world width. More...
Real | mPosYScale
| The scale of the position based on the world height. More...
Real | mPosZScale
| The scale of the position based on the world depth. More...
const bool | mSobelGradient
| Whether to blur the gradient a bit Sobel like. More...
const bool | mTrilinearGradient
| Whether to use trilinear filtering or not for the gradient. More...
bool | mTrilinearValue
| Whether to use trilinear filtering or not for the value. More...
Real | mVolumeSpaceToWorldSpaceFactor
| Factor to come from volume coordinate to world coordinate. More...
size_t | mWidth
| The texture width. More...

## Detailed Description

A volume source from a 16 Bit float 3D grid capable of loading volume serializations.

Definition at line 40 of file OgreVolumeHalfFloatGridSource.h.

## Constructor & Destructor Documentation

## HalfFloatGridSource()

Ogre::Volume::HalfFloatGridSource::HalfFloatGridSource | ( | const String & | serializedVolumeFile,
|  | const bool | trilinearValue = `true`,
|  | const bool | trilinearGradient = `false`,
|  | const bool | sobelGradient = `false`
| ) |  |

explicit

Constructur.

Parameters

  serializedVolumeFile | Which volume serialization to get the data from.
  trilinearValue | Whether to use trilinear filtering (true) or nearest neighbour (false) for the value.
  trilinearGradient | Whether to use trilinear filtering (true) or nearest neighbour (false) for the gradient.
  sobelGradient | Whether to add a bit of blur to the gradient like in a sobel filter.

## ~HalfFloatGridSource()

Ogre::Volume::HalfFloatGridSource::~HalfFloatGridSource | ( | void |  | ) |

Destructor.

## Member Function Documentation

## combineWithSource()

virtual void Ogre::Volume::GridSource::combineWithSource | ( | CSGOperationSource * | operation,
|  | Source * | source,
|  | const Vector3 & | center,
|  | Real | radius
| ) |  |

virtual inherited

Updates this grid with another source in a certain area.

Use it for example to add spheres as a brush.

Parameters

  operation | The operation to use, will use this source and the other given one as operands. Beware that this function overrides the maybe existing sources in the operation.
  source | The other source to combine this one with.
  center | The rough center of the affected area by the operation. If the other source is a sphere, take its center for example.
  radius | The radius of the affected area. For the example sphere, you might use its radius times two because the density outside of the sphere is needed, too.

## getDepth()

size_t Ogre::Volume::GridSource::getDepth | ( | void |  | ) | const

inherited

Gets the depth of the texture.

Returns
  The depth of the texture.

## 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

  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.

## getGradient()

const Vector3 Ogre::Volume::GridSource::getGradient | ( | size_t | x,
|  | size_t | y,
|  | size_t | z
| ) |  | const

protected inherited

Gets a gradient of a point with optional sobel blurring.

Parameters

  x | The x coordinate of the point.
  y | The x coordinate of the point.
  z | The x coordinate of the point.

Definition at line 116 of file OgreVolumeGridSource.h.

## getHeight()

size_t Ogre::Volume::GridSource::getHeight | ( | void |  | ) | const

inherited

Gets the height of the texture.

Returns
  The height of the texture.

## getIntersectionEnd()

virtual Vector3 Ogre::Volume::GridSource::getIntersectionEnd | ( | const Ray & | ray,
|  | Real | maxDistance
| ) |  | const

protected virtual inherited

Overridden from VolumeSource.

Reimplemented from Ogre::Volume::Source.

## getIntersectionStart()

virtual Vector3 Ogre::Volume::GridSource::getIntersectionStart | ( | const Ray & | ray,
|  | Real | maxDistance
| ) |  | const

protected virtual inherited

Overridden from VolumeSource.

Reimplemented from Ogre::Volume::Source.

## getMaxClampedAbsoluteDensity()

Real Ogre::Volume::HalfFloatGridSource::getMaxClampedAbsoluteDensity | ( | void |  | ) | const

Gets the maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization.

Returns
  The maximum absolute density value, 0.0 when deactivated.

## getValue()

virtual Real Ogre::Volume::GridSource::getValue | ( | const Vector3 & | position | ) | const

virtual inherited

Overridden from VolumeSource.

Implements Ogre::Volume::Source.

## getValueAndGradient()

virtual Vector4 Ogre::Volume::GridSource::getValueAndGradient | ( | const Vector3 & | position | ) | const

virtual inherited

Overridden from VolumeSource.

Implements Ogre::Volume::Source.

## getVolumeGridValue()

virtual float Ogre::Volume::HalfFloatGridSource::getVolumeGridValue | ( | size_t | x,
|  | size_t | y,
|  | size_t | z
| ) |  | const

protected virtual

Overridden from GridSource.

Implements Ogre::Volume::GridSource.

## getVolumeSpaceToWorldSpaceFactor()

Real Ogre::Volume::GridSource::getVolumeSpaceToWorldSpaceFactor | ( | void |  | ) | const

inherited

Overridden from VolumeSource.

## getWidth()

size_t Ogre::Volume::GridSource::getWidth | ( | void |  | ) | const

inherited

Gets the width of the texture.

Returns
  The width of the texture.

## 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

  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.

## 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

  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.

## setMaxClampedAbsoluteDensity()

void Ogre::Volume::HalfFloatGridSource::setMaxClampedAbsoluteDensity | ( | Real | maxClampedAbsoluteDensity | ) |

Sets the maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization.

Set it to 0.0 to deactivate.

Parameters

  maxClampedAbsoluteDensity | The maximum absolute density value.

## setVolumeGridValue()

virtual void Ogre::Volume::HalfFloatGridSource::setVolumeGridValue | ( | int | x,
|  | int | y,
|  | int | z,
|  | float | value
| ) |  |

protected virtual

Overridden from GridSource.

Implements Ogre::Volume::GridSource.

## Member Data Documentation

## mData

uint16* Ogre::Volume::HalfFloatGridSource::mData

protected

The raw volume data.

Definition at line 45 of file OgreVolumeHalfFloatGridSource.h.

## mDepth

size_t Ogre::Volume::GridSource::mDepth

protected inherited

The texture depth.

Definition at line 53 of file OgreVolumeGridSource.h.

## mDepthTimesHeight

int Ogre::Volume::HalfFloatGridSource::mDepthTimesHeight

protected

To have a little bit faster data access.

Definition at line 48 of file OgreVolumeHalfFloatGridSource.h.

## mHeight

size_t Ogre::Volume::GridSource::mHeight

protected inherited

The texture height.

Definition at line 50 of file OgreVolumeGridSource.h.

## mMaxClampedAbsoluteDensity

Real Ogre::Volume::HalfFloatGridSource::mMaxClampedAbsoluteDensity

protected

The maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization.

Definition at line 52 of file OgreVolumeHalfFloatGridSource.h.

## mPosXScale

Real Ogre::Volume::GridSource::mPosXScale

protected inherited

The scale of the position based on the world width.

Definition at line 56 of file OgreVolumeGridSource.h.

## mPosYScale

Real Ogre::Volume::GridSource::mPosYScale

protected inherited

The scale of the position based on the world height.

Definition at line 59 of file OgreVolumeGridSource.h.

## mPosZScale

Real Ogre::Volume::GridSource::mPosZScale

protected inherited

The scale of the position based on the world depth.

Definition at line 62 of file OgreVolumeGridSource.h.

## mSobelGradient

const bool Ogre::Volume::GridSource::mSobelGradient

protected inherited

Whether to blur the gradient a bit Sobel like.

Definition at line 71 of file OgreVolumeGridSource.h.

## mTrilinearGradient

const bool Ogre::Volume::GridSource::mTrilinearGradient

protected inherited

Whether to use trilinear filtering or not for the gradient.

Definition at line 68 of file OgreVolumeGridSource.h.

## mTrilinearValue

bool Ogre::Volume::GridSource::mTrilinearValue

protected inherited

Whether to use trilinear filtering or not for the value.

Definition at line 65 of file OgreVolumeGridSource.h.

## mVolumeSpaceToWorldSpaceFactor

Real Ogre::Volume::GridSource::mVolumeSpaceToWorldSpaceFactor

protected inherited

Factor to come from volume coordinate to world coordinate.

Definition at line 74 of file OgreVolumeGridSource.h.

## mWidth

size_t Ogre::Volume::GridSource::mWidth

protected inherited

The texture width.

Definition at line 47 of file OgreVolumeGridSource.h.

## SERIALIZATION_CHUNK_SIZE

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

static inherited

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

Definition at line 76 of file OgreVolumeSource.h.

## VOLUME_CHUNK_ID

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

static inherited

The id of volume files.

Definition at line 70 of file OgreVolumeSource.h.

## VOLUME_CHUNK_VERSION

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

static inherited

The version of volume files.

Definition at line 73 of file OgreVolumeSource.h.

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

- OgreVolumeHalfFloatGridSource.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.