 |
Coin
4.0.3
Coin3D core library
|
|
Coin
4.0.3
Coin3D core library
|
The SoDragger class is the base class for all draggers. More...
#include <Inventor/draggers/SoDragger.h>
Public Types | |
| 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 } |
Public Attributes | |
| SoSFBool | isActive |
| Public Attributes inherited from SoInteractionKit | |
| SoSFEnum | boundingBoxCaching |
| SoSFEnum | pickCulling |
| SoSFEnum | renderCaching |
| SoSFEnum | renderCulling |
Protected Attributes | |
| 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 | |
| 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 SoDragger class is the base class for all draggers.
Draggers is a mechanism used for letting the end-users of your application code interact with elements in 3D, by scaling, rotating or translating geometry or other instances in the scene (like cameras or light sources).
For a very thorough introduction and tutorial to the dragger classes and general concepts, we advise you to consult «The Inventor Mentor», ISBN 0-201-62495-8, chapter 15.
This is the common superclass for all dragger classes.
It holds the current motion matrix, and offers lots of convenience methods to build from for its subclasses – that is, the non-abstract dragger classes to use as nodes in your scene graph.
The motion matrix is used to modify the model matrix during traversal, and this is a common dragger mechanism – all draggers should update this during dragging.
A number of the Coin dragger classes have built-in convenience wrapper classes, called manipulators. See for instance the SoTrackballDragger / SoTrackballManip pair.
The matching manipulator class for any dragger class has basically two convenient additions to the functionality of the standalone dragger: 1) it makes swapping the dragger in and out of the scene graph very straightforward (something which is often done for draggers in 3D user interfaces), 2) it wraps up the dragger with SoSurroundScale and SoAntiSquish nodes where applicable, so the dragger geometry automatically scales up or down to match the geometry it influences.
This last functionality can also be duplicated in a rather straightforward manner outside of the context of a manipulator, as can be seen from the usage example in the SoSurroundScale class documentation.
The appearance of draggers can be modified by either using the SoDragger::setPart() method (see usage example below) or by setting up external Inventor-format files which the geometry parts are read from. The latter method can be done by setting the environment variable SO_DRAGGER_DIR to point to a directory with replacement geometry files. The name of the new files and the name of the nodes / sub-graphs with the replacement geometries must follow a rigid scheme. We advise you to look at the Coin source code directory Coin/data/draggerDefaults/ to see how the replacement geometry files should be named. Setting SO_DRAGGER_DIR to this directory and modifying the files there provides a convenient way to play around with new dragger geometry arrangements.
As mentioned above, SoDragger::setPart() can be used to modify the appearance of a dragger by changing its default geometry. One common technique is for instance to take advantage of this to use only parts of a dragger, by replacing / disabling the geometry that you don't want the end-user to interact with. The following code example shows how to remove the translation functionality of the SoTransformBoxDragger:
Draggers are also node kits, and below is the catalog structure for this top-level dragger class.
Nodekit structure (new entries versus parent class marked with arrow prefix):
CLASS SoDragger
-->"this"
"callbackList"
"topSeparator"
--> "motionMatrix"
"geomSeparator"
(See SoBaseKit::printDiagram() for information about the output formatting.)
Detailed information on catalog parts:
CLASS SoDragger
PVT "this", SoDragger ---
"callbackList", SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT "topSeparator", SoSeparator ---
PVT "motionMatrix", SoMatrixTransform ---
PVT "geomSeparator", SoSeparator ---
(See SoBaseKit::printTable() for information about the output formatting.)
Holds various settings for projectors, which might affect cylindrical and spherical based draggers. Specifies whether dragging should be based on the front or back of the sphere / cylinder, or if the picked point should be used to decide this.
| Enumerator | |
|---|---|
| FRONT | Always use front of projector. |
| BACK | Always use back of projector. |
| USE_PICK | Use picked point to decide front or back of projector. |
|
protected |
A protected constructor for this abstract superclass for all Coin draggers.
|
protectedvirtual |
Virtual protected destructor.
Adds a callback which is called after dragging is finished.
Adds a callback which is called for each mouse movement during dragging.
Adds an event callback for events other then drag events. As soon as dragging starts, the dragger grabs all events (until mouse button is released). This method can be used to handle other events during dragging.
Adds a callback which is called at the start of a drag, after the mouse button 1 is pressed, and dragger is picked.
Adds a callback which is called after a dragger has changed a field. It is not called if the SoDragger::isActive field is changed.
|
static |
Appends rot, around rotcenter, to matrix. If conversion is != NULL, this is used to move the rotation into that coordinate systems before appending the rotation.
|
static |
Returns matrix after scale and scalecenter have been appended. If conversion != NULL it is used to transform scale into the space matrix is defined.
|
static |
Returns matrix after translation has been appended. If conversion != NULL it is used to transform translation into the space matrix is defined.
|
virtual |
Action method for SoCallbackAction.
Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.
Reimplemented from SoBaseKit.
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.
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.
|
staticprotected |
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.
| SbBool SoDragger::enableValueChangedCallbacks | ( | SbBool | val | ) |
Enable or disable "value changed" callbacks.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
|
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 SoBaseKit.
Reimplemented in SoCenterballDragger.
|
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 SoInteractionKit.
Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger.
|
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.
| SoDragger::ProjectorFrontSetting SoDragger::getFrontOnProjector | ( | void | ) | const |
Returns the behaviour of the SbProjector.
| SoHandleEventAction * SoDragger::getHandleEventAction | ( | void | ) | const |
Return the current (most recent) SoHandleEventAction.
Returns the drag starting point in the local coordinate system.
Returns a matrix that converts from local to world space.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
virtual |
Action method for SoGetMatrixAction.
Updates action by accumulating with the transformation matrix of this node (if any).
Reimplemented from SoBaseKit.
Reimplemented in SoCenterballDragger.
| int SoDragger::getMinGesture | ( | void | ) | const |
Returns the gesture pixels threshold value.
|
static |
Returns the minimum scale value.
|
virtual |
Returns the nodekit catalog which defines the layout of this class' kit.
Reimplemented from SoInteractionKit.
Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger.
Returns the position of the locater.
| void SoDragger::getPartToLocalMatrix | ( | const SbName & | partname, |
| SbMatrix & | parttolocalmatrix, | ||
| SbMatrix & | localtopartmatrix ) |
Returns matrices that will convert between local space and the space in which partname lies in.
|
protectedvirtual |
Interaction with the dragger will be started, if the returned picked point belongs to the dragger. A derived class can override this method to change the condition when the dragger starts interaction, e.g. it can return the picked point on the dragger from the picked point list of the action, even if it is covered by other (semi) transparent objects. The default implementation returns the foremost picked point from the action. This method is not present in Open Inventor.
|
virtual |
Action method for the SoGetPrimitiveCountAction.
Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.
Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.
Reimplemented from SoBaseKit.
Returns the position when mouse button 1 was pressed.
Returns the motion matrix as it was when saveStartParameters() was called.
Returns the name of the path in the SoInteractionKit that holds the current surrogate path.
Returns the path to the SoInteractionKit that holds the current surrogate path.
Returns the current surrogate path.
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
static |
Can be used when there is no scaleorientation. Faster than SoDragger::workValuesIntoTransform().
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 SoInteractionKit.
Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger.
| const SbViewportRegion & SoDragger::getViewportRegion | ( | void | ) |
Returns the current viewport region.
| const SbViewVolume & SoDragger::getViewVolume | ( | void | ) |
Return the current view volume.
Returns the drag starting point in the world coordinate system.
Returns a matrix that converts from world to local space.
|
virtual |
Action method for the SoGLRenderAction.
This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.
Reimplemented from SoBaseKit.
Reimplemented in SoTabPlaneDragger.
Called when dragger stops grabbing events (mouse button up).
Reimplemented from SoNode.
Called when dragger starts grabbing events (mouse button down). Overload if you need to do something extra in your dragger.
Reimplemented from SoNode.
|
protectedvirtual |
Action method for SoHandleEventAction.
Inspects the event data from action, and processes it if it is something which this node should react to.
Nodes influencing relevant state variables for how event handling is done also override this method.
Reimplemented from SoBaseKit.
Initializes type system for this dragger class.
Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init().
|
protected |
Checks if the mouse pointer has been moved enough after the end-user hit a constraint mode key (which is typically SHIFT, sometimes also CTRL for the built-in draggers) that we should act upon and decide which direction the constraint should be set to.
|
protected |
Returns whether dragger geometry should be ignored when calculating bounding box.
|
virtual |
Action method for SoRayPickAction.
Checks the ray specification of the action and tests for intersection with the data of the node.
Nodes influencing relevant state variables for how picking is done also override this method.
Reimplemented from SoBaseKit.
Should be called by compound draggers to register child draggers.
Should be called by compound draggers to register child draggers that should move independently of their parent.
Removes a finish callback.
Removes a previously registered motion callback.
Removes a other event callback.
Removes a previously registered start callback.
Removes a value changed callback.
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 in SoCenterballDragger.
|
virtual |
Action method for SoSearchAction.
Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction – if any of the requested criteria is a miss, the search is not deemed successful for the node.
Reimplemented from SoBaseKit.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Store data about the current camera in the given action.
(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 SoInteractionKit.
Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, and SoTransformerDragger.
| void SoDragger::setFrontOnProjector | ( | ProjectorFrontSetting | val | ) |
Controls the behaviour of the SbProjector.
| void SoDragger::setHandleEventAction | ( | SoHandleEventAction * | action | ) |
Stores a handle event action.
|
protected |
Sets whether dragger geometry should be ignored when calculating bounding box.
| void SoDragger::setMinGesture | ( | int | pixels | ) |
Sets the number of pixel movement needed to trigger a constraint gesture. Default is 8 pixels.
|
static |
Sets the minimum scale value all scale factors are clamped against. This is used in workFieldsIntoTransform(). The default value is 0.01
Sets a new current motion matrix for the dragger geometry.
Triggers value changed callbacks if matrix is not equal to the previous motion matrix.
Reimplemented in SoTranslate2Dragger, and SoTranslate1Dragger.
Sets the epsilon used for restricting the draggers when the intersection line is almost parallel with the projector direction.
For line projectors this is based on the dot product between the picking ray and the projector line. For plane projector, the dot product between the plane normal and the picking ray is used.
Default value is 0.0.
| void SoDragger::setStartingPoint | ( | const SoPickedPoint * | point | ) |
Sets the staring point for the drag. point is usually a picked point from a SoRayPickAction.
The start locater position is automatically set when mouse button 1 goes down, but subclasses can use this method to reset the value.
This function is part of the original SGI Inventor 2.1 API, but has not been implemented in Coin as it looks like a function which should probably have been private in Open Inventor.
| void SoDragger::setViewportRegion | ( | const SbViewportRegion & | vp | ) |
Sets the current viewport region.
| void SoDragger::setViewVolume | ( | const SbViewVolume & | vv | ) |
Sets the current view volume.
|
protectedvirtual |
Checks if pickpath contains surrogatepath and returns TRUE if the tail of surrogatepath is before any dragger in pickpath.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Convenience method that transforms the local frommatrix to a world coordinate systems matrix.
| void SoDragger::transformMatrixToLocalSpace | ( | const SbMatrix & | frommatrix, |
| SbMatrix & | tomatrix, | ||
| const SbName & | fromspacepartname ) |
Transforms a matrix that lies in the frompartname coordinate system into the local coordinate system.
Convenience method that transforms the world frommatrix to a local coordinate systems matrix.
Should be called by compound draggers to unregister child draggers.
Should be called by compound draggers to unregister child draggers.
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Can be called by subclasses to trigger value changed callbacks. This might be needed if a field is changed without changing the motion matrix.
Examines the fields of the dragger, changes the matrix according to those fields and leaves the rest of the matrix as it was. The following field names are supported: translation, scaleFactor, rotation and scaleOrientation.
|
static |
Same as above, but pointers to values are supplied. If a pointer is NULL, the matrix value for that argument is used when reconstructing the matrix.
|
virtual |
Action method for SoWriteAction.
Writes out a node object, and any connected nodes, engines etc, if necessary.
Reimplemented from SoBaseKit.
| SoSFBool SoDragger::isActive |
Is TRUE whenever the user is interacting with the dragger. For compound draggers (draggers consisting of one or more subdraggers), the isActive field is updated only for the active subdragger, not for the compound dragger.
1.10.0