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

Class RegularProbe

  • public class RegularProbe
extends java.lang.Object

    Title: RegualorProbe

    Description: Regular probe has its own geometry and type of burning. This class builds the geometry shape of the regular probe.

    Author:
    Ruida Cheng

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) javax.vecmath.Color3f ambientColor
      Attenuation lighting setup.
      private javax.media.j3d.Appearance appTip
      DOCUMENT ME!
      private com.sun.j3d.utils.geometry.Cone coneIndicator
      Indicator probe cone shape.
      private javax.media.j3d.TransformGroup coneIndicatorTG
      Tranformgroup of the indicator cone shape.
      private com.sun.j3d.utils.geometry.Cone coneTip
      Cone geometry shape part of the regular probe.
      private javax.media.j3d.TransformGroup coneTipTG
      The probe tip cone geometry shape.
      private com.sun.j3d.utils.geometry.Cylinder cylinderIndicator
      Indicator probe cylinder shape.
      private javax.media.j3d.TransformGroup cylinderIndicatorTG
      Transformgroup of the indicator cylinder shape.
      private com.sun.j3d.utils.geometry.Cylinder cylinderTip
      Cylinder geometry shape part of the regular probe.
      private javax.media.j3d.TransformGroup cylinderTipTG
      The probe tip cylinder geometry shape.
      (package private) javax.vecmath.Color3f diffuseColor
      DOCUMENT ME!
      (package private) javax.vecmath.Color3f emissiveColor
      DOCUMENT ME!
      (package private) javax.vecmath.Color3f green
      The indicator probe's green color.
      private javax.media.j3d.BranchGroup indicatorProbeBG
      Indicator probe branch group.
      protected com.sun.j3d.utils.picking.PickCanvas pickCanvas
      Agent to set the regular probe pickable.
      private javax.media.j3d.TransformGroup regularProbe
      The root transform group the the regular probe.
      private javax.media.j3d.BranchGroup regularProbeBG
      Regular probe branch group.
      (package private) javax.vecmath.Color3f sepcualarColor
      DOCUMENT ME!
      private javax.media.j3d.Switch switchGroup
      The switch group that switch between regular probe and indicator probe.
      (package private) javax.vecmath.Color3f yellow
      The regular probe's gray color.
      private float yOrigin
      Y original coordinate value.

    • Constructor Summary

      Constructors 
      Constructor Description
      RegularProbe()
      Constructor to build the regular probe geometry shape.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void enableEntryPointRotation​(boolean flag)
      Enable the probe to rotate around the entry point.
      protected boolean findProbe​(javax.media.j3d.Shape3D pickedShape)
      Check whether the probe being picked or not.
      javax.media.j3d.TransformGroup getProbe()
      Get the root transform group of the regular probe.
      protected void init()
      Initialize the regular probe geometry shape.
      protected void setProbeCoordinate​(float value)
      Set the probe translation in the local coordinate system.
      protected void setProbeGreenColor​(boolean flag)
      Switch the default probe between color cyan and color green.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • pickCanvas

        protected com.sun.j3d.utils.picking.PickCanvas pickCanvas
        Agent to set the regular probe pickable.

      • ambientColor

        javax.vecmath.Color3f ambientColor
        Attenuation lighting setup.

      • diffuseColor

        javax.vecmath.Color3f diffuseColor
        DOCUMENT ME!

      • emissiveColor

        javax.vecmath.Color3f emissiveColor
        DOCUMENT ME!

      • green

        javax.vecmath.Color3f green
        The indicator probe's green color.

      • sepcualarColor

        javax.vecmath.Color3f sepcualarColor
        DOCUMENT ME!

      • yellow

        javax.vecmath.Color3f yellow
        The regular probe's gray color.

      • appTip

        private javax.media.j3d.Appearance appTip
        DOCUMENT ME!

      • coneIndicator

        private com.sun.j3d.utils.geometry.Cone coneIndicator
        Indicator probe cone shape.

      • coneIndicatorTG

        private javax.media.j3d.TransformGroup coneIndicatorTG
        Tranformgroup of the indicator cone shape.

      • coneTip

        private com.sun.j3d.utils.geometry.Cone coneTip
        Cone geometry shape part of the regular probe.

      • coneTipTG

        private javax.media.j3d.TransformGroup coneTipTG
        The probe tip cone geometry shape.

      • cylinderIndicator

        private com.sun.j3d.utils.geometry.Cylinder cylinderIndicator
        Indicator probe cylinder shape.

      • cylinderIndicatorTG

        private javax.media.j3d.TransformGroup cylinderIndicatorTG
        Transformgroup of the indicator cylinder shape.

      • cylinderTip

        private com.sun.j3d.utils.geometry.Cylinder cylinderTip
        Cylinder geometry shape part of the regular probe.

      • cylinderTipTG

        private javax.media.j3d.TransformGroup cylinderTipTG
        The probe tip cylinder geometry shape.

      • indicatorProbeBG

        private javax.media.j3d.BranchGroup indicatorProbeBG
        Indicator probe branch group.

      • regularProbe

        private javax.media.j3d.TransformGroup regularProbe
        The root transform group the the regular probe.

      • regularProbeBG

        private javax.media.j3d.BranchGroup regularProbeBG
        Regular probe branch group.

      • switchGroup

        private javax.media.j3d.Switch switchGroup
        The switch group that switch between regular probe and indicator probe.

      • yOrigin

        private float yOrigin
        Y original coordinate value.

    • Constructor Detail

      • RegularProbe

        public RegularProbe()
        Constructor to build the regular probe geometry shape.

    • Method Detail

      • enableEntryPointRotation

        public void enableEntryPointRotation​(boolean flag)
        Enable the probe to rotate around the entry point.
        Parameters:
        flag - boolean true means around the entry point, false around the origin.

      • getProbe

        public javax.media.j3d.TransformGroup getProbe()
        Get the root transform group of the regular probe.
        Returns:
        TransformGroup the root of the regular probe.

      • findProbe

        protected boolean findProbe​(javax.media.j3d.Shape3D pickedShape)
        Check whether the probe being picked or not.
        Parameters:
        pickedShape - picked geometry shape.
        Returns:
        boolean true probe picked, false probe not picked.

      • init

        protected void init()
        Initialize the regular probe geometry shape.

      • setProbeCoordinate

        protected void setProbeCoordinate​(float value)
        Set the probe translation in the local coordinate system.
        Parameters:
        value - y coordinate value of the local coordinate system.

      • setProbeGreenColor

        protected void setProbeGreenColor​(boolean flag)
        Switch the default probe between color cyan and color green.
        Parameters:
        flag - boolean true green color, false gray color.