sohandleboxmanip(3) [debian man page]
SoHandleBoxManip(3) Coin SoHandleBoxManip(3) NAME
SoHandleBoxManip - The SoHandleBoxManip class wraps an SoHandleBoxDragger for manipulating a transformation. SYNOPSIS
#include <Inventor/manips/SoHandleBoxManip.h> Inherits SoTransformManip. Public Member Functions virtual SoType getTypeId (void) const SoHandleBoxManip (void) Static Public Member Functions static SoType getClassTypeId (void) static void initClass (void) Protected Member Functions virtual const SoFieldData * getFieldData (void) const virtual ~SoHandleBoxManip (void) Static Protected Member Functions static const SoFieldData ** getFieldDataPtr (void) Additional Inherited Members Detailed Description The SoHandleBoxManip class wraps an SoHandleBoxDragger for manipulating a transformation. See also: SoHandleBoxDragger, SoDragger Constructor &; Destructor Documentation SoHandleBoxManip::SoHandleBoxManip (void) Constructor sets us up with an SoHandleBoxDragger for manipulating a transformation. SoHandleBoxManip::~SoHandleBoxManip (void) [protected], [virtual] Protected destructor. (SoHandleBoxManip is automatically destructed when it's reference count goes to 0.) Member Function Documentation SoType SoHandleBoxManip::getClassTypeId (void) [static] This static method returns the SoType object associated with objects of this class. Reimplemented from SoTransformManip. SoType SoHandleBoxManip::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 SoTransformManip. const SoFieldData ** SoHandleBoxManip::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 * SoHandleBoxManip::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 SoHandleBoxManip::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. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoHandleBoxManip(3)
Check Out this Related Man Page
SoTransformBoxManip(3) Coin SoTransformBoxManip(3) NAME
SoTransformBoxManip - The SoTransformBoxManip wraps an SoTransformBoxDragger for convenience. SYNOPSIS
#include <Inventor/manips/SoTransformBoxManip.h> Inherits SoTransformManip. Public Member Functions virtual SoType getTypeId (void) const SoTransformBoxManip (void) Static Public Member Functions static SoType getClassTypeId (void) static void initClass (void) Protected Member Functions virtual const SoFieldData * getFieldData (void) const virtual ~SoTransformBoxManip (void) Static Protected Member Functions static const SoFieldData ** getFieldDataPtr (void) Additional Inherited Members Detailed Description The SoTransformBoxManip wraps an SoTransformBoxDragger for convenience. The manipulator class takes care of wrapping up the SoTransformBoxDragger 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. Here's a simple usage example, in the form of an Inventor format file: #Inventor V2.1 ascii Separator { TransformBoxManip { } Group { Cone { } } } Translation { translation 2 4 0 } Separator { TransformBoxManip { } Group { Sphere { } } }.fi Constructor &; Destructor Documentation SoTransformBoxManip::SoTransformBoxManip (void) Default constructor. Allocates an SoTransformBoxDragger and an SoSurroundScale node to surround the geometry within our part of the scenegraph. SoTransformBoxManip::~SoTransformBoxManip (void) [protected], [virtual] Destructor. Member Function Documentation SoType SoTransformBoxManip::getClassTypeId (void) [static] This static method returns the SoType object associated with objects of this class. Reimplemented from SoTransformManip. SoType SoTransformBoxManip::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 SoTransformManip. const SoFieldData ** SoTransformBoxManip::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 * SoTransformBoxManip::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 SoTransformBoxManip::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. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoTransformBoxManip(3)