SoTransformerManip(3)

📦 version 2.5.0, in fedora 43, fedora 44

💅 SoTransformerManip 💅

Library Functions Manual · the SoTransformerManip(3) page, bestie ✨

🎀 NAME 🎀

SoTransformerManip — the little class that wraps an SoTransformerDragger for convenience 🫶

okay so real talk, that's the whole NAME section and it's literally doing the most with the least 💀

SoTransformerManip</purl> is a wrapper. It wraps an SoTransformerDragger. That's it, that's the whole job — it exists so you get all that dragger goodness conveniently, no cap. 👑

bestie this is part 1 of the page and more is coming, so don't go anywhere 💖

wrap it up, literally ✨

✨ SYNOPSIS ✨

okay bestie, deep breath, because this one is a menu. 💅

#include <Inventor/manips/SoTransformerManip.h>

Inherits SoTransformManip.

Basically it's a manipulator that carries its whole entire family tree around with it, and every single one of those inherited members is listed below because Coin3D does not gatekeep. Not one flag skipped, fr fr. 🫶

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const — hands you back the exact type id of this thing, so you can check who it really is.
  • SoTransformerManip (void) — the constructor, the birth of the icon.
  • SbBool isLocateHighlighting (void) — tells you whether locate highlighting is currently on or off.
  • void setLocateHighlighting (SbBool onoff) — flips locate highlighting to whatever you pass in.
  • void unsquishKnobs (void) — un-squishes the knobs. yes really. iconic behaviour. ✨

🌸 Public Member Functions inherited from SoTransformManip 🌸

  • SoTransformManip (void) — its constructor.
  • SoDragger * getDragger (void) — gives you the dragger it's using.
  • SbBool replaceNode (SoPath *p) — swaps the node at the end of p for this manip.
  • SbBool replaceManip (SoPath *p, SoTransform *newone) const — swaps this manip out for newone along the path p.
  • virtual void doAction (SoAction *action) — runs the given action.
  • virtual void callback (SoCallbackAction *action) — the callback-action handler.
  • virtual void GLRender (SoGLRenderAction *action) — the render-action handler.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — the bounding-box-action handler.
  • virtual void getMatrix (SoGetMatrixAction *action) — the get-matrix-action handler.
  • virtual void handleEvent (SoHandleEventAction *action) — the handle-event-action handler.
  • virtual void pick (SoPickAction *action) — the pick-action handler.
  • virtual void search (SoSearchAction *action) — the search-action handler.
  • virtual SoChildList * getChildren (void) const — the child list, exposed.

🦋 Public Member Functions inherited from SoTransform 🦋

  • SoTransform (void) — constructor.
  • void pointAt (const SbVec3f &frompoint, const SbVec3f &topoint) — aims this transform from one point at another.
  • void getScaleSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — gives you the scale-space matrix and its inverse.
  • void getRotationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — same deal but for rotation space.
  • void getTranslationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const — and again for translation space.
  • void multLeft (const SbMatrix &mat) — multiplies mat in on the left.
  • void multRight (const SbMatrix &mat) — multiplies mat in on the right.
  • void combineLeft (SoTransformation *nodeonright) — combines, with the other node on the right.
  • void combineRight (SoTransformation *nodeonleft) — combines, with the other node on the left.
  • void setMatrix (const SbMatrix &mat) — sets the transform from a raw matrix.
  • void recenter (const SbVec3f &newcenter) — moves the center to newcenter.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — the primitive-count-action handler.

🌈 Public Member Functions inherited from SoNode 🌈

  • void setOverride (const SbBool state) — sets override state on or off.
  • SbBool isOverride (void) const — are we overriding?
  • void setNodeType (const NodeType type) — sets the node type.
  • NodeType getNodeType (void) const — reads the node type back out.
  • virtual SoNode * copy (SbBool copyconnections=0) const — makes a copy, optionally carrying connections along.
  • virtual SbBool affectsState (void) const — does this node mess with the traversal 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) — the ray-pick-action handler.
  • virtual void write (SoWriteAction *action) — the write-action handler.
  • virtual void audioRender (SoAudioRenderAction *action) — the audio-render-action handler.
  • virtual void grabEventsSetup (void) — sets up event grabbing.
  • virtual void grabEventsCleanup (void) — cleans event grabbing back up.
  • virtual void startNotify (void) — kicks off notification.
  • virtual void notify (SoNotList *l) — notifies along the list l.
  • uint32_t getNodeId (void) const — its unique node id.
  • virtual void writeInstance (SoOutput *out) — writes this instance out.
  • virtual SoNode * addToCopyDict (void) const — adds itself to the copy dictionary.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through a connection.

💜 Public Member Functions inherited from SoFieldContainer 💜

  • void setToDefaults (void) — resets every field to its default.
  • SbBool hasDefaultValues (void) const — are all the fields sitting at defaults?
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — do my fields match container's?
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0) — copies field values from container, optionally with connections.
  • SbBool set (const char *const fielddata) — sets fields from a string of field data.
  • void get (SbString &fielddata) — reads the fields out as a string.
  • virtual int getFields (SoFieldList &l) const — fills l with the fields.
  • virtual int getAllFields (SoFieldList &l) const — fills l with all the fields.
  • virtual SoField * getField (const SbName &name) const — grabs the field called name.
  • virtual SoField * getEventIn (const SbName &name) const — grabs the event-in called name.
  • virtual SoField * getEventOut (const SbName &name) const — grabs the event-out called name.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — looks up the name of field.
  • SbBool enableNotify (const SbBool flag) — turns notification on or off.
  • SbBool isNotifyEnabled (void) const — is notification on?
  • SbBool set (const char *fielddata, SoInput *in) — sets fields from field data, reading through in.
  • void get (SbString &fielddata, SoOutput *out) — reads fields out as a string, writing through out.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — checks whether newval is legal for field.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0) — adds a write reference.
  • SbBool getIsBuiltIn (void) const — is this thing built in?
  • void setUserData (void *userdata) const — stashes a userdata pointer.
  • void * getUserData (void) const — gets that userdata pointer back.

⭐ Public Member Functions inherited from SoBase ⭐

  • void ref (void) const — bumps the reference count.
  • void unref (void) const — drops the reference count.
  • void unrefNoDelete (void) const — drops the refcount but never deletes.
  • int32_t getRefCount (void) const — what's the refcount at right now?
  • void touch (void) — touches it, so everything downstream knows something changed.
  • SbBool isOfType (SoType type) const — is it of type type?
  • virtual SbName getName (void) const — its name.
  • virtual void setName (const SbName &newname) — sets its name to newname.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — attaches an auditor of type.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — detaches that auditor.
  • const SoAuditorList & getAuditors (void) const — the whole auditor list.
  • SbBool shouldWrite (void) — should this be written out?
  • void assertAlive (void) const — asserts that it's still alive, bestie.

🎀 Static Public Member Functions 🎀

  • static SoType getClassTypeId (void) — the class type id.
  • static void initClass (void) — initialises the class.

🍓 Static Public Member Functions inherited from SoTransformManip 🍓

  • static SoType getClassTypeId (void) — the class type id.
  • static void initClass (void) — initialises the class.

🧚 Static Public Member Functions inherited from SoTransform 🧚

  • static SoType getClassTypeId (void) — the class type id.
  • static void initClass (void) — initialises the class.

💅 Static Public Member Functions inherited from SoTransformation 💅

  • static SoType getClassTypeId (void) — the class type id.
  • static void initClass (void) — initialises the class.

🔥 Static Public Member Functions inherited from SoNode 🔥

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — the compatibility bitmask for nodetype.
  • static SoType getClassTypeId (void) — the class type id.
  • static SoNode * getByName (const SbName &name) — finds a node by name.
  • static int getByName (const SbName &name, SoNodeList &l) — finds nodes by name and dumps them into l.
  • static void initClass (void) — initialises the class.
  • static void initClasses (void) — initialises all the classes.
  • static uint32_t getNextNodeId (void) — the next unique node id.
  • static int getActionMethodIndex (const SoType type) — the action method index for type.
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — the static bounding-box dispatch.
  • static void GLRenderS (SoAction *action, SoNode *node) — the static render dispatch.
  • static void callbackS (SoAction *action, SoNode *node) — the static callback dispatch.
  • static void getMatrixS (SoAction *action, SoNode *node) — the static get-matrix dispatch.
  • static void handleEventS (SoAction *action, SoNode *node) — the static handle-event dispatch.
  • static void pickS (SoAction *action, SoNode *node) — the static pick dispatch.
  • static void rayPickS (SoAction *action, SoNode *node) — the static ray-pick dispatch.
  • static void searchS (SoAction *action, SoNode *node) — the static search dispatch.
  • static void writeS (SoAction *action, SoNode *node) — the static write dispatch.
  • static void audioRenderS (SoAction *action, SoNode *node) — the static audio-render dispatch.
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — the static primitive-count dispatch.

🫶 Static Public Member Functions inherited from SoFieldContainer 🫶

  • static void initClass (void) — initialises the class.
  • static SoType getClassTypeId (void) — the class type id.
  • static void initCopyDict (void) — sets up the copy dictionary.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers copy as the copy of orig.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — looks up the copy of orig.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds the copy of orig, respecting copyconnections.
  • static void copyDone (void) — wraps up copying.

💀 Static Public Member Functions inherited from SoBase 💀

  • static void initClass (void) — initialises the class.
  • static SoType getClassTypeId (void) — the class type id.
  • static void addName (SoBase *const base, const char *const name) — names base as name.
  • static void removeName (SoBase *const base, const char *const name) — removes that name.
  • 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) — finds a base by name and type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — finds bases by name and type, into baselist.
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads a base out of in.
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix to c.
  • static void setTraceRefs (SbBool trace) — turns reference tracing on or off.
  • static SbBool getTraceRefs (void) — is reference tracing on?
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects a route from one node+field to another, through in.
  • static SbBool readRoute (SoInput *in) — reads a route out of in.

🙈 Protected Member Functions 🙈

  • virtual const SoFieldData * getFieldData (void) const — the field data.
  • ~SoTransformerManip () — the destructor.

🌸 Protected Member Functions inherited from SoTransformManip 🌸

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

💜 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 it.
  • SbBool hasMultipleWriteRefs (void) const — does it have multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header out.
  • void writeFooter (SoOutput *out) const — writes the footer out.
  • virtual const char * getFileFormatName (void) const — the file format name.

🌈 Static Protected Member Functions 🌈

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

🍓 Static Protected Member Functions inherited from SoTransformManip 🍓

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data.
  • static void transferFieldValues (const SoTransform *from, SoTransform *to) — moves field values from from to to.
  • 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) — pointer to the field data.

💅 Static Protected Member Functions inherited from SoTransformation 💅

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

🔥 Static Protected Member Functions inherited from SoNode 🔥

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

🫶 Static Protected Member Functions inherited from SoBase 🫶

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

👑 Additional Inherited Members 👑

💖 Public Types inherited from SoNode 💖

the enum of node types, all in one gorgeous block:

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 — the translation field.
  • SoSFRotation rotation — the rotation field.
  • SoSFVec3f scaleFactor — the scale factor field.
  • SoSFRotation scaleOrientation — the scale orientation field.
  • SoSFVec3f center — the center field.

🦋 Protected Types inherited from SoBase 🦋

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

🎀 Protected Attributes inherited from SoTransformManip 🎀

  • SoFieldSensor * rotateFieldSensor — the rotation field sensor.
  • SoFieldSensor * translFieldSensor — the translation field sensor.
  • SoFieldSensor * scaleFieldSensor — the scale field sensor.
  • SoFieldSensor * centerFieldSensor — the center field sensor.
  • SoFieldSensor * scaleOrientFieldSensor — the scale-orientation field sensor.
  • SoChildList * children — the children.

✨ Protected Attributes inherited from SoNode ✨

  • uint32_t uniqueId — the unique id.

💜 Protected Attributes inherited from SoFieldContainer 💜

  • SbBool isBuiltIn — is it built in?

⭐ Static Protected Attributes inherited from SoNode ⭐

  • static uint32_t nextUniqueId = 0 — the next unique id, starting at 0.
  • static int nextActionMethodIndex = 0 — the next action method index, starting at 0.

💫 DETAILED DESCRIPTION 💫

okay so real talk: SoTransformerManip is basically a little gift-wrap situation 🎁 for an SoTransformerDragger. That's the whole personality. It wraps it up.

The manipulator class does all the boring admin so you don't have to — it wraps the SoTransformerDragger in a simple and convenient API for the application programmer (that's you, bestie 🫶), it automatically surrounds the geometry it influences, and it handles all the book-keeping routines for how it vibes with the relevant fields of an SoTransformation node. lowkey iconic of it.

🧚 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🧚

SoTransformerManip::SoTransformerManip (void )

Default constructor, bestie. It allocates an SoTransformerDragger and an SoSurroundScale node, so the whole thing can surround the geometry inside our part of the scenegraph. very "I brought my own setup" energy ✨

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

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

SoTransformerManip::~SoTransformerManip () [protected]

Destructor. That's it, that's the whole thing. bye 👋💀

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

SoType SoTransformerManip::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what powers run-time type checking and "downward" casting — iykyk.

Usage example, copy it exactly bestie:

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

Now for the application programmers out there wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else: this method needs to be overridden in all subclasses. periodt. 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. 🛠️

Want more on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 📚

Reimplemented from SoTransformManip.

const SoFieldData * SoTransformerManip::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. empty-handed, no cap 🙈

Reimplemented from SoTransformManip.

References: SoTransformerManip().

SbBool SoTransformerManip::isLocateHighlighting (void )

Convenience function, bestie — it just uses the SoTransformerDragger::isLocateHighlighting() method of the embedded dragger. See the documentation of that method for the real tea. 🍵

References: SoTransformManip::getDragger(), SoBase::isOfType(), and SoDebugError::postWarning().

void SoTransformerManip::setLocateHighlighting (SbBool onoff)

Another convenience function, and yes it does what it says — it uses the SoTransformerDragger::setLocateHighlighting() method of the embedded dragger. Again, see that method's documentation. ✨

References: SoTransformManip::getDragger(), SoBase::isOfType(), and SoDebugError::postWarning().

void SoTransformerManip::unsquishKnobs (void )

Convenience function numero tres 💅 — it uses the SoTransformerDragger::unsquishKnobs() method of the embedded dragger. You already know: see the documentation of that method.

References: SoTransformManip::getDragger(), SoBase::isOfType(), and SoDebugError::postWarning().

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. not a human writing this, just a robot doing its lil thing 🤖✨

and that's a wrap on part 3, bestie 🎀 this whole page is from Coin, Version 2.5.0, filed under SoTransformerManip(3) — go forth and transform some stuff, you got this 💖🦋

📦 where this page comes from