Struct rin_graphics::camera::arcball_camera::ArcballCamera

pub struct ArcballCamera<C = Camera> { /* fields omitted */ }

Arcball interactive camera that can be controlled with the mouse and keys

By default:

• left mouse drag will rotate the camera around it’s target
• mouse wheel scroll will move camera towards or apart from it’s target for perspective cameras and zoom in/out for orthographic ones
• middle mouse drag translate the camera and it’s target
• keypad 1 will switch front and back views, that is target position plus or minus current distance from camera to target in z axis relative to the camera up axis as y
• keypad 3 will switch left and right views similar to front/back but in the relative x axis
• keypad 7 will switch top and bottom views similat to front/back but in the relative y axis

The key mappings can be modified using a custom ViewEvents stream

Implementations

impl<C: CameraExt + NodeMut> ArcballCamera<C>

pub fn target(&self) -> &Pnt3

pub fn set_target(&mut self, target: Pnt3)

pub fn camera(&self) -> &C

pub fn update(&mut self) -> bool

Trait Implementations

impl<C: CameraExt + NodeMut> CameraExt for ArcballCamera<C>

fn projection(&self) -> Mat4

fn view(&self) -> Mat4

fn projection_view(&self) -> Mat4

fn fov(&self) -> Option<Deg<f32>>

fn width(&self) -> Option<f32>

fn near_far_clip(&self) -> (f32, Option<f32>)

fn near_clip(&self) -> f32

fn far_clip(&self) -> Option<f32>

fn set_near(&mut self, near: f32)

fn set_far(&mut self, far: f32)

fn set_near_far(&mut self, near: f32, far: f32)

fn set_aspect_ratio(&mut self, aspect: f32)

fn aspect_ratio(&self) -> f32

fn target(&self) -> &Pnt3

fn set_target(&mut self, target: Pnt3)

fn up(&self) -> &Unit<Vec3>

fn enable_depth_clamp(&mut self)

Enables depth clamping

fn disable_depth_clamp(&mut self)

Disables depth clamping

fn depth_clamp(&self) -> bool

Returns if depth clamping is enabled

fn set_reversed_z(&mut self, reversed_z: bool)

fn reversed_z(&self) -> bool

fn far_at_infinity(&self) -> bool

fn hfov(&self) -> Option<Deg<f32>>

Horizontal field of view

fn focal_length(&self) -> Option<f32>

Return the camera focal length

fn sensor_width_mm(&self) -> Option<f32>

Return the camera sensor width

fn update(&mut self) -> bool

impl<C: CameraOrthographic + NodeMut> CameraOrthographic for ArcballCamera<C>

fn set_width(&mut self, width: f32)

impl<C: CameraPerspective + NodeMut> CameraPerspective for ArcballCamera<C>

fn set_fov(&mut self, fov: Deg<f32>)

fn set_near_with_far_at_infinity(&mut self, near: f32)

impl<C: NodeMut> NodeMut for ArcballCamera<C>

fn node_mut(&mut self) -> &mut Node

fn update_with_parent_parts(
    &mut self,
    parent_loc: Option<&Node>,
    parent_orientation: Option<&Node>,
    parent_scale: Option<&Node>
) -> bool

Updates the internal matrices including the glonal matrices using the optional parent passed as argument and flags

fn update_with_parent(&mut self, parent: Option<&Node>) -> bool

Updates the internal matrices including the glonal matrices using the optional parent passed as argument

fn look_at(&mut self, at: &Pnt3, up: &Vec3) -> Result<()>

Changes the orientation of the node to look at the passed position using the up vector

fn rotate(&mut self, angle: Rad<f32>, axis: &Unit<Vec3>)

Rotate this note a certain angle around the axis of rotation

fn append_orientation(&mut self, orientation: &UnitQuat)

Append the passed quaternion to the current local orientation

fn tilt(&mut self, angle: Rad<f32>)

rotate this node around it’s local x axis

fn pan(&mut self, angle: Rad<f32>)

rotate this node around it’s local y axis

fn roll(&mut self, angle: Rad<f32>)

rotate this node around it’s local z axis

fn set_scale(&mut self, _: Vec3)

Sets the local scale

fn translate(&mut self, t: &Vec3)

Append a translation to the current local position

fn set_position(&mut self, pos: Pnt3)

Sets the local position of this node

fn set_angle_axis(&mut self, angle: Rad<f32>, axis: &Unit<Vec3>)

Sets the orientation for this node from an angle and axis of rotation

fn set_orientation(&mut self, orientation: UnitQuat)

Sets the orientation for this node from a quaternion

impl<C: NodeRef> NodeRef for ArcballCamera<C>

fn node(&self) -> &Node

Returns this object’s Node

fn position(&self) -> Pnt3

Returns the local position of this node

fn orientation(&self) -> UnitQuat

Returns the orientation of this node as a quaternion which is how it’s stored internally

fn rotation(&self) -> Rotation3<f32>

Returns the orientation of this node as a Rotation3.

fn scale(&self) -> Vec3

Returns the current local scale

fn local_x_axis(&self) -> Unit<Vec3>

The node orientation x axis

fn local_y_axis(&self) -> Unit<Vec3>

The node orientation y axis

fn local_z_axis(&self) -> Unit<Vec3>

The node orientation z axis

fn global_x_axis(&self) -> Unit<Vec3>

The node orientation x axis

fn global_y_axis(&self) -> Unit<Vec3>

The node orientation y axis

fn global_z_axis(&self) -> Unit<Vec3>

The node orientation z axis

fn local_transformation(&self) -> Mat4

Local transformation matrix

fn global_transformation(&self) -> Mat4

Global transformation matrix

fn global_position(&self) -> Pnt3

Global position of this node

fn global_orientation(&self) -> UnitQuat

Global orientation of this node

fn global_scale(&self) -> Vec3

Global scale of this node

fn inv_local_transformation(&self) -> Mat4

Inverse local transformation of this node

fn inv_global_transformation(&self) -> Mat4

Inverse global transformation of this node