DART  6.10.1
dart::gui::osg::DragAndDrop Class Referenceabstract

DragAndDrop is a class that facilitates enabling various kinds of dart Entities to be dragged and dropped in an dart::gui::osg environment. More...

#include <DragAndDrop.hpp>

Inheritance diagram for dart::gui::osg::DragAndDrop:
dart::common::Subject dart::common::Observer dart::gui::osg::BodyNodeDnD dart::gui::osg::InteractiveFrameDnD dart::gui::osg::SimpleFrameDnD dart::gui::osg::InteractiveToolDnD dart::gui::osg::SimpleFrameShapeDnD

Public Types

enum class  RotationOption : int { HOLD_MODKEY = 0 , ALWAYS_ON , ALWAYS_OFF }
 

Public Member Functions

 DragAndDrop (Viewer *viewer, dart::dynamics::Entity *entity)
 Constructor. More...
 
virtual ~DragAndDrop ()
 Virtual destructor. More...
 
dart::dynamics::EntitygetEntity () const
 Get the Entity that this DragAndDrop is associated with. More...
 
virtual void update ()
 Called when mouse events are being handled. More...
 
void setObstructable (bool _obstructable)
 If true is passed in, this object will only be drag and droppable if there are no other objects between its picked point and the camera. More...
 
bool isObstructable () const
 If this is true, then this object will only be drag and droppable if there are no other objects between its picked point and the camera. More...
 
virtual void move ()=0
 Called to specify how the Entity should be moved. More...
 
virtual void saveState ()=0
 Called when a point gets picked, and is used to save the current state of the Entity. More...
 
virtual void release ()
 Called when the user lets go of the object that they are dragging and dropping. More...
 
virtual Eigen::Vector3d getConstrainedDx () const
 Default method for getting the translation requested by the user. More...
 
virtual Eigen::AngleAxisd getConstrainedRotation () const
 Default method for getting the rotation requested by the user. More...
 
void unconstrain ()
 Remove all constraints from the dragging and dropping. More...
 
void constrainToLine (const Eigen::Vector3d &slope)
 Constrain translation to only occur along the given slope, or constrain rotation to only occur about the given slope. More...
 
void constrainToPlane (const Eigen::Vector3d &normal)
 Constrain translation to only occur within the plane defined by the given normal, or constrain rotation to only occur about the given normal. More...
 
bool isMoving () const
 Returns the mAmMoving flag. More...
 
void setRotationOption (RotationOption option)
 Set the option for triggering rotations instead of translations. More...
 
RotationOption getRotationOption () const
 Get the current rotation option for this DnD. More...
 
void setRotationModKey (::osgGA::GUIEventAdapter::ModKeyMask rotationModKey)
 Set the modkey that will be used to toggle rotation for this DnD. More...
 
::osgGA::GUIEventAdapter::ModKeyMask getRotationModKey () const
 Get the modkey that will be used to toggle rotation for this DnD. More...
 

Protected Member Functions

void handleDestructionNotification (const dart::common::Subject *subscription) override
 Perform cleanup when the subject is destroyed. More...
 
void sendDestructionNotification () const
 Send a destruction notification to all Observers. More...
 
void addObserver (Observer *_observer) const
 Add an Observer to the list of Observers. More...
 
void removeObserver (Observer *_observer) const
 Remove an Observer from the list of Observers. More...
 
void receiveDestructionNotification (const Subject *_subject)
 Called whenever a Subject is destroyed (or sends out a destruction notification). More...
 
void addSubject (const Subject *_subject)
 Add a Subject for this Observer. More...
 
void removeSubject (const Subject *_subject)
 Remove a Subject from this Observer. More...
 
void removeAllSubjects ()
 Remove all Subjects from this Observer. More...
 

Protected Attributes

ViewermViewer
 Pointer to the DnD's Viewer. More...
 
dart::dynamics::EntitymEntity
 Pointer to the DnD's Entity. More...
 
Eigen::Vector3d mPickedPosition
 The location in the world that was picked by the user. More...
 
Eigen::Vector3d mVector
 Reference vector for constraint (slope for line constraint, or normal for plane constraint) More...
 
Eigen::Vector3d mPivot
 Point in space about which rotations should happen. More...
 
ConstraintType mConstraintType
 Constraint type for this DnD. More...
 
bool mAmObstructable
 Whether other objects can block this one from being picked. More...
 
bool mAmMoving
 Whether this DnD is currently moving. More...
 
RotationOption mRotationOption
 Option for rotation settings. More...
 
::osgGA::GUIEventAdapter::ModKeyMask mRotationModKey
 Modkey for rotation. More...
 
std::set< Observer * > mObservers
 List of current Observers. More...
 
std::set< const Subject * > mSubjects
 List of current Subjects for this Observer. More...
 

Detailed Description

DragAndDrop is a class that facilitates enabling various kinds of dart Entities to be dragged and dropped in an dart::gui::osg environment.

Member Enumeration Documentation

◆ RotationOption

Enumerator
HOLD_MODKEY 
ALWAYS_ON 
ALWAYS_OFF 

Constructor & Destructor Documentation

◆ DragAndDrop()

dart::gui::osg::DragAndDrop::DragAndDrop ( Viewer viewer,
dart::dynamics::Entity entity 
)

Constructor.

◆ ~DragAndDrop()

dart::gui::osg::DragAndDrop::~DragAndDrop ( )
virtual

Virtual destructor.

Member Function Documentation

◆ addObserver()

void dart::common::Subject::addObserver ( Observer _observer) const
protectedinherited

Add an Observer to the list of Observers.

◆ addSubject()

void dart::common::Observer::addSubject ( const Subject _subject)
protectedinherited

Add a Subject for this Observer.

◆ constrainToLine()

void dart::gui::osg::DragAndDrop::constrainToLine ( const Eigen::Vector3d &  slope)

Constrain translation to only occur along the given slope, or constrain rotation to only occur about the given slope.

For rotation, this function is equivalent to constrainToPlane

◆ constrainToPlane()

void dart::gui::osg::DragAndDrop::constrainToPlane ( const Eigen::Vector3d &  normal)

Constrain translation to only occur within the plane defined by the given normal, or constrain rotation to only occur about the given normal.

For rotation, this function is equivalent to constrainToLine

◆ getConstrainedDx()

Eigen::Vector3d dart::gui::osg::DragAndDrop::getConstrainedDx ( ) const
virtual

Default method for getting the translation requested by the user.

◆ getConstrainedRotation()

Eigen::AngleAxisd dart::gui::osg::DragAndDrop::getConstrainedRotation ( ) const
virtual

Default method for getting the rotation requested by the user.

◆ getEntity()

dart::dynamics::Entity * dart::gui::osg::DragAndDrop::getEntity ( ) const

Get the Entity that this DragAndDrop is associated with.

◆ getRotationModKey()

osgGA::GUIEventAdapter::ModKeyMask dart::gui::osg::DragAndDrop::getRotationModKey ( ) const

Get the modkey that will be used to toggle rotation for this DnD.

◆ getRotationOption()

DragAndDrop::RotationOption dart::gui::osg::DragAndDrop::getRotationOption ( ) const

Get the current rotation option for this DnD.

◆ handleDestructionNotification()

void dart::gui::osg::DragAndDrop::handleDestructionNotification ( const dart::common::Subject subscription)
overrideprotectedvirtual

Perform cleanup when the subject is destroyed.

Reimplemented from dart::common::Observer.

Reimplemented in dart::gui::osg::SimpleFrameShapeDnD.

◆ isMoving()

bool dart::gui::osg::DragAndDrop::isMoving ( ) const

Returns the mAmMoving flag.

◆ isObstructable()

bool dart::gui::osg::DragAndDrop::isObstructable ( ) const

If this is true, then this object will only be drag and droppable if there are no other objects between its picked point and the camera.

Default is true.

◆ move()

virtual void dart::gui::osg::DragAndDrop::move ( )
pure virtual

Called to specify how the Entity should be moved.

Implemented in dart::gui::osg::BodyNodeDnD, dart::gui::osg::InteractiveFrameDnD, and dart::gui::osg::SimpleFrameDnD.

◆ receiveDestructionNotification()

void dart::common::Observer::receiveDestructionNotification ( const Subject _subject)
protectedinherited

Called whenever a Subject is destroyed (or sends out a destruction notification).

Override handleDestructionNotification() in order to customize your class's response to destruction notifications.

◆ release()

void dart::gui::osg::DragAndDrop::release ( )
virtual

Called when the user lets go of the object that they are dragging and dropping.

This function does nothing by default, but you can override it.

Reimplemented in dart::gui::osg::BodyNodeDnD.

◆ removeAllSubjects()

void dart::common::Observer::removeAllSubjects ( )
protectedinherited

Remove all Subjects from this Observer.

◆ removeObserver()

void dart::common::Subject::removeObserver ( Observer _observer) const
protectedinherited

Remove an Observer from the list of Observers.

◆ removeSubject()

void dart::common::Observer::removeSubject ( const Subject _subject)
protectedinherited

Remove a Subject from this Observer.

◆ saveState()

virtual void dart::gui::osg::DragAndDrop::saveState ( )
pure virtual

Called when a point gets picked, and is used to save the current state of the Entity.

Implemented in dart::gui::osg::BodyNodeDnD, dart::gui::osg::InteractiveFrameDnD, and dart::gui::osg::SimpleFrameDnD.

◆ sendDestructionNotification()

void dart::common::Subject::sendDestructionNotification ( ) const
protectedinherited

Send a destruction notification to all Observers.

This will cause all Observers to behave as if this Subject has been permanently deleted, so it should only be called when that behavior is desired.

◆ setObstructable()

void dart::gui::osg::DragAndDrop::setObstructable ( bool  _obstructable)

If true is passed in, this object will only be drag and droppable if there are no other objects between its picked point and the camera.

◆ setRotationModKey()

void dart::gui::osg::DragAndDrop::setRotationModKey ( ::osgGA::GUIEventAdapter::ModKeyMask  rotationModKey)

Set the modkey that will be used to toggle rotation for this DnD.

◆ setRotationOption()

void dart::gui::osg::DragAndDrop::setRotationOption ( RotationOption  option)

Set the option for triggering rotations instead of translations.

◆ unconstrain()

void dart::gui::osg::DragAndDrop::unconstrain ( )

Remove all constraints from the dragging and dropping.

◆ update()

void dart::gui::osg::DragAndDrop::update ( )
virtual

Member Data Documentation

◆ mAmMoving

bool dart::gui::osg::DragAndDrop::mAmMoving
protected

Whether this DnD is currently moving.

◆ mAmObstructable

bool dart::gui::osg::DragAndDrop::mAmObstructable
protected

Whether other objects can block this one from being picked.

◆ mConstraintType

ConstraintType dart::gui::osg::DragAndDrop::mConstraintType
protected

Constraint type for this DnD.

◆ mEntity

dart::dynamics::Entity* dart::gui::osg::DragAndDrop::mEntity
protected

Pointer to the DnD's Entity.

◆ mObservers

std::set<Observer*> dart::common::Subject::mObservers
mutableprotectedinherited

List of current Observers.

◆ mPickedPosition

Eigen::Vector3d dart::gui::osg::DragAndDrop::mPickedPosition
protected

The location in the world that was picked by the user.

◆ mPivot

Eigen::Vector3d dart::gui::osg::DragAndDrop::mPivot
protected

Point in space about which rotations should happen.

◆ mRotationModKey

::osgGA::GUIEventAdapter::ModKeyMask dart::gui::osg::DragAndDrop::mRotationModKey
protected

Modkey for rotation.

◆ mRotationOption

RotationOption dart::gui::osg::DragAndDrop::mRotationOption
protected

Option for rotation settings.

◆ mSubjects

std::set<const Subject*> dart::common::Observer::mSubjects
protectedinherited

List of current Subjects for this Observer.

◆ mVector

Eigen::Vector3d dart::gui::osg::DragAndDrop::mVector
protected

Reference vector for constraint (slope for line constraint, or normal for plane constraint)

◆ mViewer

Viewer* dart::gui::osg::DragAndDrop::mViewer
protected

Pointer to the DnD's Viewer.