OrbitViewController Class Reference

A camera view controller. More...

#include <OrbitViewController.hh>

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

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

Detailed Description

A camera view controller.

gz/rendering/OrbitViewController.hh

Constructor & Destructor Documentation

OrbitViewController() [1/2]

OrbitViewController

(

)

Destructor.

OrbitViewController() [2/2]

OrbitViewController ( const CameraPtr &  _camera )

explicit

Destructor.

~OrbitViewController()

~OrbitViewController ( )

override

Destructor.

Member Function Documentation

Camera()

virtual CameraPtr Camera ( ) const

virtual

Get the camera that is controlled by this view controller.

Returns

Camera being controlled

Orbit()

void Orbit ( const math::Vector2d &  _value )

overridevirtual

Set camera orbit (rotational movement) around target point.

Parameters

[in]

_value

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

Implements ViewController.

Pan()

void Pan ( const math::Vector2d &  _value )

overridevirtual

Set camera pan (translational movement) around target point.

Parameters

[in]

_value

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

Implements ViewController.

SetCamera()

void SetCamera ( const CameraPtr &  _camera )

overridevirtual

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

Parameters

[in]

_camera

Camera to control

Implements ViewController.

SetTarget()

void SetTarget ( const math::Vector3d &  _target )

overridevirtual

Set target point for pan, zoom, orbit.

Parameters

[in]

_target

Target point in world coordinates

Implements ViewController.

Target()

virtual const math::Vector3d & Target ( ) const

virtual

Get target point for pan, zoom, orbit.

Returns

target point in world coordinates

Zoom()

void Zoom ( const double  _value )

overridevirtual

Set zoom amount.

Parameters

[in]

_value

Camera zoom 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:

• OrbitViewController.hh