Legend item to display vtkScalarsToColors. More...

#include <vtkColorLegend.h>

Inheritance diagram for vtkColorLegend:

Collaboration diagram for vtkColorLegend:

Public Types
enum	{ VERTICAL = 0 , HORIZONTAL }
	Enum of legend orientation types. More...

typedef vtkChartLegend	Superclass

Public Types inherited from vtkChartLegend
enum	{ LEFT = 0 , CENTER , RIGHT , TOP , BOTTOM , CUSTOM }

typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
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.

vtkColorLegend *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	GetBounds (double bounds[4])
	Bounds of the item, by default (0, 1, 0, 1) but it mainly depends on the range of the vtkScalarsToColors function.

void	Update () override
	Perform any updates to the item that may be necessary before rendering.

bool	Paint (vtkContext2D *painter) override
	Paint the texture into a rectangle defined by the bounds.

void	SetPoint (float x, float y) override
	Set the point this legend is anchored to.

virtual void	SetTextureSize (float w, float h)
	Set the size of the scalar bar drawn by this legend.

virtual void	SetPosition (const vtkRectf &pos)
	Set the origin, width, and height of the scalar bar drawn by this legend.

virtual vtkRectf	GetPosition ()
	Returns the origin, width, and height of the scalar bar drawn by this legend.

vtkRectf	GetBoundingRect (vtkContext2D *painter) override
	Request the space the legend requires to be drawn.

bool	MouseMoveEvent (const vtkContextMouseEvent &mouse) override
	Mouse move event.


virtual void	SetTransferFunction (vtkScalarsToColors *transfer)
	Set/Get the transfer function that is used to draw the scalar bar within this legend.

virtual vtkScalarsToColors *	GetTransferFunction ()
	Set/Get the transfer function that is used to draw the scalar bar within this legend.


virtual void	SetOrientation (int orientation)
	Set/get the orientation of the legend.

virtual int	GetOrientation ()
	Set/get the orientation of the legend.


virtual void	SetTitle (const vtkStdString &title)
	Get/set the title text of the legend.

virtual vtkStdString	GetTitle ()
	Get/set the title text of the legend.


virtual void	SetDrawBorder (bool)
	Toggle whether or not a border should be drawn around this legend.

virtual bool	GetDrawBorder ()
	Toggle whether or not a border should be drawn around this legend.

virtual void	DrawBorderOn ()
	Toggle whether or not a border should be drawn around this legend.

virtual void	DrawBorderOff ()
	Toggle whether or not a border should be drawn around this legend.

Public Member Functions inherited from vtkChartLegend
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkChartLegend *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetPoint (const vtkVector2f &point)
	Set point the legend box is anchored to.

const vtkVector2f &	GetPointVector ()
	Get point the legend box is anchored to.

virtual void	SetLabelSize (int size)
	Set the point size of the label text.

virtual int	GetLabelSize ()
	Get the point size of the label text.

void	SetChart (vtkChart *chart)
	Set the chart that the legend belongs to and will draw the legend for.

vtkChart *	GetChart ()
	Get the chart that the legend belongs to and will draw the legend for.

void	Update () override
	Update the geometry of the axis.

bool	Paint (vtkContext2D *painter) override
	Paint event for the axis, called whenever the axis needs to be drawn.

virtual vtkRectf	GetBoundingRect (vtkContext2D *painter)
	Request the space the legend requires to be drawn.

vtkPen *	GetPen ()
	Get the pen used to draw the legend outline.

vtkBrush *	GetBrush ()
	Get the brush used to draw the legend background.

vtkTextProperty *	GetLabelProperties ()
	Get the vtkTextProperty for the legend's labels.

bool	Hit (const vtkContextMouseEvent &mouse) override
	Return true if the supplied x, y coordinate is inside the item.

bool	MouseMoveEvent (const vtkContextMouseEvent &mouse) override
	Mouse move event.

bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
	Mouse button down event.

bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
	Mouse button release event.

void	SetPoint (float[2])
	Set point the legend box is anchored to.

virtual float *	GetPoint ()
	Get point the legend box is anchored to.

virtual void	GetPoint (float &, float &)
	Get point the legend box is anchored to.

virtual void	GetPoint (float[2])
	Get point the legend box is anchored to.

virtual void	SetHorizontalAlignment (int)
	Set the horizontal alignment of the legend to the point specified.

virtual int	GetHorizontalAlignment ()
	Get the horizontal alignment of the legend to the point specified.

virtual void	SetVerticalAlignment (int)
	Set the vertical alignment of the legend to the point specified.

virtual int	GetVerticalAlignment ()
	Get the vertical alignment of the legend to the point specified.

virtual void	SetPadding (int)
	Set the padding between legend marks, default is 5.

virtual int	GetPadding ()
	Get the padding between legend marks.

virtual void	SetSymbolWidth (int)
	Set the symbol width, default is 15.

virtual int	GetSymbolWidth ()
	Get the legend symbol width.

virtual void	SetInline (bool)
	Get/set if the legend should be drawn inline (inside the chart), or not.

virtual bool	GetInline ()
	Get/set if the legend should be drawn inline (inside the chart), or not.

virtual void	SetDragEnabled (bool)
	Get/set if the legend can be dragged with the mouse button, or not.

virtual bool	GetDragEnabled ()
	Get/set if the legend can be dragged with the mouse button, or not.

virtual void	SetCacheBounds (bool)
	Toggle whether or not this legend should attempt to cache its position and size.

virtual bool	GetCacheBounds ()
	Toggle whether or not this legend should attempt to cache its position and size.

virtual void	CacheBoundsOn ()
	Toggle whether or not this legend should attempt to cache its position and size.

virtual void	CacheBoundsOff ()
	Toggle whether or not this legend should attempt to cache its position and size.

Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetTransform (vtkContextTransform *)
	Set the transform of the item.

virtual double	GetOpacity ()
	Get the opacity of the item.

virtual void	SetOpacity (double)
	Set the opacity of the item.

Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.

virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.

virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.

vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.

bool	RemoveItem (vtkIdType index)
	Remove child item from this item.

vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.

vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.

vtkIdType	GetNumberOfItems ()
	Get the number of child items.

void	ClearItems ()
	Remove all child items from this item.

vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.

virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.

vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.

virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.

virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.

virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.

vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.

virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.

vtkAbstractContextItem *	GetParent ()
	Get the parent item.

virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.

virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.

virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).

virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).

virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).

virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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.

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

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkColorLegend *	SafeDownCast (vtkObjectBase *o)

static vtkColorLegend *	New ()

Static Public Member Functions inherited from vtkChartLegend
static vtkTypeBool	IsTypeOf (const char *type)

static vtkChartLegend *	SafeDownCast (vtkObjectBase *o)

static vtkChartLegend *	New ()
	Creates a 2D Chart object.

Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextItem *	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 (int 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 int	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

	vtkColorLegend ()

	~vtkColorLegend () override

virtual void	ComputeTexture ()
	Need to be reimplemented by subclasses, ComputeTexture() is called at paint time if the texture is not up to date compared to vtkColorLegend.

void	UpdateAxisPosition ()
	Moves the axis whenever the position of this legend changes.

Protected Member Functions inherited from vtkChartLegend
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkChartLegend ()

	~vtkChartLegend () override

Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextItem ()=default

	~vtkContextItem () override=default

Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () 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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkScalarsToColors *	TransferFunction

vtkSmartPointer< vtkImageData >	ImageData

vtkSmartPointer< vtkAxis >	Axis

vtkSmartPointer< vtkCallbackCommand >	Callback

bool	Interpolate

bool	CustomPositionSet

bool	DrawBorder

vtkRectf	Position

int	Orientation

Protected Attributes inherited from vtkChartLegend
float *	Point

int	HorizontalAlignment

int	VerticalAlignment

vtkNew< vtkPen >	Pen
	The pen used to draw the legend box.

vtkNew< vtkBrush >	Brush
	The brush used to render the background of the legend.

vtkNew< vtkTextProperty >	LabelProperties
	The text properties of the labels used in the legend.

bool	DragEnabled
	Should we move the legend box around in response to the mouse drag?

bool	CacheBounds
	Should the legend attempt to avoid recalculating its position & bounds unnecessarily?

int	Button
	Last button to be pressed.

vtkTimeStamp	PlotTime

vtkTimeStamp	RectTime

vtkRectf	Rect

int	Padding
	Padding between symbol and text.

int	SymbolWidth
	Width of the symbols in pixels in the legend.

bool	Inline
	Should the legend be drawn inline in its chart?

Private *	Storage

Protected Attributes inherited from vtkContextItem
double	Opacity = 1.0

vtkContextTransform *	Transform = nullptr

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.

vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.

bool	Visible
	Store the visibility of the item (default is true).

bool	Interactive
	Store whether the item should respond to interactions (default is true).

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

virtual void	ScalarsToColorsModified (vtkObject caller, unsigned long eid, void calldata)
	Called whenever the ScalarsToColors function(s) is modified.

static void	OnScalarsToColorsModified (vtkObject caller, unsigned long eid, void clientdata, void *calldata)
	Called whenever the ScalarsToColors function(s) is modified.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Legend item to display vtkScalarsToColors.

vtkColorLegend is an item that will display the vtkScalarsToColors using a 1D texture, and a vtkAxis to show both the color and numerical range.

Online Examples:

Histogram2D

Definition at line 57 of file vtkColorLegend.h.

Member Typedef Documentation

◆ Superclass

typedef vtkChartLegend vtkColorLegend::Superclass

Definition at line 60 of file vtkColorLegend.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum of legend orientation types.

Enumerator
VERTICAL
HORIZONTAL

Definition at line 67 of file vtkColorLegend.h.

Constructor & Destructor Documentation

◆ vtkColorLegend()

vtkColorLegend::vtkColorLegend ( )

protected

◆ ~vtkColorLegend()

vtkColorLegend::~vtkColorLegend ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkColorLegend::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkChartLegend.

◆ NewInstance()

vtkColorLegend * vtkColorLegend::NewInstance ( ) const

◆ PrintSelf()

void vtkColorLegend::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 vtkChartLegend.

◆ New()

static vtkColorLegend * vtkColorLegend::New ( )

static

◆ GetBounds()

virtual void vtkColorLegend::GetBounds ( double bounds[4] )

virtual

Bounds of the item, by default (0, 1, 0, 1) but it mainly depends on the range of the vtkScalarsToColors function.

◆ Update()

void vtkColorLegend::Update ( )

overridevirtual

Perform any updates to the item that may be necessary before rendering.

The scene should take care of calling this on all items before their Paint function is invoked.

Reimplemented from vtkChartLegend.

◆ Paint()

bool vtkColorLegend::Paint ( vtkContext2D * painter )

overridevirtual

Paint the texture into a rectangle defined by the bounds.

If MaskAboveCurve is true and a shape has been provided by a subclass, it draws the texture into the shape

Reimplemented from vtkChartLegend.

◆ SetTransferFunction()

virtual void vtkColorLegend::SetTransferFunction ( vtkScalarsToColors * transfer )

virtual

Set/Get the transfer function that is used to draw the scalar bar within this legend.

◆ GetTransferFunction()

virtual vtkScalarsToColors * vtkColorLegend::GetTransferFunction ( )

virtual

Set/Get the transfer function that is used to draw the scalar bar within this legend.

◆ SetPoint()

void vtkColorLegend::SetPoint	(	float	x,
		float	y
	)

overridevirtual

Set the point this legend is anchored to.

Reimplemented from vtkChartLegend.

◆ SetTextureSize()

virtual void vtkColorLegend::SetTextureSize	(	float	w,
		float	h
	)

virtual

Set the size of the scalar bar drawn by this legend.

◆ SetPosition()

virtual void vtkColorLegend::SetPosition ( const vtkRectf & pos )

virtual

Set the origin, width, and height of the scalar bar drawn by this legend.

This method overrides the anchor point, as well as any horizontal and vertical alignment that has been set for this legend. If this is a problem for you, use SetPoint() and SetTextureSize() instead.

◆ GetPosition()

virtual vtkRectf vtkColorLegend::GetPosition ( )

virtual

Returns the origin, width, and height of the scalar bar drawn by this legend.

◆ GetBoundingRect()

vtkRectf vtkColorLegend::GetBoundingRect ( vtkContext2D * painter )

overridevirtual

Request the space the legend requires to be drawn.

This is returned as a vtkRect4f, with the corner being the offset from Point, and the width/ height being the total width/height required by the axis. In order to ensure the numbers are correct, Update() should be called first.

Reimplemented from vtkChartLegend.

◆ SetOrientation()

virtual void vtkColorLegend::SetOrientation ( int orientation )

virtual

Set/get the orientation of the legend.

Valid orientations are VERTICAL (default) and HORIZONTAL.

◆ GetOrientation()

virtual int vtkColorLegend::GetOrientation ( )

virtual

Set/get the orientation of the legend.

Valid orientations are VERTICAL (default) and HORIZONTAL.

◆ SetTitle()

virtual void vtkColorLegend::SetTitle ( const vtkStdString & title )

virtual

Get/set the title text of the legend.

◆ GetTitle()

virtual vtkStdString vtkColorLegend::GetTitle ( )

virtual

Get/set the title text of the legend.

◆ SetDrawBorder()

virtual void vtkColorLegend::SetDrawBorder ( bool )

virtual

Toggle whether or not a border should be drawn around this legend.

The default behavior is to not draw a border.

◆ GetDrawBorder()

virtual bool vtkColorLegend::GetDrawBorder ( )

virtual

Toggle whether or not a border should be drawn around this legend.

The default behavior is to not draw a border.

◆ DrawBorderOn()

virtual void vtkColorLegend::DrawBorderOn ( )

virtual

Toggle whether or not a border should be drawn around this legend.

The default behavior is to not draw a border.

◆ DrawBorderOff()

virtual void vtkColorLegend::DrawBorderOff ( )

virtual

Toggle whether or not a border should be drawn around this legend.

The default behavior is to not draw a border.

◆ MouseMoveEvent()

bool vtkColorLegend::MouseMoveEvent ( const vtkContextMouseEvent & mouse )

overridevirtual

Mouse move event.

Reimplemented from vtkChartLegend.

◆ ComputeTexture()

virtual void vtkColorLegend::ComputeTexture ( )

protectedvirtual

Need to be reimplemented by subclasses, ComputeTexture() is called at paint time if the texture is not up to date compared to vtkColorLegend.

◆ ScalarsToColorsModified()

virtual void vtkColorLegend::ScalarsToColorsModified	(	vtkObject *	caller,
		unsigned long	eid,
		void *	calldata
	)

protectedvirtual

Called whenever the ScalarsToColors function(s) is modified.

It internally calls Modified(). Can be reimplemented by subclasses.

◆ OnScalarsToColorsModified()

static void vtkColorLegend::OnScalarsToColorsModified	(	vtkObject *	caller,
		unsigned long	eid,
		void *	clientdata,
		void *	calldata
	)

staticprotected

Called whenever the ScalarsToColors function(s) is modified.

It internally calls Modified(). Can be reimplemented by subclasses.

◆ UpdateAxisPosition()

void vtkColorLegend::UpdateAxisPosition ( )

protected

Moves the axis whenever the position of this legend changes.

Member Data Documentation

◆ TransferFunction

vtkScalarsToColors* vtkColorLegend::TransferFunction

protected

Definition at line 191 of file vtkColorLegend.h.

◆ ImageData

vtkSmartPointer<vtkImageData> vtkColorLegend::ImageData

protected

Definition at line 192 of file vtkColorLegend.h.

◆ Axis

vtkSmartPointer<vtkAxis> vtkColorLegend::Axis

protected

Definition at line 193 of file vtkColorLegend.h.

◆ Callback

vtkSmartPointer<vtkCallbackCommand> vtkColorLegend::Callback

protected

Definition at line 194 of file vtkColorLegend.h.

◆ Interpolate

bool vtkColorLegend::Interpolate

protected

Definition at line 195 of file vtkColorLegend.h.

◆ CustomPositionSet

bool vtkColorLegend::CustomPositionSet

protected

Definition at line 196 of file vtkColorLegend.h.

◆ DrawBorder

bool vtkColorLegend::DrawBorder

protected

Definition at line 197 of file vtkColorLegend.h.

◆ Position

vtkRectf vtkColorLegend::Position

protected

Definition at line 198 of file vtkColorLegend.h.

◆ Orientation

int vtkColorLegend::Orientation

protected

Definition at line 199 of file vtkColorLegend.h.

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

Charts/Core/vtkColorLegend.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkColorLegend()

◆ ~vtkColorLegend()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ GetBounds()

◆ Update()

◆ Paint()

◆ SetTransferFunction()

◆ GetTransferFunction()

◆ SetPoint()

◆ SetTextureSize()

◆ SetPosition()

◆ GetPosition()

◆ GetBoundingRect()

◆ SetOrientation()

◆ GetOrientation()

◆ SetTitle()

◆ GetTitle()

◆ SetDrawBorder()

◆ GetDrawBorder()

◆ DrawBorderOn()

◆ DrawBorderOff()

◆ MouseMoveEvent()

◆ ComputeTexture()

◆ ScalarsToColorsModified()

◆ OnScalarsToColorsModified()

◆ UpdateAxisPosition()

Member Data Documentation

◆ TransferFunction

◆ ImageData

◆ Axis

◆ Callback

◆ Interpolate

◆ CustomPositionSet

◆ DrawBorder

◆ Position

◆ Orientation