|
Open Inventor Release 2024.2.0
|
|
| |
|
Open Inventor Release 2024.2.0
|
|
|
| |
Object you can translate or scale within a plane by dragging with the mouse. More...
#include <Inventor/draggers/SoTabPlaneDragger.h>
Inheritance diagram for SoTabPlaneDragger:Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| virtual const SoNodekitCatalog * | getNodekitCatalog () const |
| Returns the SoNodekitCatalog for this instance. | |
| SoTabPlaneDragger () | |
| Constructor. | |
| void | adjustScaleTabSize () |
| Causes the scale tab sizes to be adjusted so that they remain a near constant screen space size. | |
| void | showEdgeScales (const SbBool show) |
| show or hide edges | |
| void | showCornerScales (const SbBool show) |
| show or hide corners | |
| Public Member Functions inherited from SoDragger | |
| void | addStartCallback (SoDraggerCB *f, void *userData=NULL) |
| Adds start callback. | |
| void | removeStartCallback (SoDraggerCB *f, void *userData=NULL) |
| Removes start callback. | |
| void | addMotionCallback (SoDraggerCB *f, void *userData=NULL) |
| Adds motion callback. | |
| void | removeMotionCallback (SoDraggerCB *f, void *userData=NULL) |
| Removes motion callback. | |
| void | addFinishCallback (SoDraggerCB *f, void *userData=NULL) |
| Adds finish callback. | |
| void | removeFinishCallback (SoDraggerCB *f, void *userData=NULL) |
| Removes finish callback. | |
| void | addValueChangedCallback (SoDraggerCB *f, void *userData=NULL) |
| Adds value-changed callback. | |
| void | removeValueChangedCallback (SoDraggerCB *f, void *userData=NULL) |
| Removes value-changed callback. | |
| void | setMinGesture (int pixels) |
| Sets the number of pixels of movement required to initiate a constraint gesture. | |
| void | setMinGesture (float pixels) |
| Float version of setMinGesture. | |
| int | getMinGesture () const |
| Gets the number of pixels of movement required to initiate a constraint gesture. | |
| float | getMinGestureFloat () const |
| Float version of getMinGesture. | |
| SbBool | enableValueChangedCallbacks (SbBool newVal) |
| You can temporarily disable a dragger's valueChangedCallbacks. | |
| void | setTrackerDirectMode (TrackerDirectMode mode=DEFAULT) |
| Sets the tracker direct mode for this dragger (see description above). | |
| TrackerDirectMode | getTrackerDirectMode () const |
| Get the current tracker direct mode for this dragger. | |
| void | setMotionMatrix (const SbMatrix &newMatrix) |
| Set the motion matrix. | |
| const SbMatrix & | getMotionMatrix () |
| Get the motion matrix. | |
| Public Member Functions inherited from SoInteractionKit | |
| virtual SbBool | setPartAsPath (const SbName &partName, SoPath *surrogatePath) |
| Sets any public part in the interaction kit as a "surrogate" path instead. | |
| virtual SbBool | affectsState () const |
| Returns TRUE if a node has an effect on the state during traversal. | |
| Public Member Functions inherited from SoBaseKit | |
| SoBaseKit () | |
| Constructor. | |
| virtual SoNode * | getPart (const SbName &partName, SbBool makeIfNeeded) |
| Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
| template<typename PartType > | |
| PartType * | getPart (const SbName &partName) |
| Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE. | |
| template<typename PartType > | |
| PartType * | checkPart (const SbName &partName) |
| Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE. | |
| SbString | getPartString (const SoBase *part) |
| Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. | |
| virtual SoNodeKitPath * | createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL) |
| Returns a path that begins at this nodekit and ends at partName. | |
| virtual SbBool | setPart (const SbName &partName, SoNode *newPart) |
| Inserts the given node (not a copy) as the new part specified by partName. | |
| SoNONUNICODE SbBool | set (char *nameValuePairListString) |
| This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
| SbBool | set (const SbString &nameValuePairListString) |
| This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
| SoNONUNICODE SbBool | set (const char *partNameString, const char *parameterString) |
| This function allows field values of parts (nodes) to be set. | |
| SbBool | set (const SbString &partNameString, const SbString ¶meterString) |
| This function allows field values of parts (nodes) to be set. | |
| Public Member Functions inherited from SoNode | |
| virtual void | setOverride (const SbBool state) |
| Turns the override flag on or off. | |
| virtual SbBool | isOverride () const |
| Returns the state of the override flag. | |
| virtual SoNode * | copy (SbBool copyConnections=FALSE) const |
| Creates and returns an exact copy of the node. | |
| virtual void | touch () |
| Marks an instance as modified, simulating a change to it. | |
| Public Member Functions inherited from SoFieldContainer | |
| void | setToDefaults () |
| Sets all fields in this object to their default values. | |
| SbBool | hasDefaultValues () const |
| Returns TRUE if all of the object's fields have their default values. | |
| SbBool | fieldsAreEqual (const SoFieldContainer *fc) const |
| Returns TRUE if this object's fields are exactly equal to fc's fields. | |
| void | copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE) |
| Copies the contents of fc's fields into this object's fields. | |
| SoNONUNICODE SbBool | set (const char *fieldDataString) |
| Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. | |
| SbBool | set (const SbString &fieldDataString) |
| Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. | |
| void | get (SbString &fieldDataString) |
| Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
| virtual int | getFields (SoFieldList &list) const |
| Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
| virtual int | getAllFields (SoFieldList &list) const |
| Returns a list of fields, including the eventIn's and eventOut's. | |
| virtual SoField * | getField (const SbName &fieldName) const |
| Returns a the field of this object whose name is fieldName. | |
| virtual SoField * | getEventIn (const SbName &fieldName) const |
| Returns a the eventIn with the given name. | |
| virtual SoField * | getEventOut (const SbName &fieldName) const |
| Returns the eventOut with the given name. | |
| SbBool | getFieldName (const SoField *field, SbName &fieldName) const |
| Returns the name of the given field in the fieldName argument. | |
| SbBool | enableNotify (SbBool flag) |
| Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). | |
| SbBool | isNotifyEnabled () const |
| Notification is the process of telling interested objects that this object has changed. | |
| virtual void | setUserData (void *data) |
| Sets application data. | |
| void * | getUserData (void) const |
| Gets user application data. | |
| Public Member Functions inherited from SoBase | |
| virtual SbName | getName () const |
| Returns the name of an instance. | |
| virtual void | setName (const SbName &name) |
| Sets the name of an instance. | |
| void | setSynchronizable (const bool b) |
| Sets this to be a ScaleViz synchronizable object. | |
| bool | isSynchronizable () const |
| Gets the ScaleViz synchronizable state of this object. | |
| Public Member Functions inherited from SoRefCounter | |
| void | ref () const |
| Adds a reference to an instance. | |
| void | unref () const |
| Removes a reference from an instance. | |
| void | unrefNoDelete () const |
| unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero. | |
| int | getRefCount () const |
| Returns current reference count. | |
| void | lock () const |
| lock this instance. | |
| void | unlock () const |
| unlock this instance. | |
| Public Member Functions inherited from SoTypedObject | |
| SbBool | isOfType (const SoType &type) const |
| Returns TRUE if this object is of the type specified in type or is derived from that type. | |
| template<typename TypedObjectClass > | |
| SbBool | isOfType () const |
| Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
| Public Member Functions inherited from SoGetView | |
| SoGetView () | |
| Default constructor. | |
| virtual | ~SoGetView () |
| virtual SbBool | getViewportIsEnabled () const |
| Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise. | |
| virtual const SbVec2f | getViewportOrigin () const |
| Returns SbViewportRegion origin. | |
| virtual const SbVec2f | getViewportSize () const |
| Returns SbViewportRegion size. | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for this class. | |
| Static Public Member Functions inherited from SoDragger | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for this class. | |
| static void | setMinScale (float newMinScale) |
| Sets the smallest scale that any dragger will write. | |
| static float | getMinScale () |
| Gets the smallest scale that any dragger will write. | |
| static void | setInitialTrackerDirectMode (TrackerDirectMode mode=DEFAULT) |
| Set the initial tracker direct mode for draggers not yet created. | |
| static TrackerDirectMode | getInitialTrackerDirectMode () |
| Get the initial tracker direct mode. | |
| Static Public Member Functions inherited from SoInteractionKit | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for this class. | |
| Static Public Member Functions inherited from SoBaseKit | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for the class SoBaseKit. | |
| static void | setSearchingChildren (SbBool newVal) |
| Sets if nodekit children are searched during SoSearchAction traversal. | |
| static SbBool | isSearchingChildren () |
| Returns TRUE if nodekit children are searched during SoSearchAction traversal. | |
| Static Public Member Functions inherited from SoNode | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static SoNode * | getByName (const SbName &name) |
| A node's name can be set using SoBase::setName(). | |
| static int | getByName (const SbName &name, SoNodeList &list) |
| A node's name can be set using SoBase::setName(). | |
| Static Public Member Functions inherited from SoFieldContainer | |
| static SoType | getClassTypeId () |
| Returns the type of this class. | |
| Static Public Member Functions inherited from SoBase | |
| static SoType | getClassTypeId () |
| Returns type identifier for this class. | |
| Static Public Member Functions inherited from SoTypedObject | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
Public Attributes | |
| SoSFVec3f | translation |
| Position of the dragger. | |
| SoSFVec3f | scaleFactor |
| Scale factor affecting the dragger. | |
| SoSFBool | resizeHandles |
| If set to TRUE, handles will be resized automatically when the view matrix (camera) changes. | |
| SoSFBool | scaleUniform |
| If set to TRUE, scaling will always be uniform. | |
| SoSFBool | twoSidedLighting |
| If set to TRUE, OpenGL two sided lighting will be enabled. | |
| SoSFFloat | lineWidth |
| Specifies the line width for the outline box. | |
| SoSFInt32 | tabPixelSize |
| Specifies the size of the green tabs in pixels. | |
| Public Attributes inherited from SoDragger | |
| SoSFBool | isActive |
| TRUE when mouse is down and dragging, else FALSE. | |
| SoSFBool | enableCallbacks |
| If set to FALSE, motion, start and finish callbacks are disabled. | |
| Public Attributes inherited from SoInteractionKit | |
| SoSFEnum | boundingBoxCaching |
| Set bounding box caching mode. | |
| SoSFEnum | renderCulling |
| Set render culling mode. | |
| SoSFEnum | pickCulling |
| Set pick caching mode. | |
| SoDEPRECATED SoSFEnum | renderCaching |
| Set render caching mode. | |
| Public Attributes inherited from SoBaseKit | |
| SoSFBool | boundingBoxIgnoring |
| Whether to ignore this node during bounding box traversal. | |
Additional Inherited Members | |
| Public Types inherited from SoDragger | |
| enum | TrackerDirectMode { NONE , MOVE , ROTATE , FREE , DEFAULT } |
| Tracker direct mode. More... | |
| typedef void | SoDraggerCB(void *userData, SoDragger *dragger) |
| Used in defining the callback function lists. | |
| Public Types inherited from SoInteractionKit | |
| enum | CacheEnabled { OFF , ON , AUTO } |
| Possible values for caching. More... | |
Object you can translate or scale within a plane by dragging with the mouse.
SoTabPlaneDragger is a dragger which allows the user to interactively translate and scale in a plane. It looks like a square white outline with smaller green squares (or tabs ) set in the corners and along the center of each edge.
Dragging a corner tab scales the dragger in 2D by scaling about the opposite corner. Holding the SHIFT key while while dragging a corner tab forces uniform scaling.
Dragging an edge tab performs 1D scaling about the opposite edge.
Uniform scaling can also be forced by setting the scaleUniform field to TRUE.
Clicking and dragging a face does translation within the plane of the face. Although the face of the dragger is invisible (using the default dragger geometry) it is pickable.
The dragger tries to keep the small tabs a constant size in screen space. Before version 7.0, this adjustment was only done when a drag operation started and ended, or when the adjustScaleTabSize method was called. Now as long as the resizeHandles field is set to TRUE (the default), the tab size is automatically recalculated whenever the view matrix changes (normally because the camera position or orientation changed).
If the dragger becomes too small in one dimension to contain all three tabs (two corner tabs plus the edge tab), the middle (edge) tab will not be drawn. If the dragger becomes very small (or flat) in one dimension, it may not be possible for the user to resize using the tabs. One solution for this is to provide a "reset dragger" button in the application.
When dragging the translator part, press the <Shift> key and you can constrain motion to either the local x axis or the y axis . The direction is determined by your initial mouse gesture after pressing the key. Releasing the key removes the constraint.
When the translator part drags, the dragger updates its translation field. The various scaling parts cause changes to both the scaleFactor and translation field, since scaling about a point other than the center adds translation to the center of the dragger. If you set the field, the dragger will move accordingly. You can also connect fields of other nodes or engines from this one to make them follow the dragger's motion.
You can not change the shape used to draw the tabs. This part is kept privately and may not be changed; the coordinates for the tabs are edited during adjustScaleTabSize().
The SoTabPlaneDragger class does contain three other parts you can change: tabPlaneTranslator , tabPlaneScaleTabMaterial and tabPlaneScaleTabHints .
Each of these is set by default from a resource described in the Dragger Resources section of the online reference page for this class. You can change the parts in any instance of this dragger using setPart().
You can make your program use different default resources for the parts by copying the file $OIVHOME/data/draggerDefaults/tabPlaneDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.
See SoDragger for more information about using and customizing draggers, including code examples, using draggers in an immersive VR environment and using WYSIWYG draggers.
| boundingBoxCaching | AUTO |
| renderCulling | AUTO |
| pickCulling | AUTO |
| isActive | FALSE |
| resizeHandles | TRUE |
| translation | 0 0 0 |
| scaleFactor | 1 1 1 |
| scaleUniform | FALSE |
| twoSidedLighting | FALSE |
| lineWidth | 1 |
| tabPixelSize | 8 |
| callbackList | NULL |
| translator | <tabPlaneTranslator resource> |
| scaleTabMaterial | <tabPlaneScaleTabMaterial resource> |
| scaleTabHints | <tabPlaneScaleTabHints resource> |
| Resource: | tabPlaneTranslator |
| Part: | translator |
| Appearance: | Outline of a Square. The region within it is pickable |
| Description: | Begins translation within the plane
|
| Resource: | tabPlaneScaleTabMaterial |
| Part: | scaleTabMaterial |
| Appearance: | Green - half diffuse, half emissive. |
| Description: | Used as material for scaling tabs.
|
| Resource: | tabPlaneScaleTabHints |
| Part: | scaleTabHints |
| Appearance: | shapeHints node:COUNTERCLOCKWISE/SOLID/CONVEX |
| Description: | Property for the tab nodes.
|
| Part Name | Part Type | Default Type | NULL Default |
| callbackList | NodeKitListPart | – | yes |
| translator | Separator | – | yes |
| scaleTabMaterial | Material | – | yes |
| scaleTabHints | ShapeHints | – | yes |
| translatorDrawStyle | DrawStyle | – | no |
| translatorMaterial | Material | – | no |
Extra Information for List Parts from Above Table
| Part Name | Container Type | Possible Types |
| callbackList | Separator | Callback, EventCallback |
SoInteractionKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger
Definition at line 219 of file SoTabPlaneDragger.h.
| SoTabPlaneDragger::SoTabPlaneDragger | ( | ) |
Constructor.
| void SoTabPlaneDragger::adjustScaleTabSize | ( | ) |
Causes the scale tab sizes to be adjusted so that they remain a near constant screen space size.
This happens automatically upon dragger finish. Call this to manually adjust the scale tab sizes at other times, for instance after the camera has changed in a viewer finish callback . Note that (since version 7.0) handles are automatically resized when the camera changes, as long as the resizeHandles field is set to TRUE.
|
static |
Returns the SoNodekitCatalog for this class.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the SoNodekitCatalog for this instance.
Reimplemented from SoDragger.
Reimplemented in SoEllipsoidDragger.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoDragger.
Reimplemented in SoEllipsoidDragger.
| void SoTabPlaneDragger::showCornerScales | ( | const SbBool | show | ) |
show or hide corners
| void SoTabPlaneDragger::showEdgeScales | ( | const SbBool | show | ) |
show or hide edges
| SoSFFloat SoTabPlaneDragger::lineWidth |
Specifies the line width for the outline box.
Default is 1.0
NOTE: field available since Open Inventor 7.1
Definition at line 347 of file SoTabPlaneDragger.h.
| SoSFBool SoTabPlaneDragger::resizeHandles |
If set to TRUE, handles will be resized automatically when the view matrix (camera) changes.
Default is TRUE.
NOTE: field available since Open Inventor 7.0
Definition at line 326 of file SoTabPlaneDragger.h.
| SoSFVec3f SoTabPlaneDragger::scaleFactor |
Scale factor affecting the dragger.
Default is (1,1,1).
Definition at line 318 of file SoTabPlaneDragger.h.
| SoSFBool SoTabPlaneDragger::scaleUniform |
If set to TRUE, scaling will always be uniform.
Default is FALSE.
NOTE: field available since Open Inventor 7.1
Definition at line 333 of file SoTabPlaneDragger.h.
| SoSFInt32 SoTabPlaneDragger::tabPixelSize |
Specifies the size of the green tabs in pixels.
Default is 8
NOTE: field available since Open Inventor 9.2
Definition at line 354 of file SoTabPlaneDragger.h.
| SoSFVec3f SoTabPlaneDragger::translation |
| SoSFBool SoTabPlaneDragger::twoSidedLighting |
If set to TRUE, OpenGL two sided lighting will be enabled.
Default is FALSE.
NOTE: field available since Open Inventor 7.1
Definition at line 340 of file SoTabPlaneDragger.h.
1.9.8 