SoDragPointDragger(3)
π SoDragPointDragger π
okay bestie, gather round, because this is SoDragPointDragger(3) from the Library Functions Manual, and it's genuinely one of the slay-est little draggers in the whole Coin/Inventor universe. β¨
πΈ NAME πΈ
SoDragPointDragger β the class that hands you the actual mechanisms for moving a point around in 3D. like, in space. three dimensions. iconic behaviour only. π
π¦ SYNOPSIS π¦
First things first, the summoning spell:
#include <Inventor/draggers/SoDragPointDragger.h>
Inherits SoDragger. yes bestie, it's giving dragger family lineage, and we love a class that knows its ancestors. π
β¨ Public Member Functions β¨
these are hers. her own methods, nobody else's:
virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoDragPointDragger (void)
void setJumpLimit (const float limit)
float getJumpLimit (void) const
void showNextDraggerSet (void)
π Public Member Functions inherited from SoDragger π
everything she got from her SoDragger parent, no cap:
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
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)
void setMotionMatrix (const SbMatrix &newmatrix)
void valueChanged (void)
const SbMatrix & getStartMotionMatrix (void)
virtual void saveStartParameters (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 ®)
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 π
the kit energy, the interaction vibes:
SoInteractionKit (void)
virtual SbBool setPartAsPath (const SbName &partname, SoPath *path)
virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node,
SbBool onlyifdefault=1)
virtual SbBool setPartAsDefault (const SbName &partname, const SbName
&nodename, SbBool onlyifdefault=1)
SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath
*&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool
fillargs=1)
SbBool isPathSurrogateInMySubgraph (const SoPath *path)
virtual SbBool setPart (const SbName &partname, SoNode *from)
π Public Member Functions inherited from SoBaseKit π
the base kit, the origin story, the blueprint:
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=0)
SbBool forceChildDrivenWriteRefs (SoOutput *out)
π Public Member Functions inherited from SoNode π
main character node energy fr fr:
void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=0) 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 π
fields, fields, and more fields:
void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
copyconnections=0)
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 *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const
π§ Public Member Functions inherited from SoBase π§
the O.G. base class, the foundation, the moment:
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 girlies, they don't need an instance to pop off:
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 ¢er)
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 SoNode * typeCheck (const SbName &partname, const SoType
&parttype, SoNode *node)
π¦ 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)
bestie that's just the synopsis and we already ate π the rest is coming in the next parts, so don't go anywhere β the actual description is about to serve. π
β¨ Static Public Member Functions inherited from SoFieldContainer β¨
okay so these are the static functions she inherits from SoFieldContainer, all of them, no skipping bestie:
static void initClass (void)β the classic class-setup moment πstatic SoType getClassTypeId (void)β hands you the class type id, slaystatic void initCopyDict (void)β get the copy dictionary ready β¨static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)β adds a copy to the dictstatic SoFieldContainer * checkCopy (const SoFieldContainer *orig)β checks that copy π«Άstatic SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)β goes looking for the copy, withcopyconnectionsin the mixstatic void copyDone (void)β copy's done, periodt
β¨ Static Public Member Functions inherited from SoBase β¨
and these are the ones from SoBase, they're giving legacy but make it iconic:
static void initClass (void)static SoType getClassTypeId (void)static void addName (SoBase *const base, const char *const name)β adds a name to a basestatic void removeName (SoBase *const base, const char *const name)β takes it back π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 *in, SoBase *&base, SoType expectedtype)static void setInstancePrefix (const SbString &c)static void setTraceRefs (SbBool trace)static SbBool getTraceRefs (void)static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)static SbBool readRoute (SoInput *in)
π Public Attributes π
SoSFVec3f translationβ the main character field, fr fr π
Public Attributes inherited from SoDragger
SoSFBool isActiveβ is she active or is she not π
Public Attributes inherited from SoInteractionKit
SoSFEnum renderCachingSoSFEnum boundingBoxCachingSoSFEnum renderCullingSoSFEnum pickCulling
π Protected Member Functions π
virtual const SoFieldData * getFieldData (void) const~SoDragPointDragger ()β the destructor, she's gotta go πvirtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)virtual void setDefaultOnNonWritingFields (void)void dragStart (void)β drag's starting bestievoid drag (void)β the dragging itselfvoid dragFinish (void)β and we're done, iconic
Protected Member Functions inherited from SoDragger
SoDragger (void)virtual ~SoDragger ()SbVec2f getNormalizedLocaterPosition (void)SbVec2s getLocaterPosition (void)SbVec2s getStartLocaterPosition (void) constvoid 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)virtual void getBoundingBox (SoGetBoundingBoxAction *action)void setActiveChildDragger (SoDragger *newchilddragger)SoDragger * getActiveChildDragger (void) constvoid updateDraggerCache (const SoPath *path)
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=1, SbBool onlyifdefault=1)virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1)SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0)void connectSeparatorFields (SoSeparator *dest, SbBool onOff)
Protected Member Functions inherited from SoBaseKit
virtual ~SoBaseKit ()virtual SoNode * addToCopyDict (void) constSoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1)virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0)virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL)virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1)void createNodekitPartsList (void)void createFieldList (void)virtual void createDefaultParts (void)const SoNodekitParts * getNodekitPartsList (void) constconst SbList< SoSFNode * > & getCatalogInstances (void) constvoid catalogError (void)void countMyFields (SoOutput *out)
Protected Member Functions inherited from SoNode
SoNode (void)virtual ~SoNode ()
Protected Member Functions inherited from SoFieldContainer
SoFieldContainer (void)~SoFieldContainer ()
Protected Member Functions inherited from SoBase
SoBase (void)virtual ~SoBase ()virtual void destroy (void)SbBool hasMultipleWriteRefs (void) constSbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) constvoid writeFooter (SoOutput *out) constvirtual const char * getFileFormatName (void) const
π Static Protected Member Functions π
static const SoFieldData ** getFieldDataPtr (void)static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)static void startCB (void *f, SoDragger *d)static void motionCB (void *f, SoDragger *d)static void finishCB (void *f, SoDragger *d)static void metaKeyChangeCB (void *f, SoDragger *d)static void fieldSensorCB (void *f, SoSensor *s)static void valueChangedCB (void *f, SoDragger *d)
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 *)
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 *)
Static Protected Member Functions inherited from SoBaseKit
static const SoFieldData ** getFieldDataPtr (void)static const SoNodekitCatalog ** getClassNodekitCatalogPtr (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)
π¦ Protected Attributes π¦
okay so this is a LOT of parts, and honestly? she ate:
SoSFNode noRotSepSoSFNode planeFeedbackSepSoSFNode planeFeedbackSwitchSoSFNode planeFeedbackTranslationSoSFNode rotXSoSFNode rotXSepSoSFNode rotYSoSFNode rotYSepSoSFNode rotZSoSFNode rotZSepSoSFNode xFeedbackSoSFNode xFeedbackSepSoSFNode xFeedbackSwitchSoSFNode xFeedbackTranslationSoSFNode xTranslatorSoSFNode xTranslatorSwitchSoSFNode xyFeedbackSoSFNode xyTranslatorSoSFNode xyTranslatorSwitchSoSFNode xzFeedbackSoSFNode xzTranslatorSoSFNode xzTranslatorSwitchSoSFNode yFeedbackSoSFNode yFeedbackSepSoSFNode yFeedbackSwitchSoSFNode yFeedbackTranslationSoSFNode yTranslatorSoSFNode yTranslatorSwitchSoSFNode yzFeedbackSoSFNode yzTranslatorSoSFNode yzTranslatorSwitchSoSFNode zFeedbackSoSFNode zFeedbackSepSoSFNode zFeedbackSwitchSoSFNode zFeedbackTranslationSoSFNode zTranslatorSoSFNode zTranslatorSwitchSoFieldSensor * fieldSensor
Protected Attributes inherited from SoDragger
SoSFNode motionMatrix
Protected Attributes inherited from SoInteractionKit
SoSFNode geomSeparatorSoSFNode topSeparatorSoFieldSensor * fieldSensorSoSeparator * oldTopSep
Protected Attributes inherited from SoBaseKit
SoSFNode callbackListSoChildList * childrenSbBool 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 }
Protected Types inherited from SoBase
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 0static int nextActionMethodIndex = 0
π DETAILED DESCRIPTION π
so like, what does SoDragPointDragger actually DO? The class provides mechanisms for moving a point in 3D. that's the whole vibe. π
Here's how the dragger looks with its default geometry in the inactive state:
(picture it, bestie β that's the image from the original page showing her default geometry just chilling, inactive β¨)
This dragger is convenient to use when it is desirable that the end-user should interact with points by positioning them freely in 3D space. lowkey perfect for that.
The dragger consists of a part for 2D motion in a plane (like the SoTranslate2Dragger) and another part on the axis normal to the plane. two parts, one iconic duo π«Ά
While the dragger is inactive (ie the user is not currently grabbing and / or dragging it's parts), the CTRL keys on the keyboard can be used to switch the orientation of the 2D-plane part and the normal-axis part so the normal-axis part points along one of the other principal axes. This is done by position the mouse pointer over the dragger geometry and pressing and releasing a CTRL key. π
ngl that CTRL-key thing only works while she's inactive β once someone's grabbing or dragging her parts, that's a different story, so don't come for me π
β¨ Constructor & Destructor Documentation β¨
Lowkey the most important part, bestie β this is where the dragger actually gets built. Let's get into it. π οΈ
SoDragPointDragger::SoDragPointDragger</p> (void)
Okay so this is the default constructor, and what it does is set up the dragger nodekit catalog with all the interaction and feedback geometry. Like, it's assembling the whole vibe from scratch. π
π Node kit structure
Fyi, new entries versus the parent class are marked with an arrow prefix β so if you see a -->, that's a fresh baby that this class brought into the world. π
CLASS SoDragPointDragger
-->"this"
"callbackList"
"topSeparator"
"motionMatrix"
--> "noRotSep"
--> "xTranslatorSwitch"
--> "xTranslator"
--> "xyTranslatorSwitch"
--> "xyTranslator"
--> "rotXSep"
--> "rotX"
--> "xzTranslatorSwitch"
--> "xzTranslator"
--> "rotYSep"
--> "rotY"
--> "zTranslatorSwitch"
--> "zTranslator"
--> "yzTranslatorSwitch"
--> "yzTranslator"
--> "rotZSep"
--> "rotZ"
--> "yTranslatorSwitch"
--> "yTranslator"
--> "xFeedbackSwitch"
--> "xFeedbackSep"
--> "xFeedbackTranslation"
--> "xFeedback"
--> "yFeedbackSwitch"
--> "yFeedbackSep"
--> "yFeedbackTranslation"
--> "yFeedback"
--> "zFeedbackSwitch"
--> "zFeedbackSep"
--> "zFeedbackTranslation"
--> "zFeedback"
--> "planeFeedbackSep"
--> "planeFeedbackTranslation"
--> "planeFeedbackSwitch"
--> "yzFeedback"
--> "xzFeedback"
--> "xyFeedback"
"geomSeparator"
If you're curious about the output formatting of all that, go peek at SoBaseKit::printDiagram(). π
π¦ Detailed information on catalog parts
And here's the full tea on the catalog parts, no detail left behind:
CLASS SoDragPointDragger
PVT "this", SoDragPointDragger ---
"callbackList", SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT "topSeparator", SoSeparator ---
PVT "motionMatrix", SoMatrixTransform ---
PVT "noRotSep", SoSeparator ---
PVT "xTranslatorSwitch", SoSwitch ---
"xTranslator", SoTranslate1Dragger ---
PVT "xyTranslatorSwitch", SoSwitch ---
"xyTranslator", SoTranslate2Dragger ---
PVT "rotXSep", SoSeparator ---
PVT "rotX", SoRotation ---
PVT "xzTranslatorSwitch", SoSwitch ---
"xzTranslator", SoTranslate2Dragger ---
PVT "rotYSep", SoSeparator ---
PVT "rotY", SoRotation ---
PVT "zTranslatorSwitch", SoSwitch ---
"zTranslator", SoTranslate1Dragger ---
PVT "yzTranslatorSwitch", SoSwitch ---
"yzTranslator", SoTranslate2Dragger ---
PVT "rotZSep", SoSeparator ---
PVT "rotZ", SoRotation ---
PVT "yTranslatorSwitch", SoSwitch ---
"yTranslator", SoTranslate1Dragger ---
PVT "xFeedbackSwitch", SoSwitch ---
PVT "xFeedbackSep", SoSeparator ---
PVT "xFeedbackTranslation", SoTranslation ---
"xFeedback", SoSeparator ---
PVT "yFeedbackSwitch", SoSwitch ---
PVT "yFeedbackSep", SoSeparator ---
PVT "yFeedbackTranslation", SoTranslation ---
"yFeedback", SoSeparator ---
PVT "zFeedbackSwitch", SoSwitch ---
PVT "zFeedbackSep", SoSeparator ---
PVT "zFeedbackTranslation", SoTranslation ---
"zFeedback", SoSeparator ---
PVT "planeFeedbackSep", SoSeparator ---
PVT "planeFeedbackTranslation", SoTranslation ---
PVT "planeFeedbackSwitch", SoSwitch ---
"yzFeedback", SoSeparator ---
"xzFeedback", SoSeparator ---
"xyFeedback", SoSeparator ---
PVT "geomSeparator", SoSeparator ---
Want the deets on that output formatting? That's SoBaseKit::printTable(). π«Ά
References β bestie this constructor is social, it pulls in a whole friend group: SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addOtherEventCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), fieldSensor, fieldSensorCB(), finishCB(), metaKeyChangeCB(), motionCB(), SoInteractionKit::readDefaultParts(), SoRotation::rotation, SoInteractionKit::setAnyPartAsDefault(), SoInteractionKit::setPartAsDefault(), SoInteractionKit::setSwitchValue(), setUpConnections(), SoDragPointDragger(), startCB(), translation, and valueChangedCB().
And it's also referenced by a bunch of them: fieldSensorCB(), finishCB(), getFieldData(), metaKeyChangeCB(), motionCB(), SoDragPointDragger(), startCB(), and valueChangedCB(). Mutuals fr fr. ππ
SoDragPointDragger::~SoDragPointDragger () [protected]
The protected destructor, bestie. It's giving backstage only energy. π
Quick reminder: dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0. So likeβ¦ no manual cleanup needed, she handles herself. π
β¨
References: fieldSensor. π
β¨ Member Function Documentation β¨
π SoType SoDragPointDragger::getTypeId (void) const [virtual]
okay bestie, this one hands you back the type identification of an object that derives from a class inheriting SoBase. What's it for? Run-time type checking and "downward" casting, that's what. β¨
Usage example, and yes you're gonna want to screenshot this:
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
}
}
So for application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or others β listen up β this method needs to be overridden in all subclasses. It's 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. π«Ά
Wanna know more about writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. iykyk π
π Reimplemented from SoDragger.
πΈ const SoFieldData * SoDragPointDragger::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 at all? It returns NULL. That's it, that's the whole vibe. π
π Reimplemented fromSoDragger. π References:SoDragPointDragger().
π¦ const SoNodekitCatalog * SoDragPointDragger::getNodekitCatalog (void) const [virtual]
Returns the nodekit catalog which defines the layout of this class' kit. The blueprint, the map, the whole floor plan. π
π Reimplemented from SoDragger.
π void SoDragPointDragger::setJumpLimit (const float limit)
okay so here's the tea: the dragger plane jump limit is ignored in Coin, because we use a continuous moving plane. no jumps, just smooth. β¨
This method still included for API compatibility with the original SGI Inventor API. (So it's basically a decorative little function. We keep it around out of respect.)
π float SoDragPointDragger::getJumpLimit (void) const
Same energy, bestie: the dragger plane jump limit is ignored in Coin, as we use a continuous moving plane. π
This method still included for API compatibility with the original SGI Inventor API.
π₯ void SoDragPointDragger::showNextDraggerSet (void)
This one circulates the dragger's three different sets of geometry β to circulate the orientation of the translation axis and translation plane through the three principal axes. Three sets, three axes, rotating through like a lil carousel. π
This function is triggered when the user taps the CTRL key. That's the whole secret handshake. π€«
π Referenced by metaKeyChangeCB().
π SbBool SoDragPointDragger::setUpConnections (SbBool onoff, SbBool doitalways = 0) [protected], [virtual]
Sets up all internal connections for instances of this class. Wiring up the whole friend group so everybody's in the group chat. π«Ά
(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 fromSoInteractionKit. π References:SoBaseKit::connectionsSetUp,fieldSensor,fieldSensorCB(),SoBaseKit::getAnyPart(),SoInteractionKit::setPartAsDefault(),SoBaseKit::setUpConnections(),SoDragger::SoDragger(), andtranslation. π Referenced bySoDragPointDragger().
π void SoDragPointDragger::setDefaultOnNonWritingFields (void) [protected], [virtual]
(Heads up: 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. Like, don't export that, it's not that girl. π
This is typically done when:
- field value is
NULLand part isNULLby default - it is a leaf
SoGrouporSoSeparatornode with no children - it is a leaf listpart with no children and an
SoGrouporSoSeparatorcontainer - it is a non-leaf part and it's of
SoGrouptype and all fields are at their default values
Subclasses should usually override this to do additional settings for new member fields. And from the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. Don't ghost your superclass, bestie. π
π Reimplemented fromSoDragger. π References:SoDragger::setDefaultOnNonWritingFields().
π§ void SoDragPointDragger::dragStart (void) [protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (Internal business. Not your business. But we love her anyway.)
Called when dragger is selected (picked) by the user. β¨
π References:SoDragger::getActiveChildDragger(),SoBase::isOfType(),SoInteractionKit::setSwitchValue(), andSoDragger::SoDragger(). π Referenced bystartCB().
π§ void SoDragPointDragger::drag (void) [protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Called when user drags the mouse after picking the dragger. Slay, drag it. π±οΈ
π Referenced by motionCB().
π§ void SoDragPointDragger::dragFinish (void) [protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Called when mouse button is released after picking and interacting with the dragger. We're done here, thank you for coming. π
π References:SoInteractionKit::setSwitchValue(). π Referenced byfinishCB().
β void SoDragPointDragger::startCB (void * d, 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.
π References:dragStart(),SoDragger::SoDragger(), andSoDragPointDragger(). π Referenced bySoDragPointDragger().
β void SoDragPointDragger::motionCB (void * d, 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.
π References:drag(),SoDragger::SoDragger(), andSoDragPointDragger(). π Referenced bySoDragPointDragger().
β void SoDragPointDragger::finishCB (void * d, 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.
π References:dragFinish(),SoDragger::SoDragger(), andSoDragPointDragger(). π Referenced bySoDragPointDragger().
β void SoDragPointDragger::metaKeyChangeCB (void * d, 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.
π References:SoDragger::getActiveChildDragger(),SoDragger::getEvent(),showNextDraggerSet(),SoDragger::SoDragger(), andSoDragPointDragger(). π Referenced bySoDragPointDragger().
β void SoDragPointDragger::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.
π References:SoDragger::getMotionMatrix(),SoDragger::setMotionMatrix(),SoDragPointDragger(), andSoDragger::workFieldsIntoTransform(). π Referenced bysetUpConnections(), andSoDragPointDragger().
β void SoDragPointDragger::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.
π References:SoFieldSensor::attach(),SoFieldSensor::detach(),fieldSensor,SoDragger::getMotionMatrix(),SoDragger::SoDragger(),SoDragPointDragger(), andtranslation. π Referenced bySoDragPointDragger().
πΎ Member Data Documentation πΎ
π SoSFVec3f SoDragPointDragger::translation
Continuously updated to contain the current translation from the dragger's local origo position. Like, always updating, never not updating. π
The application programmer applying this dragger in his code should connect the relevant node fields in the scene to this field to make it follow the dragger. Yes, you have to do the connecting. It won't do it itself. π
π Referenced bysetUpConnections(),SoDragPointDragger(), andvalueChangedCB().
π SoFieldSensor* SoDragPointDragger::fieldSensor [protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (Yep. Internal. Move along, nothing to see.)
π Referenced bysetUpConnections(),SoDragPointDragger(),valueChangedCB(), and~SoDragPointDragger().
π«Ά Author
Generated automatically by Doxygen for Coin from the source code. Not a human, just a lil robot doing its best. π
okay and that's the WHOLE page bestie, we did it π this was Coin, Version 2.5.0, and the man page is SoDragPointDragger(3) β go forth and drag those points, you absolute icon πβ¨
π¦ where this page comes from
- fedora 43: Coin2-devel 2.5.0-52.fc43 Β· GPL-2.0-only
- fedora 43: Coin2-devel 2.5.0-52.fc43 Β· GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 Β· GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 Β· GPL-2.0-only
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms