SoAntiSquish(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoAntiSquish(3) — Library Functions Manual 💖

hey bestie! welcome to the SoAntiSquish(3) man page from the Library Functions Manual. it's giving iconic Unix energy, and we're about to go through every single detail together. no cap. 💅✨

✨ NAME ✨

SoAntiSquish — The SoAntiSquish class is used to reset to uniform scaling. periodt. 💖

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoAntiSquish.h>

Inherits SoTransformation. 🦋

🎀 Public Types 🎀

  • enum Sizing { X, Y, Z, AVERAGE_DIMENSION, BIGGEST_DIMENSION, SMALLEST_DIMENSION, LONGEST_DIAGONAL } — the sizing strategies, bestie. ✨

Public Types inherited from SoNode

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
    }

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • SoAntiSquish (void)
  • void recalc (void)
  • virtual void doAction (SoAction *action)

Public Member Functions inherited from SoNode

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=0) 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)
  • uint32_t 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

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
  • 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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

Public Member Functions inherited from SoBase

  • 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
  • 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)

Static Public Member Functions inherited from SoTransformation

  • static SoType getClassTypeId (void)
  • static void initClass (void)

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)
  • static void initClasses (void)
  • static uint32_t 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)
  • static SoType getClassTypeId (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)
  • static SoType getClassTypeId (void)
  • 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 *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

🍓 Public Attributes 🍓

  • SoSFEnum sizing
  • SoSFBool recalcAlways

🔥 Protected Member Functions 🔥

  • 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)
  • ~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

💜 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 🌈

Protected Types inherited from SoBase

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

Protected Attributes inherited from SoNode

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 0
  • static int nextActionMethodIndex = 0

🦋 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 🧚

enum SoAntiSquish::Sizing

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

💖 Constructor & Destructor Documentation 💖

SoAntiSquish::SoAntiSquish (void )

Constructor. 🎀

References recalcAlways, sizing, and SoAntiSquish().

Referenced by getFieldData(), and SoAntiSquish().

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

Destructor. 💀

💫 Member Function Documentation

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

okay bestie, this one hands you back the type ID of any object that descends from SoBase — it's literally how run-time type checking happens, and how "downward" casting stays safe and not a whole crime scene. 💅

Usage example, and yes you're gonna want this memorized:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

Now listen — if you're an application programmer out here wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else your heart desires, you have to override this method in all your subclasses. Not optional. It's typically done as part of setting up the full type system for extension classes, which usually gets accomplished with the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. 🌸

Want the full tea on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. iykyk. 🫶

Reimplemented from SoTransformation.

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

Gives you a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? You get NULL. That's it, that's the whole vibe check. 🙈

Reimplemented from SoTransformation.

References SoAntiSquish().

void SoAntiSquish::recalc (void )

So if SoAntiSquish::recalcAlways has been set to FALSE, then you must call this method whenever the transformations before this node in the graph have changed. No skipping, bestie, it's giving "if you don't call me nothing recalculates." 😭

See also SoAntiSquish::recalcAlways

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

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

Accumulates an "unsquishing" matrix right on top of the current model matrix. Iconic behaviour honestly. ✨

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.

It just updates the state according to how the node behaves for the render action, so you (the application programmer) can use SoCallbackAction to extract info about the scene graph. Lowkey just doing its lil job. 💖

Reimplemented from SoNode.

References doAction().

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

Action method for the SoGLRenderAction.

This gets called during rendering traversals. Any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. Main character energy for sure. 👑

Reimplemented from SoNode.

References doAction().

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

Action method for the SoGetBoundingBoxAction.

It calculates the bounding box and center coordinates for the node, then modifies the action's values so they encompass the bounding box for this node and shift the scene's center point more towards this node's. Teamwork fr fr. 🦋

Nodes that influence how geometry nodes calculate their bounding box also override 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 the action by accumulating with the transformation matrix of this node (if any). Simple, clean, no notes. 💅

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 the common processing for SoPickAction action instances. The shared chores, if you will. 🎀

Reimplemented from SoNode.

References doAction().

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

Calculates and returns the matrix you need to "unsquish" the squishedmatrix. The whole point of the class, honestly. ✨

If calcinverse is TRUE, it stores 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

SoSFEnum SoAntiSquish::sizing

The current "unsquish" strategy. Default value is SoAntiSquish::AVERAGE_DIMENSION. Pick your fighter, bestie. 💖

Referenced by SoTransformerDragger::dragStart(), getUnsquishingMatrix(), SoAntiSquish(), SoCenterballDragger::SoCenterballDragger(), SoJackDragger::SoJackDragger(), SoTrackballDragger::SoTrackballDragger(), and SoTransformBoxDragger::SoTransformBoxDragger().

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. Very "I'll take it from here, thanks." 💅

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

🧚 Author

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap on SoAntiSquish(3) bestie 🫶 — this lil masterpiece is from Coin, Version 2.5.0, and the page itself is dated SoAntiSquish(3). slay, go unsquish something. 💖✨
📦 where this page comes from