SoAntiSquish(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

✨ SoAntiSquish(3) ✨

okay so first things first, bestie: this is a page from the Coin manual, and the star of the show is the SoAntiSquish class 💅 she's a whole icon and her entire job is giving you back your uniform scaling when something has gone and squished you. no cap.

🌸 NAME 🌸

SoAntiSquish — the class that is used to reset to uniform scaling. that's it. that's the vibe. 🎀

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoAntiSquish.h>

She inherits from SoTransformation, so everything her parent can do, she can do too. periodt. 👑

💜 Public Types 💜

The one and only enum she brings to the group chat:

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

🧚 Public Types inherited from SoNode 🧚

yeah she got handed these down from SoNode, and they are a lot, but we're listing every single one because we don't skip anything in this house:

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

💖 Public Member Functions 💖

these are her very own, homegrown, main-character methods:

  • virtual SoType getTypeId (void) const
  • SoAntiSquish (void) — the constructor, hi bestie 👋
  • void recalc (void) — go redo the math, girl
  • virtual void doAction (SoAction *action)

🌈 Public Member Functions inherited from SoNode 🌈

the whole family tree showed up. every one of them:

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const
  • virtual SbBool affectsState (void) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • SbUniqueId getNodeId (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual SoFieldContainer * copyThroughConnection (void) const

🎀 Public Member Functions inherited from SoFieldContainer 🎀

more inherited besties, and yeah, we're doing all of them:

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

🍓 Public Member Functions inherited from SoBase 🍓

the root of the whole ancestry situation:

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const
    • this one is the vibe check — it hands you back TRUE if the type of this object is either the same type as type, or inherited from type. iykyk.
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static void initClass (void)
    • sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. it's giving "getting your paperwork in order" 📋

💫 Static Public Member Functions inherited from SoTransformation 💫

  • static SoType getClassTypeId (void)
  • static void initClass (void)
    • sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. same energy, different parent.

🌟 Static Public Member Functions inherited from SoNode 🌟

  • static uint32_t getCompatibilityTypes (const SoType &nodetype)
  • static SoType getClassTypeId (void)
  • static SoNode * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoNodeList &l)
  • static void initClass (void)
    • sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId getNextNodeId (void)
  • static int getActionMethodIndex (const SoType type)
  • static void getBoundingBoxS (SoAction *action, SoNode *node)
  • static void GLRenderS (SoAction *action, SoNode *node)
  • static void callbackS (SoAction *action, SoNode *node)
  • static void getMatrixS (SoAction *action, SoNode *node)
  • static void handleEventS (SoAction *action, SoNode *node)
  • static void pickS (SoAction *action, SoNode *node)
  • static void rayPickS (SoAction *action, SoNode *node)
  • static void searchS (SoAction *action, SoNode *node)
  • static void writeS (SoAction *action, SoNode *node)
  • static void audioRenderS (SoAction *action, SoNode *node)
  • static void getPrimitiveCountS (SoAction *action, SoNode *node)

🔥 Static Public Member Functions inherited from SoFieldContainer 🔥

  • static void initClass (void)
    • sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void)
    • this static method returns the SoType object associated with objects of this class.
  • static void cleanupClass (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

🫶 Static Public Member Functions inherited from SoBase 🫶

  • static void initClass (void)
    • sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void)
    • this static method returns the SoType object associated with objects of this class.
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

👑 Public Attributes 👑

her actual, tangible, you-can-touch-them fields:

  • SoSFEnum sizing
  • SoSFBool recalcAlways

🙈 Protected Member Functions 🙈

the ones only her and her subclasses get to peek at:

  • virtual const SoFieldData * getFieldData (void) const
  • 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)

💜 Protected Member Functions inherited from SoTransformation 💜

  • SoTransformation (void)
  • virtual ~SoTransformation ()

🧚 Protected Member Functions inherited from SoNode 🧚

  • SoNode (void)
  • virtual ~SoNode ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

🌸 Protected Member Functions inherited from SoFieldContainer 🌸

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

💅 Protected Member Functions inherited from SoBase 💅

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const
  • virtual SoNotRec createNotRec (void)

🦋 Static Protected Member Functions 🦋

  • static const SoFieldData ** getFieldDataPtr (void)

⭐ Static Protected Member Functions inherited from SoTransformation ⭐

  • static const SoFieldData ** getFieldDataPtr (void)

🌟 Static Protected Member Functions inherited from SoNode 🌟

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void setNextActionMethodIndex (int index)
  • static int getNextActionMethodIndex (void)
  • static void incNextActionMethodIndex (void)
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

🌈 Static Protected Member Functions inherited from SoBase 🌈

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

💫 Additional Inherited Members 💫

the little extras that came along for the ride:

🎀 Protected Types inherited from SoBase 🎀

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

🍓 Protected Attributes inherited from SoNode 🍓

  • SbUniqueId uniqueId

🧁 Protected Attributes inherited from SoFieldContainer 🧁

  • SbBool isBuiltIn

👑 Static Protected Attributes inherited from SoNode 👑

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

okay that's literally the whole inheritance situation, bestie. hold on, we're not done — this is only part 1 of 2, more is coming 💖 don't go anywhere.

💖 DETAILED DESCRIPTION 💖

okay bestie, so the SoAntiSquish class is literally the glow-up artist of matrices — its whole job is resetting stuff back to uniform scaling. no more stretched-out chaos. we love a consistent queen. ✨

when it gets traversed, this node swaps out the scale vector of the matrix for uniform values, and it picks which uniform value based on one of the SoAntiSquish::Sizing strategies. it's giving "one size fits all, but make it mathematically deliberate."

so where do you actually see this icon in the wild? manipulators use it to keep the shape of their dragger geometries looking correct when they're set up inside the influence of an SoSurroundScale node — because that node can hand you nonuniform scale-vectors in the current state transformation matrix, and nobody wants a lopsided dragger. 💅

FILE FORMAT/DEFAULTS:

AntiSquish {
    recalcAlways TRUE
    sizing AVERAGE_DIMENSION
}

👀 SEE ALSO 👀

  • SoSurroundScale — for a usage example, iykyk 🫶

🌈 MEMBER ENUMERATION DOCUMENTATION 🌈

enum SoAntiSquish::Sizing

different strategies for "unsquishing" a nonuniform scaling. these values get used by the SoAntiSquish::sizing field. pick your fighter:

  • X — the X-axis scaling factor is used.
  • Y — the Y-axis scaling factor is used.
  • Z — the Z-axis scaling factor is used.
  • AVERAGE_DIMENSION — the average value of the scaling factors is used.
  • BIGGEST_DIMENSION — the biggest of all scaling factors is used.
  • SMALLEST_DIMENSION — the smallest of all scaling factors is used.
  • LONGEST_DIAGONAL — a unit cube is transformed by the current state transformation matrix, and the scaling factor gets set to the value of its longest diagonal. iconic behavior honestly 📐

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

SoAntiSquish::SoAntiSquish (void )

the constructor. hi bestie, you're born 🎉

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

the destructor. bye bestie, you're gone 💀

🦋 MEMBER FUNCTION DOCUMENTATION 🦋

SoType SoAntiSquish::getClassTypeId (void ) [static]

this static method returns the SoType object associated with objects of this class. it's the "what even am I" of the class world.

SoType SoAntiSquish::getTypeId (void ) const [virtual]

returns the type identification of an object derived from a class inheriting SoBase. this is used for runtime type checking and "downward" casting.

reimplemented from SoTransformation.

const SoFieldData ** SoAntiSquish::getFieldDataPtr (void ) [static], [protected]

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (translation: not for you, bestie, it's library business 🙈)

returns the SoFieldData class which holds information about fields in this node.

const SoFieldData * SoAntiSquish::getFieldData (void ) const [protected], [virtual]

returns a pointer to the class-wide field data storage object for this instance. if no fields are present, returns NULL. (not "nothing", literally NULL. no cap.)

reimplemented from SoTransformation.

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. yes, must. it's not a suggestion, it's a lifestyle 🫶

see also: SoAntiSquish::recalcAlways

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

accumulates an "unsquishing" matrix on top of the current model matrix. stacking that glow-up on top of the vibe. ✨

reimplemented from SoNode.

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. it's the "tell me everything" action, lowkey.

reimplemented from SoNode.

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 that want to throw geometry primitives at OpenGL, override this method.

reimplemented from SoNode.

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 calculate their bounding box also override this method to change the relevant state variables.

reimplemented from SoNode.

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

action method for SoGetMatrixAction.

updates action by accumulating with the transformation matrix of this node (if any). note the "(if any)" — sometimes there's just nothing there and that's valid 💜

reimplemented from SoNode.

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

action method for SoPickAction.

does common processing for SoPickAction action instances. the shared homework that all of them copy off each other, fr fr.

reimplemented from SoNode.

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. so you get the inverse for free in that out-param. slay 🎁

🌸 MEMBER DATA DOCUMENTATION 🌸

SoSFEnum SoAntiSquish::sizing

the current "unsquish" strategy. default value is SoAntiSquish::AVERAGE_DIMENSION.

SoSFBool SoAntiSquish::recalcAlways

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. that's the main-character move: you take the wheel instead of letting the traversal drive. 👑

👑 AUTHOR 👑

generated automatically by Doxygen for Coin from the source code. (not a human author, just the robot scribe doing its thing 🧚)

and that's a wrap on SoAntiSquish(3), bestie — this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00. go forth and unsquish responsibly, no cap 💅✨🦋

📦 where this page comes from