Open Inventor Release 2024.1.2
 
Loading...
Searching...
No Matches
SoAntiSquish Class Reference

Transformation node that undoes non-uniform 3D scales. More...

#include <Inventor/nodes/SoAntiSquish.h>

+ Inheritance diagram for SoAntiSquish:

Public Types

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

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoAntiSquish ()
 Creates an anti-squish node with default settings.
 
void recalc ()
 Sets a flag so that the next time the node is traversed, it will recalculate its unsquishing matrix.
 
- 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 SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoTransformation
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (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

SoSFEnum sizing
 Determines which of the algorithms enumerated by the type Sizing will be used to select the new scale when the x,y, and z scales are not equal.
 
SoSFBool recalcAlways
 If recalcAlways is TRUE, this node calculates its unsquishing matrix every time it is traversed.
 

Detailed Description

Transformation node that undoes non-uniform 3D scales.

This node removes nonuniform 3D scaling from the current transformation matrix when traversed by an action. It is used by draggers such as the SoTrackballDragger that need to stay uniformly scaled no matter where they are located in the scene graph.

The magnitude of the new scale is determined by the current transformation matrix and the sizing field. This node does not change the translation or rotation in the matrix.

FILE FORMAT/DEFAULT

    AntiSquish {
    sizing AVERAGE_DIMENSION
    recalcAlways TRUE
    }

ACTION BEHAVIOR

SEE ALSO

SoCenterballDragger, SoJackDragger, SoTrackballDragger, SoTransformerDragger, SoTransformation, SoTransformBoxDragger

Definition at line 107 of file SoAntiSquish.h.

Member Enumeration Documentation

◆ Sizing

Sizing.

Enumerator

Fits the other two axes to match the X axis, whose size is unchanged.

Fits the other two axes to match the Y axis, whose size is unchanged.

Fits the other two axes to match the Z axis, whose size is unchanged.

AVERAGE_DIMENSION 

Uses average of 3 scales in the matrix.

BIGGEST_DIMENSION 

Uses biggest of 3 scales in the matrix.

SMALLEST_DIMENSION 

Uses smallest of 3 scales in the matrix.

LONGEST_DIAGONAL 

Accounts for shearing; transforms a cube by the matrix and then uses length of longest diagonal.

Definition at line 119 of file SoAntiSquish.h.

Constructor & Destructor Documentation

◆ SoAntiSquish()

SoAntiSquish::SoAntiSquish ( )

Creates an anti-squish node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoAntiSquish::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoAntiSquish::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoTransformation.

◆ recalc()

void SoAntiSquish::recalc ( )

Sets a flag so that the next time the node is traversed, it will recalculate its unsquishing matrix.

Member Data Documentation

◆ recalcAlways

SoSFBool SoAntiSquish::recalcAlways

If recalcAlways is TRUE, this node calculates its unsquishing matrix every time it is traversed.

If FALSE, then this only occurs during the first traversal folllowing a call to recalc(). Default is TRUE.

Definition at line 164 of file SoAntiSquish.h.

◆ sizing

SoSFEnum SoAntiSquish::sizing

Determines which of the algorithms enumerated by the type Sizing will be used to select the new scale when the x,y, and z scales are not equal.

Use enum Sizing. Default is AVERAGE_DIMENSION.

Definition at line 157 of file SoAntiSquish.h.


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