NAME

       SoJackDragger -

       The SoJackDragger class is a dragger you can translate, rotate and scale.

       Here's how the dragger looks with its default geometry in the inactive state:

SYNOPSIS

       #include <Inventor/draggers/SoJackDragger.h>

       Inherits SoDragger.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       virtual const SoNodekitCatalog * getNodekitCatalog (void) const
       SoJackDragger (void)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static const SoNodekitCatalog * getClassNodekitCatalog (void)
       static void initClass (void)

   Public Attributes
       SoSFRotation rotation
       SoSFVec3f translation
       SoSFVec3f scaleFactor

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoJackDragger (void)
       virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
       virtual void setDefaultOnNonWritingFields (void)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)
       static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
       static void invalidateSurroundScaleCB (void *f, SoDragger *d)
       static void fieldSensorCB (void *f, SoSensor *s)
       static void valueChangedCB (void *f, SoDragger *d)

   Protected Attributes
       SoSFNode antiSquish
       SoSFNode rotator
       SoSFNode scaler
       SoSFNode surroundScale
       SoSFNode translator
       SoFieldSensor * rotFieldSensor
       SoFieldSensor * translFieldSensor
       SoFieldSensor * scaleFieldSensor

   Additional Inherited Members

Detailed Description

       The SoJackDragger class is a dragger you can translate, rotate and scale.

       Here's how the dragger looks with its default geometry in the inactive state:

       Translation is done with this dragger by picking the flat transparent box ('x-z'
       translation) or the solid middle part of the axis ('y'-axis translation). Press a SHIFT-
       key while translating in x-z to constrain to one of the principal axes.

       Uniform scale operations can be done by dragging any of the 6 cubes. Non-uniform scale
       operations can not be done with this dragger.

       Rotations are invoked by clicking and dragging the line parts of the 3 principal 'axes' of
       the dragger geometry.

       NB: How to rotate the dragger might be abit unintuitive for the end user. If the dragger
       is to be used 'out of the box', a good documentation should be added to your application.
       An alternative is to modify the geometry to increase the affordance of the dragger. See
       the SoDragger documentation on how to change the geometry of a dragger.

       An 'action shot' of the SoJackDragger used within an SoClipPlaneManip:

       The name 'Jack dragger' probably stems from this dragger being implemented by SGI for
       interacting with a 'jack-in-the-box' type model way back in the Inventor history.

       For programmer convenience, this dragger comes fully wrapped within instances of the
       SoJackManip class. The SoClipPlaneManip manipulator also uses this dragger, for
       controlling an SoClipPlane node.

Constructor & Destructor Documentation

   SoJackDragger::SoJackDragger (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 SoJackDragger
       -->"this"
             "callbackList"
             "topSeparator"
                "motionMatrix"
       -->      "surroundScale"
       -->      "antiSquish"
       -->      "scaler"
       -->      "rotator"
       -->      "translator"
                "geomSeparator"

       (See SoBaseKit::printDiagram() for information about the output formatting.)

       Detailed information on catalog parts:

       CLASS SoJackDragger
       PVT   "this",  SoJackDragger  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
       PVT   "motionMatrix",  SoMatrixTransform  ---
             "surroundScale",  SoSurroundScale  ---
             "antiSquish",  SoAntiSquish  ---
             "scaler",  SoScaleUniformDragger  ---
             "rotator",  SoRotateSphericalDragger  ---
             "translator",  SoDragPointDragger  ---
       PVT   "geomSeparator",  SoSeparator  ---

       (See SoBaseKit::printTable() for information about the output formatting.)

   SoJackDragger::~SoJackDragger (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 SoJackDragger::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 * SoJackDragger::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 * SoJackDragger::getNodekitCatalog (void) const [virtual]
       Returns the nodekit catalog which defines the layout of this class' kit.

       Reimplemented from SoDragger.

   SbBool SoJackDragger::setUpConnections (SbBoolonoff, SbBooldoitalways = 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 SoJackDragger::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 SoJackDragger::invalidateSurroundScaleCB (void *f, SoDragger *d) [static],  [protected]
       Used to invalidate the surroundScale and antiSquish parts when a child dragger starts or
       finishes dragging.
   void SoJackDragger::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 SoJackDragger::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.

Member Data Documentation

   SoSFRotation SoJackDragger::rotation
       This field is continuously updated to contain the rotation of the current direction vector
       of the dragger.
   SoSFVec3f SoJackDragger::translation
       Continuously updated to contain the current translation from the dragger's local origo
       position.
       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.
   SoSFVec3f SoJackDragger::scaleFactor
       Continuously updated to contain the current vector of scaling along the X, Y and Z axes.
       Only uniform scaling can be done with the SoJackDragger, so the 3 vector components will
       always be equal.
   SoFieldSensor * SoJackDragger::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 * SoJackDragger::translFieldSensor [protected]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.
   SoFieldSensor * SoJackDragger::scaleFieldSensor [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.