Per-Canvas3D parameters of the ScenePic user interface. More...

#include <ui_parameters.h>

Public Member Functions
	UIParameters (double pointer_alt_key_multiplier=0.2, double pointer_rotation_speed=0.01, double mouse_wheel_translation_speed=0.005, double key_down_speed=0.1, const std::string &layer_dropdown_visibility="visible")
	Constructor. More...

double	pointer_alt_key_multiplier () const
	When the Alt key is pressed, mouse movement is scaled by this factor. More...

double	pointer_rotation_speed () const
	Linear scale factor of pointer translation into camera rotation. More...

double	mouse_wheel_translation_speed () const
	Linear scale factor of mouse wheel input into camera translation. More...

double	key_down_speed () const
	Movement speed from key presses. More...

const std::string &	layer_dropdown_visibility () const
	Whether the layer dropdown is visible. 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 "no ui parameters" instance. More...

Static Public Member Functions
static const UIParameters	None ()
	A UIParameters value indicating "no ui parameters". More...

Detailed Description

Per-Canvas3D parameters of the ScenePic user interface.

Constructor & Destructor Documentation

◆ UIParameters()

scenepic::UIParameters::UIParameters	(	double	pointer_alt_key_multiplier = `0.2`,
		double	pointer_rotation_speed = `0.01`,
		double	mouse_wheel_translation_speed = `0.005`,
		double	key_down_speed = `0.1`,
		const std::string &	layer_dropdown_visibility = `"visible"`
	)

Constructor.

Parameters

pointer_alt_key_multiplier	when the Alt key is pressed, mouse movement is scaled by this factor.
pointer_rotation_speed	linear scale factor of pointer translation into camera rotation.
mouse_wheel_translation_speed	linear scale factor of mouse wheel input into camera translation.
key_down_speed	movement speed from key presses
layer_dropdown_visibility	CSS visibility setting for the layer dropdown menu.

Member Function Documentation

◆ is_none()

bool scenepic::UIParameters::is_none ( ) const

Whether this is a "no ui parameters" instance.

◆ key_down_speed()

double scenepic::UIParameters::key_down_speed ( ) const

Movement speed from key presses.

◆ layer_dropdown_visibility()

const std::string & scenepic::UIParameters::layer_dropdown_visibility ( ) const

Whether the layer dropdown is visible.

◆ mouse_wheel_translation_speed()

double scenepic::UIParameters::mouse_wheel_translation_speed ( ) const

Linear scale factor of mouse wheel input into camera translation.

◆ None()

static const UIParameters scenepic::UIParameters::None ( )

static

A UIParameters value indicating "no ui parameters".

◆ pointer_alt_key_multiplier()

double scenepic::UIParameters::pointer_alt_key_multiplier ( ) const

When the Alt key is pressed, mouse movement is scaled by this factor.

◆ pointer_rotation_speed()

double scenepic::UIParameters::pointer_rotation_speed ( ) const

Linear scale factor of pointer translation into camera rotation.

◆ to_json()

JsonValue scenepic::UIParameters::to_json ( ) const

Convert this object into ScenePic json.

Returns: a json value

◆ to_string()

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

Return a JSON string representing the object.

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

src/include/scenepic/ui_parameters.h

Public Member Functions

Static Public Member Functions