SoHandleBoxManip(3)

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

💖 SoHandleBoxManip(3) — Coin 💖

okay bestie, welcome to the manual page for SoHandleBoxManip, straight outta the Coin library, section 3 of the manual. grab a boba, this one's a long one 🧋✨

🌸 NAME 🌸

SoHandleBoxManip — the class that wraps an SoHandleBoxDragger so you can manipulate a transformation. that's the whole vibe. it's a manip, it handles the box, it drags. iconic. 👑

🎀 SYNOPSIS 🎀

#include <Inventor/manips/SoHandleBoxManip.h>

Inherits SoTransformManip.

💅 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoHandleBoxManip (void)

Public Member Functions inherited from SoTransformManip

  • 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=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)
  • SbUniqueId 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 — returns TRUE if the type of this object is either of the same type or inherited from type. no cap, that's what it does 💅
  • 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 the lil setup ritual 🕯️

Static Public Member Functions inherited from SoTransformManip

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

Static Public Member Functions inherited from SoTransform

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

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.

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

🫶 Protected Member Functions 🫶

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoHandleBoxManip (void)

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
  • virtual SoNotRec createNotRec (void)

🌈 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)
💖 bestie this is part 1 and we are not done — more parts are coming, so don't go anywhere 🦋

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — grab the pointer to the field data, no cap.
  • static void setNextActionMethodIndex (int index) — set that next-action-method index.
  • static int getNextActionMethodIndex (void) — read it back out.
  • static void incNextActionMethodIndex (void) — bump it up by one.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — assign the compatibility types for a node type.

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — the current write counter, right there.
  • static void staticDataLock (void) — locks the static data. 💅
  • static void staticDataUnlock (void) — and unlocks it. balanced, as all things should be.

Additional Inherited Members

Public Types inherited from SoNode

bestie there's an enum and it's LONG, okay, here's the whole thing verbatim because I would never trim it:

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

  • SbUniqueId uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

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

Detailed Description

okay so the whole vibe of SoHandleBoxManip is that it wraps an SoHandleBoxDragger so you can manipulate a transformation. ✨

A manipulator works like this: you swap out the node you wanna edit in the graph, and put the manipulator in its place. Then the draggers do the actual manipulating of the node. Once you're done manipulating, the node goes back into the graph and it replaces the manipulator again. It's giving temp-swap-then-put-it-back. 🎀

See also

SoHandleBoxDragger, SoDragger

Constructor & Destructor Documentation

SoHandleBoxManip::SoHandleBoxManip (void )

Constructor sets us up with an SoHandleBoxDragger for manipulating a transformation. iconic behavior, fr fr. 💅

SoHandleBoxManip::~SoHandleBoxManip (void ) [protected], [virtual]

Protected destructor. (SoHandleBoxManip is automatically destructed when its reference count goes to 0.) she cleans up after herself, we love to see it. 🫶

Member Function Documentation

SoType SoHandleBoxManip::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

SoType SoHandleBoxManip::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 SoTransformManip.

const SoFieldData ** SoHandleBoxManip::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.

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

const SoFieldData * SoHandleBoxManip::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.

Reimplemented from SoTransformManip.

Author

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page bestie, we ate that. 🍓 this one's Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00 — go forth and manipulate those transformations, main character. 💖✨👑

📦 where this page comes from