| SoROIManip Class |
Manipulator to transform an ROI (Region of Interest).
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.LDM.NodesSoROI
OIV.LDM.ManipsSoROIManip
Namespace: OIV.LDM.Manips
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 9.9.13.0 (9.9.13.0)
SyntaxThe SoROIManip type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoROIManip | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoROI.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoROI.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoROI.) |
| GetDragger | Returns the dragger node being employed by this manip. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoNode.) |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoROI.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoROI.) |
| RayPick | (Inherited from SoNode.) |
| ReplaceManip | Replaces the tail of the path, which must be this manipulator, with the given SoROI node. |
| ReplaceNode | Replaces the tail of the path with this manipulator. |
| Search | (Inherited from SoNode.) |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoROI.) |
Properties| Name | Description | |
|---|---|---|
 | box | Specifies the bounds of the region of interest. |
| boxOn | Chooses between the box (true) or the subVolume (false) in the SoROI. |
| constrained | Constrains the dragger to fit in the data volume. |
| flags | Specifies how the bounds of the box are used. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| relative | Specifies whether the box bounds are relative to the subvolume or the full volume (i.e., are specified in absolute slice coordinates). |
| subVolume | Specifies the bounds of the subvolume that will be rendered. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis 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 box field (and do not set the 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.
EXAMPLE
SoVolumeData volData = new SoVolumeData(); . . . SoROIManip roiManip = new SoROIManip(); roiManip.box.SetValue( new SbVec3i32(0, 0, 0), volData.data.GetSize() - 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