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

SoTransformerManip Class Reference
[Manipulators]

The SoTransformerManip wraps an SoTransformerDragger for convenience.

.
More...

#include <Inventor/manips/SoTransformerManip.h>

Inheritance diagram for SoTransformerManip:

SoTransformManip SoTransform SoTransformation SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
 SoTransformerManip (void)
SbBool isLocateHighlighting (void)
void setLocateHighlighting (SbBool onoff)
void unsquishKnobs (void)

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 ~SoTransformerManip ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)


Detailed Description

The SoTransformerManip wraps an SoTransformerDragger for convenience.

.

transformer.png

The manipulator class takes care of wrapping up the SoTransformerDragger in a simple and convenient API for the application programmer, making it automatically surround the geometry it influences and taking care of the book-keeping routines for it's interaction with the relevant fields of an SoTransformation node.


Constructor & Destructor Documentation

SoTransformerManip::SoTransformerManip ( void   ) 

Default constructor. Allocates an SoTransformerDragger and an SoSurroundScale node to surround the geometry within our part of the scenegraph.

References SoBaseKit::getPart(), SoSurroundScale::numNodesUpToContainer, SoSurroundScale::numNodesUpToReset, and SoTransformManip::setDragger().

SoTransformerManip::~SoTransformerManip (  )  [protected]

Destructor.


Member Function Documentation

SoType SoTransformerManip::getClassTypeId ( void   )  [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoTransformManip.

SoType SoTransformerManip::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
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)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 SoTransformManip.

const SoFieldData ** SoTransformerManip::getFieldDataPtr ( void   )  [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 SoTransformManip.

const SoFieldData * SoTransformerManip::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 SoTransformManip.

void SoTransformerManip::initClass ( void   )  [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoTransformManip.

Referenced by SoInteraction::init().

SbBool SoTransformerManip::isLocateHighlighting ( void   ) 

Convenience function to use the SoTransformerDragger::isLocateHighlighting() method of the embedded dragger. See documentation of that method.

References SoTransformerDragger::getClassTypeId(), SoTransformManip::getDragger(), SoBase::isOfType(), and SoDebugError::postWarning().

void SoTransformerManip::setLocateHighlighting ( SbBool  onoff  ) 

Convenience function to use the SoTransformerDragger::setLocateHighlighting() method of the embedded dragger. See documentation of that method.

References SoTransformerDragger::getClassTypeId(), SoTransformManip::getDragger(), SoBase::isOfType(), and SoDebugError::postWarning().

void SoTransformerManip::unsquishKnobs ( void   ) 

Convenience function to use the SoTransformerDragger::unsquishKnobs() method of the embedded dragger. See documentation of that method.

References SoTransformerDragger::getClassTypeId(), SoTransformManip::getDragger(), SoBase::isOfType(), and SoDebugError::postWarning().


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 23 16:34:04 2009 for Coin by Doxygen. 1.5.8