vtkColorLegend Class Reference

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 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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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 ()
Public Member Functions inherited from vtkChartLegend
vtkChartLegend *	NewInstance () const
void	SetPoint (const vtkVector2f &point)
const vtkVector2f &	GetPointVector ()
virtual void	SetLabelSize (int size)
virtual int	GetLabelSize ()
void	SetChart (vtkChart *chart)
vtkChart *	GetChart ()
vtkPen *	GetPen ()
vtkBrush *	GetBrush ()
vtkTextProperty *	GetLabelProperties ()
virtual bool	Hit (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
void	SetPoint (float[2])
virtual float *	GetPoint ()
virtual void	GetPoint (float &, float &)
virtual void	GetPoint (float[2])
virtual void	SetHorizontalAlignment (int)
virtual int	GetHorizontalAlignment ()
virtual void	SetVerticalAlignment (int)
virtual int	GetVerticalAlignment ()
virtual void	SetPadding (int)
virtual int	GetPadding ()
virtual void	SetSymbolWidth (int)
virtual int	GetSymbolWidth ()
virtual void	SetInline (bool)
virtual bool	GetInline ()
virtual void	SetDragEnabled (bool)
virtual bool	GetDragEnabled ()
virtual void	SetCacheBounds (bool)
virtual bool	GetCacheBounds ()
virtual void	CacheBoundsOn ()
virtual void	CacheBoundsOff ()
Public Member Functions inherited from vtkContextItem
vtkContextItem *	NewInstance () const
virtual double	GetOpacity ()
virtual void	SetOpacity (double)
Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItem *	NewInstance () const
virtual bool	PaintChildren (vtkContext2D *painter)
virtual void	ReleaseGraphicsResources ()
unsigned int	AddItem (vtkAbstractContextItem *item)
bool	RemoveItem (vtkAbstractContextItem *item)
bool	RemoveItem (unsigned int index)
vtkAbstractContextItem *	GetItem (unsigned int index)
unsigned int	GetItemIndex (vtkAbstractContextItem *item)
unsigned int	GetNumberOfItems ()
void	ClearItems ()
unsigned int	Raise (unsigned int index)
unsigned int	Lower (unsigned int index)
virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
virtual void	SetScene (vtkContextScene *scene)
virtual void	SetParent (vtkAbstractContextItem *parent)
virtual vtkVector2f	MapToParent (const vtkVector2f &point)
virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
virtual vtkVector2f	MapToScene (const vtkVector2f &point)
virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
virtual unsigned int	StackAbove (unsigned int index, unsigned int under)
virtual unsigned int	StackUnder (unsigned int child, unsigned int above)
virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
vtkContextScene *	GetScene ()
vtkAbstractContextItem *	GetParent ()
virtual bool	GetVisible ()
virtual void	SetVisible (bool)
virtual bool	GetInteractive ()
virtual void	SetInteractive (bool)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
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 *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkColorLegend *	SafeDownCast (vtkObjectBase *o)
static vtkColorLegend *	New ()
Static Public Member Functions inherited from vtkChartLegend
static int	IsTypeOf (const char *type)
static vtkChartLegend *	SafeDownCast (vtkObjectBase *o)
static vtkChartLegend *	New ()
Static Public Member Functions inherited from vtkContextItem
static int	IsTypeOf (const char *type)
static vtkContextItem *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractContextItem
static int	IsTypeOf (const char *type)
static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkColorLegend ()
virtual	~vtkColorLegend ()
virtual void	ComputeTexture ()
void	UpdateAxisPosition ()
Protected Member Functions inherited from vtkChartLegend
	vtkChartLegend ()
	~vtkChartLegend ()
Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()
	~vtkContextItem ()
Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()
	~vtkAbstractContextItem ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
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 &)

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
vtkNew< vtkBrush >	Brush
vtkNew< vtkTextProperty >	LabelProperties
bool	DragEnabled
bool	CacheBounds
int	Button
vtkTimeStamp	PlotTime
vtkTimeStamp	RectTime
vtkRectf	Rect
int	Padding
int	SymbolWidth
bool	Inline
Private *	Storage
Protected Attributes inherited from vtkContextItem
double	Opacity
Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
vtkAbstractContextItem *	Parent
vtkContextScenePrivate *	Children
bool	Visible
bool	Interactive
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
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

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 ( )

protectedvirtual

Member Function Documentation

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

static

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

virtual vtkObjectBase* vtkColorLegend::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkChartLegend.

vtkColorLegend* vtkColorLegend::NewInstance

(

)

const

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

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 ( )

protectedvirtual

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  )

protectedvirtual

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  )

staticprotected

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

void vtkColorLegend::UpdateAxisPosition ( )

protected

Moves the axis whenever the position of this legend changes.

Member Data Documentation

vtkScalarsToColors* vtkColorLegend::TransferFunction

protected

Definition at line 142 of file vtkColorLegend.h.

vtkSmartPointer<vtkImageData> vtkColorLegend::ImageData

protected

Definition at line 143 of file vtkColorLegend.h.

vtkSmartPointer<vtkAxis> vtkColorLegend::Axis

protected

Definition at line 144 of file vtkColorLegend.h.

vtkSmartPointer<vtkCallbackCommand> vtkColorLegend::Callback

protected

Definition at line 145 of file vtkColorLegend.h.

bool vtkColorLegend::Interpolate

protected

Definition at line 146 of file vtkColorLegend.h.

bool vtkColorLegend::CustomPositionSet

protected

Definition at line 147 of file vtkColorLegend.h.

bool vtkColorLegend::DrawBorder

protected

Definition at line 148 of file vtkColorLegend.h.

vtkRectf vtkColorLegend::Position

protected

Definition at line 149 of file vtkColorLegend.h.

int vtkColorLegend::Orientation

protected

Definition at line 150 of file vtkColorLegend.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Charts/Core/vtkColorLegend.h