OpenSceneGraph  3.5.1
Public Types | Public Member Functions | Protected Member Functions | List of all members
osgManipulator::MotionCommand Class Referenceabstract

Base class for motion commands that are generated by draggers. More...

Inheritance diagram for osgManipulator::MotionCommand:
Inheritance graph
[legend]

Public Types

enum  Stage { NONE, START, MOVE, FINISH }
 Motion command are based on click-drag-release actions. More...
 

Public Member Functions

 MotionCommand ()
 
virtual MotionCommandcreateCommandInverse ()=0
 create a MotionCommand that is the inverse of this command, and if applied will undo this commands changes. More...
 
virtual osg::Matrix getMotionMatrix () const =0
 Gets the matrix for transforming the object being dragged. More...
 
virtual void accept (const Constraint &constraint)
 
virtual void accept (DraggerCallback &callback)
 
void setLocalToWorldAndWorldToLocal (const osg::Matrix &localToWorld, const osg::Matrix &worldToLocal)
 Sets the matrix for transforming the command's local coordinate system to the world/object coordinate system. More...
 
const osg::MatrixgetLocalToWorld () const
 Gets the matrix for transforming the command's local coordinate system to the world/object coordinate system. More...
 
const osg::MatrixgetWorldToLocal () const
 Gets the matrix for transforming the command's world/object coordinate system to the command's local coordinate system. More...
 
void setStage (const Stage s)
 
Stage getStage () const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

virtual ~MotionCommand ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Detailed Description

Base class for motion commands that are generated by draggers.

Member Enumeration Documentation

Motion command are based on click-drag-release actions.

So each command needs to indicate which stage of the motion the command represents.

Enumerator
NONE 
START 

Click or pick start.

MOVE 

Drag or pick move.

FINISH 

Release or pick finish.

Constructor & Destructor Documentation

osgManipulator::MotionCommand::MotionCommand ( )
virtual osgManipulator::MotionCommand::~MotionCommand ( )
protectedvirtual

Member Function Documentation

virtual void osgManipulator::MotionCommand::accept ( const Constraint constraint)
inlinevirtual
virtual void osgManipulator::MotionCommand::accept ( DraggerCallback callback)
inlinevirtual
virtual MotionCommand* osgManipulator::MotionCommand::createCommandInverse ( )
pure virtual
const osg::Matrix& osgManipulator::MotionCommand::getLocalToWorld ( ) const
inline

Gets the matrix for transforming the command's local coordinate system to the world/object coordinate system.

virtual osg::Matrix osgManipulator::MotionCommand::getMotionMatrix ( ) const
pure virtual

Gets the matrix for transforming the object being dragged.

This matrix is in the command's coordinate systems.

Implemented in osgManipulator::Rotate3DCommand, osgManipulator::ScaleUniformCommand, osgManipulator::Scale2DCommand, osgManipulator::Scale1DCommand, osgManipulator::TranslateInPlaneCommand, and osgManipulator::TranslateInLineCommand.

Stage osgManipulator::MotionCommand::getStage ( ) const
inline
const osg::Matrix& osgManipulator::MotionCommand::getWorldToLocal ( ) const
inline

Gets the matrix for transforming the command's world/object coordinate system to the command's local coordinate system.

void osgManipulator::MotionCommand::setLocalToWorldAndWorldToLocal ( const osg::Matrix localToWorld,
const osg::Matrix worldToLocal 
)
inline

Sets the matrix for transforming the command's local coordinate system to the world/object coordinate system.

void osgManipulator::MotionCommand::setStage ( const Stage  s)
inline

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

osg logo
Generated at Wed Nov 11 2015 22:15:00 for the OpenSceneGraph by doxygen 1.8.10.