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

Inheritance diagram for Kitware.VTK.vtkLegendScaleActor:

Collaboration diagram for Kitware.VTK.vtkLegendScaleActor:

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.
Public Member Functions inherited from Kitware.VTK.vtkProp
	vtkProp (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
void	AddConsumer (vtkObject c)
	Tells if the prop has all the required keys.
virtual void	AddEstimatedRenderTime (double t, vtkViewport arg1)
	Tells if the prop has all the required keys.
virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	Tells if the prop has all the required keys.
virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable. This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.
virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable. This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.
virtual void	GetActors (vtkPropCollection arg0)
	For some exporters and other other operations we must be able to collect all the actors or volumes. These methods are used in that process.
virtual double	GetAllocatedRenderTime ()
	Tells if the prop has all the required keys.
virtual double[]	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). in world coordinates. NULL means that the bounds are not defined.
vtkObject	GetConsumer (int i)
	Tells if the prop has all the required keys.
virtual int	GetDragable ()
	Set/Get the value of the dragable instance variable. This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.
virtual double	GetEstimatedRenderTime (vtkViewport arg0)
	Tells if the prop has all the required keys.
virtual double	GetEstimatedRenderTime ()
	Tells if the prop has all the required keys.
virtual vtkMatrix4x4	GetMatrix ()
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. Generally used only for picking. See vtkProp3D for more information.
virtual vtkAssemblyPath	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.
virtual int	GetNumberOfConsumers ()
	Tells if the prop has all the required keys.
virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.
virtual int	GetPickable ()
	Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.
virtual vtkInformation	GetPropertyKeys ()
	Set/Get property keys. Property keys can be digest by some rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow mapping render pass. Keys are documented in render pass classes. Initial value is NULL.
virtual uint	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, textures etc.
virtual double	GetRenderTimeMultiplier ()
	Tells if the prop has all the required keys.
virtual bool	GetSupportsSelection ()
	Tells if the prop has all the required keys.
virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). Initial value is true.
virtual int	GetVisibility ()
	Set/Get visibility of this vtkProp. Initial value is true.
virtual void	GetVolumes (vtkPropCollection arg0)
	For some exporters and other other operations we must be able to collect all the actors or volumes. These methods are used in that process.
virtual bool	HasKeys (vtkInformation requiredKeys)
	Tells if the prop has all the required keys.
virtual int	HasTranslucentPolygonalGeometry ()
	Tells if the prop has all the required keys.
virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.
int	IsConsumer (vtkObject c)
	Tells if the prop has all the required keys.
virtual void	Pick ()
	Method fires PickEvent if the prop is picked.
virtual void	PickableOff ()
	Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.
virtual void	PickableOn ()
	Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.
virtual void	PokeMatrix (vtkMatrix4x4 arg0)
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. Generally used only for picking. See vtkProp3D for more information.
void	RemoveConsumer (vtkObject c)
	Tells if the prop has all the required keys.
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Tells if the prop has all the required keys.
virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Tells if the prop has all the required keys.
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Tells if the prop has all the required keys.
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Tells if the prop has all the required keys.
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport arg0)
	Tells if the prop has all the required keys.
virtual int	RenderVolumetricGeometry (vtkViewport arg0)
	Tells if the prop has all the required keys.
virtual void	RestoreEstimatedRenderTime ()
	Tells if the prop has all the required keys.
virtual void	SetAllocatedRenderTime (double t, vtkViewport arg1)
	Tells if the prop has all the required keys.
virtual void	SetDragable (int _arg)
	Set/Get the value of the dragable instance variable. This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.
virtual void	SetEstimatedRenderTime (double t)
	Tells if the prop has all the required keys.
virtual void	SetPickable (int _arg)
	Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.
virtual void	SetPropertyKeys (vtkInformation keys)
	Set/Get property keys. Property keys can be digest by some rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow mapping render pass. Keys are documented in render pass classes. Initial value is NULL.
void	SetRenderTimeMultiplier (double t)
	Tells if the prop has all the required keys.
virtual void	SetUseBounds (bool _arg)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). Initial value is true.
virtual void	SetVisibility (int _arg)
	Set/Get visibility of this vtkProp. Initial value is true.
virtual void	ShallowCopy (vtkProp prop)
	Shallow copy of this vtkProp.
virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). Initial value is true.
virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). Initial value is true.
virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp. Initial value is true.
virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp. Initial value is true.
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 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.
Public Attributes inherited from Kitware.VTK.vtkProp
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 = "19vtkLegendScaleActor"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkProp
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	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

enum Kitware.VTK.vtkLegendScaleActor.AttributeLocation

Standard methods for the class.

Enumerator:

DISTANCE	enum member
XY_COORDINATES	enum member

Constructor & Destructor Documentation

static Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor ( )

staticprivate

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.

Kitware.VTK.vtkLegendScaleActor.vtkLegendScaleActor ( )

Instantiate the class.

Member Function Documentation

void Kitware.VTK.vtkLegendScaleActor.AllAnnotationsOff ( )

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

void Kitware.VTK.vtkLegendScaleActor.AllAnnotationsOn ( )

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

void Kitware.VTK.vtkLegendScaleActor.AllAxesOff ( )

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

void Kitware.VTK.vtkLegendScaleActor.AllAxesOn ( )

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

virtual void Kitware.VTK.vtkLegendScaleActor.BottomAxisVisibilityOff ( )

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.BottomAxisVisibilityOn ( )

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.BuildRepresentation ( vtkViewport viewport )

virtual

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.

override void Kitware.VTK.vtkLegendScaleActor.GetActors2D ( vtkPropCollection arg0 )

virtual

Decsription: Standard methods supporting the rendering process.

Reimplemented from Kitware.VTK.vtkProp.

virtual vtkAxisActor2D Kitware.VTK.vtkLegendScaleActor.GetBottomAxis ( )

virtual

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:

virtual int Kitware.VTK.vtkLegendScaleActor.GetBottomAxisVisibility ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetBottomBorderOffset ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetBottomBorderOffsetMaxValue ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetBottomBorderOffsetMinValue ( )

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 double Kitware.VTK.vtkLegendScaleActor.GetCornerOffsetFactor ( )

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 double Kitware.VTK.vtkLegendScaleActor.GetCornerOffsetFactorMaxValue ( )

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 double Kitware.VTK.vtkLegendScaleActor.GetCornerOffsetFactorMinValue ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetLabelMode ( )

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.

virtual int Kitware.VTK.vtkLegendScaleActor.GetLabelModeMaxValue ( )

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.

virtual int Kitware.VTK.vtkLegendScaleActor.GetLabelModeMinValue ( )

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.

virtual vtkAxisActor2D Kitware.VTK.vtkLegendScaleActor.GetLeftAxis ( )

virtual

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:

virtual int Kitware.VTK.vtkLegendScaleActor.GetLeftAxisVisibility ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetLeftBorderOffset ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetLeftBorderOffsetMaxValue ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetLeftBorderOffsetMinValue ( )

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 vtkTextProperty Kitware.VTK.vtkLegendScaleActor.GetLegendLabelProperty ( )

virtual

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

Here is the call graph for this function:

virtual vtkTextProperty Kitware.VTK.vtkLegendScaleActor.GetLegendTitleProperty ( )

virtual

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

Here is the call graph for this function:

virtual int Kitware.VTK.vtkLegendScaleActor.GetLegendVisibility ( )

virtual

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

virtual vtkAxisActor2D Kitware.VTK.vtkLegendScaleActor.GetRightAxis ( )

virtual

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:

virtual int Kitware.VTK.vtkLegendScaleActor.GetRightAxisVisibility ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetRightBorderOffset ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetRightBorderOffsetMaxValue ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetRightBorderOffsetMinValue ( )

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 vtkAxisActor2D Kitware.VTK.vtkLegendScaleActor.GetTopAxis ( )

virtual

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:

virtual int Kitware.VTK.vtkLegendScaleActor.GetTopAxisVisibility ( )

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 int Kitware.VTK.vtkLegendScaleActor.GetTopBorderOffset ( )

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.

virtual int Kitware.VTK.vtkLegendScaleActor.GetTopBorderOffsetMaxValue ( )

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.

virtual int Kitware.VTK.vtkLegendScaleActor.GetTopBorderOffsetMinValue ( )

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.

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.

virtual void Kitware.VTK.vtkLegendScaleActor.LeftAxisVisibilityOff ( )

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.LeftAxisVisibilityOn ( )

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.LegendVisibilityOff ( )

virtual

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

virtual void Kitware.VTK.vtkLegendScaleActor.LegendVisibilityOn ( )

virtual

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

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

static

Instantiate the class.

Reimplemented from Kitware.VTK.vtkObject.

new vtkLegendScaleActor Kitware.VTK.vtkLegendScaleActor.NewInstance ( )

Standard methods for the class.

Reimplemented from Kitware.VTK.vtkProp.

override void Kitware.VTK.vtkLegendScaleActor.ReleaseGraphicsResources ( vtkWindow arg0 )

virtual

Decsription: Standard methods supporting the rendering process.

Reimplemented from Kitware.VTK.vtkProp.

override int Kitware.VTK.vtkLegendScaleActor.RenderOpaqueGeometry ( vtkViewport arg0 )

virtual

Decsription: Standard methods supporting the rendering process.

Reimplemented from Kitware.VTK.vtkProp.

override int Kitware.VTK.vtkLegendScaleActor.RenderOverlay ( vtkViewport arg0 )

virtual

Decsription: Standard methods supporting the rendering process.

Reimplemented from Kitware.VTK.vtkProp.

virtual void Kitware.VTK.vtkLegendScaleActor.RightAxisVisibilityOff ( )

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.RightAxisVisibilityOn ( )

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.

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

static

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.

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

virtual void Kitware.VTK.vtkLegendScaleActor.TopAxisVisibilityOff ( )

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.TopAxisVisibilityOn ( )

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.

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:

csharp/vtkLegendScaleActor.cs

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Private Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation