#include <vtkScivisScalarBars.h>

Detailed Description

The scalar bars a view keeps for what it is drawing.

vtkScivisScalarBars is the part of a view that labels the scene with what its colors mean, reached as vtkScivisView::GetScalarBars(). Nothing has to be switched on: color a representation by an array and a bar labelled with it appears.

A scalar bar describes the scene rather than any one representation, which is why they are kept here rather than by the things being drawn. Two representations coloring by "Temperature" are one bar spanning both of their ranges, not two bars disagreeing about the same quantity. A bar goes away when the last representation drawing that array is removed or hidden, and a live bar's range only ever grows, so bars do not jump about as data comes and goes.

The set of bars is not yours to change:: There is no way to add or remove one, because which bars exist follows from what the representations are drawing. GetActor(), by index or by array name and field association, reaches a bar to adjust what it looks like – its title, its label format, its size. AutoVisibilityOff() removes the bars and stops them being maintained, leaving the representations and their color maps alone.

Where the bars sit:: They are stacked down the right hand edge, sharing the height between them. With Draggable on, each bar can be picked up and moved by the user, and one that has been moved stays where it was put rather than being stacked again.

Colors are the view's:: The map an array is drawn through comes from the view's vtkLookupTableManager, which is shared between views that should agree on color. This component decides what is labelled, not what color it is.

See also: vtkScivisView vtkLookupTableManager vtkScalarBarActor

Tests:: vtkScivisScalarBars (Tests)

Definition at line 57 of file vtkScivisScalarBars.h.

Inheritance diagram for vtkScivisScalarBars:

[legend]

Collaboration diagram for vtkScivisScalarBars:

[legend]

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.
vtkScivisScalarBars *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	Return this object's modified time.
int	GetNumberOfBars ()
	How many bars there are, which is how many arrays the visible representations are drawing between them.
vtkScalarBarWidget *	GetWidget (int index)
	The widget that makes the bar at index draggable, for its interaction and its representation.

void	SetAutoVisibility (bool val)
	Whether a bar is kept for each array being drawn.
bool	GetAutoVisibility ()
	Whether a bar is kept for each array being drawn.
virtual void	AutoVisibilityOn ()
	Whether a bar is kept for each array being drawn.
virtual void	AutoVisibilityOff ()
	Whether a bar is kept for each array being drawn.

void	SetDraggable (bool val)
	Whether the user can pick a bar up and move it.
bool	GetDraggable ()
	Whether the user can pick a bar up and move it.
virtual void	DraggableOn ()
	Whether the user can pick a bar up and move it.
virtual void	DraggableOff ()
	Whether the user can pick a bar up and move it.

const char *	GetArrayName (int index)
	What the bar at index is labelled with, in array-name order.
int	GetFieldAssociation (int index)
	What the bar at index is labelled with, in array-name order.

vtkScalarBarActor *	GetActor (int index)
	The bar at index, or the one labelled with arrayName drawn from fieldAssoc.
vtkScalarBarActor *	GetActor (const char *arrayName, int fieldAssoc)
	The bar at index, or the one labelled with arrayName drawn from fieldAssoc.
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.
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 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 vtkScivisScalarBars *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkScivisScalarBars *	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
	vtkScivisScalarBars ()
	~vtkScivisScalarBars () 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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Friends
class	vtkScivisView

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
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

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkScivisScalarBars::Superclass

Definition at line 61 of file vtkScivisScalarBars.h.

Constructor & Destructor Documentation

◆ vtkScivisScalarBars()

vtkScivisScalarBars::vtkScivisScalarBars ( )

protected

◆ ~vtkScivisScalarBars()

vtkScivisScalarBars::~vtkScivisScalarBars ( )

overrideprotected

Member Function Documentation

◆ New()

vtkScivisScalarBars * vtkScivisScalarBars::New ( )

static

◆ IsTypeOf()

vtkTypeBool vtkScivisScalarBars::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkScivisScalarBars::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()

vtkScivisScalarBars * vtkScivisScalarBars::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkScivisScalarBars::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkScivisScalarBars * vtkScivisScalarBars::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetMTime()

vtkMTimeType vtkScivisScalarBars::GetMTime ( )

overridevirtual

Return this object's modified time.

Reimplemented from vtkObject.

◆ SetAutoVisibility()

void vtkScivisScalarBars::SetAutoVisibility ( bool val )

Whether a bar is kept for each array being drawn.

Default is on.

Turning this off removes the bars and stops them being maintained. The representations and the color maps they draw through are left alone.

◆ GetAutoVisibility()

bool vtkScivisScalarBars::GetAutoVisibility ( )

Whether a bar is kept for each array being drawn.

Default is on.

Turning this off removes the bars and stops them being maintained. The representations and the color maps they draw through are left alone.

◆ AutoVisibilityOn()

virtual void vtkScivisScalarBars::AutoVisibilityOn ( )

virtual

Whether a bar is kept for each array being drawn.

Default is on.

Turning this off removes the bars and stops them being maintained. The representations and the color maps they draw through are left alone.

◆ AutoVisibilityOff()

virtual void vtkScivisScalarBars::AutoVisibilityOff ( )

virtual

Whether a bar is kept for each array being drawn.

Default is on.

Turning this off removes the bars and stops them being maintained. The representations and the color maps they draw through are left alone.

◆ SetDraggable()

void vtkScivisScalarBars::SetDraggable ( bool val )

Whether the user can pick a bar up and move it.

Default is off.

A bar that has been moved keeps where it was put; the rest go on being stacked down the right hand edge. Turning this off takes the widgets away but changes nothing about where the bars are, so one the user had moved stays moved, and stays out of the stack.

◆ GetDraggable()

bool vtkScivisScalarBars::GetDraggable ( )

Whether the user can pick a bar up and move it.

Default is off.

A bar that has been moved keeps where it was put; the rest go on being stacked down the right hand edge. Turning this off takes the widgets away but changes nothing about where the bars are, so one the user had moved stays moved, and stays out of the stack.

◆ DraggableOn()

virtual void vtkScivisScalarBars::DraggableOn ( )

virtual

Whether the user can pick a bar up and move it.

Default is off.

A bar that has been moved keeps where it was put; the rest go on being stacked down the right hand edge. Turning this off takes the widgets away but changes nothing about where the bars are, so one the user had moved stays moved, and stays out of the stack.

◆ DraggableOff()

virtual void vtkScivisScalarBars::DraggableOff ( )

virtual

Whether the user can pick a bar up and move it.

Default is off.

A bar that has been moved keeps where it was put; the rest go on being stacked down the right hand edge. Turning this off takes the widgets away but changes nothing about where the bars are, so one the user had moved stays moved, and stays out of the stack.

◆ GetNumberOfBars()

int vtkScivisScalarBars::GetNumberOfBars ( )

How many bars there are, which is how many arrays the visible representations are drawing between them.

◆ GetArrayName()

const char * vtkScivisScalarBars::GetArrayName ( int index )

What the bar at index is labelled with, in array-name order.

The association is one of the vtkDataObject::FIELD_ASSOCIATION_* values.

◆ GetFieldAssociation()

int vtkScivisScalarBars::GetFieldAssociation ( int index )

What the bar at index is labelled with, in array-name order.

The association is one of the vtkDataObject::FIELD_ASSOCIATION_* values.

◆ GetActor() [1/2]

vtkScalarBarActor * vtkScivisScalarBars::GetActor ( int index )

The bar at index, or the one labelled with arrayName drawn from fieldAssoc.

Null when there is no such bar.

◆ GetActor() [2/2]

vtkScalarBarActor * vtkScivisScalarBars::GetActor	(	const char *	arrayName,
		int	fieldAssoc )

The bar at index, or the one labelled with arrayName drawn from fieldAssoc.

Null when there is no such bar.

◆ GetWidget()

vtkScalarBarWidget * vtkScivisScalarBars::GetWidget ( int index )

The widget that makes the bar at index draggable, for its interaction and its representation.

Null while Draggable is off, since there is no widget until there is something to drag.

◆ vtkScivisView

friend class vtkScivisView

friend

Definition at line 128 of file vtkScivisScalarBars.h.

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

Views/Scivis/vtkScivisScalarBars.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkScivisScalarBars()

◆ ~vtkScivisScalarBars()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetMTime()

◆ SetAutoVisibility()

◆ GetAutoVisibility()

◆ AutoVisibilityOn()

◆ AutoVisibilityOff()

◆ SetDraggable()

◆ GetDraggable()

◆ DraggableOn()

◆ DraggableOff()

◆ GetNumberOfBars()

◆ GetArrayName()

◆ GetFieldAssociation()

◆ GetActor() [1/2]

◆ GetActor() [2/2]

◆ GetWidget()

Friends And Related Symbol Documentation

◆ vtkScivisView