Package gov.nih.mipav.view.renderer.WildMagic.flythroughview

Class FlyPathAnnotateList_WM.Item

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean m_bPathMoveForward
      Annotation flag indicating whether moving was forward
      private float m_fNormalizedPathDist
      Annotation relative distance (in the [0,1] range) along the branch path
      private int m_iBranch
      Annotation branch index
      private WildMagic.LibFoundation.Mathematics.Vector3f m_kCameraDVector
      Camera direction vector at Annotation point.
      private WildMagic.LibFoundation.Mathematics.Vector3f m_kCameraLocation
      Camera location at Annotation point.
      private WildMagic.LibFoundation.Mathematics.Vector3f m_kCameraRVector
      Camera right vector at Annotation point.
      private WildMagic.LibFoundation.Mathematics.Vector3f m_kCameraUVector
      Camera up vector at Annotation point.
      private java.lang.String m_kDescription
      Annotation description
      private WildMagic.LibFoundation.Mathematics.Vector3f m_kPointNormal
      Normal vector for the annotated point
      private WildMagic.LibFoundation.Mathematics.Vector3f m_kPointPosition
      3D coordinates for the annotated point

    • Constructor Summary

      Constructors 
      Constructor Description
      Item​(int iBranch, float fNormalizedPathDist, boolean bPathMoveForward, WildMagic.LibFoundation.Mathematics.Vector3f kPointPosition, WildMagic.LibFoundation.Mathematics.Vector3f kPointNormal, WildMagic.LibFoundation.Mathematics.Vector3f kCLoc, WildMagic.LibFoundation.Mathematics.Vector3f kCDir, WildMagic.LibFoundation.Mathematics.Vector3f kCUp, WildMagic.LibFoundation.Mathematics.Vector3f kCRight, 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.
      WildMagic.LibFoundation.Mathematics.Vector3f getCameraDirection()
      Return the Camera direction vector at the Annotation point.
      WildMagic.LibFoundation.Mathematics.Vector3f getCameraLocation()
      Return the Camera 3D position at the Annotation point.
      WildMagic.LibFoundation.Mathematics.Vector3f getCameraRight()
      Return the Camera right vector at the Annotation point.
      WildMagic.LibFoundation.Mathematics.Vector3f getCameraUp()
      Return the Camera up vector at the Annotation point.
      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​(WildMagic.LibFoundation.Mathematics.Vector3f kPointNormal)
      Return the normal vector for the annotated point.
      void getPointPosition​(WildMagic.LibFoundation.Mathematics.Vector3f kPointPosition)
      Return the 3D coordinates for 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.

      • 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
        Annotation flag indicating whether moving was forward

      • m_fNormalizedPathDist

        private float m_fNormalizedPathDist
        Annotation relative distance (in the [0,1] range) along the branch path

      • m_iBranch

        private int m_iBranch
        Annotation branch index

      • m_kDescription

        private java.lang.String m_kDescription
        Annotation description

      • m_kPointNormal

        private WildMagic.LibFoundation.Mathematics.Vector3f m_kPointNormal
        Normal vector for the annotated point

      • m_kPointPosition

        private WildMagic.LibFoundation.Mathematics.Vector3f m_kPointPosition
        3D coordinates for the annotated point

      • m_kCameraLocation

        private WildMagic.LibFoundation.Mathematics.Vector3f m_kCameraLocation
        Camera location at Annotation point.

      • m_kCameraDVector

        private WildMagic.LibFoundation.Mathematics.Vector3f m_kCameraDVector
        Camera direction vector at Annotation point.

      • m_kCameraUVector

        private WildMagic.LibFoundation.Mathematics.Vector3f m_kCameraUVector
        Camera up vector at Annotation point.

      • m_kCameraRVector

        private WildMagic.LibFoundation.Mathematics.Vector3f m_kCameraRVector
        Camera right vector at Annotation point.

    • Constructor Detail

      • Item

        Item​(int iBranch,
     float fNormalizedPathDist,
     boolean bPathMoveForward,
     WildMagic.LibFoundation.Mathematics.Vector3f kPointPosition,
     WildMagic.LibFoundation.Mathematics.Vector3f kPointNormal,
     WildMagic.LibFoundation.Mathematics.Vector3f kCLoc,
     WildMagic.LibFoundation.Mathematics.Vector3f kCDir,
     WildMagic.LibFoundation.Mathematics.Vector3f kCUp,
     WildMagic.LibFoundation.Mathematics.Vector3f kCRight,
     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.
        kDescription - String Text description to set.
        kCLoc - Camera location.
        kCDir - Camera view direction.
        kCUp - Camera up vector.
        kCRight - Camera right vector.

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

      • getCameraDirection

        public WildMagic.LibFoundation.Mathematics.Vector3f getCameraDirection()
        Return the Camera direction vector at the Annotation point.
        Returns:
        Camera direction vector at the Annotation point

      • getCameraLocation

        public WildMagic.LibFoundation.Mathematics.Vector3f getCameraLocation()
        Return the Camera 3D position at the Annotation point.
        Returns:
        Camera 3D position at the Annotation point

      • getCameraRight

        public WildMagic.LibFoundation.Mathematics.Vector3f getCameraRight()
        Return the Camera right vector at the Annotation point.
        Returns:
        Camera right vector at the Annotation point

      • getCameraUp

        public WildMagic.LibFoundation.Mathematics.Vector3f getCameraUp()
        Return the Camera up vector at the Annotation point.
        Returns:
        Camera up vector at the Annotation point

      • 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​(WildMagic.LibFoundation.Mathematics.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​(WildMagic.LibFoundation.Mathematics.Vector3f kPointPosition)
        Return the 3D coordinates for the annotated point.
        Parameters:
        kPointPosition - Point3f Filled in with the 3D coordinates upon return.

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