Open Inventor Reference
SoTabPlaneDragger Class Reference

Object you can translate or scale within a plane by dragging with the mouse. More...

#include <Inventor/draggers/SoTabPlaneDragger.h>

Inheritance diagram for SoTabPlaneDragger:
SoDragger SoInteractionKit SoBaseKit SoNode SoFieldContainer SoBase

Public Member Functions

 SoTabPlaneDragger ()
 Constructor. More...
 
void adjustScaleTabSize ()
 Cause the scale tab sizes to be re-adjusted so that they remain a near constant screen space size. More...
 
- Public Member Functions inherited from SoDragger
void addStartCallback (SoDraggerCB *f, void *userData=NULL)
 Start callbacks are made after the mouse button 1 goes down and the dragger determines that it has been picked. More...
 
void removeStartCallback (SoDraggerCB *f, void *userData=NULL)
 
void addMotionCallback (SoDraggerCB *f, void *userData=NULL)
 Motion callbacks are called after each movement of the mouse during dragging. More...
 
void removeMotionCallback (SoDraggerCB *f, void *userData=NULL)
 Motion callbacks are called after each movement of the mouse during dragging. More...
 
void addFinishCallback (SoDraggerCB *f, void *userData=NULL)
 Finish callbacks are made after dragging ends and the dragger has stopped grabbing events. More...
 
void removeFinishCallback (SoDraggerCB *f, void *userData=NULL)
 Finish callbacks are made after dragging ends and the dragger has stopped grabbing events. More...
 
void addValueChangedCallback (SoDraggerCB *f, void *userData=NULL)
 Value-changed callbacks are made after a dragger changes any of its fields. More...
 
void removeValueChangedCallback (SoDraggerCB *f, void *userData=NULL)
 
void setMinGesture (int pixels)
 Set and get the number of pixels of movement required to initiate a constraint gesture. More...
 
int getMinGesture () const
 Set and get the number of pixels of movement required to initiate a constraint gesture. More...
 
bool enableValueChangedCallbacks (bool newVal)
 You can temporarily disable a dragger's valueChangedCallbacks. More...
 
const SbMatrixgetMotionMatrix ()
 Get the motion matrix. More...
 
void addOtherEventCallback (SoDraggerCB *f, void *userData=NULL)
 In addition to the public callback functions, these callback functions can also be used by subclasses to find out when things have happened. More...
 
void removeOtherEventCallback (SoDraggerCB *f, void *userData=NULL)
 
void registerChildDragger (SoDragger *child)
 Compound draggers should call this for each child dragger so that user callbacks (valueChanged, start, motion, finish, other event) registered with the parent dragger will be invoked based on the child dragger. More...
 
void unregisterChildDragger (SoDragger *child)
 
void registerChildDraggerMovingIndependently (SoDragger *child)
 These two routines tie the child to the parent, but WITHOUT the transferMotion callback. More...
 
void unregisterChildDraggerMovingIndependently (SoDragger *child)
 
SbMatrix getLocalToWorldMatrix ()
 Get the matrix which converts from one dragger space to another. More...
 
SbMatrix getWorldToLocalMatrix ()
 
SbVec3f getLocalStartingPoint ()
 Returns the starting point in local coordinates. More...
 
SbVec3f getWorldStartingPoint ()
 Returns the starting point in world coordinates. More...
 
void getPartToLocalMatrix (const SbName &partName, SbMatrix &partToLocalMatrix, SbMatrix &localToPartMatrix)
 Get the matrix which converts from the space of one part into local space. More...
 
void transformMatrixLocalToWorld (const SbMatrix &fromMatrix, SbMatrix &toMatrix)
 Transforms a given matrix from one space into another space. More...
 
void transformMatrixWorldToLocal (const SbMatrix &fromMatrix, SbMatrix &toMatrix)
 
void transformMatrixToLocalSpace (const SbMatrix &fromMatrix, SbMatrix &toMatrix, const SbName &fromSpacePartName)
 
void setMotionMatrix (const SbMatrix &newMatrix)
 Set the motion matrix. More...
 
void valueChanged ()
 Invokes the valueChangedCallbacks. More...
 
const SbMatrixgetStartMotionMatrix ()
 Used to calculate motion relative to the dragger's position at the beginning of the dragging. More...
 
virtual void saveStartParameters ()
 By default, saves the motionMatrix as the startMotionMatrix. More...
 
const SoPathgetPickPath () const
 Information that's good to have during a valueChanged callback. More...
 
const SoEventgetEvent () const
 
SoPathcreatePathToThis ()
 Creates a new path leading to this dragger, if the last path given by setTempPathToThis() is still valid. More...
 
const SoPathgetSurrogatePartPickedOwner () const
 Surrogate Pick Information. More...
 
const SbNamegetSurrogatePartPickedName () const
 Name:
Name of the surrogate part within the owners list. More...
 
const SoPathgetSurrogatePartPickedPath () const
 SurrogatePath: The owner's surrogate path for this name. More...
 
void setStartingPoint (const SoPickedPoint *newPoint)
 Set the point where the drag begins. More...
 
void setStartingPoint (const SbVec3f &newPoint)
 The SbVec3f version would usually be a point saved from the end of another gesture. More...
 
const SbViewVolumegetViewVolume ()
 Information about the window an event occurred in. More...
 
void setViewVolume (const SbViewVolume &vol)
 
const SbViewportRegiongetViewportRegion ()
 
void setViewportRegion (const SbViewportRegion &reg)
 
SoHandleEventActiongetHandleEventAction () const
 Get the most recent handleEventAction. More...
 
void setHandleEventAction (SoHandleEventAction *newAction)
 
void setTempPathToThis (const SoPath *somethingClose)
 A path leading to 'this. More...
 
virtual void grabEventsSetup ()
 Called when the dragger gains or loses status as "grabber" of events. More...
 
virtual void grabEventsCleanup ()
 
void workFieldsIntoTransform (SbMatrix &mtx)
 Changes only that part of the matrix for which this dragger has fields. More...
 
void setFrontOnProjector (ProjectorFrontSetting newVal)
 
ProjectorFrontSetting getFrontOnProjector () const
 
- Public Member Functions inherited from SoInteractionKit
virtual bool setPartAsPath (const SbName &partName, SoPath *surrogatePath)
 Sets any public part in the interaction kit as a "surrogate" path instead. More...
 
virtual bool affectsState () const
 Override the default behavior of SoNode. More...
 
virtual bool setPartAsDefault (const SbName &partName, SoNode *newNode, bool onlyIfAlready=TRUE)
 Sets the part, then sets the field for that part to default using partField.setDefault(TRUE). More...
 
virtual bool setPartAsDefault (const SbName &partName, const SbName &newNodeName, bool onlyIfAlready=TRUE)
 
bool isPathSurrogateInMySubgraph (const SoPath *pathToCheck)
 Is the 'inPath' valid as a surrogate path anywhere in this node's subgraph? Examines the surrogate paths of all InteractionKits from this node down. More...
 
bool isPathSurrogateInMySubgraph (const SoPath *pathToCheck, SoPath *&pathToOwner, SbName &surrogateNameInOwner, SoPath *&surrogatePathInOwner, bool fillArgs=TRUE)
 
- Public Member Functions inherited from SoBaseKit
virtual const SoNodekitCataloggetNodekitCatalog () const
 Returns the SoNodekitCatalog for this instance of SoBaseKit. More...
 
 SoBaseKit ()
 Constructor. More...
 
virtual SoNodegetPart (const SbName &partName, bool makeIfNeeded)
 Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. More...
 
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. More...
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partName, bool makeIfNeeded, const SoPath *pathToExtend=NULL)
 Returns a path that begins at this nodekit and ends at partName. More...
 
virtual bool setPart (const SbName &partName, SoNode *from)
 Inserts the given node (not a copy) as the new part specified by partName. More...
 
bool set (char *nameValuePairListString)
 SETTING FIELDS OF PARTS. More...
 
bool set (char *partNameString, char *parameterString)
 
virtual void doAction (SoAction *action)
 This method performs the "typical" operation of a node for any action. More...
 
virtual void callback (SoCallbackAction *action)
 These functions implement all actions for nodekits. More...
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void search (SoSearchAction *action)
 
virtual void write (SoWriteAction *action)
 
virtual SoChildListgetChildren () const
 Returns pointer to children. More...
 
void printDiagram ()
 
void printSubDiagram (const SbName &rootName, int level)
 
void printTable ()
 
virtual void addWriteReference (SoOutput *out, bool isFromField=FALSE)
 Overrides the default method to use countMyFields() instead of the regular SoFieldData writing mechanism. More...
 
bool forceChildDrivenWriteRefs (SoOutput *out)
 This returns TRUE if the nodekit intends to write out. More...
 
- Public Member Functions inherited from SoNode
void setOverride (bool state)
 Turns override flag on or off. More...
 
bool isOverride () const
 Returns the state of the override flag. More...
 
SoNodecopy (bool copyConnections=FALSE) const
 Creates and returns an exact copy of the node. More...
 
virtual void pick (SoPickAction *action)
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes. More...
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void startNotify ()
 Initiates notification from an instance. More...
 
virtual void notify (SoNotList *list)
 Propagates modification notification through an instance. More...
 
SbNodeIdType getNodeId () const
 Returns the unique id for a node. More...
 
virtual void writeInstance (SoOutput *out)
 Writes instance to SoOutput. (Used for either stage of writing.) More...
 
virtual SoFieldContainercopyThroughConnection () const
 Copies an instance that is encountered through a field connection. More...
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values. More...
 
bool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values. More...
 
bool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields. More...
 
void copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields. More...
 
bool 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 Inventor file format. More...
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
 
virtual int getFields (SoFieldList &list) const
 Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. More...
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a pointer to the field with the given name. More...
 
bool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument. More...
 
bool enableNotify (bool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). More...
 
bool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed. More...
 
bool set (const char *fieldDataString, SoInput *dictIn)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. More...
 
void get (SbString &fieldDataString, SoOutput *dictOut)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
 
bool getIsBuiltIn () const
 Returns whether or not instance is considered 'built-in' to the library. More...
 
virtual const SoFieldDatagetFieldData () const
 Returns an SoFieldData structure for the node. More...
 
void addManagedSensor (SoSensor *sensor)
 Adds a sensor which is managed by the field container. More...
 
- Public Member Functions inherited from SoBase
void ref () const
 Adds and removes a reference to an instance. More...
 
void unref () const
 
void unrefNoDelete () const
 
void touch ()
 Marks an instance as modified, simulating a change to it. More...
 
virtual SoType getTypeId () const =0
 Returns the type identifier for a specific instance. More...
 
bool isOfType (SoType type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type. More...
 
virtual SbName getName () const
 Returns the name of an instance. More...
 
virtual void setName (const SbName &name)
 Sets the name of an instance. More...
 
void addAuditor (void *auditor, SoNotRec::Type type)
 Adds/removes an auditor to/from list. More...
 
void removeAuditor (void *auditor, SoNotRec::Type type)
 
const SoAuditorListgetAuditors ()
 Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...
 
int getRefCount () const
 Returns current reference count. More...
 
bool shouldWrite ()
 Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...
 

Static Public Member Functions

static void initClass ()
 initialize the class More...
 
- Static Public Member Functions inherited from SoDragger
static void setMinScale (float newMinScale)
 The smallest scale that any dragger will write. More...
 
static float getMinScale ()
 Get min scale. More...
 
static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationPtr, const SbRotation *rotationPtr, const SbVec3f *scaleFactorPtr, const SbRotation *scaleOrientationPtr, const SbVec3f *centerPtr)
 Same as above, but values are given explicitly as pointers. More...
 
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scaleFactor, SbRotation &scaleOrientation, const SbVec3f &center)
 Faster versions of getTransform() and factor() that take advantage of the case where there is no scaleOrientation. More...
 
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scaleFactor, SbRotation &scaleOrientation)
 
static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
 Appends the given motion to the end of 'mtx'. More...
 
static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scaleCenter, const SbMatrix *conversion=NULL)
 
static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotCenter, const SbMatrix *conversion=NULL)
 
static void initClass ()
 
static void initClasses ()
 Initialize ALL Inventor detail classes. More...
 
- Static Public Member Functions inherited from SoInteractionKit
static void setSwitchValue (SoNode *n, int newVal)
 
static void initClass ()
 initialize the class More...
 
- Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for the class SoBaseKit. More...
 
static bool isSearchingChildren ()
 Sets and queries if nodekit children are searched during SoSearchAction traversal. More...
 
static void setSearchingChildren (bool newVal)
 Sets and queries if nodekit children are searched during SoSearchAction traversal. More...
 
static void initClass ()
 
static SoNodetypeCheck (const SbName &partName, const SoType &partType, SoNode *node)
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns type identifier for the SoNode class. More...
 
static SoNodegetByName (const SbName &name)
 Returns the last node given the specified name. More...
 
static int getByName (const SbName &name, SoNodeList &list)
 Returns the number of nodes with the given name, and adds to list pointers to those nodes. More...
 
static void initClass ()
 Initializes base node class. More...
 
static void initClasses ()
 Initialize ALL Inventor node classes. More...
 
static SbNodeIdType getNextNodeId ()
 Returns the next available unique id. More...
 
static int getActionMethodIndex (SoType t)
 Returns the index of this node in the action/method table, given its type. More...
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class. More...
 
static void initClass ()
 Setup type information. More...
 
static void initCopyDict ()
 During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used. More...
 
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 Adds an instance to the dictionary. More...
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 If a copy of the given instance is in the dictionary, this returns it. More...
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, bool copyConnections)
 If a copy of the given instance is not in the dictionary, this returns NULL. More...
 
static void copyDone ()
 Cleans up the dictionary when done. More...
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class. More...
 
static void initClass ()
 Setup type information. More...
 
static void incrementCurrentWriteCounter ()
 Increments the current write counter at the start of a write operation. More...
 
static void decrementCurrentWriteCounter ()
 Decrements the current write counter after a write operation, in some rare cases. More...
 
static void addName (SoBase *, const char *)
 Internal methods used to maintain the global name dictionary. More...
 
static void removeName (SoBase *, const char *)
 
static SoBasegetNamedBase (const SbName &, SoType)
 Helper routines used to get stuff out of nameDict. More...
 
static int getNamedBases (const SbName &, SoBaseList &, SoType)
 
static bool read (SoInput *in, SoBase *&base, SoType expectedType)
 Reads one instance of some subclass of SoBase. More...
 
static void setInstancePrefix (const SbString &c)
 This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...
 

Public Attributes

SoSFVec3f translation
 
SoSFVec3f scaleFactor
 
- Public Attributes inherited from SoDragger
SoSFBool enable
 This field is a boolean that enables / disables interaction. More...
 
SoSFBool isActive
 This field is a boolean that is TRUE when the mouse is down and we are dragging, FALSE otherwise. More...
 
- Public Attributes inherited from SoInteractionKit
SoSFEnum renderCaching
 Set render caching mode. Default is AUTO. More...
 
SoSFEnum boundingBoxCaching
 Set bounding box caching mode. More...
 
SoSFEnum renderCulling
 Set render culling mode. More...
 
SoSFEnum pickCulling
 Set pick caching mode. Default is AUTO. More...
 

Protected Types

enum  State {
  INACTIVE , TRANSLATING , EDGE_SCALING , CORNER_SCALING ,
  UNIFORM_SCALING
}
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
 This set of enums is used when reading and writing the base. More...
 

Protected Member Functions

virtual void GLRender (SoGLRenderAction *action)
 These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing. More...
 
void dragStart ()
 
void drag ()
 
void dragFinish ()
 
void translateStart ()
 
void translateDrag ()
 
void edgeScaleStart ()
 
void edgeScaleDrag ()
 
void cornerScaleStart ()
 
void cornerScaleDrag ()
 
void scaleUniformStart ()
 
void scaleUniformDrag ()
 
void reallyAdjustScaleTabSize (SoGLRenderAction *action)
 
void getXYScreenLengths (SbVec2f &lengths, const SbMatrix &localToScreen, const SbVec2s &winSize)
 
virtual bool setUpConnections (bool onOff, bool doItAlways=FALSE)
 detach/attach any sensors, callbacks, and/or field connections. More...
 
virtual void setDefaultOnNonWritingFields ()
 Called by the SoBaseKit::write() method. More...
 
virtual ~SoTabPlaneDragger ()
 
- Protected Member Functions inherited from SoDragger
 SoDragger ()
 Constructor. More...
 
SbVec2f getNormalizedLocaterPosition ()
 Get the last known position of the locator (mouse). More...
 
SbVec2s getLocaterPosition ()
 
SbVec2s getStartLocaterPosition () const
 Get the position of the locater when dragging started. More...
 
void setStartLocaterPosition (SbVec2s p)
 The start locater position is automatically set when button 1 goes down over the dragger. More...
 
bool isAdequateConstraintMotion ()
 Has the locater moved far enough from where it started to choose a constraint gesture. More...
 
virtual bool shouldGrabBasedOnSurrogate (const SoPath *pickPath, const SoPath *surrogatePath)
 Given a pickPath and a surrogatePath, decides whether it should grab based on the surrogate. More...
 
void setCameraInfo (SoAction *action)
 The dragger looks in this action to get information about the camera and the viewport. More...
 
virtual void handleEvent (SoHandleEventAction *ha)
 This is called during traversal by a HandleEventAction. More...
 
virtual bool mouseButtonPressed (const SoEvent *ev)
 This is called during handleEvent. More...
 
virtual bool mouseButtonReleased (const SoEvent *ev)
 This is called during handleEvent. More...
 
void transferMotion (SoDragger *child)
 This should be called by every child dragger of a compound dragger as a result of compoundDragger->registerChildDragger( childDragger ); Called on the compoundDragger when childDragger's value changes. More...
 
void setIgnoreInBbox (bool newVal)
 Set/get whether the dragger should be ignored during bounding box calculations. More...
 
bool isIgnoreInBbox ()
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 Implements getBoundingBox action. More...
 
void setActiveChildDragger (SoDragger *newChildDragger)
 Called by the above child callbacks. More...
 
SoDraggergetActiveChildDragger () const
 
virtual ~SoDragger ()
 
- Protected Member Functions inherited from SoInteractionKit
 SoInteractionKit ()
 
 ~SoInteractionKit ()
 
virtual void copyContents (const SoFieldContainer *fromFC, bool copyConnections)
 Copies the contents of the given instance into this instance This copies the surrogatePartPathList and the surrogatePartNameList. More...
 
virtual SoNodegetAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE)
 These are overloaded to set the surrogate path to NULL after completing their work. More...
 
virtual SoNodeKitPathcreatePathToAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE, const SoPath *pathToExtend=NULL)
 
virtual bool setAnyPart (const SbName &partName, SoNode *from, bool anyPart=TRUE)
 
virtual bool setAnyPartAsPath (const SbName &partName, SoPath *surrogatePath, bool leafCheck=FALSE, bool publicCheck=FALSE)
 This allows you to set any part in the nodekit as a surrogate path. More...
 
virtual bool readInstance (SoInput *in, unsigned short flags)
 Reads in from file. More...
 
virtual bool setAnyPartAsDefault (const SbName &partName, SoNode *newNode, bool anyPart=TRUE, bool onlyIfAlready=TRUE)
 Protected versions of these methods that allow you to set non-leaf and/or private parts. More...
 
virtual bool setAnyPartAsDefault (const SbName &partName, const SbName &newNodeName, bool anyPart=TRUE, bool onlyIfAlready=TRUE)
 
bool setAnySurrogatePath (const SbName &inName, SoPath *inPath, bool leafCheck=FALSE, bool publicCheck=FALSE)
 
void connectSeparatorFields (SoSeparator *dest, bool onOff)
 
- Protected Member Functions inherited from SoBaseKit
 SO_KIT_CATALOG_ENTRY_HEADER (callbackList)
 Define fields for the new parts of the kit... More...
 
virtual SoNodeaddToCopyDict () const
 Redefines this to add this node and all part nodes to the dictionary. More...
 
SoGroupgetContainerNode (const SbName &listName, bool makeIfNeeded=TRUE)
 Returns the containerNode within the SoNodeKitListPart given by listName. More...
 
void createNodekitPartsList ()
 called during construction to create parts list More...
 
virtual void createDefaultParts ()
 called during construction to create any parts that are created by default (such as the cube in the SoCubeKit) More...
 
const SoNodekitPartsgetNodekitPartsList () const
 Return the node's partsList. More...
 
void catalogError ()
 Prints an Error when there's trouble building a catalog. More...
 
void countMyFields (SoOutput *out)
 This is called during addWriteReference() to write the fields. More...
 
virtual ~SoBaseKit ()
 
- Protected Member Functions inherited from SoNode
 SoNode ()
 Constructor, destructor. More...
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer ()
 
 ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase ()
 Constructor is protected - this is an abstract class. More...
 
virtual ~SoBase ()
 Virtual destructor so that subclasses are deleted properly. More...
 
virtual void destroy ()
 Actually deletes an instance. More...
 
bool hasMultipleWriteRefs () const
 Returns TRUE if the instance has multiple write references. More...
 
bool writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
 Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName () const
 Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned) More...
 

Static Protected Member Functions

static void startCB (void *, SoDragger *)
 
static void motionCB (void *, SoDragger *)
 
static void finishCB (void *, SoDragger *)
 
static void metaKeyChangeCB (void *, SoDragger *)
 
static void fieldSensorCB (void *, SoSensor *)
 
static void valueChangedCB (void *, SoDragger *)
 
- Static Protected Member Functions inherited from SoDragger
static void childTransferMotionAndValueChangedCB (void *, SoDragger *)
 Stubs used by compound draggers to get user callbacks from the child dragger. More...
 
static void childValueChangedCB (void *, SoDragger *)
 
static void childStartCB (void *, SoDragger *)
 
static void childMotionCB (void *, SoDragger *)
 
static void childFinishCB (void *, SoDragger *)
 
static void childOtherEventCB (void *, SoDragger *)
 
- Static Protected Member Functions inherited from SoInteractionKit
static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)
 read from buffer More...
 
static void fieldSensorCB (void *, SoSensor *)
 
- Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog ** getClassNodekitCatalogPtr ()
 ...end of contents of SO_KIT_HEADER More...
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr ()
 This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. More...
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter ()
 Returns current write counter. More...
 

Protected Attributes

SbLineProjectorlineProj
 
SbPlaneProjectorplaneProj
 
SoFieldSensortranslFieldSensor
 
SoFieldSensorscaleFieldSensor
 
SbVec3f worldRestartPt
 
int currentScalePatch
 
bool shftDown
 
State currentState
 
State restartState
 
int translateDir
 
SbVec3f scaleCenter
 
bool needScaleTabAdjustment
 
- Protected Attributes inherited from SoInteractionKit
SoFieldSensorfieldSensor
 This sensor will watch the topSeparator part. More...
 
SoSeparatoroldTopSep
 
- Protected Attributes inherited from SoBaseKit
SoChildListchildren
 
SoNodekitPartsnodekitPartsList
 parts list. More...
 
bool connectionsSetUp
 
- Protected Attributes inherited from SoNode
SbNodeIdType uniqueId
 Unique id for this node. More...
 
- Protected Attributes inherited from SoFieldContainer
bool isBuiltIn
 Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. More...
 

Additional Inherited Members

- Public Types inherited from SoDragger
enum  ProjectorFrontSetting { FRONT , BACK , USE_PICK }
 These control behavior of the rotational parts. More...
 
- Public Types inherited from SoInteractionKit
enum  CacheEnabled { OFF , ON , AUTO }
 Possible values for caching. More...
 
- Public Types inherited from SoNode
enum  Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
 
- Static Public Attributes inherited from SoBase
static bool traceRefs
 Turns on/off reference count tracing (for debugging) More...
 
- Static Protected Attributes inherited from SoNode
static SbNodeIdType nextUniqueId
 Next available unique id. More...
 
static int nextActionMethodIndex
 Next index into the action method table. More...
 

Detailed Description

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. Dragging an edge tab performs 1D scaling about the opposite edge. The rest of the dragger is invisible but pickable; selecting it initiates translation within the plane.

The dragger tries to keep the small tabs a constant size in screen space. Every time a drag begins or ends, the size is recalculated based on the viewing and modeling matrix.

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 /usr/share/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.

File Format/Default
TabPlaneDragger {
}
#define FALSE
Definition: SbBasic.h:79
SoSFBool isActive
This field is a boolean that is TRUE when the mouse is down and we are dragging, FALSE otherwise.
Definition: SoDragger.h:238
SoSFEnum renderCaching
Set render caching mode. Default is AUTO.
@ AUTO
Decide based on some heuristic.
SoSFEnum boundingBoxCaching
Set bounding box caching mode.
SoSFEnum renderCulling
Set render culling mode.
SoSFEnum pickCulling
Set pick caching mode. Default is AUTO.
See Also
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 172 of file SoTabPlaneDragger.h.

Member Enumeration Documentation

◆ State

enum SoTabPlaneDragger::State
protected
Enumerator
INACTIVE 
TRANSLATING 
EDGE_SCALING 
CORNER_SCALING 
UNIFORM_SCALING 

Definition at line 250 of file SoTabPlaneDragger.h.

Constructor & Destructor Documentation

◆ SoTabPlaneDragger()

SoTabPlaneDragger::SoTabPlaneDragger ( )

◆ ~SoTabPlaneDragger()

virtual SoTabPlaneDragger::~SoTabPlaneDragger ( )
protectedvirtual

Member Function Documentation

◆ adjustScaleTabSize()

void SoTabPlaneDragger::adjustScaleTabSize ( )

This happens automatically upon dragger finish. Call this to adjust the scale tab sizes at other times, for instance after the camera has changed in a viewer finish callback.

◆ cornerScaleDrag()

void SoTabPlaneDragger::cornerScaleDrag ( )
protected

◆ cornerScaleStart()

void SoTabPlaneDragger::cornerScaleStart ( )
protected

◆ drag()

void SoTabPlaneDragger::drag ( )
protected

◆ dragFinish()

void SoTabPlaneDragger::dragFinish ( )
protected

◆ dragStart()

void SoTabPlaneDragger::dragStart ( )
protected

◆ edgeScaleDrag()

void SoTabPlaneDragger::edgeScaleDrag ( )
protected

◆ edgeScaleStart()

void SoTabPlaneDragger::edgeScaleStart ( )
protected

◆ fieldSensorCB()

static void SoTabPlaneDragger::fieldSensorCB ( void *  ,
SoSensor  
)
staticprotected

◆ finishCB()

static void SoTabPlaneDragger::finishCB ( void *  ,
SoDragger  
)
staticprotected

◆ getXYScreenLengths()

void SoTabPlaneDragger::getXYScreenLengths ( SbVec2f lengths,
const SbMatrix localToScreen,
const SbVec2s winSize 
)
protected

◆ GLRender()

virtual void SoTabPlaneDragger::GLRender ( SoGLRenderAction action)
protectedvirtual

Reimplemented from SoBaseKit.

◆ initClass()

static void SoTabPlaneDragger::initClass ( )
static

◆ metaKeyChangeCB()

static void SoTabPlaneDragger::metaKeyChangeCB ( void *  ,
SoDragger  
)
staticprotected

◆ motionCB()

static void SoTabPlaneDragger::motionCB ( void *  ,
SoDragger  
)
staticprotected

◆ reallyAdjustScaleTabSize()

void SoTabPlaneDragger::reallyAdjustScaleTabSize ( SoGLRenderAction action)
protected

◆ scaleUniformDrag()

void SoTabPlaneDragger::scaleUniformDrag ( )
protected

◆ scaleUniformStart()

void SoTabPlaneDragger::scaleUniformStart ( )
protected

◆ setDefaultOnNonWritingFields()

virtual void SoTabPlaneDragger::setDefaultOnNonWritingFields ( )
protectedvirtual

Draggers don't want to write out fields if they have default vals.

sets isActive to default if default and not connected.

Looks for fields named: 'rotation' with value SbRotation::identity() 'translation' with value (0,0,0) 'center' with value (0,0,0) 'scaleFactor' with value (1,1,1) and sets them to default if they are not connected from a field. (most draggers are missing at least some of these, but thats okay)

Then calls the method for SoInteractionKit.

NOTE: Parts which are set to default may still wind up writing to file if, for example, they lie on a path.

Reimplemented from SoDragger.

◆ setUpConnections()

virtual bool SoTabPlaneDragger::setUpConnections ( bool  onOff,
bool  doItAlways = FALSE 
)
protectedvirtual

Called by: start/end of SoBaseKit::readInstance and on new copy by: start/end of SoBaseKit::copy. Classes that redefine must call setUpConnections(TRUE,TRUE) at end of constructor. Returns the state of the node when this was called.

Reimplemented from SoInteractionKit.

◆ startCB()

static void SoTabPlaneDragger::startCB ( void *  ,
SoDragger  
)
staticprotected

◆ translateDrag()

void SoTabPlaneDragger::translateDrag ( )
protected

◆ translateStart()

void SoTabPlaneDragger::translateStart ( )
protected

◆ valueChangedCB()

static void SoTabPlaneDragger::valueChangedCB ( void *  ,
SoDragger  
)
staticprotected

Member Data Documentation

◆ currentScalePatch

int SoTabPlaneDragger::currentScalePatch
protected

Definition at line 248 of file SoTabPlaneDragger.h.

◆ currentState

State SoTabPlaneDragger::currentState
protected

Definition at line 255 of file SoTabPlaneDragger.h.

◆ lineProj

SbLineProjector* SoTabPlaneDragger::lineProj
protected

Definition at line 221 of file SoTabPlaneDragger.h.

◆ needScaleTabAdjustment

bool SoTabPlaneDragger::needScaleTabAdjustment
protected

Definition at line 261 of file SoTabPlaneDragger.h.

◆ planeProj

SbPlaneProjector* SoTabPlaneDragger::planeProj
protected

Definition at line 222 of file SoTabPlaneDragger.h.

◆ restartState

State SoTabPlaneDragger::restartState
protected

Definition at line 256 of file SoTabPlaneDragger.h.

◆ scaleCenter

SbVec3f SoTabPlaneDragger::scaleCenter
protected

Definition at line 259 of file SoTabPlaneDragger.h.

◆ scaleFactor

SoSFVec3f SoTabPlaneDragger::scaleFactor

Definition at line 202 of file SoTabPlaneDragger.h.

◆ scaleFieldSensor

SoFieldSensor* SoTabPlaneDragger::scaleFieldSensor
protected

Definition at line 225 of file SoTabPlaneDragger.h.

◆ shftDown

bool SoTabPlaneDragger::shftDown
protected

Definition at line 253 of file SoTabPlaneDragger.h.

◆ translateDir

int SoTabPlaneDragger::translateDir
protected

Definition at line 257 of file SoTabPlaneDragger.h.

◆ translation

SoSFVec3f SoTabPlaneDragger::translation

Definition at line 201 of file SoTabPlaneDragger.h.

◆ translFieldSensor

SoFieldSensor* SoTabPlaneDragger::translFieldSensor
protected

Definition at line 224 of file SoTabPlaneDragger.h.

◆ worldRestartPt

SbVec3f SoTabPlaneDragger::worldRestartPt
protected

Definition at line 247 of file SoTabPlaneDragger.h.


The documentation for this class was generated from the following file: