Ignition Rendering

API Reference

6.3.1
List of all members | Public Member Functions
ViewController Class Referenceabstract

A camera view controller. More...

#include <ViewController.hh>

Public Member Functions

virtual ~ViewController ()
 Destructor. More...
 
virtual void Orbit (const math::Vector2d &_value)=0
 Set camera orbit (rotational movement) around target point. More...
 
virtual void Pan (const math::Vector2d &_value)=0
 Set camera pan (translational movement) around target point. More...
 
virtual void SetCamera (const CameraPtr &_camera)=0
 Set the camera that will be controlled by this view controller. More...
 
virtual void SetTarget (const math::Vector3d &_target)=0
 Set target point for pan, zoom, oribit. More...
 
virtual void Zoom (const double _value)=0
 Set zoom amount. More...
 

Detailed Description

A camera view controller.

ignition/rendering/ViewController.hh

Constructor & Destructor Documentation

◆ ~ViewController()

virtual ~ViewController ( )
inlinevirtual

Destructor.

References ViewController::Orbit(), ViewController::Pan(), ViewController::SetCamera(), ViewController::SetTarget(), and ViewController::Zoom().

Member Function Documentation

◆ Orbit()

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

Set camera orbit (rotational movement) around target point.

Parameters
[in]_valuerobit amount in image plane, e.g. mouse drag delta

Implemented in OrbitViewController, and OrthoViewController.

Referenced by ViewController::~ViewController().

◆ Pan()

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

Set camera pan (translational movement) around target point.

Parameters
[in]_valuePan amount in image plane, e.g. mouse drag delta.

Implemented in OrbitViewController, and OrthoViewController.

Referenced by ViewController::~ViewController().

◆ SetCamera()

virtual void SetCamera ( const CameraPtr &  _camera)
pure virtual

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

Parameters
[in]_cameraCamera to control

Implemented in OrbitViewController, and OrthoViewController.

Referenced by ViewController::~ViewController().

◆ SetTarget()

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

Set target point for pan, zoom, oribit.

Parameters
[in]_targetTarget point in world coordinates

Implemented in OrbitViewController, and OrthoViewController.

Referenced by ViewController::~ViewController().

◆ Zoom()

virtual void Zoom ( const double  _value)
pure virtual

Set zoom amount.

Parameters
[in]_valueCamera zoon value, e.g. mouse scroll delta

Implemented in OrbitViewController, and OrthoViewController.

Referenced by ViewController::~ViewController().

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