vtkAbstractContextItem Class Reference

#include <vtkAbstractContextItem.h>

Inheritance diagram for vtkAbstractContextItem:

Inheritance graph
[legend]
Collaboration diagram for vtkAbstractContextItem:

Collaboration graph
[legend]

List of all members.


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.


Public Types

typedef vtkObject 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)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkAbstractContextItemSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkAbstractContextItem ()
 ~vtkAbstractContextItem ()

Protected Attributes

vtkContextSceneScene
vtkAbstractContextItemParent
vtkContextScenePrivateChildren
bool Visible

Member Typedef Documentation


Constructor & Destructor Documentation

vtkAbstractContextItem::vtkAbstractContextItem (  )  [protected]

vtkAbstractContextItem::~vtkAbstractContextItem (  )  [protected]


Member Function Documentation

virtual const char* vtkAbstractContextItem::GetClassName (  )  [virtual]

static int vtkAbstractContextItem::IsTypeOf ( const char *  name  )  [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, vtkChartHistogram2D, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkColorLegend, vtkContextClip, vtkContextTransform, vtkPlotHistogram2D, vtkPlotParallelCoordinates, vtkPlotPoints, vtkPlotStacked, and vtkTooltipItem.

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:
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::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 vtkBlockItem, vtkChartHistogram2D, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, and vtkControlPointsItem.

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

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 vtkBlockItem, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, and vtkControlPointsItem.

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

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 vtkBlockItem, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, and vtkControlPointsItem.

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 vtkBlockItem, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, and vtkControlPointsItem.

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

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

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

Definition at line 178 of file vtkAbstractContextItem.h.

Point to the parent item - can be null.

Definition at line 181 of file vtkAbstractContextItem.h.

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.

Definition at line 188 of file vtkAbstractContextItem.h.


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

Generated on Wed Aug 24 11:28:06 2011 for VTK by  doxygen 1.5.6