Coin
4.0.3
Coin3D core library
|
The SoDragPointDragger class provides mechanisms for moving a point in 3D. More...
#include <Inventor/draggers/SoDragPointDragger.h>
Public Attributes | |
SoSFVec3f | translation |
Public Attributes inherited from SoDragger | |
SoSFBool | isActive |
Public Attributes inherited from SoInteractionKit | |
SoSFEnum | boundingBoxCaching |
SoSFEnum | pickCulling |
SoSFEnum | renderCaching |
SoSFEnum | renderCulling |
Protected Attributes | |
SoFieldSensor * | fieldSensor |
SoSFNode | noRotSep |
SoSFNode | planeFeedbackSep |
SoSFNode | planeFeedbackSwitch |
SoSFNode | planeFeedbackTranslation |
SoSFNode | rotX |
SoSFNode | rotXSep |
SoSFNode | rotY |
SoSFNode | rotYSep |
SoSFNode | rotZ |
SoSFNode | rotZSep |
SoSFNode | xFeedback |
SoSFNode | xFeedbackSep |
SoSFNode | xFeedbackSwitch |
SoSFNode | xFeedbackTranslation |
SoSFNode | xTranslator |
SoSFNode | xTranslatorSwitch |
SoSFNode | xyFeedback |
SoSFNode | xyTranslator |
SoSFNode | xyTranslatorSwitch |
SoSFNode | xzFeedback |
SoSFNode | xzTranslator |
SoSFNode | xzTranslatorSwitch |
SoSFNode | yFeedback |
SoSFNode | yFeedbackSep |
SoSFNode | yFeedbackSwitch |
SoSFNode | yFeedbackTranslation |
SoSFNode | yTranslator |
SoSFNode | yTranslatorSwitch |
SoSFNode | yzFeedback |
SoSFNode | yzTranslator |
SoSFNode | yzTranslatorSwitch |
SoSFNode | zFeedback |
SoSFNode | zFeedbackSep |
SoSFNode | zFeedbackSwitch |
SoSFNode | zFeedbackTranslation |
SoSFNode | zTranslator |
SoSFNode | zTranslatorSwitch |
Protected Attributes inherited from SoDragger | |
SoSFNode | motionMatrix |
Protected Attributes inherited from SoInteractionKit | |
SoFieldSensor * | fieldSensor |
SoSFNode | geomSeparator |
SoSeparator * | oldTopSep |
SoSFNode | topSeparator |
Protected Attributes inherited from SoBaseKit | |
SoSFNode | callbackList |
SoChildList * | children |
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 |
The SoDragPointDragger class provides mechanisms for moving a point in 3D.
Here's how the dragger looks with its default geometry in the inactive state:
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.
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.
While the dragger is inactive (i.e. the user is not currently grabbing and / or dragging its 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.
SoDragPointDragger::SoDragPointDragger | ( | 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 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"
(See SoBaseKit::printDiagram() for information about the output formatting.)
Detailed information on catalog parts:
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 ---
(See SoBaseKit::printTable() for information about the output formatting.)
|
protectedvirtual |
Protected destructor.
(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)
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.
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.
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.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
|
static |
Returns the nodekit catalog which defines the layout of this class' kit.
|
staticprotected |
Returns the pointer to the pointer of the nodekit catalog for this class.
This static method returns the SoType object associated with objects of this class.
|
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.
|
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.
float SoDragPointDragger::getJumpLimit | ( | void | ) | const |
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.
|
virtual |
Returns the nodekit catalog which defines the layout of this class' kit.
Reimplemented from SoDragger.
Initializes type system for this dragger class.
Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init().
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
(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:
field value is NULL
and part is NULL
by default
it is a leaf SoGroup or SoSeparator node with no children
it is a leaf listpart with no children and an SoGroup or SoSeparator container
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.
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.
|
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.
Circulate the dragger's three different sets of geometry, to circulate the orientation of the translation axis and translation plane through the three principal axes.
This function is triggered when the user taps the CTRL
key.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
|
protected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
SoSFVec3f SoDragPointDragger::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.