SoJackManip(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 SoJackManip(3) 🎀

okay so bestie, welcome to the Library Functions Manual page for SoJackManip 💖 (yes the (3) is the library-functions section, we love a genre). this is a LONG one so it's split up, and this right here is part 1 — don't panic, the rest is coming 🦋

💖 NAME 💖

SoJackManip — the SoJackManip wraps an SoJackDragger for convenience. that's the whole thing. it's a convenience wrapper, it said what it said, no cap 💅

✨ SYNOPSIS ✨

#include <Inventor/manips/SoJackManip.h>

Inherits SoTransformManip. so she's a SoTransformManip girlie, and everything in that family comes along for the ride 🌸

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const — the type-id getter, periodt.
  • SoJackManip (void) — constructor, hi bestie 👋

🌈 Public Member Functions inherited from SoTransformManip

  • SoTransformManip (void) — constructor, inherited, still slaying.
  • SoDragger * getDragger (void) — hands you the dragger.
  • 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) — constructor, she's here.
  • 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=FALSE) 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=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) — the class type id, iconic.
  • static void initClass (void) — sets the class up, that's the whole description, slay.

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

🔒 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoJackManip (void) — the destructor, protected, mysterious, love that for her 🙈

🔐 Protected Member Functions inherited from SoTransformManip

  • virtual ~SoTransformManip (void)
  • 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)
  • 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 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 🧁

💠 Public Types inherited from SoNode

the enum, bestie, all of it, not one value skipped:

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

okay but hold up 👀 that's just part 1 — there is more of this page and it's coming right up, don't you dare close the tab 🫶

🫶 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — yes bestie, this one's protected, it's the family-only attribute fr fr. she's built-in and she knows it 💅

🌈 Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — the counter that hands out unique IDs, and she starts at 1 because of course she does, no cap ✨
  • static int nextActionMethodIndex = 0 — the action method index, kicking things off at 0, lowkey iconic 🎀

💖 Detailed Description 💖

So the SoJackManip is literally just out here wrapping an SoJackDragger for convenience. That's the whole vibe. 🦋

The way that the manipulator class works: it takes care of wrapping up the SoJackDragger in a simple and convenient API for the application programmer. She makes it automatically surround the geometry it influences 🌸 and she handles all the book-keeping routines for its interaction with the relevant fields of an SoTransformation node. She's doing the most so you don't have to, periodt 👑

✨ Constructor & Destructor Documentation ✨

🎀 SoJackManip::SoJackManip (void )

Default constructor, bestie! She allocates an SoCenterballDragger and an SoSurroundScale node, so she can surround the geometry within our part of the scenegraph. Two draggers, one slay 💅

Not me pointing out that she says SoCenterballDragger here while the class is all about SoJackDragger — that's just what the page says, I don't make the rules 🙈

🦋 SoJackManip::~SoJackManip (void ) [protected], [virtual]

Destructor. She's leaving the group chat 😭 protected and virtual, so she goes out on her own terms.

🔥 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. Run-time type checking is the main character energy here 👑

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)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, fr fr. This is 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 (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. Macros doing the heavy lifting, we love to see it 💖

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. Go read the superclass lore, iykyk 📚

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. If no fields are present, returns NULL. Empty-handed but still valid, she's giving minimalism 🎀

Reimplemented from SoTransformManip.

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. Not a human author, just a robot doing her little robot thing 🤖✨

That's the whole page bestie, and we ate and left no crumbs. This one's from Coin, Version 3.1.3, dated SoJackManip(3) — go surround some geometry with your new manipulator, you've got this 💅🫶💖

📦 where this page comes from