OGRE  13.4
Object-Oriented Graphics Rendering Engine
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:

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...
 
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...
 
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...
 
- Public Member Functions inherited from Ogre::Volume::GridSource
 GridSource (bool trilinearValue, bool trilinearGradient, bool sobelGradient)
 
virtual ~GridSource (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...
 
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...
 
- Public Member Functions inherited from Ogre::Volume::Source
virtual ~Source (void)
 Destructor. 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...
 
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...
 

Additional Inherited Members

- Static Public Attributes inherited from Ogre::Volume::Source
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...
 

Detailed Description

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

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
serializedVolumeFileWhich volume serialization to get the data from.
trilinearValueWhether to use trilinear filtering (true) or nearest neighbour (false) for the value.
trilinearGradientWhether to use trilinear filtering (true) or nearest neighbour (false) for the gradient.
sobelGradientWhether to add a bit of blur to the gradient like in a sobel filter.

◆ ~HalfFloatGridSource()

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

Destructor.

Member Function Documentation

◆ 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
maxClampedAbsoluteDensityThe maximum absolute density value.

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

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