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 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 Update ()
 
virtual bool Paint (vtkContext2D *painter)
 
bool PaintChildren (vtkContext2D *painter)
 
virtual void ReleaseGraphicsResources ()
 
unsigned int AddItem (vtkAbstractContextItem *item)
 
bool RemoveItem (vtkAbstractContextItem *item)
 
bool RemoveItem (unsigned int index)
 
vtkAbstractContextItemGetItem (unsigned int index)
 
unsigned int GetNumberOfItems ()
 
void ClearItems ()
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 
virtual vtkAbstractContextItemGetPickedItem (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)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
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)
 
vtkCommandGetCommand (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 vtkAbstractContextItemSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

 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

vtkContextSceneScene
 
vtkAbstractContextItemParent
 
vtkContextScenePrivateChildren
 
bool Visible
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int 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 37 of file vtkAbstractContextItem.h.

Member Typedef Documentation

Definition at line 40 of file vtkAbstractContextItem.h.

Constructor & Destructor Documentation

vtkAbstractContextItem::vtkAbstractContextItem ( )
protected
vtkAbstractContextItem::~vtkAbstractContextItem ( )
protected

Member Function Documentation

virtual const char* vtkAbstractContextItem::GetClassName ( )
virtual
static int vtkAbstractContextItem::IsTypeOf ( const char *  type)
static
virtual int vtkAbstractContextItem::IsA ( const char *  name)
virtual
static vtkAbstractContextItem* vtkAbstractContextItem::SafeDownCast ( vtkObject o)
static
virtual void vtkAbstractContextItem::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
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, vtkTooltipItem, vtkPlotStacked, vtkPlotPoints, vtkChartXY, vtkColorLegend, vtkPlotParallelCoordinates, vtkChartParallelCoordinates, vtkContextTransform, vtkChartPie, vtkChartHistogram2D, vtkPlotHistogram2D, and vtkContextClip.

virtual bool vtkAbstractContextItem::Paint ( vtkContext2D painter)
virtual
bool vtkAbstractContextItem::PaintChildren ( vtkContext2D painter)

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
itemthe 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
indexof 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::GetNumberOfItems ( )

Get the number of child items.

void vtkAbstractContextItem::ClearItems ( )

Remove all child items from this item.

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

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

Reimplemented in vtkControlPointsItem, vtkChartLegend, vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, 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, 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, vtkChartLegend, vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, 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, 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, vtkChartLegend, vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, 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, vtkChartLegend, vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, 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.

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, vtkChartParallelCoordinates, and vtkChartPie.

virtual void vtkAbstractContextItem::SetScene ( vtkContextScene scene)
virtual

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

Reimplemented in vtkChartPie.

vtkContextScene* vtkAbstractContextItem::GetScene ( )
inline

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

Definition at line 130 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.

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

virtual void vtkAbstractContextItem::SetVisible ( bool  )
virtual

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

Member Data Documentation

vtkContextScene* vtkAbstractContextItem::Scene
protected

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

Definition at line 178 of file vtkAbstractContextItem.h.

vtkAbstractContextItem* vtkAbstractContextItem::Parent
protected

Point to the parent item - can be null.

Definition at line 181 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 vtkstd::vector<vtkAbstractContextItem>, defined in a private header.

Definition at line 186 of file vtkAbstractContextItem.h.

bool vtkAbstractContextItem::Visible
protected

Definition at line 188 of file vtkAbstractContextItem.h.


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