Package com.openinventor.ldm.manips

Class SoROIManip

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.inventor.misc.SoBase
com.openinventor.inventor.fields.SoFieldContainer
com.openinventor.inventor.nodes.SoNode
com.openinventor.ldm.nodes.SoROI
com.openinventor.ldm.manips.SoROIManip
All Implemented Interfaces:
SafeDisposable
public class SoROIManip extends SoROI
Manipulator to transform an ROI (Region of Interest). This class defines a manipulator to transform an ROI (Region of Interest). The manipulator is a composite of SoROI and an SoTabBoxDragger that allows the user to interactively move and resize the ROI.

To define a simple ROI, set the limits of the ROI in the SoROI.box field (and do not set the SoROI.subVolume field). The same result is obtained by setting the 'box' and 'subVolume' fields to the same value, but this is not necessary. But note that, like SoROI, the default ROI box is not automatically the full volume. You must initialize the ROI box to something, for example the volume dimensions minus one. See SoROI for more details.

Note: The edge color of the embedded dragger is modified, i.e. is not the same as the default edge color in SoTabBoxDragger.

EXAMPLE 

 // Initialize ROI box to full volume
 SoVolumeData volData = new SoVolumeData();
 . . .
 SoROIManip roiManip = new SoROIManip();
 roiManip.box.setValue( new SbVec3i32(0, 0, 0), volData.data.getSize().minus( new SbVec3i32(1, 1, 1)));
 root.addChild( roiManip );

File format/default:

ROIManip {

    subVolume 0 0 0 0 0 0
    box 0 0 0 1 1 1
    flags 7
    relative false
    boxOn true
    constrained false
}

See Also:

  • Field Details

    • boxOn

      public final SoSFBool boxOn
      Chooses between the 'box' (true) or the 'subVolume' (false) field in the SoROI. Default value is true.

    • constrained

      public final SoSFBool constrained
      Constrains the dragger to fit in the data volume. Default value is false.

  • Constructor Details

    • SoROIManip

      public SoROIManip()
      Constructor.

  • Method Details

    • replaceManip

      public boolean replaceManip(SoPath p, SoROI newOne)
      Replaces the tail of the path, which must be this manipulator, with the given SoROI node. If the path has a nodekit, this will try to use setPart() to insert the new node. Otherwise, the manipulator requires that the next-to-last node in the path chain be a group.

      The field values from the manipulator will be copied to the ROI node, and the manipulator will be replaced.

      It will not make any changes to field connections. The calling process is thus responsible for keeping track of its own nodes and field connections.

    • replaceNode

      public boolean replaceNode(SoPath p)
      Replaces the tail of the path with this manipulator. The tail of the path must be an SoROI node (or subclass thereof). If the path has a nodekit, this will try to use setPart() to insert the manipulator. Otherwise, the manipulator requires that the next-to-last node in the path chain be a group.

      The field values from the ROI node will be copied to this manipulator, and the ROI node will be replaced.

      The old node will disappear if it has no references other than from the input path p and its parent, since this manipulator will be replacing it in both of those places. Nor will the manipulator make any changes to field connections of the old node. The calling process is thus responsible for keeping track of its own nodes and field connections.

    • getDragger

      public SoDragger getDragger()
      Returns the dragger node being employed by this manip.