Transformation node that adjusts the current matrix so a default cube will surround other objects. More...

#include <Inventor/nodes/SoSurroundScale.h>

Inheritance diagram for SoSurroundScale:

Public Member Functions
	SoSurroundScale ()
	Creates a surround scale node with default settings. More...

Public Member Functions inherited from SoNode
void	setOverride (bool state)
	Turns override flag on or off. More...

bool	isOverride () const
	Returns the state of the override flag. More...

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

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

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	write (SoWriteAction *action)

virtual void	GLRenderBelowPath (SoGLRenderAction *action)
	These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes. More...

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	grabEventsSetup ()
	These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()). More...

virtual void	grabEventsCleanup ()

virtual void	startNotify ()
	Initiates notification from an instance. More...

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance. More...

SbNodeIdType	getNodeId () const
	Returns the unique id for a node. More...

virtual SoChildList *	getChildren () const
	Returns pointer to children, or NULL if none. More...

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used for either stage of writing.) More...

virtual SoNode *	addToCopyDict () const
	Recursively adds this node and all nodes under it to the copy dictionary. More...

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance. More...

virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection. More...

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

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

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

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

bool	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 Inventor file format. More...

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

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

virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name. More...

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

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

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

bool	set (const char fieldDataString, SoInput dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. More...

void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing. More...

bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library. More...

virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node. More...

void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container. More...

Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance. More...

void	unref () const

void	unrefNoDelete () const

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

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance. More...

bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in `type` or is derived from that type. More...

virtual SbName	getName () const
	Returns the name of an instance. More...

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

void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list. More...

void	removeAuditor (void *auditor, SoNotRec::Type type)

const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...

int	getRefCount () const
	Returns current reference count. More...

bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...

Fields
SoSFInt32	numNodesUpToContainer
	When traversed by an action, if surroundScale needs to calculate a new box, surroundScale looks at the current path in the action. More...

SoSFInt32	numNodesUpToReset
	Before applying the SoGetBoundingBoxAction (see the numNodesUpToContainer field aove) the surroundScale node travels up the path a distance of numNodesUpToReset and tells the action to reset the bounding box upon traversal of that node. More...

SbVec3f	cachedScale

SbVec3f	cachedInvScale

SbVec3f	cachedTranslation

bool	cacheOK

bool	doTranslations

void	invalidate ()
	If you call this, then next time an action is applied the node will re-calculate it's cached translation and scale values. More...

void	doAction (SoAction *action)
	Called by actions that need to change the state with a new matrix. More...

void	setDoingTranslations (bool doEm)

bool	isDoingTranslations ()

static void	initClass ()

virtual void	callback (SoCallbackAction *action)

virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing. More...

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	pick (SoPickAction *action)

void	updateMySurroundParams (SoAction *action, const SbMatrix &inv)

void	setIgnoreInBbox (bool newVal)

bool	isIgnoreInBbox ()

virtual	~SoSurroundScale ()

Additional Inherited Members
Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }

Static Public Member Functions inherited from SoTransformation
static void	initClass ()

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

static SoNode *	getByName (const SbName &name)
	Returns the last node given the specified name. More...

static int	getByName (const SbName &name, SoNodeList &list)
	Returns the number of nodes with the given name, and adds to `list` pointers to those nodes. More...

static void	initClass ()
	Initializes base node class. More...

static void	initClasses ()
	Initialize ALL Inventor node classes. More...

static SbNodeIdType	getNextNodeId ()
	Returns the next available unique id. More...

static int	getActionMethodIndex (SoType t)
	Returns the index of this node in the action/method table, given its type. More...

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

static void	initClass ()
	Setup type information. More...

static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used. More...

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
	Adds an instance to the dictionary. More...

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it. More...

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL. More...

static void	copyDone ()
	Cleans up the dictionary when done. More...

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

static void	initClass ()
	Setup type information. More...

static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation. More...

static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases. More...

static void	addName (SoBase , const char )
	Internal methods used to maintain the global name dictionary. More...

static void	removeName (SoBase , const char )

static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict. More...

static int	getNamedBases (const SbName &, SoBaseList &, SoType)

static bool	read (SoInput in, SoBase &base, SoType expectedType)
	Reads one instance of some subclass of SoBase. More...

static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...

Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging) More...

Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...

Protected Member Functions inherited from SoTransformation
	SoTransformation ()
	Constructor - protected since this is abstract. More...

virtual	~SoTransformation ()

Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor. More...

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()

	~SoFieldContainer ()

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error. More...

Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class. More...

virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly. More...

virtual void	destroy ()
	Actually deletes an instance. More...

bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references. More...

bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned) More...

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. More...

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter. More...

Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node. More...

Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. More...

Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id. More...

static int	nextActionMethodIndex
	Next index into the action method table. More...

Detailed Description

When traversed by an action, this node appends a transformation to the current transformation matrix so that a default size cube will surround the objects specified by its fields. Transform manipulators, such as SoHandleBoxManip, use these nodes to make themselves surround other objects.

This node only recalculates after the invalidate() method has been called. Otherwise it uses a saved scale and translation.

When calculating what to surround, the SoSurroundScale looks at the current path in the action and at its own field values.
Then SoSurroundScale applies an SoGetBoundingBoxAction to the node that is numNodesUpToContainer nodes above it on the path. SoSurroundScale also tells the action to reset the bounding box upon traversal of the node located numNodesUpToReset nodes above it in the path. The SoSurroundScale then appends a translation and scale to the current transformation so that a default size SoCube will translate and scale to fit this bounding box.

For example, when an SoHandleBoxManip wants to surround the objects it is going to move, the scene graph will look something like this:

(Cr
                 RootNode
       -------------------------
       |                        |
     handleBoxManip        movingStuff
       |
     handleBoxDragger
       |
     separator
      -----------------------------------
      |            |                     |
    motionMatrix  surroundScale      cubeGeom
The SoHandleBoxDragger wants to transform the cubeGeom so that it
surrounds the movingStuff. So it sets the surroundScale fields to:
     numNodesUpToContainer = 4;
     numNodesUpToReset = 3;

The SoBoundingBoxAction will then be applied to RootNode, with a reset after traversing the SoHandleBoxManip. So the SoSurroundScale will surround the objects below separator, and to the right of handleBoxManip, producing the desired effect.

Action Behavior

: SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoRayPickAction
Accumulates scaling and translation transformations into the current transformation.

: SoGetMatrixAction
Returns the matrix corresponding to the scaling and translation.

See Also

: SoTransformation, SoTransformManip, SoCenterballDragger, SoCenterballManip, SoHandleBoxDragger, SoHandleBoxManip, SoJackDragger, SoJackManip, SoTabBoxDragger, SoTabBoxManip, SoTrackballDragger, SoTrackballManip, SoTransformBoxDragger, SoTransformBoxManip

Definition at line 137 of file SoSurroundScale.h.

Constructor & Destructor Documentation

◆ SoSurroundScale()

SoSurroundScale::SoSurroundScale ( )

◆ ~SoSurroundScale()

virtual SoSurroundScale::~SoSurroundScale ( )

protectedvirtual

Member Function Documentation

◆ callback()

virtual void SoSurroundScale::callback ( SoCallbackAction * action )

protectedvirtual

Reimplemented from SoNode.

◆ doAction()

void SoSurroundScale::doAction ( SoAction * action )

virtual

Reimplemented from SoNode.

◆ getBoundingBox()

virtual void SoSurroundScale::getBoundingBox ( SoGetBoundingBoxAction * action )

protectedvirtual

Reimplemented from SoNode.

◆ getMatrix()

virtual void SoSurroundScale::getMatrix ( SoGetMatrixAction * action )

protectedvirtual

Reimplemented from SoNode.

◆ GLRender()

virtual void SoSurroundScale::GLRender ( SoGLRenderAction * action )

protectedvirtual

Reimplemented from SoNode.

◆ initClass()

static void SoSurroundScale::initClass ( )

static

◆ invalidate()

void SoSurroundScale::invalidate ( )

◆ isDoingTranslations()

bool SoSurroundScale::isDoingTranslations ( )

inline

Definition at line 175 of file SoSurroundScale.h.

◆ isIgnoreInBbox()

bool SoSurroundScale::isIgnoreInBbox ( )

inlineprotected

Definition at line 191 of file SoSurroundScale.h.

◆ pick()

virtual void SoSurroundScale::pick ( SoPickAction * action )

protectedvirtual

Reimplemented from SoNode.

◆ setDoingTranslations()

void SoSurroundScale::setDoingTranslations ( bool doEm )

inline

Definition at line 174 of file SoSurroundScale.h.

◆ setIgnoreInBbox()

void SoSurroundScale::setIgnoreInBbox ( bool newVal )

inlineprotected

Definition at line 190 of file SoSurroundScale.h.

◆ updateMySurroundParams()

void SoSurroundScale::updateMySurroundParams	(	SoAction *	action,
		const SbMatrix &	inv
	)

protected

Member Data Documentation

◆ cachedInvScale

SbVec3f SoSurroundScale::cachedInvScale

protected

Definition at line 194 of file SoSurroundScale.h.

◆ cachedScale

SbVec3f SoSurroundScale::cachedScale

protected

Definition at line 193 of file SoSurroundScale.h.

◆ cachedTranslation

SbVec3f SoSurroundScale::cachedTranslation

protected

Definition at line 195 of file SoSurroundScale.h.

◆ cacheOK

bool SoSurroundScale::cacheOK

protected

Definition at line 196 of file SoSurroundScale.h.

◆ doTranslations

bool SoSurroundScale::doTranslations

protected

Definition at line 198 of file SoSurroundScale.h.

◆ numNodesUpToContainer

SoSFInt32 SoSurroundScale::numNodesUpToContainer

It travels up this path a distance of numNodesUpToContainer
and applies an SoGetBoundingBoxAction to the node that it finds there.

Definition at line 155 of file SoSurroundScale.h.

◆ numNodesUpToReset

SoSFInt32 SoSurroundScale::numNodesUpToReset

Definition at line 162 of file SoSurroundScale.h.

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

/home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodes/SoSurroundScale.h

Public Member Functions

Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoSurroundScale()

◆ ~SoSurroundScale()

Member Function Documentation

◆ callback()

◆ doAction()

◆ getBoundingBox()

◆ getMatrix()

◆ GLRender()

◆ initClass()

◆ invalidate()

◆ isDoingTranslations()

◆ isIgnoreInBbox()

◆ pick()

◆ setDoingTranslations()

◆ setIgnoreInBbox()

◆ updateMySurroundParams()

Member Data Documentation

◆ cachedInvScale

◆ cachedScale

◆ cachedTranslation

◆ cacheOK

◆ doTranslations

◆ numNodesUpToContainer

◆ numNodesUpToReset