vtk
Class vtkLegendBoxActor

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkProp
              vtk.vtkActor2D
                  vtk.vtkLegendBoxActor

All Implemented Interfaces:

java.io.Serializable

public class vtkLegendBoxActor

extends vtkActor2D

implements java.io.Serializable

vtkLegendBoxActor - draw symbols with text. 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. JavaBean wrapper for vtkLegendBoxActor object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

vtkXYPlotActor, vtkActor2D, Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkLegendBoxActor()
protected	vtkLegendBoxActor(int dmy)

Method Summary

void	borderOff() Set/Get the flag that controls whether a border will be drawn around the legend box.
void	borderOn() Set/Get the flag that controls whether a border will be drawn around the legend box.
void	boxOff() Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
void	boxOn() Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
int	getBorder() Set/Get the flag that controls whether a border will be drawn around the legend box.
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.
java.lang.String	getClassName() Return the class name as a string.
double[]	getEntryColor(int id0) Add an entry to the legend box.
java.lang.String	getEntryString(int id0) Add an entry to the legend box.
vtkPolyData	getEntrySymbol(int id0) Add an entry to the legend box.
vtkTextProperty	getEntryTextProperty() Set/Get the text property.
int	getLockBorder() Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2).
int	getNumberOfEntries() Add an entry to the legend box.
int	getPadding() Set/Get the padding between the legend entries and the border.
int	getPaddingMaxValue() Set/Get the padding between the legend entries and the border.
int	getPaddingMinValue() Set/Get the padding between the legend entries and the border.
int	getScalarVisibility() Turn on/off flag to control whether the symbol's scalar data is used to color the symbol.
vtkLegendBoxActor	getThisLegendBoxActor()
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	lockBorderOff() Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2).
void	lockBorderOn() Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2).
void	scalarVisibilityOff() Turn on/off flag to control whether the symbol's scalar data is used to color the symbol.
void	scalarVisibilityOn() Turn on/off flag to control whether the symbol's scalar data is used to color the symbol.
void	setBorder(int id0) Set/Get the flag that controls whether a border will be drawn around the legend box.
void	setBox(int id0) Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.
void	setEntry(int id0, vtkPolyData id1, java.lang.String id2, double[] id3) Add an entry to the legend box.
void	setEntryColor(int id0, double[] id1) Add an entry to the legend box.
void	setEntryColor(int id0, double id1, double id2, double id3) Add an entry to the legend box.
void	setEntryString(int id0, java.lang.String id1) Add an entry to the legend box.
void	setEntrySymbol(int id0, vtkPolyData id1) Add an entry to the legend box.
void	setEntryTextProperty(vtkTextProperty id0) Set/Get the text property.
void	setLockBorder(int id0) Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2).
void	setNumberOfEntries(int id0) Specify the number of entries in the legend box.
void	setPadding(int id0) Set/Get the padding between the legend entries and the border.
void	setScalarVisibility(int id0) Turn on/off flag to control whether the symbol's scalar data is used to color the symbol.
void	shallowCopy(vtkProp id0) Shallow copy of this scaled text actor.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkActor2D

getActors2D, getActualPosition2Coordinate, getActualPositionCoordinate, getHeight, getLayerNumber, getMapper, getMTime, getPosition, getPosition2, getPosition2Coordinate, getPositionCoordinate, getProperty, getThisActor2D, getWidth, releaseGraphicsResources, renderOpaqueGeometry, renderOverlay, renderTranslucentGeometry, setDisplayPosition, setHeight, setLayerNumber, setMapper, setPosition, setPosition, setPosition2, setPosition2, setProperty, setWidth

Methods inherited from class vtk.vtkProp

dragableOff, dragableOn, getActors, getDragable, getMatrix, getNextPath, getNumberOfPaths, getPickable, getRedrawMTime, getThisProp, getVisibility, getVolumes, initPathTraversal, pick, pickableOff, pickableOn, pokeMatrix, setDragable, setPickable, setVisibility, visibilityOff, visibilityOn

Methods inherited from class vtk.vtkObject

AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay, unRegister

Methods inherited from class vtk.vtkObjectBase

addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changes

protected java.beans.PropertyChangeSupport changes

Constructor Detail

vtkLegendBoxActor

public vtkLegendBoxActor()

vtkLegendBoxActor

protected vtkLegendBoxActor(int dmy)

Method Detail

getThisLegendBoxActor

public vtkLegendBoxActor getThisLegendBoxActor()

getClassName

public java.lang.String getClassName()

Description copied from class: vtkObjectBase

Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

getClassName in class vtkActor2D

isA

public int isA(java.lang.String id0)

Description copied from class: vtkObjectBase

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

isA in class vtkActor2D

setNumberOfEntries

public void setNumberOfEntries(int id0)

Specify the number of entries in the legend box.

getNumberOfEntries

public int getNumberOfEntries()

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

setEntry

public void setEntry(int id0,
                     vtkPolyData id1,
                     java.lang.String id2,
                     double[] id3)

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

setEntrySymbol

public void setEntrySymbol(int id0,
                           vtkPolyData id1)

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

setEntryString

public void setEntryString(int id0,
                           java.lang.String id1)

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

setEntryColor

public void setEntryColor(int id0,
                          double[] id1)

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

setEntryColor

public void setEntryColor(int id0,
                          double id1,
                          double id2,
                          double id3)

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

getEntrySymbol

public vtkPolyData getEntrySymbol(int id0)

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

getEntryString

public java.lang.String getEntryString(int id0)

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

getEntryColor

public double[] getEntryColor(int id0)

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

setEntryTextProperty

public void setEntryTextProperty(vtkTextProperty id0)

Set/Get the text property.

getEntryTextProperty

public vtkTextProperty getEntryTextProperty()

Set/Get the text property.

setBorder

public void setBorder(int id0)

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

getBorder

public int getBorder()

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

borderOn

public void borderOn()

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

borderOff

public void borderOff()

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

setLockBorder

public void setLockBorder(int id0)

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.

getLockBorder

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

lockBorderOn

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

lockBorderOff

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

setBox

public void setBox(int id0)

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

getBox

public int getBox()

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

boxOn

public void boxOn()

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

boxOff

public void boxOff()

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

getBoxProperty

public vtkProperty2D getBoxProperty()

Get the box vtkProperty2D.

setPadding

public void setPadding(int id0)

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

getPaddingMinValue

public int getPaddingMinValue()

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

getPaddingMaxValue

public int getPaddingMaxValue()

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

getPadding

public int getPadding()

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

setScalarVisibility

public void setScalarVisibility(int id0)

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.

getScalarVisibility

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

scalarVisibilityOn

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

scalarVisibilityOff

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

shallowCopy

public void shallowCopy(vtkProp id0)

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

Overrides:

shallowCopy in class vtkActor2D

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkActor2D

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkActor2D