llnl.visit
Class AnnotationObjectList

java.lang.Object
  extended by llnl.visit.AttributeSubject
      extended by llnl.visit.AnnotationObjectList

public class AnnotationObjectList
extends AttributeSubject


Constructor Summary
AnnotationObjectList()
           
AnnotationObjectList(AnnotationObjectList obj)
           
AnnotationObjectList(int nMoreFields)
           
 
Method Summary
 void AddAnnotation(AnnotationObject obj)
           
 void ClearAnnotations()
           
 boolean equals(AnnotationObjectList obj)
           
 java.util.Vector GetAnnotation()
           
 AnnotationObject GetAnnotation(int i)
           
 AnnotationObject GetAnnotation(java.lang.String name)
          Returned the annotation object with the specified name
 int GetNumAdditionalAttributes()
          Returns the number of attributes added in this level of the state object.
 int GetNumAnnotations()
           
 int Offset()
          Returns the offset into the selected table where this state object's fields begin.
 void ReadAtts(int index, CommunicationBuffer buf)
          Reads the specified index's data from the buffer into the object.
 void RemoveAnnotation(int index)
           
 void SetImageOptions(java.lang.String annotName, java.lang.String filename, double x, double y, double xScale, double yScale, boolean scalesLinked, ColorAttribute transColor, boolean removeTransColor, double opacity, boolean visible)
          Sets the options for the named image annotation object.
 void SetLegendOptions(java.lang.String annotName, boolean managePosition, double x, double y, double scaleX, double scaleY, int numTicks, boolean drawBox, boolean drawLabels, boolean horizontalLegend, boolean alternateText, boolean drawTitle, boolean drawMinMax, boolean controlTicks, boolean minMaxInclusive, boolean drawValues, double fontHeight, ColorAttribute textColor, boolean useForegroundColor, int fontFamily, boolean bold, boolean italic, boolean shadow, boolean visible)
           
 void SetLine2DOptions(java.lang.String annotName, double x0, double y0, double x1, double y1, int lineWidth, int startArrow, int endArrow, ColorAttribute color, boolean useForegroundColor, boolean visible)
          Sets the options for the named 2D line annotation object.
 void SetText2DOptions(java.lang.String annotName, double x, double y, double height, java.lang.String text, ColorAttribute textColor, boolean useForegroundColor, int fontFamily, boolean bold, boolean italic, boolean shadow, boolean visible)
          Sets the options for the named 2D text annotation object.
 void SetText3DOptions(java.lang.String annotName, double x, double y, double z, java.lang.String text, boolean heightMode, double fixedHeight, int relativeHeight, boolean facesCamera, double rotX, double rotY, double rotZ, ColorAttribute textColor, boolean useForegroundColor, boolean visible)
          Sets the options for the named 3D text annotation object.
 void SetTimeSliderOptions(java.lang.String annotName, double x, double y, double width, double height, java.lang.String label, java.lang.String timeFormat, ColorAttribute startColor, ColorAttribute endColor, ColorAttribute textColor, boolean useForegroundColor, int timeDisplay, boolean visible, boolean rounded, boolean shaded)
          Sets the options for the named time slider annotation object.
 java.lang.String toString(java.lang.String indent)
           
 void WriteAtts(CommunicationBuffer buf)
          Writes the selected fields of the object to the buffer.
 
Methods inherited from class llnl.visit.AttributeSubject
Attach, boolToString, Detach, doubleArrayToString, doubleToString, doubleVectorToString, floatArrayToString, floatToString, floatVectorToString, GetAttributeId, GetClassName, intArrayToString, intToString, intVectorToString, IsSelected, Notify, NumAttributes, NumAttributesSelected, Read, Select, SelectAll, SetAttributeId, stringToString, stringVectorToString, toString, ucharArrayToString, ucharToString, ucharVectorToString, UnSelectAll, Write, WriteSelect
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AnnotationObjectList

public AnnotationObjectList()

AnnotationObjectList

public AnnotationObjectList(int nMoreFields)

AnnotationObjectList

public AnnotationObjectList(AnnotationObjectList obj)
Method Detail

Offset

public int Offset()
Description copied from class: AttributeSubject
Returns the offset into the selected table where this state object's fields begin.

Overrides:
Offset in class AttributeSubject
Returns:
An offset into the selected table.

GetNumAdditionalAttributes

public int GetNumAdditionalAttributes()
Description copied from class: AttributeSubject
Returns the number of attributes added in this level of the state object.

Overrides:
GetNumAdditionalAttributes in class AttributeSubject
Returns:
The number of attributes added in this level of the state object.

equals

public boolean equals(AnnotationObjectList obj)

GetAnnotation

public java.util.Vector GetAnnotation()

WriteAtts

public void WriteAtts(CommunicationBuffer buf)
Description copied from class: AttributeSubject
Writes the selected fields of the object to the buffer.

Overrides:
WriteAtts in class AttributeSubject
Parameters:
buf - The communication buffer to which the object will be written.

ReadAtts

public void ReadAtts(int index,
                     CommunicationBuffer buf)
Description copied from class: AttributeSubject
Reads the specified index's data from the buffer into the object.

Specified by:
ReadAtts in class AttributeSubject
buf - The communication buffer to from which the object will be read.

toString

public java.lang.String toString(java.lang.String indent)
Overrides:
toString in class AttributeSubject

AddAnnotation

public void AddAnnotation(AnnotationObject obj)

ClearAnnotations

public void ClearAnnotations()

RemoveAnnotation

public void RemoveAnnotation(int index)

GetNumAnnotations

public int GetNumAnnotations()

GetAnnotation

public AnnotationObject GetAnnotation(int i)

GetAnnotation

public AnnotationObject GetAnnotation(java.lang.String name)
Returned the annotation object with the specified name

Parameters:
name - Name of the annotation object we want to return.
Returns:
The named annotationn object or null.

SetTimeSliderOptions

public void SetTimeSliderOptions(java.lang.String annotName,
                                 double x,
                                 double y,
                                 double width,
                                 double height,
                                 java.lang.String label,
                                 java.lang.String timeFormat,
                                 ColorAttribute startColor,
                                 ColorAttribute endColor,
                                 ColorAttribute textColor,
                                 boolean useForegroundColor,
                                 int timeDisplay,
                                 boolean visible,
                                 boolean rounded,
                                 boolean shaded)
Sets the options for the named time slider annotation object.

Parameters:
annotName - Name of the time slider annotation that we want to modify.
x - X location of the lower left corner in the visualization window [0.,1.]
y - Y location of the lower left corner in the visualization window [0.,1.]
width - Width of the annotation [0.,1.]
height - Height of the annotation [0.,1.]
label - Label to be used in the time slider
timeFormat - C-style format string for the time number, such as "%1.3f"
startColor - Color used for the left progress part of the time slider.
endColor - Color used for the right part of the time slider progress.
textColor - Color used for the text if we're not using the fg color.
useForegroundColor - True to use the foreground color as the text color
timeDisplay - 0=All frames, 1=Frames for plot, 2=States for plot
visible - Whether the annotation is visible.
rounded - Whether the ends of the progress bar are rounded
shaded - Whether the progress bar is shaded

SetText2DOptions

public void SetText2DOptions(java.lang.String annotName,
                             double x,
                             double y,
                             double height,
                             java.lang.String text,
                             ColorAttribute textColor,
                             boolean useForegroundColor,
                             int fontFamily,
                             boolean bold,
                             boolean italic,
                             boolean shadow,
                             boolean visible)
Sets the options for the named 2D text annotation object.

Parameters:
annotName - Name of the text annotation that we want to modify.
x - X location of the lower left corner in the visualization window [0.,1.]
y - Y location of the lower left corner in the visualization window [0.,1.]
height - Height of the annotation [0.,1.]
text - Text to be displayed
textColor - Color used for the text if we're not using the fg color.
useForegroundColor - True to use the foreground color as the text color
fontFamily - 0=Arial, 1=Courier, 2=Times
bold - Whether the font is bold
italic - Whether the font is italic
shadow - Whether the font has a shadow.
visible - Whether the annotation is visible.

SetText3DOptions

public void SetText3DOptions(java.lang.String annotName,
                             double x,
                             double y,
                             double z,
                             java.lang.String text,
                             boolean heightMode,
                             double fixedHeight,
                             int relativeHeight,
                             boolean facesCamera,
                             double rotX,
                             double rotY,
                             double rotZ,
                             ColorAttribute textColor,
                             boolean useForegroundColor,
                             boolean visible)
Sets the options for the named 3D text annotation object.

Parameters:
annotName - Name of the text annotation that we want to modify.
x - X location of the text
y - Y location of the text
z - Z location of the text
text - Text to be displayed
heightMode - 0=relative, 1=fixed
fixedHeight - Height to use when heightMode==0
relativeHeight - Height to use when heightMode==1. Percent of original height [1,100]
facesCamera - Whether the text should face the camera.
rotX - X rotation in degrees.
rotY - Y rotation in degrees.
rotZ - Z rotation in degrees.
textColor - Color used for the text if we're not using the fg color.
useForegroundColor - True to use the foreground color as the text color
visible - Whether the annotation is visible.

SetLine2DOptions

public void SetLine2DOptions(java.lang.String annotName,
                             double x0,
                             double y0,
                             double x1,
                             double y1,
                             int lineWidth,
                             int startArrow,
                             int endArrow,
                             ColorAttribute color,
                             boolean useForegroundColor,
                             boolean visible)
Sets the options for the named 2D line annotation object.

Parameters:
annotName - Name of the text annotation that we want to modify.
x0 - X location of the start point in the visualization window [0.,1.]
y0 - Y location of the start point in the visualization window [0.,1.]
x1 - X location of the end point in the visualization window [0.,1.]
y1 - Y location of the end point in the visualization window [0.,1.]
lineWidth - Width of the line.
startArrow - 0=None, 1=Line, 2=Solid
endArrow - 0=None, 1=Line, 2=Solid
color - Color used for the line if we're not using the fg color.
useForegroundColor - True to use the foreground color as the text color
visible - Whether the annotation is visible.

SetImageOptions

public void SetImageOptions(java.lang.String annotName,
                            java.lang.String filename,
                            double x,
                            double y,
                            double xScale,
                            double yScale,
                            boolean scalesLinked,
                            ColorAttribute transColor,
                            boolean removeTransColor,
                            double opacity,
                            boolean visible)
Sets the options for the named image annotation object.

Parameters:
annotName - Name of the text annotation that we want to modify.
filename - Filename that contains the image.
x - X location of the start point in the visualization window [0.,1.]
y - Y location of the start point in the visualization window [0.,1.]
xScale - X scale.
yScale - Y scale.
scalesLinked - Keeps the scales linked.
transColor - The color to remove from the image so it becomes clear.
removeTransColor - Tells VisIt to remove the transparent color.
opacity - Overal opacity of the image.
visible - Whether the annotation is visible.

SetLegendOptions

public void SetLegendOptions(java.lang.String annotName,
                             boolean managePosition,
                             double x,
                             double y,
                             double scaleX,
                             double scaleY,
                             int numTicks,
                             boolean drawBox,
                             boolean drawLabels,
                             boolean horizontalLegend,
                             boolean alternateText,
                             boolean drawTitle,
                             boolean drawMinMax,
                             boolean controlTicks,
                             boolean minMaxInclusive,
                             boolean drawValues,
                             double fontHeight,
                             ColorAttribute textColor,
                             boolean useForegroundColor,
                             int fontFamily,
                             boolean bold,
                             boolean italic,
                             boolean shadow,
                             boolean visible)