Click or drag to resize
SoROIManip Class

Manipulator to transform an ROI (Region of Interest).

Inheritance Hierarchy

Namespace: OIV.LDM.Manips
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 2024.1.1.0 (2024.1.1)
Syntax
Copy
public class SoROIManip : SoROI

The SoROIManip type exposes the following members.

Constructors
  NameDescription
Public methodSoROIManip

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Overrides SoROICallback(SoCallbackAction).)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Overrides SoROIDoAction(SoAction).)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoROI.)
Public methodGetBoundingBox
(Overrides SoROIGetBoundingBox(SoGetBoundingBoxAction).)
Public methodGetDragger

Returns the dragger node being employed by this manip.

Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Overrides SoNodeGetMatrix(SoGetMatrixAction).)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Overrides SoROIGLRender(SoGLRenderAction).)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Overrides SoNodeHandleEvent(SoHandleEventAction).)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

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.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Overrides SoROIPick(SoPickAction).)
Public methodRayPick
(Inherited from SoNode.)
Public methodReplaceManip

Replaces the tail of the path, which must be this manipulator, with the given OIV.LDM.Nodes.SoROI node.

Public methodReplaceNode

Replaces the tail of the path with this manipulator.

Public methodSearch
(Overrides SoNodeSearch(SoSearchAction).)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Overrides SoROIWrite(SoWriteAction).)
Top
Properties
  NameDescription
Public propertybox

Specifies the bounds of the region of interest.

(Inherited from SoROI.)
Public propertyboxOn

Chooses between the 'box' (true) or the 'subVolume' (false) field in the OIV.LDM.Nodes.SoROI.

Public propertyconstrained

Constrains the dragger to fit in the data volume.

Public propertydataSetId

Specifies which OIV.VolumeViz.Nodes.SoVolumeData node to use.

(Inherited from SoROI.)
Public propertyflags

Specifies how the bounds of the box are used.

(Inherited from SoROI.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyrelative

Specifies whether the box bounds are relative to the subvolume or the full volume (i.e., are specified in absolute slice coordinates).

(Inherited from SoROI.)
Public propertysubVolume

Specifies the bounds of the subvolume that will be rendered.

(Inherited from SoROI.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This class defines a manipulator to transform an ROI (Region of Interest). The manipulator is a composite of OIV.LDM.Nodes.SoROI and an OIV.Inventor.Draggers.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 OIV.LDM.Nodes.SoROI.box field (and do not set the OIV.LDM.Nodes.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 OIV.LDM.Nodes.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 OIV.LDM.Nodes.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 OIV.Inventor.Draggers.SoTabBoxDragger.

EXAMPLE

Copy
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