Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

soscaleuniformdragger(3) [debian man page]

SoScaleUniformDragger(3)					       Coin						  SoScaleUniformDragger(3)

NAME
SoScaleUniformDragger - The SoScaleUniformDragger class provides a mechanism for the end-user to scale in three dimensions. Here's how the dragger looks with its default geometry in the inactive state: SYNOPSIS
#include <Inventor/draggers/SoScaleUniformDragger.h> Inherits SoDragger. Public Member Functions virtual SoType getTypeId (void) const virtual const SoNodekitCatalog * getNodekitCatalog (void) const SoScaleUniformDragger (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 ~SoScaleUniformDragger (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 SbLineProjector * lineProj Additional Inherited Members Detailed Description The SoScaleUniformDragger class provides a mechanism for the end-user to scale in three 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 simultaneously along all the axes. Scaling with this dragger can only be done in a uniform manner, ie the X, Y and Z components of the SoScaleUniformDragger::scaleFactor will always be exactly equal. See also: SoScale2UniformDragger Constructor &; Destructor Documentation SoScaleUniformDragger::SoScaleUniformDragger (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 SoScaleUniformDragger -->"this" "callbackList" "topSeparator" "motionMatrix" "geomSeparator" --> "scalerSwitch" --> "scaler" --> "scalerActive" --> "feedbackSwitch" --> "feedback" --> "feedbackActive".fi (See SoBaseKit::printDiagram() for information about the output formatting.) Detailed information on catalog parts: CLASS SoScaleUniformDragger PVT "this", SoScaleUniformDragger --- "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 --- .fi (See SoBaseKit::printTable() for information about the output formatting.) SoScaleUniformDragger::~SoScaleUniformDragger (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 SoScaleUniformDragger::getClassTypeId (void) [static] This static method returns the SoType object associated with objects of this class. Reimplemented from SoDragger. SoType SoScaleUniformDragger::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 ** SoScaleUniformDragger::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 SoDragger. const SoFieldData * SoScaleUniformDragger::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 * SoScaleUniformDragger::getClassNodekitCatalog (void) [static] Returns the nodekit catalog which defines the layout of this class' kit. Reimplemented from SoDragger. const SoNodekitCatalog * SoScaleUniformDragger::getNodekitCatalog (void) const [virtual] Returns the nodekit catalog which defines the layout of this class' kit. Reimplemented from SoDragger. const SoNodekitCatalog ** SoScaleUniformDragger::getClassNodekitCatalogPtr (void) [static], [protected] Returns the pointer to the pointer of the nodekit catalog for this class. Reimplemented from SoDragger. void SoScaleUniformDragger::initClass (void) [static] Initializes type system for this dragger class. Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init(). Reimplemented from SoDragger. SbBool SoScaleUniformDragger::setUpConnections (SbBoolonoff, SbBooldoitalways = 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 SoScaleUniformDragger::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 SoScaleUniformDragger::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 SoScaleUniformDragger::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 SoScaleUniformDragger::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. Reimplemented from SoInteractionKit. void SoScaleUniformDragger::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 SoScaleUniformDragger::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 SoScaleUniformDragger::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 SoScaleUniformDragger::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 SoScaleUniformDragger::scaleFactor Continuously updated to contain the current vector of scaling along the X, Y and Z axes. SoFieldSensor * SoScaleUniformDragger::fieldSensor [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 SoInteractionKit. SbLineProjector * SoScaleUniformDragger::lineProj [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. Version 3.1.3 Wed May 23 2012 SoScaleUniformDragger(3)
Man Page