ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkChartLegend Class Reference

vtkChartLegend - draw the chart legend More...

Inheritance diagram for Kitware.VTK.vtkChartLegend:
[legend]
Collaboration diagram for Kitware.VTK.vtkChartLegend:
[legend]

List of all members.

Public Types

enum  BOTTOM_WrapperEnum {
  BOTTOM = 4, CENTER = 1, CUSTOM = 5, LEFT = 0,
  RIGHT = 2, TOP = 3
}
 Get point the legend box is anchored to. More...

Public Member Functions

 vtkChartLegend (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkChartLegend ()
 Creates a 2D Chart object.
vtkBrush GetBrush ()
 Get the brush used to draw the legend background.
vtkChart GetChart ()
 Get the chart that the legend belongs to and will draw the legend for.
virtual bool GetDragEnabled ()
 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 int GetHorizontalAlignment ()
 Get the horizontal alignment of the legend to the point specified.
virtual bool GetInline ()
 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.
vtkTextProperty GetLabelProperties ()
 Get the vtkTextProperty for the legend's labels.
virtual int GetLabelSize ()
 Get the point size of the label text.
virtual int GetPadding ()
 Get the padding between legend marks.
vtkPen GetPen ()
 Get the pen used to draw the legend outline.
virtual float[] GetPoint ()
 Get point the legend box is anchored to.
virtual void GetPoint (ref float _arg1, ref float _arg2)
 Get point the legend box is anchored to.
virtual void GetPoint (IntPtr _arg)
 Get point the legend box is anchored to.
virtual int GetSymbolWidth ()
 Get the legend symbol width.
virtual int GetVerticalAlignment ()
 Get the vertical alignment of the legend to the point specified.
override int IsA (string type)
 *Undocumented Block
new vtkChartLegend NewInstance ()
 *Undocumented Block
override bool Paint (vtkContext2D painter)
 Paint event for the axis, called whenever the axis needs to be drawn.
void SetChart (vtkChart chart)
 Set the chart that the legend belongs to and will draw the legend for.
virtual void SetDragEnabled (bool _arg)
 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 void SetHorizontalAlignment (int _arg)
 Set the horizontal alignment of the legend to the point specified. Valid values are LEFT, CENTER and RIGHT.
virtual void SetInline (bool _arg)
 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 void SetLabelSize (int size)
 Set the point size of the label text.
virtual void SetPadding (int _arg)
 Set the padding between legend marks, default is 5.
virtual void SetPoint (float _arg1, float _arg2)
 Set point the legend box is anchored to.
void SetPoint (IntPtr _arg)
 Set point the legend box is anchored to.
virtual void SetSymbolWidth (int _arg)
 Set the symbol width, default is 15.
virtual void SetVerticalAlignment (int _arg)
 Set the vertical alignment of the legend to the point specified. Valid values are TOP, CENTER and BOTTOM.
override void Update ()
 Update the geometry of the axis. Takes care of setting up the tick mark locations etc. Should be called by the scene before rendering.
- Public Member Functions inherited from Kitware.VTK.vtkContextItem
 vtkContextItem (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual double GetOpacity ()
 Get the opacity of the item.
virtual void SetOpacity (double _arg)
 Set the opacity of the item. 1.0 by default.
- Public Member Functions inherited from Kitware.VTK.vtkAbstractContextItem
 vtkAbstractContextItem (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
uint AddItem (vtkAbstractContextItem item)
 Add child items to this item. Increments reference count of item.
void ClearItems ()
 Remove all child items from this item.
vtkAbstractContextItem GetItem (uint index)
 Get the item at the specified index.
uint GetNumberOfItems ()
 Get the number of child items.
vtkAbstractContextItem GetParent ()
 Get the parent item. The parent will be set for all items except top level items in a tree.
vtkContextScene GetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene.
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn).
bool PaintChildren (vtkContext2D painter)
 Paint the children of the item, should be called whenever the children need to be rendered.
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. The default implementation is empty.
bool RemoveItem (vtkAbstractContextItem item)
 Remove child item from this item. Decrements reference count of item.
bool RemoveItem (uint index)
 Remove child item from this item. Decrements reference count of item.
virtual void SetParent (vtkAbstractContextItem parent)
 Set the parent item. The parent will be set for all items except top level items in a scene.
virtual void SetScene (vtkContextScene scene)
 Set the vtkContextScene for the item, always set for an item in a scene.
virtual void SetVisible (bool _arg)
 Set the visibility of the item (should it be drawn). Visible by default.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkChartLegend New ()
 Creates a 2D Chart object.
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkChartLegend SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkChartLegend"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkContextItem
- Public Attributes inherited from Kitware.VTK.vtkAbstractContextItem
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkChartLegend"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkContextItem
- Static Public Attributes inherited from Kitware.VTK.vtkAbstractContextItem
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkChartLegend ()
 Automatically generated type registration mechanics.

Detailed Description

vtkChartLegend - draw the chart legend

Description 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.


Member Enumeration Documentation

Get point the legend box is anchored to.

Enumerator:
BOTTOM 

enum member

CENTER 

enum member

CUSTOM 

enum member

LEFT 

enum member

RIGHT 

enum member

TOP 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkChartLegend.vtkChartLegend ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkChartLegend.vtkChartLegend ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkChartLegend.vtkChartLegend ( )

Creates a 2D Chart object.


Member Function Documentation

override void Kitware.VTK.vtkChartLegend.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.

vtkBrush Kitware.VTK.vtkChartLegend.GetBrush ( )

Get the brush used to draw the legend background.

Here is the call graph for this function:

vtkChart Kitware.VTK.vtkChartLegend.GetChart ( )

Get the chart that the legend belongs to and will draw the legend for.

Here is the call graph for this function:

virtual bool Kitware.VTK.vtkChartLegend.GetDragEnabled ( )
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 int Kitware.VTK.vtkChartLegend.GetHorizontalAlignment ( )
virtual

Get the horizontal alignment of the legend to the point specified.

virtual bool Kitware.VTK.vtkChartLegend.GetInline ( )
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.

vtkTextProperty Kitware.VTK.vtkChartLegend.GetLabelProperties ( )

Get the vtkTextProperty for the legend's labels.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkChartLegend.GetLabelSize ( )
virtual

Get the point size of the label text.

virtual int Kitware.VTK.vtkChartLegend.GetPadding ( )
virtual

Get the padding between legend marks.

vtkPen Kitware.VTK.vtkChartLegend.GetPen ( )

Get the pen used to draw the legend outline.

Here is the call graph for this function:

virtual float [] Kitware.VTK.vtkChartLegend.GetPoint ( )
virtual

Get point the legend box is anchored to.

virtual void Kitware.VTK.vtkChartLegend.GetPoint ( ref float  _arg1,
ref float  _arg2 
)
virtual

Get point the legend box is anchored to.

virtual void Kitware.VTK.vtkChartLegend.GetPoint ( IntPtr  _arg)
virtual

Get point the legend box is anchored to.

virtual int Kitware.VTK.vtkChartLegend.GetSymbolWidth ( )
virtual

Get the legend symbol width.

virtual int Kitware.VTK.vtkChartLegend.GetVerticalAlignment ( )
virtual

Get the vertical alignment of the legend to the point specified.

override int Kitware.VTK.vtkChartLegend.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.

static new int Kitware.VTK.vtkChartLegend.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.

static new vtkChartLegend Kitware.VTK.vtkChartLegend.New ( )
static

Creates a 2D Chart object.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkColorLegend.

new vtkChartLegend Kitware.VTK.vtkChartLegend.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.

override bool Kitware.VTK.vtkChartLegend.Paint ( vtkContext2D  painter)
virtual

Paint event for the axis, called whenever the axis needs to be drawn.

Reimplemented from Kitware.VTK.vtkAbstractContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.

static new vtkChartLegend Kitware.VTK.vtkChartLegend.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.

Here is the call graph for this function:

void Kitware.VTK.vtkChartLegend.SetChart ( vtkChart  chart)

Set the chart that the legend belongs to and will draw the legend for.

virtual void Kitware.VTK.vtkChartLegend.SetDragEnabled ( bool  _arg)
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 void Kitware.VTK.vtkChartLegend.SetHorizontalAlignment ( int  _arg)
virtual

Set the horizontal alignment of the legend to the point specified. Valid values are LEFT, CENTER and RIGHT.

virtual void Kitware.VTK.vtkChartLegend.SetInline ( bool  _arg)
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 void Kitware.VTK.vtkChartLegend.SetLabelSize ( int  size)
virtual

Set the point size of the label text.

virtual void Kitware.VTK.vtkChartLegend.SetPadding ( int  _arg)
virtual

Set the padding between legend marks, default is 5.

virtual void Kitware.VTK.vtkChartLegend.SetPoint ( float  _arg1,
float  _arg2 
)
virtual

Set point the legend box is anchored to.

void Kitware.VTK.vtkChartLegend.SetPoint ( IntPtr  _arg)

Set point the legend box is anchored to.

virtual void Kitware.VTK.vtkChartLegend.SetSymbolWidth ( int  _arg)
virtual

Set the symbol width, default is 15.

virtual void Kitware.VTK.vtkChartLegend.SetVerticalAlignment ( int  _arg)
virtual

Set the vertical alignment of the legend to the point specified. Valid values are TOP, CENTER and BOTTOM.

override void Kitware.VTK.vtkChartLegend.Update ( )
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 Kitware.VTK.vtkAbstractContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.


Member Data Documentation

new readonly string Kitware.VTK.vtkChartLegend.MRClassNameKey = "14vtkChartLegend"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.

new const string Kitware.VTK.vtkChartLegend.MRFullTypeName = "Kitware.VTK.vtkChartLegend"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.


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