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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.

virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.

virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.

vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.

bool	RemoveItem (vtkIdType index)
	Remove child item from this item.

vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.

vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.

vtkIdType	GetNumberOfItems ()
	Get the number of child items.

void	ClearItems ()
	Remove all child items from this item.

vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.

virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.

vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.

virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.

virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.

virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.

vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.

virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.

vtkAbstractContextItem *	GetParent ()
	Get the parent item.

virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.

virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.


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


virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).


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


virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractContextItem ()

	~vtkAbstractContextItem () override

virtual void	ReleaseGraphicsCache ()
	Release cache entries created by this context item.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.

vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.

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

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 30 of file vtkAbstractContextItem.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAbstractContextItem::Superclass

Definition at line 33 of file vtkAbstractContextItem.h.

Constructor & Destructor Documentation

◆ vtkAbstractContextItem()

vtkAbstractContextItem::vtkAbstractContextItem ( )

protected

◆ ~vtkAbstractContextItem()

vtkAbstractContextItem::~vtkAbstractContextItem ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractContextItem::NewInstanceInternal ( ) const

protectedvirtual

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

◆ NewInstance()

vtkAbstractContextItem * vtkAbstractContextItem::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractContextItem::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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

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

◆ Update()

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, vtkChartBox, vtkChartHistogram2D, vtkChartLegend, vtkChartMatrix, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkChartXYZ, vtkColorLegend, vtkPlot, vtkPlotHistogram2D, vtkScatterPlotMatrix, vtkContextClip, vtkContextTransform, and vtkTooltipItem.

◆ Paint()

virtual bool vtkAbstractContextItem::Paint ( vtkContext2D * painter )

virtual

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

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

◆ PaintChildren()

virtual bool vtkAbstractContextItem::PaintChildren ( vtkContext2D * painter )

virtual

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

◆ ReleaseGraphicsResources()

virtual void vtkAbstractContextItem::ReleaseGraphicsResources ( )

virtual

Release graphics resources hold by the item.

The default implementation is empty.

Reimplemented in vtkPropItem.

◆ AddItem()

vtkIdType vtkAbstractContextItem::AddItem ( vtkAbstractContextItem * item )

Add child items to this item.

Increments reference count of item.

Returns: the index of the child item.

◆ RemoveItem() [1/2]

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.

◆ RemoveItem() [2/2]

bool vtkAbstractContextItem::RemoveItem ( vtkIdType 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.

◆ GetItem()

vtkAbstractContextItem * vtkAbstractContextItem::GetItem ( vtkIdType index )

Get the item at the specified index.

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

◆ GetItemIndex()

vtkIdType vtkAbstractContextItem::GetItemIndex ( vtkAbstractContextItem * item )

Get the index of the specified item in itemIndex.

Returns: the item index if found or -1 if not.

◆ GetNumberOfItems()

vtkIdType vtkAbstractContextItem::GetNumberOfItems ( )

Get the number of child items.

◆ ClearItems()

void vtkAbstractContextItem::ClearItems ( )

Remove all child items from this item.

◆ Raise()

vtkIdType vtkAbstractContextItem::Raise ( vtkIdType index )

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

Returns: The new index of the item

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

◆ StackAbove()

virtual vtkIdType vtkAbstractContextItem::StackAbove	(	vtkIdType	index,
		vtkIdType	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()

◆ Lower()

vtkIdType vtkAbstractContextItem::Lower ( vtkIdType index )

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

Returns: The new index of the item

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

◆ StackUnder()

virtual vtkIdType vtkAbstractContextItem::StackUnder	(	vtkIdType	child,
		vtkIdType	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()

◆ Hit()

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

virtual

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

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

◆ GetPickedItem()

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.

◆ MouseEnterEvent()

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 vtkGraphItem, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkPlotRangeHandlesItem, vtkEqualizerContextItem, and vtkBlockItem.

◆ MouseMoveEvent()

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 vtkGraphItem, vtkHeatmapItem, vtkChartBox, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkChartXYZ, vtkColorLegend, vtkCompositeControlPointsItem, vtkControlPointsItem, vtkInteractiveArea, vtkPiecewisePointHandleItem, vtkPlotRangeHandlesItem, vtkScatterPlotMatrix, vtkEqualizerContextItem, vtkBlockItem, and vtkContextTransform.

◆ MouseLeaveEvent()

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 vtkGraphItem, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkPlotRangeHandlesItem, vtkEqualizerContextItem, and vtkBlockItem.

◆ MouseButtonPressEvent()

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 vtkGraphItem, vtkChartBox, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkChartXYZ, vtkCompositeControlPointsItem, vtkControlPointsItem, vtkInteractiveArea, vtkPiecewisePointHandleItem, vtkPlotRangeHandlesItem, vtkScatterPlotMatrix, vtkEqualizerContextItem, vtkBlockItem, and vtkContextTransform.

◆ MouseButtonReleaseEvent()

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 vtkGraphItem, vtkChartBox, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkControlPointsItem, vtkPiecewisePointHandleItem, vtkPlotRangeHandlesItem, vtkScatterPlotMatrix, vtkEqualizerContextItem, and vtkBlockItem.

◆ MouseDoubleClickEvent()

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 vtkDendrogramItem, vtkHeatmapItem, vtkTanglegramItem, vtkTreeHeatmapItem, vtkCompositeControlPointsItem, vtkControlPointsItem, and vtkPlotRangeHandlesItem.

◆ MouseWheelEvent()

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 vtkGraphItem, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkChartXYZ, vtkInteractiveArea, and vtkContextTransform.

◆ KeyPressEvent()

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

virtual

Key press event.

Reimplemented in vtkChartXY, vtkChartXYZ, and vtkControlPointsItem.

◆ KeyReleaseEvent()

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

virtual

Key release event.

Reimplemented in vtkControlPointsItem.

◆ SetScene()

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.

◆ GetScene()

vtkContextScene * vtkAbstractContextItem::GetScene ( )

inline

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

Definition at line 213 of file vtkAbstractContextItem.h.

◆ SetParent()

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.

◆ GetParent()

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 225 of file vtkAbstractContextItem.h.

◆ MapToParent()

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

virtual

Maps the point to the parent coordinate system.

Reimplemented in vtkContextTransform.

◆ MapFromParent()

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

virtual

Maps the point from the parent coordinate system.

Reimplemented in vtkContextTransform.

◆ MapToScene()

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

virtual

Maps the point to the scene coordinate system.

◆ MapFromScene()

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

virtual

Maps the point from the scene coordinate system.

◆ GetVisible()

virtual bool vtkAbstractContextItem::GetVisible ( )

inlinevirtual

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

Reimplemented in vtkPlotFunctionalBag.

Definition at line 251 of file vtkAbstractContextItem.h.

◆ SetVisible()

virtual void vtkAbstractContextItem::SetVisible ( bool )

virtual

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

Visible by default.

◆ GetInteractive()

virtual bool vtkAbstractContextItem::GetInteractive ( )

virtual

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

◆ SetInteractive()

virtual void vtkAbstractContextItem::SetInteractive ( bool )

virtual

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

◆ ReleaseGraphicsCache()

virtual void vtkAbstractContextItem::ReleaseGraphicsCache ( )

protectedvirtual

Release cache entries created by this context item.

Reimplemented in vtkPlotPoints, and vtkPlotPoints3D.

Member Data Documentation

◆ Scene

vtkContextScene* vtkAbstractContextItem::Scene

protected

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

Definition at line 294 of file vtkAbstractContextItem.h.

◆ Parent

vtkAbstractContextItem* vtkAbstractContextItem::Parent

protected

Point to the parent item - can be null.

Definition at line 299 of file vtkAbstractContextItem.h.

◆ Children

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 306 of file vtkAbstractContextItem.h.

◆ Visible

bool vtkAbstractContextItem::Visible

protected

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

Definition at line 311 of file vtkAbstractContextItem.h.

◆ Interactive

bool vtkAbstractContextItem::Interactive

protected

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

Definition at line 316 of file vtkAbstractContextItem.h.

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

Rendering/Context2D/vtkAbstractContextItem.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAbstractContextItem()

◆ ~vtkAbstractContextItem()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Update()

◆ Paint()

◆ PaintChildren()

◆ ReleaseGraphicsResources()

◆ AddItem()

◆ RemoveItem() [1/2]

◆ RemoveItem() [2/2]

◆ GetItem()

◆ GetItemIndex()

◆ GetNumberOfItems()

◆ ClearItems()

◆ Raise()

◆ StackAbove()

◆ Lower()

◆ StackUnder()

◆ Hit()

◆ GetPickedItem()

◆ MouseEnterEvent()

◆ MouseMoveEvent()

◆ MouseLeaveEvent()

◆ MouseButtonPressEvent()

◆ MouseButtonReleaseEvent()

◆ MouseDoubleClickEvent()

◆ MouseWheelEvent()

◆ KeyPressEvent()

◆ KeyReleaseEvent()

◆ SetScene()

◆ GetScene()

◆ SetParent()

◆ GetParent()

◆ MapToParent()

◆ MapFromParent()

◆ MapToScene()

◆ MapFromScene()

◆ GetVisible()

◆ SetVisible()

◆ GetInteractive()

◆ SetInteractive()

◆ ReleaseGraphicsCache()

Member Data Documentation

◆ Scene

◆ Parent

◆ Children

◆ Visible

◆ Interactive