base class for items that are part of a vtkContextScene. More...

#include <vtkAbstractContextItem.h>

Inheritance diagram for vtkAbstractContextItem:

Collaboration diagram for vtkAbstractContextItem:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAbstractContextItem *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Update ()

virtual bool	Paint (vtkContext2D *painter)

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

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

Detailed Description

base class for items that are part of a vtkContextScene.

This class is the common base for all context scene items. You should generally derive from vtkContextItem, rather than this class, as it provides most of the commonly used API.

Definition at line 39 of file vtkAbstractContextItem.h.

Member Typedef Documentation

typedef vtkObject vtkAbstractContextItem::Superclass

Definition at line 42 of file vtkAbstractContextItem.h.

Constructor & Destructor Documentation

vtkAbstractContextItem::vtkAbstractContextItem ( )

protected

vtkAbstractContextItem::~vtkAbstractContextItem ( )

protected

Member Function Documentation

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

static

virtual int vtkAbstractContextItem::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 vtkObject.

Reimplemented in vtkAxis, vtkDendrogramItem, vtkTreeHeatmapItem, vtkScatterPlotMatrix, vtkPlotPoints, vtkHeatmapItem, vtkPlot, vtkGraphItem, vtkChart, vtkChartXY, vtkChartXYZ, vtkPlotFunctionalBag, vtkTanglegramItem, vtkPlotBar, vtkCategoryLegend, vtkControlPointsItem, vtkPlot3D, vtkPlotBag, vtkPlotStacked, vtkCompositeControlPointsItem, vtkChartLegend, vtkPiecewiseControlPointsItem, vtkPlotBox, vtkPlotLine3D, vtkPlotPoints3D, vtkScalarsToColorsItem, vtkChartBox, vtkColorTransferControlPointsItem, vtkPiecewisePointHandleItem, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotSurface, vtkContextTransform, vtkTooltipItem, vtkChartMatrix, vtkChartParallelCoordinates, vtkColorLegend, vtkPlotGrid, vtkChartPie, vtkBlockItem, vtkImageItem, vtkChartHistogram2D, vtkPlotArea, vtkPlotHistogram2D, vtkPlotLine, vtkContextItem, vtkContextClip, vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

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

static

virtual vtkObjectBase* vtkAbstractContextItem::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkAxis, vtkDendrogramItem, vtkTreeHeatmapItem, vtkScatterPlotMatrix, vtkPlotPoints, vtkHeatmapItem, vtkPlot, vtkGraphItem, vtkChart, vtkChartXY, vtkChartXYZ, vtkPlotFunctionalBag, vtkTanglegramItem, vtkPlotBar, vtkCategoryLegend, vtkControlPointsItem, vtkPlot3D, vtkPlotBag, vtkPlotStacked, vtkCompositeControlPointsItem, vtkChartLegend, vtkPiecewiseControlPointsItem, vtkPlotBox, vtkPlotLine3D, vtkPlotPoints3D, vtkScalarsToColorsItem, vtkChartBox, vtkColorTransferControlPointsItem, vtkPiecewisePointHandleItem, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotSurface, vtkContextTransform, vtkTooltipItem, vtkChartMatrix, vtkChartParallelCoordinates, vtkColorLegend, vtkPlotGrid, vtkChartPie, vtkBlockItem, vtkImageItem, vtkChartHistogram2D, vtkPlotArea, vtkPlotHistogram2D, vtkPlotLine, vtkContextItem, vtkContextClip, vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

vtkAbstractContextItem* vtkAbstractContextItem::NewInstance ( ) const

virtual void vtkAbstractContextItem::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 vtkObject.

Reimplemented in vtkAxis, vtkDendrogramItem, vtkTreeHeatmapItem, vtkScatterPlotMatrix, vtkPlotPoints, vtkHeatmapItem, vtkPlot, vtkGraphItem, vtkChart, vtkChartXY, vtkChartXYZ, vtkPlotFunctionalBag, vtkTanglegramItem, vtkPlotBar, vtkControlPointsItem, vtkPlot3D, vtkPlotBag, vtkPlotStacked, vtkCompositeControlPointsItem, vtkChartLegend, vtkPiecewiseControlPointsItem, vtkPlotBox, vtkPlotLine3D, vtkPlotPoints3D, vtkScalarsToColorsItem, vtkChartBox, vtkColorTransferControlPointsItem, vtkPiecewisePointHandleItem, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotSurface, vtkContextTransform, vtkTooltipItem, vtkChartMatrix, vtkChartParallelCoordinates, vtkColorLegend, vtkPlotGrid, vtkChartPie, vtkBlockItem, vtkImageItem, vtkChartHistogram2D, vtkPlotArea, vtkPlotHistogram2D, vtkPlotLine, vtkContextItem, vtkContextClip, vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

virtual void vtkAbstractContextItem::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 in vtkAxis, vtkChartLegend, vtkChartXYZ, vtkTooltipItem, vtkPlotFunctionalBag, vtkPlotPoints, vtkScatterPlotMatrix, vtkPlotBar, vtkPlotStacked, vtkChartXY, vtkColorLegend, vtkPlotArea, vtkPlotBag, vtkPlotBox, vtkChartBox, vtkPlotParallelCoordinates, vtkContextTransform, vtkChartParallelCoordinates, vtkChartMatrix, vtkChartPie, vtkChartHistogram2D, vtkPlotHistogram2D, and vtkContextClip.

virtual bool vtkAbstractContextItem::Paint ( vtkContext2D * painter )

virtual

Paint event for the item, called whenever the item needs to be drawn.

Reimplemented in vtkAxis, vtkTreeHeatmapItem, vtkTanglegramItem, vtkDendrogramItem, vtkChartLegend, vtkHeatmapItem, vtkChartXYZ, vtkChart, vtkControlPointsItem, vtkTooltipItem, vtkGraphItem, vtkPlotArea, vtkPlotFunctionalBag, vtkPlotPoints, vtkPlotBar, vtkPlotStacked, vtkScatterPlotMatrix, vtkChartXY, vtkColorLegend, vtkScalarsToColorsItem, vtkPlotBag, vtkCategoryLegend, vtkPlotBox, vtkChartBox, vtkPlotParallelCoordinates, vtkChartParallelCoordinates, vtkPlotGrid, vtkContextTransform, vtkChartPie, vtkChartMatrix, vtkPiecewisePointHandleItem, vtkPlotLine3D, vtkPlotHistogram2D, vtkPlotPoints3D, vtkPlotPie, vtkPlotSurface, vtkContextClip, vtkBlockItem, vtkImageItem, and vtkPlotLine.

virtual bool vtkAbstractContextItem::PaintChildren ( vtkContext2D * painter )

virtual

Paint the children of the item, should be called whenever the children need to be rendered.

virtual void vtkAbstractContextItem::ReleaseGraphicsResources ( )

virtual

Release graphics resources hold by the item. The default implementation is empty.

unsigned int vtkAbstractContextItem::AddItem ( vtkAbstractContextItem * item )

Add child items to this item. Increments reference count of item.

Returns: the index of the child item.

bool vtkAbstractContextItem::RemoveItem ( vtkAbstractContextItem * item )

Remove child item from this item. Decrements reference count of item.

Parameters

item	the item to be removed.

Returns: true on success, false otherwise.

bool vtkAbstractContextItem::RemoveItem ( unsigned int index )

Remove child item from this item. Decrements reference count of item.

Parameters

index of the item to be removed.

Returns: true on success, false otherwise.

vtkAbstractContextItem* vtkAbstractContextItem::GetItem ( unsigned int index )

Get the item at the specified index.

Returns: the item at the specified index (null if index is invalid).

unsigned int vtkAbstractContextItem::GetItemIndex ( vtkAbstractContextItem * item )

Get the index of the specified item.

Returns: the index of the item (-1 if item is not a valid child).

unsigned int vtkAbstractContextItem::GetNumberOfItems ( )

Get the number of child items.

void vtkAbstractContextItem::ClearItems ( )

Remove all child items from this item.

unsigned int vtkAbstractContextItem::Raise ( unsigned int index )

Raises the child to the top of the item's stack.

Returns: The new index of the item

See also: StackAbove(), Lower(), LowerUnder()

virtual unsigned int vtkAbstractContextItem::StackAbove	(	unsigned int	index,
		unsigned int	under
	)

virtual

Raises the child above the under sibling. If under is invalid, the item is raised to the top of the item's stack.

Returns: The new index of the item

See also: Raise(), Lower(), StackUnder()

unsigned int vtkAbstractContextItem::Lower ( unsigned int index )

Lowers the child to the bottom of the item's stack.

Returns: The new index of the item

See also: StackUnder(), Raise(), StackAbove()

virtual unsigned int vtkAbstractContextItem::StackUnder	(	unsigned int	child,
		unsigned int	above
	)

virtual

Lowers the child under the above sibling. If above is invalid, the item is lowered to the bottom of the item's stack

Returns: The new index of the item

See also: Lower(), Raise(), StackAbove()

virtual bool vtkAbstractContextItem::Hit ( const vtkContextMouseEvent & mouse )

virtual

Return true if the supplied x, y coordinate is inside the item.

Reimplemented in vtkControlPointsItem, vtkDendrogramItem, vtkChartXY, vtkChartLegend, vtkGraphItem, vtkTreeHeatmapItem, vtkContextTransform, vtkHeatmapItem, vtkScatterPlotMatrix, vtkTanglegramItem, vtkChartXYZ, vtkChartBox, vtkChartParallelCoordinates, vtkChartPie, vtkPiecewisePointHandleItem, vtkChartHistogram2D, and vtkBlockItem.

virtual vtkAbstractContextItem* vtkAbstractContextItem::GetPickedItem ( const vtkContextMouseEvent & mouse )

virtual

Return the item under the mouse. If no item is under the mouse, the method returns a null pointer.

virtual bool vtkAbstractContextItem::MouseEnterEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse enter event. Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented in vtkChartXY, vtkGraphItem, vtkChartParallelCoordinates, vtkChartPie, and vtkBlockItem.

virtual bool vtkAbstractContextItem::MouseMoveEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse move event. Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented in vtkControlPointsItem, vtkChartXY, vtkChartLegend, vtkGraphItem, vtkContextTransform, vtkHeatmapItem, vtkScatterPlotMatrix, vtkChartXYZ, vtkColorLegend, vtkChartBox, vtkChartParallelCoordinates, vtkCompositeControlPointsItem, vtkChartPie, vtkPiecewisePointHandleItem, and vtkBlockItem.

virtual bool vtkAbstractContextItem::MouseLeaveEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse leave event. Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented in vtkChartXY, vtkGraphItem, vtkChartParallelCoordinates, vtkChartPie, and vtkBlockItem.

virtual bool vtkAbstractContextItem::MouseButtonPressEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented in vtkControlPointsItem, vtkChartXY, vtkChartLegend, vtkGraphItem, vtkContextTransform, vtkScatterPlotMatrix, vtkChartXYZ, vtkChartBox, vtkChartParallelCoordinates, vtkCompositeControlPointsItem, vtkChartPie, vtkPiecewisePointHandleItem, and vtkBlockItem.

virtual bool vtkAbstractContextItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse button release event. Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented in vtkControlPointsItem, vtkChartXY, vtkChartLegend, vtkGraphItem, vtkScatterPlotMatrix, vtkChartBox, vtkChartParallelCoordinates, vtkChartPie, vtkPiecewisePointHandleItem, and vtkBlockItem.

virtual bool vtkAbstractContextItem::MouseDoubleClickEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse button double click event. Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented in vtkControlPointsItem, vtkDendrogramItem, vtkTreeHeatmapItem, vtkHeatmapItem, vtkTanglegramItem, and vtkCompositeControlPointsItem.

virtual bool vtkAbstractContextItem::MouseWheelEvent	(	const vtkContextMouseEvent &	mouse,
		int	delta
	)

virtual

Mouse wheel event, positive delta indicates forward movement of the wheel. Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented in vtkChartXY, vtkGraphItem, vtkContextTransform, vtkChartXYZ, vtkChartParallelCoordinates, and vtkChartPie.

virtual bool vtkAbstractContextItem::KeyPressEvent ( const vtkContextKeyEvent & key )

virtual

Key press event.

Reimplemented in vtkControlPointsItem, vtkChartXY, and vtkChartXYZ.

virtual bool vtkAbstractContextItem::KeyReleaseEvent ( const vtkContextKeyEvent & key )

virtual

Key release event.

Reimplemented in vtkControlPointsItem.

virtual void vtkAbstractContextItem::SetScene ( vtkContextScene * scene )

virtual

Set the vtkContextScene for the item, always set for an item in a scene.

Reimplemented in vtkChartPie, and vtkScatterPlotMatrix.

vtkContextScene* vtkAbstractContextItem::GetScene ( )

inline

Get the vtkContextScene for the item, always set for an item in a scene.

Definition at line 166 of file vtkAbstractContextItem.h.

virtual void vtkAbstractContextItem::SetParent ( vtkAbstractContextItem * parent )

virtual

Set the parent item. The parent will be set for all items except top level items in a scene.

Reimplemented in vtkPiecewisePointHandleItem.

vtkAbstractContextItem* vtkAbstractContextItem::GetParent ( )

inline

Get the parent item. The parent will be set for all items except top level items in a tree.

Definition at line 179 of file vtkAbstractContextItem.h.

virtual vtkVector2f vtkAbstractContextItem::MapToParent ( const vtkVector2f & point )

virtual

Maps the point to the parent coordinate system.

Reimplemented in vtkContextTransform.

virtual vtkVector2f vtkAbstractContextItem::MapFromParent ( const vtkVector2f & point )

virtual

Maps the point from the parent coordinate system.

Reimplemented in vtkContextTransform.

virtual vtkVector2f vtkAbstractContextItem::MapToScene ( const vtkVector2f & point )

virtual

Maps the point to the scene coordinate system.

virtual vtkVector2f vtkAbstractContextItem::MapFromScene ( const vtkVector2f & point )

virtual

Maps the point from the scene coordinate system.

virtual bool vtkAbstractContextItem::GetVisible ( )

virtual

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

Reimplemented in vtkPlotFunctionalBag.

virtual void vtkAbstractContextItem::SetVisible ( bool )

virtual

Set the visibility of the item (should it be drawn). Visible by default.

virtual bool vtkAbstractContextItem::GetInteractive ( )

virtual

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

virtual void vtkAbstractContextItem::SetInteractive ( bool )

virtual

Set if the item is interactive (should respond to mouse events).

Member Data Documentation

vtkContextScene* vtkAbstractContextItem::Scene

protected

Point to the scene the item is on - can be null.

Definition at line 224 of file vtkAbstractContextItem.h.

vtkAbstractContextItem* vtkAbstractContextItem::Parent

protected

Point to the parent item - can be null.

Definition at line 227 of file vtkAbstractContextItem.h.

vtkContextScenePrivate* vtkAbstractContextItem::Children

protected

This structure provides a list of children, along with convenience functions to paint the children etc. It is derived from std::vector<vtkAbstractContextItem>, defined in a private header.

Definition at line 232 of file vtkAbstractContextItem.h.

bool vtkAbstractContextItem::Visible

protected

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

Definition at line 235 of file vtkAbstractContextItem.h.

bool vtkAbstractContextItem::Interactive

protected

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

Definition at line 239 of file vtkAbstractContextItem.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Context2D/vtkAbstractContextItem.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