SoAntiSquish(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoAntiSquish 💖 (NAME)

okay bestie, welcome to the <pink>SoAntiSquish</pink> page — this is the <cyan>SoAntiSquish(3)</cyan> manual, Library Functions Manual energy, and it's the class that resets to uniform scaling. Slay. 🎀

✨ SYNOPSIS ✨

no cap, here's how you pull it in:

#include <Inventor/nodes/SoAntiSquish.h>

Inherits SoTransformation.

🌸 Public Types 🌸

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

🦋 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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

💅 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=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)
  • 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=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 🌈

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

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

💫 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 = 1
  • static int nextActionMethodIndex = 0

🌟 Detailed Description 🌟

okay so the <hotpink>SoAntiSquish</hotpink> class is used to <green>reset to uniform scaling</green>. That's the whole assignment bestie. 💅

When traversed, this node replaces the scale vector of the matrix with uniform values, based on one of the SoAntiSquish::Sizing strategies. Not me casually rewriting your scale vector, but here we are. 👑

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). iykyk — those nonuniform scale-vectors were not it. 🙈

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. Pick your fighter, bestie. ✨

🦋 Constructor & Destructor Documentation 🦋

SoAntiSquish::SoAntiSquish (void )

Constructor. Hi queen, you're born. 🎀

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

Destructor. And that's the goodbye (protected + virtual, fancy). 💅

💖 MEMBER FUNCTION DOCUMENTATION 💖

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

okay so this one hands you back the type identification of any object derived from a class that inherits SoBase. it's the whole reason run-time type checking and "downward" casting even work, no cap.

usage example, and yes bestie, this is verbatim:

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

if you're an application programmer and you want to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. that's just the vibe. it's typically done as part of setting up the full type system for extension classes, which is usually accomplished by using 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. 🦋

for more information on writing Coin extensions, go read the class documentation of the toplevel superclasses for the various class groups.

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. if there are no fields present? it returns NULL. that's it, that's the whole function. 💅

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. like, mandatory bestie, don't skip it. 😭

See also

SoAntiSquish::recalcAlways

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

accumulates an "unsquishing" matrix on top of the current model matrix. iconic behavior honestly.

Reimplemented from SoNode.

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

action method for SoCallbackAction.

it 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. very giving-informative.

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 who wants to throw geometry primitives at OpenGL overrides this method. throw those primitives, queen. 🔥

Reimplemented from SoNode.

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

action method for the SoGetBoundingBoxAction.

it 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. math girlies rise up. ✨

nodes influencing how geometry nodes calculates their bounding box also overrides 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). "if any" bestie, read the fine print. 🙈

Reimplemented from SoNode.

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

action method for SoPickAction.

does common processing for SoPickAction action instances. lowkey the most chill one in the list.

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. we love a glow-up. 🧚

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

🎀 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.

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

okay bestie that's the whole page, we made it 💖 this one's from Coin, Version 3.1.3, and it's filed under SoAntiSquish(3) — go forth and unsquish, you absolute main character. 🌈✨🫶

📦 where this page comes from