Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes

SoRotateCylindricalDragger Class Reference

The SoRotateCylindricalDragger class is for rotating geometry around a single axis.Here's how the dragger looks with its default geometry in the inactive state: More...

#include <Inventor/draggers/SoRotateCylindricalDragger.h>

Inheritance diagram for SoRotateCylindricalDragger:
SoDragger SoInteractionKit SoBaseKit SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoRotateCylindricalDragger (void)
void setProjector (SbCylinderProjector *p)
const SbCylinderProjectorgetProjector (void) const

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFRotation rotation

Protected Member Functions

 ~SoRotateCylindricalDragger ()
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
void dragStart (void)
void drag (void)
void dragFinish (void)

Static Protected Member Functions

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

SoFieldSensorfieldSensor
SbCylinderProjectorcylinderProj
SbBool userProj

Detailed Description

The SoRotateCylindricalDragger class is for rotating geometry around a single axis.

Here's how the dragger looks with its default geometry in the inactive state:

rotatecylindrical.png

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.

For the dragger orientation and positioning itself, use some kind of transformation node in your scenegraph, as usual.


Constructor & Destructor Documentation

SoRotateCylindricalDragger::SoRotateCylindricalDragger ( 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 SoRotateCylindricalDragger
  -->"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 SoRotateCylindricalDragger
  PVT   "this",  SoRotateCylindricalDragger  --- 
        "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(), cylinderProj, doneCB(), fieldSensor, fieldSensorCB(), motionCB(), SoInteractionKit::readDefaultParts(), rotation, SoInteractionKit::setPartAsDefault(), SoDelayQueueSensor::setPriority(), SoInteractionKit::setSwitchValue(), setUpConnections(), startCB(), userProj, and valueChangedCB().

SoRotateCylindricalDragger::~SoRotateCylindricalDragger ( ) [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 cylinderProj, fieldSensor, and userProj.


Member Function Documentation

void SoRotateCylindricalDragger::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.

void SoRotateCylindricalDragger::setProjector ( SbCylinderProjector p)

Replace the default cylinder projection strategy. You may want to do this if you change the dragger geometry, for instance.

The default cylinder projection is an SbCylinderPlaneProjector.

See also:
SbCylinderSectionProjector, SbCylinderSheetProjector

References cylinderProj, and userProj.

const SbCylinderProjector * SoRotateCylindricalDragger::getProjector ( void  ) const

Returns projector instance used for converting from user interaction dragger movements to 3D dragger re-orientation.

See also:
setProjector()

References cylinderProj.

SbBool SoRotateCylindricalDragger::setUpConnections ( SbBool  onoff,
SbBool  doitalways = FALSE 
) [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 SoRotateCylindricalDragger().

void SoRotateCylindricalDragger::copyContents ( const SoFieldContainer from,
SbBool  copyconnections 
) [protected, virtual]

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

  SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

  void
  MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                    SbBool copyconnections)
  {
    // let parent superclasses do their thing (copy fields, copy
    // instance name, etc etc)
    SoNode::copyContents(from, copyconnections);

    // [..then copy internal data..]
  }

Reimplemented from SoInteractionKit.

References SbProjector::copy(), SoInteractionKit::copyContents(), cylinderProj, SoNode::getClassTypeId(), SoBase::isOfType(), and userProj.

void SoRotateCylindricalDragger::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 SoRotateCylindricalDragger().

void SoRotateCylindricalDragger::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 SoRotateCylindricalDragger().

void SoRotateCylindricalDragger::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 SoRotateCylindricalDragger().

void SoRotateCylindricalDragger::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(), rotation, SoDragger::setMotionMatrix(), and SbMatrix::setTransform().

Referenced by setUpConnections(), and SoRotateCylindricalDragger().

void SoRotateCylindricalDragger::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(), and rotation.

Referenced by SoRotateCylindricalDragger().

void SoRotateCylindricalDragger::dragStart ( void  ) [protected]
void SoRotateCylindricalDragger::drag ( void  ) [protected]
void SoRotateCylindricalDragger::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().


Member Data Documentation

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(), SoRotateCylindricalDragger(), and valueChangedCB().

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(), SoRotateCylindricalDragger(), valueChangedCB(), and ~SoRotateCylindricalDragger().

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Referenced by copyContents(), drag(), dragStart(), getProjector(), setProjector(), SoRotateCylindricalDragger(), and ~SoRotateCylindricalDragger().

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Referenced by copyContents(), setProjector(), SoRotateCylindricalDragger(), and ~SoRotateCylindricalDragger().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:18 for Coin by Doxygen. 1.7.3