vtk
Class vtkAxisActor2D

java.lang.Object
  extended byvtk.vtkObjectBase
      extended byvtk.vtkObject
          extended byvtk.vtkProp
              extended byvtk.vtkActor2D
                  extended byvtk.vtkAxisActor2D
All Implemented Interfaces:
java.io.Serializable

public class vtkAxisActor2D
extends vtkActor2D
implements java.io.Serializable

vtkAxisActor2D - Create an axis with tick marks and labels. vtkAxisActor2D creates an axis with tick marks, labels, and/or a title, depending on the particular instance variable settings. vtkAxisActor2D is a 2D actor; that is, it is drawn on the overlay plane and is not occluded by 3D geometry. To use this class, you typically specify two points defining the start and end points of the line (x-y definition using vtkCoordinate class), the number of labels, and the data range (min,max). You can also control what parts of the axis are visible including the line, the tick marks, the labels, and the title. You can also specify the label format (a printf style format). This class decides what font size to use and how to locate the labels. It also decides how to create reasonable tick marks and labels. The number of labels and the range of values may not match the number specified, but should be close. Labels are drawn on the "right" side of the axis. The "right" side is the side of the axis on the right as you move from Position to Position2. The way the labels and title line up with the axis and tick marks depends on whether the line is considered horizontal or vertical. The vtkActor2D instance variables Position and Position2 are instances of vtkCoordinate. Note that the Position2 is an absolute position in that class (it was by default relative to Position in vtkActor2D). What this means is that you can specify the axis in a variety of coordinate systems. Also, the axis does not have to be either horizontal or vertical. The tick marks are created so that they are perpendicular to the axis. Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated to this actor. JavaBean wrapper for vtkAxisActor2D object.

Author:
vtk2jbean Automatic JavaBean wrapper for VTK.
See Also:
vtkAxisActor3D, can, be, used, to, create, axes, in, world, coordinate, space., vtkActor2D, vtkTextMapper, vtkPolyDataMapper2D, vtkScalarBarActor, vtkCoordinate, Serialized Form

Field Summary
protected  java.beans.PropertyChangeSupport changes
           
 
Fields inherited from class vtk.vtkObjectBase
vtkId
 
Constructor Summary
  vtkAxisActor2D()
           
protected vtkAxisActor2D(int dmy)
           
 
Method Summary
 void adjustLabelsOff()
          Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 void adjustLabelsOn()
          Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 void axisVisibilityOff()
          Set/Get visibility of the axis line.
 void axisVisibilityOn()
          Set/Get visibility of the axis line.
 int getAdjustedNumberOfLabels()
          Set/Get the title of the scalar bar actor,
 void getAdjustedRange(double[] id0)
          Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 int getAdjustLabels()
          Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 int getAxisVisibility()
          Set/Get visibility of the axis line.
 java.lang.String getClassName()
          Return the class name as a string.
 double getFontFactor()
          Set/Get the factor that controls the overall size of the fonts used to label and title the axes.
 double getFontFactorMaxValue()
          Set/Get the factor that controls the overall size of the fonts used to label and title the axes.
 double getFontFactorMinValue()
          Set/Get the factor that controls the overall size of the fonts used to label and title the axes.
 double getLabelFactor()
          Set/Get the factor that controls the relative size of the axis labels to the axis title.
 double getLabelFactorMaxValue()
          Set/Get the factor that controls the relative size of the axis labels to the axis title.
 double getLabelFactorMinValue()
          Set/Get the factor that controls the relative size of the axis labels to the axis title.
 java.lang.String getLabelFormat()
          Set/Get the format with which to print the labels on the scalar bar.
 vtkTextProperty getLabelTextProperty()
          Set/Get the labels text property.
 int getLabelVisibility()
          Set/Get visibility of the axis labels.
 int getNumberOfLabels()
          Set/Get the number of annotation labels to show.
 int getNumberOfLabelsMaxValue()
          Set/Get the number of annotation labels to show.
 int getNumberOfLabelsMinValue()
          Set/Get the number of annotation labels to show.
 vtkCoordinate getPoint1Coordinate()
          Specify the position of the first point defining the axis.
 vtkCoordinate getPoint2Coordinate()
          Specify the position of the second point defining the axis.
 double[] getRange()
          Specify the (min,max) axis range.
 vtkAxisActor2D getThisAxisActor2D()
           
 int getTickLength()
          Set/Get the length of the tick marks (expressed in pixels or display coordinates).
 int getTickLengthMaxValue()
          Set/Get the length of the tick marks (expressed in pixels or display coordinates).
 int getTickLengthMinValue()
          Set/Get the length of the tick marks (expressed in pixels or display coordinates).
 int getTickOffset()
          Set/Get the offset of the labels (expressed in pixels or display coordinates).
 int getTickOffsetMaxValue()
          Set/Get the offset of the labels (expressed in pixels or display coordinates).
 int getTickOffsetMinValue()
          Set/Get the offset of the labels (expressed in pixels or display coordinates).
 int getTickVisibility()
          Set/Get visibility of the axis tick marks.
 java.lang.String getTitle()
          Set/Get the title of the scalar bar actor,
 vtkTextProperty getTitleTextProperty()
          Set/Get the title text property.
 int getTitleVisibility()
          Set/Get visibility of the axis title.
 int isA(java.lang.String id0)
          Return 1 if this class is the same type of (or a subclass of) the named class.
 void labelVisibilityOff()
          Set/Get visibility of the axis labels.
 void labelVisibilityOn()
          Set/Get visibility of the axis labels.
 void releaseGraphicsResources(vtkWindow id0)
          Release any graphics resources that are being consumed by this actor.
 int renderOpaqueGeometry(vtkViewport id0)
          Draw the axis.
 int renderOverlay(vtkViewport id0)
          Draw the axis.
 int renderTranslucentGeometry(vtkViewport id0)
          Release any graphics resources that are being consumed by this actor.
 void setAdjustLabels(int id0)
          Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 void setAxisVisibility(int id0)
          Set/Get visibility of the axis line.
 void setFontFactor(double id0)
          Set/Get the factor that controls the overall size of the fonts used to label and title the axes.
 void setLabelFactor(double id0)
          Set/Get the factor that controls the relative size of the axis labels to the axis title.
 void setLabelFormat(java.lang.String id0)
          Set/Get the format with which to print the labels on the scalar bar.
 void setLabelTextProperty(vtkTextProperty id0)
          Set/Get the labels text property.
 void setLabelVisibility(int id0)
          Set/Get visibility of the axis labels.
 void setNumberOfLabels(int id0)
          Set/Get the number of annotation labels to show.
 void setPoint1(double[] id0)
          Specify the position of the first point defining the axis.
 void setPoint1(double id0, double id1)
          Specify the position of the first point defining the axis.
 void setPoint2(double[] id0)
          Specify the position of the second point defining the axis.
 void setPoint2(double id0, double id1)
          Specify the position of the second point defining the axis.
 void setRange(double[] id0)
          Specify the (min,max) axis range.
 void setRange(double id0, double id1)
          Specify the (min,max) axis range.
 void setTickLength(int id0)
          Set/Get the length of the tick marks (expressed in pixels or display coordinates).
 void setTickOffset(int id0)
          Set/Get the offset of the labels (expressed in pixels or display coordinates).
 void setTickVisibility(int id0)
          Set/Get visibility of the axis tick marks.
 void setTitle(java.lang.String id0)
          Set/Get the title of the scalar bar actor,
 void setTitleTextProperty(vtkTextProperty id0)
          Set/Get the title text property.
 void setTitleVisibility(int id0)
          Set/Get visibility of the axis title.
 void shallowCopy(vtkProp id0)
          Shallow copy of an axis actor.
 void tickVisibilityOff()
          Set/Get visibility of the axis tick marks.
 void tickVisibilityOn()
          Set/Get visibility of the axis tick marks.
 void titleVisibilityOff()
          Set/Get visibility of the axis title.
 void titleVisibilityOn()
          Set/Get visibility of the axis title.
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, 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

vtkAxisActor2D

public vtkAxisActor2D()

vtkAxisActor2D

protected vtkAxisActor2D(int dmy)
Method Detail

getThisAxisActor2D

public vtkAxisActor2D getThisAxisActor2D()

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

getPoint1Coordinate

public vtkCoordinate getPoint1Coordinate()
Specify the position of the first point defining the axis. Note: backward compatibility only, use vtkActor2D's Position instead.


setPoint1

public void setPoint1(double[] id0)
Specify the position of the first point defining the axis. Note: backward compatibility only, use vtkActor2D's Position instead.


setPoint1

public void setPoint1(double id0,
                      double id1)
Specify the position of the first point defining the axis. Note: backward compatibility only, use vtkActor2D's Position instead.


getPoint2Coordinate

public vtkCoordinate getPoint2Coordinate()
Specify the position of the second point defining the axis. Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.


setPoint2

public void setPoint2(double[] id0)
Specify the position of the second point defining the axis. Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.


setPoint2

public void setPoint2(double id0,
                      double id1)
Specify the position of the second point defining the axis. Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.


setRange

public void setRange(double id0,
                     double id1)
Specify the (min,max) axis range. This will be used in the generation of labels, if labels are visible.


setRange

public void setRange(double[] id0)
Specify the (min,max) axis range. This will be used in the generation of labels, if labels are visible.


getRange

public double[] getRange()
Specify the (min,max) axis range. This will be used in the generation of labels, if labels are visible.


setNumberOfLabels

public void setNumberOfLabels(int id0)
Set/Get the number of annotation labels to show.


getNumberOfLabelsMinValue

public int getNumberOfLabelsMinValue()
Set/Get the number of annotation labels to show.


getNumberOfLabelsMaxValue

public int getNumberOfLabelsMaxValue()
Set/Get the number of annotation labels to show.


getNumberOfLabels

public int getNumberOfLabels()
Set/Get the number of annotation labels to show.


setLabelFormat

public void setLabelFormat(java.lang.String id0)
Set/Get the format with which to print the labels on the scalar bar.


getLabelFormat

public java.lang.String getLabelFormat()
Set/Get the format with which to print the labels on the scalar bar.


setAdjustLabels

public void setAdjustLabels(int id0)
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.


getAdjustLabels

public int getAdjustLabels()
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.


adjustLabelsOn

public void adjustLabelsOn()
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.


adjustLabelsOff

public void adjustLabelsOff()
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.


getAdjustedRange

public void getAdjustedRange(double[] id0)
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.


getAdjustedNumberOfLabels

public int getAdjustedNumberOfLabels()
Set/Get the title of the scalar bar actor,


setTitle

public void setTitle(java.lang.String id0)
Set/Get the title of the scalar bar actor,


getTitle

public java.lang.String getTitle()
Set/Get the title of the scalar bar actor,


setTitleTextProperty

public void setTitleTextProperty(vtkTextProperty id0)
Set/Get the title text property.


getTitleTextProperty

public vtkTextProperty getTitleTextProperty()
Set/Get the title text property.


setLabelTextProperty

public void setLabelTextProperty(vtkTextProperty id0)
Set/Get the labels text property.


getLabelTextProperty

public vtkTextProperty getLabelTextProperty()
Set/Get the labels text property.


setTickLength

public void setTickLength(int id0)
Set/Get the length of the tick marks (expressed in pixels or display coordinates).


getTickLengthMinValue

public int getTickLengthMinValue()
Set/Get the length of the tick marks (expressed in pixels or display coordinates).


getTickLengthMaxValue

public int getTickLengthMaxValue()
Set/Get the length of the tick marks (expressed in pixels or display coordinates).


getTickLength

public int getTickLength()
Set/Get the length of the tick marks (expressed in pixels or display coordinates).


setTickOffset

public void setTickOffset(int id0)
Set/Get the offset of the labels (expressed in pixels or display coordinates). The offset is the distance of labels from tick marks or other objects.


getTickOffsetMinValue

public int getTickOffsetMinValue()
Set/Get the offset of the labels (expressed in pixels or display coordinates). The offset is the distance of labels from tick marks or other objects.


getTickOffsetMaxValue

public int getTickOffsetMaxValue()
Set/Get the offset of the labels (expressed in pixels or display coordinates). The offset is the distance of labels from tick marks or other objects.


getTickOffset

public int getTickOffset()
Set/Get the offset of the labels (expressed in pixels or display coordinates). The offset is the distance of labels from tick marks or other objects.


setAxisVisibility

public void setAxisVisibility(int id0)
Set/Get visibility of the axis line.


getAxisVisibility

public int getAxisVisibility()
Set/Get visibility of the axis line.


axisVisibilityOn

public void axisVisibilityOn()
Set/Get visibility of the axis line.


axisVisibilityOff

public void axisVisibilityOff()
Set/Get visibility of the axis line.


setTickVisibility

public void setTickVisibility(int id0)
Set/Get visibility of the axis tick marks.


getTickVisibility

public int getTickVisibility()
Set/Get visibility of the axis tick marks.


tickVisibilityOn

public void tickVisibilityOn()
Set/Get visibility of the axis tick marks.


tickVisibilityOff

public void tickVisibilityOff()
Set/Get visibility of the axis tick marks.


setLabelVisibility

public void setLabelVisibility(int id0)
Set/Get visibility of the axis labels.


getLabelVisibility

public int getLabelVisibility()
Set/Get visibility of the axis labels.


labelVisibilityOn

public void labelVisibilityOn()
Set/Get visibility of the axis labels.


labelVisibilityOff

public void labelVisibilityOff()
Set/Get visibility of the axis labels.


setTitleVisibility

public void setTitleVisibility(int id0)
Set/Get visibility of the axis title.


getTitleVisibility

public int getTitleVisibility()
Set/Get visibility of the axis title.


titleVisibilityOn

public void titleVisibilityOn()
Set/Get visibility of the axis title.


titleVisibilityOff

public void titleVisibilityOff()
Set/Get visibility of the axis title.


setFontFactor

public void setFontFactor(double id0)
Set/Get the factor that controls the overall size of the fonts used to label and title the axes. This ivar used in conjunction with the LabelFactor can be used to control font sizes.


getFontFactorMinValue

public double getFontFactorMinValue()
Set/Get the factor that controls the overall size of the fonts used to label and title the axes. This ivar used in conjunction with the LabelFactor can be used to control font sizes.


getFontFactorMaxValue

public double getFontFactorMaxValue()
Set/Get the factor that controls the overall size of the fonts used to label and title the axes. This ivar used in conjunction with the LabelFactor can be used to control font sizes.


getFontFactor

public double getFontFactor()
Set/Get the factor that controls the overall size of the fonts used to label and title the axes. This ivar used in conjunction with the LabelFactor can be used to control font sizes.


setLabelFactor

public void setLabelFactor(double id0)
Set/Get the factor that controls the relative size of the axis labels to the axis title.


getLabelFactorMinValue

public double getLabelFactorMinValue()
Set/Get the factor that controls the relative size of the axis labels to the axis title.


getLabelFactorMaxValue

public double getLabelFactorMaxValue()
Set/Get the factor that controls the relative size of the axis labels to the axis title.


getLabelFactor

public double getLabelFactor()
Set/Get the factor that controls the relative size of the axis labels to the axis title.


renderOverlay

public int renderOverlay(vtkViewport id0)
Draw the axis.

Overrides:
renderOverlay in class vtkActor2D

renderOpaqueGeometry

public int renderOpaqueGeometry(vtkViewport id0)
Draw the axis.

Overrides:
renderOpaqueGeometry in class vtkActor2D

renderTranslucentGeometry

public int renderTranslucentGeometry(vtkViewport id0)
Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Overrides:
renderTranslucentGeometry in class vtkActor2D

releaseGraphicsResources

public void releaseGraphicsResources(vtkWindow id0)
Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Overrides:
releaseGraphicsResources in class vtkActor2D

shallowCopy

public void shallowCopy(vtkProp id0)
Shallow copy of an axis 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


Copyright © 2004 Sydney ViSLAB. All Rights Reserved.