OGRE  13.4
Object-Oriented Graphics Rendering Engine
Ogre::Volume::GridSource Class Referenceabstract

A volume source from a discrete 3d grid. More...

#include <OgreVolumeGridSource.h>

+ Inheritance diagram for Ogre::Volume::GridSource:

Public Member Functions

 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 discrete 3d grid.

Constructor & Destructor Documentation

◆ GridSource()

Ogre::Volume::GridSource::GridSource ( bool  trilinearValue,
bool  trilinearGradient,
bool  sobelGradient 
)

◆ ~GridSource()

virtual Ogre::Volume::GridSource::~GridSource ( void  )
virtual

Destructor.

Member Function Documentation

◆ getValueAndGradient()

virtual Vector4 Ogre::Volume::GridSource::getValueAndGradient ( const Vector3 position) const
virtual

Overridden from VolumeSource.

Implements Ogre::Volume::Source.

◆ getValue()

virtual Real Ogre::Volume::GridSource::getValue ( const Vector3 position) const
virtual

Overridden from VolumeSource.

Implements Ogre::Volume::Source.

◆ getWidth()

size_t Ogre::Volume::GridSource::getWidth ( void  ) const

Gets the width of the texture.

Returns
The width of the texture.

◆ getHeight()

size_t Ogre::Volume::GridSource::getHeight ( void  ) const

Gets the height of the texture.

Returns
The height of the texture.

◆ getDepth()

size_t Ogre::Volume::GridSource::getDepth ( void  ) const

Gets the depth of the texture.

Returns
The depth of the texture.

◆ combineWithSource()

virtual void Ogre::Volume::GridSource::combineWithSource ( CSGOperationSource operation,
Source source,
const Vector3 center,
Real  radius 
)
virtual

Updates this grid with another source in a certain area.

Use it for example to add spheres as a brush.

Parameters
operationThe 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.
sourceThe other source to combine this one with.
centerThe rough center of the affected area by the operation. If the other source is a sphere, take its center for example.
radiusThe 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.

◆ getVolumeSpaceToWorldSpaceFactor()

Real Ogre::Volume::GridSource::getVolumeSpaceToWorldSpaceFactor ( void  ) const

Overridden from VolumeSource.


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