|  

---

ManipulatedCameraFrame Class Reference

A Camera Frame that can be rotated and translated with the mouse. More...

Inherits ManipulatedFrame.

List of all members.

Fly parameters
float	flySpeed () const
Vec	flyUpVector () const
void	setFlySpeed (const float s)
void	setFlyUpVector (const Vec &up)
XML representation
virtual QDomElement	domElement (const QString &name, QDomDocument &doc) const
virtual void	initFromDOMElement (const QDomElement &de)
Mouse event handlers
virtual void	mouseReleaseEvent (QMouseEvent *const, Camera *const)
virtual void	mouseMoveEvent (QMouseEvent *const, const Camera *const)
virtual void	wheelEvent (QWheelEvent *const, const Camera *const camera)
Public Member Functions
	ManipulatedCameraFrame ()
virtual	~ManipulatedCameraFrame ()
Protected Slots
void	updateFrameInFlyMode ()
Protected Member Functions
void	updateFlyUpVector ()
Quaternion	quaternionFromThetaPhi (const int x, const int y, const Camera *const camera)
virtual void	startAction (MouseMotion ma, bool withConstraint=true)

---

Detailed Description

A Camera Frame that can be rotated and translated with the mouse.

A ManipulatedCameraFrame is a specialization of a ManipulatedFrame, designed for associated Camera frames. All mouse motions are basically interpreted in a negated way: when the mouse goes to the right, the ManipulatedFrame translation goes to the right, while the ManipulatedCameraFrame has to go to the left, so that the scene seems to move to the right.

See the mouse page for a description of the possible displacements that can be performed using the mouse.

The ManipulatedFrame::isManipulated() function is used to call QGLViewer::fastDraw() instead of QGLViewer::draw() for interactive scene displays when the camera is manipulated (see the fastDraw example).

---

Constructor & Destructor Documentation

ManipulatedCameraFrame (   )

Creates a default ManipulatedCameraFrame. Created object is removeFromMouseGrabberPool().

virtual ~ManipulatedCameraFrame (   )  [inline, virtual]

Virtual destructor. Empty.

---

Member Function Documentation

QDomElement domElement (  const QString &  name, QDomDocument &  doc )  const [virtual]

Creates an XML QDomElement that represents the ManipulatedCameraFrame. Add to ManipulatedFrame::domElement() the ManipulatedCameraFrame specific informations. name is the name of the QDomElement tag. You need to provide the QDomDocument doc that will hold the resulting element. Use initFromDOMElement() to restore the ManipulatedCameraFrame state from the resulting domElement. Reimplemented from ManipulatedFrame.

float flySpeed (   )  const [inline]

Returns the current fly speed set with setFlySpeed(). Set according to the QGLViewer::sceneRadius() in QGLViewer::setSceneRadius().

Vec flyUpVector (   )  const [inline]

Return the up vector used in ManipulatedFrame::MOVE_FORWARD and ManipulatedFrame::MOVE_BACKWARD modes. This vector is normal to the displacement horizontal plane. Horizontal displacements of the mouse rotates the frame around this vector. It is expressed in the world coordinate system. Vertical displacements of the mouse rotate around the Camera Y axis.

void initFromDOMElement (  const QDomElement &  de  )  [virtual]

Restore the ManipulatedCameraFrame state from a QDomElement created by domElement(). See also Frame::initFromDOMElement(). Reimplemented from ManipulatedFrame.

void mouseMoveEvent (  QMouseEvent *  const, const Camera *  const )  [protected, virtual]

Move the camera frame according to the mouse motion. The camera is given as an argument so that its parameters (width and height of the window, fieldOfView) are available in order to fit the mouse motion and the display. Emits manipulated(). Reimplemented from ManipulatedFrame.

void mouseReleaseEvent (  QMouseEvent *  const, Camera *  const )  [protected, virtual]

When the user releases the mouse button, the manipulatedFrame action is stopped. Reimplemented from ManipulatedFrame.

Quaternion quaternionFromThetaPhi (  const int  x, const int  y, const Camera *const  camera )  [protected]

Set lastQuat according to the mouse motion. Simple Theta-Phi inferred from the X-flyUpVector() axis.

void setFlySpeed (  const float  s  )  [inline, slot]

When a ManipulatedFrame::MOVE_FORWARD or ManipulatedFrame::MOVE_BACKWARD action is produced by the mouse, this value tunes the speed of the displacement. Current value is given by flySpeed(). See the mouse page and QGLViewer::setMouseBinding() for details.

void setFlyUpVector (  const Vec &  up  )  [inline, slot]

Defines the fly up vector (used in MOVE_FORWARD and MOVE_BACKWARD mode), defined in the world coordinate system. See flyUpVector().

void startAction (  MouseMotion  ma, bool  withConstraint = true )  [protected, virtual]

Reimplemented from ManipulatedFrame.

void updateFlyUpVector (   )  [protected]

This function will be called by the camera when the camera orientation is changed, so that the flyUpVector (private) is changed accordingly. You should not need to call this function.

void updateFrameInFlyMode (   )  [protected, slot]

Called for continuous frame motion in fly mode (see ManipulatedFrame::MOVE_FORWARD). Emits manipulated().

void wheelEvent (  QWheelEvent *  const, const Camera *const  camera )  [protected, virtual]

The wheel behavior depends on the wheel binded action. Current possible actions are ZOOM, MOVE_FORWARD, MOVE_BACKWARD. See QGLViewer::setWheelBinding() to customize the binding. Depending on your system configuration, you may have to actually press the wheel while wheeling. Reimplemented from ManipulatedFrame.

---