osgGA::FlightManipulator Class Reference

FlightManipulator is a MatrixManipulator which provides flight simulator-like updating of the camera position & orientation. More...

Inheritance diagram for osgGA::FlightManipulator:

List of all members.

Public Types
enum	YawControlMode { YAW_AUTOMATICALLY_WHEN_BANKED, NO_AUTOMATIC_YAW }
Public Member Functions
	FlightManipulator (int flags=UPDATE_MODEL_SIZE|COMPUTE_HOME_USING_BBOX)
	FlightManipulator (const FlightManipulator &fpm, const osg::CopyOp &copyOp=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgGA, FlightManipulator)
virtual void	setYawControlMode (YawControlMode ycm)
YawControlMode	getYawControlMode () const
	Returns the Yaw control for the flight model.
virtual void	home (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
	Move the camera to the default position.
virtual void	init (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
	Start/restart the manipulator.
virtual void	getUsage (osg::ApplicationUsage &usage) const
	Get the keyboard and mouse usage of this manipulator.
Protected Member Functions
virtual bool	handleFrame (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
virtual bool	handleMouseMove (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
virtual bool	handleMouseDrag (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
virtual bool	handleMousePush (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
virtual bool	handleMouseRelease (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
virtual bool	handleKeyDown (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
virtual bool	flightHandleEvent (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
virtual bool	performMovement ()
virtual bool	performMovementLeftMouseButton (const double eventTimeDelta, const double dx, const double dy)
virtual bool	performMovementMiddleMouseButton (const double eventTimeDelta, const double dx, const double dy)
virtual bool	performMovementRightMouseButton (const double eventTimeDelta, const double dx, const double dy)
Protected Attributes
YawControlMode	_yawMode

---

Detailed Description

FlightManipulator is a MatrixManipulator which provides flight simulator-like updating of the camera position & orientation.

By default, the left mouse button accelerates, the right mouse button decelerates, and the middle mouse button (or left and right simultaneously) stops dead.

---

Member Enumeration Documentation

enum osgGA::FlightManipulator::YawControlMode

Enumerator:

YAW_AUTOMATICALLY_WHEN_BANKED
NO_AUTOMATIC_YAW

---

Constructor & Destructor Documentation

osgGA::FlightManipulator::FlightManipulator

(

int

flags = UPDATE_MODEL_SIZE|COMPUTE_HOME_USING_BBOX

)

osgGA::FlightManipulator::FlightManipulator	(	const FlightManipulator &	fpm,
		const osg::CopyOp &	copyOp = osg::CopyOp::SHALLOW_COPY
	)

---

Member Function Documentation

virtual bool osgGA::FlightManipulator::flightHandleEvent	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)		[protected, virtual]

virtual void osgGA::FlightManipulator::getUsage

(

osg::ApplicationUsage &

)

const [virtual]

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::StandardManipulator.

FlightManipulator::YawControlMode osgGA::FlightManipulator::getYawControlMode

(

)

const [inline]

Returns the Yaw control for the flight model.

References _yawMode.

virtual bool osgGA::FlightManipulator::handleFrame	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)		[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual bool osgGA::FlightManipulator::handleKeyDown	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)		[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual bool osgGA::FlightManipulator::handleMouseDrag	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)		[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual bool osgGA::FlightManipulator::handleMouseMove	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)		[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual bool osgGA::FlightManipulator::handleMousePush	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)		[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual bool osgGA::FlightManipulator::handleMouseRelease	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)		[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual void osgGA::FlightManipulator::home	(	const osgGA::GUIEventAdapter &	,
		osgGA::GUIActionAdapter &
	)		[virtual]

Move the camera to the default position.

May be ignored by manipulators if home functionality is not appropriate.

Reimplemented from osgGA::FirstPersonManipulator.

virtual void osgGA::FlightManipulator::init	(	const osgGA::GUIEventAdapter &	,
		osgGA::GUIActionAdapter &
	)		[virtual]

Start/restart the manipulator.

FIXME: what does this actually mean? Provide examples.

Reimplemented from osgGA::FirstPersonManipulator.

osgGA::FlightManipulator::META_Object	(	osgGA	,
		FlightManipulator
	)

virtual bool osgGA::FlightManipulator::performMovement

(

)

[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual bool osgGA::FlightManipulator::performMovementLeftMouseButton	(	const double	eventTimeDelta,
		const double	dx,
		const double	dy
	)		[protected, virtual]

Reimplemented from osgGA::FirstPersonManipulator.

virtual bool osgGA::FlightManipulator::performMovementMiddleMouseButton	(	const double	eventTimeDelta,
		const double	dx,
		const double	dy
	)		[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual bool osgGA::FlightManipulator::performMovementRightMouseButton	(	const double	eventTimeDelta,
		const double	dx,
		const double	dy
	)		[protected, virtual]

Reimplemented from osgGA::StandardManipulator.

virtual void osgGA::FlightManipulator::setYawControlMode

(

YawControlMode

ycm

)

[virtual]

---

Member Data Documentation

YawControlMode osgGA::FlightManipulator::_yawMode [protected]

Referenced by getYawControlMode().

---

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

• osgGA/FlightManipulator