VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractContextItem Class Reference

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

#include <vtkAbstractContextItem.h>

Inheritance diagram for vtkAbstractContextItem:
[legend]
Collaboration diagram for vtkAbstractContextItem:
[legend]

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. More...
 
vtkAbstractContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool Paint (vtkContext2D *painter)
 Paint event for the item, called whenever the item needs to be drawn. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
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. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- 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. More...
 
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

vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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 40 of file vtkAbstractContextItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractContextItem::NewInstanceInternal ( ) const
protectedvirtual

◆ 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 vtkObject.

Reimplemented in vtkDendrogramItem, vtkTreeHeatmapItem, vtkHeatmapItem, vtkGraphItem, vtkTanglegramItem, vtkLabeledContourPolyDataItem, vtkPythonItem, vtkContextTransform, vtkTooltipItem, vtkPropItem, vtkBlockItem, vtkImageItem, vtkContextItem, vtkPolyDataItem, and vtkContextClip.

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

◆ Paint()

virtual bool vtkAbstractContextItem::Paint ( vtkContext2D painter)
virtual

◆ 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
itemthe 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
indexof 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

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

◆ MouseMoveEvent()

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

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

◆ MouseButtonPressEvent()

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

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

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

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

◆ KeyPressEvent()

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

Key press event.

Reimplemented in vtkControlPointsItem, vtkChartXY, and vtkChartXYZ.

◆ 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 222 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 237 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 ( )
virtual

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

Reimplemented in vtkPlotFunctionalBag.

◆ 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).

Member Data Documentation

◆ Scene

vtkContextScene* vtkAbstractContextItem::Scene
protected

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

Definition at line 298 of file vtkAbstractContextItem.h.

◆ Parent

vtkAbstractContextItem* vtkAbstractContextItem::Parent
protected

Point to the parent item - can be null.

Definition at line 303 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 310 of file vtkAbstractContextItem.h.

◆ Visible

bool vtkAbstractContextItem::Visible
protected

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

Definition at line 315 of file vtkAbstractContextItem.h.

◆ Interactive

bool vtkAbstractContextItem::Interactive
protected

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

Definition at line 320 of file vtkAbstractContextItem.h.


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