Attaches a camera to an entity using springs. More...

#include <spring-arm-component.hpp>

Public Attributes
entity::id	parent_eid {entt::null}
	ID of the entity to which the spring arm is attached. More...

double	near_focal_plane_height {1.0}
	Height of the view frustum at the near clipping distance. More...

math::dquat	up_rotation {math::dquat::identity()}
	Local up rotation quaternion. More...

math::dquat	camera_rotation {math::dquat::identity()}
	Attached camera rotation. More...

math::dvec3	angular_velocities {}
	Pitch, yaw, and roll velocities, in radians per second. More...

math::dvec3	min_angles {-math::half_pi<double>, -std::numeric_limits<double>::infinity(), -std::numeric_limits<double>::infinity()}
	Minimum pitch, yaw, and roll angles, in radians. More...

math::dvec3	max_angles {math::half_pi<double>, std::numeric_limits<double>::infinity(), std::numeric_limits<double>::infinity()}
	Maximum pitch, yaw, and roll angles, in radians. More...

physics::numeric_spring< math::dvec3, double >	focal_point_spring

physics::numeric_spring< math::dvec3, double >	angles_spring
	Pitch, yaw, and roll angles spring. More...

double	far_focal_plane_height {50.0}
	Arm length spring. More...

double	near_hfov {math::radians(90.0)}
	Horizontal FoV at maximum zoom. More...

double	far_hfov {math::radians(45.0)}
	Horizontal FoV at minimum zoom. More...

double	zoom {}
	Zoom factor, on `[0, 1]`. More...

double	hfov {}
	Horizontal FoV of the camera, in radians. More...

double	vfov {}
	Vertical FoV of the camera, in radians. More...

math::dvec3	focal_point_offset {}
	Position of the focal point, relative to the subject. More...

double	focal_distance {}
	Distance to the focal plane. More...

double	focal_plane_width {}
	Width of the view frustum at the focal distance. More...

double	focal_plane_height {}
	Height of the view frustum at the focal distance. More...

Detailed Description

Attaches a camera to an entity using springs.

Definition at line 32 of file spring-arm-component.hpp.

Member Data Documentation

◆ angles_spring

physics::numeric_spring<math::dvec3, double> spring_arm_component::angles_spring

Pitch, yaw, and roll angles spring.

Definition at line 58 of file spring-arm-component.hpp.

◆ angular_velocities

math::dvec3 spring_arm_component::angular_velocities {}

Pitch, yaw, and roll velocities, in radians per second.

Definition at line 47 of file spring-arm-component.hpp.

◆ camera_rotation

math::dquat spring_arm_component::camera_rotation {math::dquat::identity()}

Attached camera rotation.

Definition at line 44 of file spring-arm-component.hpp.

◆ far_focal_plane_height

double spring_arm_component::far_focal_plane_height {50.0}

Arm length spring.

Height of the view frustum at the far clipping distance.

Definition at line 67 of file spring-arm-component.hpp.

◆ far_hfov

double spring_arm_component::far_hfov {math::radians(45.0)}

Horizontal FoV at minimum zoom.

Definition at line 73 of file spring-arm-component.hpp.

◆ focal_distance

double spring_arm_component::focal_distance {}

Distance to the focal plane.

Definition at line 88 of file spring-arm-component.hpp.

◆ focal_plane_height

double spring_arm_component::focal_plane_height {}

Height of the view frustum at the focal distance.

Definition at line 94 of file spring-arm-component.hpp.

◆ focal_plane_width

double spring_arm_component::focal_plane_width {}

Width of the view frustum at the focal distance.

Definition at line 91 of file spring-arm-component.hpp.

◆ focal_point_offset

math::dvec3 spring_arm_component::focal_point_offset {}

Position of the focal point, relative to the subject.

Definition at line 85 of file spring-arm-component.hpp.

◆ focal_point_spring

physics::numeric_spring<math::dvec3, double> spring_arm_component::focal_point_spring

Definition at line 55 of file spring-arm-component.hpp.

◆ hfov

double spring_arm_component::hfov {}

Horizontal FoV of the camera, in radians.

Definition at line 79 of file spring-arm-component.hpp.

◆ max_angles

math::dvec3 spring_arm_component::max_angles {math::half_pi<double>, std::numeric_limits<double>::infinity(), std::numeric_limits<double>::infinity()}

Maximum pitch, yaw, and roll angles, in radians.

Definition at line 53 of file spring-arm-component.hpp.

◆ min_angles

math::dvec3 spring_arm_component::min_angles {-math::half_pi<double>, -std::numeric_limits<double>::infinity(), -std::numeric_limits<double>::infinity()}

Minimum pitch, yaw, and roll angles, in radians.

Definition at line 50 of file spring-arm-component.hpp.

◆ near_focal_plane_height

double spring_arm_component::near_focal_plane_height {1.0}

Height of the view frustum at the near clipping distance.

Definition at line 38 of file spring-arm-component.hpp.

◆ near_hfov

double spring_arm_component::near_hfov {math::radians(90.0)}

Horizontal FoV at maximum zoom.

Definition at line 70 of file spring-arm-component.hpp.

◆ parent_eid

entity::id spring_arm_component::parent_eid {entt::null}

ID of the entity to which the spring arm is attached.

Definition at line 35 of file spring-arm-component.hpp.

◆ up_rotation

math::dquat spring_arm_component::up_rotation {math::dquat::identity()}

Local up rotation quaternion.

Definition at line 41 of file spring-arm-component.hpp.

◆ vfov

double spring_arm_component::vfov {}

Vertical FoV of the camera, in radians.

Definition at line 82 of file spring-arm-component.hpp.

◆ zoom

double spring_arm_component::zoom {}

Zoom factor, on [0, 1].

Definition at line 76 of file spring-arm-component.hpp.

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

spring-arm-component.hpp

Public Attributes