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

Class FlyPathAnnotateList.Item

  • Enclosing class:
    FlyPathAnnotateList
    public class FlyPathAnnotateList.Item
extends java.lang.Object
    Single annotation item. Must extend Object in order to be placed into a container.

    • Constructor Summary

      Constructors 
      Constructor Description
      Item​(int iBranch, float fNormalizedPathDist, boolean bPathMoveForward, javax.vecmath.Point3f kPointPosition, javax.vecmath.Vector3f kPointNormal, javax.media.j3d.Shape3D kShape, java.lang.String kDescription)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getBranchIndex()
      Return the index of the branch from which the item was seen and annotated.
      java.lang.String getDescription()
      Return the description associated with the annotated point.
      float getNormalizedPathDist()
      Return the relative distance (in the [0,1] range) along the branch path from which the item was seen and annotated.
      void getPointNormal​(javax.vecmath.Vector3f kPointNormal)
      Return the normal vector for the annotated point.
      void getPointPosition​(javax.vecmath.Point3f kPointPosition)
      Return the 3D coordinates for the annotated point.
      javax.media.j3d.Shape3D getShape()
      Return access to the shape for rendering the annotated point.
      boolean isPathMoveForward()
      Return the flag indicating whether moving was forward, as opposed to in reverse, down the path.
      void setDescription​(java.lang.String kDescription)
      Set the description associated with the annotated point.
      void setShape​(javax.media.j3d.Shape3D kShape)
      Set the shape for rendering the annotated point to that specified.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • m_bPathMoveForward

        private boolean m_bPathMoveForward
        DOCUMENT ME!

      • m_fNormalizedPathDist

        private float m_fNormalizedPathDist
        DOCUMENT ME!

      • m_iBranch

        private int m_iBranch
        DOCUMENT ME!

      • m_kDescription

        private java.lang.String m_kDescription
        DOCUMENT ME!

      • m_kPointNormal

        private javax.vecmath.Vector3f m_kPointNormal
        DOCUMENT ME!

      • m_kPointPosition

        private javax.vecmath.Point3f m_kPointPosition
        DOCUMENT ME!

      • m_kShape

        private javax.media.j3d.Shape3D m_kShape
        DOCUMENT ME!

    • Constructor Detail

      • Item

        Item​(int iBranch,
     float fNormalizedPathDist,
     boolean bPathMoveForward,
     javax.vecmath.Point3f kPointPosition,
     javax.vecmath.Vector3f kPointNormal,
     javax.media.j3d.Shape3D kShape,
     java.lang.String kDescription)
        Constructor. Only the shape and description can be changed once initialized in the constructor, while all other member data cannot be changed once initialized.
        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.
        kShape - Shape3D Instance which contains the geometry and appearance to use for rendering.
        kDescription - String Text description to set.

    • Method Detail

      • getBranchIndex

        public int getBranchIndex()
        Return the index of the branch from which the item was seen and annotated.
        Returns:
        int Index which identifies the branch in the FlyPathGraph.

      • getDescription

        public java.lang.String getDescription()
        Return the description associated with the annotated point.
        Returns:
        String Text description.

      • getNormalizedPathDist

        public float getNormalizedPathDist()
        Return the relative distance (in the [0,1] range) along the branch path from which the item was seen and annotated.
        Returns:
        float

      • getPointNormal

        public void getPointNormal​(javax.vecmath.Vector3f kPointNormal)
        Return the normal vector for the annotated point.
        Parameters:
        kPointNormal - Vector3f Filled in with the normal vector upon return.

      • getPointPosition

        public void getPointPosition​(javax.vecmath.Point3f kPointPosition)
        Return the 3D coordinates for the annotated point.
        Parameters:
        kPointPosition - Point3f Filled in with the 3D coordinates upon return.

      • getShape

        public javax.media.j3d.Shape3D getShape()
        Return access to the shape for rendering the annotated point.
        Returns:
        Shape3D Instance which contains the geometry and appearance to use for rendering.

      • isPathMoveForward

        public boolean isPathMoveForward()
        Return the flag indicating whether moving was forward, as opposed to in reverse, down the path.
        Returns:
        boolean True if moving forward down the path.

      • setDescription

        public void setDescription​(java.lang.String kDescription)
        Set the description associated with the annotated point.
        Parameters:
        kDescription - String Text description to set.

      • setShape

        public void setShape​(javax.media.j3d.Shape3D kShape)
        Set the shape for rendering the annotated point to that specified.
        Parameters:
        kShape - Shape3D Instance which contains the geometry and appearance to use for rendering.