ViewAngle Class Reference

Provides buttons for viewing angles. More...

#include <ViewAngle.hh>

Public Slots
void	OnAngleMode (int _x, int _y, int _z)
	Callback in Qt thread when angle mode changes.
void	OnViewControl (const QString &_controller)
	Callback in Qt thread when camera view controller changes.
void	OnViewControlReferenceVisual (bool _enable)
	Callback in Qt thread when camera view reference visual state changes.
void	OnViewControlSensitivity (double _sensitivity)
	Callback in Qt thread when camera view controller changes.
void	SetCamClipDist (double _near, double _far)
	Updates gui camera's near/far clipping distances.
void	SetCamPose (double _x, double _y, double _z, double _roll, double _pitch, double _yaw)
	Callback to update gui camera pose.
void	SetHorizontalFOV (double _horizontalFOV)
	Updates gui camera's Horizontal fov.

Signals
void	CamClipDistChanged ()
	Notify that the gui camera's near/far clipping distances changed.
void	CamHorizontalFOVChanged ()
	Notify that the gui camera's horizontal fov changed.
void	CamPoseChanged ()
	Notify that the gui camera pose has changed.
void	ViewControlIndexChanged ()
	Notify that the camera's view controller has changed.

Public Member Functions
	ViewAngle ()
	Constructor.
	~ViewAngle () override
	Destructor.
Q_INVOKABLE QList< double >	CamClipDist () const
	Get the current gui camera's near and far clipping distances.
Q_INVOKABLE QList< double >	CamPose () const
	Get the current gui camera pose.
void	CamPoseCb (const msgs::Pose &_msg)
	Callback for retrieving gui camera pose.
Q_INVOKABLE double	HorizontalFOV () const
	Get the current gui horizontal fov.
void	LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
bool	OnMoveToModelService (const gz::msgs::GUICamera &_msg, gz::msgs::Boolean &_res)
	Move to model service received.
int	ViewControlIndex () const
	Get the current index for view controller (on qml side)
Public Member Functions inherited from Plugin
	Plugin ()
virtual	~Plugin ()
QQuickItem *	CardItem () const
virtual std::string	ConfigStr ()
QQmlContext *	Context () const
bool	DeleteLaterRequested () const
void	Load (const tinyxml2::XMLElement *_pluginElem)
QQuickItem *	PluginItem () const
void	PostParentChanges ()
virtual std::string	Title () const

Properties
QList< double >	camClipDist
	gui camera near/far clipping distance (QList order is near, far)
QList< double >	camPose
	gui camera pose (QList order is x, y, z, roll, pitch, yaw)
double	horizontalFOV
	gui camera horizontal fov
int	viewControlIndex
	view controller index for qml side (0: orbit; 1: ortho)

Additional Inherited Members
Protected Member Functions inherited from Plugin
void	DeleteLater ()
Protected Attributes inherited from Plugin
std::string	configStr
std::string	title

Detailed Description

Provides buttons for viewing angles.

Configuration

<service> : Set the service to receive view angle requests. MinimalScene. Defaults to true.

Constructor & Destructor Documentation

ViewAngle()

ViewAngle

(

)

Constructor.

~ViewAngle()

~ViewAngle ( )

override

Destructor.

Member Function Documentation

CamClipDist()

Q_INVOKABLE QList< double > CamClipDist

(

)

const

Get the current gui camera's near and far clipping distances.

CamClipDistChanged

void CamClipDistChanged ( )

signal

Notify that the gui camera's near/far clipping distances changed.

CamHorizontalFOVChanged

void CamHorizontalFOVChanged ( )

signal

Notify that the gui camera's horizontal fov changed.

CamPose()

Q_INVOKABLE QList< double > CamPose

(

)

const

Get the current gui camera pose.

CamPoseCb()

void CamPoseCb

(

const msgs::Pose &

_msg

)

Callback for retrieving gui camera pose.

Parameters

[in]

_msg

Pose message

CamPoseChanged

void CamPoseChanged ( )

signal

Notify that the gui camera pose has changed.

HorizontalFOV()

Q_INVOKABLE double HorizontalFOV

(

)

const

Get the current gui horizontal fov.

LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem )

overridevirtual

Reimplemented from Plugin.

OnAngleMode

void OnAngleMode ( int  _x, int  _y, int  _z  )

slot

Callback in Qt thread when angle mode changes.

Parameters

[in]	_x	The x component of the directional vector for the camera to assume. All 0s for x, y, and z indicate the initial camera pose.
[in]	_y	The y component of the directional vector for the camera to assume. All 0s for x, y, and z indicate the initial camera pose.
[in]	_z	The z component of the directional vector for the camera to assume. All 0s for x, y, and z indicate the initial camera pose.

OnMoveToModelService()

bool OnMoveToModelService	(	const gz::msgs::GUICamera &	_msg,
		gz::msgs::Boolean &	_res
	)

Move to model service received.

Parameters

[in]	_msg	GUI camera message
[in]	_res	Response

OnViewControl

void OnViewControl ( const QString &  _controller )

slot

Callback in Qt thread when camera view controller changes.

Parameters

[in]

_mode

New camera view controller

OnViewControlReferenceVisual

void OnViewControlReferenceVisual ( bool  _enable )

slot

Callback in Qt thread when camera view reference visual state changes.

Parameters

[in]

_enable

True to enable camera view control reference visual, false to hide it

OnViewControlSensitivity

void OnViewControlSensitivity ( double  _sensitivity )

slot

Callback in Qt thread when camera view controller changes.

Parameters

[in]

_sensitivity

View control sensitivity value

SetCamClipDist

void SetCamClipDist ( double  _near, double  _far  )

slot

Updates gui camera's near/far clipping distances.

Parameters

[in]	_near	Near clipping plane distance
[in]	_far	Far clipping plane distance

SetCamPose

void SetCamPose ( double  _x, double  _y, double  _z, double  _roll, double  _pitch, double  _yaw  )

slot

Callback to update gui camera pose.

Parameters

[in]	_x,_y,_z	cartesian coordinates
[in]	_roll,_pitch,_yaw	principal coordinates

SetHorizontalFOV

void SetHorizontalFOV ( double  _horizontalFOV )

slot

Updates gui camera's Horizontal fov.

Parameters

[in]

_horizontalFOV

Horizontal fov

ViewControlIndex()

int ViewControlIndex

(

)

const

Get the current index for view controller (on qml side)

ViewControlIndexChanged

void ViewControlIndexChanged ( )

signal

Notify that the camera's view controller has changed.

Property Documentation

camClipDist

QList<double> camClipDist

read

gui camera near/far clipping distance (QList order is near, far)

camPose

QList<double> camPose

read

gui camera pose (QList order is x, y, z, roll, pitch, yaw)

horizontalFOV

double horizontalFOV

read

gui camera horizontal fov

viewControlIndex

int viewControlIndex

read

view controller index for qml side (0: orbit; 1: ortho)

---

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

• ViewAngle.hh