ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkLegendBoxActor Class Reference

vtkLegendBoxActor - draw symbols with text More...

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

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.

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.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkLegendBoxActor"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkLegendBoxActor_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLegendBoxActor_BorderOff_01 (HandleRef pThis)
static internal void vtkLegendBoxActor_BorderOn_02 (HandleRef pThis)
static internal void vtkLegendBoxActor_BoxOff_03 (HandleRef pThis)
static internal void vtkLegendBoxActor_BoxOn_04 (HandleRef pThis)
static internal IntPtr vtkLegendBoxActor_GetBackgroundColor_05 (HandleRef pThis)
static internal void vtkLegendBoxActor_GetBackgroundColor_06 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkLegendBoxActor_GetBackgroundColor_07 (HandleRef pThis, IntPtr _arg)
static internal double vtkLegendBoxActor_GetBackgroundOpacity_08 (HandleRef pThis)
static internal double vtkLegendBoxActor_GetBackgroundOpacityMaxValue_09 (HandleRef pThis)
static internal double vtkLegendBoxActor_GetBackgroundOpacityMinValue_10 (HandleRef pThis)
static internal int vtkLegendBoxActor_GetBorder_11 (HandleRef pThis)
static internal int vtkLegendBoxActor_GetBox_12 (HandleRef pThis)
static internal IntPtr vtkLegendBoxActor_GetBoxProperty_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkLegendBoxActor_GetEntryColor_14 (HandleRef pThis, int i)
static internal IntPtr vtkLegendBoxActor_GetEntryIcon_15 (HandleRef pThis, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkLegendBoxActor_GetEntryString_16 (HandleRef pThis, int i)
static internal IntPtr vtkLegendBoxActor_GetEntrySymbol_17 (HandleRef pThis, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkLegendBoxActor_GetEntryTextProperty_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkLegendBoxActor_GetLockBorder_19 (HandleRef pThis)
static internal int vtkLegendBoxActor_GetNumberOfEntries_20 (HandleRef pThis)
static internal int vtkLegendBoxActor_GetPadding_21 (HandleRef pThis)
static internal int vtkLegendBoxActor_GetPaddingMaxValue_22 (HandleRef pThis)
static internal int vtkLegendBoxActor_GetPaddingMinValue_23 (HandleRef pThis)
static internal int vtkLegendBoxActor_GetScalarVisibility_24 (HandleRef pThis)
static internal int vtkLegendBoxActor_GetUseBackground_25 (HandleRef pThis)
static internal int vtkLegendBoxActor_HasTranslucentPolygonalGeometry_26 (HandleRef pThis)
static internal int vtkLegendBoxActor_IsA_27 (HandleRef pThis, string type)
static internal int vtkLegendBoxActor_IsTypeOf_28 (string type)
static internal void vtkLegendBoxActor_LockBorderOff_29 (HandleRef pThis)
static internal void vtkLegendBoxActor_LockBorderOn_30 (HandleRef pThis)
static internal IntPtr vtkLegendBoxActor_NewInstance_32 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLegendBoxActor_ReleaseGraphicsResources_33 (HandleRef pThis, HandleRef arg0)
static internal int vtkLegendBoxActor_RenderOpaqueGeometry_34 (HandleRef pThis, HandleRef viewport)
static internal int vtkLegendBoxActor_RenderOverlay_35 (HandleRef pThis, HandleRef viewport)
static internal int vtkLegendBoxActor_RenderTranslucentPolygonalGeometry_36 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkLegendBoxActor_SafeDownCast_37 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLegendBoxActor_ScalarVisibilityOff_38 (HandleRef pThis)
static internal void vtkLegendBoxActor_ScalarVisibilityOn_39 (HandleRef pThis)
static internal void vtkLegendBoxActor_SetBackgroundColor_40 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkLegendBoxActor_SetBackgroundColor_41 (HandleRef pThis, IntPtr _arg)
static internal void vtkLegendBoxActor_SetBackgroundOpacity_42 (HandleRef pThis, double _arg)
static internal void vtkLegendBoxActor_SetBorder_43 (HandleRef pThis, int _arg)
static internal void vtkLegendBoxActor_SetBox_44 (HandleRef pThis, int _arg)
static internal void vtkLegendBoxActor_SetEntry_45 (HandleRef pThis, int i, HandleRef symbol, string arg2, IntPtr color)
static internal void vtkLegendBoxActor_SetEntry_46 (HandleRef pThis, int i, HandleRef symbol, string arg2, IntPtr color)
static internal void vtkLegendBoxActor_SetEntry_47 (HandleRef pThis, int i, HandleRef symbol, HandleRef icon, string arg3, IntPtr color)
static internal void vtkLegendBoxActor_SetEntryColor_48 (HandleRef pThis, int i, IntPtr color)
static internal void vtkLegendBoxActor_SetEntryColor_49 (HandleRef pThis, int i, double r, double g, double b)
static internal void vtkLegendBoxActor_SetEntryIcon_50 (HandleRef pThis, int i, HandleRef icon)
static internal void vtkLegendBoxActor_SetEntryString_51 (HandleRef pThis, int i, string arg1)
static internal void vtkLegendBoxActor_SetEntrySymbol_52 (HandleRef pThis, int i, HandleRef symbol)
static internal void vtkLegendBoxActor_SetEntryTextProperty_53 (HandleRef pThis, HandleRef p)
static internal void vtkLegendBoxActor_SetLockBorder_54 (HandleRef pThis, int _arg)
static internal void vtkLegendBoxActor_SetNumberOfEntries_55 (HandleRef pThis, int num)
static internal void vtkLegendBoxActor_SetPadding_56 (HandleRef pThis, int _arg)
static internal void vtkLegendBoxActor_SetScalarVisibility_57 (HandleRef pThis, int _arg)
static internal void vtkLegendBoxActor_SetUseBackground_58 (HandleRef pThis, int _arg)
static internal void vtkLegendBoxActor_ShallowCopy_59 (HandleRef pThis, HandleRef prop)
static internal void vtkLegendBoxActor_UseBackgroundOff_60 (HandleRef pThis)
static internal void vtkLegendBoxActor_UseBackgroundOn_61 (HandleRef pThis)

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

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.

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

Set/Get background opacity. Default is: 1.0.

Set/Get background opacity. Default is: 1.0.

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.

Get the box vtkProperty2D.

Here is the call graph for this function:

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

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:

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

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:

Set/Get the text property.

Here is the call graph for this function:

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.

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.

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

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

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.

Turn on/off background.

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.

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

Reimplemented from Kitware.VTK.vtkActor2D.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

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

Reimplemented from Kitware.VTK.vtkActor2D.

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.

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

Reimplemented from Kitware.VTK.vtkActor2D.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

Here is the call graph for this function:

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.

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

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

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

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.

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.

Turn on/off background.

Turn on/off background.

static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_BorderOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_BorderOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_BoxOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_BoxOn_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBackgroundColor_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBackgroundColor_06 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBackgroundColor_07 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal double Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBackgroundOpacity_08 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBackgroundOpacityMaxValue_09 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBackgroundOpacityMinValue_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBorder_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBox_12 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetBoxProperty_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetEntryColor_14 ( HandleRef  pThis,
int  i 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetEntryIcon_15 ( HandleRef  pThis,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetEntryString_16 ( HandleRef  pThis,
int  i 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetEntrySymbol_17 ( HandleRef  pThis,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetEntryTextProperty_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetLockBorder_19 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetNumberOfEntries_20 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetPadding_21 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetPaddingMaxValue_22 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetPaddingMinValue_23 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetScalarVisibility_24 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_GetUseBackground_25 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_IsA_27 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_IsTypeOf_28 ( string  type) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_LockBorderOff_29 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_LockBorderOn_30 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_NewInstance_32 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_ReleaseGraphicsResources_33 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_RenderOpaqueGeometry_34 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_RenderOverlay_35 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal int Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_RenderTranslucentPolygonalGeometry_36 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SafeDownCast_37 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_ScalarVisibilityOff_38 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_ScalarVisibilityOn_39 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetBackgroundColor_40 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetBackgroundColor_41 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetBackgroundOpacity_42 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetBorder_43 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetBox_44 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntry_45 ( HandleRef  pThis,
int  i,
HandleRef  symbol,
string  arg2,
IntPtr  color 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntry_46 ( HandleRef  pThis,
int  i,
HandleRef  symbol,
string  arg2,
IntPtr  color 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntry_47 ( HandleRef  pThis,
int  i,
HandleRef  symbol,
HandleRef  icon,
string  arg3,
IntPtr  color 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntryColor_48 ( HandleRef  pThis,
int  i,
IntPtr  color 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntryColor_49 ( HandleRef  pThis,
int  i,
double  r,
double  g,
double  b 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntryIcon_50 ( HandleRef  pThis,
int  i,
HandleRef  icon 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntryString_51 ( HandleRef  pThis,
int  i,
string  arg1 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntrySymbol_52 ( HandleRef  pThis,
int  i,
HandleRef  symbol 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetEntryTextProperty_53 ( HandleRef  pThis,
HandleRef  p 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetLockBorder_54 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetNumberOfEntries_55 ( HandleRef  pThis,
int  num 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetPadding_56 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetScalarVisibility_57 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_SetUseBackground_58 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_ShallowCopy_59 ( HandleRef  pThis,
HandleRef  prop 
) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_UseBackgroundOff_60 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLegendBoxActor.vtkLegendBoxActor_UseBackgroundOn_61 ( HandleRef  pThis) [private]

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: