--- name: "SoHandleBoxDragger" section: "3iv" platform: "linux" package: "inventor-doc" version: "2.1.6+ds-2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/SoHandleBoxDragger/3iv" --- # SoHandleBoxDragger(3iv) box you can scale, stretch and translate by dragging with the mouse ## NAME SoHandleBoxDragger — box you can scale, stretch and translate by dragging with the mouse ## INHERITS FROM SoBase \> SoFieldContainer \> SoNode \> SoBaseKit \> SoInteractionKit \> SoDragger \> SoHandleBoxDragger ## SYNOPSIS **#include \** Fields from class SoHandleBoxDragger: **SoSFVec3f** **scaleFactor**\ **SoSFVec3f** **translation** Fields from class SoDragger: **SoSFBool** **isActive** Fields from class SoInteractionKit: **SoSFEnum** **renderCaching**\ **SoSFEnum** **boundingBoxCaching**\ **SoSFEnum** **renderCulling**\ **SoSFEnum** **pickCulling** Parts from class SoBaseKit: **(SoNodeKitListPart)** **callbackList** Methods from class SoHandleBoxDragger: **SoHandleBoxDragger()**\ **static const SoNodekitCatalog \***\ **getClassNodekitCatalog() const**\ **static SoType** **getClassTypeId()** Methods from class SoDragger: **void** **addStartCallback(SoDraggerCB \*f, void \*userData = NULL)**\ **void** **removeStartCallback(SoDraggerCB \*f, void \*userData = NULL)**\ **void** **addMotionCallback(SoDraggerCB \*f, void \*userData = NULL)**\ **void** **removeMotionCallback(SoDraggerCB \*f, void \*userData = NULL)**\ **void** **addFinishCallback(SoDraggerCB \*f, void \*userData = NULL)**\ **void** **removeFinishCallback(SoDraggerCB \*f, void \*userData = NULL)**\ **void** **addValueChangedCallback(SoDraggerCB \*f, void \*userData = NULL)**\ **void** **removeValueChangedCallback(SoDraggerCB \*f, void \*userData = NULL)**\ **SbBool** **enableValueChangedCallbacks()**\ **void** **setMinGesture(int pixels)**\ **int** **getMinGesture() const**\ **static void** **setMinScale(float newMinScale)**\ **static float** **getMinScale()** Methods from class SoInteractionKit: **virtual SbBool** **setPartAsPath(const SbName &partName, SoPath \*surrogatePath )** Methods from class SoBaseKit: **virtual const SoNodekitCatalog \***\ **getNodekitCatalog() const**\ **virtual SoNode \*** **getPart(const SbName &partName, SbBool makeIfNeeded)**\ **SbString** **getPartString(const SoBase \*part)**\ **virtual SoNodeKitPath \*** **createPathToPart(const SbName &partName, SbBool makeIfNeeded, const SoPath \*pathToExtend = NULL)**\ **virtual SbBool** **setPart(const SbName &partName, SoNode \*newPart)**\ **SbBool** **set(char \*partName, char \*parameters)**\ **SbBool** **set(char \*nameValuePairs)**\ **static SbBool** **isSearchingChildren()**\ **static void** **setSearchingChildren(SbBool newVal)** Methods from class SoNode: **void** **setOverride(SbBool state)**\ **SbBool** **isOverride() const**\ **SoNode \*** **copy(SbBool copyConnections = FALSE) const**\ **virtual SbBool** **affectsState() const**\ **static SoNode \*** **getByName(const SbName &name)**\ **static int** **getByName(const SbName &name, SoNodeList &list)** Methods from class SoFieldContainer: **void** **setToDefaults()**\ **SbBool** **hasDefaultValues() const**\ **SbBool** **fieldsAreEqual(const SoFieldContainer \*fc) const**\ **void** **copyFieldValues(const SoFieldContainer \*fc, SbBool copyConnections = FALSE)**\ **void** **get(SbString &fieldDataString)**\ **virtual int** **getFields(SoFieldList &resultList) const**\ **virtual SoField \*** **getField(const SbName &fieldName) const**\ **SbBool** **getFieldName(const SoField \*field, SbName &fieldName) const**\ **SbBool** **isNotifyEnabled() const**\ **SbBool** **enableNotify(SbBool flag)** Methods from class SoBase: **void** **ref()**\ **void** **unref() const**\ **void** **unrefNoDelete() const**\ **void** **touch()**\ **virtual SoType** **getTypeId() const**\ **SbBool** **isOfType(SoType type) const**\ **virtual void** **setName(const SbName &name)**\ **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 **\** 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 **\** 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 **\** 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** **scaleFactor**\ Scale of the dragger. **SoSFVec3f** **translation**\ Position of the dragger. ## METHODS **SoHandleBoxDragger()**\ Constructor. **static const SoNodekitCatalog \***\ **getClassNodekitCatalog() const**\ Returns an **SoNodekitCatalog** for this class **static SoType** **getClassTypeId()**\ Returns type identifier for this class. ## CATALOG PARTS | | | | | | --- | --- | --- | --- | | **All parts** | | | | | **NULL by** | | **Part Name** | **Part Type** | **Default Type** | **Default** | | | | callbackList | NodeKitListPart | -- | yes | | surroundScale | SurroundScale | -- | yes | | translator1 | Separator | -- | yes | | translator1Active | Separator | -- | yes | | translator2 | Separator | -- | yes | | translator2Active | Separator | -- | yes | | translator3 | Separator | -- | yes | | translator3Active | Separator | -- | yes | | translator4 | Separator | -- | yes | | translator4Active | Separator | -- | yes | | translator5 | Separator | -- | yes | | translator5Active | Separator | -- | yes | | translator6 | Separator | -- | yes | | translator6Active | Separator | -- | yes | | extruder1 | Separator | -- | yes | | extruder1Active | Separator | -- | yes | | extruder2 | Separator | -- | yes | | extruder2Active | Separator | -- | yes | | extruder3 | Separator | -- | yes | | extruder3Active | Separator | -- | yes | | extruder4 | Separator | -- | yes | | extruder4Active | Separator | -- | yes | | extruder5 | Separator | -- | yes | | extruder5Active | Separator | -- | yes | | extruder6 | Separator | -- | yes | | extruder6Active | Separator | -- | yes | | uniform1 | Separator | -- | yes | | uniform1Active | Separator | -- | yes | | uniform2 | Separator | -- | yes | | uniform2Active | Separator | -- | yes | | uniform3 | Separator | -- | yes | | uniform3Active | Separator | -- | yes | | uniform4 | Separator | -- | yes | | uniform4Active | Separator | -- | yes | | uniform5 | Separator | -- | yes | | uniform5Active | Separator | -- | yes | | uniform6 | Separator | -- | yes | | uniform6Active | Separator | -- | yes | | uniform7 | Separator | -- | yes | | uniform7Active | Separator | -- | yes | | uniform8 | Separator | -- | yes | | uniform8Active | Separator | -- | yes | | arrow1 | Separator | -- | yes | | arrow2 | Separator | -- | yes | | arrow3 | Separator | -- | yes | | arrow4 | Separator | -- | yes | | arrow5 | Separator | -- | yes | | arrow6 | Separator | -- | yes | | | | | | | | --- | --- | --- | | **Extra information for list parts from above table** | | **Part Name** | **Container Type** | **Permissible Types** | | | | callbackList | Separator | Callback, 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 translator1Active translator2 translator2Active translator3 translator3Active translator4 translator4Active translator5 translator5Active translator6 translator6Active extruder1 extruder1Active extruder2 extruder2Active extruder3 extruder3Active extruder4 extruder4Active extruder5 extruder5Active extruder6 extruder6Active uniform1 uniform1Active uniform2 uniform2Active uniform3 uniform3Active uniform4 uniform4Active uniform5 uniform5Active uniform6 uniform6Active uniform7 uniform7Active uniform8 uniform8Active arrow1 arrow2 arrow3 arrow4 arrow5 arrow6 } ``` ## 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**