A volume source from a discrete 3d grid.
More...
#include <OgreVolumeGridSource.h>
|
| | GridSource (bool trilinearValue, bool trilinearGradient, bool sobelGradient) |
| |
| virtual | ~GridSource (void) |
| | Destructor. More...
|
| |
| virtual void | combineWithSource (CSGOperationSource *operation, Source *source, const Vector3 ¢er, 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...
|
| |
| 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...
|
| |
A volume source from a discrete 3d grid.
Definition at line 42 of file OgreVolumeGridSource.h.
| Ogre::Volume::GridSource::GridSource |
( |
bool |
trilinearValue, |
|
|
bool |
trilinearGradient, |
|
|
bool |
sobelGradient |
|
) |
| |
| virtual Ogre::Volume::GridSource::~GridSource |
( |
void |
| ) |
|
|
virtual |
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. |
| size_t Ogre::Volume::GridSource::getDepth |
( |
void |
| ) |
const |
Gets the depth of the texture.
- Returns
- The depth of the texture.
| 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. |
| const Vector3 Ogre::Volume::GridSource::getGradient |
( |
size_t |
x, |
|
|
size_t |
y, |
|
|
size_t |
z |
|
) |
| const |
|
inlineprotected |
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.
| size_t Ogre::Volume::GridSource::getHeight |
( |
void |
| ) |
const |
Gets the height of the texture.
- Returns
- The height of the texture.
| virtual Vector3 Ogre::Volume::GridSource::getIntersectionEnd |
( |
const Ray & |
ray, |
|
|
Real |
maxDistance |
|
) |
| const |
|
protectedvirtual |
| virtual Vector3 Ogre::Volume::GridSource::getIntersectionStart |
( |
const Ray & |
ray, |
|
|
Real |
maxDistance |
|
) |
| const |
|
protectedvirtual |
| virtual Real Ogre::Volume::GridSource::getValue |
( |
const Vector3 & |
position | ) |
const |
|
virtual |
| virtual Vector4 Ogre::Volume::GridSource::getValueAndGradient |
( |
const Vector3 & |
position | ) |
const |
|
virtual |
| virtual float Ogre::Volume::GridSource::getVolumeGridValue |
( |
size_t |
x, |
|
|
size_t |
y, |
|
|
size_t |
z |
|
) |
| const |
|
protectedpure virtual |
| Real Ogre::Volume::GridSource::getVolumeSpaceToWorldSpaceFactor |
( |
void |
| ) |
const |
Overridden from VolumeSource.
| size_t Ogre::Volume::GridSource::getWidth |
( |
void |
| ) |
const |
Gets the width of the texture.
- Returns
- The width of the texture.
| 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::GridSource::setVolumeGridValue |
( |
int |
x, |
|
|
int |
y, |
|
|
int |
z, |
|
|
float |
value |
|
) |
| |
|
protectedpure virtual |
| size_t Ogre::Volume::GridSource::mDepth |
|
protected |
| size_t Ogre::Volume::GridSource::mHeight |
|
protected |
| Real Ogre::Volume::GridSource::mPosXScale |
|
protected |
| Real Ogre::Volume::GridSource::mPosYScale |
|
protected |
| Real Ogre::Volume::GridSource::mPosZScale |
|
protected |
| const bool Ogre::Volume::GridSource::mSobelGradient |
|
protected |
| const bool Ogre::Volume::GridSource::mTrilinearGradient |
|
protected |
| bool Ogre::Volume::GridSource::mTrilinearValue |
|
protected |
| Real Ogre::Volume::GridSource::mVolumeSpaceToWorldSpaceFactor |
|
protected |
| size_t Ogre::Volume::GridSource::mWidth |
|
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:
Inheritance diagram for Ogre::Volume::GridSource:
1.8.7 
