OrbitViewController Class Reference

A camera view controller. More...

#include <OrbitViewController.hh>

Public Member Functions
	OrbitViewController ()
	Deconstructor. More...
	OrbitViewController (const CameraPtr &_camera)
	Deconstructor. More...
virtual	~OrbitViewController ()
	Deconstructor. More...
virtual CameraPtr	Camera () const
	Get the camera that is controlled by this view controller. More...
virtual void	Orbit (const math::Vector2d &_value)
	Set camera orbit (rotational movement) around target point. More...
virtual void	Pan (const math::Vector2d &_value)
	Set camera pan (translational movement) around target point. More...
virtual void	SetCamera (const CameraPtr &_camera)
	Set the camera that will be controlled by this view controller. More...
virtual void	SetTarget (const math::Vector3d &_target)
	Set target point for pan, zoom, oribit. More...
virtual math::Vector3d &	Target () const
	Get target point for pan, zoom, oribit. More...
virtual void	Zoom (const double _value)
	Set zoom amount. More...
Public Member Functions inherited from ViewController
virtual	~ViewController ()
	Deconstructor. More...

Public Attributes
std::unique_ptr< OrbitViewControllerPrivate >	dataPtr
	Private data pointer. More...

Detailed Description

A camera view controller.

ignition/rendering/OrbitViewController.hh

Constructor & Destructor Documentation

OrbitViewController() [1/2]

OrbitViewController

(

)

Deconstructor.

OrbitViewController() [2/2]

OrbitViewController ( const CameraPtr &  _camera )

explicit

Deconstructor.

~OrbitViewController()

virtual ~OrbitViewController ( )

virtual

Deconstructor.

Member Function Documentation

Camera()

virtual CameraPtr Camera ( ) const

virtual

Get the camera that is controlled by this view controller.

Returns

Camera being controlled

Orbit()

virtual void Orbit ( const math::Vector2d &  _value )

virtual

Set camera orbit (rotational movement) around target point.

Parameters

[in]

_value

robit amount in image plane, e.g. mouse drag delta

Implements ViewController.

Pan()

virtual void Pan ( const math::Vector2d &  _value )

virtual

Set camera pan (translational movement) around target point.

Parameters

[in]

_value

Pan amount in image plane, e.g. mouse drag delta.

Implements ViewController.

SetCamera()

virtual void SetCamera ( const CameraPtr &  _camera )

virtual

Set the camera that will be controlled by this view controller.

Parameters

[in]

_camera

Camera to control

Implements ViewController.

SetTarget()

virtual void SetTarget ( const math::Vector3d &  _target )

virtual

Set target point for pan, zoom, oribit.

Parameters

[in]

_target

Target point in world coordinates

Implements ViewController.

Target()

virtual math::Vector3d& Target ( ) const

virtual

Get target point for pan, zoom, oribit.

Returns

target point in world coordinates

Zoom()

virtual void Zoom ( const double  _value )

virtual

Set zoom amount.

Parameters

[in]

_value

Camera zoon value, e.g. mouse scroll delta

Implements ViewController.

Member Data Documentation

dataPtr

std::unique_ptr<OrbitViewControllerPrivate> dataPtr

Private data pointer.

---

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

• gz/rendering/OrbitViewController.hh