SoOrthoSliceDragger Class

Object that moves an OIV.VolumeViz.Nodes.SoOrthoSlice by dragging with the mouse.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodekitsSoBaseKit
              OIV.Inventor.NodekitsSoInteractionKit
                OIV.Inventor.DraggersSoDragger
                  OIV.Inventor.DraggersSoTranslate1Dragger
                    OIV.VolumeViz.DraggersSoOrthoSliceDragger

Namespace: OIV.VolumeViz.Draggers
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class SoOrthoSliceDragger : SoTranslate1Dragger

Public Class SoOrthoSliceDragger
	Inherits SoTranslate1Dragger

public ref class SoOrthoSliceDragger : public SoTranslate1Dragger

type SoOrthoSliceDragger =  
    class
        inherit SoTranslate1Dragger
    end

The SoOrthoSliceDragger type exposes the following members.

Constructors

	Name	Description
	SoOrthoSliceDragger	Constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Inherited from SoBaseKit.)
	ClearOtherEventCallbacks	(Inherited from SoDragger.)
	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.)
	CreatePathToPart(String, Boolean)	Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.)
	CreatePathToPart(String, Boolean, SoPath)	Returns a path that begins at this nodekit and ends at partName. (Inherited from SoBaseKit.)
	CreatePathToThis	(Inherited from SoDragger.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Inherited from SoBaseKit.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	EnableValueChangedEvent	You can temporarily disable a dragger's valueChangedCallbacks. (Inherited from SoDragger.)
	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 SoNode.)
	GetBoundingBox	(Inherited from SoBaseKit.)
	GetClassNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.
	GetEvent	(Inherited from SoDragger.)
	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.)
	GetHandleEventAction	(Inherited from SoDragger.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetLocalStartingPoint	(Inherited from SoDragger.)
	GetLocalToWorldMatrix	Calls GetLocalToWorldMatrix((OIV.Inventor.Actions.SoAction ^)nullptr). (Inherited from SoDragger.)
	GetLocalToWorldMatrix(SoAction)	(Inherited from SoDragger.)
	GetMatrix	(Inherited from SoBaseKit.)
	GetMinGesture	Gets the number of pixels of movement required to initiate a constraint gesture. (Inherited from SoDragger.)
	GetMinGestureFloat	Float version of OIV.Inventor.Draggers.SoDragger.GetMinGesture(). (Inherited from SoDragger.)
	GetMotionMatrix	Get the motion matrix. (Inherited from SoDragger.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. (Inherited from SoBaseKit.)
	GetPart	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. (Inherited from SoBaseKit.)
	GetPartString	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. (Inherited from SoBaseKit.)
	GetPartToLocalMatrix	(Inherited from SoDragger.)
	GetPickPath	(Inherited from SoDragger.)
	GetPrimitiveCount	(Inherited from SoBaseKit.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStartMotionMatrix	(Inherited from SoDragger.)
	GetStringName	(Inherited from SoBase.)
	GetSurrogatePartPickedName	(Inherited from SoDragger.)
	GetSurrogatePartPickedOwner	(Inherited from SoDragger.)
	GetSurrogatePartPickedPath	(Inherited from SoDragger.)
	GetTrackerDirectMode	Get the current tracker direct mode for this dragger. (Inherited from SoDragger.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetViewportIsEnabled	(Inherited from SoBaseKit.)
	GetViewportOrigin	(Inherited from SoBaseKit.)
	GetViewportRegion	Obsolete. (Inherited from SoDragger.)
	GetViewportSize	(Inherited from SoBaseKit.)
	GetViewVolume	Obsolete. Dragger must not store information related to viewer settings. (Inherited from SoDragger.)
	GetWorldStartingPoint	(Inherited from SoDragger.)
	GetWorldToLocalMatrix	Calls GetWorldToLocalMatrix((OIV.Inventor.Actions.SoAction ^)nullptr). (Inherited from SoDragger.)
	GetWorldToLocalMatrix(SoAction)	(Inherited from SoDragger.)
	GLRender	(Inherited from SoBaseKit.)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoBaseKit.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	InvokeValueChanged	(Inherited from SoDragger.)
	IsBoundingBoxIgnoring	Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. (Inherited from SoBaseKit.)
	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.)
	IsPathSurrogateInMySubgraph(SoPath)	(Inherited from SoInteractionKit.)
	IsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath)	Calls IsPathSurrogateInMySubgraph(pathToCheck, pathToOwner, surrogateNameInOwner, surrogatePathInOwner, true). (Inherited from SoInteractionKit.)
	IsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath, Boolean)	(Inherited from SoInteractionKit.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	IsTrackerDirectMode	(Inherited from SoDragger.)
	Pick	(Inherited from SoNode.)
	RayPick	(Inherited from SoBaseKit.)
	RegisterChildDragger	(Inherited from SoDragger.)
	RegisterChildDraggerMovingIndependently	(Inherited from SoDragger.)
	SaveStartParameters	(Inherited from SoDragger.)
	Search	(Inherited from SoBaseKit.)
	Set(String)	This function allows field values of parts (nodes) to be set in several different parts simultaneously. (Inherited from SoBaseKit.)
	Set(String, String)	This function allows field values of parts (nodes) to be set. (Inherited from SoBaseKit.)
	SetHandleEventAction	(Inherited from SoDragger.)
	SetMinGesture(Int32)	Sets the number of pixels of movement required to initiate a constraint gesture. (Inherited from SoDragger.)
	SetMinGesture(Single)	Float version of OIV.Inventor.Draggers.SoDragger.SetMinGesture(System.Int32). (Inherited from SoDragger.)
	SetMotionMatrix	Set the motion matrix. (Inherited from SoDragger.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetPart	Inserts the given node (not a copy) as the new part specified by partName. (Inherited from SoBaseKit.)
	SetPartAsDefault(String, SoNode)	Calls SetPartAsDefault(partName, newNode, true). (Inherited from SoInteractionKit.)
	SetPartAsDefault(String, String)	Calls SetPartAsDefault(partName, newNodeName, true). (Inherited from SoInteractionKit.)
	SetPartAsDefault(String, SoNode, Boolean)	(Inherited from SoInteractionKit.)
	SetPartAsDefault(String, String, Boolean)	(Inherited from SoInteractionKit.)
	SetPartAsPath	Sets any public part in the interaction kit as a "surrogate" path instead. (Inherited from SoInteractionKit.)
	SetStartingPoint(SbVec3f)	(Inherited from SoDragger.)
	SetStartingPoint(SoPickedPoint)	(Inherited from SoDragger.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetTempPathToThis	(Inherited from SoDragger.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	SetTrackerDirectMode	Calls SetTrackerDirectMode(OIV.Inventor.Draggers.SoDragger.TrackerDirectModes( .SoDragger.DEFAULT )). (Inherited from SoDragger.)
	SetTrackerDirectMode(SoDraggerTrackerDirectModes)	Sets the tracker direct mode for this dragger (see description above). (Inherited from SoDragger.)
	SetViewportRegion	Obsolete. (Inherited from SoDragger.)
	SetViewVolume	Obsolete. (Inherited from SoDragger.)
	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.)
	TransformMatrixLocalToWorld	(Inherited from SoDragger.)
	TransformMatrixToLocalSpace	(Inherited from SoDragger.)
	TransformMatrixWorldToLocal	(Inherited from SoDragger.)
	UnregisterChildDragger	(Inherited from SoDragger.)
	UnregisterChildDraggerMovingIndependently	(Inherited from SoDragger.)
	WorkFieldsIntoTransform	(Inherited from SoDragger.)
	Write	(Inherited from SoBaseKit.)

Top

Properties

	Name	Description
	boundingBoxCaching	(Inherited from SoInteractionKit.)
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	enableCallbacks	If set to false, motion, start and finish callbacks are disabled. (Inherited from SoDragger.)
	enableHighlight	Enables highlighting.
	highlightColor
	isActive	true when mouse is down and dragging, else false. (Inherited from SoDragger.)
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	orthoSlicePath	Path to the OIV.VolumeViz.Nodes.SoOrthoSlice node to drag.
	pickCulling	Set pick caching mode. (Inherited from SoInteractionKit.)
	renderCaching	Obsolete. Set render caching mode. (Inherited from SoInteractionKit.)
	renderCulling	Set render culling mode. (Inherited from SoInteractionKit.)
	translation	Position of the dragger. (Inherited from SoTranslate1Dragger.)
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	volumeDimension	Obsolete. Dimension of the volume.
	volumeExtent	Obsolete. Extent of the volume.

Top

Events

	Name	Description
	FinishDragging	(Inherited from SoDragger.)
	MouseMove	(Inherited from SoDragger.)
	StartDragging	(Inherited from SoDragger.)
	ValueChanged	(Inherited from SoDragger.)

Top

Remarks

OIV.VolumeViz.Draggers.SoOrthoSliceDragger is derived from OIV.Inventor.Draggers.SoTranslate1Dragger and has similar behavior, but is specifically designed to allow direct manipulation of an OIV.VolumeViz.Nodes.SoOrthoSlice. The difference is that this class uses the actual geometry of the ortho slice to detect mouse clicks and automatically updates the slice's OIV.VolumeViz.Nodes.SoOrthoSlice.sliceNumber field as the dragger is moved. Conversely the dragger updates itself if the slice's axis or sliceNumber fields are changed by the application.

The dragger will not do anything until the field OIV.VolumeViz.Draggers.SoOrthoSliceDragger.orthoSlicePath has been set. The path can be a partial path, i.e. it does not need to start at the root of the scene graph. However, it must include the OIV.VolumeViz.Nodes.SoOrthoSlice node.

The dragger always sets its "translator" part to be the actual ortho slice node. When the dragger is created it sets its "translatorActive" part to be an empty Separator. You can reset this to something else. You can attach callbacks to this dragger in the usual way.

If the camera faces the slice (i.e. the orientation of the slice and the camera are exactly the same), the dragger will automatically change its orientation to another axis so that it can be manipulated (otherwise it can't). When the dragger itself is displayed, this behaviour may be surprising, and it can be disabled by setting the OIV.Inventor.SoPreferences value IVVR_ENABLE_ORTHOSLICE_DRAGGER_AXIS_SWITCH to false.

EXAMPLE

Copy

SoSeparator volSep = new SoSeparator();
root.AddChild(volSep);

SoVolumeData volData = new SoVolumeData();
volSep.AddChild( volData );

SoOrthoSlice orthoSlice = new SoOrthoSlice();
volSep.AddChild( orthoSlice );

SoPath path = new SoPath(volSep);
path.Append( orthoSlice );

SoOrthoSliceDragger dragger   = new SoOrthoSliceDragger();
dragger.orthoSlicePath.Value  = path;
volSep.AddChild(dragger);

FILE FORMAT/DEFAULT

OrthoSliceDragger {
orthoSlicePath NULL
volumeDimension 0 0 0
volumeExtent 0 0 0
enableHighlight true
highlightColor 1.0 1.0 0
}

Reference

OIV.VolumeViz.Draggers Namespace

OIV.Inventor.Draggers.SoDragger

OIV.Inventor.Draggers.SoTranslate1Dragger

OIV.VolumeViz.Nodes.SoOrthoSlice

orthoSlicePath	NULL
volumeDimension	0 0 0
volumeExtent	0 0 0
enableHighlight	true
highlightColor	1.0 1.0 0