3D focus point for this frame (with optional 3D rotation for orientation lock), used in the ScenePic user interface. More...

#include <focus_point.h>

Public Member Functions
	FocusPoint (const Vector &position=Vector::Zero(), const Vector &orientation_axis_angle=VectorNone())
	Constructor. More...

std::string	to_string () const
	Return a JSON string representing the object. More...

JsonValue	to_json () const
	Convert this object into ScenePic json. More...

bool	is_none () const
	Whether this is a "none" focus point. More...

FocusPoint &	operator= (const Vector &position)
	Assignment operator. More...

const Vector &	position () const
	The position of the focus point. More...

const Vector &	orientation_axis_angle () const
	The orientation axis angle. More...

Static Public Member Functions
static FocusPoint	None ()
	A value indicating "no focus point". More...

Detailed Description

3D focus point for this frame (with optional 3D rotation for orientation lock), used in the ScenePic user interface.

Constructor & Destructor Documentation

◆ FocusPoint()

scenepic::FocusPoint::FocusPoint	(	const Vector &	position = `Vector::Zero()`,
		const Vector &	orientation_axis_angle = `VectorNone()`
	)

Constructor.

Parameters

position	the position of the focus point
orientation_axis_angle	the orientation axis angle

Member Function Documentation

◆ is_none()

bool scenepic::FocusPoint::is_none ( ) const

Whether this is a "none" focus point.

◆ None()

static FocusPoint scenepic::FocusPoint::None ( )

static

A value indicating "no focus point".

◆ operator=()

FocusPoint & scenepic::FocusPoint::operator= ( const Vector & position )

Assignment operator.

◆ orientation_axis_angle()

const Vector & scenepic::FocusPoint::orientation_axis_angle ( ) const

The orientation axis angle.

◆ position()

const Vector & scenepic::FocusPoint::position ( ) const

The position of the focus point.

◆ to_json()

JsonValue scenepic::FocusPoint::to_json ( ) const

Convert this object into ScenePic json.

Returns: a json value

◆ to_string()

std::string scenepic::FocusPoint::to_string ( ) const

Return a JSON string representing the object.

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

src/include/scenepic/focus_point.h

Public Member Functions

Static Public Member Functions