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.vtkLegendScaleActor Class Reference

vtkLegendScaleActor - annotate the render window with scale and distance information More...

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

List of all members.

Public Types

enum  AttributeLocation { DISTANCE = 0, XY_COORDINATES = 1 }
 Standard methods for the class. More...

Public Member Functions

 vtkLegendScaleActor (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkLegendScaleActor ()
 Instantiate the class.
void AllAnnotationsOff ()
 Convenience method that turns all the axes and the legend scale.
void AllAnnotationsOn ()
 Convenience method that turns all the axes and the legend scale.
void AllAxesOff ()
 Convenience method that turns all the axes either on or off.
void AllAxesOn ()
 Convenience method that turns all the axes either on or off.
virtual void BottomAxisVisibilityOff ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void BottomAxisVisibilityOn ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void BuildRepresentation (vtkViewport viewport)
 Decsription: Standard methods supporting the rendering process.
override void GetActors2D (vtkPropCollection arg0)
 Decsription: Standard methods supporting the rendering process.
virtual vtkAxisActor2D GetBottomAxis ()
 These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.
virtual int GetBottomAxisVisibility ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual int GetBottomBorderOffset ()
 Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.
virtual int GetBottomBorderOffsetMaxValue ()
 Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.
virtual int GetBottomBorderOffsetMinValue ()
 Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.
virtual double GetCornerOffsetFactor ()
 Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.
virtual double GetCornerOffsetFactorMaxValue ()
 Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.
virtual double GetCornerOffsetFactorMinValue ()
 Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.
virtual int GetLabelMode ()
 Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
virtual int GetLabelModeMaxValue ()
 Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
virtual int GetLabelModeMinValue ()
 Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
virtual vtkAxisActor2D GetLeftAxis ()
 These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.
virtual int GetLeftAxisVisibility ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual int GetLeftBorderOffset ()
 Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.
virtual int GetLeftBorderOffsetMaxValue ()
 Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.
virtual int GetLeftBorderOffsetMinValue ()
 Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.
virtual vtkTextProperty GetLegendLabelProperty ()
 Set/Get the labels text properties for the legend title and labels.
virtual vtkTextProperty GetLegendTitleProperty ()
 Set/Get the labels text properties for the legend title and labels.
virtual int GetLegendVisibility ()
 Indicate whether the legend scale should be displayed or not. The default is On.
virtual vtkAxisActor2D GetRightAxis ()
 These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.
virtual int GetRightAxisVisibility ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual int GetRightBorderOffset ()
 Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.
virtual int GetRightBorderOffsetMaxValue ()
 Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.
virtual int GetRightBorderOffsetMinValue ()
 Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.
virtual vtkAxisActor2D GetTopAxis ()
 These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.
virtual int GetTopAxisVisibility ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual int GetTopBorderOffset ()
 Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.
virtual int GetTopBorderOffsetMaxValue ()
 Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.
virtual int GetTopBorderOffsetMinValue ()
 Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.
override int IsA (string type)
 Standard methods for the class.
virtual void LeftAxisVisibilityOff ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void LeftAxisVisibilityOn ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void LegendVisibilityOff ()
 Indicate whether the legend scale should be displayed or not. The default is On.
virtual void LegendVisibilityOn ()
 Indicate whether the legend scale should be displayed or not. The default is On.
new vtkLegendScaleActor NewInstance ()
 Standard methods for the class.
override void ReleaseGraphicsResources (vtkWindow arg0)
 Decsription: Standard methods supporting the rendering process.
override int RenderOpaqueGeometry (vtkViewport arg0)
 Decsription: Standard methods supporting the rendering process.
override int RenderOverlay (vtkViewport arg0)
 Decsription: Standard methods supporting the rendering process.
virtual void RightAxisVisibilityOff ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void RightAxisVisibilityOn ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void SetBottomAxisVisibility (int _arg)
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void SetBottomBorderOffset (int _arg)
 Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.
virtual void SetCornerOffsetFactor (double _arg)
 Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.
virtual void SetLabelMode (int _arg)
 Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
void SetLabelModeToDistance ()
 Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
void SetLabelModeToXYCoordinates ()
 Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.
virtual void SetLeftAxisVisibility (int _arg)
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void SetLeftBorderOffset (int _arg)
 Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.
virtual void SetLegendVisibility (int _arg)
 Indicate whether the legend scale should be displayed or not. The default is On.
virtual void SetRightAxisVisibility (int _arg)
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void SetRightBorderOffset (int _arg)
 Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.
virtual void SetTopAxisVisibility (int _arg)
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void SetTopBorderOffset (int _arg)
 Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.
virtual void TopAxisVisibilityOff ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.
virtual void TopAxisVisibilityOn ()
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Static Public Member Functions

static new vtkLegendScaleActor New ()
 Instantiate the class.
static new int IsTypeOf (string type)
 Standard methods for the class.
static new vtkLegendScaleActor SafeDownCast (vtkObjectBase o)
 Standard methods for the class.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkLegendScaleActor"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "19vtkLegendScaleActor"
 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 vtkLegendScaleActor_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLegendScaleActor_AllAnnotationsOff_01 (HandleRef pThis)
static internal void vtkLegendScaleActor_AllAnnotationsOn_02 (HandleRef pThis)
static internal void vtkLegendScaleActor_AllAxesOff_03 (HandleRef pThis)
static internal void vtkLegendScaleActor_AllAxesOn_04 (HandleRef pThis)
static internal void vtkLegendScaleActor_BottomAxisVisibilityOff_05 (HandleRef pThis)
static internal void vtkLegendScaleActor_BottomAxisVisibilityOn_06 (HandleRef pThis)
static internal void vtkLegendScaleActor_BuildRepresentation_07 (HandleRef pThis, HandleRef viewport)
static internal void vtkLegendScaleActor_GetActors2D_08 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkLegendScaleActor_GetBottomAxis_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkLegendScaleActor_GetBottomAxisVisibility_10 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetBottomBorderOffset_11 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetBottomBorderOffsetMaxValue_12 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetBottomBorderOffsetMinValue_13 (HandleRef pThis)
static internal double vtkLegendScaleActor_GetCornerOffsetFactor_14 (HandleRef pThis)
static internal double vtkLegendScaleActor_GetCornerOffsetFactorMaxValue_15 (HandleRef pThis)
static internal double vtkLegendScaleActor_GetCornerOffsetFactorMinValue_16 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetLabelMode_17 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetLabelModeMaxValue_18 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetLabelModeMinValue_19 (HandleRef pThis)
static internal IntPtr vtkLegendScaleActor_GetLeftAxis_20 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkLegendScaleActor_GetLeftAxisVisibility_21 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetLeftBorderOffset_22 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetLeftBorderOffsetMaxValue_23 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetLeftBorderOffsetMinValue_24 (HandleRef pThis)
static internal IntPtr vtkLegendScaleActor_GetLegendLabelProperty_25 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkLegendScaleActor_GetLegendTitleProperty_26 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkLegendScaleActor_GetLegendVisibility_27 (HandleRef pThis)
static internal IntPtr vtkLegendScaleActor_GetRightAxis_28 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkLegendScaleActor_GetRightAxisVisibility_29 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetRightBorderOffset_30 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetRightBorderOffsetMaxValue_31 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetRightBorderOffsetMinValue_32 (HandleRef pThis)
static internal IntPtr vtkLegendScaleActor_GetTopAxis_33 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkLegendScaleActor_GetTopAxisVisibility_34 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetTopBorderOffset_35 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetTopBorderOffsetMaxValue_36 (HandleRef pThis)
static internal int vtkLegendScaleActor_GetTopBorderOffsetMinValue_37 (HandleRef pThis)
static internal int vtkLegendScaleActor_IsA_38 (HandleRef pThis, string type)
static internal int vtkLegendScaleActor_IsTypeOf_39 (string type)
static internal void vtkLegendScaleActor_LeftAxisVisibilityOff_40 (HandleRef pThis)
static internal void vtkLegendScaleActor_LeftAxisVisibilityOn_41 (HandleRef pThis)
static internal void vtkLegendScaleActor_LegendVisibilityOff_42 (HandleRef pThis)
static internal void vtkLegendScaleActor_LegendVisibilityOn_43 (HandleRef pThis)
static internal IntPtr vtkLegendScaleActor_NewInstance_45 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLegendScaleActor_ReleaseGraphicsResources_46 (HandleRef pThis, HandleRef arg0)
static internal int vtkLegendScaleActor_RenderOpaqueGeometry_47 (HandleRef pThis, HandleRef arg0)
static internal int vtkLegendScaleActor_RenderOverlay_48 (HandleRef pThis, HandleRef arg0)
static internal void vtkLegendScaleActor_RightAxisVisibilityOff_49 (HandleRef pThis)
static internal void vtkLegendScaleActor_RightAxisVisibilityOn_50 (HandleRef pThis)
static internal IntPtr vtkLegendScaleActor_SafeDownCast_51 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLegendScaleActor_SetBottomAxisVisibility_52 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetBottomBorderOffset_53 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetCornerOffsetFactor_54 (HandleRef pThis, double _arg)
static internal void vtkLegendScaleActor_SetLabelMode_55 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetLabelModeToDistance_56 (HandleRef pThis)
static internal void vtkLegendScaleActor_SetLabelModeToXYCoordinates_57 (HandleRef pThis)
static internal void vtkLegendScaleActor_SetLeftAxisVisibility_58 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetLeftBorderOffset_59 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetLegendVisibility_60 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetRightAxisVisibility_61 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetRightBorderOffset_62 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetTopAxisVisibility_63 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_SetTopBorderOffset_64 (HandleRef pThis, int _arg)
static internal void vtkLegendScaleActor_TopAxisVisibilityOff_65 (HandleRef pThis)
static internal void vtkLegendScaleActor_TopAxisVisibilityOn_66 (HandleRef pThis)

Static Private Member Functions

static vtkLegendScaleActor ()
 Automatically generated type registration mechanics.

Detailed Description

vtkLegendScaleActor - annotate the render window with scale and distance information

Description This class is used to annotate the render window. Its basic goal is to provide an indication of the scale of the scene. Four axes surrounding the render window indicate (in a variety of ways) the scale of what the camera is viewing. An option also exists for displaying a scale legend.

The axes can be programmed either to display distance scales or x-y coordinate values. By default, the scales display a distance. However, if you know that the view is down the z-axis, the scales can be programmed to display x-y coordinate values.

Caveats Please be aware that the axes and scale values are subject to perspective effects. The distances are computed in the focal plane of the camera. When there are large view angles (i.e., perspective projection), the computed distances may provide users the wrong sense of scale. These effects are not present when parallel projection is enabled.


Member Enumeration Documentation

Standard methods for the class.

Enumerator:
DISTANCE 

enum member

XY_COORDINATES 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Instantiate the class.


Member Function Documentation

Convenience method that turns all the axes and the legend scale.

Convenience method that turns all the axes and the legend scale.

Convenience method that turns all the axes either on or off.

Convenience method that turns all the axes either on or off.

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Decsription: Standard methods supporting the rendering process.

override void Kitware.VTK.vtkLegendScaleActor.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.vtkProp.

Decsription: Standard methods supporting the rendering process.

Reimplemented from Kitware.VTK.vtkProp.

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.

Here is the call graph for this function:

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.

Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.

Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.

Here is the call graph for this function:

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

Set/Get the labels text properties for the legend title and labels.

Here is the call graph for this function:

Set/Get the labels text properties for the legend title and labels.

Here is the call graph for this function:

Indicate whether the legend scale should be displayed or not. The default is On.

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.

Here is the call graph for this function:

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.

Here is the call graph for this function:

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

override int Kitware.VTK.vtkLegendScaleActor.IsA ( string  type) [virtual]

Standard methods for the class.

Reimplemented from Kitware.VTK.vtkProp.

static new int Kitware.VTK.vtkLegendScaleActor.IsTypeOf ( string  type) [static]

Standard methods for the class.

Reimplemented from Kitware.VTK.vtkProp.

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Indicate whether the legend scale should be displayed or not. The default is On.

Indicate whether the legend scale should be displayed or not. The default is On.

Instantiate the class.

Reimplemented from Kitware.VTK.vtkObject.

Standard methods for the class.

Reimplemented from Kitware.VTK.vtkProp.

Decsription: Standard methods supporting the rendering process.

Reimplemented from Kitware.VTK.vtkProp.

Decsription: Standard methods supporting the rendering process.

Reimplemented from Kitware.VTK.vtkProp.

Decsription: Standard methods supporting the rendering process.

Reimplemented from Kitware.VTK.vtkProp.

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Standard methods for the class.

Reimplemented from Kitware.VTK.vtkProp.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkLegendScaleActor.SetBottomAxisVisibility ( int  _arg) [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void Kitware.VTK.vtkLegendScaleActor.SetBottomBorderOffset ( int  _arg) [virtual]

Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

virtual void Kitware.VTK.vtkLegendScaleActor.SetCornerOffsetFactor ( double  _arg) [virtual]

Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.

virtual void Kitware.VTK.vtkLegendScaleActor.SetLabelMode ( int  _arg) [virtual]

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

virtual void Kitware.VTK.vtkLegendScaleActor.SetLeftAxisVisibility ( int  _arg) [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void Kitware.VTK.vtkLegendScaleActor.SetLeftBorderOffset ( int  _arg) [virtual]

Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

virtual void Kitware.VTK.vtkLegendScaleActor.SetLegendVisibility ( int  _arg) [virtual]

Indicate whether the legend scale should be displayed or not. The default is On.

virtual void Kitware.VTK.vtkLegendScaleActor.SetRightAxisVisibility ( int  _arg) [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void Kitware.VTK.vtkLegendScaleActor.SetRightBorderOffset ( int  _arg) [virtual]

Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

virtual void Kitware.VTK.vtkLegendScaleActor.SetTopAxisVisibility ( int  _arg) [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void Kitware.VTK.vtkLegendScaleActor.SetTopBorderOffset ( int  _arg) [virtual]

Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_AllAnnotationsOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_AllAnnotationsOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_AllAxesOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_AllAxesOn_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_BottomAxisVisibilityOff_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_BottomAxisVisibilityOn_06 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_BuildRepresentation_07 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetActors2D_08 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetBottomAxis_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetBottomAxisVisibility_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetBottomBorderOffset_11 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetCornerOffsetFactor_14 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetCornerOffsetFactorMaxValue_15 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetCornerOffsetFactorMinValue_16 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLabelMode_17 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLabelModeMaxValue_18 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLabelModeMinValue_19 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLeftAxis_20 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLeftAxisVisibility_21 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLeftBorderOffset_22 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLegendLabelProperty_25 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLegendTitleProperty_26 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetLegendVisibility_27 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetRightAxis_28 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetRightAxisVisibility_29 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetRightBorderOffset_30 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetTopAxis_33 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetTopAxisVisibility_34 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_GetTopBorderOffset_35 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_IsA_38 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_IsTypeOf_39 ( string  type) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_LeftAxisVisibilityOff_40 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_LeftAxisVisibilityOn_41 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_LegendVisibilityOff_42 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_LegendVisibilityOn_43 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_NewInstance_45 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_ReleaseGraphicsResources_46 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_RenderOpaqueGeometry_47 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_RenderOverlay_48 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_RightAxisVisibilityOff_49 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_RightAxisVisibilityOn_50 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SafeDownCast_51 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetBottomAxisVisibility_52 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetBottomBorderOffset_53 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetCornerOffsetFactor_54 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetLabelMode_55 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetLabelModeToDistance_56 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetLeftAxisVisibility_58 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetLeftBorderOffset_59 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetLegendVisibility_60 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetRightAxisVisibility_61 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetRightBorderOffset_62 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetTopAxisVisibility_63 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_SetTopBorderOffset_64 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_TopAxisVisibilityOff_65 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor_TopAxisVisibilityOn_66 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkLegendScaleActor.MRClassNameKey = "19vtkLegendScaleActor" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkProp.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkProp.


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