Kitware.VTK.vtkLegendBoxActor Class Reference

vtkLegendBoxActor - draw symbols with text More...

Inheritance diagram for Kitware.VTK.vtkLegendBoxActor:

Collaboration diagram for Kitware.VTK.vtkLegendBoxActor:

List of all members.

Public Member Functions
	vtkLegendBoxActor (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkLegendBoxActor ()
	Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
virtual void	BorderOff ()
	Set/Get the flag that controls whether a border will be drawn around the legend box.
virtual void	BorderOn ()
	Set/Get the flag that controls whether a border will be drawn around the legend box.
virtual void	BoxOff ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
virtual void	BoxOn ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
virtual double[]	GetBackgroundColor ()
	Set/Get background color. Default is: (0.3, 0.3, 0.3).
virtual void	GetBackgroundColor (ref double _arg1, ref double _arg2, ref double _arg3)
	Set/Get background color. Default is: (0.3, 0.3, 0.3).
virtual void	GetBackgroundColor (IntPtr _arg)
	Set/Get background color. Default is: (0.3, 0.3, 0.3).
virtual double	GetBackgroundOpacity ()
	Set/Get background opacity. Default is: 1.0.
virtual double	GetBackgroundOpacityMaxValue ()
	Set/Get background opacity. Default is: 1.0.
virtual double	GetBackgroundOpacityMinValue ()
	Set/Get background opacity. Default is: 1.0.
virtual int	GetBorder ()
	Set/Get the flag that controls whether a border will be drawn around the legend box.
virtual int	GetBox ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
vtkProperty2D	GetBoxProperty ()
	Get the box vtkProperty2D.
double[]	GetEntryColor (int i)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
vtkImageData	GetEntryIcon (int i)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
string	GetEntryString (int i)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
vtkPolyData	GetEntrySymbol (int i)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
virtual vtkTextProperty	GetEntryTextProperty ()
	Set/Get the text property.
virtual int	GetLockBorder ()
	Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.
int	GetNumberOfEntries ()
	Specify the number of entries in the legend box.
virtual int	GetPadding ()
	Set/Get the padding between the legend entries and the border. The value is specified in pixels.
virtual int	GetPaddingMaxValue ()
	Set/Get the padding between the legend entries and the border. The value is specified in pixels.
virtual int	GetPaddingMinValue ()
	Set/Get the padding between the legend entries and the border. The value is specified in pixels.
virtual int	GetScalarVisibility ()
	Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.
virtual int	GetUseBackground ()
	Turn on/off background.
override int	HasTranslucentPolygonalGeometry ()
	Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.
override int	IsA (string type)
	*Undocumented Block
virtual void	LockBorderOff ()
	Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.
virtual void	LockBorderOn ()
	Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.
new vtkLegendBoxActor	NewInstance ()
	*Undocumented Block
override void	ReleaseGraphicsResources (vtkWindow arg0)
	Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.
override int	RenderOpaqueGeometry (vtkViewport viewport)
	Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.
override int	RenderOverlay (vtkViewport viewport)
	Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.
override int	RenderTranslucentPolygonalGeometry (vtkViewport arg0)
	Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.
virtual void	ScalarVisibilityOff ()
	Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.
virtual void	ScalarVisibilityOn ()
	Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.
virtual void	SetBackgroundColor (double _arg1, double _arg2, double _arg3)
	Set/Get background color. Default is: (0.3, 0.3, 0.3).
virtual void	SetBackgroundColor (IntPtr _arg)
	Set/Get background color. Default is: (0.3, 0.3, 0.3).
virtual void	SetBackgroundOpacity (double _arg)
	Set/Get background opacity. Default is: 1.0.
virtual void	SetBorder (int _arg)
	Set/Get the flag that controls whether a border will be drawn around the legend box.
virtual void	SetBox (int _arg)
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
void	SetEntry (int i, vtkPolyData symbol, string arg2, IntPtr color)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
void	SetEntry (int i, vtkImageData symbol, string arg2, IntPtr color)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
void	SetEntry (int i, vtkPolyData symbol, vtkImageData icon, string arg3, IntPtr color)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
void	SetEntryColor (int i, IntPtr color)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
void	SetEntryColor (int i, double r, double g, double b)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
void	SetEntryIcon (int i, vtkImageData icon)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
void	SetEntryString (int i, string arg1)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
void	SetEntrySymbol (int i, vtkPolyData symbol)
	Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)
virtual void	SetEntryTextProperty (vtkTextProperty p)
	Set/Get the text property.
virtual void	SetLockBorder (int _arg)
	Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.
void	SetNumberOfEntries (int num)
	Specify the number of entries in the legend box.
virtual void	SetPadding (int _arg)
	Set/Get the padding between the legend entries and the border. The value is specified in pixels.
virtual void	SetScalarVisibility (int _arg)
	Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.
virtual void	SetUseBackground (int _arg)
	Turn on/off background.
override void	ShallowCopy (vtkProp prop)
	Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.
virtual void	UseBackgroundOff ()
	Turn on/off background.
virtual void	UseBackgroundOn ()
	Turn on/off background.
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 vtkLegendBoxActor	New ()
	Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkLegendBoxActor	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

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

---

Detailed Description

vtkLegendBoxActor - draw symbols with text

Description vtkLegendBoxActor is used to associate a symbol with a text string. The user specifies a vtkPolyData to use as the symbol, and a string associated with the symbol. The actor can then be placed in the scene in the same way that any other vtkActor2D can be used.

To use this class, you must define the position of the legend box by using the superclasses' vtkActor2D::Position coordinate and Position2 coordinate. Then define the set of symbols and text strings that make up the menu box. The font attributes of the entries can be set through the vtkTextProperty associated to this actor. The class will scale the symbols and text to fit in the legend box defined by (Position,Position2). Optional features like turning on a border line and setting the spacing between the border and the symbols/text can also be set.

---

Constructor & Destructor Documentation

static Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor

(

)

Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).

---

Member Function Documentation

virtual void Kitware.VTK.vtkLegendBoxActor.BorderOff ( )

virtual

Set/Get the flag that controls whether a border will be drawn around the legend box.

virtual void Kitware.VTK.vtkLegendBoxActor.BorderOn ( )

virtual

Set/Get the flag that controls whether a border will be drawn around the legend box.

virtual void Kitware.VTK.vtkLegendBoxActor.BoxOff ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

virtual void Kitware.VTK.vtkLegendBoxActor.BoxOn ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

override void Kitware.VTK.vtkLegendBoxActor.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 double [] Kitware.VTK.vtkLegendBoxActor.GetBackgroundColor ( )

virtual

Set/Get background color. Default is: (0.3, 0.3, 0.3).

virtual void Kitware.VTK.vtkLegendBoxActor.GetBackgroundColor ( ref double  _arg1, ref double  _arg2, ref double  _arg3  )

virtual

Set/Get background color. Default is: (0.3, 0.3, 0.3).

virtual void Kitware.VTK.vtkLegendBoxActor.GetBackgroundColor ( IntPtr  _arg )

virtual

Set/Get background color. Default is: (0.3, 0.3, 0.3).

virtual double Kitware.VTK.vtkLegendBoxActor.GetBackgroundOpacity ( )

virtual

Set/Get background opacity. Default is: 1.0.

virtual double Kitware.VTK.vtkLegendBoxActor.GetBackgroundOpacityMaxValue ( )

virtual

Set/Get background opacity. Default is: 1.0.

virtual double Kitware.VTK.vtkLegendBoxActor.GetBackgroundOpacityMinValue ( )

virtual

Set/Get background opacity. Default is: 1.0.

virtual int Kitware.VTK.vtkLegendBoxActor.GetBorder ( )

virtual

Set/Get the flag that controls whether a border will be drawn around the legend box.

virtual int Kitware.VTK.vtkLegendBoxActor.GetBox ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

vtkProperty2D Kitware.VTK.vtkLegendBoxActor.GetBoxProperty

(

)

Get the box vtkProperty2D.

Here is the call graph for this function:

double [] Kitware.VTK.vtkLegendBoxActor.GetEntryColor

(

int

i

)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

vtkImageData Kitware.VTK.vtkLegendBoxActor.GetEntryIcon

(

int

i

)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

Here is the call graph for this function:

string Kitware.VTK.vtkLegendBoxActor.GetEntryString

(

int

i

)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

vtkPolyData Kitware.VTK.vtkLegendBoxActor.GetEntrySymbol

(

int

i

)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

Here is the call graph for this function:

virtual vtkTextProperty Kitware.VTK.vtkLegendBoxActor.GetEntryTextProperty ( )

virtual

Set/Get the text property.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkLegendBoxActor.GetLockBorder ( )

virtual

Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.

int Kitware.VTK.vtkLegendBoxActor.GetNumberOfEntries

(

)

Specify the number of entries in the legend box.

virtual int Kitware.VTK.vtkLegendBoxActor.GetPadding ( )

virtual

Set/Get the padding between the legend entries and the border. The value is specified in pixels.

virtual int Kitware.VTK.vtkLegendBoxActor.GetPaddingMaxValue ( )

virtual

Set/Get the padding between the legend entries and the border. The value is specified in pixels.

virtual int Kitware.VTK.vtkLegendBoxActor.GetPaddingMinValue ( )

virtual

Set/Get the padding between the legend entries and the border. The value is specified in pixels.

virtual int Kitware.VTK.vtkLegendBoxActor.GetScalarVisibility ( )

virtual

Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.

virtual int Kitware.VTK.vtkLegendBoxActor.GetUseBackground ( )

virtual

Turn on/off background.

override int Kitware.VTK.vtkLegendBoxActor.HasTranslucentPolygonalGeometry ( )

virtual

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkActor2D.

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

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

virtual void Kitware.VTK.vtkLegendBoxActor.LockBorderOff ( )

virtual

Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.

virtual void Kitware.VTK.vtkLegendBoxActor.LockBorderOn ( )

virtual

Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.

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

static

Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).

Reimplemented from Kitware.VTK.vtkActor2D.

new vtkLegendBoxActor Kitware.VTK.vtkLegendBoxActor.NewInstance

(

)

*Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

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

virtual

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkActor2D.

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

virtual

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkActor2D.

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

virtual

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkActor2D.

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

virtual

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkActor2D.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkLegendBoxActor.ScalarVisibilityOff ( )

virtual

Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.

virtual void Kitware.VTK.vtkLegendBoxActor.ScalarVisibilityOn ( )

virtual

Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.

virtual void Kitware.VTK.vtkLegendBoxActor.SetBackgroundColor ( double  _arg1, double  _arg2, double  _arg3  )

virtual

Set/Get background color. Default is: (0.3, 0.3, 0.3).

virtual void Kitware.VTK.vtkLegendBoxActor.SetBackgroundColor ( IntPtr  _arg )

virtual

Set/Get background color. Default is: (0.3, 0.3, 0.3).

virtual void Kitware.VTK.vtkLegendBoxActor.SetBackgroundOpacity ( double  _arg )

virtual

Set/Get background opacity. Default is: 1.0.

virtual void Kitware.VTK.vtkLegendBoxActor.SetBorder ( int  _arg )

virtual

Set/Get the flag that controls whether a border will be drawn around the legend box.

virtual void Kitware.VTK.vtkLegendBoxActor.SetBox ( int  _arg )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

void Kitware.VTK.vtkLegendBoxActor.SetEntry	(	int	i,
		vtkPolyData	symbol,
		string	arg2,
		IntPtr	color
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void Kitware.VTK.vtkLegendBoxActor.SetEntry	(	int	i,
		vtkImageData	symbol,
		string	arg2,
		IntPtr	color
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void Kitware.VTK.vtkLegendBoxActor.SetEntry	(	int	i,
		vtkPolyData	symbol,
		vtkImageData	icon,
		string	arg3,
		IntPtr	color
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void Kitware.VTK.vtkLegendBoxActor.SetEntryColor	(	int	i,
		IntPtr	color
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void Kitware.VTK.vtkLegendBoxActor.SetEntryColor	(	int	i,
		double	r,
		double	g,
		double	b
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void Kitware.VTK.vtkLegendBoxActor.SetEntryIcon	(	int	i,
		vtkImageData	icon
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void Kitware.VTK.vtkLegendBoxActor.SetEntryString	(	int	i,
		string	arg1
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void Kitware.VTK.vtkLegendBoxActor.SetEntrySymbol	(	int	i,
		vtkPolyData	symbol
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

virtual void Kitware.VTK.vtkLegendBoxActor.SetEntryTextProperty ( vtkTextProperty  p )

virtual

Set/Get the text property.

virtual void Kitware.VTK.vtkLegendBoxActor.SetLockBorder ( int  _arg )

virtual

Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.

void Kitware.VTK.vtkLegendBoxActor.SetNumberOfEntries

(

int

num

)

Specify the number of entries in the legend box.

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

virtual

Set/Get the padding between the legend entries and the border. The value is specified in pixels.

virtual void Kitware.VTK.vtkLegendBoxActor.SetScalarVisibility ( int  _arg )

virtual

Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.

virtual void Kitware.VTK.vtkLegendBoxActor.SetUseBackground ( int  _arg )

virtual

Turn on/off background.

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

virtual

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkActor2D.

virtual void Kitware.VTK.vtkLegendBoxActor.UseBackgroundOff ( )

virtual

Turn on/off background.

virtual void Kitware.VTK.vtkLegendBoxActor.UseBackgroundOn ( )

virtual

Turn on/off background.

---

Member Data Documentation

new readonly string Kitware.VTK.vtkLegendBoxActor.MRClassNameKey = "17vtkLegendBoxActor"

static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkActor2D.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkActor2D.

---

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

• csharp/vtkLegendBoxActor.cs