ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private 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.

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.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkChartLegend"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkChartLegend_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkChartLegend_GetBrush_01 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkChartLegend_GetChart_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkChartLegend_GetDragEnabled_03 (HandleRef pThis)
static internal int vtkChartLegend_GetHorizontalAlignment_04 (HandleRef pThis)
static internal byte vtkChartLegend_GetInline_05 (HandleRef pThis)
static internal IntPtr vtkChartLegend_GetLabelProperties_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkChartLegend_GetLabelSize_07 (HandleRef pThis)
static internal int vtkChartLegend_GetPadding_08 (HandleRef pThis)
static internal IntPtr vtkChartLegend_GetPen_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkChartLegend_GetPoint_10 (HandleRef pThis)
static internal void vtkChartLegend_GetPoint_11 (HandleRef pThis, ref float _arg1, ref float _arg2)
static internal void vtkChartLegend_GetPoint_12 (HandleRef pThis, IntPtr _arg)
static internal int vtkChartLegend_GetSymbolWidth_13 (HandleRef pThis)
static internal int vtkChartLegend_GetVerticalAlignment_14 (HandleRef pThis)
static internal int vtkChartLegend_IsA_15 (HandleRef pThis, string type)
static internal int vtkChartLegend_IsTypeOf_16 (string type)
static internal IntPtr vtkChartLegend_NewInstance_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkChartLegend_Paint_19 (HandleRef pThis, HandleRef painter)
static internal IntPtr vtkChartLegend_SafeDownCast_20 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkChartLegend_SetChart_21 (HandleRef pThis, HandleRef chart)
static internal void vtkChartLegend_SetDragEnabled_22 (HandleRef pThis, byte _arg)
static internal void vtkChartLegend_SetHorizontalAlignment_23 (HandleRef pThis, int _arg)
static internal void vtkChartLegend_SetInline_24 (HandleRef pThis, byte _arg)
static internal void vtkChartLegend_SetLabelSize_25 (HandleRef pThis, int size)
static internal void vtkChartLegend_SetPadding_26 (HandleRef pThis, int _arg)
static internal void vtkChartLegend_SetPoint_27 (HandleRef pThis, float _arg1, float _arg2)
static internal void vtkChartLegend_SetPoint_28 (HandleRef pThis, IntPtr _arg)
static internal void vtkChartLegend_SetSymbolWidth_29 (HandleRef pThis, int _arg)
static internal void vtkChartLegend_SetVerticalAlignment_30 (HandleRef pThis, int _arg)
static internal void vtkChartLegend_Update_31 (HandleRef pThis)

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 ( ) [static, private]

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.

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.

Get the brush used to draw the legend background.

Here is the call graph for this function:

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.

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.

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.

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.

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.

Creates a 2D Chart object.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkColorLegend.

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkContextItem.

Reimplemented in Kitware.VTK.vtkColorLegend.

Here is the call graph for this function:

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.

static internal IntPtr Kitware.VTK.vtkChartLegend.vtkChartLegend_GetBrush_01 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkChartLegend.vtkChartLegend_GetChart_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkChartLegend.vtkChartLegend_GetDragEnabled_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkChartLegend.vtkChartLegend_GetHorizontalAlignment_04 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkChartLegend.vtkChartLegend_GetInline_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkChartLegend.vtkChartLegend_GetLabelProperties_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkChartLegend.vtkChartLegend_GetLabelSize_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkChartLegend.vtkChartLegend_GetPadding_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkChartLegend.vtkChartLegend_GetPen_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkChartLegend.vtkChartLegend_GetPoint_10 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_GetPoint_11 ( HandleRef  pThis,
ref float  _arg1,
ref float  _arg2 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_GetPoint_12 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkChartLegend.vtkChartLegend_GetSymbolWidth_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkChartLegend.vtkChartLegend_GetVerticalAlignment_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkChartLegend.vtkChartLegend_IsA_15 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkChartLegend.vtkChartLegend_IsTypeOf_16 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkChartLegend.vtkChartLegend_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkChartLegend.vtkChartLegend_NewInstance_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkChartLegend.vtkChartLegend_Paint_19 ( HandleRef  pThis,
HandleRef  painter 
) [private]
static internal IntPtr Kitware.VTK.vtkChartLegend.vtkChartLegend_SafeDownCast_20 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetChart_21 ( HandleRef  pThis,
HandleRef  chart 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetDragEnabled_22 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetHorizontalAlignment_23 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetInline_24 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetLabelSize_25 ( HandleRef  pThis,
int  size 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetPadding_26 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetPoint_27 ( HandleRef  pThis,
float  _arg1,
float  _arg2 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetPoint_28 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetSymbolWidth_29 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_SetVerticalAlignment_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkChartLegend.vtkChartLegend_Update_31 ( HandleRef  pThis) [private]

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: