Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
SoCenterballDragger Class Reference

The SoCenterballDragger class is a dragger you can rotate and translate. More...

#include <Inventor/draggers/SoCenterballDragger.h>

Inheritance diagram for SoCenterballDragger:
SoDragger SoInteractionKit SoBaseKit SoNode SoFieldContainer SoBase

Public Member Functions

 SoCenterballDragger (void)
 
virtual const SoNodekitCataloggetNodekitCatalog (void) const
 
virtual SoType getTypeId (void) const
 
virtual void saveStartParameters (void)
 
- Public Member Functions inherited from SoDragger
void addFinishCallback (SoDraggerCB *func, void *data=NULL)
 
void addMotionCallback (SoDraggerCB *func, void *data=NULL)
 
void addOtherEventCallback (SoDraggerCB *func, void *data=NULL)
 
void addStartCallback (SoDraggerCB *func, void *data=NULL)
 
void addValueChangedCallback (SoDraggerCB *func, void *data=NULL)
 
virtual void callback (SoCallbackAction *action)
 
SoPathcreatePathToThis (void)
 
SbBool enableValueChangedCallbacks (SbBool newval)
 
const SoEventgetEvent (void) const
 
ProjectorFrontSetting getFrontOnProjector (void) const
 
SoHandleEventActiongetHandleEventAction (void) const
 
SbVec3f getLocalStartingPoint (void)
 
SbMatrix getLocalToWorldMatrix (void)
 
int getMinGesture (void) const
 
const SbMatrixgetMotionMatrix (void)
 
void getPartToLocalMatrix (const SbName &partname, SbMatrix &parttolocalmatrix, SbMatrix &localtopartmatrix)
 
const SoPathgetPickPath (void) const
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
float getProjectorEpsilon (void) const
 
const SbMatrixgetStartMotionMatrix (void)
 
const SbNamegetSurrogatePartPickedName (void) const
 
const SoPathgetSurrogatePartPickedOwner (void) const
 
const SoPathgetSurrogatePartPickedPath (void) const
 
const SbViewportRegiongetViewportRegion (void)
 
const SbViewVolumegetViewVolume (void)
 
SbVec3f getWorldStartingPoint (void)
 
SbMatrix getWorldToLocalMatrix (void)
 
virtual void GLRender (SoGLRenderAction *action)
 
virtual void grabEventsCleanup (void)
 
virtual void grabEventsSetup (void)
 
virtual void rayPick (SoRayPickAction *action)
 
void registerChildDragger (SoDragger *child)
 
void registerChildDraggerMovingIndependently (SoDragger *child)
 
void removeFinishCallback (SoDraggerCB *func, void *data=NULL)
 
void removeMotionCallback (SoDraggerCB *func, void *data=NULL)
 
void removeOtherEventCallback (SoDraggerCB *func, void *data=NULL)
 
void removeStartCallback (SoDraggerCB *func, void *data=NULL)
 
void removeValueChangedCallback (SoDraggerCB *func, void *data=NULL)
 
virtual void search (SoSearchAction *action)
 
void setFrontOnProjector (ProjectorFrontSetting newval)
 
void setHandleEventAction (SoHandleEventAction *newAction)
 
void setMinGesture (int pixels)
 
virtual void setMotionMatrix (const SbMatrix &newmatrix)
 
void setProjectorEpsilon (const float epsilon)
 
void setStartingPoint (const SbVec3f &newpoint)
 
void setStartingPoint (const SoPickedPoint *newpoint)
 
void setTempPathToThis (const SoPath *somethingclose)
 
void setViewportRegion (const SbViewportRegion &reg)
 
void setViewVolume (const SbViewVolume &vol)
 
void transformMatrixLocalToWorld (const SbMatrix &frommatrix, SbMatrix &tomatrix)
 
void transformMatrixToLocalSpace (const SbMatrix &frommatrix, SbMatrix &tomatrix, const SbName &fromspacepartname)
 
void transformMatrixWorldToLocal (const SbMatrix &frommatrix, SbMatrix &tomatrix)
 
void unregisterChildDragger (SoDragger *child)
 
void unregisterChildDraggerMovingIndependently (SoDragger *child)
 
void valueChanged (void)
 
void workFieldsIntoTransform (SbMatrix &mtx)
 
virtual void write (SoWriteAction *action)
 
- Public Member Functions inherited from SoInteractionKit
 SoInteractionKit (void)
 
SbBool isPathSurrogateInMySubgraph (const SoPath *path)
 
SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=TRUE)
 
virtual SbBool setPart (const SbName &partname, SoNode *from)
 
virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=TRUE)
 
virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node, SbBool onlyifdefault=TRUE)
 
virtual SbBool setPartAsPath (const SbName &partname, SoPath *path)
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit (void)
 
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
 
virtual void doAction (SoAction *action)
 
SbBool forceChildDrivenWriteRefs (SoOutput *out)
 
virtual SoChildListgetChildren (void) const
 
virtual SoNodegetPart (const SbName &partname, SbBool makeifneeded)
 
SbString getPartString (const SoBase *part)
 
void printDiagram (void)
 
void printSubDiagram (const SbName &rootname, int level)
 
void printTable (void)
 
SbBool set (const char *namevaluepairliststring)
 
SbBool set (const char *partnamestring, const char *parameterstring)
 
- Public Member Functions inherited from SoNode
virtual SbBool affectsState (void) const
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual SoFieldContainercopyThroughConnection (void) const
 
SbUniqueId getNodeId (void) const
 
NodeType getNodeType (void) const
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
SbBool isOverride (void) const
 
virtual void notify (SoNotList *l)
 
virtual void pick (SoPickAction *action)
 
void setNodeType (const NodeType type)
 
void setOverride (const SbBool state)
 
virtual void startNotify (void)
 
virtual void writeInstance (SoOutput *out)
 
- Public Member Functions inherited from SoFieldContainer
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
 
SbBool enableNotify (const SbBool flag)
 
SbBool fieldsAreEqual (const SoFieldContainer *container) const
 
void get (SbString &fielddata)
 
void get (SbString &fielddata, SoOutput *out)
 
virtual int getAllFields (SoFieldList &l) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (const SbName &name) const
 
virtual SoFieldgetField (const SbName &name) const
 
SbBool getFieldName (const SoField *const field, SbName &name) const
 
virtual int getFields (SoFieldList &l) const
 
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
 
SbBool getIsBuiltIn (void) const
 
voidgetUserData (void) const
 
SbBool hasDefaultValues (void) const
 
SbBool isNotifyEnabled (void) const
 
SbBool set (const char *const fielddata)
 
SbBool set (const char *fielddata, SoInput *input)
 
void setToDefaults (void)
 
void setUserData (void *userdata) const
 
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
 
- Public Member Functions inherited from SoBase
void addAuditor (void *const auditor, const SoNotRec::Type type)
 
void assertAlive (void) const
 
const SoAuditorListgetAuditors (void) const
 
virtual SbName getName (void) const
 
int32_t getRefCount (void) const
 
SbBool isOfType (SoType type) const
 Returns TRUE if the type of this object is either of the same type or inherited from type.
 
void ref (void) const
 
void removeAuditor (void *const auditor, const SoNotRec::Type type)
 
virtual void setName (const SbName &newname)
 
SbBool shouldWrite (void)
 
void touch (void)
 
void unref (void) const
 
void unrefNoDelete (void) const
 

Static Public Member Functions

static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoDragger
static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL)
 
static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL)
 
static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
 
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SoType getClassTypeId (void)
 
static float getMinScale (void)
 
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation)
 
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center)
 
static void initClass (void)
 
static void initClasses (void)
 
static void setMinScale (float newminscale)
 
static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr)
 
- Static Public Member Functions inherited from SoInteractionKit
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void setSwitchValue (SoNode *node, const int newVal)
 
- Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
static SbBool isSearchingChildren (void)
 
static void setSearchingChildren (const SbBool newval)
 
- Static Public Member Functions inherited from SoNode
static void audioRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static SoType getClassTypeId (void)
 
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static SbUniqueId getNextNodeId (void)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void initClasses (void)
 
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 Public Member Functions inherited from SoFieldContainer
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static void cleanupClass (void)
 
static void copyDone (void)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void initCopyDict (void)
 
- Static Public Member Functions inherited from SoBase
static void addName (SoBase *const base, const char *const name)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static void decrementCurrentWriteCounter (void)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool getTraceRefs (void)
 
static void incrementCurrentWriteCounter (void)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static SbBool readRoute (SoInput *input)
 
static void removeName (SoBase *const base, const char *const name)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 

Public Attributes

SoSFVec3f center
 
SoSFRotation rotation
 
- Public Attributes inherited from SoDragger
SoSFBool isActive
 
- Public Attributes inherited from SoInteractionKit
SoSFEnum boundingBoxCaching
 
SoSFEnum pickCulling
 
SoSFEnum renderCaching
 
SoSFEnum renderCulling
 

Protected Member Functions

virtual ~SoCenterballDragger (void)
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual const SoFieldDatagetFieldData (void) const
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void setDefaultOnNonWritingFields (void)
 
void setSwitches (SoDragger *activechild)
 
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
 
void transferCenterDraggerMotion (SoDragger *childdragger)
 
- Protected Member Functions inherited from SoDragger
 SoDragger (void)
 
virtual ~SoDragger (void)
 
SoDraggergetActiveChildDragger (void) const
 
SbVec2s getLocaterPosition (void)
 
SbVec2f getNormalizedLocaterPosition (void)
 
virtual const SoPickedPointgetPickedPointForStart (SoHandleEventAction *action)
 
SbVec2s getStartLocaterPosition (void) const
 
virtual void handleEvent (SoHandleEventAction *ha)
 
SbBool isAdequateConstraintMotion (void)
 
SbBool isIgnoreInBbox (void)
 
void setActiveChildDragger (SoDragger *newchilddragger)
 
void setCameraInfo (SoAction *action)
 
void setIgnoreInBbox (SbBool newval)
 
void setStartLocaterPosition (SbVec2s p)
 
virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath)
 
void transferMotion (SoDragger *child)
 
void updateDraggerCache (const SoPath *path)
 
- Protected Member Functions inherited from SoInteractionKit
virtual ~SoInteractionKit ()
 
void connectSeparatorFields (SoSeparator *dest, SbBool onOff)
 
virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
 
virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
 
SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
 
virtual SbBool setPart (const int partNum, SoNode *node)
 
- Protected Member Functions inherited from SoBaseKit
virtual ~SoBaseKit ()
 
virtual SoNodeaddToCopyDict (void) const
 
void catalogError (void)
 
void countMyFields (SoOutput *out)
 
virtual void createDefaultParts (void)
 
void createFieldList (void)
 
void createNodekitPartsList (void)
 
virtual SoNodeKitPathcreatePathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
 
virtual SoNodegetAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
 
const SbList< SoSFNode * > & getCatalogInstances (void) const
 
SoGroupgetContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
 
const SoNodekitPartsgetNodekitPartsList (void) const
 
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 
virtual ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase (void)
 
virtual ~SoBase ()
 
virtual SoNotRec createNotRec (void)
 
virtual void destroy (void)
 
virtual const char * getFileFormatName (void) const
 
SbBool hasMultipleWriteRefs (void) const
 
void writeFooter (SoOutput *out) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 

Static Protected Member Functions

static void fieldSensorCB (void *f, SoSensor *s)
 
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static const SoFieldData ** getFieldDataPtr (void)
 
static void kidFinishCB (void *f, SoDragger *d)
 
static void kidStartCB (void *f, SoDragger *d)
 
static void valueChangedCB (void *f, SoDragger *d)
 
- Static Protected Member Functions inherited from SoDragger
static void childFinishCB (void *, SoDragger *)
 
static void childMotionCB (void *, SoDragger *)
 
static void childOtherEventCB (void *, SoDragger *)
 
static void childStartCB (void *, SoDragger *)
 
static void childTransferMotionAndValueChangedCB (void *, SoDragger *)
 
static void childValueChangedCB (void *, SoDragger *)
 
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoInteractionKit
static void fieldSensorCB (void *, SoSensor *)
 
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static const SoFieldData ** getFieldDataPtr (void)
 
static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)
 
- Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr (void)
 
static int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
static void setNextActionMethodIndex (int index)
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter (void)
 
static void staticDataLock (void)
 
static void staticDataUnlock (void)
 

Protected Attributes

SoSFNode antiSquish
 
SoFieldSensorcenterFieldSensor
 
SoSFNode lightModel
 
SoSFNode rot2X90
 
SoSFNode rotator
 
SoFieldSensorrotFieldSensor
 
SoSFNode rotX90
 
SoSFNode rotY90
 
SoSFNode surroundScale
 
SoSFNode translateToCenter
 
SoSFNode XAxis
 
SoSFNode XAxisSwitch
 
SoSFNode XCenterChanger
 
SoSFNode XRotator
 
SoSFNode YAxis
 
SoSFNode YAxisSwitch
 
SoSFNode YCenterChanger
 
SoSFNode YRotator
 
SoSFNode ZAxis
 
SoSFNode ZAxisSwitch
 
SoSFNode ZCenterChanger
 
SoSFNode ZRotator
 
- Protected Attributes inherited from SoDragger
SoSFNode motionMatrix
 
- Protected Attributes inherited from SoInteractionKit
SoFieldSensorfieldSensor
 
SoSFNode geomSeparator
 
SoSeparatoroldTopSep
 
SoSFNode topSeparator
 
- Protected Attributes inherited from SoBaseKit
SoSFNode callbackList
 
SoChildListchildren
 
SbBool connectionsSetUp
 
- Protected Attributes inherited from SoNode
SbUniqueId 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 , COIN_4_0 = 0x20000
}
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }
 
- Static Protected Attributes inherited from SoNode
static int nextActionMethodIndex = 0
 
static SbUniqueId nextUniqueId = 1
 

Detailed Description

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:

Screen Shot of Default Dragger

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 { }
}
CenterBall Dragger Action Shot

The figure above shows the example scene graph in a viewer with the nearest cross on the centerball dragger selected. Moving the dragger then moves the associated clip plane over the geometry (the sphere in this case).

Constructor & Destructor Documentation

◆ SoCenterballDragger()

SoCenterballDragger::SoCenterballDragger ( void )

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

Nodekit 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::~SoCenterballDragger ( void )
protectedvirtual

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

◆ fieldSensorCB()

void SoCenterballDragger::fieldSensorCB ( void * d,
SoSensor * s )
staticprotected

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

◆ getBoundingBox()

void SoCenterballDragger::getBoundingBox ( SoGetBoundingBoxAction * action)
protectedvirtual

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 calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoDragger.

◆ getClassNodekitCatalog()

const SoNodekitCatalog * SoCenterballDragger::getClassNodekitCatalog ( void )
static

Returns the nodekit catalog which defines the layout of this class' kit.

◆ getClassNodekitCatalogPtr()

const SoNodekitCatalog ** SoCenterballDragger::getClassNodekitCatalogPtr ( void )
staticprotected

Returns the pointer to the pointer of the nodekit catalog for this class.

◆ getClassTypeId()

SoType SoCenterballDragger::getClassTypeId ( void )
static

This static method returns the SoType object associated with objects of this class.

◆ getFieldData()

const SoFieldData * SoCenterballDragger::getFieldData ( void ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoDragger.

◆ getFieldDataPtr()

const SoFieldData ** SoCenterballDragger::getFieldDataPtr ( void )
staticprotected

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

Returns the SoFieldData class which holds information about fields in this node.

◆ getMatrix()

void SoCenterballDragger::getMatrix ( SoGetMatrixAction * action)
protectedvirtual

Action method for SoGetMatrixAction.

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

Reimplemented from SoDragger.

◆ getNodekitCatalog()

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

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoDragger.

◆ getTypeId()

SoType SoCenterballDragger::getTypeId ( void ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoDragger.

◆ initClass()

void SoCenterballDragger::initClass ( void )
static

Initializes type system for this dragger class.

Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init().

◆ kidFinishCB()

void SoCenterballDragger::kidFinishCB ( void * d,
SoDragger * child )
staticprotected

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

Needed to deactivate some feedback.

◆ kidStartCB()

void SoCenterballDragger::kidStartCB ( void * d,
SoDragger * child )
staticprotected

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.

◆ saveStartParameters()

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.

◆ setDefaultOnNonWritingFields()

void SoCenterballDragger::setDefaultOnNonWritingFields ( void )
protectedvirtual

(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 scene graph 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 is 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.

◆ setSwitches()

void SoCenterballDragger::setSwitches ( SoDragger * activechild)
protected

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

◆ setUpConnections()

SbBool SoCenterballDragger::setUpConnections ( SbBool onoff,
SbBool doitalways = FALSE )
protectedvirtual

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.

◆ transferCenterDraggerMotion()

void SoCenterballDragger::transferCenterDraggerMotion ( SoDragger * childdragger)
protected

Should be called after motion matrix has been updated by a child dragger.

◆ valueChangedCB()

void SoCenterballDragger::valueChangedCB ( void * f,
SoDragger * d )
staticprotected

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

Member Data Documentation

◆ center

SoSFVec3f SoCenterballDragger::center

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

◆ centerFieldSensor

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.

◆ rotation

SoSFRotation SoCenterballDragger::rotation

This field is continuously updated to contain the rotation of the ball.

◆ rotFieldSensor

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.


The documentation for this class was generated from the following files: