![]() |
http://www.sim.no http://www.coin3d.org |
Here's how the dragger looks with its default geometry in the inactive state:. More...
#include <Inventor/draggers/SoRotateDiscDragger.h>
Public Member Functions | |
virtual SoType | getTypeId (void) const |
virtual const SoNodekitCatalog * | getNodekitCatalog (void) const |
SoRotateDiscDragger (void) | |
Static Public Member Functions | |
static SoType | getClassTypeId (void) |
static const SoNodekitCatalog * | getClassNodekitCatalog (void) |
static void | initClass (void) |
Public Attributes | |
SoSFRotation | rotation |
Protected Member Functions | |
virtual const SoFieldData * | getFieldData (void) const |
~SoRotateDiscDragger () | |
virtual SbBool | setUpConnections (SbBool onoff, SbBool doitalways=0) |
void | dragStart (void) |
void | drag (void) |
void | dragFinish (void) |
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 | doneCB (void *f, SoDragger *d) |
static void | fieldSensorCB (void *f, SoSensor *s) |
static void | valueChangedCB (void *f, SoDragger *d) |
Protected Attributes | |
SoSFNode | feedback |
SoSFNode | feedbackActive |
SoSFNode | feedbackSwitch |
SoSFNode | rotator |
SoSFNode | rotatorActive |
SoSFNode | rotatorSwitch |
SoFieldSensor * | fieldSensor |
SbPlaneProjector * | planeProj |
Here's how the dragger looks with its default geometry in the inactive state:.
Use an instance of this dragger class in your scenegraph to let the end-users of your application rotate geometry around a pre-defined axis vector in 3D.
The special feature of this dragger that sets it apart from the other draggers that provides rotation around an axis (like the SoRotateCylindricalDragger) is that it provides a convenient interface to rotate around an axis that is pointing in approximately the same direction as the camera. This is useful for interacting with for instance something like a "volume" knob.
For the dragger orientation and positioning itself, use some kind of transformation node in your scenegraph, as usual.
SoRotateDiscDragger::SoRotateDiscDragger | ( | 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 SoRotateDiscDragger -->"this" "callbackList" "topSeparator" "motionMatrix" "geomSeparator" --> "rotatorSwitch" --> "rotator" --> "rotatorActive" --> "feedbackSwitch" --> "feedback" --> "feedbackActive"
(See SoBaseKit::printDiagram() for information about the output formatting.)
Detailed information on catalog parts:
CLASS SoRotateDiscDragger PVT "this", SoRotateDiscDragger --- "callbackList", SoNodeKitListPart [ SoCallback, SoEventCallback ] PVT "topSeparator", SoSeparator --- PVT "motionMatrix", SoMatrixTransform --- PVT "geomSeparator", SoSeparator --- PVT "rotatorSwitch", SoSwitch --- "rotator", SoSeparator --- "rotatorActive", SoSeparator --- PVT "feedbackSwitch", SoSwitch --- "feedback", SoSeparator --- "feedbackActive", SoSeparator ---
(See SoBaseKit::printTable() for information about the output formatting.)
References SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), doneCB(), fieldSensor, fieldSensorCB(), motionCB(), planeProj, SoInteractionKit::readDefaultParts(), rotation, SoInteractionKit::setPartAsDefault(), SoDelayQueueSensor::setPriority(), SoInteractionKit::setSwitchValue(), setUpConnections(), startCB(), and valueChangedCB().
SoRotateDiscDragger::~SoRotateDiscDragger | ( | ) | [protected] |
Protected destructor.
(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)
References fieldSensor, and planeProj.
SoType SoRotateDiscDragger::getClassTypeId | ( | void | ) | [static] |
SoType SoRotateDiscDragger::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 } else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) { SoGroup * group = (SoGroup *)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 ** SoRotateDiscDragger::getFieldDataPtr | ( | void | ) | [static, protected] |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Reimplemented from SoDragger.
const SoFieldData * SoRotateDiscDragger::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 * SoRotateDiscDragger::getClassNodekitCatalog | ( | void | ) | [static] |
Returns the nodekit catalog which defines the layout of this class' kit.
Reimplemented from SoDragger.
const SoNodekitCatalog * SoRotateDiscDragger::getNodekitCatalog | ( | void | ) | const [virtual] |
Returns the nodekit catalog which defines the layout of this class' kit.
Reimplemented from SoDragger.
const SoNodekitCatalog ** SoRotateDiscDragger::getClassNodekitCatalogPtr | ( | void | ) | [static, protected] |
Returns the pointer to the pointer of the nodekit catalog for this class.
Reimplemented from SoDragger.
void SoRotateDiscDragger::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().
Reimplemented from SoDragger.
SbBool SoRotateDiscDragger::setUpConnections | ( | SbBool | onoff, | |
SbBool | doitalways = 0 | |||
) | [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.
References SoFieldSensor::attach(), SoBaseKit::connectionsSetUp, SoFieldSensor::detach(), fieldSensor, fieldSensorCB(), SoFieldSensor::getAttachedField(), rotation, and SoInteractionKit::setUpConnections().
Referenced by SoRotateDiscDragger().
void SoRotateDiscDragger::startCB | ( | 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 dragStart().
Referenced by SoRotateDiscDragger().
void SoRotateDiscDragger::motionCB | ( | 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 drag().
Referenced by SoRotateDiscDragger().
void SoRotateDiscDragger::doneCB | ( | 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 dragFinish().
Referenced by SoRotateDiscDragger().
void SoRotateDiscDragger::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.
Reimplemented from SoInteractionKit.
References SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SoSFRotation::getValue(), rotation, SoDragger::setMotionMatrix(), and SbMatrix::setTransform().
Referenced by setUpConnections(), and SoRotateDiscDragger().
void SoRotateDiscDragger::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(), SbMatrix::getTransform(), SoSFRotation::getValue(), and rotation.
Referenced by SoRotateDiscDragger().
void SoRotateDiscDragger::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.
Called when dragger is selected (picked) by the user.
References SoDragger::getLocalStartingPoint(), planeProj, SbPlaneProjector::setPlane(), and SoInteractionKit::setSwitchValue().
Referenced by startCB().
void SoRotateDiscDragger::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.
References SoDragger::appendRotation(), SbVec3f::cross(), SbVec3f::dot(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getStartMotionMatrix(), SoDragger::getViewVolume(), SbPlane::intersect(), SbVec3f::normalize(), planeProj, SbPlaneProjector::project(), SoDragger::setMotionMatrix(), SbProjector::setViewVolume(), and SbProjector::setWorkingSpace().
Referenced by motionCB().
void SoRotateDiscDragger::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.
References SoInteractionKit::setSwitchValue().
Referenced by doneCB().
This field is continuously updated to contain the rotation of the current direction vector of the dragger.
The application programmer using this dragger in his scenegraph should connect the relevant node fields in the scene to this field to make them follow the dragger orientation.
Referenced by fieldSensorCB(), setUpConnections(), SoRotateDiscDragger(), and valueChangedCB().
SoFieldSensor * SoRotateDiscDragger::fieldSensor [protected] |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Reimplemented from SoInteractionKit.
Referenced by setUpConnections(), SoRotateDiscDragger(), valueChangedCB(), and ~SoRotateDiscDragger().
SbPlaneProjector * SoRotateDiscDragger::planeProj [protected] |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Referenced by drag(), dragStart(), SoRotateDiscDragger(), and ~SoRotateDiscDragger().
Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.
Generated on Mon Feb 23 16:33:57 2009 for Coin by Doxygen. 1.5.8