SoHandleBoxDragger.3coin3 man page

SoHandleBoxDragger — The SoHandleBoxDragger class provides support for interactive scaling and translation.

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

Synopsis

#include <Inventor/draggers/SoHandleBoxDragger.h>

Inherits SoDragger.

Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoHandleBoxDragger (void)

Static Public Member Functions

static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void initClass (void)

Public Attributes

SoSFVec3f scaleFactor
SoSFVec3f translation

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual ~SoHandleBoxDragger (void)
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
virtual void setDefaultOnNonWritingFields (void)
void dragStart (void)
void drag (void)
void dragFinish (void)
void setAllPartsActive (SbBool onoroff)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
static void startCB (void *f, SoDragger *d)
static void motionCB (void *f, SoDragger *d)
static void finishCB (void *f, SoDragger *d)
static void metaKeyChangeCB (void *f, SoDragger *d)
static void fieldSensorCB (void *f, SoSensor *s)
static void valueChangedCB (void *f, SoDragger *d)

Protected Attributes

SoSFNode arrow1
SoSFNode arrow1Switch
SoSFNode arrow2
SoSFNode arrow2Switch
SoSFNode arrow3
SoSFNode arrow3Switch
SoSFNode arrow4
SoSFNode arrow4Switch
SoSFNode arrow5
SoSFNode arrow5Switch
SoSFNode arrow6
SoSFNode arrow6Switch
SoSFNode arrowTranslation
SoSFNode drawStyle
SoSFNode extruder1
SoSFNode extruder1Active
SoSFNode extruder1Switch
SoSFNode extruder2
SoSFNode extruder2Active
SoSFNode extruder2Switch
SoSFNode extruder3
SoSFNode extruder3Active
SoSFNode extruder3Switch
SoSFNode extruder4
SoSFNode extruder4Active
SoSFNode extruder4Switch
SoSFNode extruder5
SoSFNode extruder5Active
SoSFNode extruder5Switch
SoSFNode extruder6
SoSFNode extruder6Active
SoSFNode extruder6Switch
SoSFNode surroundScale
SoSFNode translator1
SoSFNode translator1Active
SoSFNode translator1Switch
SoSFNode translator2
SoSFNode translator2Active
SoSFNode translator2Switch
SoSFNode translator3
SoSFNode translator3Active
SoSFNode translator3Switch
SoSFNode translator4
SoSFNode translator4Active
SoSFNode translator4Switch
SoSFNode translator5
SoSFNode translator5Active
SoSFNode translator5Switch
SoSFNode translator6
SoSFNode translator6Active
SoSFNode translator6Switch
SoSFNode uniform1
SoSFNode uniform1Active
SoSFNode uniform1Switch
SoSFNode uniform2
SoSFNode uniform2Active
SoSFNode uniform2Switch
SoSFNode uniform3
SoSFNode uniform3Active
SoSFNode uniform3Switch
SoSFNode uniform4
SoSFNode uniform4Active
SoSFNode uniform4Switch
SoSFNode uniform5
SoSFNode uniform5Active
SoSFNode uniform5Switch
SoSFNode uniform6
SoSFNode uniform6Active
SoSFNode uniform6Switch
SoSFNode uniform7
SoSFNode uniform7Active
SoSFNode uniform7Switch
SoSFNode uniform8
SoSFNode uniform8Active
SoSFNode uniform8Switch
SoFieldSensor * translFieldSensor
SoFieldSensor * scaleFieldSensor

Additional Inherited Members

Detailed Description

The SoHandleBoxDragger class provides support for interactive scaling and translation.

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

 

A handlebox dragger is convenient to use for letting the user interact with geometry that can be scaled (uniformly or in a non-uniform way) and translated in 3D.

The dragger consists of a 'cube' of interaction geometry. The end-user can click and drag any side of the cube to translate the dragger and click and drag any of the corner or edge markers for scaling operations.

Constructor & Destructor Documentation

SoHandleBoxDragger::SoHandleBoxDragger (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 SoHandleBoxDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "surroundScale"
         "geomSeparator"
-->         "drawStyle"
-->         "translator1Switch"
-->            "translator1"
-->            "translator1Active"
-->         "translator2Switch"
-->            "translator2"
-->            "translator2Active"
-->         "translator3Switch"
-->            "translator3"
-->            "translator3Active"
-->         "translator4Switch"
-->            "translator4"
-->            "translator4Active"
-->         "translator5Switch"
-->            "translator5"
-->            "translator5Active"
-->         "translator6Switch"
-->            "translator6"
-->            "translator6Active"
-->         "extruder1Switch"
-->            "extruder1"
-->            "extruder1Active"
-->         "extruder2Switch"
-->            "extruder2"
-->            "extruder2Active"
-->         "extruder3Switch"
-->            "extruder3"
-->            "extruder3Active"
-->         "extruder4Switch"
-->            "extruder4"
-->            "extruder4Active"
-->         "extruder5Switch"
-->            "extruder5"
-->            "extruder5Active"
-->         "extruder6Switch"
-->            "extruder6"
-->            "extruder6Active"
-->         "uniform1Switch"
-->            "uniform1"
-->            "uniform1Active"
-->         "uniform2Switch"
-->            "uniform2"
-->            "uniform2Active"
-->         "uniform3Switch"
-->            "uniform3"
-->            "uniform3Active"
-->         "uniform4Switch"
-->            "uniform4"
-->            "uniform4Active"
-->         "uniform5Switch"
-->            "uniform5"
-->            "uniform5Active"
-->         "uniform6Switch"
-->            "uniform6"
-->            "uniform6Active"
-->         "uniform7Switch"
-->            "uniform7"
-->            "uniform7Active"
-->         "uniform8Switch"
-->            "uniform8"
-->            "uniform8Active"
-->         "arrowTranslation"
-->         "arrow1Switch"
-->            "arrow1"
-->         "arrow2Switch"
-->            "arrow2"
-->         "arrow3Switch"
-->            "arrow3"
-->         "arrow4Switch"
-->            "arrow4"
-->         "arrow5Switch"
-->            "arrow5"
-->         "arrow6Switch"
-->            "arrow6"

(See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

CLASS SoHandleBoxDragger
PVT   "this",  SoHandleBoxDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
      "surroundScale",  SoSurroundScale  ---
PVT   "geomSeparator",  SoSeparator  ---
PVT   "drawStyle",  SoDrawStyle  ---
PVT   "translator1Switch",  SoSwitch  ---
      "translator1",  SoSeparator  ---
      "translator1Active",  SoSeparator  ---
PVT   "translator2Switch",  SoSwitch  ---
      "translator2",  SoSeparator  ---
      "translator2Active",  SoSeparator  ---
PVT   "translator3Switch",  SoSwitch  ---
      "translator3",  SoSeparator  ---
      "translator3Active",  SoSeparator  ---
PVT   "translator4Switch",  SoSwitch  ---
      "translator4",  SoSeparator  ---
      "translator4Active",  SoSeparator  ---
PVT   "translator5Switch",  SoSwitch  ---
      "translator5",  SoSeparator  ---
      "translator5Active",  SoSeparator  ---
PVT   "translator6Switch",  SoSwitch  ---
      "translator6",  SoSeparator  ---
      "translator6Active",  SoSeparator  ---
PVT   "extruder1Switch",  SoSwitch  ---
      "extruder1",  SoSeparator  ---
      "extruder1Active",  SoSeparator  ---
PVT   "extruder2Switch",  SoSwitch  ---
      "extruder2",  SoSeparator  ---
      "extruder2Active",  SoSeparator  ---
PVT   "extruder3Switch",  SoSwitch  ---
      "extruder3",  SoSeparator  ---
      "extruder3Active",  SoSeparator  ---
PVT   "extruder4Switch",  SoSwitch  ---
      "extruder4",  SoSeparator  ---
      "extruder4Active",  SoSeparator  ---
PVT   "extruder5Switch",  SoSwitch  ---
      "extruder5",  SoSeparator  ---
      "extruder5Active",  SoSeparator  ---
PVT   "extruder6Switch",  SoSwitch  ---
      "extruder6",  SoSeparator  ---
      "extruder6Active",  SoSeparator  ---
PVT   "uniform1Switch",  SoSwitch  ---
      "uniform1",  SoSeparator  ---
      "uniform1Active",  SoSeparator  ---
PVT   "uniform2Switch",  SoSwitch  ---
      "uniform2",  SoSeparator  ---
      "uniform2Active",  SoSeparator  ---
PVT   "uniform3Switch",  SoSwitch  ---
      "uniform3",  SoSeparator  ---
      "uniform3Active",  SoSeparator  ---
PVT   "uniform4Switch",  SoSwitch  ---
      "uniform4",  SoSeparator  ---
      "uniform4Active",  SoSeparator  ---
PVT   "uniform5Switch",  SoSwitch  ---
      "uniform5",  SoSeparator  ---
      "uniform5Active",  SoSeparator  ---
PVT   "uniform6Switch",  SoSwitch  ---
      "uniform6",  SoSeparator  ---
      "uniform6Active",  SoSeparator  ---
PVT   "uniform7Switch",  SoSwitch  ---
      "uniform7",  SoSeparator  ---
      "uniform7Active",  SoSeparator  ---
PVT   "uniform8Switch",  SoSwitch  ---
      "uniform8",  SoSeparator  ---
      "uniform8Active",  SoSeparator  ---
PVT   "arrowTranslation",  SoTranslation  ---
PVT   "arrow1Switch",  SoSwitch  ---
      "arrow1",  SoSeparator  ---
PVT   "arrow2Switch",  SoSwitch  ---
      "arrow2",  SoSeparator  ---
PVT   "arrow3Switch",  SoSwitch  ---
      "arrow3",  SoSeparator  ---
PVT   "arrow4Switch",  SoSwitch  ---
      "arrow4",  SoSeparator  ---
PVT   "arrow5Switch",  SoSwitch  ---
      "arrow5",  SoSeparator  ---
PVT   "arrow6Switch",  SoSwitch  ---
      "arrow6",  SoSeparator  ---

(See SoBaseKit::printTable() for information about the output formatting.)

SoHandleBoxDragger::~SoHandleBoxDragger (void) [protected], [virtual]

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

SoType SoHandleBoxDragger::getTypeId (void) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoDragger.

const SoFieldData * SoHandleBoxDragger::getFieldData (void) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoDragger.

const SoNodekitCatalog * SoHandleBoxDragger::getNodekitCatalog (void) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoDragger.

SbBool SoHandleBoxDragger::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 SoHandleBoxDragger::setDefaultOnNonWritingFields (void) [protected], [virtual]

(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 scenegraph export operations.

This is typically done when:

1.

field value is NULL and part is NULL by default

2.

it is a leaf SoGroup or SoSeparator node with no children

3.

it is a leaf listpart with no children and an SoGroup or SoSeparator container

4.

it is a non-leaf part and it's 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.

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

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

void SoHandleBoxDragger::finishCB (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.

void SoHandleBoxDragger::metaKeyChangeCB (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.

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

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

void SoHandleBoxDragger::dragStart (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 dragger is selected (picked) by the user.

void SoHandleBoxDragger::drag (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 user drags the mouse after picking the dragger.

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

void SoHandleBoxDragger::setAllPartsActive (SbBool onoroff) [protected]

Activate or deactive all dragger geometry parts.

Member Data Documentation

SoSFVec3f SoHandleBoxDragger::scaleFactor

Continuously updated to contain the current vector of scaling along the X, Y and Z axes.

SoSFVec3f SoHandleBoxDragger::translation

Continuously updated to contain the current translation from the dragger's local origo position.

The application programmer applying this dragger in his code should connect the relevant node fields in the scene to this field to make it follow the dragger.

SoFieldSensor * SoHandleBoxDragger::translFieldSensor [protected]

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

SoFieldSensor * SoHandleBoxDragger::scaleFieldSensor [protected]

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

Author

Generated automatically by Doxygen for Coin from the source code.

Referenced By

SoHandleBoxDragger.3coin2(3) is an alias of SoHandleBoxDragger.3coin3(3).

Tue Feb 7 2017 Version 3.1.3 Coin