Package gov.nih.mipav.view.renderer.J3D.surfaceview.flythruview

Class FlyPathAnnotateList

java.lang.Object
gov.nih.mipav.view.renderer.J3D.surfaceview.flythruview.FlyPathAnnotateList
public class FlyPathAnnotateList extends Object
Container which stores annotations which include the following: - point position and normal - branch and location along branch when point annotated - geometry and appearance - description.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    FlyPathAnnotateList.Item
    Single annotation item.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    m_iNextItemKey
    DOCUMENT ME!
    protected javax.media.j3d.Shape3D
    m_kDefaultShape
    DOCUMENT ME!
    protected ArrayList<FlyPathAnnotateList.Item>
    m_kList
    DOCUMENT ME!

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlyPathAnnotateList()
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addItem(int iBranch, float fNormalizedPathDist, boolean bPathMoveForward, javax.vecmath.Point3f kPointPosition, javax.vecmath.Vector3f kPointNormal)
    Create a new annotation item with the specified information and add the item to the end of the list.
    void
    addItem(FlyPathAnnotateList.Item kNewItem)
    Add the specified annotation item to the end of the list.
    javax.media.j3d.Shape3D
    getDefaultShape()
    Return access to the default shape to use for rendering all subsequent annotated items.
    FlyPathAnnotateList.Item
    getItem(int iItem)
    Return the specified annotation item.
    int
    getNumItems()
    Return the number of annotation items stored.
    void
    removeItem(int iItem)
    Remove the specified annotation item from the list.
    void
    setDefaultShape(javax.media.j3d.Shape3D kShape)
    Set the default shape for rendering all subsequent annotated items to that specified.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • m_iNextItemKey

      protected int m_iNextItemKey
      DOCUMENT ME!

    • m_kDefaultShape

      protected javax.media.j3d.Shape3D m_kDefaultShape
      DOCUMENT ME!

    • m_kList

      protected ArrayList<FlyPathAnnotateList.Item> m_kList
      DOCUMENT ME!

  • Constructor Details

    • FlyPathAnnotateList

      public FlyPathAnnotateList()
      Constructor. Initially an empty list.

  • Method Details

    • addItem

      public void addItem(FlyPathAnnotateList.Item kNewItem)
      Add the specified annotation item to the end of the list.
      Parameters:
      kNewItem - Item Information about the annotation item to be added.

    • addItem

      public void addItem(int iBranch, float fNormalizedPathDist, boolean bPathMoveForward, javax.vecmath.Point3f kPointPosition, javax.vecmath.Vector3f kPointNormal)
      Create a new annotation item with the specified information and add the item to the end of the list. Set the item's appearance and geometry based on the defaults. Generate a description for the item based on the number of items inserted already.
      Parameters:
      iBranch - int Index of branch from which the item was seen and annotated.
      fNormalizedPathDist - float Relative distance along the branch (in the [0,1] range) from which the item was seen and annotated.
      bPathMoveForward - boolean Flag set if the moving forward, as opposed to in reverse, down the path.
      kPointPosition - Point3f Coordinates of the annotated point.
      kPointNormal - Vector3f Normal vector associated with the annotated point.

    • getDefaultShape

      public javax.media.j3d.Shape3D getDefaultShape()
      Return access to the default shape to use for rendering all subsequent annotated items.
      Returns:
      Shape3D Instance which contains the geometry and appearance to use for rendering.

    • getItem

      public FlyPathAnnotateList.Item getItem(int iItem)
      Return the specified annotation item.
      Parameters:
      iItem - int Index of the specified item.
      Returns:
      Item Information about the annotation item.

    • getNumItems

      public int getNumItems()
      Return the number of annotation items stored.
      Returns:
      int Number of annotation items.

    • removeItem

      public void removeItem(int iItem)
      Remove the specified annotation item from the list.
      Parameters:
      iItem - int Index of the annotation item in the list to be removed.

    • setDefaultShape

      public void setDefaultShape(javax.media.j3d.Shape3D kShape)
      Set the default shape for rendering all subsequent annotated items to that specified.
      Parameters:
      kShape - Shape3D Instance which contains the geometry and appearance to use for rendering.