A volume source from a 16 Bit float 3D grid capable of loading volume serializations. More...
#include <OgreVolumeHalfFloatGridSource.h>
Public Member Functions | |
HalfFloatGridSource (const String &serializedVolumeFile, const bool trilinearValue=true, const bool trilinearGradient=false, const bool sobelGradient=false) | |
Constructur. | |
~HalfFloatGridSource (void) | |
Destructor. | |
virtual void | combineWithSource (CSGOperationSource *operation, Source *source, const Vector3 ¢er, Real radius) |
Updates this grid with another source in a certain area. | |
size_t | getDepth (void) const |
Gets the depth of the texture. | |
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. | |
size_t | getHeight (void) const |
Gets the height of the texture. | |
Real | getMaxClampedAbsoluteDensity (void) const |
Gets the maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization. | |
virtual Real | getValue (const Vector3 &position) const |
Overridden from VolumeSource. | |
virtual Vector4 | getValueAndGradient (const Vector3 &position) const |
Overridden from VolumeSource. | |
Real | getVolumeSpaceToWorldSpaceFactor (void) const |
Overridden from VolumeSource. | |
size_t | getWidth (void) const |
Gets the width of the texture. | |
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. | |
void | setMaxClampedAbsoluteDensity (Real maxClampedAbsoluteDensity) |
Sets the maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization. | |
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 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. | |
virtual Vector3 | getIntersectionEnd (const Ray &ray, Real maxDistance) const |
Overridden from VolumeSource. | |
virtual Vector3 | getIntersectionStart (const Ray &ray, Real maxDistance) const |
Overridden from VolumeSource. | |
virtual float | getVolumeGridValue (size_t x, size_t y, size_t z) const |
Overridden from GridSource. | |
virtual void | setVolumeGridValue (int x, int y, int z, float value) |
Overridden from GridSource. | |
Protected Attributes | |
uint16 * | mData |
The raw volume data. | |
size_t | mDepth |
The texture depth. | |
int | mDepthTimesHeight |
To have a little bit faster data access. | |
size_t | mHeight |
The texture height. | |
Real | mMaxClampedAbsoluteDensity |
The maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization. | |
Real | mPosXScale |
The scale of the position based on the world width. | |
Real | mPosYScale |
The scale of the position based on the world height. | |
Real | mPosZScale |
The scale of the position based on the world depth. | |
const bool | mSobelGradient |
Whether to blur the gradient a bit Sobel like. | |
const bool | mTrilinearGradient |
Whether to use trilinear filtering or not for the gradient. | |
bool | mTrilinearValue |
Whether to use trilinear filtering or not for the value. | |
Real | mVolumeSpaceToWorldSpaceFactor |
Factor to come from volume coordinate to world coordinate. | |
size_t | mWidth |
The texture width. | |
A volume source from a 16 Bit float 3D grid capable of loading volume serializations.
Definition at line 40 of file OgreVolumeHalfFloatGridSource.h.
|
explicit |
Constructur.
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. |
Ogre::Volume::HalfFloatGridSource::~HalfFloatGridSource | ( | void | ) |
Destructor.
|
virtualinherited |
Updates this grid with another source in a certain area.
Use it for example to add spheres as a brush.
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. |
Gets the depth of the texture.
|
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);
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. |
|
protectedinherited |
Gets a gradient of a point with optional sobel blurring.
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.
Gets the height of the texture.
|
protectedvirtualinherited |
Overridden from VolumeSource.
Reimplemented from Ogre::Volume::Source.
|
protectedvirtualinherited |
Overridden from VolumeSource.
Reimplemented from Ogre::Volume::Source.
Gets the maximum absolute density value to be written into the data when combining, influencing the compression rate on serialization.
Overridden from VolumeSource.
Implements Ogre::Volume::Source.
|
virtualinherited |
Overridden from VolumeSource.
Implements Ogre::Volume::Source.
|
protectedvirtual |
Overridden from GridSource.
Implements Ogre::Volume::GridSource.
Overridden from VolumeSource.
Gets the width of the texture.
|
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).
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. |
|
inherited |
Same as the other serialize function but with a user definable maximum absolute density value.
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. |
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.
maxClampedAbsoluteDensity | The maximum absolute density value. |
|
protectedvirtual |
Overridden from GridSource.
Implements Ogre::Volume::GridSource.
|
protected |
The raw volume data.
Definition at line 45 of file OgreVolumeHalfFloatGridSource.h.
|
protectedinherited |
The texture depth.
Definition at line 53 of file OgreVolumeGridSource.h.
|
protected |
To have a little bit faster data access.
Definition at line 48 of file OgreVolumeHalfFloatGridSource.h.
|
protectedinherited |
The texture height.
Definition at line 50 of file OgreVolumeGridSource.h.
|
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.
|
protectedinherited |
The scale of the position based on the world width.
Definition at line 56 of file OgreVolumeGridSource.h.
|
protectedinherited |
The scale of the position based on the world height.
Definition at line 59 of file OgreVolumeGridSource.h.
|
protectedinherited |
The scale of the position based on the world depth.
Definition at line 62 of file OgreVolumeGridSource.h.
Whether to blur the gradient a bit Sobel like.
Definition at line 71 of file OgreVolumeGridSource.h.
Whether to use trilinear filtering or not for the gradient.
Definition at line 68 of file OgreVolumeGridSource.h.
|
protectedinherited |
Whether to use trilinear filtering or not for the value.
Definition at line 65 of file OgreVolumeGridSource.h.
|
protectedinherited |
Factor to come from volume coordinate to world coordinate.
Definition at line 74 of file OgreVolumeGridSource.h.
|
protectedinherited |
The texture width.
Definition at line 47 of file OgreVolumeGridSource.h.
The amount of items being written as one chunk during serialization.
Definition at line 76 of file OgreVolumeSource.h.
The id of volume files.
Definition at line 70 of file OgreVolumeSource.h.
The version of volume files.
Definition at line 73 of file OgreVolumeSource.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.