OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Member Functions | Public Attributes | List of all members
ossimMouseEvent Class Reference

#include <ossimMouseEvent.h>

Inheritance diagram for ossimMouseEvent:
ossimEvent ossimObject ossimReferenced

Public Member Functions

 ossimMouseEvent (const ossimDpt &scenePoint=ossimDpt(0, 0), const ossimDpt &relViewPoint=ossimDpt(0, 0), ossimObject *object=NULL, long id=OSSIM_MOUSE_EVENT_ID, long mouseType=0)
 
virtual ossimObjectdup () const
 
bool controlDown () const
 
bool altDown () const
 
bool shiftDown () const
 
bool leftDown () const
 
bool middleDown () const
 
bool rightDown () const
 
bool leftUp () const
 
bool middleUp () const
 
bool rightUp () const
 
bool leftDClick () const
 
bool middleDClick () const
 
bool rightDClick () const
 
bool leftIsDown () const
 
bool middleIsDown () const
 
bool rightIsDown () const
 
bool dragging () const
 
bool moving () const
 
bool entering () const
 
bool leaving () const
 
- Public Member Functions inherited from ossimEvent
 ossimEvent (ossimObject *object=NULL, long id=OSSIM_EVENT_NULL_ID)
 
 ossimEvent (const ossimEvent &rhs)
 
long getId () const
 
void setId (long id)
 
bool isConsumed () const
 
void setConsumedFlag (bool flag=true)
 
void consume ()
 
const ossimObjectgetObject () const
 This is the originating object that originally produced the event. More...
 
ossimObjectgetObject ()
 
const ossimObjectgetCurrentObject () const
 
ossimObjectgetCurrentObject ()
 
void setObject (ossimObject *object)
 
void setCurrentObject (ossimObject *object)
 
void setPropagationType (PropagationType type)
 
bool isPropagatingToOutputs () const
 
bool isPropagatingToInputs () const
 
- Public Member Functions inherited from ossimObject
 ossimObject ()
 
virtual ~ossimObject ()
 
virtual ossimString getShortName () const
 
virtual ossimString getLongName () const
 
virtual ossimString getDescription () const
 
virtual ossimString getClassName () const
 
virtual RTTItypeid getType () const
 
virtual bool canCastTo (ossimObject *obj) const
 
virtual bool canCastTo (const RTTItypeid &id) const
 
virtual bool canCastTo (const ossimString &parentClassName) const
 
virtual bool saveState (ossimKeywordlist &kwl, const char *prefix=0) const
 
virtual bool loadState (const ossimKeywordlist &kwl, const char *prefix=0)
 
virtual std::ostream & print (std::ostream &out) const
 Generic print method. More...
 
virtual bool isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
 
virtual void accept (ossimVisitor &visitor)
 
- Public Member Functions inherited from ossimReferenced
 ossimReferenced ()
 
 ossimReferenced (const ossimReferenced &)
 
ossimReferencedoperator= (const ossimReferenced &)
 
void ref () const
 increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
void unref () const
 decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
 
void unref_nodelete () const
 decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
 
int referenceCount () const
 

Public Attributes

ossimDpt theScenePoint
 
ossimDpt theRelViewPoint
 
int theMouseType
 
bool theAltKeyDown
 
bool theControlKeyDown
 
bool theShiftKeyDown
 
bool theLeftDown
 
bool theRightDown
 
bool theMiddleDown
 

Additional Inherited Members

- Public Types inherited from ossimEvent
enum  PropagationType { PROPAGATION_NONE = 0, PROPAGATION_INPUT = 1, PROPAGATION_OUTPUT = 2 }
 
- Protected Member Functions inherited from ossimReferenced
virtual ~ossimReferenced ()
 
- Protected Attributes inherited from ossimEvent
ossimObjecttheObject
 
ossimObjecttheCurrentObject
 
long theId
 
bool theIsConsumedFlag
 
PropagationType thePropagationType
 

Detailed Description

Definition at line 15 of file ossimMouseEvent.h.

Constructor & Destructor Documentation

◆ ossimMouseEvent()

ossimMouseEvent::ossimMouseEvent ( const ossimDpt scenePoint = ossimDpt(0,0),
const ossimDpt relViewPoint = ossimDpt(0,0),
ossimObject object = NULL,
long  id = OSSIM_MOUSE_EVENT_ID,
long  mouseType = 0 
)
inline

Definition at line 18 of file ossimMouseEvent.h.

23  :ossimEvent(object, id),
24  theScenePoint(scenePoint),
25  theRelViewPoint(relViewPoint),
26  theMouseType(mouseType)
27  {
28  }
ossimDpt theScenePoint
ossimEvent(ossimObject *object=NULL, long id=OSSIM_EVENT_NULL_ID)
Definition: ossimEvent.cpp:16
ossimDpt theRelViewPoint

Member Function Documentation

◆ altDown()

bool ossimMouseEvent::altDown ( ) const
inline

Definition at line 33 of file ossimMouseEvent.h.

33 { return theAltKeyDown; }

◆ controlDown()

bool ossimMouseEvent::controlDown ( ) const
inline

Definition at line 32 of file ossimMouseEvent.h.

32 { return theControlKeyDown; }

◆ dragging()

bool ossimMouseEvent::dragging ( ) const
inline

Definition at line 55 of file ossimMouseEvent.h.

56  {
57  return (moving() &&
58  (leftIsDown() || middleIsDown() || rightIsDown()));
59  }
bool leftIsDown() const
bool middleIsDown() const
bool rightIsDown() const
bool moving() const

◆ dup()

virtual ossimObject* ossimMouseEvent::dup ( ) const
inlinevirtual

Reimplemented from ossimObject.

Definition at line 30 of file ossimMouseEvent.h.

30 {return new ossimMouseEvent(*this);}
ossimMouseEvent(const ossimDpt &scenePoint=ossimDpt(0, 0), const ossimDpt &relViewPoint=ossimDpt(0, 0), ossimObject *object=NULL, long id=OSSIM_MOUSE_EVENT_ID, long mouseType=0)

◆ entering()

bool ossimMouseEvent::entering ( ) const
inline

Definition at line 65 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_ENTER_WINDOW_ID.

#define OSSIM_MOUSE_EVENT_ENTER_WINDOW_ID
Definition: ossimEventIds.h:52

◆ leaving()

bool ossimMouseEvent::leaving ( ) const
inline

Definition at line 68 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_LEAVE_WINDOW_ID.

#define OSSIM_MOUSE_EVENT_LEAVE_WINDOW_ID
Definition: ossimEventIds.h:40

◆ leftDClick()

bool ossimMouseEvent::leftDClick ( ) const
inline

Definition at line 44 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_LEFT_DCLICK_ID.

#define OSSIM_MOUSE_EVENT_LEFT_DCLICK_ID
Definition: ossimEventIds.h:49

◆ leftDown()

bool ossimMouseEvent::leftDown ( ) const
inline

Definition at line 37 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_LEFT_DOWN_ID.

#define OSSIM_MOUSE_EVENT_LEFT_DOWN_ID
Definition: ossimEventIds.h:42

◆ leftIsDown()

bool ossimMouseEvent::leftIsDown ( ) const
inline

Definition at line 50 of file ossimMouseEvent.h.

50 { return theLeftDown; }

◆ leftUp()

bool ossimMouseEvent::leftUp ( ) const
inline

Definition at line 40 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_LEFT_UP_ID.

#define OSSIM_MOUSE_EVENT_LEFT_UP_ID
Definition: ossimEventIds.h:45

◆ middleDClick()

bool ossimMouseEvent::middleDClick ( ) const
inline

Definition at line 45 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_MIDDLE_DCLICK_ID.

#define OSSIM_MOUSE_EVENT_MIDDLE_DCLICK_ID
Definition: ossimEventIds.h:51

◆ middleDown()

bool ossimMouseEvent::middleDown ( ) const
inline

Definition at line 38 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_MIDDLE_DOWN_ID.

#define OSSIM_MOUSE_EVENT_MIDDLE_DOWN_ID
Definition: ossimEventIds.h:44

◆ middleIsDown()

bool ossimMouseEvent::middleIsDown ( ) const
inline

Definition at line 51 of file ossimMouseEvent.h.

51 { return theMiddleDown; }

◆ middleUp()

bool ossimMouseEvent::middleUp ( ) const
inline

Definition at line 41 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_MIDDLE_UP_ID.

#define OSSIM_MOUSE_EVENT_MIDDLE_UP_ID
Definition: ossimEventIds.h:47

◆ moving()

bool ossimMouseEvent::moving ( ) const
inline

Definition at line 62 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_MOTION_ID.

#define OSSIM_MOUSE_EVENT_MOTION_ID
Definition: ossimEventIds.h:41

◆ rightDClick()

bool ossimMouseEvent::rightDClick ( ) const
inline

Definition at line 46 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_RIGHT_DCLICK_ID.

#define OSSIM_MOUSE_EVENT_RIGHT_DCLICK_ID
Definition: ossimEventIds.h:50

◆ rightDown()

bool ossimMouseEvent::rightDown ( ) const
inline

Definition at line 39 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_RIGHT_DOWN_ID.

#define OSSIM_MOUSE_EVENT_RIGHT_DOWN_ID
Definition: ossimEventIds.h:43

◆ rightIsDown()

bool ossimMouseEvent::rightIsDown ( ) const
inline

Definition at line 52 of file ossimMouseEvent.h.

52 { return theRightDown; }

◆ rightUp()

bool ossimMouseEvent::rightUp ( ) const
inline

Definition at line 42 of file ossimMouseEvent.h.

References OSSIM_MOUSE_EVENT_RIGHT_UP_ID.

#define OSSIM_MOUSE_EVENT_RIGHT_UP_ID
Definition: ossimEventIds.h:46

◆ shiftDown()

bool ossimMouseEvent::shiftDown ( ) const
inline

Definition at line 34 of file ossimMouseEvent.h.

34 { return theShiftKeyDown; }

Member Data Documentation

◆ theAltKeyDown

bool ossimMouseEvent::theAltKeyDown

Definition at line 73 of file ossimMouseEvent.h.

◆ theControlKeyDown

bool ossimMouseEvent::theControlKeyDown

Definition at line 74 of file ossimMouseEvent.h.

◆ theLeftDown

bool ossimMouseEvent::theLeftDown

Definition at line 76 of file ossimMouseEvent.h.

◆ theMiddleDown

bool ossimMouseEvent::theMiddleDown

Definition at line 78 of file ossimMouseEvent.h.

◆ theMouseType

int ossimMouseEvent::theMouseType

Definition at line 72 of file ossimMouseEvent.h.

◆ theRelViewPoint

ossimDpt ossimMouseEvent::theRelViewPoint

Definition at line 71 of file ossimMouseEvent.h.

◆ theRightDown

bool ossimMouseEvent::theRightDown

Definition at line 77 of file ossimMouseEvent.h.

◆ theScenePoint

ossimDpt ossimMouseEvent::theScenePoint

Definition at line 70 of file ossimMouseEvent.h.

◆ theShiftKeyDown

bool ossimMouseEvent::theShiftKeyDown

Definition at line 75 of file ossimMouseEvent.h.


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