---

SoSurroundScale Class Reference

The SoSurroundScale class is used to make a default cube surround geometry. More...

#include <Inventor/nodes/SoSurroundScale.h>

Inheritance diagram for SoSurroundScale::

List of all members.

Public Methods
	SoSurroundScale (void)
void	invalidate (void)
virtual void	doAction (SoAction *action)
void	setDoingTranslations (const SbBool val)
SbBool	isDoingTranslations (void)
Static Public Methods
void	initClass (void)
Public Attributes
SoSFInt32	numNodesUpToContainer
SoSFInt32	numNodesUpToReset
Protected Methods
virtual	~SoSurroundScale ()
virtual void	callback (SoCallbackAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	pick (SoPickAction *action)
void	updateMySurroundParams (SoAction *action, const SbMatrix &inv)
void	setIgnoreInBbox (const SbBool val)
SbBool	isIgnoreInBbox (void)
Protected Attributes
SbVec3f	cachedScale
SbVec3f	cachedInvScale
SbVec3f	cachedTranslation
SbBool	cacheOK
SbBool	doTranslations

---

Detailed Description

The SoSurroundScale class is used to make a default cube surround geometry.

This node calculates a transformation (a translation and a scale) which will, when the node is traversed, be appended to the current model matrix, making a default cube placed directly to the right of this node in the graph surround geometry to the right of the container branch this node is on. The container is specified by the field numNodesUpToContainer. When calculating the bounding box to be surrounded, the bounding box action will be applied to the container node, and the bounding box calculations will be reset after traversing the node specified by the field numNodesUpToReset.

FIXME: insert a scenegraph diagram here which shows how a SoSurroundScale can be set up to work. 20010823 mortene.

This node is internally used by draggers to make it possible for manipulators to have the dragger surround the geometry it is modifying, but it is also useful for application programmers who want a particular piece of geometry (like a unit sized sphere or cube) surround other geometry of unknown extent.

SoSurroundScale nodes in the scenegraph is often paired up with SoAntiSquish nodes to get uniform scaling along all three principal axes.

---

Constructor & Destructor Documentation

SoSurroundScale::SoSurroundScale (  void )

Constructor.

SoSurroundScale::~SoSurroundScale (  )  [protected, virtual]

Destructor.

---

Member Function Documentation

void SoSurroundScale::initClass (  void )  [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Reimplemented from SoTransformation.

void SoSurroundScale::invalidate (  void )

Invalidates the cached transformation, forcing a recalculation to be done the next time this node is traversed.

void SoSurroundScale::doAction (  SoAction * action )  [virtual]

This function performs the typical operation of a node for any action. Reimplemented from SoNode.

void SoSurroundScale::setDoingTranslations (  const SbBool val )

Sets whether the translation part of the transformation should be ignored or not.

SbBool SoSurroundScale::isDoingTranslations (  void )

Returns whether the translation part of the transformation should be ignored or not.

void SoSurroundScale::callback (  SoCallbackAction * action )  [protected, virtual]

Action method for SoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. Reimplemented from SoNode.

void SoSurroundScale::GLRender (  SoGLRenderAction * action )  [protected, virtual]

Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. Reimplemented from SoNode.

void SoSurroundScale::getBoundingBox (  SoGetBoundingBoxAction * action )  [protected, virtual]

Action method for the SoGetBoundingBoxAction. Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables. Reimplemented from SoNode.

void SoSurroundScale::getMatrix (  SoGetMatrixAction * action )  [protected, virtual]

Action method for SoGetMatrixAction. Updates action by accumulating with the transformation matrix of this node (if any). Reimplemented from SoNode.

void SoSurroundScale::pick (  SoPickAction * action )  [protected, virtual]

Action method for SoPickAction. Does common processing for SoPickAction action instances. Reimplemented from SoNode.

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

Calculates the translation and scale needed to make a default cube surround geometry to the right of the branch this node is on.

void SoSurroundScale::setIgnoreInBbox (  const SbBool val )  [protected]

Sets whether bounding box calculations in SoGetBoundingBoxAction should be affected by this node.

SbBool SoSurroundScale::isIgnoreInBbox (  void )  [protected]

Returns whether bounding box calculations in SoGetBoundingBoxAction should be affected by this node.

---

Member Data Documentation

SoSFInt32 SoSurroundScale::numNodesUpToContainer

Number of nodes in the path counting from this and "upwards" to the container node.

SoSFInt32 SoSurroundScale::numNodesUpToReset

Number of nodes in the path counting from this and "upwards" to the node where we will reset the bounding box value.

SoSurroundScale::cachedScale [protected]

For internal use only.

SoSurroundScale::cachedInvScale [protected]

For internal use only.

SoSurroundScale::cachedTranslation [protected]

For internal use only.

SoSurroundScale::cacheOK [protected]

For internal use only.

SoSurroundScale::doTranslations [protected]

For internal use only.

---

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

• SoSurroundScale.cpp
• SoSurroundScale.h

---