vtkOpenGLVolumeLookupTable Class Reference

Base class for OpenGL texture management of scalar color, opacity and gradient opacity lookup tables. More...

#include <vtkOpenGLVolumeLookupTable.h>

Inheritance diagram for vtkOpenGLVolumeLookupTable:

Collaboration diagram for vtkOpenGLVolumeLookupTable:

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.
vtkOpenGLVolumeLookupTable *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	GetTextureUnit ()
	Get the texture unit associated with the managed texture object.
int	GetMaximumSupportedTextureWidth (vtkOpenGLRenderWindow *renWin, int idealWidth)
	Get the maximum supported texture width for the target OpenGL environment.
void	ReleaseGraphicsResources (vtkWindow *window)
	Release graphics resources.
virtual void	Update (vtkObject *func, double scalarRange[2], int blendMode, double sampleDistance, double unitDistance, int filterValue, vtkOpenGLRenderWindow *renWin)
	Update the internal texture object using the transfer function provided.
virtual int	GetTextureHeight ()
	Get access to the texture height used by this object.
virtual int	GetTextureWidth ()
	Get access to the texture width used by this object.
void	Activate ()
	Activate / deactivate the internal texture object.
void	Deactivate ()
	Activate / deactivate the internal texture object.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLVolumeLookupTable *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLVolumeLookupTable ()=default
	~vtkOpenGLVolumeLookupTable () override
virtual bool	NeedsUpdate (vtkObject *func, double scalarRange[2], int blendMode, double sampleDistance)
	Test whether the internal function needs to be updated.
virtual void	InternalUpdate (vtkObject *func, int blendMode, double sampleDistance, double unitDistance, int filterValue)
	Internal method to actually update the texture object.
virtual void	ComputeIdealTextureSize (vtkObject *func, int &width, int &height, vtkOpenGLRenderWindow *renWin)
	Compute ideal width and height for the texture based on function provided.
virtual void	AllocateTable ()
	Allocate internal data table.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	LastRange [2] = { 0.0, 0.0 }
float *	Table = nullptr
int	LastInterpolation = -1
int	NumberOfColorComponents = 1
int	TextureWidth = 1024
int	TextureHeight = 1
vtkTextureObject *	TextureObject = nullptr
vtkTimeStamp	BuildTime
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Base class for OpenGL texture management of scalar color, opacity and gradient opacity lookup tables.

Definition at line 21 of file vtkOpenGLVolumeLookupTable.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkOpenGLVolumeLookupTable::Superclass

Definition at line 24 of file vtkOpenGLVolumeLookupTable.h.

Constructor & Destructor Documentation

vtkOpenGLVolumeLookupTable()

vtkOpenGLVolumeLookupTable::vtkOpenGLVolumeLookupTable ( )

protecteddefault

~vtkOpenGLVolumeLookupTable()

vtkOpenGLVolumeLookupTable::~vtkOpenGLVolumeLookupTable ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkOpenGLVolumeLookupTable::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.

Reimplemented in vtkOpenGLVolumeGradientOpacityTable, vtkOpenGLVolumeMaskGradientOpacityTransferFunction2D, vtkOpenGLVolumeMaskTransferFunction2D, vtkOpenGLVolumeOpacityTable, vtkOpenGLVolumeRGBTable, and vtkOpenGLVolumeTransferFunction2D.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLVolumeLookupTable::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkOpenGLVolumeGradientOpacityTable, vtkOpenGLVolumeMaskGradientOpacityTransferFunction2D, vtkOpenGLVolumeMaskTransferFunction2D, vtkOpenGLVolumeOpacityTable, vtkOpenGLVolumeRGBTable, and vtkOpenGLVolumeTransferFunction2D.

NewInstance()

vtkOpenGLVolumeLookupTable * vtkOpenGLVolumeLookupTable::NewInstance

(

)

const

PrintSelf()

void vtkOpenGLVolumeLookupTable::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.

Reimplemented in vtkOpenGLVolumeMaskGradientOpacityTransferFunction2D, vtkOpenGLVolumeMaskTransferFunction2D, vtkOpenGLVolumeOpacityTable, vtkOpenGLVolumeRGBTable, and vtkOpenGLVolumeTransferFunction2D.

GetTextureUnit()

int vtkOpenGLVolumeLookupTable::GetTextureUnit

(

)

Get the texture unit associated with the managed texture object.

Activate()

void vtkOpenGLVolumeLookupTable::Activate

(

)

Activate / deactivate the internal texture object.

Deactivate()

void vtkOpenGLVolumeLookupTable::Deactivate

(

)

Activate / deactivate the internal texture object.

GetMaximumSupportedTextureWidth()

int vtkOpenGLVolumeLookupTable::GetMaximumSupportedTextureWidth	(	vtkOpenGLRenderWindow *	renWin,
		int	idealWidth
	)

Get the maximum supported texture width for the target OpenGL environment.

ReleaseGraphicsResources()

void vtkOpenGLVolumeLookupTable::ReleaseGraphicsResources

(

vtkWindow *

window

)

Release graphics resources.

Update()

virtual void vtkOpenGLVolumeLookupTable::Update ( vtkObject *  func, double  scalarRange[2], int  blendMode, double  sampleDistance, double  unitDistance, int  filterValue, vtkOpenGLRenderWindow *  renWin  )

virtual

Update the internal texture object using the transfer function provided.

GetTextureHeight()

virtual int vtkOpenGLVolumeLookupTable::GetTextureHeight ( )

virtual

Get access to the texture height used by this object.

GetTextureWidth()

virtual int vtkOpenGLVolumeLookupTable::GetTextureWidth ( )

virtual

Get access to the texture width used by this object.

NeedsUpdate()

virtual bool vtkOpenGLVolumeLookupTable::NeedsUpdate ( vtkObject *  func, double  scalarRange[2], int  blendMode, double  sampleDistance  )

protectedvirtual

Test whether the internal function needs to be updated.

Reimplemented in vtkOpenGLVolumeOpacityTable, and vtkOpenGLVolumeTransferFunction2D.

InternalUpdate()

virtual void vtkOpenGLVolumeLookupTable::InternalUpdate ( vtkObject *  func, int  blendMode, double  sampleDistance, double  unitDistance, int  filterValue  )

protectedvirtual

Internal method to actually update the texture object.

Reimplemented in vtkOpenGLVolumeGradientOpacityTable, vtkOpenGLVolumeMaskGradientOpacityTransferFunction2D, vtkOpenGLVolumeMaskTransferFunction2D, vtkOpenGLVolumeOpacityTable, vtkOpenGLVolumeRGBTable, and vtkOpenGLVolumeTransferFunction2D.

ComputeIdealTextureSize()

virtual void vtkOpenGLVolumeLookupTable::ComputeIdealTextureSize ( vtkObject *  func, int &  width, int &  height, vtkOpenGLRenderWindow *  renWin  )

protectedvirtual

Compute ideal width and height for the texture based on function provided.

Reimplemented in vtkOpenGLVolumeMaskGradientOpacityTransferFunction2D, and vtkOpenGLVolumeMaskTransferFunction2D.

AllocateTable()

virtual void vtkOpenGLVolumeLookupTable::AllocateTable ( )

protectedvirtual

Allocate internal data table.

Reimplemented in vtkOpenGLVolumeTransferFunction2D.

Member Data Documentation

LastRange

double vtkOpenGLVolumeLookupTable::LastRange[2] = { 0.0, 0.0 }

protected

Definition at line 72 of file vtkOpenGLVolumeLookupTable.h.

Table

float* vtkOpenGLVolumeLookupTable::Table = nullptr

protected

Definition at line 73 of file vtkOpenGLVolumeLookupTable.h.

LastInterpolation

int vtkOpenGLVolumeLookupTable::LastInterpolation = -1

protected

Definition at line 74 of file vtkOpenGLVolumeLookupTable.h.

NumberOfColorComponents

int vtkOpenGLVolumeLookupTable::NumberOfColorComponents = 1

protected

Definition at line 75 of file vtkOpenGLVolumeLookupTable.h.

TextureWidth

int vtkOpenGLVolumeLookupTable::TextureWidth = 1024

protected

Definition at line 76 of file vtkOpenGLVolumeLookupTable.h.

TextureHeight

int vtkOpenGLVolumeLookupTable::TextureHeight = 1

protected

Definition at line 77 of file vtkOpenGLVolumeLookupTable.h.

TextureObject

vtkTextureObject* vtkOpenGLVolumeLookupTable::TextureObject = nullptr

protected

Definition at line 78 of file vtkOpenGLVolumeLookupTable.h.

BuildTime

vtkTimeStamp vtkOpenGLVolumeLookupTable::BuildTime

protected

Definition at line 79 of file vtkOpenGLVolumeLookupTable.h.

---

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

• Rendering/VolumeOpenGL2/vtkOpenGLVolumeLookupTable.h