SoTrackballManip(3)

📦 version 2.5.0, in fedora 43, fedora 44

💫 SoTrackballManip 💫

okay bestie, welcome to the manual page for SoTrackballManip — it lives in section 3 of the library functions manuals, iykyk 🎀

✨ NAME ✨

SoTrackballManip — the way this one wraps an SoTrackballDragger purely for convenience, no cap 💅

like, that's the whole vibe. it's a glow-up wrapper so you don't have to build the dragger situation yourself 🦋

more parts of this page are coming, bestie — don't go anywhere 🌸

✨ SYNOPSIS ✨

okay bestie, if you wanna use this iconic manip, you gotta pull in the header first:

#include <Inventor/manips/SoTrackballManip.h>

and lowkey important: it inherits from SoTransformManip. no cap. 💅

💖 Public Member Functions 💖

These are the main character functions that belong to SoTrackballManip itself:

  • virtual SoType getTypeId (void) const — returns the SoType, type ID check. ✨
  • SoTrackballManip (void) — the constructor, slay. 🎀

🦋 Public Member Functions inherited from SoTransformManip 🦋

These are the ones you get from the parent, but they still work for you:

  • SoTransformManip (void) — constructor from SoTransformManip.
  • SoDragger * getDragger (void) — gets the dragger.
  • SbBool replaceNode (SoPath *p) — replaces a node.
  • SbBool replaceManip (SoPath *p, SoTransform *newone) const — replaces the manip.
  • virtual void doAction (SoAction *action) — does an action.
  • virtual void callback (SoCallbackAction *action) — callback action.
  • virtual void GLRender (SoGLRenderAction *action) — GL render action.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — gets bounding box.
  • virtual void getMatrix (SoGetMatrixAction *action) — gets matrix.
  • virtual void handleEvent (SoHandleEventAction *action) — handles event.
  • virtual void pick (SoPickAction *action) — picks.
  • virtual void search (SoSearchAction *action) — searches.
  • virtual SoChildList * getChildren (void) const — gets children.

🌈 Public Member Functions inherited from SoTransform 🌈

  • SoTransform (void) — constructor.
  • void pointAt (const SbVec3f &frompoint, const SbVec3f &topoint) — points at.
  • void getScaleSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — gets scale space matrix.
  • void getRotationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — gets rotation space matrix.
  • void getTranslationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — gets translation space matrix.
  • void multLeft (const SbMatrix &mat) — multiplies left.
  • void multRight (const SbMatrix &mat) — multiplies right.
  • void combineLeft (SoTransformation *nodeonright) — combines left.
  • void combineRight (SoTransformation *nodeonleft) — combines right.
  • void setMatrix (const SbMatrix &mat) — sets matrix.
  • void recenter (const SbVec3f &newcenter) — recenters.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — gets primitive count.

💜 Public Member Functions inherited from SoNode 💜

  • void setOverride (const SbBool state) — sets override.
  • SbBool isOverride (void) const — is override?
  • void setNodeType (const NodeType type) — sets node type.
  • NodeType getNodeType (void) const — gets node type.
  • virtual SoNode * copy (SbBool copyconnections=0) const — copies.
  • virtual SbBool affectsState (void) const — affects state?
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — GL render below path.
  • virtual void GLRenderInPath (SoGLRenderAction *action) — GL render in path.
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — GL render off path.
  • virtual void rayPick (SoRayPickAction *action) — ray pick.
  • virtual void write (SoWriteAction *action) — write.
  • virtual void audioRender (SoAudioRenderAction *action) — audio render.
  • virtual void grabEventsSetup (void) — grab events setup.
  • virtual void grabEventsCleanup (void) — grab events cleanup.
  • virtual void startNotify (void) — start notify.
  • virtual void notify (SoNotList *l) — notify.
  • uint32_t getNodeId (void) const — gets node ID.
  • virtual void writeInstance (SoOutput *out) — write instance.
  • virtual SoNode * addToCopyDict (void) const — adds to copy dict.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through connection.

🫶 Public Member Functions inherited from SoFieldContainer 🫶

  • void setToDefaults (void) — sets to defaults.
  • SbBool hasDefaultValues (void) const — has default values?
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — fields are equal?
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0) — copies field values.
  • SbBool set (const char *const fielddata) — sets.
  • void get (SbString &fielddata) — gets.
  • virtual int getFields (SoFieldList &l) const — gets fields.
  • virtual int getAllFields (SoFieldList &l) const — gets all fields.
  • virtual SoField * getField (const SbName &name) const — gets field.
  • virtual SoField * getEventIn (const SbName &name) const — gets event in.
  • virtual SoField * getEventOut (const SbName &name) const — gets event out.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — gets field name.
  • SbBool enableNotify (const SbBool flag) — enables notify.
  • SbBool isNotifyEnabled (void) const — is notify enabled?
  • SbBool set (const char *fielddata, SoInput *in) — sets with input.
  • void get (SbString &fielddata, SoOutput *out) — gets with output.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validates new field value.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0) — adds write reference.
  • SbBool getIsBuiltIn (void) const — gets is built in.
  • void setUserData (void *userdata) const — sets user data.
  • void * getUserData (void) const — gets user data.

🌟 Public Member Functions inherited from SoBase 🌟

  • void ref (void) const — ref.
  • void unref (void) const — unref.
  • void unrefNoDelete (void) const — unref no delete.
  • int32_t getRefCount (void) const — gets ref count.
  • void touch (void) — touch.
  • SbBool isOfType (SoType type) const — is of type?
  • virtual SbName getName (void) const — gets name.
  • virtual void setName (const SbName &newname) — sets name.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — adds auditor.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes auditor.
  • const SoAuditorList & getAuditors (void) const — gets auditors.
  • SbBool shouldWrite (void) — should write?
  • void assertAlive (void) const — assert alive.

✨ Static Public Member Functions ✨

  • static SoType getClassTypeId (void) — gets class type ID.
  • static void initClass (void) — inits class.

🎀 Static Public Member Functions inherited from SoTransformManip 🎀

  • static SoType getClassTypeId (void) — gets class type ID.
  • static void initClass (void) — inits class.

🎀 Static Public Member Functions inherited from SoTransform 🎀

  • static SoType getClassTypeId (void) — gets class type ID.
  • static void initClass (void) — inits class.

🎀 Static Public Member Functions inherited from SoTransformation 🎀

  • static SoType getClassTypeId (void) — gets class type ID.
  • static void initClass (void) — inits class.

🧚 Static Public Member Functions inherited from SoNode 🧚

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — gets compatibility types.
  • static SoType getClassTypeId (void) — gets class type ID.
  • static SoNode * getByName (const SbName &name) — gets by name.
  • static int getByName (const SbName &name, SoNodeList &l) — gets by name with list.
  • static void initClass (void) — inits class.
  • static void initClasses (void) — inits classes.
  • static uint32_t getNextNodeId (void) — gets next node ID.
  • static int getActionMethodIndex (const SoType type) — gets action method index.
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — getBoundingBoxS.
  • static void GLRenderS (SoAction *action, SoNode *node) — GLRenderS.
  • static void callbackS (SoAction *action, SoNode *node) — callbackS.
  • static void getMatrixS (SoAction *action, SoNode *node) — getMatrixS.
  • static void handleEventS (SoAction *action, SoNode *node) — handleEventS.
  • static void pickS (SoAction *action, SoNode *node) — pickS.
  • static void rayPickS (SoAction *action, SoNode *node) — rayPickS.
  • static void searchS (SoAction *action, SoNode *node) — searchS.
  • static void writeS (SoAction *action, SoNode *node) — writeS.
  • static void audioRenderS (SoAction *action, SoNode *node) — audioRenderS.
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — getPrimitiveCountS.

💖 Static Public Member Functions inherited from SoFieldContainer 💖

  • static void initClass (void) — inits class.
  • static SoType getClassTypeId (void) — gets class type ID.
  • static void initCopyDict (void) — inits copy dict.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — adds copy.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks copy.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds copy.
  • static void copyDone (void) — copy done.

🌸 Static Public Member Functions inherited from SoBase 🌸

  • static void initClass (void) — inits class.
  • static SoType getClassTypeId (void) — gets class type ID.
  • static void addName (SoBase *const base, const char *const name) — adds name.
  • static void removeName (SoBase *const base, const char *const name) — removes name.
  • static void incrementCurrentWriteCounter (void) — increments current write counter.
  • static void decrementCurrentWriteCounter (void) — decrements current write counter.
  • static SoBase * getNamedBase (const SbName &name, SoType type) — gets named base.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — gets named bases.
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads.
  • static void setInstancePrefix (const SbString &c) — sets instance prefix.
  • static void setTraceRefs (SbBool trace) — sets trace refs.
  • static SbBool getTraceRefs (void) — gets trace refs.
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects route.
  • static SbBool readRoute (SoInput *in) — reads route.

🔒 Protected Member Functions 🔒

  • virtual const SoFieldData * getFieldData (void) const — gets field data.
  • ~SoTrackballManip () — destructor, rip. 💀

🛡️ Protected Member Functions inherited from SoTransformManip 🛡️

  • ~SoTransformManip () — destructor.
  • void setDragger (SoDragger *newdragger) — sets dragger.
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) — copies contents.
  • void attachSensors (const SbBool onoff) — attaches 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 instance.

🛡️ Protected Member Functions inherited from SoFieldContainer 🛡️

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

🛡️ Protected Member Functions inherited from SoBase 🛡️

  • SoBase (void) — constructor.
  • virtual ~SoBase () — destructor.
  • virtual void destroy (void) — destroys.
  • SbBool hasMultipleWriteRefs (void) const — has multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes header.
  • void writeFooter (SoOutput *out) const — writes footer.
  • virtual const char * getFileFormatName (void) const — gets file format name.

🧚 Static Protected Member Functions 🧚

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

🌟 Static Protected Member Functions inherited from SoTransformManip 🌟

  • static const SoFieldData ** getFieldDataPtr (void) — gets field data pointer.
  • static void transferFieldValues (const SoTransform *from, SoTransform *to) — transfers field values.
  • static void valueChangedCB (void *f, SoDragger *d) — value changed callback.
  • static void fieldSensorCB (void *f, SoSensor *d) — field sensor callback.

🌟 Static Protected Member Functions inherited from SoTransform 🌟

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

🌟 Static Protected Member Functions inherited from SoTransformation 🌟

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

🌟 Static Protected Member Functions inherited from SoNode 🌟

  • static const SoFieldData ** getFieldDataPtr (void) — gets field data pointer.
  • static void setNextActionMethodIndex (int index) — sets next action method index.
  • static int getNextActionMethodIndex (void) — gets next action method index.
  • static void incNextActionMethodIndex (void) — increments next action method index.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types.

🌟 Static Protected Member Functions inherited from SoBase 🌟

  • static uint32_t getCurrentWriteCounter (void) — gets current write counter.
  • static void staticDataLock (void) — locks static data.
  • static void staticDataUnlock (void) — unlocks static data.

👑 Additional Inherited Members 👑

💅 Public Types inherited from SoNode 💅

Here's the iconic enum:

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

✨ Detailed Description ✨

okay so SoTrackballManip is literally the bestie wrapper for SoTrackballDragger — convenience core, no cap. 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. It's giving "I got you, babe" energy. 💅

Here's a dead simple, stand-alone example on how to set up an SoTrackballManip in a scenegraph:

#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 scenegraph interaction mode in the examinerviewer, then change the rotation of the cone by interacting with the dragger bands. Obsessed. 🌀

🛠️ Constructor & Destructor Documentation 🛠️

SoTrackballManip::SoTrackballManip (void )

Default constructor. Allocates an SoTrackballDragger and an SoSurroundScale node to surround the geometry within our part of the scenegraph.

  • References SoBaseKit::getPart(), SoSurroundScale::numNodesUpToContainer, SoSurroundScale::numNodesUpToReset, SoTransformManip::setDragger(), and SoTrackballManip().
  • Referenced by getFieldData(), and SoTrackballManip().

SoTrackballManip::~SoTrackballManip () [protected]

Destructor. That's it, she's done. 💀

🧠 Member Function Documentation 🧠

SoType SoTrackballManip::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. iykyk.

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. 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 (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. Periodt.

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

  • Reimplemented from SoTransformManip.

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. No fields? No problem. 💅

  • Reimplemented from SoTransformManip.
  • References SoTrackballManip().

📝 Author 📝

Generated automatically by Doxygen for Coin from the source code. Not me reading the source code like a romance novel. 📖

💖 okay bestie, that's the whole page — this is the SoTrackballManip(3) page from Coin Version 2.5.0, and the date? Not on this one, but the vibe is eternal. stay slay, keep casting downward safely, mwah 💅✨

📦 where this page comes from