SoJackManip(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 NAME 🎀

okay bestie, you clicked on SoJackManip(3) 💖 so let's talk about her. this page is about SoJackManip, and honestly her whole personality is one line: she wraps an SoJackDragger for convenience. that's it. that's the vibe. no cap 🫶

✨ SYNOPSIS ✨

so like, here's how you even get her into the room:

#include <Inventor/manips/SoJackManip.h>

and the family tree? she inherits SoTransformManip 💅 which means she shows up with a whole inheritance situation, and we are NOT skipping any of it. sit down, get comfy, hydrate 🍓

💖 Public Member Functions (hers, original recipe)

  • virtual SoType getTypeId (void) const — the girl knows exactly who she is.
  • SoJackManip (void) — the constructor, her grand entrance 👑

💜 Public Member Functions inherited from SoTransformManip

she didn't build these herself, she inherited them, and we're giving them their flowers 🌸

  • SoTransformManip (void)
  • SoDragger * getDragger (void)
  • SbBool replaceNode (SoPath *p)
  • SbBool replaceManip (SoPath *p, SoTransform *newone) const
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual SoChildList * getChildren (void) const

💜 Public Member Functions inherited from SoTransform

  • SoTransform (void)
  • void pointAt (const SbVec3f &frompoint, const SbVec3f &topoint)
  • void getScaleSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
  • void getRotationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
  • void getTranslationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
  • void multLeft (const SbMatrix &mat)
  • void multRight (const SbMatrix &mat)
  • void combineLeft (SoTransformation *nodeonright)
  • void combineRight (SoTransformation *nodeonleft)
  • void setMatrix (const SbMatrix &mat)
  • void recenter (const SbVec3f &newcenter)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *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 rayPick (SoRayPickAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • 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

the OG ancestor, we love her, we respect her 👑

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

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

⭐ Static Public Member Functions inherited from SoTransform

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

🌸 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • ~SoJackManip () — yes, the destructor, she's protected, don't touch 🫣

🌸 Protected Member Functions inherited from SoTransformManip

  • ~SoTransformManip ()
  • void setDragger (SoDragger *newdragger)
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
  • void attachSensors (const SbBool onoff)

🌸 Protected Member Functions inherited from SoTransform

  • virtual ~SoTransform ()

🌸 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 SoTransformManip

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void transferFieldValues (const SoTransform *from, SoTransform *to)
  • static void valueChangedCB (void *f, SoDragger *d)
  • static void fieldSensorCB (void *f, SoSensor *d)

🦋 Static Protected Member Functions inherited from SoTransform

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

bestie we're still going. the lore is DEEP. 🧚

💖 Public Types inherited from SoNode

the big enum, and yes, every single value is here, we don't gatekeep:

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 Attributes inherited from SoTransform

  • SoSFVec3f translation
  • SoSFRotation rotation
  • SoSFVec3f scaleFactor
  • SoSFRotation scaleOrientation
  • SoSFVec3f center

💖 Protected Types inherited from SoBase

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

💖 Protected Attributes inherited from SoTransformManip

  • SoFieldSensor * rotateFieldSensor
  • SoFieldSensor * translFieldSensor
  • SoFieldSensor * scaleFieldSensor
  • SoFieldSensor * centerFieldSensor
  • SoFieldSensor * scaleOrientFieldSensor
  • SoChildList * children

💖 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

and that's the whole SYNOPSIS, bestie — every signature accounted for, nobody left behind 💅 but wait, there's more, part 2 is coming so don't you dare close the tab 🦋✨

🌸 DETAILED DESCRIPTION 🌸

okay so real talk bestie, SoJackManip is literally just a lil cozy wrapper around an SoJackDragger 💖 it's giving "we did the boring parts so you don't have to."

The manipulator class takes care of wrapping up the SoJackDragger in a simple and convenient API for the application programmer. That means it automatically surrounds the geometry it influences and handles all the book-keeping routines for how the dragger interacts with the relevant fields of an SoTransformation node. no cap, it's the whole "you just vibe, we handle the admin" situation 🎀

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

✨ SoJackManip::SoJackManip (void )

Default constructor, slay 💅 It allocates an SoCenterballDragger and an SoSurroundScale node, so it can surround the geometry within our part of the scenegraph. iconic behavior fr.

References: SoBaseKit::getPart(), SoSurroundScale::numNodesUpToContainer, SoSurroundScale::numNodesUpToReset, SoTransformManip::setDragger(), and SoJackManip().

Referenced by: getFieldData(), and SoJackManip().

🦋 SoJackManip::~SoJackManip () [protected]

Destructor. it's giving closure, bestie 🫶

👑 MEMBER FUNCTION DOCUMENTATION 👑

⭐ SoType SoJackManip::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. yes, it's the whole "who am I actually" moment 💅

Usage example:

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
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. That'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. iykyk 😌

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

Reimplemented from SoTransformManip.

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

Returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? it returns NULL. simple as that 🎀

Reimplemented from SoTransformManip.

References: SoJackManip().

🌈 AUTHOR 🌈

Generated automatically by Doxygen for Coin from the source code. the robots wrote it, not me, don't @ me 💀

and that's a wrap on SoJackManip(3) bestie!! 🥳 this whole thing comes from Coin, Version 2.5.0 — go forth and manipulate your jacks responsibly, mwah 💖✨

📦 where this page comes from