SoTransformerManip(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’– SoTransformerManip(3) πŸ’–

Library Functions Manual ✨ Coin / Open Inventor land

okay so. hi bestie 🫢 welcome to SoTransformerManip, section 3 of the manual, and she is a long one. like, genuinely. this whole page comes in 2 parts and you're reading part 1 rn, so don't wander off, there's more coming.


🌸 NAME 🌸

SoTransformerManip β€” the manip that wraps an SoTransformerDragger for you. that's literally the whole pitch: convenience. she's a wrapper, she's helpful, she's doing the most so you don't have to πŸ’…


✨ SYNOPSIS ✨

#include <Inventor/manips/SoTransformerManip.h>

she inherits from SoTransformManip, so like... a lot of what she can do, she got from her ancestors. family tree moment 🌳


πŸŽ€ Public Member Functions πŸŽ€

the ones that are actually hers:

  • virtual SoType getTypeId (void) const β€” tells you her exact type id, the real one, runtime-style.
  • SoTransformerManip (void) β€” the constructor. makes a fresh one. hi queen πŸ‘‘
  • SbBool isLocateHighlighting (void) β€” asks "is locate highlighting on rn?" and gives you an SbBool back.
  • void setLocateHighlighting (SbBool onoff) β€” flips locate highlighting on or off. you pass onoff, she handles it.
  • void unsquishKnobs (void) β€” un-squishes the knobs. yes that's the actual name and yes it's iconic πŸŽ€

🌈 Public Member Functions inherited from SoTransformManip 🌈

all the stuff she gets handed down, no notes:

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 πŸ¦‹

transformation math, the whole buffet:

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 ⭐

the node essentials. copy, notify, render, pick, write, all of it:

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 πŸ’œ

fields, notifications, user data β€” the admin side of the family:

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 🌟

the literal root of everything. ref counting, names, auditors:

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 πŸ”₯

hers, and only hers:

  • static SoType getClassTypeId (void) β€” the class-level type id. static btw.
  • static void initClass (void) β€” does the class setup. call it once, she's ready.

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

this list is a whole meal, but every single one stays:

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 πŸ’œ

copy-dict bookkeeping central:

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 🌟

naming, ref tracing, routes β€” all the behind-the-scenes stuff:

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 🧚

for the class and her subclasses only, no outsiders:

  • virtual const SoFieldData * getFieldData (void) const β€” hands over the field data.
  • virtual ~SoTransformerManip (void) β€” the destructor. protected, so she goes out quietly πŸ™ˆ

🌸 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) β€” a pointer to the field data pointer. she keeps it protected, iykyk.

🌈 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 πŸŽ€

the extra bits that come along for the ride:

πŸ‘‘ Public Types inherited from SoNode πŸ‘‘

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 πŸ‘‘

these five fields come free with the inheritance, no cap:

SoSFVec3f translation
SoSFRotation rotation
SoSFVec3f scaleFactor
SoSFRotation scaleOrientation
SoSFVec3f center

πŸ‘‘ Protected Types inherited from SoBase πŸ‘‘

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

okay that's the SYNOPSIS fully served, every last inherited member, nothing skipped bestie πŸ’… part 2 is coming with the rest of the page, so keep scrolling, we're not done yet πŸ¦‹

πŸ’– Protected Attributes inherited from SoTransformManip πŸ’–

Okay so these are the protected attributes you inherit from SoTransformManip, bestie. They're not yours to touch directly, but they're part of the whole situation:

  • SoFieldSensor * rotateFieldSensor β€” lowkey iconic.
  • SoFieldSensor * translFieldSensor β€” no cap.
  • SoFieldSensor * scaleFieldSensor β€” slay.
  • SoFieldSensor * centerFieldSensor β€” periodt.
  • SoFieldSensor * scaleOrientFieldSensor β€” fr fr.
  • SoChildList * children β€” main character energy.

🌸 Protected Attributes inherited from SoNode 🌸

  • uint32_t uniqueId β€” the unique ID, iykyk.

πŸ¦‹ Protected Attributes inherited from SoFieldContainer πŸ¦‹

  • SbBool isBuiltIn β€” built-in flag, vibes.

✨ Static Protected Attributes inherited from SoNode ✨

  • static uint32_t nextUniqueId = 1 β€” starting at 1, periodt.
  • static int nextActionMethodIndex = 0 β€” starting at 0, slay.

πŸ’… Detailed Description πŸ’…

Okay so <hotpink>SoTransformerManip</hotpink>? It literally wraps an SoTransformerDragger for convenience. The manipulator class takes care of wrapping up the SoTransformerDragger in a simple and convenient API for the application programmer. It makes it automatically surround the geometry it influences, and it handles the book-keeping routines for its interaction with the relevant fields of an SoTransformation node. Periodt.

πŸŽ€ Constructor & Destructor Documentation πŸŽ€

SoTransformerManip::SoTransformerManip (void )

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

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

Destructor. Bye bestie.

⭐ Member Function Documentation ⭐

SoType SoTransformerManip::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.

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

For more information on writing Coin extensions, see 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. If no fields are present, returns NULL.

Reimplemented from SoTransformManip.

SbBool SoTransformerManip::isLocateHighlighting (void )

Convenience function to use the SoTransformerDragger::isLocateHighlighting() method of the embedded dragger. See documentation of that method.

void SoTransformerManip::setLocateHighlighting (SbBool onoff)

Convenience function to use the SoTransformerDragger::setLocateHighlighting() method of the embedded dragger. See documentation of that method.

void SoTransformerManip::unsquishKnobs (void )

Convenience function to use the SoTransformerDragger::unsquishKnobs() method of the embedded dragger. See documentation of that method.

πŸ“ Author πŸ“

Generated automatically by Doxygen for Coin from the source code.


And that's the tea, bestie. This page was brought to you by Coin, version 3.1.3, for SoTransformerManip(3). Stay slaying. πŸ’–βœ¨

πŸ“¦ where this page comes from