Legend item to display vtkScalarsToColors. More...

#include <vtkColorLegend.h>

Inheritance diagram for vtkColorLegend:

Collaboration diagram for vtkColorLegend:

Public Types
typedef vtkChartLegend	Superclass
Public Types inherited from vtkChartLegend
enum	{ LEFT = 0, CENTER, RIGHT, TOP, BOTTOM, CUSTOM }
Public Types inherited from vtkContextItem
Public Types inherited from vtkAbstractContextItem
Public Types inherited from vtkObject

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	GetBounds (double bounds[4])
virtual void	Update ()
virtual bool	Paint (vtkContext2D *painter)
virtual void	SetTransferFunction (vtkScalarsToColors *transfer)
virtual vtkScalarsToColors *	GetTransferFunction ()
virtual void	SetPosition (const vtkRectf &pos)
virtual vtkRectf	GetPosition ()
vtkRectf	GetBoundingRect (vtkContext2D *painter)
Public Member Functions inherited from vtkChartLegend
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	MouseMoveEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
virtual void	SetPoint (float, float)
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 ()
Public Member Functions inherited from vtkContextItem
virtual double	GetOpacity ()
virtual void	SetOpacity (double)
Public Member Functions inherited from vtkAbstractContextItem
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	GetNumberOfItems ()
void	ClearItems ()
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 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 bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
vtkContextScene *	GetScene ()
vtkAbstractContextItem *	GetParent ()
virtual bool	GetVisible ()
virtual void	SetVisible (bool)
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char 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)
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 &os)
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 (vtkObject *o)
static vtkColorLegend *	New ()

Protected Member Functions
	vtkColorLegend ()
virtual	~vtkColorLegend ()
virtual void	ComputeTexture ()
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 &os)
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
vtkRectf	Position
Protected Attributes inherited from vtkChartLegend
float *	Point
int	HorizontalAlignment
int	VerticalAlignment
vtkNew< vtkPen >	Pen
vtkNew< vtkBrush >	Brush
vtkNew< vtkTextProperty >	LabelProperties
bool	DragEnabled
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
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	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)

Additional Inherited Members

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 35 of file vtkColorLegend.h.

Member Typedef Documentation

typedef vtkChartLegend vtkColorLegend::Superclass

Reimplemented from vtkChartLegend.

Definition at line 38 of file vtkColorLegend.h.

Constructor & Destructor Documentation

vtkColorLegend::vtkColorLegend ( )

protected

virtual vtkColorLegend::~vtkColorLegend ( )

protectedvirtual

Member Function Documentation

virtual const char* vtkColorLegend::GetClassName ( )

virtual

Reimplemented from vtkChartLegend.

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 ( vtkObject * o )

static

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

virtual vtkScalarsToColors* vtkColorLegend::GetTransferFunction ( )

virtual

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

virtual

virtual vtkRectf vtkColorLegend::GetPosition ( )

virtual

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

Member Data Documentation

vtkScalarsToColors* vtkColorLegend::TransferFunction

protected

Definition at line 87 of file vtkColorLegend.h.

vtkSmartPointer<vtkImageData> vtkColorLegend::ImageData

protected

Definition at line 88 of file vtkColorLegend.h.

vtkSmartPointer<vtkAxis> vtkColorLegend::Axis

protected

Definition at line 89 of file vtkColorLegend.h.

vtkSmartPointer<vtkCallbackCommand> vtkColorLegend::Callback

protected

Definition at line 90 of file vtkColorLegend.h.

bool vtkColorLegend::Interpolate

protected

Definition at line 91 of file vtkColorLegend.h.

vtkRectf vtkColorLegend::Position

protected

Definition at line 92 of file vtkColorLegend.h.

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

dox/Charts/vtkColorLegend.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation