Abstract class for ScalarsToColors items. More...

#include <vtkScalarsToColorsItem.h>

Inheritance diagram for vtkScalarsToColorsItem:

Collaboration diagram for vtkScalarsToColorsItem:

Public Types
typedef vtkPlot	Superclass

Public Types inherited from vtkPlot
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 const char *	GetClassName ()

virtual int	IsA (const char *type)

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	GetBounds (double bounds[4])

virtual bool	Paint (vtkContext2D *painter)


virtual vtkPen *	GetPolyLinePen ()


virtual void	SetMaskAboveCurve (bool)

virtual bool	GetMaskAboveCurve ()

Public Member Functions inherited from vtkPlot
virtual void	SetWidth (float width)

virtual float	GetWidth ()

virtual void	SetLabel (const vtkStdString &label)

virtual vtkStdString	GetLabel ()

virtual void	SetLabels (vtkStringArray *labels)

virtual vtkStringArray *	GetLabels ()

virtual int	GetNumberOfLabels ()

vtkStdString	GetLabel (vtkIdType index)

void	SetIndexedLabels (vtkStringArray *labels)

virtual vtkStringArray *	GetIndexedLabels ()

virtual vtkTable *	GetInput ()

virtual void	SetInputArray (int index, const vtkStdString &name)

virtual void	SetSelection (vtkIdTypeArray *id)

virtual vtkIdTypeArray *	GetSelection ()

virtual bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)

virtual void	SetTooltipLabelFormat (const vtkStdString &label)

virtual vtkStdString	GetTooltipLabelFormat ()

virtual vtkStdString	GetTooltipLabel (const vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)

virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)

virtual bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max)

virtual void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)

virtual void	SetColor (double r, double g, double b)

virtual void	GetColor (double rgb[3])

void	GetColor (unsigned char rgb[3])

virtual vtkPen *	GetPen ()

virtual vtkBrush *	GetBrush ()

virtual vtkContextMapper2D *	GetData ()

virtual bool	GetUseIndexForXSeries ()

virtual void	SetUseIndexForXSeries (bool)

virtual void	SetInput (vtkTable *table)

virtual void	SetInput (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)

void	SetInput (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)

virtual vtkAxis *	GetXAxis ()

virtual void	SetXAxis (vtkAxis *axis)

virtual vtkAxis *	GetYAxis ()

virtual void	SetYAxis (vtkAxis *axis)

virtual void	SetProperty (const vtkStdString &property, const vtkVariant &var)

virtual vtkVariant	GetProperty (const vtkStdString &property)

Public Member Functions inherited from vtkContextItem
virtual double	GetOpacity ()

virtual void	SetOpacity (double)

Public Member Functions inherited from vtkAbstractContextItem
virtual void	Update ()

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 bool	Hit (const vtkContextMouseEvent &mouse)

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonReleaseEvent (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 vtkScalarsToColorsItem *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPlot
static int	IsTypeOf (const char *type)

static vtkPlot *	SafeDownCast (vtkObject *o)

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

static vtkContextItem *	SafeDownCast (vtkObject *o)

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

static vtkAbstractContextItem *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObject *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
	vtkScalarsToColorsItem ()

virtual	~vtkScalarsToColorsItem ()

virtual void	ComputeTexture ()=0

Protected Member Functions inherited from vtkPlot
	vtkPlot ()

	~vtkPlot ()

vtkStdString	GetNumber (double position, vtkAxis *axis)

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
vtkImageData *	Texture

bool	Interpolate

vtkPoints2D *	Shape

vtkCallbackCommand *	Callback

vtkPen *	PolyLinePen

bool	MaskAboveCurve

Protected Attributes inherited from vtkPlot
vtkPen *	Pen

vtkBrush *	Brush

vtkSmartPointer< vtkStringArray >	Labels

vtkSmartPointer< vtkStringArray >	AutoLabels

vtkSmartPointer< vtkStringArray >	IndexedLabels

bool	UseIndexForXSeries

vtkContextMapper2D *	Data

vtkIdTypeArray *	Selection

vtkAxis *	XAxis

vtkAxis *	YAxis

vtkStdString	TooltipLabelFormat

vtkStdString	TooltipDefaultLabelFormat

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)

Detailed Description

Abstract class for ScalarsToColors items.

vtkScalarsToColorsItem implements item bounds and painting for inherited classes that provide a texture (ComputeTexture()) and optionally a shape

See Also: vtkControlPointsItem vtkLookupTableItem vtkColorTransferFunctionItem vtkCompositeTransferFunctionItem vtkPiecewiseItemFunctionItem

Definition at line 38 of file vtkScalarsToColorsItem.h.

Member Typedef Documentation

typedef vtkPlot vtkScalarsToColorsItem::Superclass

Definition at line 41 of file vtkScalarsToColorsItem.h.

Constructor & Destructor Documentation

vtkScalarsToColorsItem::vtkScalarsToColorsItem ( )

protected

virtual vtkScalarsToColorsItem::~vtkScalarsToColorsItem ( )

protectedvirtual

Member Function Documentation

virtual const char* vtkScalarsToColorsItem::GetClassName ( )

virtual

Reimplemented from vtkPlot.

Reimplemented in vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

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

static

virtual int vtkScalarsToColorsItem::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 vtkPlot.

Reimplemented in vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

static vtkScalarsToColorsItem* vtkScalarsToColorsItem::SafeDownCast ( vtkObject * o )

static

virtual void vtkScalarsToColorsItem::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 vtkPlot.

Reimplemented in vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

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

virtual

Bounds of the item, by default (0, 1, 0, 1) but it mainly depends on the range of the ScalarsToColors function. Need to be reimplemented by subclasses if the range is != [0,1]

Reimplemented from vtkPlot.

Reimplemented in vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

virtual bool vtkScalarsToColorsItem::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 vtkAbstractContextItem.

virtual vtkPen* vtkScalarsToColorsItem::GetPolyLinePen ( )

virtual

Get a pointer to the vtkPen object that controls the drawing of the edge of the shape if any. PolyLinePen type is vtkPen::NO_PEN by default.

virtual void vtkScalarsToColorsItem::SetMaskAboveCurve ( bool )

virtual

Don't fill in the part above the transfer function. If true texture is not visible above the shape provided by subclasses, otherwise the whole rectangle defined by the bounds is filled with the transfer function. Note: only 2D transfer functions (RGB tf + alpha tf ) support the feature.

virtual bool vtkScalarsToColorsItem::GetMaskAboveCurve ( )

virtual

Don't fill in the part above the transfer function. If true texture is not visible above the shape provided by subclasses, otherwise the whole rectangle defined by the bounds is filled with the transfer function. Note: only 2D transfer functions (RGB tf + alpha tf ) support the feature.

virtual void vtkScalarsToColorsItem::ComputeTexture ( )

protectedpure virtual

Need to be reimplemented by subclasses, ComputeTexture() is called at paint time if the texture is not up to date compared to vtkScalarsToColorsItem Return false if no texture is generated.

Implemented in vtkColorTransferFunctionItem, vtkPiecewiseFunctionItem, vtkLookupTableItem, and vtkCompositeTransferFunctionItem.

virtual void vtkScalarsToColorsItem::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 vtkScalarsToColorsItem::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

vtkImageData* vtkScalarsToColorsItem::Texture

protected

Definition at line 87 of file vtkScalarsToColorsItem.h.

bool vtkScalarsToColorsItem::Interpolate

protected

Definition at line 88 of file vtkScalarsToColorsItem.h.

vtkPoints2D* vtkScalarsToColorsItem::Shape

protected

Definition at line 89 of file vtkScalarsToColorsItem.h.

vtkCallbackCommand* vtkScalarsToColorsItem::Callback

protected

Definition at line 90 of file vtkScalarsToColorsItem.h.

vtkPen* vtkScalarsToColorsItem::PolyLinePen

protected

Definition at line 92 of file vtkScalarsToColorsItem.h.

bool vtkScalarsToColorsItem::MaskAboveCurve

protected

Definition at line 93 of file vtkScalarsToColorsItem.h.

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

dox/Charts/vtkScalarsToColorsItem.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation