SoCenterballDragger(3)

๐Ÿ“ฆ version 3.1.3, in fedora 43, fedora 44

๐Ÿ’– SoCenterballDragger(3) ๐Ÿ’–

okay bestie, welcome to the Library Functions Manual entry for SoCenterballDragger(3) โ€” she's a whole vibe and she's about to be explained to you with love, zero gatekeeping, and every single detail intact. ๐ŸŽ€


๐ŸŒธ NAME ๐ŸŒธ

SoCenterballDragger โ€” the class that is a dragger you can rotate and translate. ๐Ÿ’…


โœจ SYNOPSIS โœจ

First things first, you gotta pull her in:

#include <Inventor/draggers/SoCenterballDragger.h>

Inherits SoDragger. (yes, she comes from a distinguished line, we'll get to the whole family tree, don't even worry) ๐Ÿฆ‹

๐ŸŽ€ Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoCenterballDragger (void)
virtual void saveStartParameters (void)

๐Ÿ’œ Public Member Functions inherited from SoDragger

like, this is a LOT of inherited energy, but we're listing every single one because that's the rules and honestly? iconic. ๐Ÿ”ฅ

virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
void setProjectorEpsilon (const float epsilon)
float getProjectorEpsilon (void) const
void addStartCallback (SoDraggerCB *func, void *data=NULL)
void removeStartCallback (SoDraggerCB *func, void *data=NULL)
void addMotionCallback (SoDraggerCB *func, void *data=NULL)
void removeMotionCallback (SoDraggerCB *func, void *data=NULL)
void addFinishCallback (SoDraggerCB *func, void *data=NULL)
void removeFinishCallback (SoDraggerCB *func, void *data=NULL)
void addValueChangedCallback (SoDraggerCB *func, void *data=NULL)
void removeValueChangedCallback (SoDraggerCB *func, void *data=NULL)
void setMinGesture (int pixels)
int getMinGesture (void) const
SbBool enableValueChangedCallbacks (SbBool newval)
const SbMatrix & getMotionMatrix (void)
void addOtherEventCallback (SoDraggerCB *func, void *data=NULL)
void removeOtherEventCallback (SoDraggerCB *func, void *data=NULL)
void registerChildDragger (SoDragger *child)
void unregisterChildDragger (SoDragger *child)
void registerChildDraggerMovingIndependently (SoDragger *child)
void unregisterChildDraggerMovingIndependently (SoDragger *child)
SbMatrix getLocalToWorldMatrix (void)
SbMatrix getWorldToLocalMatrix (void)
SbVec3f getLocalStartingPoint (void)
SbVec3f getWorldStartingPoint (void)
void getPartToLocalMatrix (const SbName &partname, SbMatrix &parttolocalmatrix, SbMatrix &localtopartmatrix)
void transformMatrixLocalToWorld (const SbMatrix &frommatrix, SbMatrix &tomatrix)
void transformMatrixWorldToLocal (const SbMatrix &frommatrix, SbMatrix &tomatrix)
void transformMatrixToLocalSpace (const SbMatrix &frommatrix, SbMatrix &tomatrix, const SbName &fromspacepartname)
virtual void setMotionMatrix (const SbMatrix &newmatrix)
void valueChanged (void)
const SbMatrix & getStartMotionMatrix (void)
const SoPath * getPickPath (void) const
const SoEvent * getEvent (void) const
SoPath * createPathToThis (void)
const SoPath * getSurrogatePartPickedOwner (void) const
const SbName & getSurrogatePartPickedName (void) const
const SoPath * getSurrogatePartPickedPath (void) const
void setStartingPoint (const SoPickedPoint *newpoint)
void setStartingPoint (const SbVec3f &newpoint)
const SbViewVolume & getViewVolume (void)
void setViewVolume (const SbViewVolume &vol)
const SbViewportRegion & getViewportRegion (void)
void setViewportRegion (const SbViewportRegion &reg)
SoHandleEventAction * getHandleEventAction (void) const
void setHandleEventAction (SoHandleEventAction *newAction)
void setTempPathToThis (const SoPath *somethingclose)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
void workFieldsIntoTransform (SbMatrix &mtx)
void setFrontOnProjector (ProjectorFrontSetting newval)
ProjectorFrontSetting getFrontOnProjector (void) const

๐ŸŒˆ Public Member Functions inherited from SoInteractionKit

SoInteractionKit (void)
virtual SbBool setPartAsPath (const SbName &partname, SoPath *path)
virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node, SbBool onlyifdefault=TRUE)
virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=TRUE)
SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=TRUE)
SbBool isPathSurrogateInMySubgraph (const SoPath *path)
virtual SbBool setPart (const SbName &partname, SoNode *from)

๐Ÿซถ Public Member Functions inherited from SoBaseKit

SoBaseKit (void)
virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded)
SbString getPartString (const SoBase *part)
virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
SbBool set (const char *namevaluepairliststring)
SbBool set (const char *partnamestring, const char *parameterstring)
virtual void doAction (SoAction *action)
virtual SoChildList * getChildren (void) const
void printDiagram (void)
void printSubDiagram (const SbName &rootname, int level)
void printTable (void)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool forceChildDrivenWriteRefs (SoOutput *out)

โญ 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 pick (SoPickAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
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)
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
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 const SoNodekitCatalog * getClassNodekitCatalog (void)
static void initClass (void)

๐Ÿ’… Static Public Member Functions inherited from SoDragger

static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void setMinScale (float newminscale)
static float getMinScale (void)
static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr)
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center)
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation)
static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL)
static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL)
static void initClass (void)
static void initClasses (void)

๐ŸŒธ Static Public Member Functions inherited from SoInteractionKit

static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void initClass (void)
static void setSwitchValue (SoNode *node, const int newVal)

๐ŸŽ€ Static Public Member Functions inherited from SoBaseKit

static SoType getClassTypeId (void)
static void initClass (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static SbBool isSearchingChildren (void)
static void setSearchingChildren (const SbBool newval)

โœจ 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)
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)

okay that's the synopsis bestie and we are SO not done, there's more coming ๐Ÿ’– don't go anywhere ๐Ÿซถ

Static Public Member Functions inherited from SoFieldContainer

okay bestie, so these are the inherited static public member functions from SoFieldContainer. they're giving legacy foundation, no cap. here's the exact list, character for character:

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)

we love a static void moment, periodt ๐Ÿ’….


Static Public Member Functions inherited from SoBase

and now the SoBase ones, bestie. they're all static, all iconic, all here:

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)

ngl, connectRoute and readRoute are lowkey giving main character energy ๐Ÿฆ‹.


Public Attributes

these are the public attributes for SoCenterballDragger itself, bestie:

  • SoSFRotation rotation โ€” the rotation field, slay.
  • SoSFVec3f center โ€” the center field, also slay.

Public Attributes inherited from SoDragger

  • SoSFBool isActive โ€” inherited, but still cute.

Public Attributes inherited from SoInteractionKit

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling

these four are the caching queens ๐Ÿ‘‘.


Protected Member Functions

okay so these are the protected member functions for this class. they're giving inner circle, iykyk:

virtual const SoFieldData * getFieldData (void) const
virtual ~SoCenterballDragger (void)
void transferCenterDraggerMotion (SoDragger *childdragger)
void setSwitches (SoDragger *activechild)
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
virtual void setDefaultOnNonWritingFields (void)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)

transferCenterDraggerMotion? we love a motion transfer, fr fr ๐Ÿ’–.

Protected Member Functions inherited from SoDragger

SoDragger (void)
virtual ~SoDragger (void)
SbVec2f getNormalizedLocaterPosition (void)
SbVec2s getLocaterPosition (void)
SbVec2s getStartLocaterPosition (void) const
void setStartLocaterPosition (SbVec2s p)
SbBool isAdequateConstraintMotion (void)
virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const
    SoPath *surrogatepath)
void setCameraInfo (SoAction *action)
virtual void handleEvent (SoHandleEventAction *ha)
void transferMotion (SoDragger *child)
void setIgnoreInBbox (SbBool newval)
SbBool isIgnoreInBbox (void)
void setActiveChildDragger (SoDragger *newchilddragger)
SoDragger * getActiveChildDragger (void) const
void updateDraggerCache (const SoPath *path)

this list is long but we're obsessed, no cap โœจ.

Protected Member Functions inherited from SoInteractionKit

virtual ~SoInteractionKit ()
virtual void copyContents (const SoFieldContainer *fromFC, SbBool
    copyConnections)
virtual SbBool setPart (const int partNum, SoNode *node)
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode
    *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName
    &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool
    leafcheck=FALSE, SbBool publiccheck=FALSE)
void connectSeparatorFields (SoSeparator *dest, SbBool onOff)

setAnyPartAsDefault twice? not me seeing double, but okay ๐Ÿ’€.

Protected Member Functions inherited from SoBaseKit

virtual ~SoBaseKit ()
virtual SoNode * addToCopyDict (void) const
SoGroup * getContainerNode (const SbName &listname, SbBool
    makeifneeded=TRUE)
virtual SoNode * getAnyPart (const SbName &partname, SbBool
    makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname,
    SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool
    publiccheck=FALSE, const SoPath *pathtoextend=NULL)
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool
    anypart=TRUE)
void createNodekitPartsList (void)
void createFieldList (void)
virtual void createDefaultParts (void)
const SoNodekitParts * getNodekitPartsList (void) const
const SbList< SoSFNode * > & getCatalogInstances (void) const
void catalogError (void)
void countMyFields (SoOutput *out)

createPathToAnyPart with all those defaults? we love a flexible queen ๐ŸŒธ.

Protected Member Functions inherited from SoNode

SoNode (void)
virtual ~SoNode ()

short and sweet, just like a good constructor.

Protected Member Functions inherited from SoFieldContainer

SoFieldContainer (void)
virtual ~SoFieldContainer ()

more constructors, more vibes.

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

destroy? dramatic, but we respect it ๐Ÿ’….


Static Protected Member Functions

these are the static protected ones for this class, bestie:

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
static void fieldSensorCB (void *f, SoSensor *s)
static void valueChangedCB (void *f, SoDragger *d)
static void kidStartCB (void *f, SoDragger *d)
static void kidFinishCB (void *f, SoDragger *d)

kidStartCB and kidFinishCB? not the kid emojis ๐Ÿ˜ญ.

Static Protected Member Functions inherited from SoDragger

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
static void childTransferMotionAndValueChangedCB (void *, SoDragger *)
static void childValueChangedCB (void *, SoDragger *)
static void childStartCB (void *, SoDragger *)
static void childMotionCB (void *, SoDragger *)
static void childFinishCB (void *, SoDragger *)
static void childOtherEventCB (void *, SoDragger *)

all the child callbacks, giving family reunion ๐Ÿซถ.

Static Protected Member Functions inherited from SoInteractionKit

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
static void readDefaultParts (const char *fileName, const char
    defaultBuffer[], int defBufSize)
static void fieldSensorCB (void *, SoSensor *)

readDefaultParts is lowkey the blueprint, no cap.

Static Protected Member Functions inherited from SoBaseKit

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

just the two, short and iconic.

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)

setCompatibilityTypes with a bitmask? we love a bitwise moment ๐Ÿ”ฅ.

Static Protected Member Functions inherited from SoBase

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

lock and unlock, the original dynamic duo ๐Ÿ”.


Protected Attributes

okay so these are the protected attributes for SoCenterballDragger. they're all SoSFNode except the sensors. here's the whole squad:

  • SoSFNode XAxis
  • SoSFNode XAxisSwitch
  • SoSFNode XCenterChanger
  • SoSFNode XRotator
  • SoSFNode YAxis
  • SoSFNode YAxisSwitch
  • SoSFNode YCenterChanger
  • SoSFNode YRotator
  • SoSFNode ZAxis
  • SoSFNode ZAxisSwitch
  • SoSFNode ZCenterChanger
  • SoSFNode ZRotator
  • SoSFNode antiSquish
  • SoSFNode lightModel
  • SoSFNode rot2X90
  • SoSFNode rotX90
  • SoSFNode rotY90
  • SoSFNode rotator
  • SoSFNode surroundScale
  • SoSFNode translateToCenter
  • SoFieldSensor * rotFieldSensor
  • SoFieldSensor * centerFieldSensor

that's a lot of nodes, but we're not intimidated ๐Ÿ’ช.

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix

Protected Attributes inherited from SoInteractionKit

  • SoSFNode geomSeparator
  • SoSFNode topSeparator
  • SoFieldSensor * fieldSensor
  • SoSeparator * oldTopSep

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

Protected Attributes inherited from SoNode

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Additional Inherited Members

Public Types inherited from SoDragger

enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }

Public Types inherited from SoInteractionKit

enum CacheEnabled { OFF, ON, AUTO }

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 }

this enum is giving history lesson, but we appreciate the lore ๐Ÿ“š.

Protected Types inherited from SoBase

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

Static Protected Attributes inherited from SoNode

static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

โœจ Detailed Description โœจ

okay so bestie, the SoCenterballDragger class is a dragger you can rotate and translate. ๐Ÿ’…

Here's how the dragger looks with its default geometry in the inactive state: (imagine a cute little gizmo just vibing, inactive, default geometry, periodt โœจ)

For rotation, click either the ball "bands" to constrain rotation to happen around the normal vector of the disc, or anywhere else on the (invisible) ball for free-form rotation. ๐ŸŒ€

Translation is done by clicking and dragging any of the four arrow markers. Hold SHIFT to constrain translation to a single axis instead of in the plane. ๐Ÿ‘†

When translating, instead of modifying the translation part of the motion matrix, a center field is updated, and the geometry is moved using an internal transformation node. ๐Ÿ”„

Here's a simple usage example, in the form of a scene graph as an iv-file:

       #Inventor V2.1 ascii

       Separator {

          # The dragger, offset a little bit against the geometry to clip,
          # so as to not mess up the user interface.
          Separator {
             Translation { translation -4 0 0 }
             DEF cbdragger CenterballDragger { }
          }

          # The clipping plane sub-graph.
          TransformSeparator {

             # Connect transformations to those of the dragger.
             Rotation { rotation 0 0 1 0 = USE cbdragger . rotation }
             Translation { translation 0 0 0 = USE cbdragger . center }

             # Use a simple lineset-based indicator to show how the
             # clipping plane is situated in space.
             Coordinate3 {
                point [
                 0 2 2, 0 2 -2,
                 0 -2 2, 0 -2 -2,
                 0 2 -2, 0 -2 -2,
                 0 2 2, 0 -2 2
              ]
             }
             LineSet { numVertices [ 2, 2, 2, 2 ] }

             ClipPlane { }
          }

          # Then follows the geometry that gets clipped. For this
          # example, we use a simple sphere.

          Sphere { }
       }

Constructor & Destructor Documentation ๐ŸŽ€

SoCenterballDragger::SoCenterballDragger (void )

Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry. โœจ

Node kit structure (new entries versus parent class marked with arrow prefix):

       CLASS SoCenterballDragger
       -->"this"
             "callbackList"
             "topSeparator"
                "motionMatrix"
       -->      "translateToCenter"
       -->      "surroundScale"
       -->      "antiSquish"
       -->      "lightModel"
                "geomSeparator"
       -->         "XAxisSwitch"
       -->            "XAxis"
       -->         "YAxisSwitch"
       -->            "YAxis"
       -->         "ZAxisSwitch"
       -->            "ZAxis"
       -->      "rotator"
       -->      "YRotator"
       -->      "ZCenterChanger"
       -->      "rotX90"
       -->      "ZRotator"
       -->      "YCenterChanger"
       -->      "rotY90"
       -->      "XCenterChanger"
       -->      "rot2X90"
       -->      "XRotator"

(See SoBaseKit::printDiagram() for information about the output formatting.) ๐Ÿ“Š

Detailed information on catalog parts:

       CLASS SoCenterballDragger
       PVT   "this",  SoCenterballDragger  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
       PVT   "motionMatrix",  SoMatrixTransform  ---
             "translateToCenter",  SoMatrixTransform  ---
             "surroundScale",  SoSurroundScale  ---
             "antiSquish",  SoAntiSquish  ---
             "lightModel",  SoLightModel  ---
       PVT   "geomSeparator",  SoSeparator  ---
             "rotator",  SoRotateSphericalDragger  ---
             "YRotator",  SoRotateCylindricalDragger  ---
             "ZCenterChanger",  SoTranslate2Dragger  ---
       PVT   "rotX90",  SoRotation  ---
             "ZRotator",  SoRotateCylindricalDragger  ---
             "YCenterChanger",  SoTranslate2Dragger  ---
       PVT   "rotY90",  SoRotation  ---
             "XCenterChanger",  SoTranslate2Dragger  ---
       PVT   "rot2X90",  SoRotation  ---
       PVT   "XAxisSwitch",  SoSwitch  ---
             "XAxis",  SoSeparator  ---
       PVT   "YAxisSwitch",  SoSwitch  ---
             "YAxis",  SoSeparator  ---
       PVT   "ZAxisSwitch",  SoSwitch  ---
             "ZAxis",  SoSeparator  ---
             "XRotator",  SoRotateCylindricalDragger  ---

(See SoBaseKit::printTable() for information about the output formatting.) ๐Ÿ“‹

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

Protected destructor. ๐Ÿ”’

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.) ๐Ÿ’€

Member Function Documentation ๐Ÿ’–

SoType SoCenterballDragger::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 SoDragger.

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

const SoNodekitCatalog * SoCenterballDragger::getNodekitCatalog (void ) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit. ๐Ÿ—‚๏ธ

Reimplemented from SoDragger.

void SoCenterballDragger::saveStartParameters (void ) [virtual]

This is invoked to save start parameters, to enable draggers to calculate relative motion. ๐Ÿ’พ

Default method in superclass SoDragger just saves the motion matrix, but subclasses should overload this method if other data needs to be saved. ๐Ÿ”

Reimplemented from SoDragger.

void SoCenterballDragger::transferCenterDraggerMotion (SoDragger * childdragger) [protected]

Should be called after motion matrix has been updated by a child dragger. ๐Ÿ‘ถ

void SoCenterballDragger::setSwitches (SoDragger * activechild) [protected]

Sets values for the internal SoSwitch parts. If activechild == NULL, all feedback is deactivated. ๐Ÿ”Œ

SbBool SoCenterballDragger::setUpConnections (SbBool onoff, SbBool doitalways = FALSE) [protected], [virtual]

Sets up all internal connections for instances of this class. ๐Ÿ”—

(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.) ๐Ÿ“–

Reimplemented from SoInteractionKit.

void SoCenterballDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual]

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.) ๐Ÿ‘€

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations. ๐Ÿšซ

This is typically done when:

  1. field value is NULL and part is NULL by default
  2. it is a leaf SoGroup or SoSeparator node with no children
  3. it is a leaf listpart with no children and an SoGroup or SoSeparator container
  4. it is a non-leaf part and it's of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. โฌ†๏ธ

Reimplemented from SoDragger.

void SoCenterballDragger::fieldSensorCB (void * d, SoSensor * s) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. ๐Ÿ™ˆ

void SoCenterballDragger::valueChangedCB (void * f, SoDragger * d) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. ๐Ÿ™ˆ

void SoCenterballDragger::kidStartCB (void * d, SoDragger * child) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. ๐Ÿ™ˆ

Needed to activate some feedback. โœจ

void SoCenterballDragger::kidFinishCB (void * f, SoDragger * d) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. ๐Ÿ™ˆ

Needed to deactive some feedback. (yes, "deactive", keep it exactly, bestie) ๐Ÿ’…

void SoCenterballDragger::getBoundingBox (SoGetBoundingBoxAction * action) [protected], [virtual]

Action method for the SoGetBoundingBoxAction. ๐Ÿ“ฆ

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. ๐Ÿ“

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables. ๐Ÿง 

Reimplemented from SoDragger.

void SoCenterballDragger::getMatrix (SoGetMatrixAction * action) [protected], [virtual]

Action method for SoGetMatrixAction. ๐Ÿงฎ

Updates action by accumulating with the transformation matrix of this node (if any). ๐Ÿ”„

Reimplemented from SoDragger.

Member Data Documentation ๐Ÿงธ

SoSFRotation SoCenterballDragger::rotation

This field is continuously updated to contain the rotation of the ball. ๐ŸŽพ

SoSFVec3f SoCenterballDragger::center

Continuously updated to contain the current translation from the dragger's internal local origo position. ๐Ÿ“

SoFieldSensor* SoCenterballDragger::rotFieldSensor [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. ๐Ÿ™ˆ

SoFieldSensor* SoCenterballDragger::centerFieldSensor [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. ๐Ÿ™ˆ

Author ๐Ÿ“

Generated automatically by Doxygen for Coin from the source code. ๐Ÿค–


That's the whole page bestie! Coin version 3.1.3, page SoCenterballDragger(3). You're welcome, periodt. ๐Ÿ’–โœจ

๐Ÿ“ฆ where this page comes from