Object that moves an SoOrthoSlice by dragging with the mouse. More...

#include <VolumeViz/draggers/SoOrthoSliceDragger.h>

Inheritance diagram for SoOrthoSliceDragger:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance.

	SoOrthoSliceDragger ()
	Constructor.

Public Member Functions inherited from SoTranslate1Dragger
	SoTranslate1Dragger ()
	Constructor.

Public Member Functions inherited from SoDragger
void	addStartCallback (SoDraggerCB f, void userData=NULL)
	Adds start callback.

void	removeStartCallback (SoDraggerCB f, void userData=NULL)
	Removes start callback.

void	addMotionCallback (SoDraggerCB f, void userData=NULL)
	Adds motion callback.

void	removeMotionCallback (SoDraggerCB f, void userData=NULL)
	Removes motion callback.

void	addFinishCallback (SoDraggerCB f, void userData=NULL)
	Adds finish callback.

void	removeFinishCallback (SoDraggerCB f, void userData=NULL)
	Removes finish callback.

void	addValueChangedCallback (SoDraggerCB f, void userData=NULL)
	Adds value-changed callback.

void	removeValueChangedCallback (SoDraggerCB f, void userData=NULL)
	Removes value-changed callback.

void	setMinGesture (int pixels)
	Sets the number of pixels of movement required to initiate a constraint gesture.

void	setMinGesture (float pixels)
	Float version of setMinGesture.

int	getMinGesture () const
	Gets the number of pixels of movement required to initiate a constraint gesture.

float	getMinGestureFloat () const
	Float version of getMinGesture.

SbBool	enableValueChangedCallbacks (SbBool newVal)
	You can temporarily disable a dragger's valueChangedCallbacks.

void	setTrackerDirectMode (TrackerDirectMode mode=DEFAULT)
	Sets the tracker direct mode for this dragger (see description above).

TrackerDirectMode	getTrackerDirectMode () const
	Get the current tracker direct mode for this dragger.

void	setMotionMatrix (const SbMatrix &newMatrix)
	Set the motion matrix.

const SbMatrix &	getMotionMatrix ()
	Get the motion matrix.

Public Member Functions inherited from SoInteractionKit
virtual SbBool	setPartAsPath (const SbName &partName, SoPath *surrogatePath)
	Sets any public part in the interaction kit as a "surrogate" path instead.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

Public Member Functions inherited from SoBaseKit
	SoBaseKit ()
	Constructor.

virtual SoNode *	getPart (const SbName &partName, SbBool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

template<typename PartType >
PartType *	getPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.

template<typename PartType >
PartType *	checkPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.

SbString	getPartString (const SoBase *part)
	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.

virtual SoNodeKitPath *	createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.

virtual SbBool	setPart (const SbName &partName, SoNode *newPart)
	Inserts the given node (not a copy) as the new part specified by partName.

SoNONUNICODE SbBool	set (char *nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SbBool	set (const SbString &nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SoNONUNICODE SbBool	set (const char partNameString, const char parameterString)
	This function allows field values of parts (nodes) to be set.

SbBool	set (const SbString &partNameString, const SbString &parameterString)
	This function allows field values of parts (nodes) to be set.

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	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.

SbBool	set (const SbString &fieldDataString)
	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.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Public Member Functions inherited from SoGetView
	SoGetView ()
	Default constructor.

virtual	~SoGetView ()

virtual SbBool	getViewportIsEnabled () const
	Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.

virtual const SbVec2f	getViewportOrigin () const
	Returns SbViewportRegion origin.

virtual const SbVec2f	getViewportSize () const
	Returns SbViewportRegion size.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from SoTranslate1Dragger
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from SoDragger
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

static void	setMinScale (float newMinScale)
	Sets the smallest scale that any dragger will write.

static float	getMinScale ()
	Gets the smallest scale that any dragger will write.

static void	setInitialTrackerDirectMode (TrackerDirectMode mode=DEFAULT)
	Set the initial tracker direct mode for draggers not yet created.

static TrackerDirectMode	getInitialTrackerDirectMode ()
	Get the initial tracker direct mode.

Static Public Member Functions inherited from SoInteractionKit
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from SoBaseKit
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.

static void	setSearchingChildren (SbBool newVal)
	Sets if nodekit children are searched during SoSearchAction traversal.

static SbBool	isSearchingChildren ()
	Returns TRUE if nodekit children are searched during SoSearchAction traversal.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFPath	orthoSlicePath
	Path to the SoOrthoSlice node to drag.

SoSFColor	highlightColor
	Specifies the highlight color.

SoSFBool	enableHighlight
	Enables highlighting.

Deprecated

SoDEPRECATED SoSFVec3i32	volumeDimension
	Dimension of the volume.

SoDEPRECATED SoSFBox3f	volumeExtent
	Extent of the volume.

Public Attributes inherited from SoTranslate1Dragger
SoSFVec3f	translation
	Position of the dragger.

Public Attributes inherited from SoDragger
SoSFBool	isActive
	TRUE when mouse is down and dragging, else FALSE.

SoSFBool	enableCallbacks
	If set to FALSE, motion, start and finish callbacks are disabled.

Public Attributes inherited from SoInteractionKit
SoSFEnum	boundingBoxCaching
	Set bounding box caching mode.

SoSFEnum	renderCulling
	Set render culling mode.

SoSFEnum	pickCulling
	Set pick caching mode.

SoDEPRECATED SoSFEnum	renderCaching
	Set render caching mode.

Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Additional Inherited Members
Public Types inherited from SoDragger
enum	TrackerDirectMode { NONE , MOVE , ROTATE , FREE , DEFAULT }
	Tracker direct mode. More...

typedef void	SoDraggerCB(void userData, SoDragger dragger)
	Used in defining the callback function lists.

Public Types inherited from SoInteractionKit
enum	CacheEnabled { OFF , ON , AUTO }
	Possible values for caching. More...

Detailed Description

Object that moves an SoOrthoSlice by dragging with the mouse.

SoOrthoSliceDragger is derived from SoTranslate1Dragger and has similar behavior, but is specifically designed to allow direct manipulation of an 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 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 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 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 SoPreferences value IVVR_ENABLE_ORTHOSLICE_DRAGGER_AXIS_SWITCH to FALSE.

EXAMPLE

SoSeparator* volSep = new SoSeparator();
root->addChild( volSep );
 
// Create and initialize data node
SoVolumeData* volData = new SoVolumeData();
volSep->addChild( volData );
 
// Create and initialize orthoslice node
SoOrthoSlice* orthoSlice = new SoOrthoSlice();
volSep->addChild( orthoSlice );
 
// Create path to slice node
// Note: Can be a partial path but must include the slice node.
SoPath* path = new SoPath( volSep );
path->append( orthoSlice );
 
// Create and initialize dragger
SoOrthoSliceDragger* dragger = new SoOrthoSliceDragger();
dragger->orthoSlicePath  = path;
volSep->addChild( dragger );

FILE FORMAT/DEFAULT

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

Constructor & Destructor Documentation

◆ SoOrthoSliceDragger()

SoOrthoSliceDragger::SoOrthoSliceDragger ( )

Constructor.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * SoOrthoSliceDragger::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType SoOrthoSliceDragger::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * SoOrthoSliceDragger::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from SoTranslate1Dragger.

◆ getTypeId()

virtual SoType SoOrthoSliceDragger::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoTranslate1Dragger.

Member Data Documentation

◆ enableHighlight

SoSFBool SoOrthoSliceDragger::enableHighlight

Enables highlighting.

If this field is true, during a mousemouve, a border is drawn and highlighted according to the highlightColor when the cursor moves over the slice. This border disappears once the cursor is no longer over the slice. Default is true.

Definition at line 208 of file SoOrthoSliceDragger.h.

◆ highlightColor

SoSFColor SoOrthoSliceDragger::highlightColor

Specifies the highlight color.

See also enableHighlight. The default color is yellow (1,1,0).

Definition at line 199 of file SoOrthoSliceDragger.h.

◆ orthoSlicePath

SoSFPath SoOrthoSliceDragger::orthoSlicePath

Path to the SoOrthoSlice node to drag.

Default is empty (no path).

Definition at line 177 of file SoOrthoSliceDragger.h.

◆ volumeDimension

SoDEPRECATED SoSFVec3i32 SoOrthoSliceDragger::volumeDimension

Dimension of the volume.

Definition at line 185 of file SoOrthoSliceDragger.h.

◆ volumeExtent

SoDEPRECATED SoSFBox3f SoOrthoSliceDragger::volumeExtent

Extent of the volume.

Definition at line 191 of file SoOrthoSliceDragger.h.

The documentation for this class was generated from the following file:

VolumeViz/draggers/SoOrthoSliceDragger.h

Open Inventor Release 2024.2.0

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members