SoRotateCylindricalDragger Class Reference
[Draggers]
Object you rotate along a cylindrical surface by dragging with the mouse. More...
#include <Inventor/draggers/SoRotateCylindricalDragger.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| virtual const SoNodekitCatalog * | getNodekitCatalog () const |
| SoRotateCylindricalDragger () | |
| void | setProjector (SbCylinderProjector *p) |
| const SbCylinderProjector * | getProjector () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
Public Attributes | |
| SoSFRotation | rotation |
Detailed Description
Object you rotate along a cylindrical surface by dragging with the mouse.
SoRotateCylindricalDragger is a simple dragger that rotates about the y axis of its local space. The feel of the rotation is as if you were spinning a cylinder about its axis of rotation. The local space is determined by its location in the scene graph. Transformation nodes placed before it will affect both the dragger and the direction of motion.
This node has a rotation field which always reflects its orientation in local space. If you set the field, the dragger will rotate accordingly. You can also connect fields of other nodes or engines from this one to make them follow the dragger's orientation.
This dragger contains four parts, rotator , rotatorActive , feedback , and feedbackActive .
Each of these is set by default from a resource described in the Dragger Resources section of the online reference page for this class. You can change the parts in any instance of this dragger using setPart().
You can make your program use different default resources for the parts by copying the file $OIVHOME/data/draggerDefaults/rotateCylindricalDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.
This dragger has both a default and a WYSIWYG version:
-
Default Dragger WYSIWYG Dragger 
See SoDragger for more information about using and customizing draggers, including code examples, using draggers in an immersive VR environment and using WYSIWYG draggers.
FILE FORMAT/DEFAULT
- RotateCylindricalDragger {
| boundingBoxCaching | AUTO |
| renderCulling | AUTO |
| pickCulling | AUTO |
| isActive | FALSE |
| rotation | 0 0 1 0 |
| callbackList | NULL |
| rotator | <rotateCylindricalRotator resource> |
| rotatorActive | <rotateCylindricalRotatorActive resource> |
| feedback | <rotateCylindricalFeedback resource> |
| feedbackActive | <rotateCylindricalFeedbackActive resource> |
DRAGGER RESOURCES
| Resource: | rotateCylindricalRotator |
| Part: | rotator |
| Appearance: | white cylinder (with vertical axis) made of lines |
| Description: | picking this initiates rotation |
| Resource: | rotateCylindricalRotatorActive |
| Part: | rotatorActive |
| Appearance: | yellow version of rotator |
| Description: | displayed while in motion instead of the rotator |
| Resource: | rotateCylindricalFeedback |
| Part: | feedback |
| Appearance: | thin purple line along local y-axis |
| Description: | shows center of rotation when not moving |
| Resource: | rotateCylindricalFeedbackActive |
| Part: | feedbackActive |
| Appearance: | thin, slightly brighter purple line along local y-axis |
| Description: | shows center of rotation when moving |
CATALOG PARTS
- All Parts
| Part Name | Part Type | Default Type | NULL Default |
| callbackList | NodeKitListPart | -- | yes |
| rotator | Separator | -- | yes |
| rotatorActive | Separator | -- | yes |
| feedback | Separator | -- | yes |
| feedbackActive | Separator | -- | yes |
Extra Information for List Parts from Above Table
| Part Name | Container Type | Possible Types |
| callbackList | Separator | Callback, EventCallback |
SEE ALSO
SoInteractionKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger
Constructor & Destructor Documentation
| SoRotateCylindricalDragger::SoRotateCylindricalDragger | ( | ) |
Constructor.
Member Function Documentation
| static const SoNodekitCatalog* SoRotateCylindricalDragger::getClassNodekitCatalog | ( | ) | [static] |
Returns the SoNodekitCatalog for this class.
Reimplemented from SoDragger.
| static SoType SoRotateCylindricalDragger::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoDragger.
| virtual const SoNodekitCatalog* SoRotateCylindricalDragger::getNodekitCatalog | ( | ) | const [virtual] |
Returns the SoNodekitCatalog for this instance.
Reimplemented from SoDragger.
| const SbCylinderProjector* SoRotateCylindricalDragger::getProjector | ( | ) | const [inline] |
Gets the cylinder projector.
| virtual SoType SoRotateCylindricalDragger::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoDragger.
| void SoRotateCylindricalDragger::setProjector | ( | SbCylinderProjector * | p | ) |
Sets a different cylinder projector.
See the SbCylinderProjector reference pages to find out how each kind affects the feel of your dragger's motion. The default uses an SbCylinderPlaneProjector.
Passing in NULL will cause this default type of projector to be used. Any projector you pass in will be deleted by this dragger when this dragger is deleted. Note that the axis and radius of the cylinder are determined by the dragger, based on the y-axis in local space and how far the initial mouse click occured from the center of rotation.
Member Data Documentation
Orientation of the dragger.
The documentation for this class was generated from the following file:
- Inventor/draggers/SoRotateCylindricalDragger.h