Ogre::Volume::CSGIntersectionSource Class Reference

Builds the intersection between two sources. More...

`#include <OgreVolumeCSGSource.h>`

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

## Public Member Functions

| CSGIntersectionSource (const Source *a, const Source *b)
| Constructor. More...
| CSGIntersectionSource (void)
| Constructor, sets the sources to null. 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...
virtual const Source * | getSourceA () const
| Gets the first operator source. More...
virtual const Source * | getSourceB (void) const
| Gets the second operator 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 | setSourceA (Source *a)
| Sets the first operator source. More...
virtual void | setSourceB (Source *b)
| Sets the second operator 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...

## Protected Member Functions

virtual Vector3 | getIntersectionEnd (const Ray &ray, Real maxDistance) const
| Gets the end vector of an intersection. More...
virtual Vector3 | getIntersectionStart (const Ray &ray, Real maxDistance) const
| Gets the start vector of an intersection. More...

## Protected Attributes

const Source * | mA
| The first operant. More...
const Source * | mB
| The second operant. More...

## Detailed Description

Builds the intersection between two sources.

Definition at line 219 of file OgreVolumeCSGSource.h.

## Constructor & Destructor Documentation

## CSGIntersectionSource() [1/2]

Ogre::Volume::CSGIntersectionSource::CSGIntersectionSource | ( | const Source * | a,
|  | const Source * | b
| ) |  |

Constructor.

Parameters

  a | The first operator.
  b | The second operator.

## CSGIntersectionSource() [2/2]

Ogre::Volume::CSGIntersectionSource::CSGIntersectionSource | ( | void |  | ) |

Constructor, sets the sources to null.

## Member Function Documentation

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

## getIntersectionEnd()

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.

## getIntersectionStart()

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.

## getSourceA()

virtual const Source* Ogre::Volume::CSGOperationSource::getSourceA | ( |  | ) | const

virtual inherited

Gets the first operator source.

Returns
  The first operator source.

## getSourceB()

virtual const Source* Ogre::Volume::CSGOperationSource::getSourceB | ( | void |  | ) | const

virtual inherited

Gets the second operator source.

Returns
  The second operator source.

## getValue()

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

virtual

Overridden from Source.

Implements Ogre::Volume::Source.

## getValueAndGradient()

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

virtual

Overridden from Source.

Implements Ogre::Volume::Source.

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

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

## setSourceA()

virtual void Ogre::Volume::CSGOperationSource::setSourceA | ( | Source * | a | ) |

virtual inherited

Sets the first operator source.

Parameters

  a | The first operator source.

## setSourceB()

virtual void Ogre::Volume::CSGOperationSource::setSourceB | ( | Source * | b | ) |

virtual inherited

Sets the second operator source.

Parameters

  b | The second operator source.

## Member Data Documentation

## mA

const Source* Ogre::Volume::CSGOperationSource::mA

protected inherited

The first operant.

Definition at line 173 of file OgreVolumeCSGSource.h.

## mB

const Source* Ogre::Volume::CSGOperationSource::mB

protected inherited

The second operant.

Definition at line 176 of file OgreVolumeCSGSource.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:

- OgreVolumeCSGSource.h

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