VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCategoryLegend Class Reference

Legend item to display categorical data. More...

#include <vtkCategoryLegend.h>

Inheritance diagram for vtkCategoryLegend:
[legend]
Collaboration diagram for vtkCategoryLegend:
[legend]

Public Types

enum  { VERTICAL = 0, HORIZONTAL }
 Enum of legend orientation types. More...
 
typedef vtkChartLegend Superclass
 
- Public Types inherited from vtkChartLegend
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 vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCategoryLegendNewInstance () const
 
bool Paint (vtkContext2D *painter) override
 Paint the legend into a rectangle defined by the bounds. More...
 
vtkRectf GetBoundingRect (vtkContext2D *painter) override
 Compute and return the lower left corner of this legend, along with its width and height. More...
 
virtual void SetScalarsToColors (vtkScalarsToColors *stc)
 Get/Set the vtkScalarsToColors used to draw this legend. More...
 
virtual vtkScalarsToColorsGetScalarsToColors ()
 
virtual vtkVariantArrayGetValues ()
 Get/Set the array of values that will be represented by this legend. More...
 
virtual void SetValues (vtkVariantArray *)
 
virtual void SetTitle (const vtkStdString &title)
 Get/set the title text of the legend. More...
 
virtual vtkStdString GetTitle ()
 
virtual vtkStdString GetOutlierLabel ()
 Get/set the label to use for outlier data. More...
 
virtual void SetOutlierLabel (vtkStdString)
 
- Public Member Functions inherited from vtkChartLegend
vtkChartLegendNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetPoint (float, float)
 Set point the legend box is anchored to. More...
 
void SetPoint (float[2])
 
virtual float * GetPoint ()
 Get point the legend box is anchored to. More...
 
virtual void GetPoint (float &, float &)
 
virtual void GetPoint (float[2])
 
void SetPoint (const vtkVector2f &point)
 Set point the legend box is anchored to. More...
 
const vtkVector2fGetPointVector ()
 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 SetLabelSize (int size)
 Set the point size of the label text. More...
 
virtual int GetLabelSize ()
 Get the point size of the label text. More...
 
virtual void SetInline (bool)
 Get/set if the legend should be drawn inline (inside the chart), or not. More...
 
virtual bool GetInline ()
 
virtual void SetDragEnabled (bool)
 Get/set if the legend can be dragged with the mouse button, or not. More...
 
virtual bool GetDragEnabled ()
 
void SetChart (vtkChart *chart)
 Set the chart that the legend belongs to and will draw the legend for. More...
 
vtkChartGetChart ()
 Get the chart that the legend belongs to and will draw the legend for. More...
 
void Update () override
 Update the geometry of the axis. More...
 
bool Paint (vtkContext2D *painter) override
 Paint event for the axis, called whenever the axis needs to be drawn. More...
 
vtkPenGetPen ()
 Get the pen used to draw the legend outline. More...
 
vtkBrushGetBrush ()
 Get the brush used to draw the legend background. More...
 
vtkTextPropertyGetLabelProperties ()
 Get the vtkTextProperty for the legend's labels. More...
 
virtual void SetCacheBounds (bool)
 Toggle whether or not this legend should attempt to cache its position and size. More...
 
virtual bool GetCacheBounds ()
 
virtual void CacheBoundsOn ()
 
virtual void CacheBoundsOff ()
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Return true if the supplied x, y coordinate is inside the item. More...
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Mouse move event. More...
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
 Mouse button down event. More...
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
 Mouse button release event. More...
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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
vtkAbstractContextItemNewInstance () 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...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual vtkAbstractContextItemGetPickedItem (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...
 
vtkContextSceneGetScene ()
 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...
 
vtkAbstractContextItemGetParent ()
 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCategoryLegendSafeDownCast (vtkObjectBase *o)
 
static vtkCategoryLegendNew ()
 
- Static Public Member Functions inherited from vtkChartLegend
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkChartLegendSafeDownCast (vtkObjectBase *o)
 
static vtkChartLegendNew ()
 Creates a 2D Chart object. More...
 
- Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCategoryLegend ()
 
 ~vtkCategoryLegend () override
 
- Protected Member Functions inherited from vtkChartLegend
 vtkChartLegend ()
 
 ~vtkChartLegend () override
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
- 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- 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

bool HasOutliers
 
float TitleWidthOffset
 
vtkScalarsToColorsScalarsToColors
 
vtkStdString OutlierLabel
 
vtkStdString Title
 
vtkNew< vtkTextPropertyTitleProperties
 
vtkVariantArrayValues
 
- Protected Attributes inherited from vtkChartLegend
float * Point
 
int HorizontalAlignment
 
int VerticalAlignment
 
vtkNew< vtkPenPen
 The pen used to draw the legend box. More...
 
vtkNew< vtkBrushBrush
 The brush used to render the background of the legend. More...
 
vtkNew< vtkTextPropertyLabelProperties
 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
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Legend item to display categorical data.

vtkCategoryLegend will display a label and color patch for each value in a categorical data set. To use this class, you must first populate a vtkScalarsToColors by using the SetAnnotation() method. The other input to this class is a vtkVariantArray. This should contain the annotated values from the vtkScalarsToColors that you wish to include within the legend.

Definition at line 41 of file vtkCategoryLegend.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkCategoryLegend.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum of legend orientation types.

Enumerator
VERTICAL 
HORIZONTAL 

Definition at line 50 of file vtkCategoryLegend.h.

Constructor & Destructor Documentation

◆ vtkCategoryLegend()

vtkCategoryLegend::vtkCategoryLegend ( )
protected

◆ ~vtkCategoryLegend()

vtkCategoryLegend::~vtkCategoryLegend ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkCategoryLegend::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkCategoryLegend::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 vtkChartLegend.

◆ SafeDownCast()

static vtkCategoryLegend* vtkCategoryLegend::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCategoryLegend::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkChartLegend.

◆ NewInstance()

vtkCategoryLegend* vtkCategoryLegend::NewInstance ( ) const

◆ New()

static vtkCategoryLegend* vtkCategoryLegend::New ( )
static

◆ Paint()

bool vtkCategoryLegend::Paint ( vtkContext2D painter)
overridevirtual

Paint the legend into a rectangle defined by the bounds.

Reimplemented from vtkAbstractContextItem.

◆ GetBoundingRect()

vtkRectf vtkCategoryLegend::GetBoundingRect ( vtkContext2D painter)
overridevirtual

Compute and return the lower left corner of this legend, along with its width and height.

Reimplemented from vtkChartLegend.

◆ SetScalarsToColors()

virtual void vtkCategoryLegend::SetScalarsToColors ( vtkScalarsToColors stc)
virtual

Get/Set the vtkScalarsToColors used to draw this legend.

Since this legend represents categorical data, this vtkScalarsToColors must have been populated using SetAnnotation().

◆ GetScalarsToColors()

virtual vtkScalarsToColors* vtkCategoryLegend::GetScalarsToColors ( )
virtual

◆ GetValues()

virtual vtkVariantArray* vtkCategoryLegend::GetValues ( )
virtual

Get/Set the array of values that will be represented by this legend.

This array must contain distinct annotated values from the ScalarsToColors. Each value in this array will be drawn as a separate entry within this legend.

◆ SetValues()

virtual void vtkCategoryLegend::SetValues ( vtkVariantArray )
virtual

◆ SetTitle()

virtual void vtkCategoryLegend::SetTitle ( const vtkStdString title)
virtual

Get/set the title text of the legend.

◆ GetTitle()

virtual vtkStdString vtkCategoryLegend::GetTitle ( )
virtual

◆ GetOutlierLabel()

virtual vtkStdString vtkCategoryLegend::GetOutlierLabel ( )
virtual

Get/set the label to use for outlier data.

◆ SetOutlierLabel()

virtual void vtkCategoryLegend::SetOutlierLabel ( vtkStdString  )
virtual

Member Data Documentation

◆ HasOutliers

bool vtkCategoryLegend::HasOutliers
protected

Definition at line 108 of file vtkCategoryLegend.h.

◆ TitleWidthOffset

float vtkCategoryLegend::TitleWidthOffset
protected

Definition at line 109 of file vtkCategoryLegend.h.

◆ ScalarsToColors

vtkScalarsToColors* vtkCategoryLegend::ScalarsToColors
protected

Definition at line 110 of file vtkCategoryLegend.h.

◆ OutlierLabel

vtkStdString vtkCategoryLegend::OutlierLabel
protected

Definition at line 111 of file vtkCategoryLegend.h.

◆ Title

vtkStdString vtkCategoryLegend::Title
protected

Definition at line 112 of file vtkCategoryLegend.h.

◆ TitleProperties

vtkNew<vtkTextProperty> vtkCategoryLegend::TitleProperties
protected

Definition at line 113 of file vtkCategoryLegend.h.

◆ Values

vtkVariantArray* vtkCategoryLegend::Values
protected

Definition at line 114 of file vtkCategoryLegend.h.


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