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  -  SOHANDLEBOXDRAGGER (3)

NAME

SoHandleBoxDragger — box you can scale, stretch and translate by dragging with the mouse

CONTENTS

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

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoInteractionKit > SoDragger > SoHandleBoxDragger

SYNOPSIS

#include <Inventor/draggers/SoHandleBoxDragger.h>

Fields from class SoHandleBoxDragger:

    SoSFVec3f    
                    
SoSFVec3f            scaleFactor    
SoSFVec3f    
                    
SoSFVec3f            translation

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 SoHandleBoxDragger:

       
                    
                     SoHandleBoxDragger()    
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

SoHandleBoxDragger is a dragger shaped like a wireframe box with small corner cubes mounted on each corner. Click and drag any of these cubes to scale the box uniformly. Six other center cubes are centered on the sides of the box; white lines connect them to the center of the dragger. Drag one of the center cubes along its line to stretch the box in that direction. Dragging a face of the box translates the dragger within that plane.

While you drag a face of the box, purple feedback arrows display the possible directions of motion. Press the <Shift> key to constrain the motion to one of the two major directions in the plane. The constraint direction is chosen based on the next user gesture. Press the <Control> key and the dragger will translate perpendicular to that plane. The translation field is modified as the face is dragged.

By default, dragging any of the small cubes scales about the center of the object. Pressing the <Control> key changes this: A corner cube will scale about its opposite corner. A center cube will scale about the center of its opposite face. Dragging one of the small cubes will usually result in changes to both the scaleFactor and translation fields. This is because any scale about a point other than the origin has a translation element.

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 SoHandleBoxManip, which is subclassed from SoTransform. It creates one of these draggers and uses it as the interface to change its fields. (see the SoHandleBoxManip reference 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 SoHandleBoxDragger 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/handleBoxDragger.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

    SoSFVec3f    
                    
SoSFVec3f            scaleFactor
Scale of the dragger.

    SoSFVec3f    
                    
SoSFVec3f            translation
Position of the dragger.

METHODS

       
                    
                     SoHandleBoxDragger()
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
translator1Separator--yes
translator1ActiveSeparator--yes
translator2Separator--yes
translator2ActiveSeparator--yes
translator3Separator--yes
translator3ActiveSeparator--yes
translator4Separator--yes
translator4ActiveSeparator--yes
translator5Separator--yes
translator5ActiveSeparator--yes
translator6Separator--yes
translator6ActiveSeparator--yes
extruder1Separator--yes
extruder1ActiveSeparator--yes
extruder2Separator--yes
extruder2ActiveSeparator--yes
extruder3Separator--yes
extruder3ActiveSeparator--yes
extruder4Separator--yes
extruder4ActiveSeparator--yes
extruder5Separator--yes
extruder5ActiveSeparator--yes
extruder6Separator--yes
extruder6ActiveSeparator--yes
uniform1Separator--yes
uniform1ActiveSeparator--yes
uniform2Separator--yes
uniform2ActiveSeparator--yes
uniform3Separator--yes
uniform3ActiveSeparator--yes
uniform4Separator--yes
uniform4ActiveSeparator--yes
uniform5Separator--yes
uniform5ActiveSeparator--yes
uniform6Separator--yes
uniform6ActiveSeparator--yes
uniform7Separator--yes
uniform7ActiveSeparator--yes
uniform8Separator--yes
uniform8ActiveSeparator--yes
arrow1Separator--yes
arrow2Separator--yes
arrow3Separator--yes
arrow4Separator--yes
arrow5Separator--yes
arrow6Separator--yes

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

DRAGGER RESOURCES

.in 0n+.5i     Resource:         handleBoxTranslator1
.in 0n+.5i     Part:             translator1    
Appearance:       White Line-Style Square    
Description:      Top face of handleBox. Picking this initiates scaling in x-z plane.

.in 0n+.5i     Resource:         handleBoxTranslator2
.in 0n+.5i     Part:             translator2    
Appearance:       White Line-Style Square    
Description:      Bottom face of handleBox. Picking this initiates scaling in x-z plane.

.in 0n+.5i     Resource:         handleBoxTranslator3
.in 0n+.5i     Part:             translator3    
Appearance:       White Line-Style Square    
Description:      Left face of handleBox. Picking this initiates scaling in y-z plane.

.in 0n+.5i     Resource:         handleBoxTranslator4
.in 0n+.5i     Part:             translator4    
Appearance:       White Line-Style Square    
Description:      Right face of handleBox. Picking this initiates scaling in y-z plane.

.in 0n+.5i     Resource:         handleBoxTranslator5
.in 0n+.5i     Part:             translator5    
Appearance:       White Line-Style Square    
Description:      Front face of handleBox. Picking this initiates scaling in x-y plane.

.in 0n+.5i     Resource:         handleBoxTranslator6
.in 0n+.5i     Part:             translator6    
Appearance:       White Line-Style Square    
Description:      Back face of handleBox. Picking this initiates scaling in x-y plane.

.in 0n+.5i     Resource:         handleBoxTranslator1Active
.in 0n+.5i     Part:             translator1Active    
Appearance:       Yellow version of handleBoxTranslator1    
Description:      Replaces handleBoxTranslator1 during dragging.

.in 0n+.5i     Resource:         handleBoxTranslator2Active
.in 0n+.5i     Part:             translator2Active    
Appearance:       Yellow version of handleBoxTranslator2    
Description:      Replaces handleBoxTranslator2 during dragging.

.in 0n+.5i     Resource:         handleBoxTranslator3Active
.in 0n+.5i     Part:             translator3Active    
Appearance:       Yellow version of handleBoxTranslator3    
Description:      Replaces handleBoxTranslator3 during dragging.

.in 0n+.5i     Resource:         handleBoxTranslator4Active
.in 0n+.5i     Part:             translator4Active    
Appearance:       Yellow version of handleBoxTranslator4    
Description:      Replaces handleBoxTranslator4 during dragging.

.in 0n+.5i     Resource:         handleBoxTranslator5Active
.in 0n+.5i     Part:             translator5Active    
Appearance:       Yellow version of handleBoxTranslator5    
Description:      Replaces handleBoxTranslator5 during dragging.

.in 0n+.5i     Resource:         handleBoxTranslator6Active
.in 0n+.5i     Part:             translator6Active    
Appearance:       Yellow version of handleBoxTranslator6    
Description:      Replaces handleBoxTranslator6 during dragging.

.in 0n+.5i     Resource:         handleBoxExtruder1
.in 0n+.5i     Part:             extruder1    
Appearance:       Small white cube at (0,1.25,0) with line to origin    
Description:      Selecting this part initiates 1-D scaling along Y axis.

.in 0n+.5i     Resource:         handleBoxExtruder2
.in 0n+.5i     Part:             extruder2    
Appearance:       Small white cube at (0,-1.25,0) with line to origin    
Description:      Selecting this part initiates 1-D scaling along Y axis.

.in 0n+.5i     Resource:         handleBoxExtruder3
.in 0n+.5i     Part:             extruder3    
Appearance:       Small white cube at (-1.25,0,0) with line to origin    
Description:      Selecting this part initiates 1-D scaling along X axis.

.in 0n+.5i     Resource:         handleBoxExtruder4
.in 0n+.5i     Part:             extruder4    
Appearance:       Small white cube at (1.25,0,0) with line to origin    
Description:      Selecting this part initiates 1-D scaling along X axis.

.in 0n+.5i     Resource:         handleBoxExtruder5
.in 0n+.5i     Part:             extruder5    
Appearance:       Small white cube at (0,0,1.25) with line to origin    
Description:      Selecting this part initiates 1-D scaling along Z axis.

.in 0n+.5i     Resource:         handleBoxExtruder6
.in 0n+.5i     Part:             extruder6    
Appearance:       Small white cube at (0,0,-1.25) with line to origin    
Description:      Selecting this part initiates 1-D scaling along Z axis.

.in 0n+.5i     Resource:         handleBoxExtruder1Active
.in 0n+.5i     Part:             extruder1Active    
Appearance:       Yellow version of handleBoxExtruder1    
Description:      Replaces handleBoxExtruder1 during dragging.

.in 0n+.5i     Resource:         handleBoxExtruder2Active
.in 0n+.5i     Part:             extruder2Active    
Appearance:       Yellow version of handleBoxExtruder1    
Description:      Replaces handleBoxExtruder1 during dragging.

.in 0n+.5i     Resource:         handleBoxExtruder3Active
.in 0n+.5i     Part:             extruder3Active    
Appearance:       Yellow version of handleBoxExtruder3    
Description:      Replaces handleBoxExtruder3 during dragging.

.in 0n+.5i     Resource:         handleBoxExtruder4Active
.in 0n+.5i     Part:             extruder4Active    
Appearance:       Yellow version of handleBoxExtruder4    
Description:      Replaces handleBoxExtruder4 during dragging.

.in 0n+.5i     Resource:         handleBoxExtruder5Active
.in 0n+.5i     Part:             extruder5Active    
Appearance:       Yellow version of handleBoxExtruder5    
Description:      Replaces handleBoxExtruder5 during dragging.

.in 0n+.5i     Resource:         handleBoxExtruder6Active
.in 0n+.5i     Part:             extruder6Active    
Appearance:       Yellow version of handleBoxExtruder6    
Description:      Replaces handleBoxExtruder6 during dragging.

.in 0n+.5i     Resource:         handleBoxUniform1
.in 0n+.5i     Part:             uniform1    
Appearance:       Small white cube in (+x+y+z) corner of handleBox    
Description:      Picking this initiates uniform scaling.

.in 0n+.5i     Resource:         handleBoxUniform2
.in 0n+.5i     Part:             uniform2    
Appearance:       Small white cube in (+x+y-z) corner of handleBox    
Description:      Picking this initiates uniform scaling.

.in 0n+.5i     Resource:         handleBoxUniform3
.in 0n+.5i     Part:             uniform3    
Appearance:       Small white cube in (+x-y+z) corner of handleBox    
Description:      Picking this initiates uniform scaling.

.in 0n+.5i     Resource:         handleBoxUniform4
.in 0n+.5i     Part:             uniform4    
Appearance:       Small white cube in (+x-y-z) corner of handleBox    
Description:      Picking this initiates uniform scaling.

.in 0n+.5i     Resource:         handleBoxUniform5
.in 0n+.5i     Part:             uniform5    
Appearance:       Small white cube in (-x+y+z) corner of handleBox    
Description:      Picking this initiates uniform scaling.

.in 0n+.5i     Resource:         handleBoxUniform6
.in 0n+.5i     Part:             uniform6    
Appearance:       Small white cube in (-x+y-z) corner of handleBox    
Description:      Picking this initiates uniform scaling.

.in 0n+.5i     Resource:         handleBoxUniform7
.in 0n+.5i     Part:             uniform7    
Appearance:       Small white cube in (-x-y+z) corner of handleBox    
Description:      Picking this initiates uniform scaling.

.in 0n+.5i     Resource:         handleBoxUniform8
.in 0n+.5i     Part:             uniform8    
Appearance:       Small white cube in (-x-y-z) corner of handleBox    
Description:      Picking this initiates uniform scaling.

.in 0n+.5i     Resource:         handleBoxUniform1Active
.in 0n+.5i     Part:             uniform1Active    
Appearance:       Yellow version of handleBoxUniform1Active    
Description:      Replaces handleBoxUniform1Active during dragging.

.in 0n+.5i     Resource:         handleBoxUniform2Active
.in 0n+.5i     Part:             uniform2Active    
Appearance:       Yellow version of handleBoxUniform1Active    
Description:      Replaces handleBoxUniform1Active during dragging.

.in 0n+.5i     Resource:         handleBoxUniform3Active
.in 0n+.5i     Part:             uniform3Active    
Appearance:       Yellow version of handleBoxUniform1Active    
Description:      Replaces handleBoxUniform1Active during dragging.

.in 0n+.5i     Resource:         handleBoxUniform4Active
.in 0n+.5i     Part:             uniform4Active    
Appearance:       Yellow version of handleBoxUniform1Active    
Description:      Replaces handleBoxUniform1Active during dragging.

.in 0n+.5i     Resource:         handleBoxUniform5Active
.in 0n+.5i     Part:             uniform5Active    
Appearance:       Yellow version of handleBoxUniform1Active    
Description:      Replaces handleBoxUniform1Active during dragging.

.in 0n+.5i     Resource:         handleBoxUniform6Active
.in 0n+.5i     Part:             uniform6Active    
Appearance:       Yellow version of handleBoxUniform1Active    
Description:      Replaces handleBoxUniform1Active during dragging.

.in 0n+.5i     Resource:         handleBoxUniform7Active
.in 0n+.5i     Part:             uniform7Active    
Appearance:       Yellow version of handleBoxUniform1Active    
Description:      Replaces handleBoxUniform1Active during dragging.

.in 0n+.5i     Resource:         handleBoxUniform8Active
.in 0n+.5i     Part:             uniform8Active    
Appearance:       Yellow version of handleBoxUniform1Active    
Description:      Replaces handleBoxUniform1Active during dragging.

.in 0n+.5i     Resource:         handleBoxArrow1
.in 0n+.5i     Part:             arrow1    
Appearance:       Purple Arrow, pointing up    
Description:      Displayed when translating if Y direction is permitted.

.in 0n+.5i     Resource:         handleBoxArrow2
.in 0n+.5i     Part:             arrow2    
Appearance:       Purple Arrow, pointing down    
Description:      Displayed when translating if Y direction is permitted.

.in 0n+.5i     Resource:         handleBoxArrow3
.in 0n+.5i     Part:             arrow3    
Appearance:       Purple Arrow, pointing left    
Description:      Displayed when translating if X direction is permitted.

.in 0n+.5i     Resource:         handleBoxArrow4
.in 0n+.5i     Part:             arrow4    
Appearance:       Purple Arrow, pointing right    
Description:      Displayed when translating if X direction is permitted.

.in 0n+.5i     Resource:         handleBoxArrow5
.in 0n+.5i     Part:             arrow5    
Appearance:       Purple Arrow, pointing forward    
Description:      Displayed when translating if Z direction is permitted.

.in 0n+.5i     Resource:         handleBoxArrow6
.in 0n+.5i     Part:             arrow6    
Appearance:       Purple Arrow, pointing backward    
Description:      Displayed when translating if Z direction is permitted.

FILE FORMAT/DEFAULTS

HandleBoxDragger {



renderCaching       AUTO
boundingBoxCaching  AUTO
renderCulling       AUTO
pickCulling         AUTO
isActive            FALSE
translation         0 0 0
scaleFactor         1 1 1
callbackList        NULL
surroundScale       NULL
translator1         <handleBoxTranslator1 resource>
translator1Active   <handleBoxTranslator1Active resource>
translator2         <handleBoxTranslator2 resource>
translator2Active   <handleBoxTranslator2Active resource>
translator3         <handleBoxTranslator3 resource>
translator3Active   <handleBoxTranslator3Active resource>
translator4         <handleBoxTranslator4 resource>
translator4Active   <handleBoxTranslator4Active resource>
translator5         <handleBoxTranslator5 resource>
translator5Active   <handleBoxTranslator5Active resource>
translator6         <handleBoxTranslator6 resource>
translator6Active   <handleBoxTranslator6Active resource>
extruder1           <handleBoxExtruder1 resource>
extruder1Active     <handleBoxExtruder1Active resource>
extruder2           <handleBoxExtruder2 resource>
extruder2Active     <handleBoxExtruder2Active resource>
extruder3           <handleBoxExtruder3 resource>
extruder3Active     <handleBoxExtruder3Active resource>
extruder4           <handleBoxExtruder4 resource>
extruder4Active     <handleBoxExtruder4Active resource>
extruder5           <handleBoxExtruder5 resource>
extruder5Active     <handleBoxExtruder5Active resource>
extruder6           <handleBoxExtruder6 resource>
extruder6Active     <handleBoxExtruder6Active resource>
uniform1            <handleBoxUniform1 resource>
uniform1Active      <handleBoxUniform1Active resource>
uniform2            <handleBoxUniform2 resource>
uniform2Active      <handleBoxUniform2Active resource>
uniform3            <handleBoxUniform3 resource>
uniform3Active      <handleBoxUniform3Active resource>
uniform4            <handleBoxUniform4 resource>
uniform4Active      <handleBoxUniform4Active resource>
uniform5            <handleBoxUniform5 resource>
uniform5Active      <handleBoxUniform5Active resource>
uniform6            <handleBoxUniform6 resource>
uniform6Active      <handleBoxUniform6Active resource>
uniform7            <handleBoxUniform7 resource>
uniform7Active      <handleBoxUniform7Active resource>
uniform8            <handleBoxUniform8 resource>
uniform8Active      <handleBoxUniform8Active resource>
arrow1              <handleBoxArrow1 resource>
arrow2              <handleBoxArrow2 resource>
arrow3              <handleBoxArrow3 resource>
arrow4              <handleBoxArrow4 resource>
arrow5              <handleBoxArrow5 resource>
arrow6              <handleBoxArrow6 resource>


}

NOTE

Unlike most multi-function draggers, SoHandleBoxDragger is not a compound dragger made up of other draggers that perform its smaller tasks. This is not because it was inappropriate, but because was written before implementation of the methods that synchronize multiple child draggers. The younger SoTransformBoxDragger has similarities to the handle box dragger, but the transform box dragger is a compound dragger.

SEE ALSO

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

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


SOHANDLEBOXDRAGGER(3IV) (-->)

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