Abstract operation volume source holding two sources as operants.
More...
#include <OgreVolumeCSGSource.h>
|
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 =0 |
| Gets the density value at a specific position. More...
|
|
virtual Vector4 | getValueAndGradient (const Vector3 &position) const =0 |
| Gets the density value and gradient at a specific position. 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...
|
|
Abstract operation volume source holding two sources as operants.
Definition at line 168 of file OgreVolumeCSGSource.h.
Ogre::Volume::CSGOperationSource::CSGOperationSource |
( |
const Source * |
a, |
|
|
const Source * |
b |
|
) |
| |
|
protected |
Constructor.
Protected to be callable from child classes.
- Parameters
-
a | The first operator. |
b | The second operator. |
Ogre::Volume::CSGOperationSource::CSGOperationSource |
( |
void |
| ) |
|
|
protected |
Constructor, sets the sources to null.
Protected to be callable from child classes.
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. |
virtual Vector3 Ogre::Volume::Source::getIntersectionEnd |
( |
const Ray & |
ray, |
|
|
Real |
maxDistance |
|
) |
| const |
|
protectedvirtualinherited |
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 |
|
protectedvirtualinherited |
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 const Source* Ogre::Volume::CSGOperationSource::getSourceA |
( |
| ) |
const |
|
virtual |
Gets the first operator source.
- Returns
- The first operator source.
virtual const Source* Ogre::Volume::CSGOperationSource::getSourceB |
( |
void |
| ) |
const |
|
virtual |
Gets the second operator source.
- Returns
- The second operator source.
virtual Real Ogre::Volume::Source::getValue |
( |
const Vector3 & |
position | ) |
const |
|
pure virtualinherited |
Gets the density value at a specific position.
- Parameters
-
- Returns
- The density.
Implemented in Ogre::Volume::CSGNoiseSource, Ogre::Volume::CSGScaleSource, Ogre::Volume::CSGNegateSource, Ogre::Volume::CSGDifferenceSource, Ogre::Volume::CSGUnionSource, Ogre::Volume::CSGIntersectionSource, Ogre::Volume::CSGCubeSource, Ogre::Volume::GridSource, Ogre::Volume::CacheSource, Ogre::Volume::CSGPlaneSource, and Ogre::Volume::CSGSphereSource.
virtual Vector4 Ogre::Volume::Source::getValueAndGradient |
( |
const Vector3 & |
position | ) |
const |
|
pure virtualinherited |
Gets the density value and gradient at a specific position.
- Parameters
-
- Returns
- A vector with x, y, z containing the gradient and w containing the density.
Implemented in Ogre::Volume::CSGNoiseSource, Ogre::Volume::CSGScaleSource, Ogre::Volume::CSGNegateSource, Ogre::Volume::CSGDifferenceSource, Ogre::Volume::CSGUnionSource, Ogre::Volume::CSGIntersectionSource, Ogre::Volume::CSGCubeSource, Ogre::Volume::GridSource, Ogre::Volume::CacheSource, Ogre::Volume::CSGPlaneSource, and Ogre::Volume::CSGSphereSource.
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.
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. |
virtual void Ogre::Volume::CSGOperationSource::setSourceA |
( |
Source * |
a | ) |
|
|
virtual |
Sets the first operator source.
- Parameters
-
a | The first operator source. |
virtual void Ogre::Volume::CSGOperationSource::setSourceB |
( |
Source * |
b | ) |
|
|
virtual |
Sets the second operator source.
- Parameters
-
b | The second operator source. |
const Source* Ogre::Volume::CSGOperationSource::mA |
|
protected |
const Source* Ogre::Volume::CSGOperationSource::mB |
|
protected |
const size_t Ogre::Volume::Source::SERIALIZATION_CHUNK_SIZE |
|
staticinherited |
The amount of items being written as one chunk during serialization.
Definition at line 76 of file OgreVolumeSource.h.
const uint32 Ogre::Volume::Source::VOLUME_CHUNK_ID |
|
staticinherited |
const uint16 Ogre::Volume::Source::VOLUME_CHUNK_VERSION |
|
staticinherited |
The documentation for this class was generated from the following file: