vtkContextItem Class Reference
#include <vtkContextItem.h>
Detailed Description
base class for items that are part of a vtkContextScene.Derive from this class to create custom items that can be added to a vtkContextScene.
- Tests:
- vtkContextItem (Tests)
Definition at line 38 of file vtkContextItem.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)=0 |
| virtual bool | Hit (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 | MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta) |
| virtual void | SetTransform (vtkTransform2D *transform) |
| void | Translate (float dx, float dy) |
| virtual void | SetScene (vtkContextScene *scene) |
| vtkContextScene * | GetScene () |
| virtual void | ReleaseGraphicsResources () |
| virtual vtkTransform2D * | GetTransform () |
| virtual bool | GetVisible () |
| virtual void | SetVisible (bool) |
| virtual double | GetOpacity () |
| virtual void | SetOpacity (double) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkContextItem * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkContextItem () | |
| ~vtkContextItem () | |
Protected Attributes | |
| vtkTransform2D * | Transform |
| vtkWeakPointer< vtkContextScene > | Scene |
| bool | Visible |
| double | Opacity |
Member Typedef Documentation
| typedef vtkObject vtkContextItem::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkAxis, vtkBlockItem, vtkChart, vtkChartLegend, vtkChartParallelCoordinates, vtkChartXY, vtkImageItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPoints, and vtkTooltipItem.
Definition at line 41 of file vtkContextItem.h.
Constructor & Destructor Documentation
| vtkContextItem::vtkContextItem | ( | ) | [protected] |
| vtkContextItem::~vtkContextItem | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkContextItem::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkAxis, vtkBlockItem, vtkChart, vtkChartLegend, vtkChartParallelCoordinates, vtkChartXY, vtkImageItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPoints, and vtkTooltipItem.
| static int vtkContextItem::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, vtkChartLegend, vtkChartParallelCoordinates, vtkChartXY, vtkImageItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPoints, and vtkTooltipItem.
| virtual int vtkContextItem::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, vtkChartLegend, vtkChartParallelCoordinates, vtkChartXY, vtkImageItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPoints, and vtkTooltipItem.
| static vtkContextItem* vtkContextItem::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkAxis, vtkBlockItem, vtkChart, vtkChartLegend, vtkChartParallelCoordinates, vtkChartXY, vtkImageItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPoints, and vtkTooltipItem.
| virtual void vtkContextItem::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, vtkChartLegend, vtkChartParallelCoordinates, vtkChartXY, vtkImageItem, vtkPlot, vtkPlotBar, vtkPlotGrid, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPoints, and vtkTooltipItem.
| virtual void vtkContextItem::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, vtkChartParallelCoordinates, vtkChartXY, vtkPlotParallelCoordinates, vtkPlotPoints, and vtkTooltipItem.
| virtual bool vtkContextItem::Paint | ( | vtkContext2D * | painter | ) | [pure virtual] |
Paint event for the item, called whenever the item needs to be drawn,
Implemented in vtkAxis, vtkBlockItem, vtkChart, vtkChartLegend, vtkChartParallelCoordinates, vtkChartXY, vtkImageItem, vtkPlotBar, vtkPlotGrid, vtkPlotLine, vtkPlotParallelCoordinates, vtkPlotPoints, and vtkTooltipItem.
| virtual bool vtkContextItem::Hit | ( | const vtkContextMouseEvent & | mouse | ) | [virtual] |
Return true if the supplied x, y coordinate is inside the item.
Reimplemented in vtkBlockItem, vtkChartParallelCoordinates, vtkChartXY, and vtkImageItem.
| virtual bool vtkContextItem::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, vtkChartXY, and vtkImageItem.
| virtual bool vtkContextItem::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, vtkChartParallelCoordinates, vtkChartXY, and vtkImageItem.
| virtual bool vtkContextItem::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, vtkChartXY, and vtkImageItem.
| virtual bool vtkContextItem::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, vtkChartParallelCoordinates, vtkChartXY, and vtkImageItem.
| virtual bool vtkContextItem::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, vtkChartParallelCoordinates, vtkChartXY, and vtkImageItem.
| virtual bool vtkContextItem::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, and vtkChartXY.
| virtual void vtkContextItem::SetTransform | ( | vtkTransform2D * | transform | ) | [virtual] |
Set the transform for the item.
| virtual vtkTransform2D* vtkContextItem::GetTransform | ( | ) | [virtual] |
Set the transform for the item.
| virtual bool vtkContextItem::GetVisible | ( | ) | [virtual] |
Get the visibility of the item (should it be drawn).
| virtual void vtkContextItem::SetVisible | ( | bool | ) | [virtual] |
Set the visibility of the item (should it be drawn).
| virtual double vtkContextItem::GetOpacity | ( | ) | [virtual] |
Get the opacity of the item.
| virtual void vtkContextItem::SetOpacity | ( | double | ) | [virtual] |
Set the opacity of the item.
| void vtkContextItem::Translate | ( | float | dx, | |
| float | dy | |||
| ) |
Translate the item by the given dx, dy.
| virtual void vtkContextItem::SetScene | ( | vtkContextScene * | scene | ) | [virtual] |
Set the vtkContextScene for the item, always set for an item in a scene.
Reimplemented in vtkChartXY.
| vtkContextScene* vtkContextItem::GetScene | ( | ) |
Get the vtkContextScene for the item, always set for an item in a scene.
| virtual void vtkContextItem::ReleaseGraphicsResources | ( | ) | [virtual] |
Release graphics resources hold by the item. The default implementation is empty.
Member Data Documentation
vtkTransform2D* vtkContextItem::Transform [protected] |
Definition at line 130 of file vtkContextItem.h.
vtkWeakPointer<vtkContextScene> vtkContextItem::Scene [protected] |
Definition at line 131 of file vtkContextItem.h.
bool vtkContextItem::Visible [protected] |
Definition at line 133 of file vtkContextItem.h.
double vtkContextItem::Opacity [protected] |
Definition at line 135 of file vtkContextItem.h.
The documentation for this class was generated from the following file:
- dox/Charts/vtkContextItem.h
