Struct rin_graphics::camera::Camera

pub struct Camera { /* fields omitted */ }

Perspective camera that can be positioned and oriented in 3d space as a Node

Implementations

impl Camera

pub fn new(
    eye: Pnt3,
    look_at: Pnt3,
    up: Unit<Vec3>,
    fov: Deg<f32>,
    aspect_ratio: f32
) -> Result<Camera>

Create a new camera.

pub fn new_with_frustum(
    eye: Pnt3,
    look_at: Pnt3,
    up: Unit<Vec3>,
    fov: Deg<f32>,
    aspect_ratio: f32,
    znear: f32,
    zfar: f32
) -> Result<Camera>

Creates a new camera from frustum values.

pub fn with_pixel_coordinates(
    size: Vec2<i32>,
    fov: Deg<f32>,
    coordinate_origin: CoordinateOrigin
) -> Camera

Creates an orthographic camera ready to be used in two dimensional applications

The resulting view will have the same coordinates as the passed size and everything drawn at z = 0 within that viewport will be visible at it’s size in pixels

pub fn projection(&self) -> Mat4

Projection matrix

pub fn view(&self) -> Mat4

View matrix

pub fn projection_view(&self) -> Mat4

Projection * View

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

Vertical field of view

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

Horizontal field of view

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

Set vertical field of view

pub fn focal_length(&self) -> f32

Return the camera focal length in mm

pub fn set_focal_length(&mut self, f: f32)

Set the focal length in mm

Internally changes the field of view of the camera based on the current sensor width

pub fn set_sensor_width(&mut self, w: f32)

Set the camera sensor width in mm

Internally chanages the field of view of the camera based on the current focal length

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

Near and far clip planes as a tuple

pub fn near_clip(&self) -> f32

Near clip

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

Far clip

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

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

pub fn set_far_at_infinity(&mut self)

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

pub fn set_near_far<F: Into<Option<f32>>>(&mut self, near: f32, far: F)

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

pub fn target(&self) -> &Pnt3

Target the camera will look at, the target will change if the camera is moved or re-oriented

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

pub fn enable_depth_clamp(&mut self)

Enables depth clamping

Doesn’t really change the projection or view matrices of the camera but can be use as a flag to signal a renderer to do depth clamping.

pub fn disable_depth_clamp(&mut self)

Disables depth clamping

Doesn’t really change the projection or view matrices of the camera but can be use as a flag to signal a renderer to not do depth clamping.

pub fn depth_clamp(&self) -> bool

Returns if depth clamping is enabled

Doesn’t really change the projection or view matrices of the camera but can be use as a flag to signal a renderer to do depth clamping or not.

pub fn far_at_infinity(&self) -> bool

pub fn reversed_z(&self) -> bool

pub fn set_oblique_near_clip_plane<P: Into<Option<Vec4>>>(&mut self, plane: P)

Changes the projection matrix to set an oblique clip plane

Useful for reflections / refractions

pub fn oblique_clip_plane(&self) -> Option<&Vec4>

pub fn update(&mut self) -> bool

Call every frame to update the camera matrices

Returns true if the camera changed since the last udpate

Trait Implementations

impl CameraExt for Camera

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 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 aspect_ratio(&self) -> f32

fn target(&self) -> &Pnt3

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

fn set_target(&mut self, target: Pnt3)

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 update(&mut self) -> bool

impl CameraPerspective for Camera

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

fn set_near_with_far_at_infinity(&mut self, near: f32)

impl Clone for Camera

fn clone(&self) -> Camera

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Camera

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl NodeMut for Camera

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 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

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

impl NodeRef for Camera

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

impl Serialize for Camera

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.