Coin Logo http://www.sim.no
http://www.coin3d.org

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

SoAntiSquish Class Reference

The SoAntiSquish class is used to reset to uniform scaling.When traversed, this node replaces the scale vector of the matrix with uniform values, based on one of the SoAntiSquish::Sizing strategies. More...

#include <Inventor/nodes/SoAntiSquish.h>

Inheritance diagram for SoAntiSquish:
SoTransformation SoNode SoFieldContainer SoBase

List of all members.

Public Types

enum  Sizing {
  X, Y, Z, AVERAGE_DIMENSION,
  BIGGEST_DIMENSION, SMALLEST_DIMENSION, LONGEST_DIAGONAL
}

Public Member Functions

 SoAntiSquish (void)
void recalc (void)
virtual void doAction (SoAction *action)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFEnum sizing
SoSFBool recalcAlways

Protected Member Functions

virtual ~SoAntiSquish ()
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)
SbMatrix getUnsquishingMatrix (const SbMatrix &squishedmatrix, const SbBool calcinverse, SbMatrix &getinverse)

Detailed Description

The SoAntiSquish class is used to reset to uniform scaling.

When traversed, this node replaces the scale vector of the matrix with uniform values, based on one of the SoAntiSquish::Sizing strategies.

This node is for instance used by manipulators to retain the shape of their dragger geometries when set up within the influence of an SoSurroundScale node (which can yield nonuniform scale-vectors in the current state transformation matrix).

FILE FORMAT/DEFAULTS:

    AntiSquish {
        recalcAlways TRUE
        sizing AVERAGE_DIMENSION
    }
See also:
SoSurroundScale for a usage example.

Member Enumeration Documentation

Different strategies for "unsquishing" a scale. Values are used by the SoAntiSquish::sizing field.


Constructor & Destructor Documentation

SoAntiSquish::SoAntiSquish ( void  )

Constructor.

References recalcAlways, and sizing.

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

Destructor.


Member Function Documentation

void SoAntiSquish::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.

Referenced by SoInteraction::init().

void SoAntiSquish::recalc ( void  )

If SoAntiSquish::recalcAlways has been set to FALSE, you must call this method whenever the transformations before this node in the graph has changed.

See also:
SoAntiSquish::recalcAlways

Referenced by SoTransformerDragger::dragStart(), SoTransformBoxDragger::invalidateSurroundScaleCB(), and SoJackDragger::invalidateSurroundScaleCB().

void SoAntiSquish::doAction ( SoAction action) [virtual]

Accumulates an "unsquishing" matrix on top of the current model matrix.

Reimplemented from SoNode.

References SoAction::getState(), getUnsquishingMatrix(), and recalcAlways.

Referenced by callback(), getBoundingBox(), GLRender(), and pick().

void SoAntiSquish::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.

References doAction().

void SoAntiSquish::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.

References doAction().

void SoAntiSquish::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.

References doAction(), and recalcAlways.

void SoAntiSquish::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.

References SoGetMatrixAction::getInverse(), SoGetMatrixAction::getMatrix(), getUnsquishingMatrix(), SbMatrix::multLeft(), SbMatrix::multRight(), and recalcAlways.

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

SbMatrix SoAntiSquish::getUnsquishingMatrix ( const SbMatrix squishedmatrix,
const SbBool  calcinverse,
SbMatrix getinverse 
) [protected]

Calculate and return the matrix needed to "unsquish" the squishedmatrix.

If calcinverse is TRUE, store the inverse of the unsquishmatrix in getinverse.

References SbMatrix::getTransform(), SbMatrix::inverse(), SbMatrix::multRight(), SbMatrix::multVecMatrix(), SbMatrix::setTransform(), and sizing.

Referenced by doAction(), and getMatrix().


Member Data Documentation

Whether to automatically have the unsquishing parameters recalculated for every traversal. Default value is TRUE.

You can set this to FALSE and manually invoke SoAntiSquish::recalc() if you need closer control of the geometry influenced by this node.

Referenced by doAction(), getBoundingBox(), getMatrix(), SoAntiSquish(), SoCenterballDragger::SoCenterballDragger(), SoJackDragger::SoJackDragger(), and SoTransformBoxDragger::SoTransformBoxDragger().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:02 for Coin by Doxygen. 1.7.3