Struct rin::graphics::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> ArcballCamera<C> where
    C: CameraExt + NodeMut, 

pub fn target(&self) -> &Point<f32, U3>

pub fn set_target(&mut self, target: Point<f32, U3>)

pub fn camera(&self) -> &C

pub fn update(&mut self) -> bool

Trait Implementations

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

pub fn projection(
    &self
) -> Matrix<f32, U4, U4, <DefaultAllocator as Allocator<f32, U4, U4>>::Buffer>

pub fn view(
    &self
) -> Matrix<f32, U4, U4, <DefaultAllocator as Allocator<f32, U4, U4>>::Buffer>

pub fn projection_view(
    &self
) -> Matrix<f32, U4, U4, <DefaultAllocator as Allocator<f32, U4, U4>>::Buffer>

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

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

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

pub fn near_clip(&self) -> f32

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

pub fn set_near(&mut self, near: f32)

pub fn set_far(&mut self, far: f32)

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

pub fn set_aspect_ratio(&mut self, aspect: f32)

pub fn aspect_ratio(&self) -> f32

pub fn target(&self) -> &Point<f32, U3>

pub fn set_target(&mut self, target: Point<f32, U3>)

pub fn up(
    &self
) -> &Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>

pub fn enable_depth_clamp(&mut self)

Enables depth clamping

pub fn disable_depth_clamp(&mut self)

Disables depth clamping

pub fn depth_clamp(&self) -> bool

Returns if depth clamping is enabled

pub fn set_reversed_z(&mut self, reversed_z: bool)

pub fn reversed_z(&self) -> bool

pub fn far_at_infinity(&self) -> bool

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

Horizontal field of view

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

Return the camera focal length

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

Return the camera sensor width

pub fn update(&mut self) -> bool

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

pub fn set_width(&mut self, width: f32)

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

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

pub fn set_near_with_far_at_infinity(&mut self, near: f32)

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

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

pub 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

pub 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

pub fn look_at(
    &mut self,
    at: &Point<f32, U3>,
    up: &Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>
) -> Result<(), Error>

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

pub fn rotate(
    &mut self,
    angle: Rad<f32>,
    axis: &Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>
)

Rotate this note a certain angle around the axis of rotation

pub fn append_orientation(&mut self, orientation: &Unit<Quaternion<f32>>)

Append the passed quaternion to the current local orientation

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

rotate this node around it’s local x axis

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

rotate this node around it’s local y axis

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

rotate this node around it’s local z axis

pub fn set_scale(
    &mut self,
    Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>
)

Sets the local scale

pub fn translate(
    &mut self,
    t: &Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>
)

Append a translation to the current local position

pub fn set_position(&mut self, pos: Point<f32, U3>)

Sets the local position of this node

pub fn set_angle_axis(
    &mut self,
    angle: Rad<f32>,
    axis: &Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>
)

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

pub fn set_orientation(&mut self, orientation: Unit<Quaternion<f32>>)

Sets the orientation for this node from a quaternion

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

pub fn node(&self) -> &Node

Returns this object’s Node

pub fn position(&self) -> Point<f32, U3>

Returns the local position of this node

pub fn orientation(&self) -> Unit<Quaternion<f32>>

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

pub fn rotation(&self) -> Rotation<f32, U3>

Returns the orientation of this node as a Rotation3.

pub fn scale(
    &self
) -> Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>

Returns the current local scale

pub fn local_x_axis(
    &self
) -> Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>

The node orientation x axis

pub fn local_y_axis(
    &self
) -> Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>

The node orientation y axis

pub fn local_z_axis(
    &self
) -> Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>

The node orientation z axis

pub fn global_x_axis(
    &self
) -> Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>

The node orientation x axis

pub fn global_y_axis(
    &self
) -> Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>

The node orientation y axis

pub fn global_z_axis(
    &self
) -> Unit<Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>>

The node orientation z axis

pub fn local_transformation(
    &self
) -> Matrix<f32, U4, U4, <DefaultAllocator as Allocator<f32, U4, U4>>::Buffer>

Local transformation matrix

pub fn global_transformation(
    &self
) -> Matrix<f32, U4, U4, <DefaultAllocator as Allocator<f32, U4, U4>>::Buffer>

Global transformation matrix

pub fn global_position(&self) -> Point<f32, U3>

Global position of this node

pub fn global_orientation(&self) -> Unit<Quaternion<f32>>

Global orientation of this node

pub fn global_scale(
    &self
) -> Matrix<f32, U3, U1, <DefaultAllocator as Allocator<f32, U3, U1>>::Buffer>

Global scale of this node

pub fn inv_local_transformation(
    &self
) -> Matrix<f32, U4, U4, <DefaultAllocator as Allocator<f32, U4, U4>>::Buffer>

Inverse local transformation of this node

pub fn inv_global_transformation(
    &self
) -> Matrix<f32, U4, U4, <DefaultAllocator as Allocator<f32, U4, U4>>::Buffer>

Inverse global transformation of this node