SoTrackballManip(3)

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

okay so bestie 💖 pull up a chair, hydrate, and get comfy, because we're reading SoTrackballManip(3) from the Coin library together and it's gonna be a whole journey. 🫶 No cap, it's long, but we're built for this.

🎀 NAME 🎀

SoTrackballManip — the SoTrackballManip wraps an SoTrackballDragger for convenience. that's literally the entire vibe. it's giving "I did the hard part so you don't have to." ✨

🦋 SYNOPSIS 🦋

#include <Inventor/manips/SoTrackballManip.h>

Inherits SoTransformManip. (so it's deep in the family tree, main character lineage fr 👑)

💅 Public Member Functions

  • virtual SoType getTypeId (void) const — hands you the SoType of this thing, iykyk.
  • SoTrackballManip (void) — the constructor, aka how you actually make one of these. 🎀

🌸 Public Member Functions inherited from SoTransformManip

  • SoTransformManip (void) — constructor for the parent class.
  • SoDragger * getDragger (void) — grabs the dragger doing the work.
  • SbBool replaceNode (SoPath *p) — swaps in a node, returns an SbBool.
  • SbBool replaceManip (SoPath *p, SoTransform *newone) const — swaps this manip out for newone, const-style.
  • virtual void doAction (SoAction *action) — runs an action.
  • virtual void callback (SoCallbackAction *action) — the callback-action entry point.
  • virtual void GLRender (SoGLRenderAction *action) — renders it. 🎨
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — computes the bounding box.
  • virtual void getMatrix (SoGetMatrixAction *action) — grabs the matrix.
  • virtual void handleEvent (SoHandleEventAction *action) — handles events.
  • virtual void pick (SoPickAction *action) — picking behavior, lowkey essential.
  • virtual void search (SoSearchAction *action) — search-action handling.
  • virtual SoChildList * getChildren (void) const — returns the child list.

🦋 Public Member Functions inherited from SoTransform

  • SoTransform (void) — constructor.
  • void pointAt (const SbVec3f &frompoint, const SbVec3f &topoint) — points from one spot to another.
  • void getScaleSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — gives you the scale-space matrix and its inverse.
  • void getRotationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — rotation-space matrix + inverse.
  • void getTranslationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — translation-space matrix + inverse.
  • void multLeft (const SbMatrix &mat) — multiplies on the left.
  • void multRight (const SbMatrix &mat) — multiplies on the right.
  • void combineLeft (SoTransformation *nodeonright) — combines from the left.
  • void combineRight (SoTransformation *nodeonleft) — combines from the right.
  • void setMatrix (const SbMatrix &mat) — sets the matrix.
  • void recenter (const SbVec3f &newcenter) — recenters it around newcenter.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — primitive-count handling.

✨ Public Member Functions inherited from SoNode

  • void setOverride (const SbBool state) — sets the override state.
  • SbBool isOverride (void) const — is it overriding? asks.
  • void setNodeType (const NodeType type) — sets the node type.
  • NodeType getNodeType (void) const — gets the node type.
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — makes a copy, copyconnections defaults to FALSE.
  • virtual SbBool affectsState (void) const — does it touch the state?
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — renders below the path.
  • virtual void GLRenderInPath (SoGLRenderAction *action) — renders in the path.
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — renders off the path.
  • virtual void rayPick (SoRayPickAction *action) — ray picking. 🔥
  • virtual void write (SoWriteAction *action) — writes it out.
  • virtual void audioRender (SoAudioRenderAction *action) — audio render, yes really.
  • virtual void grabEventsSetup (void) — sets up event grabbing.
  • virtual void grabEventsCleanup (void) — cleans up event grabbing.
  • virtual void startNotify (void) — kicks off notification.
  • virtual void notify (SoNotList *l) — notify with a list.
  • SbUniqueId getNodeId (void) const — the unique node id.
  • virtual void writeInstance (SoOutput *out) — writes an instance.
  • virtual SoNode * addToCopyDict (void) const — adds itself to the copy dict.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through a connection.

💜 Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void) — resets everything to defaults.
  • SbBool hasDefaultValues (void) const — are all the values default?
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — compares fields with another container.
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copies field values over, copyconnections defaults to FALSE.
  • SbBool set (const char *const fielddata) — sets from a fielddata string.
  • void get (SbString &fielddata) — gets the fielddata into an SbString.
  • virtual int getFields (SoFieldList &l) const — fills the field list.
  • virtual int getAllFields (SoFieldList &l) const — fills the list with all the fields.
  • virtual SoField * getField (const SbName &name) const — grabs a field by name.
  • virtual SoField * getEventIn (const SbName &name) const — grabs an event-in by name.
  • virtual SoField * getEventOut (const SbName &name) const — grabs an event-out by name.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — looks up a field's name.
  • SbBool enableNotify (const SbBool flag) — toggles notifications.
  • SbBool isNotifyEnabled (void) const — are notifications on?
  • SbBool set (const char *fielddata, SoInput *input) — sets from fielddata with an SoInput.
  • void get (SbString &fielddata, SoOutput *out) — gets fielddata with an SoOutput.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validates a new field value.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — adds a write reference, isfromfield defaults to FALSE.
  • SbBool getIsBuiltIn (void) const — is it built-in?
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — reports field memory sizes into managed and unmanaged.
  • void setUserData (void *userdata) const — attaches user data.
  • void * getUserData (void) const — retrieves user data.

🌈 Public Member Functions inherited from SoBase

  • void ref (void) const — bumps the ref count. 🫶
  • void unref (void) const — drops the ref count.
  • void unrefNoDelete (void) const — unrefs without deleting.
  • int32_t getRefCount (void) const — how many refs we holding?
  • void touch (void) — touches it (and the notification ripples out).
  • SbBool isOfType (SoType type) const — returns TRUE if the type of this object is either of the same type or inherited from type.
  • virtual SbName getName (void) const — gets the name.
  • virtual void setName (const SbName &newname) — sets the name.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes an auditor.
  • const SoAuditorList & getAuditors (void) const — returns the auditor list.
  • SbBool shouldWrite (void) — should it write?
  • void assertAlive (void) const — asserts it's still alive. dramatic but fair 💀

👑 Static Public Member Functions

  • static SoType getClassTypeId (void) — the class's SoType.
  • 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 SoTransformManip

  • static SoType getClassTypeId (void) — the class's SoType.
  • 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) — the class's SoType.
  • 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) — the class's SoType.
  • 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) — compatibility types for a node type.
  • static SoType getClassTypeId (void) — the class's SoType.
  • static SoNode * getByName (const SbName &name) — find a node by name.
  • static int getByName (const SbName &name, SoNodeList &l) — find nodes by name into a list.
  • 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) — initializes the classes (plural, slay).
  • static SbUniqueId getNextNodeId (void) — the next node id in line.
  • static int getActionMethodIndex (const SoType type) — the action method index for a type.
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — static bounding-box helper.
  • static void GLRenderS (SoAction *action, SoNode *node) — static GL render helper.
  • static void callbackS (SoAction *action, SoNode *node) — static callback helper.
  • static void getMatrixS (SoAction *action, SoNode *node) — static get-matrix helper.
  • static void handleEventS (SoAction *action, SoNode *node) — static handle-event helper.
  • static void pickS (SoAction *action, SoNode *node) — static pick helper.
  • static void rayPickS (SoAction *action, SoNode *node) — static ray-pick helper.
  • static void searchS (SoAction *action, SoNode *node) — static search helper.
  • static void writeS (SoAction *action, SoNode *node) — static write helper.
  • static void audioRenderS (SoAction *action, SoNode *node) — static audio-render helper.
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive-count helper.

🦋 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.
  • static void cleanupClass (void) — cleans up the class.
  • static void initCopyDict (void) — sets up the copy dict.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers a copy.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks for a copy.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds a copy, with copyconnections.
  • static void copyDone (void) — signals copying is done.

💖 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) — adds a name to a base.
  • static void removeName (SoBase *const base, const char *const name) — removes a name from a base.
  • static void incrementCurrentWriteCounter (void) — bumps the current write counter.
  • static void decrementCurrentWriteCounter (void) — drops the current write counter.
  • static SoBase * getNamedBase (const SbName &name, SoType type) — fetches a named base of a given type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — fetches named bases into a list.
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base from input.
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix.
  • static void setTraceRefs (SbBool trace) — toggles ref tracing.
  • static SbBool getTraceRefs (void) — gets the ref-trace setting.
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects a route between two fields.
  • static SbBool readRoute (SoInput *input) — reads a route from input.

🌸 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const — returns the field data.
  • virtual ~SoTrackballManip (void) — the destructor. bye bestie 🥲

💜 Protected Member Functions inherited from SoTransformManip

  • virtual ~SoTransformManip (void) — destructor.
  • void setDragger (SoDragger *newdragger) — sets a new dragger.
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) — copies contents from another field container.
  • void attachSensors (const SbBool onoff) — attaches or detaches sensors.

🎀 Protected Member Functions inherited from SoTransform

  • virtual ~SoTransform () — destructor.

⭐ Protected Member Functions inherited from SoTransformation

  • SoTransformation (void) — constructor.
  • virtual ~SoTransformation () — destructor.

🦋 Protected Member Functions inherited from SoNode

  • SoNode (void) — constructor.
  • virtual ~SoNode () — destructor.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance.

💫 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor.
  • virtual ~SoFieldContainer () — destructor.

🌈 Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor.
  • virtual ~SoBase () — destructor.
  • virtual void destroy (void) — destroys it.
  • SbBool hasMultipleWriteRefs (void) const — multiple write refs or nah?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes a header.
  • void writeFooter (SoOutput *out) const — writes a footer.
  • virtual const char * getFileFormatName (void) const — the file format name.
  • virtual SoNotRec createNotRec (void) — makes a notification record.

👑 Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer, don't think about it too hard, it's fine.

✨ Static Protected Member Functions inherited from SoTransformManip

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer.
  • static void transferFieldValues (const SoTransform *from, SoTransform *to) — moves field values from one transform to another.
  • static void valueChangedCB (void *f, SoDragger *d) — the value-changed callback.
  • static void fieldSensorCB (void *f, SoSensor *d) — the field-sensor callback.

🌟 Static Protected Member Functions inherited from SoTransform

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer.

🎀 Static Protected Member Functions inherited from SoTransformation

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer.

and bestie… that's just part one, we're not even done yet. don't go anywhere, there's more coming and it's gonna be so worth it 💖✨

🦋 Static Protected Member Functions inherited from SoNode

Like, these are the family heirlooms from SoNode that only the class itself and its subclasses get to touch, bestie. Internal vibes only:

  • 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

And these cuties come from SoBase, same energy:

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

🫶 Additional Inherited Members

Okay so this is the whole "everything your girl also got handed down" section, and it's a lot, so buckle up:

⭐ Public Types inherited from SoNode

The iconic NodeType enum, every single value, no skips, periodt:

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

These are the fields your girl inherits and totally shows off at the function:

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

🎀 Protected Types inherited from SoBase

Just one lil enum, living its protected life:

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

🌈 Protected Attributes inherited from SoTransformManip

The behind-the-scenes sensor squad and the children list. So much admin, honestly:

  • 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 point of SoTrackballManip? It wraps an SoTrackballDragger for you, because convenience is the moment. 🫶

The manipulator class takes care of wrapping up the SoTrackballDragger in a simple and convenient API for the application programmer, making it automatically surround the geometry it influences and taking care of the book-keeping routines for its interaction with the relevant fields of an SoTransformation node.

Here's a dead simple, standalone example on how to set up an SoTrackballManip in a scene graph — copy it, run it, slay:

#include <Inventor/Qt/SoQt.h>
#include <Inventor/Qt/viewers/SoQtExaminerViewer.h>
#include <Inventor/nodes/SoCone.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/manips/SoTrackballManip.h>

int
main(int argc, char* argv[])
{
  QWidget * mainwin = SoQt::init(argv[0]);

  SoSeparator * root = new SoSeparator;
  root->ref();

  SoTrackballManip * manip = new SoTrackballManip;
  root->addChild(manip);

  root->addChild(new SoCone);

  SoQtExaminerViewer * viewer = new SoQtExaminerViewer(mainwin);
  viewer->setSceneGraph(root);

  SoQt::show(mainwin);
  SoQt::mainLoop();

  root->unref();

  return 0;
}

Compile and hit 'ESC' to go into scene graph interaction mode in the examiner viewer, then change the rotation of the cone by interacting with the dragger bands. That's it, that's the whole vibe. 🔥

🎀 Constructor & Destructor Documentation

SoTrackballManip::SoTrackballManip (void )

Default constructor. Allocates an SoTrackballDragger and an SoSurroundScale node to surround the geometry within our part of the scene graph. It literally sets up its whole little world for you. 💖

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

Destructor. Cleanup time bestie, we don't leave messes.

💫 Member Function Documentation

SoType SoTrackballManip::getClassTypeId (void ) [static]

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

SoType SoTrackballManip::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 ** SoTrackballManip::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. So like… not your business, but okay, we're telling you anyway. 🙈

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

const SoFieldData * SoTrackballManip::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 — no cap, you read all of it. 🏆 This one's from Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's filed under SoTrackballManip(3). Go forth and rotate your cones. 💅🌈

📦 where this page comes from