SoROIManip Class

SoROIManip Class

Manipulator to transform an ROI (Region of Interest).

Inheritance Hierarchy

SystemObject
  OIV.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: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class SoROIManip : SoROI

Public Class SoROIManip
	Inherits SoROI

public ref class SoROIManip : public SoROI

type SoROIManip =  
    class
        inherit SoROI
    end

The SoROIManip type exposes the following members.

Constructors

	Name	Description
	SoROIManip	Constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Overrides SoROICallback(SoCallbackAction).)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Overrides SoROIDoAction(SoAction).)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	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.)
	GetBoundingBox	(Overrides SoROIGetBoundingBox(SoGetBoundingBoxAction).)
	GetDragger	Returns the dragger node being employed by this manip.
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Overrides SoNodeGetMatrix(SoGetMatrixAction).)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetPrimitiveCount	(Inherited from SoNode.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	(Overrides SoROIGLRender(SoGLRenderAction).)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Overrides SoNodeHandleEvent(SoHandleEventAction).)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	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. (Inherited from SoNode.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Overrides SoROIPick(SoPickAction).)
	RayPick	(Inherited from SoNode.)
	ReplaceManip	Replaces the tail of the path, which must be this manipulator, with the given OIV.LDM.Nodes.SoROI node.
	ReplaceNode	Replaces the tail of the path with this manipulator.
	Search	(Overrides SoNodeSearch(SoSearchAction).)
	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. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Overrides SoROIWrite(SoWriteAction).)

Top

Properties

	Name	Description
	box	Specifies the bounds of the region of interest. (Inherited from SoROI.)
	boxOn	Chooses between the 'box' (true) or the 'subVolume' (false) field in the OIV.LDM.Nodes.SoROI.
	constrained	Constrains the dragger to fit in the data volume.
	dataSetId	Specifies which OIV.VolumeViz.Nodes.SoVolumeData node to use. (Inherited from SoROI.)
	flags	Specifies how the bounds of the box are used. (Inherited from SoROI.)
	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). (Inherited from SoROI.)
	subVolume	Specifies the bounds of the subvolume that will be rendered. (Inherited from SoROI.)
	UserData	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
}

Reference

OIV.LDM.Manips Namespace

OIV.LDM.Nodes.SoROI

OIV.Inventor.Draggers.SoDragger

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