VTK
|
draw the chart legend More...
#include <vtkChartLegend.h>
Public Types | |
enum | { LEFT = 0, CENTER, RIGHT, TOP, BOTTOM, CUSTOM } |
typedef vtkContextItem | Superclass |
Public Types inherited from vtkContextItem | |
typedef vtkAbstractContextItem | Superclass |
Public Types inherited from vtkAbstractContextItem | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual int | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkChartLegend * | NewInstance () const |
virtual void | PrintSelf (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
void | SetPoint (const vtkVector2f &point) |
Set point the legend box is anchored to. More... | |
const vtkVector2f & | GetPointVector () |
Get point the legend box is anchored to. More... | |
virtual void | SetLabelSize (int size) |
Set the point size of the label text. More... | |
virtual int | GetLabelSize () |
Get the point size of the label text. More... | |
void | SetChart (vtkChart *chart) |
Set the chart that the legend belongs to and will draw the legend for. More... | |
vtkChart * | GetChart () |
Get the chart that the legend belongs to and will draw the legend for. More... | |
virtual void | Update () |
Update the geometry of the axis. More... | |
virtual bool | Paint (vtkContext2D *painter) |
Paint event for the axis, called whenever the axis needs to be drawn. More... | |
virtual vtkRectf | GetBoundingRect (vtkContext2D *painter) |
Request the space the legend requires to be drawn. More... | |
vtkPen * | GetPen () |
Get the pen used to draw the legend outline. More... | |
vtkBrush * | GetBrush () |
Get the brush used to draw the legend background. More... | |
vtkTextProperty * | GetLabelProperties () |
Get the vtkTextProperty for the legend's labels. More... | |
virtual bool | Hit (const vtkContextMouseEvent &mouse) |
Return true if the supplied x, y coordinate is inside the item. More... | |
virtual bool | MouseMoveEvent (const vtkContextMouseEvent &mouse) |
Mouse move event. More... | |
virtual bool | MouseButtonPressEvent (const vtkContextMouseEvent &mouse) |
Mouse button down event. More... | |
virtual bool | MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) |
Mouse button release event. More... | |
virtual void | SetPoint (float, float) |
Set point the legend box is anchored to. More... | |
void | SetPoint (float[2]) |
Set point the legend box is anchored to. More... | |
virtual float * | GetPoint () |
Get point the legend box is anchored to. More... | |
virtual void | GetPoint (float &, float &) |
Get point the legend box is anchored to. More... | |
virtual void | GetPoint (float[2]) |
Get point the legend box is anchored to. More... | |
virtual void | SetHorizontalAlignment (int) |
Set the horizontal alignment of the legend to the point specified. More... | |
virtual int | GetHorizontalAlignment () |
Get the horizontal alignment of the legend to the point specified. More... | |
virtual void | SetVerticalAlignment (int) |
Set the vertical alignment of the legend to the point specified. More... | |
virtual int | GetVerticalAlignment () |
Get the vertical alignment of the legend to the point specified. More... | |
virtual void | SetPadding (int) |
Set the padding between legend marks, default is 5. More... | |
virtual int | GetPadding () |
Get the padding between legend marks. More... | |
virtual void | SetSymbolWidth (int) |
Set the symbol width, default is 15. More... | |
virtual int | GetSymbolWidth () |
Get the legend symbol width. More... | |
virtual void | SetInline (bool) |
Get/set if the legend should be drawn inline (inside the chart), or not. More... | |
virtual bool | GetInline () |
Get/set if the legend should be drawn inline (inside the chart), or not. More... | |
virtual void | SetDragEnabled (bool) |
Get/set if the legend can be dragged with the mouse button, or not. More... | |
virtual bool | GetDragEnabled () |
Get/set if the legend can be dragged with the mouse button, or not. More... | |
virtual void | SetCacheBounds (bool) |
Toggle whether or not this legend should attempt to cache its position and size. More... | |
virtual bool | GetCacheBounds () |
Toggle whether or not this legend should attempt to cache its position and size. More... | |
virtual void | CacheBoundsOn () |
Toggle whether or not this legend should attempt to cache its position and size. More... | |
virtual void | CacheBoundsOff () |
Toggle whether or not this legend should attempt to cache its position and size. More... | |
Public Member Functions inherited from vtkContextItem | |
vtkContextItem * | NewInstance () const |
virtual double | GetOpacity () |
Get the opacity of the item. More... | |
virtual void | SetOpacity (double) |
Set the opacity of the item. More... | |
Public Member Functions inherited from vtkAbstractContextItem | |
vtkAbstractContextItem * | NewInstance () const |
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... | |
unsigned int | AddItem (vtkAbstractContextItem *item) |
Add child items to this item. More... | |
bool | RemoveItem (vtkAbstractContextItem *item) |
Remove child item from this item. More... | |
bool | RemoveItem (unsigned int index) |
Remove child item from this item. More... | |
vtkAbstractContextItem * | GetItem (unsigned int index) |
Get the item at the specified index. More... | |
unsigned int | GetItemIndex (vtkAbstractContextItem *item) |
Get the index of the specified item. More... | |
unsigned int | GetNumberOfItems () |
Get the number of child items. More... | |
void | ClearItems () |
Remove all child items from this item. More... | |
unsigned int | Raise (unsigned int index) |
Raises the child to the top of the item's stack. More... | |
virtual unsigned int | StackAbove (unsigned int index, unsigned int under) |
Raises the child above the under sibling. More... | |
unsigned int | Lower (unsigned int index) |
Lowers the child to the bottom of the item's stack. More... | |
virtual unsigned int | StackUnder (unsigned int child, unsigned int above) |
Lowers the child under the above sibling. More... | |
virtual vtkAbstractContextItem * | GetPickedItem (const vtkContextMouseEvent &mouse) |
Return the item under the mouse. More... | |
virtual bool | MouseEnterEvent (const vtkContextMouseEvent &mouse) |
Mouse enter event. More... | |
virtual bool | MouseLeaveEvent (const vtkContextMouseEvent &mouse) |
Mouse leave 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... | |
vtkContextScene * | GetScene () |
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... | |
vtkAbstractContextItem * | GetParent () |
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... | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
int | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
int | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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) |
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, 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) |
This method invokes an event and return whether the event was aborted or not. More... | |
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 | 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... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkChartLegend * | SafeDownCast (vtkObjectBase *o) |
static vtkChartLegend * | New () |
Creates a 2D Chart object. More... | |
Static Public Member Functions inherited from vtkContextItem | |
static int | IsTypeOf (const char *type) |
static vtkContextItem * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkAbstractContextItem | |
static int | IsTypeOf (const char *type) |
static vtkAbstractContextItem * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
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 () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkChartLegend () | |
~vtkChartLegend () | |
Protected Member Functions inherited from vtkContextItem | |
vtkContextItem () | |
~vtkContextItem () | |
Protected Member Functions inherited from vtkAbstractContextItem | |
vtkAbstractContextItem () | |
~vtkAbstractContextItem () | |
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=NULL) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. More... | |
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 | |
float * | Point |
int | HorizontalAlignment |
int | VerticalAlignment |
vtkNew< vtkPen > | Pen |
The pen used to draw the legend box. More... | |
vtkNew< vtkBrush > | Brush |
The brush used to render the background of the legend. More... | |
vtkNew< vtkTextProperty > | LabelProperties |
The text properties of the labels used in the legend. More... | |
bool | DragEnabled |
Should we move the legend box around in response to the mouse drag? More... | |
bool | CacheBounds |
Should the legend attempt to avoid recalculating its position & bounds unnecessarily? More... | |
int | Button |
Last button to be pressed. More... | |
vtkTimeStamp | PlotTime |
vtkTimeStamp | RectTime |
vtkRectf | Rect |
int | Padding |
Padding between symbol and text. More... | |
int | SymbolWidth |
Width of the symbols in pixels in the legend. More... | |
bool | Inline |
Should the legend be drawn inline in its chart? More... | |
Private * | Storage |
Protected Attributes inherited from vtkContextItem | |
double | Opacity |
Protected Attributes inherited from vtkAbstractContextItem | |
vtkContextScene * | Scene |
Point to the scene the item is on - can be null. More... | |
vtkAbstractContextItem * | Parent |
Point to the parent item - can be null. More... | |
vtkContextScenePrivate * | Children |
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 | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
draw the chart legend
The vtkChartLegend is drawn in screen coordinates. It is usually one of the last elements of a chart to be drawn. It renders the the mark/line for each plot, and the plot labels.
Definition at line 42 of file vtkChartLegend.h.
Definition at line 45 of file vtkChartLegend.h.
anonymous enum |
Enumerator | |
---|---|
LEFT | |
CENTER | |
RIGHT | |
TOP | |
BOTTOM | |
CUSTOM |
Definition at line 67 of file vtkChartLegend.h.
|
protected |
|
protected |
|
static |
|
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 vtkContextItem.
Reimplemented in vtkCategoryLegend, and vtkColorLegend.
|
static |
|
protectedvirtual |
Reimplemented from vtkContextItem.
Reimplemented in vtkCategoryLegend, and vtkColorLegend.
vtkChartLegend* vtkChartLegend::NewInstance | ( | ) | const |
|
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 vtkContextItem.
Reimplemented in vtkColorLegend.
|
static |
Creates a 2D Chart object.
Set point the legend box is anchored to.
Reimplemented in vtkColorLegend.
void vtkChartLegend::SetPoint | ( | float | [2] | ) |
Set point the legend box is anchored to.
|
virtual |
Get point the legend box is anchored to.
Get point the legend box is anchored to.
|
virtual |
Get point the legend box is anchored to.
void vtkChartLegend::SetPoint | ( | const vtkVector2f & | point | ) |
Set point the legend box is anchored to.
const vtkVector2f& vtkChartLegend::GetPointVector | ( | ) |
Get point the legend box is anchored to.
|
virtual |
Set the horizontal alignment of the legend to the point specified.
Valid values are LEFT, CENTER and RIGHT.
|
virtual |
Get the horizontal alignment of the legend to the point specified.
|
virtual |
Set the vertical alignment of the legend to the point specified.
Valid values are TOP, CENTER and BOTTOM.
|
virtual |
Get the vertical alignment of the legend to the point specified.
|
virtual |
Set the padding between legend marks, default is 5.
|
virtual |
Get the padding between legend marks.
|
virtual |
Set the symbol width, default is 15.
|
virtual |
Get the legend symbol width.
|
virtual |
Set the point size of the label text.
|
virtual |
Get the point size of the label text.
|
virtual |
Get/set if the legend should be drawn inline (inside the chart), or not.
True would generally request that the chart draws it inside the chart, false would adjust the chart axes and make space to draw the axes outside.
|
virtual |
Get/set if the legend should be drawn inline (inside the chart), or not.
True would generally request that the chart draws it inside the chart, false would adjust the chart axes and make space to draw the axes outside.
|
virtual |
Get/set if the legend can be dragged with the mouse button, or not.
True results in left click and drag causing the legend to move around the scene. False disables response to mouse events. The default is true.
|
virtual |
Get/set if the legend can be dragged with the mouse button, or not.
True results in left click and drag causing the legend to move around the scene. False disables response to mouse events. The default is true.
void vtkChartLegend::SetChart | ( | vtkChart * | chart | ) |
Set the chart that the legend belongs to and will draw the legend for.
vtkChart* vtkChartLegend::GetChart | ( | ) |
Get the chart that the legend belongs to and will draw the legend for.
|
virtual |
Update the geometry of the axis.
Takes care of setting up the tick mark locations etc. Should be called by the scene before rendering.
Reimplemented from vtkAbstractContextItem.
Reimplemented in vtkColorLegend.
|
virtual |
Paint event for the axis, called whenever the axis needs to be drawn.
Reimplemented from vtkAbstractContextItem.
Reimplemented in vtkColorLegend, and vtkCategoryLegend.
|
virtual |
Request the space the legend requires to be drawn.
This is returned as a vtkRect4f, with the corner being the offset from Point, and the width/ height being the total width/height required by the axis. In order to ensure the numbers are correct, Update() should be called first.
Reimplemented in vtkColorLegend, and vtkCategoryLegend.
vtkPen* vtkChartLegend::GetPen | ( | ) |
Get the pen used to draw the legend outline.
vtkBrush* vtkChartLegend::GetBrush | ( | ) |
Get the brush used to draw the legend background.
vtkTextProperty* vtkChartLegend::GetLabelProperties | ( | ) |
Get the vtkTextProperty for the legend's labels.
|
virtual |
Toggle whether or not this legend should attempt to cache its position and size.
The default value is true. If this value is set to false, the legend will recalculate its position and bounds every time it is drawn. If users will be able to zoom in or out on your legend, you may want to set this to false. Otherwise, the border around the legend may not resize appropriately.
|
virtual |
Toggle whether or not this legend should attempt to cache its position and size.
The default value is true. If this value is set to false, the legend will recalculate its position and bounds every time it is drawn. If users will be able to zoom in or out on your legend, you may want to set this to false. Otherwise, the border around the legend may not resize appropriately.
|
virtual |
Toggle whether or not this legend should attempt to cache its position and size.
The default value is true. If this value is set to false, the legend will recalculate its position and bounds every time it is drawn. If users will be able to zoom in or out on your legend, you may want to set this to false. Otherwise, the border around the legend may not resize appropriately.
|
virtual |
Toggle whether or not this legend should attempt to cache its position and size.
The default value is true. If this value is set to false, the legend will recalculate its position and bounds every time it is drawn. If users will be able to zoom in or out on your legend, you may want to set this to false. Otherwise, the border around the legend may not resize appropriately.
|
virtual |
Return true if the supplied x, y coordinate is inside the item.
Reimplemented from vtkAbstractContextItem.
|
virtual |
|
virtual |
Mouse button down event.
Reimplemented from vtkAbstractContextItem.
|
virtual |
Mouse button release event.
Reimplemented from vtkAbstractContextItem.
|
protected |
Definition at line 257 of file vtkChartLegend.h.
|
protected |
Definition at line 258 of file vtkChartLegend.h.
|
protected |
Definition at line 259 of file vtkChartLegend.h.
The pen used to draw the legend box.
Definition at line 264 of file vtkChartLegend.h.
The brush used to render the background of the legend.
Definition at line 269 of file vtkChartLegend.h.
|
protected |
The text properties of the labels used in the legend.
Definition at line 274 of file vtkChartLegend.h.
|
protected |
Should we move the legend box around in response to the mouse drag?
Definition at line 279 of file vtkChartLegend.h.
|
protected |
Should the legend attempt to avoid recalculating its position & bounds unnecessarily?
Definition at line 285 of file vtkChartLegend.h.
|
protected |
Last button to be pressed.
Definition at line 290 of file vtkChartLegend.h.
|
protected |
Definition at line 292 of file vtkChartLegend.h.
|
protected |
Definition at line 293 of file vtkChartLegend.h.
|
protected |
Definition at line 295 of file vtkChartLegend.h.
|
protected |
Padding between symbol and text.
Definition at line 300 of file vtkChartLegend.h.
|
protected |
Width of the symbols in pixels in the legend.
Definition at line 305 of file vtkChartLegend.h.
|
protected |
Should the legend be drawn inline in its chart?
Definition at line 310 of file vtkChartLegend.h.
|
protected |
Definition at line 313 of file vtkChartLegend.h.