manages transfer functions i.e. More...

#include <vtkSMTransferFunctionManager.h>

Inheritance diagram for vtkSMTransferFunctionManager:

Collaboration diagram for vtkSMTransferFunctionManager:

[legend]

Public Types
enum	UpdateScalarBarsMode { HIDE_UNUSED_SCALAR_BARS = 0x01, SHOW_USED_SCALAR_BARS = 0x02 }

enum	TransferFunctionResetMode { NEVER = -1, GROW_ON_APPLY = 0, GROW_ON_APPLY_AND_TIMESTEP = 1, RESET_ON_APPLY = 2, RESET_ON_APPLY_AND_TIMESTEP = 3, RESET_VISIBLE_ON_APPLY = 4, RESET_VISIBLE_ON_APPLY_AND_TIMESTEP = 5 }
	Enum for TransferFunctionResetMode GROW means the data range can only expand to new data RESET means the data range corresponds exactly to the data RESET_VISIBLE means the data range corresponds exactly to the visible data. More...

typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual vtkSMProxy *	GetColorTransferFunction (const char arrayName, vtkSMSessionProxyManager pxm)
	Returns a color transfer function proxy instance for mapping a data array with the given name. More...

virtual vtkSMProxy *	GetOpacityTransferFunction (const char arrayName, vtkSMSessionProxyManager pxm)
	Returns a opacity transfer function proxy (aka Piecewise Function) instance for mapping a data array with the given name. More...

virtual vtkSMProxy *	GetTransferFunction2D (const char arrayName, vtkSMSessionProxyManager pxm)
	Returns a 2D transfer function proxy (aka Image Data) instance. More...

virtual vtkSMProxy *	GetTransferFunction2D (const char arrayName, const char array2Name, vtkSMSessionProxyManager *pxm)

virtual vtkSMProxy *	GetScalarBarRepresentation (vtkSMProxy colorTransferFunctionProxy, vtkSMProxy view)
	Returns the scalar-bar (color-legend) representation corresponding to the transfer function for the view (currently only render-views are supported). More...

void	ResetAllTransferFunctionRangesUsingCurrentData (vtkSMSessionProxyManager *pxm, bool animating=false)
	Iterates over all "known" transfer function proxies and request each one of them to update its range using data information currently available. More...

virtual bool	UpdateScalarBars (vtkSMProxy *viewProxy, unsigned int mode)
	Updates the scalar bar visibility in the view. More...

virtual bool	UpdateScalarBarsComponentTitle (vtkSMProxy lutProxy, vtkSMProxy representation)
	Updates all scalar bars using provided lutProxy, the representation is used to recover the component title. More...

virtual bool	HideScalarBarIfNotNeeded (vtkSMProxy lutProxy, vtkSMProxy view)
	Hides the scalar bar, if any, for the lutProxy in the view if it's not being used. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkSMTransferFunctionManager *	New ()

static int	IsTypeOf (const char *type)

static vtkSMTransferFunctionManager *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMTransferFunctionManager ()

	~vtkSMTransferFunctionManager () override

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

manages transfer functions i.e.

color lookuptables and opacity piecewise functions for ParaView applications.

vtkSMTransferFunctionManager manages transfer functions i.e. color lookuptables and opacity piecewise functions for ParaView applications. vtkSMTransferFunctionManager implements the ParaView specific mechanism for managing such transfer function proxies where there's one transfer function created and maintained per data array name.

vtkSMTransferFunctionManager has no state. You can create as many instances as per your choosing to call the methods. It uses the session proxy manager to locate proxies registered using specific names under specific groups. Thus, the state is maintained by the proxy manager itself.

Definition at line 29 of file vtkSMTransferFunctionManager.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMTransferFunctionManager::Superclass

Definition at line 33 of file vtkSMTransferFunctionManager.h.

Member Enumeration Documentation

◆ UpdateScalarBarsMode

enum vtkSMTransferFunctionManager::UpdateScalarBarsMode

Enumerator
HIDE_UNUSED_SCALAR_BARS
SHOW_USED_SCALAR_BARS

Definition at line 78 of file vtkSMTransferFunctionManager.h.

◆ TransferFunctionResetMode

enum vtkSMTransferFunctionManager::TransferFunctionResetMode

Enum for TransferFunctionResetMode GROW means the data range can only expand to new data RESET means the data range corresponds exactly to the data RESET_VISIBLE means the data range corresponds exactly to the visible data.

Enumerator
NEVER
GROW_ON_APPLY
GROW_ON_APPLY_AND_TIMESTEP
RESET_ON_APPLY
RESET_ON_APPLY_AND_TIMESTEP
RESET_VISIBLE_ON_APPLY
RESET_VISIBLE_ON_APPLY_AND_TIMESTEP

Definition at line 90 of file vtkSMTransferFunctionManager.h.

Constructor & Destructor Documentation

◆ vtkSMTransferFunctionManager()

vtkSMTransferFunctionManager::vtkSMTransferFunctionManager ( )

protected

◆ ~vtkSMTransferFunctionManager()

vtkSMTransferFunctionManager::~vtkSMTransferFunctionManager ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMTransferFunctionManager* vtkSMTransferFunctionManager::New ( )

static

◆ GetClassName()

virtual const char* vtkSMTransferFunctionManager::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

static int vtkSMTransferFunctionManager::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkSMTransferFunctionManager::IsA ( const char * type )

virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

static vtkSMTransferFunctionManager* vtkSMTransferFunctionManager::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkSMTransferFunctionManager::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkSMObject.

◆ GetColorTransferFunction()

virtual vtkSMProxy* vtkSMTransferFunctionManager::GetColorTransferFunction	(	const char *	arrayName,
		vtkSMSessionProxyManager *	pxm
	)

virtual

Returns a color transfer function proxy instance for mapping a data array with the given name.

If none exists in the given session, a new instance will be created and returned.

◆ GetOpacityTransferFunction()

virtual vtkSMProxy* vtkSMTransferFunctionManager::GetOpacityTransferFunction	(	const char *	arrayName,
		vtkSMSessionProxyManager *	pxm
	)

virtual

Returns a opacity transfer function proxy (aka Piecewise Function) instance for mapping a data array with the given name.

If none exists in the given session, a new instance will be created and returned.

◆ GetTransferFunction2D() [1/2]

virtual vtkSMProxy* vtkSMTransferFunctionManager::GetTransferFunction2D	(	const char *	arrayName,
		vtkSMSessionProxyManager *	pxm
	)

virtual

Returns a 2D transfer function proxy (aka Image Data) instance.

◆ GetTransferFunction2D() [2/2]

virtual vtkSMProxy* vtkSMTransferFunctionManager::GetTransferFunction2D	(	const char *	arrayName,
		const char *	array2Name,
		vtkSMSessionProxyManager *	pxm
	)

virtual

◆ GetScalarBarRepresentation()

virtual vtkSMProxy* vtkSMTransferFunctionManager::GetScalarBarRepresentation	(	vtkSMProxy *	colorTransferFunctionProxy,
		vtkSMProxy *	view
	)

virtual

Returns the scalar-bar (color-legend) representation corresponding to the transfer function for the view (currently only render-views are supported).

Thus returns an existing proxy, if present, otherwise a new one is created, if possible.

◆ ResetAllTransferFunctionRangesUsingCurrentData()

void vtkSMTransferFunctionManager::ResetAllTransferFunctionRangesUsingCurrentData	(	vtkSMSessionProxyManager *	pxm,
		bool	animating = `false`
	)

Iterates over all "known" transfer function proxies and request each one of them to update its range using data information currently available.

Set animating to true if this is called in the context of an animation, false otherwise. It relies on the mode defined by the TransferFunctionResetMode enum

◆ UpdateScalarBars()

virtual bool vtkSMTransferFunctionManager::UpdateScalarBars	(	vtkSMProxy *	viewProxy,
		unsigned int	mode
	)

virtual

Updates the scalar bar visibility in the view.

Based on the specified mode, scalars bars representing non-represented arrays can be automatically hidden; and those corresponding to arrays used for coloring can be automatically shown.

◆ UpdateScalarBarsComponentTitle()

virtual bool vtkSMTransferFunctionManager::UpdateScalarBarsComponentTitle	(	vtkSMProxy *	lutProxy,
		vtkSMProxy *	representation
	)

virtual

Updates all scalar bars using provided lutProxy, the representation is used to recover the component title.

◆ HideScalarBarIfNotNeeded()

virtual bool vtkSMTransferFunctionManager::HideScalarBarIfNotNeeded	(	vtkSMProxy *	lutProxy,
		vtkSMProxy *	view
	)

virtual

Hides the scalar bar, if any, for the lutProxy in the view if it's not being used.

Returns true if the scalar bar visibility was changed.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkSMTransferFunctionManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ UpdateScalarBarsMode

◆ TransferFunctionResetMode

Constructor & Destructor Documentation

◆ vtkSMTransferFunctionManager()

◆ ~vtkSMTransferFunctionManager()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetColorTransferFunction()

◆ GetOpacityTransferFunction()

◆ GetTransferFunction2D() [1/2]

◆ GetTransferFunction2D() [2/2]

◆ GetScalarBarRepresentation()

◆ ResetAllTransferFunctionRangesUsingCurrentData()

◆ UpdateScalarBars()

◆ UpdateScalarBarsComponentTitle()

◆ HideScalarBarIfNotNeeded()