The ManipulatedCameraFrame class represents a ManipulatedFrame with Camera specific mouse bindings. More...

#include <QGLViewer/manipulatedCameraFrame.h>

Inheritance diagram for qglviewer::ManipulatedCameraFrame:

Public Member Functions
	ManipulatedCameraFrame ()
	ManipulatedCameraFrame (const ManipulatedCameraFrame &mcf)
ManipulatedCameraFrame &	operator= (const ManipulatedCameraFrame &mcf)
virtual	~ManipulatedCameraFrame ()
Protected Member Functions
virtual void	startAction (int ma, bool withConstraint=true)
Private Slots
virtual void	flyUpdate ()
Private Member Functions
Quaternion	pitchYawQuaternion (int x, int y, const Camera *const camera)
Quaternion	turnQuaternion (int x, const Camera *const camera)
void	updateFlyUpVector ()
Private Attributes
float	driveSpeed_
float	flySpeed_
QTimer	flyTimer_
Vec	flyUpVector_
Vec	revolveAroundPoint_
Friends
class	::QGLViewer
class	Camera
Revolve around point
Vec	revolveAroundPoint () const
void	setRevolveAroundPoint (const Vec &revolveAroundPoint)
Fly parameters
float	flySpeed () const
Vec	flyUpVector () const
void	setFlySpeed (float speed)
void	setFlyUpVector (const Vec &up)
Mouse event handlers
virtual void	mouseReleaseEvent (QMouseEvent const event, Camera const camera)
virtual void	mouseMoveEvent (QMouseEvent const event, Camera const camera)
virtual void	wheelEvent (QWheelEvent const event, Camera const camera)
Spinning
virtual void	spin ()
XML representation
virtual QDomElement	domElement (const QString &name, QDomDocument &document) const
virtual void	initFromDOMElement (const QDomElement &element)

Detailed Description

The ManipulatedCameraFrame class represents a ManipulatedFrame with Camera specific mouse bindings.

A ManipulatedCameraFrame is a specialization of a ManipulatedFrame, designed to be set as the Camera::frame(). 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.

A ManipulatedCameraFrame rotates around its revolveAroundPoint(), which corresponds to the associated Camera::revolveAroundPoint().

A ManipulatedCameraFrame can also "fly" in the scene. It basically moves forward, and turns according to the mouse motion. See flySpeed(), flyUpVector() and the QGLViewer::MOVE_FORWARD and QGLViewer::MOVE_BACKWARD QGLViewer::MouseAction.

See the mouse page for a description of the possible actions that can be performed using the mouse and their bindings.

Definition at line 47 of file manipulatedCameraFrame.h.

Constructor & Destructor Documentation

ManipulatedCameraFrame::ManipulatedCameraFrame ( )

Default constructor.

flySpeed() is set to 0.0 and flyUpVector() is (0,1,0). The revolveAroundPoint() is set to (0,0,0).

Attention:: Created object is removeFromMouseGrabberPool().

Definition at line 39 of file manipulatedCameraFrame.cpp.

virtual qglviewer::ManipulatedCameraFrame::~ManipulatedCameraFrame ( ) [inline, virtual]

Virtual destructor. Empty.

Definition at line 59 of file manipulatedCameraFrame.h.

ManipulatedCameraFrame::ManipulatedCameraFrame ( const ManipulatedCameraFrame & mcf )

Copy constructor. Performs a deep copy of all members using operator=().

Definition at line 60 of file manipulatedCameraFrame.cpp.

Member Function Documentation

QDomElement ManipulatedCameraFrame::domElement	(	const QString &	name,
		QDomDocument &	document
	)		const `[virtual]`

Returns an XML QDomElement that represents the ManipulatedCameraFrame.

Adds to the ManipulatedFrame::domElement() the ManipulatedCameraFrame specific informations in a ManipulatedCameraParameters child QDomElement.

name is the name of the QDomElement tag. doc is the QDomDocument factory used to create QDomElement.

Use initFromDOMElement() to restore the ManipulatedCameraFrame state from the resulting QDomElement.

See Vec::domElement() for a complete example. See also Quaternion::domElement(), Frame::domElement(), Camera::domElement()...

Reimplemented from qglviewer::ManipulatedFrame.

Definition at line 132 of file manipulatedCameraFrame.cpp.

float qglviewer::ManipulatedCameraFrame::flySpeed ( ) const [inline]

Returns the fly speed, expressed in OpenGL units.

It corresponds to the incremental displacement that is periodically applied to the ManipulatedCameraFrame position when a QGLViewer::MOVE_FORWARD or QGLViewer::MOVE_BACKWARD QGLViewer::MouseAction is proceeded.

Attention:: When the ManipulatedCameraFrame is set as the Camera::frame(), this value is set according to the QGLViewer::sceneRadius() by QGLViewer::setSceneRadius().

Definition at line 104 of file manipulatedCameraFrame.h.

void ManipulatedCameraFrame::flyUpdate ( ) [private, virtual, slot]

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

Definition at line 81 of file manipulatedCameraFrame.cpp.

Vec qglviewer::ManipulatedCameraFrame::flyUpVector ( ) const [inline]

Returns the up vector used in fly mode, expressed in the world coordinate system.

Fly mode corresponds to the QGLViewer::MOVE_FORWARD and QGLViewer::MOVE_BACKWARD QGLViewer::MouseAction bindings. In these modes, horizontal displacements of the mouse rotate the ManipulatedCameraFrame around this vector. Vertical displacements rotate always around the Camera X axis.

Default value is (0,1,0), but it is updated by the Camera when set as its Camera::frame(). Camera::setOrientation() and Camera::setUpVector()) modify this value and should be used instead.

Definition at line 116 of file manipulatedCameraFrame.h.

void ManipulatedCameraFrame::initFromDOMElement ( const QDomElement & element ) [virtual, slot]

Restores the ManipulatedCameraFrame state from a QDomElement created by domElement().

First calls ManipulatedFrame::initFromDOMElement() and then initializes ManipulatedCameraFrame specific parameters.

Reimplemented from qglviewer::ManipulatedFrame.

Definition at line 146 of file manipulatedCameraFrame.cpp.

void ManipulatedCameraFrame::mouseMoveEvent	(	QMouseEvent *const	event,
		Camera *const	camera
	)		`[protected, virtual]`

Overloading of ManipulatedFrame::mouseMoveEvent().

Motion depends on mouse binding (see mouse page for details). The resulting displacements are basically inverted from those of a ManipulatedFrame.

Reimplemented from qglviewer::ManipulatedFrame.

Definition at line 204 of file manipulatedCameraFrame.cpp.

void ManipulatedCameraFrame::mouseReleaseEvent	(	QMouseEvent *const	event,
		Camera *const	camera
	)		`[protected, virtual]`

This is an overload of ManipulatedFrame::mouseReleaseEvent(). The QGLViewer::MouseAction is terminated.

Reimplemented from qglviewer::ManipulatedFrame.

Definition at line 360 of file manipulatedCameraFrame.cpp.

ManipulatedCameraFrame & ManipulatedCameraFrame::operator= ( const ManipulatedCameraFrame & mcf )

Equal operator. Calls ManipulatedFrame::operator=() and then copy attributes.

Definition at line 49 of file manipulatedCameraFrame.cpp.

Quaternion ManipulatedCameraFrame::pitchYawQuaternion	(	int	x,
		int	y,
		const Camera *const	camera
	)		`[private]`

Returns a Quaternion that is the composition of two rotations, inferred from the mouse pitch (X axis) and yaw (flyUpVector() axis).

Definition at line 436 of file manipulatedCameraFrame.cpp.

Vec qglviewer::ManipulatedCameraFrame::revolveAroundPoint ( ) const [inline]

Returns the point the ManipulatedCameraFrame revolves around when rotated.

It is defined in the world coordinate system. Default value is (0,0,0).

When the ManipulatedCameraFrame is associated to a Camera, Camera::revolveAroundPoint() also returns this value. This point can interactively be changed using the mouse (see QGLViewer::RAP_FROM_PIXEL and QGLViewer::RAP_IS_CENTER in the mouse page).

Definition at line 75 of file manipulatedCameraFrame.h.

void qglviewer::ManipulatedCameraFrame::setFlySpeed ( float speed ) [inline, slot]

Sets the flySpeed(), defined in OpenGL units.

Default value is 0.0, but it is modified according to the QGLViewer::sceneRadius() when the ManipulatedCameraFrame is set as the Camera::frame().

Definition at line 87 of file manipulatedCameraFrame.h.

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

Sets the flyUpVector(), defined in the world coordinate system.

Default value is (0,1,0), but it is updated by the Camera when set as its Camera::frame(). Use Camera::setUpVector() instead in that case.

Definition at line 93 of file manipulatedCameraFrame.h.

void qglviewer::ManipulatedCameraFrame::setRevolveAroundPoint ( const Vec & revolveAroundPoint ) [inline]

Sets the revolveAroundPoint(), defined in the world coordinate system.

Definition at line 77 of file manipulatedCameraFrame.h.

void ManipulatedCameraFrame::spin ( ) [protected, virtual, slot]

Overloading of ManipulatedFrame::spin().

Rotates the ManipulatedCameraFrame around its revolveAroundPoint() instead of its origin.

Reimplemented from qglviewer::ManipulatedFrame.

Definition at line 73 of file manipulatedCameraFrame.cpp.

void ManipulatedCameraFrame::startAction	(	int	ma,
		bool	withConstraint = `true`
	)		`[protected, virtual]`

Protected internal method used to handle mouse events.

Reimplemented from qglviewer::ManipulatedFrame.

Definition at line 180 of file manipulatedCameraFrame.cpp.

Quaternion ManipulatedCameraFrame::turnQuaternion	(	int	x,
		const Camera *const	camera
	)		`[private]`

Returns a Quaternion that is a rotation around current camera Y, proportionnal to the horizontal mouse position.

Definition at line 429 of file manipulatedCameraFrame.cpp.

void ManipulatedCameraFrame::updateFlyUpVector ( ) [private]

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

Definition at line 110 of file manipulatedCameraFrame.cpp.