GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOTRANSFORMBOXDRAGGER (3)

NAME

SoTransformBoxDragger — box-like object you scale, rotate, and translate by dragging with the mouse

CONTENTS

Inherits From
Synopsis
Description
Fields
Methods
Catalog Parts
Dragger Resources
File Format/defaults
See Also

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoInteractionKit > SoDragger > SoTransformBoxDragger

SYNOPSIS

#include <Inventor/draggers/SoTransformBoxDragger.h>

Fields from class SoTransformBoxDragger:

    SoSFRotation    
                    
SoSFRotation         rotation    
SoSFVec3f    
                    
SoSFVec3f            translation    
SoSFVec3f    
                    
SoSFVec3f            scaleFactor

Fields from class SoDragger:

    SoSFBool    
                    
SoSFBool             isActive

Fields from class SoInteractionKit:

    SoSFEnum    
                    
SoSFEnum             renderCaching    
SoSFEnum    
                    
SoSFEnum             boundingBoxCaching    
SoSFEnum    
                    
SoSFEnum             renderCulling    
SoSFEnum    
                    
SoSFEnum             pickCulling

Parts from class SoBaseKit:

    (SoNodeKitListPart)    
                     
(SoNodeKitListPart)   callbackList

Methods from class SoTransformBoxDragger:

       
                    
                     SoTransformBoxDragger()    
static const SoNodekitCatalog *    
                    
static const SoNodekitCatalog * getClassNodekitCatalog() const    
static SoType    
                    
static SoType        getClassTypeId()

Methods from class SoDragger:

    void    
                    
void                 addStartCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 removeStartCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 addMotionCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 removeMotionCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 addFinishCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 removeFinishCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 addValueChangedCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 removeValueChangedCallback(SoDraggerCB *f, void *userData = NULL)    
SbBool    
                    
SbBool               enableValueChangedCallbacks()    
void    
                    
void                 setMinGesture(int pixels)    
int    
                    
int                  getMinGesture() const    
static void    
                    
static void          setMinScale(float newMinScale)    
static float    
                    
static float         getMinScale()

Methods from class SoInteractionKit:

    virtual SbBool    
                    
virtual SbBool       setPartAsPath(const SbName &partName, SoPath *surrogatePath )

Methods from class SoBaseKit:

    virtual const SoNodekitCatalog *    
                         
virtual const SoNodekitCatalog * getNodekitCatalog() const    
virtual SoNode *    
                         
virtual SoNode *          getPart(const SbName &partName, SbBool makeIfNeeded)    
SbString    
                         
SbString                  getPartString(const SoBase *part)    
virtual SoNodeKitPath *    
                         
virtual SoNodeKitPath *   createPathToPart(const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend = NULL)    
virtual SbBool    
                         
virtual SbBool            setPart(const SbName &partName, SoNode *newPart)    
SbBool    
                         
SbBool                    set(char *partName, char *parameters)    
SbBool    
                         
SbBool                    set(char *nameValuePairs)    
static SbBool    
                         
static SbBool             isSearchingChildren()    
static void    
                         
static void               setSearchingChildren(SbBool newVal)

Methods from class SoNode:

    void    
                    
void                 setOverride(SbBool state)    
SbBool    
                    
SbBool               isOverride() const    
SoNode *    
                    
SoNode *             copy(SbBool copyConnections = FALSE) const    
virtual SbBool    
                    
virtual SbBool       affectsState() const    
static SoNode *    
                    
static SoNode *      getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoNodeList &list)

Methods from class SoFieldContainer:

    void    
                    
void                 setToDefaults()    
SbBool    
                    
SbBool               hasDefaultValues() const    
SbBool    
                    
SbBool               fieldsAreEqual(const SoFieldContainer *fc) const    
void    
                    
void                 copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)    
void    
                    
void                 get(SbString &fieldDataString)    
virtual int    
                    
virtual int          getFields(SoFieldList &resultList) const    
virtual SoField *    
                    
virtual SoField *    getField(const SbName &fieldName) const    
SbBool    
                    
SbBool               getFieldName(const SoField *field, SbName &fieldName) const    
SbBool    
                    
SbBool               isNotifyEnabled() const    
SbBool    
                    
SbBool               enableNotify(SbBool flag)

Methods from class SoBase:

    void    
                    
void                 ref()    
void    
                    
void                 unref() const    
void    
                    
void                 unrefNoDelete() const    
void    
                    
void                 touch()    
virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
virtual void    
                    
virtual void         setName(const SbName &name)    
virtual SbName    
                    
virtual SbName       getName() const

Macros from class SoBaseKit:

SO_GET_PART(kit, partName, partClass)
                    
SO_CHECK_PART(kit, partName, partClass)
                    

DESCRIPTION

SoTransformBoxDragger is a composite dragger shaped like a box with small cubes at the corners. Click and drag any of these cubes to scale the box uniformly. Drag any edge of the box to rotate the whole dragger about its center, along an axis parallel to that edge. Pick any face of the box for 2D translation in the plane of that face.

Although the box looks just about like a wireframe cube, it is composed of many different simple draggers arranged in a composite assembly. When one part is dragged, the transformBox makes sure they all move together. Each of the parts of the box is a different dragger with the default geometry changed. The faces of the box are SoTranslate2Draggers, the edges are SoRotateCylindricalDraggers, and the cubes are an SoScaleUniformDragger. Drag them and the dragger will update its translation, rotation and scaleFactor fields to reflect the changes. As with all draggers, if you change the fields the dragger will move to match the new settings.

Remember: This is not an SoTransform!. If you want to move other objects with this dragger, you can either:

[a] Use an SoTransformBoxManip, which is subclassed from SoTransform. It creates one of these draggers and uses it as the interface to change its fields. (see the SoTransformBoxManip man page).

[b] Use field-to-field connections to connect the fields of this dragger to those of any SoTransformation node.

You can change the parts in any instance of this dragger using setPart(). The default part geometries are defined as resources for this SoTransformBoxDragger class. They are detailed in the Dragger Resources section of the online reference page for this class. You can make your program use different default resources for the parts by copying the file /usr/share/data/draggerDefaults/transformBoxDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.

FIELDS

    SoSFRotation    
                    
SoSFRotation         rotation
Orientation of the dragger.

    SoSFVec3f    
                    
SoSFVec3f            translation
Position of the dragger.

    SoSFVec3f    
                    
SoSFVec3f            scaleFactor
Scale of the dragger.

METHODS

       
                    
                     SoTransformBoxDragger()
Constructor.

    static const SoNodekitCatalog *    
                    
static const SoNodekitCatalog * getClassNodekitCatalog() const
Returns an SoNodekitCatalog for this class

    static SoType    
                    
static SoType        getClassTypeId()
Returns type identifier for this class.

CATALOG PARTS

All parts
   NULL by
Part NamePart TypeDefault TypeDefault
callbackListNodeKitListPart--yes
surroundScaleSurroundScale--yes
antiSquishAntiSquish--no
scalerScaleUniformDragger--yes
rotator1RotateCylindricalDragger--yes
rotator2RotateCylindricalDragger--yes
rotator3RotateCylindricalDragger--yes
translator1Translate2Dragger--yes
translator2Translate2Dragger--yes
translator3Translate2Dragger--yes
translator4Translate2Dragger--yes
translator5Translate2Dragger--yes
translator6Translate2Dragger--yes

Extra information for list parts from above table
Part NameContainer TypePermissible Types 
callbackListSeparatorCallback, EventCallback

DRAGGER RESOURCES

.in 0n+.5i     Resource:         transformBoxScalerScaler
.in 0n+.5i     Part:             scaler.scaler    
Appearance:       Eight small white cubes at the corners of the box    
Description:      Picking this initiates uniform 3D scaling of the dragger.

.in 0n+.5i     Resource:         transformBoxScalerScalerActive
.in 0n+.5i     Part:             scaler.scalerActive    
Appearance:       Yellow version of the regular scaler part    
Description:      Displayed while the dragger is being scaled.

.in 0n+.5i     Resource:         transformBoxScalerFeedback
.in 0n+.5i     Part:             scaler.feedback    
Appearance:       Empty separator    
Description:      Removes any feedback geometry created in the constructor of the SoScaleUniformDragger.

.in 0n+.5i     Resource:         transformBoxScalerFeedbackActive
.in 0n+.5i     Part:             scaler.feedbackActive    
Appearance:       Empty separator    
Description:      Removes any feedbackActive geometry created in the constructor of the SoScaleUniformDragger.

.in 0n+.5i     Resource:         transformBoxRotatorRotator
.in 0n+.5i     Parts:            rotator1.rotator
                  rotator2.rotator
                  rotator3.rotator    
Appearance:       Four white lines along the edges of the box    
Description:      Picking this begins rotational dragging. In each of the three rotateCylindrical draggers, the lines of the rotator part are oriented parallel to the axis of rotation.

.in 0n+.5i     Resource:         transformBoxRotatorRotatorActive
.in 0n+.5i     Parts:            rotator1.rotatorActive
                  rotator2.rotatorActive
                  rotator3.rotatorActive    
Appearance:       Four yellow lines along the edges of the box    
Description:      Displayed while the dragger is being rotated

.in 0n+.5i     Resource:         transformBoxRotatorFeedback
.in 0n+.5i     Parts:            rotator1.feedback
                  rotator2.feedback
                  rotator3.feedback    
Appearance:       Empty separator    
Description:      Removes any feedback geometry created in the constructor of the SoRotateCylindricalDragger.

.in 0n+.5i     Resource:         transformBoxRotatorFeedbackActive
.in 0n+.5i     Parts:            rotator1.feedbackActive
                  rotator2.feedbackActive
                  rotator3.feedbackActive    
Appearance:       Thin purple line through center of box    
Description:      Displayed to show axis of rotation during rotational dragging.

.in 0n+.5i     Resource:         transformBoxTranslatorTranslator
.in 0n+.5i     Parts:            translator1.translator
                  translator2.translator
                  translator3.translator
                  translator4.translator
                  translator5.translator
                  translator6.translator    
Appearance:       Invisible but pickable square surface    
Description:      Picking these begins 2-D translational dragging within the plane of one of the sides of the box. The invisible squares of the six translate2Draggers are arranged to form the sides of the box. The squares are easy to discern, although rendered as invisible; they are bounded by the lines of the rotational dragger parts.

.in 0n+.5i     Resource:         transformBoxTranslatorTranslatorActive
.in 0n+.5i     Parts:            translator1.translatorActive
                  translator2.translatorActive
                  translator3.translatorActive
                  translator4.translatorActive
                  translator5.translatorActive
                  translator6.translatorActive    
Appearance:       Invisible square surface    
Description:      Shown during 2-D translational dragging.

.in 0n+.5i     Resource:         transformBoxTranslatorXAxisFeedback
.in 0n+.5i     Parts:            translator1.xAxisFeedback
                  translator2.xAxisFeedback
                  translator3.xAxisFeedback
                  translator4.xAxisFeedback
                  translator5.xAxisFeedback
                  translator6.xAxisFeedback    
Appearance:       Short thin purple line    
Description:      Only shown if dragger is moving and the axis is a permissable direction of motion. When pressing <shift>, motion is constrained, and this is displayed only if the primary motion is in the X direction.

.in 0n+.5i     Resource:         transformBoxTranslatorYAxisFeedback
.in 0n+.5i     Parts:            translator1.yAxisFeedback
                  translator2.yAxisFeedback
                  translator3.yAxisFeedback
                  translator4.yAxisFeedback
                  translator5.yAxisFeedback
                  translator6.yAxisFeedback    
Appearance:       Short thin purple line    
Description:      Only shown if dragger is moving and the axis is a permissable direction of motion. When pressing <shift>, motion is constrained, and this is displayed only if the primary motion is in the Y direction.

FILE FORMAT/DEFAULTS

TransformBoxDragger {



renderCaching                 AUTO
boundingBoxCaching            AUTO
renderCulling                 AUTO
pickCulling                   AUTO
isActive                      FALSE
rotation                      0 0 1  0
translation                   0 0 0
scaleFactor                   1 1 1
callbackList                  NULL
surroundScale                 NULL
antiSquish                    AntiSquish {
    sizing BIGGEST_DIMENSION }

scaler                        ScaleUniformDragger { }

rotator1                      RotateCylindricalDragger { }

rotator2                      RotateCylindricalDragger { }

rotator3                      RotateCylindricalDragger { }

translator1                   Translate2Dragger { }

translator2                   Translate2Dragger { }

translator3                   Translate2Dragger { }

translator4                   Translate2Dragger { }

translator5                   Translate2Dragger { }

translator6                   Translate2Dragger { }

scaler.scaler                 <transformBoxScalerScaler resource> scaler.scalerActive           <transformBoxScalerScalerActive resource> scaler.feedback               <transformBoxScalerFeedback resource> scaler.feedbackActive         <transformBoxScalerFeedbackActive resource> rotator1.rotator              <transformBoxRotatorRotator resource> rotator2.rotator              <transformBoxRotatorRotator resource> rotator3.rotator              <transformBoxRotatorRotator resource> rotator1.rotatorActive        <transformBoxRotatorRotatorActive resource> rotator2.rotatorActive        <transformBoxRotatorRotatorActive resource> rotator3.rotatorActive        <transformBoxRotatorRotatorActive resource> rotator1.feedback             <transformBoxRotatorFeedback resource> rotator2.feedback             <transformBoxRotatorFeedback resource> rotator3.feedback             <transformBoxRotatorFeedback resource> rotator1.feedbackActive       <transformBoxRotatorFeedbackActive resource> rotator2.feedbackActive       <transformBoxRotatorFeedbackActive resource> rotator3.feedbackActive       <transformBoxRotatorFeedbackActive resource> translator1.translator        <transformBoxTranslatorTranslator resource> translator2.translator        <transformBoxTranslatorTranslator resource> translator3.translator        <transformBoxTranslatorTranslator resource> translator4.translator        <transformBoxTranslatorTranslator resource> translator5.translator        <transformBoxTranslatorTranslator resource> translator6.translator        <transformBoxTranslatorTranslator resource> translator1.translatorActive  <transformBoxTranslatorTranslatorActive resource> translator2.translatorActive  <transformBoxTranslatorTranslatorActive resource> translator3.translatorActive  <transformBoxTranslatorTranslatorActive resource> translator4.translatorActive  <transformBoxTranslatorTranslatorActive resource> translator5.translatorActive  <transformBoxTranslatorTranslatorActive resource> translator6.translatorActive  <transformBoxTranslatorTranslatorActive resource> translator1.xAxisFeedback     <transformBoxTranslatorXAxisFeedback resource> translator2.xAxisFeedback     <transformBoxTranslatorXAxisFeedback resource> translator3.xAxisFeedback     <transformBoxTranslatorXAxisFeedback resource> translator4.xAxisFeedback     <transformBoxTranslatorXAxisFeedback resource> translator5.xAxisFeedback     <transformBoxTranslatorXAxisFeedback resource> translator6.xAxisFeedback     <transformBoxTranslatorXAxisFeedback resource> translator1.yAxisFeedback     <transformBoxTranslatorYAxisFeedback resource> translator2.yAxisFeedback     <transformBoxTranslatorYAxisFeedback resource> translator3.yAxisFeedback     <transformBoxTranslatorYAxisFeedback resource> translator4.yAxisFeedback     <transformBoxTranslatorYAxisFeedback resource> translator5.yAxisFeedback     <transformBoxTranslatorYAxisFeedback resource> translator6.yAxisFeedback     <transformBoxTranslatorYAxisFeedback resource> }

SEE ALSO

SoInteractionKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger

Search for    or go to Top of page |  Section 3 |  Main Index


SOTRANSFORMBOXDRAGGER(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.