Orthographic view controller. More...

#include <OrthoViewController.hh>

Public Member Functions
	OrthoViewController (UserCameraPtr _camera)
	Constructor.
virtual	~OrthoViewController ()
	Destructor.
ignition::math::Vector3d	FocalPoint () const
	Get the focal point.
std::string	GetTypeString () const
	Get the type of view controller.
virtual void	HandleKeyPressEvent (const std::string &_key)
	Handle a key press event.
void	HandleKeyReleaseEvent (const std::string &_key)
	Handle a key release event.
virtual void	HandleMouseEvent (const common::MouseEvent &_event)
	Handle a mouse event.
virtual void	Init ()
	Initialize the controller.
virtual void	Init (const ignition::math::Vector3d &_focalPoint, const double _yaw=0, const double _pitch=0)
	Initialize with a focus point.
double	Pitch () const
virtual void	Resize (const unsigned int _width, const unsigned int _height)
	Called by the UserCamera when a resize event occurs.
void	SetDistance (float _d)
	Set the distance to the focal point.
void	SetEnabled (bool _value)
	Set whether the controller is enabled.
void	SetFocalPoint (const ignition::math::Vector3d &_fp)
	Set the focal point.
virtual void	Update ()
	Update.
double	Yaw () const

Static Public Member Functions
static std::string	GetTypeString ()
	Get the type name of this view controller.

Protected Member Functions
double	NormalizePitch (double _v)
	Normalize pitch value.
double	NormalizeYaw (double _v)
	Normalize yaw value.
void	Orbit (double _dy, double _dp)
	Update the camera's pose based on a rotation update.
void	TranslateGlobal (const ignition::math::Vector3d &_vec)
	Translate the focal point in the global coordinate frame.
void	TranslateLocal (const ignition::math::Vector3d &_vec)
	Translate the focal point in the local coordinate frame.
void	UpdateRefVisual ()
	Update the reference visual.
void	Zoom (float _amount)
	Zoom the camera.

Protected Attributes
UserCameraPtr	camera
	Pointer to the camera to control.
float	distance
	Distance to the focal point.
bool	enabled
	True if enabled.
ignition::math::Vector3d	focalPoint
	The focal point.
bool	init
	A flag used to inidicate that the view controller has just been initialized.
std::string	key
	Key that is currently pressed.
float	pitch
	Pitch value.
VisualPtr	refVisual
	A reference visual.
std::string	typeString
	Type of view controller.
float	yaw
	Yaw value.

Detailed Description

Orthographic view controller.

Constructor & Destructor Documentation

◆ OrthoViewController()

OrthoViewController ( UserCameraPtr _camera )

explicit

Constructor.

Parameters

[in] _camera Pointer to the camera to control.

◆ ~OrthoViewController()

virtual ~OrthoViewController ( )

virtual

Destructor.

Member Function Documentation

◆ FocalPoint()

ignition::math::Vector3d FocalPoint ( ) const

inherited

Get the focal point.

Returns: The focal point

◆ GetTypeString() [1/2]

std::string GetTypeString ( )

static

Get the type name of this view controller.

Returns: The view controller name: "ortho".

◆ GetTypeString() [2/2]

std::string GetTypeString ( ) const

inherited

Get the type of view controller.

Returns: The view controller type string.

◆ HandleKeyPressEvent()

virtual void HandleKeyPressEvent ( const std::string & _key )

virtualinherited

Handle a key press event.

Parameters

[in] _key The key that was pressed.

Implements ViewController.

◆ HandleKeyReleaseEvent()

void HandleKeyReleaseEvent ( const std::string & _key )

virtualinherited

Handle a key release event.

Parameters

[in] _key The key that was released.

Implements ViewController.

◆ HandleMouseEvent()

virtual void HandleMouseEvent ( const common::MouseEvent & _event )

virtual

Handle a mouse event.

Parameters

[in] _event The mouse event.

Reimplemented from OrbitViewController.

◆ Init() [1/2]

virtual void Init ( )

virtual

Initialize the controller.

Reimplemented from OrbitViewController.

◆ Init() [2/2]

virtual void Init	(	const ignition::math::Vector3d &	_focalPoint,
		const double	_yaw = 0,
		const double	_pitch = 0 )

virtual

Initialize with a focus point.

Parameters

[in]	_focalPoint	The point to look at.
[in]	_yaw	Initial yaw angle.
[in]	_pitch	Initial pitch angle.

Reimplemented from OrbitViewController.

◆ NormalizePitch()

double NormalizePitch ( double _v )

protectedinherited

Normalize pitch value.

\paramp[in] _v Normalize a pitch value.

Returns: The normalized value.

◆ NormalizeYaw()

double NormalizeYaw ( double _v )

protectedinherited

Normalize yaw value.

\paramp[in] _v Normalize a yaw value.

Returns: The normalized value.

◆ Orbit()

void Orbit	(	double	_dy,
		double	_dp )

protectedinherited

Update the camera's pose based on a rotation update.

Parameters

[in]	_dy	Delta yaw movement.
[in]	_dp	Delta pitch movement.

◆ Pitch()

double Pitch ( ) const

inherited

◆ Resize()

virtual void Resize	(	const unsigned int	_width,
		const unsigned int	_height )

virtual

Called by the UserCamera when a resize event occurs.

Parameters

[in]	_width	New width
[in]	_height	New height

Reimplemented from ViewController.

◆ SetDistance()

void SetDistance ( float _d )

inherited

Set the distance to the focal point.

Parameters

[in] _d The distance from the focal point.

◆ SetEnabled()

void SetEnabled ( bool _value )

inherited

Set whether the controller is enabled.

Parameters

[in] _value True if the controller is enabled.

◆ SetFocalPoint()

void SetFocalPoint ( const ignition::math::Vector3d & _fp )

inherited

Set the focal point.

Parameters

[in] _fp The focal point

◆ TranslateGlobal()

void TranslateGlobal ( const ignition::math::Vector3d & _vec )

protectedinherited

Translate the focal point in the global coordinate frame.

Parameters

[in] _vec Direction and amount to translate the camera.

◆ TranslateLocal()

void TranslateLocal ( const ignition::math::Vector3d & _vec )

protectedinherited

Translate the focal point in the local coordinate frame.

Parameters

[in] _vec Direction and amount to translate the camera.

◆ Update()

virtual void Update ( )

virtualinherited

Update.

Implements ViewController.

◆ UpdateRefVisual()

void UpdateRefVisual ( )

protectedinherited

Update the reference visual.

◆ Yaw()

double Yaw ( ) const

inherited

◆ Zoom()

void Zoom ( float _amount )

protectedinherited

Zoom the camera.

\paramp[in] _amount Zoom quatity.

Member Data Documentation

◆ camera

UserCameraPtr camera

protectedinherited

Pointer to the camera to control.

◆ distance

float distance

protectedinherited

Distance to the focal point.

◆ enabled

bool enabled

protectedinherited

True if enabled.

◆ focalPoint

ignition::math::Vector3d focalPoint

protectedinherited

The focal point.

◆ init

bool init

protectedinherited

A flag used to inidicate that the view controller has just been initialized.

◆ key

std::string key

protectedinherited

Key that is currently pressed.

◆ pitch

float pitch

protectedinherited

Pitch value.

◆ refVisual

VisualPtr refVisual

protectedinherited

A reference visual.

◆ typeString

std::string typeString

protectedinherited

Type of view controller.

◆ yaw

float yaw

protectedinherited

Yaw value.

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

OrthoViewController.hh

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OrthoViewController()

◆ ~OrthoViewController()

Member Function Documentation

◆ FocalPoint()

◆ GetTypeString() [1/2]

◆ GetTypeString() [2/2]

◆ HandleKeyPressEvent()

◆ HandleKeyReleaseEvent()

◆ HandleMouseEvent()

◆ Init() [1/2]

◆ Init() [2/2]

◆ NormalizePitch()

◆ NormalizeYaw()

◆ Orbit()

◆ Pitch()

◆ Resize()

◆ SetDistance()

◆ SetEnabled()

◆ SetFocalPoint()

◆ TranslateGlobal()

◆ TranslateLocal()

◆ Update()

◆ UpdateRefVisual()

◆ Yaw()

◆ Zoom()

Member Data Documentation

◆ camera

◆ distance

◆ enabled

◆ focalPoint

◆ init

◆ key

◆ pitch

◆ refVisual

◆ typeString

◆ yaw