Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoRotateCylindricalDragger Class Reference

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

#include <Inventor/draggers/SoRotateCylindricalDragger.h>

Inheritance diagram for SoRotateCylindricalDragger::

SoDragger SoInteractionKit SoBaseKit SoNode SoFieldContainer SoBase List of all members.

Public Methods

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

Static Public Methods

void initClass (void)

Public Attributes

SoSFRotation rotation

Protected Methods

 ~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 Methods

void startCB (void *f, SoDragger *d)
void motionCB (void *f, SoDragger *d)
void doneCB (void *f, SoDragger *d)
void fieldSensorCB (void *f, SoSensor *s)
void valueChangedCB (void *f, SoDragger *d)

Protected Attributes

SoFieldSensor * fieldSensor
SbCylinderProjector * cylinderProj
SbBool userProj

Detailed Description

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

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.

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.)

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

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

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()

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.

void SoRotateCylindricalDragger::copyContents (  const SoFieldContainer * fromfc,
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 method that should be overridden by subclasses which needs to account for internal data that are not handled automatically.

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.

void SoRotateCylindricalDragger::startCB (  void * f,
SoDragger * d
)  [static, protected]
 

For internal use only.

void SoRotateCylindricalDragger::motionCB (  void * f,
SoDragger * d
)  [static, protected]
 

For internal use only.

void SoRotateCylindricalDragger::doneCB (  void * f,
SoDragger * d
)  [static, protected]
 

For internal use only.

void SoRotateCylindricalDragger::fieldSensorCB (  void * d,
SoSensor * s
)  [static, protected]
 

For internal use only.

Reimplemented from SoInteractionKit.

void SoRotateCylindricalDragger::valueChangedCB (  void * f,
SoDragger * d
)  [static, protected]
 

For internal use only.

void SoRotateCylindricalDragger::dragStart (  void )  [protected]
 

For internal use only.

void SoRotateCylindricalDragger::drag (  void )  [protected]
 

For internal use only.

void SoRotateCylindricalDragger::dragFinish (  void )  [protected]
 

For internal use only.

Member Data Documentation

SoSFRotation SoRotateCylindricalDragger::rotation
 

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.

SoFieldSensor * SoRotateCylindricalDragger::fieldSensor [protected]
 

For internal use only.

Reimplemented from SoInteractionKit.

SbCylinderProjector * SoRotateCylindricalDragger::cylinderProj [protected]
 

For internal use only.

SbBool SoRotateCylindricalDragger::userProj [protected]
 

For internal use only.

The documentation for this class was generated from the following files:
Generated at Tue Mar 5 03:31:29 2002 for Coin by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001