vtkAbstractContextItem Class Reference
#include <vtkAbstractContextItem.h>
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
Reimplemented from vtkObject.
Reimplemented in vtkAxis, vtkBlockItem, vtkChart, vtkChartHistogram2D, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkColorLegend, vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkContextClip, vtkContextItem, vtkContextTransform, vtkControlPointsItem, vtkImageItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, vtkScalarsToColorsItem, and vtkTooltipItem.
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] |
Reimplemented from vtkObject.
Reimplemented in vtkAxis, vtkBlockItem, vtkChart, vtkChartHistogram2D, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkColorLegend, vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkContextClip, vtkContextItem, vtkContextTransform, vtkControlPointsItem, vtkImageItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, vtkScalarsToColorsItem, and vtkTooltipItem.
| static int vtkAbstractContextItem::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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, vtkBlockItem, vtkChart, vtkChartHistogram2D, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkColorLegend, vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkContextClip, vtkContextItem, vtkContextTransform, vtkControlPointsItem, vtkImageItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, vtkScalarsToColorsItem, and vtkTooltipItem.
| 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, vtkBlockItem, vtkChart, vtkChartHistogram2D, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkColorLegend, vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkContextClip, vtkContextItem, vtkContextTransform, vtkControlPointsItem, vtkImageItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, vtkScalarsToColorsItem, and vtkTooltipItem.
| static vtkAbstractContextItem* vtkAbstractContextItem::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkAxis, vtkBlockItem, vtkChart, vtkChartHistogram2D, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkColorLegend, vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkContextClip, vtkContextItem, vtkContextTransform, vtkControlPointsItem, vtkImageItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, vtkScalarsToColorsItem, and vtkTooltipItem.
| 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, vtkBlockItem, vtkChart, vtkChartHistogram2D, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkColorLegend, vtkColorTransferControlPointsItem, vtkColorTransferFunctionItem, vtkCompositeControlPointsItem, vtkCompositeTransferFunctionItem, vtkContextClip, vtkContextItem, vtkContextTransform, vtkControlPointsItem, vtkImageItem, vtkLookupTableItem, vtkPiecewiseControlPointsItem, vtkPiecewiseFunctionItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, vtkScalarsToColorsItem, and vtkTooltipItem.
| 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] |
Paint event for the item, called whenever the item needs to be drawn.
Reimplemented in vtkAxis, vtkBlockItem, vtkChart, vtkChartLegend, vtkChartParallelCoordinates, vtkChartPie, vtkChartXY, vtkColorLegend, vtkContextClip, vtkContextTransform, vtkControlPointsItem, vtkImageItem, vtkPlotBar, vtkPlotGrid, vtkPlotHistogram2D, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotPoints, vtkPlotStacked, vtkScalarsToColorsItem, and vtkTooltipItem.
| 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
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:
- dox/Charts/vtkAbstractContextItem.h
