vtkScalarBarActor - Create a scalar bar with labels More...

Inheritance diagram for Kitware.VTK.vtkScalarBarActor:

Collaboration diagram for Kitware.VTK.vtkScalarBarActor:

Public Types
enum	PrecedeScalarBar_WrapperEnum { PrecedeScalarBar = 0, SucceedScalarBar = 1 }
	Get the texture actor.. you may want to change some properties on it. More...

Public Member Functions
	vtkScalarBarActor (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkScalarBarActor ()
	Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label format, no title, and vertical orientation. The initial scalar bar size is (0.05 x 0.8) of the viewport size.
virtual string	GetComponentTitle ()
	Set/Get the title for the component that is selected,.
virtual string	GetLabelFormat ()
	Set/Get the format with which to print the labels on the scalar bar.
virtual vtkTextProperty	GetLabelTextProperty ()
	Set/Get the labels text property.
virtual vtkScalarsToColors	GetLookupTable ()
	Set/Get the vtkLookupTable to use. The lookup table specifies the number of colors to use in the table (if not overridden), as well as the scalar range.
virtual int	GetMaximumHeightInPixels ()
	Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.
virtual int	GetMaximumNumberOfColors ()
	Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.
virtual int	GetMaximumNumberOfColorsMaxValue ()
	Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.
virtual int	GetMaximumNumberOfColorsMinValue ()
	Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.
virtual int	GetMaximumWidthInPixels ()
	Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.
virtual int	GetNumberOfLabels ()
	Set/Get the number of annotation labels to show.
virtual int	GetNumberOfLabelsMaxValue ()
	Set/Get the number of annotation labels to show.
virtual int	GetNumberOfLabelsMinValue ()
	Set/Get the number of annotation labels to show.
virtual int	GetOrientation ()
	Control the orientation of the scalar bar.
virtual int	GetOrientationMaxValue ()
	Control the orientation of the scalar bar.
virtual int	GetOrientationMinValue ()
	Control the orientation of the scalar bar.
virtual int	GetTextPosition ()
	Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.
virtual int	GetTextPositionMaxValue ()
	Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.
virtual int	GetTextPositionMinValue ()
	Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.
virtual vtkActor2D	GetTextureActor ()
	Get the texture actor.. you may want to change some properties on it.
virtual double	GetTextureGridWidth ()
	Set the width of the texture grid. Used only if UseOpacity is ON.
virtual string	GetTitle ()
	Set/Get the title of the scalar bar actor,.
virtual vtkTextProperty	GetTitleTextProperty ()
	Set/Get the title text property.
virtual int	GetUseOpacity ()
	Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off].
override int	HasTranslucentPolygonalGeometry ()
	Does this prop have some translucent polygonal geometry?
override int	IsA (string type)
	*Undocumented Block
new vtkScalarBarActor	NewInstance ()
	*Undocumented Block
override void	ReleaseGraphicsResources (vtkWindow arg0)
	Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.
override int	RenderOpaqueGeometry (vtkViewport viewport)
	Draw the scalar bar and annotation text to the screen.
override int	RenderOverlay (vtkViewport viewport)
	Draw the scalar bar and annotation text to the screen.
override int	RenderTranslucentPolygonalGeometry (vtkViewport arg0)
	Draw the scalar bar and annotation text to the screen.
virtual void	SetComponentTitle (string _arg)
	Set/Get the title for the component that is selected,.
virtual void	SetLabelFormat (string _arg)
	Set/Get the format with which to print the labels on the scalar bar.
virtual void	SetLabelTextProperty (vtkTextProperty p)
	Set/Get the labels text property.
virtual void	SetLookupTable (vtkScalarsToColors arg0)
	Set/Get the vtkLookupTable to use. The lookup table specifies the number of colors to use in the table (if not overridden), as well as the scalar range.
virtual void	SetMaximumHeightInPixels (int _arg)
	Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.
virtual void	SetMaximumNumberOfColors (int _arg)
	Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.
virtual void	SetMaximumWidthInPixels (int _arg)
	Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.
virtual void	SetNumberOfLabels (int _arg)
	Set/Get the number of annotation labels to show.
virtual void	SetOrientation (int _arg)
	Control the orientation of the scalar bar.
void	SetOrientationToHorizontal ()
	Control the orientation of the scalar bar.
void	SetOrientationToVertical ()
	Control the orientation of the scalar bar.
virtual void	SetTextPosition (int _arg)
	Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.
virtual void	SetTextPositionToPrecedeScalarBar ()
	Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.
virtual void	SetTextPositionToSucceedScalarBar ()
	Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.
virtual void	SetTextureGridWidth (double _arg)
	Set the width of the texture grid. Used only if UseOpacity is ON.
virtual void	SetTitle (string _arg)
	Set/Get the title of the scalar bar actor,.
virtual void	SetTitleTextProperty (vtkTextProperty p)
	Set/Get the title text property.
virtual void	SetUseOpacity (int _arg)
	Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off].
override void	ShallowCopy (vtkProp prop)
	Shallow copy of a scalar bar actor. Overloads the virtual vtkProp method.
virtual void	UseOpacityOff ()
	Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off].
virtual void	UseOpacityOn ()
	Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off].
Public Member Functions inherited from Kitware.VTK.vtkActor2D
	vtkActor2D (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkActor2D ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0.
override void	GetActors2D (vtkPropCollection pc)
	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 vtkCoordinate	GetActualPosition2Coordinate ()
	Return the actual vtkCoordinate reference that the mapper should use to position the actor. This is used internally by the mappers and should be overridden in specialized subclasses and otherwise ignored.
virtual vtkCoordinate	GetActualPositionCoordinate ()
	Return the actual vtkCoordinate reference that the mapper should use to position the actor. This is used internally by the mappers and should be overridden in specialized subclasses and otherwise ignored.
double	GetHeight ()
	Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render.
override uint	GetMTime ()
	Return this objects MTime.
virtual vtkMapper2D	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn.
virtual double[]	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D.
virtual double[]	GetPosition2 ()
	Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable.
virtual vtkCoordinate	GetPosition2Coordinate ()
	Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable.
virtual vtkCoordinate	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D.
vtkProperty2D	GetProperty ()
	Returns this actor's vtkProperty2D. Creates a property if one doesn't already exist.
double	GetWidth ()
	Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
void	SetDisplayPosition (int arg0, int arg1)
	Set the Prop2D's position in display coordinates.
void	SetHeight (double h)
	Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
virtual void	SetLayerNumber (int _arg)
	Set/Get the layer number in the overlay planes into which to render.
virtual void	SetMapper (vtkMapper2D mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn.
virtual void	SetPosition (IntPtr x)
	Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D.
virtual void	SetPosition (double x, double y)
	Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D.
virtual void	SetPosition2 (IntPtr x)
	Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable.
virtual void	SetPosition2 (double x, double y)
	Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable.
virtual void	SetProperty (vtkProperty2D arg0)
	Set this vtkProp's vtkProperty2D.
void	SetWidth (double w)
	Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
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 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	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	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.
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 vtkScalarBarActor	New ()
	Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label format, no title, and vertical orientation. The initial scalar bar size is (0.05 x 0.8) of the viewport size.
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkScalarBarActor	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkScalarBarActor"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkActor2D
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 = "17vtkScalarBarActor"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkActor2D
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	vtkScalarBarActor ()
	Automatically generated type registration mechanics.

Detailed Description

vtkScalarBarActor - Create a scalar bar with labels

Description vtkScalarBarActor creates a scalar bar with annotation text. A scalar bar is a legend that indicates to the viewer the correspondence between color value and data value. The legend consists of a rectangular bar made of rectangular pieces each colored a constant value. Since vtkScalarBarActor is a subclass of vtkActor2D, it is drawn in the image plane (i.e., in the renderer's viewport) on top of the 3D graphics window.

To use vtkScalarBarActor you must associate a vtkScalarsToColors (or subclass) with it. The lookup table defines the colors and the range of scalar values used to map scalar data. Typically, the number of colors shown in the scalar bar is not equal to the number of colors in the lookup table, in which case sampling of the lookup table is performed.

Other optional capabilities include specifying the fraction of the viewport size (both x and y directions) which will control the size of the scalar bar and the number of annotation labels. The actual position of the scalar bar on the screen is controlled by using the vtkActor2D::SetPosition() method (by default the scalar bar is centered in the viewport). Other features include the ability to orient the scalar bar horizontally of vertically and controlling the format (printf style) with which to print the labels on the scalar bar. Also, the vtkScalarBarActor's property is applied to the scalar bar and annotation (including layer, and compositing operator).

Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated to this actor.

Caveats If a vtkLogLookupTable is specified as the lookup table to use, then the labels are created using a logarithmic scale.

vtkActor2D vtkTextProperty vtkTextMapper vtkPolyDataMapper2D

Member Enumeration Documentation

enum Kitware.VTK.vtkScalarBarActor.PrecedeScalarBar_WrapperEnum

Get the texture actor.. you may want to change some properties on it.

Enumerator:

PrecedeScalarBar	enum member
SucceedScalarBar	enum member

Constructor & Destructor Documentation

static Kitware.VTK.vtkScalarBarActor.vtkScalarBarActor ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkScalarBarActor.vtkScalarBarActor ( )

Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label format, no title, and vertical orientation. The initial scalar bar size is (0.05 x 0.8) of the viewport size.

Member Function Documentation

override void Kitware.VTK.vtkScalarBarActor.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.vtkActor2D.

virtual string Kitware.VTK.vtkScalarBarActor.GetComponentTitle ( )

virtual

Set/Get the title for the component that is selected,.

virtual string Kitware.VTK.vtkScalarBarActor.GetLabelFormat ( )

virtual

Set/Get the format with which to print the labels on the scalar bar.

virtual vtkTextProperty Kitware.VTK.vtkScalarBarActor.GetLabelTextProperty ( )

virtual

Set/Get the labels text property.

Here is the call graph for this function:

virtual vtkScalarsToColors Kitware.VTK.vtkScalarBarActor.GetLookupTable ( )

virtual

Set/Get the vtkLookupTable to use. The lookup table specifies the number of colors to use in the table (if not overridden), as well as the scalar range.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkScalarBarActor.GetMaximumHeightInPixels ( )

virtual

Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.

virtual int Kitware.VTK.vtkScalarBarActor.GetMaximumNumberOfColors ( )

virtual

Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.

virtual int Kitware.VTK.vtkScalarBarActor.GetMaximumNumberOfColorsMaxValue ( )

virtual

Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.

virtual int Kitware.VTK.vtkScalarBarActor.GetMaximumNumberOfColorsMinValue ( )

virtual

Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.

virtual int Kitware.VTK.vtkScalarBarActor.GetMaximumWidthInPixels ( )

virtual

Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.

virtual int Kitware.VTK.vtkScalarBarActor.GetNumberOfLabels ( )

virtual

Set/Get the number of annotation labels to show.

virtual int Kitware.VTK.vtkScalarBarActor.GetNumberOfLabelsMaxValue ( )

virtual

Set/Get the number of annotation labels to show.

virtual int Kitware.VTK.vtkScalarBarActor.GetNumberOfLabelsMinValue ( )

virtual

Set/Get the number of annotation labels to show.

virtual int Kitware.VTK.vtkScalarBarActor.GetOrientation ( )

virtual

Control the orientation of the scalar bar.

virtual int Kitware.VTK.vtkScalarBarActor.GetOrientationMaxValue ( )

virtual

Control the orientation of the scalar bar.

virtual int Kitware.VTK.vtkScalarBarActor.GetOrientationMinValue ( )

virtual

Control the orientation of the scalar bar.

virtual int Kitware.VTK.vtkScalarBarActor.GetTextPosition ( )

virtual

Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.

virtual int Kitware.VTK.vtkScalarBarActor.GetTextPositionMaxValue ( )

virtual

Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.

virtual int Kitware.VTK.vtkScalarBarActor.GetTextPositionMinValue ( )

virtual

Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.

virtual vtkActor2D Kitware.VTK.vtkScalarBarActor.GetTextureActor ( )

virtual

Get the texture actor.. you may want to change some properties on it.

Here is the call graph for this function:

virtual double Kitware.VTK.vtkScalarBarActor.GetTextureGridWidth ( )

virtual

Set the width of the texture grid. Used only if UseOpacity is ON.

virtual string Kitware.VTK.vtkScalarBarActor.GetTitle ( )

virtual

Set/Get the title of the scalar bar actor,.

virtual vtkTextProperty Kitware.VTK.vtkScalarBarActor.GetTitleTextProperty ( )

virtual

Set/Get the title text property.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkScalarBarActor.GetUseOpacity ( )

virtual

Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off].

override int Kitware.VTK.vtkScalarBarActor.HasTranslucentPolygonalGeometry ( )

virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkScalarBarActor.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

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

static

Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label format, no title, and vertical orientation. The initial scalar bar size is (0.05 x 0.8) of the viewport size.

Reimplemented from Kitware.VTK.vtkActor2D.

new vtkScalarBarActor Kitware.VTK.vtkScalarBarActor.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

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

virtual

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkScalarBarActor.RenderOpaqueGeometry ( vtkViewport viewport )

virtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkScalarBarActor.RenderOverlay ( vtkViewport viewport )

virtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkScalarBarActor.RenderTranslucentPolygonalGeometry ( vtkViewport arg0 )

virtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from Kitware.VTK.vtkActor2D.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkScalarBarActor.SetComponentTitle ( string _arg )

virtual

Set/Get the title for the component that is selected,.

virtual void Kitware.VTK.vtkScalarBarActor.SetLabelFormat ( string _arg )

virtual

Set/Get the format with which to print the labels on the scalar bar.

virtual void Kitware.VTK.vtkScalarBarActor.SetLabelTextProperty ( vtkTextProperty p )

virtual

Set/Get the labels text property.

virtual void Kitware.VTK.vtkScalarBarActor.SetLookupTable ( vtkScalarsToColors arg0 )

virtual

Set/Get the vtkLookupTable to use. The lookup table specifies the number of colors to use in the table (if not overridden), as well as the scalar range.

virtual void Kitware.VTK.vtkScalarBarActor.SetMaximumHeightInPixels ( int _arg )

virtual

Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.

virtual void Kitware.VTK.vtkScalarBarActor.SetMaximumNumberOfColors ( int _arg )

virtual

Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.

virtual void Kitware.VTK.vtkScalarBarActor.SetMaximumWidthInPixels ( int _arg )

virtual

Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.

virtual void Kitware.VTK.vtkScalarBarActor.SetNumberOfLabels ( int _arg )

virtual

Set/Get the number of annotation labels to show.

virtual void Kitware.VTK.vtkScalarBarActor.SetOrientation ( int _arg )

virtual

Control the orientation of the scalar bar.

void Kitware.VTK.vtkScalarBarActor.SetOrientationToHorizontal ( )

Control the orientation of the scalar bar.

void Kitware.VTK.vtkScalarBarActor.SetOrientationToVertical ( )

Control the orientation of the scalar bar.

virtual void Kitware.VTK.vtkScalarBarActor.SetTextPosition ( int _arg )

virtual

Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.

virtual void Kitware.VTK.vtkScalarBarActor.SetTextPositionToPrecedeScalarBar ( )

virtual

Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.

virtual void Kitware.VTK.vtkScalarBarActor.SetTextPositionToSucceedScalarBar ( )

virtual

Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite.

virtual void Kitware.VTK.vtkScalarBarActor.SetTextureGridWidth ( double _arg )

virtual

Set the width of the texture grid. Used only if UseOpacity is ON.

virtual void Kitware.VTK.vtkScalarBarActor.SetTitle ( string _arg )

virtual

Set/Get the title of the scalar bar actor,.

virtual void Kitware.VTK.vtkScalarBarActor.SetTitleTextProperty ( vtkTextProperty p )

virtual

Set/Get the title text property.

virtual void Kitware.VTK.vtkScalarBarActor.SetUseOpacity ( int _arg )

virtual

Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off].

override void Kitware.VTK.vtkScalarBarActor.ShallowCopy ( vtkProp prop )

virtual

Shallow copy of a scalar bar actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkActor2D.

virtual void Kitware.VTK.vtkScalarBarActor.UseOpacityOff ( )

virtual

Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off].

virtual void Kitware.VTK.vtkScalarBarActor.UseOpacityOn ( )

virtual

Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off].