Legend item to display vtkScalarsToColors. More...

#include <vtkColorLegend.h>

Inheritance diagram for vtkColorLegend:

Collaboration diagram for vtkColorLegend:

Public Types
typedef vtkChartLegend	Superclass

enum	{ VERTICAL = 0, HORIZONTAL }
Public Member Functions
virtual int	IsA (const char *type)
vtkColorLegend *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	GetBounds (double bounds[4])
virtual void	Update ()
virtual bool	Paint (vtkContext2D *painter)
virtual void	SetPoint (float x, float y)
virtual void	SetTextureSize (float w, float h)
virtual void	SetPosition (const vtkRectf &pos)
virtual vtkRectf	GetPosition ()
vtkRectf	GetBoundingRect (vtkContext2D *painter)
virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)

virtual void	SetTransferFunction (vtkScalarsToColors *transfer)
virtual vtkScalarsToColors *	GetTransferFunction ()

virtual void	SetOrientation (int orientation)
virtual int	GetOrientation ()

virtual void	SetTitle (const vtkStdString &title)
virtual vtkStdString	GetTitle ()

virtual void	SetDrawBorder (bool)
virtual bool	GetDrawBorder ()
virtual void	DrawBorderOn ()
virtual void	DrawBorderOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkColorLegend *	SafeDownCast (vtkObjectBase *o)
static vtkColorLegend *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkColorLegend ()
virtual	~vtkColorLegend ()
virtual void	ComputeTexture ()
void	UpdateAxisPosition ()
Protected Attributes
vtkScalarsToColors *	TransferFunction
vtkSmartPointer< vtkImageData >	ImageData
vtkSmartPointer< vtkAxis >	Axis
vtkSmartPointer < vtkCallbackCommand >	Callback
bool	Interpolate
bool	CustomPositionSet
bool	DrawBorder
vtkRectf	Position
int	Orientation
virtual void	ScalarsToColorsModified (vtkObject caller, unsigned long eid, void calldata)
static void	OnScalarsToColorsModified (vtkObject caller, unsigned long eid, void clientdata, void *calldata)

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.

Definition at line 37 of file vtkColorLegend.h.

Member Typedef Documentation

typedef vtkChartLegend vtkColorLegend::Superclass

Reimplemented from vtkChartLegend.

Definition at line 40 of file vtkColorLegend.h.

Member Enumeration Documentation

anonymous enum

Enum of legend orientation types

Enumerator:

VERTICAL
HORIZONTAL

Definition at line 46 of file vtkColorLegend.h.

Constructor & Destructor Documentation

vtkColorLegend::vtkColorLegend ( ) [protected]

virtual vtkColorLegend::~vtkColorLegend ( ) [protected, virtual]

Member Function Documentation

static int vtkColorLegend::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

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

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

Reimplemented from vtkChartLegend.

virtual vtkObjectBase* vtkColorLegend::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkChartLegend.

vtkColorLegend* vtkColorLegend::NewInstance ( ) const

Reimplemented from vtkChartLegend.

virtual void vtkColorLegend::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

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.

static vtkColorLegend* vtkColorLegend::New ( ) [static]

Creates a 2D Chart object.

Reimplemented from vtkChartLegend.

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.

virtual void vtkColorLegend::Update ( ) [virtual]

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.

virtual bool vtkColorLegend::Paint ( vtkContext2D * painter ) [virtual]

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.

virtual void vtkColorLegend::SetTransferFunction ( vtkScalarsToColors * transfer ) [virtual]

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

virtual vtkScalarsToColors* vtkColorLegend::GetTransferFunction ( ) [virtual]

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

virtual void vtkColorLegend::SetPoint	(	float	x,
		float	y
	)		`[virtual]`

Set the point this legend is anchored to.

Reimplemented from vtkChartLegend.

virtual void vtkColorLegend::SetTextureSize	(	float	w,
		float	h
	)		`[virtual]`

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

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.

virtual vtkRectf vtkColorLegend::GetPosition ( ) [virtual]

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

vtkRectf vtkColorLegend::GetBoundingRect ( vtkContext2D * painter ) [virtual]

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.

virtual void vtkColorLegend::SetOrientation ( int orientation ) [virtual]

Set/get the orientation of the legend. Valid orientations are VERTICAL (default) and HORIZONTAL.

virtual int vtkColorLegend::GetOrientation ( ) [virtual]

Set/get the orientation of the legend. Valid orientations are VERTICAL (default) and HORIZONTAL.

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

Get/set the title text of the legend.

virtual vtkStdString vtkColorLegend::GetTitle ( ) [virtual]

Get/set the title text of the legend.

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.

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.

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.

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.

virtual bool vtkColorLegend::MouseMoveEvent ( const vtkContextMouseEvent & mouse ) [virtual]

Mouse move event.

Reimplemented from vtkChartLegend.

virtual void vtkColorLegend::ComputeTexture ( ) [protected, virtual]

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

virtual void vtkColorLegend::ScalarsToColorsModified	(	vtkObject *	caller,
		unsigned long	eid,
		void *	calldata
	)		`[protected, virtual]`

Called whenever the ScalarsToColors function(s) is modified. It internally calls Modified(). Can be reimplemented by subclasses.

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