VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
vtkVolumeTexture Class Reference

Creates and manages the volume texture rendered by vtkOpenGLGPUVolumeRayCastMapper. More...

#include <vtkVolumeTexture.h>

Inheritance diagram for vtkVolumeTexture:
[legend]
Collaboration diagram for vtkVolumeTexture:
[legend]

Classes

struct  VolumeBlock
 

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkVolumeTextureNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetPartitions (int const i, int const j, int const k)
 Set a number of blocks per axis. More...
 
const Size3GetPartitions ()
 
bool LoadVolume (vtkRenderer *ren, vtkImageData *data, vtkDataArray *scalars, int const isCell, int const interpolation)
 Loads the data array into the texture in the case only a single block is is defined. More...
 
void UpdateVolume (vtkVolumeProperty *property)
 It currently only calls SetInterpolation internally. More...
 
void SortBlocksBackToFront (vtkRenderer *ren, vtkMatrix4x4 *volumeMat)
 If streaming the data array as separate blocks, sort them back to front. More...
 
VolumeBlockGetNextBlock ()
 Return the next volume block to be rendered and load its data. More...
 
VolumeBlockGetCurrentBlock ()
 Return the currently loaded block. More...
 
void ReleaseGraphicsResources (vtkWindow *win)
 Clean-up acquired graphics resources. More...
 
vtkDataArrayGetLoadedScalars ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkVolumeTextureNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVolumeTextureSafeDownCast (vtkObjectBase *o)
 
static void GetScaleAndBias (const int scalarType, float *scalarRange, float &scale, float &bias)
 Get the scale and bias values given a VTK scalar type and a finite range. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Public Attributes

bool HandleLargeDataTypes
 
float Scale [4]
 
float Bias [4]
 
float ScalarRange [4][2]
 
float CellSpacing [3]
 
int InterpolationType
 
vtkTimeStamp UploadTime
 
int IsCellData = 0
 
vtkNew< vtkMatrix4x4CellToPointMatrix
 
float AdjustedTexMin [4]
 
float AdjustedTexMax [4]
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVolumeTexture ()
 
 ~vtkVolumeTexture () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Creates and manages the volume texture rendered by vtkOpenGLGPUVolumeRayCastMapper.

Wraps a vtkTextureObject for which it selects the appropriate format (depending on the input vtkDataArray type, number of components, etc.) and loads input data. The class maintains a set of members of interest to the parent mapper, such as:

This class supports streaming the volume data in separate blocks to make it fit in graphics memory (sometimes referred to as bricking). The data is split into a user-defined number of blocks in such a way that a single sub-block (brick) fits completely into GPU memory. A stride is passed to OpenGL so that it can access the underlying vtkDataArray adequately for each of the blocks to be streamed into GPU memory (back-to-front for correct composition).

Streaming the volume as separate texture bricks certainly imposes a performance trade-off but acts as a graphics memory expansion scheme for devices that would not be able to render higher resoulution volumes otherwise.

Warning
There are certain caveats when texture streaming is enabled, given the locality constraint that rendering a single block imposes.

Future work will extend the API to be able to compute an ideal number of partitions and extents based on the platform capabilities.

Warning
This is an internal class of vtkOpenGLGPUVolumeRayCastMapper. It assumes there is an active OpenGL context in methods involving GL calls (MakeCurrent() is expected to be called in the mapper beforehand).

Definition at line 85 of file vtkVolumeTexture.h.

Member Typedef Documentation

◆ Superclass

Definition at line 131 of file vtkVolumeTexture.h.

Constructor & Destructor Documentation

◆ vtkVolumeTexture()

vtkVolumeTexture::vtkVolumeTexture ( )
protected

◆ ~vtkVolumeTexture()

vtkVolumeTexture::~vtkVolumeTexture ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkVolumeTexture* vtkVolumeTexture::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkVolumeTexture::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkVolumeTexture::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkVolumeTexture* vtkVolumeTexture::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVolumeTexture::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkVolumeTexture* vtkVolumeTexture::NewInstance ( ) const

◆ PrintSelf()

void vtkVolumeTexture::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetPartitions()

void vtkVolumeTexture::SetPartitions ( int const  i,
int const  j,
int const  k 
)

Set a number of blocks per axis.

◆ GetPartitions()

const Size3& vtkVolumeTexture::GetPartitions ( )

◆ LoadVolume()

bool vtkVolumeTexture::LoadVolume ( vtkRenderer ren,
vtkImageData data,
vtkDataArray scalars,
int const  isCell,
int const  interpolation 
)

Loads the data array into the texture in the case only a single block is is defined.

Does not load when the input data is divided in multiple blocks (in which case they will be loaded into GPU memory by GetNextBlock()). Requires an active OpenGL context.

◆ UpdateVolume()

void vtkVolumeTexture::UpdateVolume ( vtkVolumeProperty property)

It currently only calls SetInterpolation internally.

Requires an active OpenGL context.

◆ SortBlocksBackToFront()

void vtkVolumeTexture::SortBlocksBackToFront ( vtkRenderer ren,
vtkMatrix4x4 volumeMat 
)

If streaming the data array as separate blocks, sort them back to front.

This method does nothing if there is a single block.

◆ GetNextBlock()

VolumeBlock* vtkVolumeTexture::GetNextBlock ( )

Return the next volume block to be rendered and load its data.

If the current block is the last one, it will return nullptr.

◆ GetCurrentBlock()

VolumeBlock* vtkVolumeTexture::GetCurrentBlock ( )

Return the currently loaded block.

◆ ReleaseGraphicsResources()

void vtkVolumeTexture::ReleaseGraphicsResources ( vtkWindow win)

Clean-up acquired graphics resources.

◆ GetScaleAndBias()

static void vtkVolumeTexture::GetScaleAndBias ( const int  scalarType,
float *  scalarRange,
float &  scale,
float &  bias 
)
static

Get the scale and bias values given a VTK scalar type and a finite range.

The scale and bias values computed using this method can be useful for custom shader code. For example, when looking up color values through the transfer function texture, the scalar value must be scaled and offset.

◆ GetLoadedScalars()

vtkDataArray* vtkVolumeTexture::GetLoadedScalars ( )

Member Data Documentation

◆ HandleLargeDataTypes

bool vtkVolumeTexture::HandleLargeDataTypes

Definition at line 185 of file vtkVolumeTexture.h.

◆ Scale

float vtkVolumeTexture::Scale[4]

Definition at line 186 of file vtkVolumeTexture.h.

◆ Bias

float vtkVolumeTexture::Bias[4]

Definition at line 187 of file vtkVolumeTexture.h.

◆ ScalarRange

float vtkVolumeTexture::ScalarRange[4][2]

Definition at line 188 of file vtkVolumeTexture.h.

◆ CellSpacing

float vtkVolumeTexture::CellSpacing[3]

Definition at line 189 of file vtkVolumeTexture.h.

◆ InterpolationType

int vtkVolumeTexture::InterpolationType

Definition at line 190 of file vtkVolumeTexture.h.

◆ UploadTime

vtkTimeStamp vtkVolumeTexture::UploadTime

Definition at line 191 of file vtkVolumeTexture.h.

◆ IsCellData

int vtkVolumeTexture::IsCellData = 0

Definition at line 193 of file vtkVolumeTexture.h.

◆ CellToPointMatrix

vtkNew<vtkMatrix4x4> vtkVolumeTexture::CellToPointMatrix

Definition at line 194 of file vtkVolumeTexture.h.

◆ AdjustedTexMin

float vtkVolumeTexture::AdjustedTexMin[4]

Definition at line 195 of file vtkVolumeTexture.h.

◆ AdjustedTexMax

float vtkVolumeTexture::AdjustedTexMax[4]

Definition at line 196 of file vtkVolumeTexture.h.


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