SoScale2Dragger.3coin3 man page

SoScale2Dragger — The SoScale2Dragger class provides a mechanism for the end-user to scale in two dimensions.

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

Synopsis

#include <Inventor/draggers/SoScale2Dragger.h>

Inherits SoDragger.

Public Member Functions

virtual SoType getTypeId (void) const

virtual const SoNodekitCatalog * getNodekitCatalog (void) const

SoScale2Dragger (void)

Static Public Member Functions

static SoType getClassTypeId (void)

static const SoNodekitCatalog * getClassNodekitCatalog (void)

static void initClass (void)

Public Attributes

SoSFVec3f scaleFactor

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

virtual ~SoScale2Dragger (void)

virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)

void dragStart (void)

void drag (void)

void dragFinish (void)

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 fieldSensorCB (void *f, SoSensor *s)

static void valueChangedCB (void *f, SoDragger *d)

Protected Attributes

SoSFNode feedback

SoSFNode feedbackActive

SoSFNode feedbackSwitch

SoSFNode scaler

SoSFNode scalerActive

SoSFNode scalerSwitch

SoFieldSensor * fieldSensor

SbPlaneProjector * planeProj

Additional Inherited Members

Detailed Description

The SoScale2Dragger class provides a mechanism for the end-user to scale in two dimensions.

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

Use this dragger to allow the end-user of your application to scale along the X-axis and the Y-axis. (Use a transformation node in front of the dragger to position it and re-orient it to scale in any plane.)

Scaling can be done in a non-uniform manner.

See also:

SoScale1Dragger, SoScaleUniformDragger, SoScale2UniformDragger

Constructor & Destructor Documentation

SoScale2Dragger::SoScale2Dragger (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 SoScale2Dragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
         "geomSeparator"
-->         "scalerSwitch"
-->            "scaler"
-->            "scalerActive"
-->         "feedbackSwitch"
-->            "feedback"
-->            "feedbackActive"

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

Detailed information on catalog parts:

CLASS SoScale2Dragger
PVT   "this",  SoScale2Dragger  --- 
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ] 
PVT   "topSeparator",  SoSeparator  --- 
PVT   "motionMatrix",  SoMatrixTransform  --- 
PVT   "geomSeparator",  SoSeparator  --- 
PVT   "scalerSwitch",  SoSwitch  --- 
      "scaler",  SoSeparator  --- 
      "scalerActive",  SoSeparator  --- 
PVT   "feedbackSwitch",  SoSwitch  --- 
      "feedback",  SoSeparator  --- 
      "feedbackActive",  SoSeparator  ---

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

SoScale2Dragger::~SoScale2Dragger (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 SoScale2Dragger::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 * SoScale2Dragger::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 * SoScale2Dragger::getNodekitCatalog (void) const [virtual]

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

Reimplemented from SoDragger.

SbBool SoScale2Dragger::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 SoScale2Dragger::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 SoScale2Dragger::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 SoScale2Dragger::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 SoScale2Dragger::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 SoScale2Dragger::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 SoScale2Dragger::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 SoScale2Dragger::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 SoScale2Dragger::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.

Member Data Documentation

SoSFVec3f SoScale2Dragger::scaleFactor

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

For the SoScale2Dragger, only the X and Y components are used, the Z component will always be equal to 1 (ie no scaling).

SoFieldSensor * SoScale2Dragger::fieldSensor [protected]

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

SbPlaneProjector * SoScale2Dragger::planeProj [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

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

Mon Sep 5 2016 Version 3.1.3 Coin