ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSMTransferFunctionManager Class Reference

manages transfer functions i.e. More...

#include <vtkSMTransferFunctionManager.h>

Inheritance diagram for vtkSMTransferFunctionManager:
Inheritance graph
[legend]
Collaboration diagram for vtkSMTransferFunctionManager:
Collaboration graph
[legend]

Public Types

enum  UpdateScalarBarsMode { HIDE_UNUSED_SCALAR_BARS = 0x01, SHOW_USED_SCALAR_BARS = 0x02 }
 
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)
 
virtual vtkSMProxyGetColorTransferFunction (const char *arrayName, vtkSMSessionProxyManager *pxm)
 Returns a color transfer function proxy instance for mapping a data array with the given name. More...
 
virtual vtkSMProxyGetOpacityTransferFunction (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 vtkSMProxyGetScalarBarRepresentation (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 extend=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 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 vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMTransferFunctionManagerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMTransferFunctionManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMTransferFunctionManager ()
 
 ~vtkSMTransferFunctionManager ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

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 41 of file vtkSMTransferFunctionManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkSMTransferFunctionManager.h.

Member Enumeration Documentation

◆ UpdateScalarBarsMode

Enumerator
HIDE_UNUSED_SCALAR_BARS 
SHOW_USED_SCALAR_BARS 

Definition at line 83 of file vtkSMTransferFunctionManager.h.

Constructor & Destructor Documentation

◆ vtkSMTransferFunctionManager()

vtkSMTransferFunctionManager::vtkSMTransferFunctionManager ( )
protected

◆ ~vtkSMTransferFunctionManager()

vtkSMTransferFunctionManager::~vtkSMTransferFunctionManager ( )
protected

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 
)

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

◆ 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  extend = false 
)

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

If extend is true, the transfer function is expanded to accommodate current data range rather then resetting it to the range.

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

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