Coin
4.0.3
Coin3D core library
|
The SoTrackballDragger provides the end-user with rotation and scaling interaction possibilities. More...
#include <Inventor/draggers/SoTrackballDragger.h>
Public Attributes | |
SoSFRotation | rotation |
SoSFVec3f | scaleFactor |
Public Attributes inherited from SoDragger | |
SoSFBool | isActive |
Public Attributes inherited from SoInteractionKit | |
SoSFEnum | boundingBoxCaching |
SoSFEnum | pickCulling |
SoSFEnum | renderCaching |
SoSFEnum | renderCulling |
Protected Attributes | |
SoSFNode | antiSquish |
SoSFNode | rotator |
SoSFNode | rotatorActive |
SoSFNode | rotatorSwitch |
SoFieldSensor * | rotFieldSensor |
SoFieldSensor * | scaleFieldSensor |
SoSFNode | surroundScale |
SoSFNode | userAxis |
SoSFNode | userAxisActive |
SoSFNode | userAxisRotation |
SoSFNode | userAxisSwitch |
SoSFNode | userRotator |
SoSFNode | userRotatorActive |
SoSFNode | userRotatorSwitch |
SoSFNode | XRotator |
SoSFNode | XRotatorActive |
SoSFNode | XRotatorSwitch |
SoSFNode | YRotator |
SoSFNode | YRotatorActive |
SoSFNode | YRotatorSwitch |
SoSFNode | ZRotator |
SoSFNode | ZRotatorActive |
SoSFNode | ZRotatorSwitch |
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 SoTrackballDragger provides the end-user with rotation and scaling interaction possibilities.
Here's how the dragger looks with its default geometry in the inactive state:
The dragger has three "bands" around a transparent sphere, which when clicked and dragged will rotate around the three principal axes. In addition, the user can define his own rotation axis by holding down a SHIFT key while clicking with the left mouse button and dragging. A new, distinctively colored axis and dragger band will be then be added.
Free-form rotation on the sphere can be done by clicking and dragging outside the predefined "rotation bands".
Scale operations are made available by holding down a CTRL key when clicking with the left mouse button. The dragger is then in scaling mode, and dragging while holding down the mouse button will uniformly scale the trackball sphere.
For the application programmer's convenience, the Coin library also provides a manipulator class called SoTrackballManip, which wraps the SoTrackballDragger into the necessary mechanisms for making direct insertion of this dragger into a scene graph possible with very little effort.
SoTrackballDragger::SoTrackballDragger | ( | 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 SoTrackballDragger -->"this" "callbackList" "topSeparator" "motionMatrix" --> "surroundScale" --> "antiSquish" "geomSeparator" --> "rotatorSwitch" --> "rotator" --> "rotatorActive" --> "XRotatorSwitch" --> "XRotator" --> "XRotatorActive" --> "YRotatorSwitch" --> "YRotator" --> "YRotatorActive" --> "ZRotatorSwitch" --> "ZRotator" --> "ZRotatorActive" --> "userAxisRotation" --> "userAxisSwitch" --> "userAxis" --> "userAxisActive" --> "userRotatorSwitch" --> "userRotator" --> "userRotatorActive"
(See SoBaseKit::printDiagram() for information about the output formatting.)
Detailed information on catalog parts:
CLASS SoTrackballDragger PVT "this", SoTrackballDragger --- "callbackList", SoNodeKitListPart [ SoCallback, SoEventCallback ] PVT "topSeparator", SoSeparator --- PVT "motionMatrix", SoMatrixTransform --- "surroundScale", SoSurroundScale --- "antiSquish", SoAntiSquish --- PVT "geomSeparator", SoSeparator --- PVT "rotatorSwitch", SoSwitch --- "rotator", SoSeparator --- "rotatorActive", SoSeparator --- PVT "XRotatorSwitch", SoSwitch --- "XRotator", SoSeparator --- "XRotatorActive", SoSeparator --- PVT "YRotatorSwitch", SoSwitch --- "YRotator", SoSeparator --- "YRotatorActive", SoSeparator --- PVT "ZRotatorSwitch", SoSwitch --- "ZRotator", SoSeparator --- "ZRotatorActive", SoSeparator --- PVT "userAxisRotation", SoRotation --- PVT "userAxisSwitch", SoSwitch --- "userAxis", SoSeparator --- "userAxisActive", SoSeparator --- PVT "userRotatorSwitch", SoSwitch --- "userRotator", SoSeparator --- "userRotatorActive", 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.
|
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().
SbBool SoTrackballDragger::isAnimationEnabled | ( | void | ) |
Whether or not the trackball will start a spin animation after a quick drag-and-release.
Note: this feature is not supported yet in the Coin library, so even though if TRUE
is returned, spin animations will not be possible to trigger.
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 |
If the input argument is TRUE
, all the geometry parts of the dragger will become highlighted, as when active.
Used internally during scaling operations and free-form rotations.
void SoTrackballDragger::setAnimationEnabled | ( | SbBool | newval | ) |
Set a flag which will decide whether or not the trackball will start a spin animation after a quick drag-and-release.
Note: this feature is not supported yet in the Coin library.
(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.
|
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.
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.
SoSFRotation SoTrackballDragger::rotation |
This field is continuously updated to contain the rotation of the dragger's trackball.
|
protected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
SoSFVec3f SoTrackballDragger::scaleFactor |
Continuously updated to contain the current vector of scaling along the X, Y and Z axes. The three components will always be equal, as this dragger only supports uniform scale operations.
|
protected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.