Struct Camera3D 

pub struct Camera3D {
    pub transform: NodeTransform,
    pub fov: f32,
    pub is_active: bool,
    pub priority: i32,
    pub exposure: f32,
    /* private fields */
}

A 3D camera that can be use in a 3d environment.

Fields

transform: NodeTransform

the NodeTransform of the camera (every node has this)

fov: f32

the field of view of the camera in radians

is_active: bool

priority: i32

exposure: f32

Implementations

impl Camera3D

pub fn new(fov: f32, near: f32, far: f32) -> Camera3D

Creates a new 3D camera

Arguments

• fov - The field of view of the camera
• near - The near plane of the camera
• far - The far plane of the camera

Returns

A new Camera3D

pub fn rotate_camera(&mut self, offset: impl Into<Vec3>, sensitivity: f32)

rotate the camera while keeping the roll at 0

Arguments

• offset - The offset to rotate the camera by a 3d vector
• sensitivity - The sensitivity of the rotation

pub fn set_position(&mut self, position: impl Into<Vec3>)

set the position of the camera

Arguments

• position - The new position of the camera

pub fn far_plane(&self) -> f32

pub fn near_plane(&self) -> f32

pub fn get_position(&self, parent_transform: NodeTransform) -> Vec3

get the world space position of the camera

Returns

The position of the camera

pub fn as_ptr(&self) -> *const Camera3D

cast the camera as a raw pointer

pub fn set_orientation_vector( &mut self, orientation: impl Into<Vec3>, ) -> &mut Camera3D

set the orientation vector of the camera

Arguments

• orientation - The new orientation vector of the camera

pub fn get_orientation_vector(&self) -> Vec3

get the orientation vector of the camera

Returns

The orientation vector of the camera

pub fn get_orientation_angles(&self) -> Vec3

get the orientation angles of the camera

Returns

The orientation angles of the camera

pub fn set_orientation_angles(&mut self, angles: impl Into<Vec3>)

set the orientation angles of the camera

Arguments

• angles - The new orientation angles of the camera

pub fn get_view_matrix(&self) -> Mat4

get the view matrix of the camera

Returns

The view matrix of the camera

pub fn get_projection_matrix(&self, aspect_ratio: f32) -> Mat4

get the projection matrix of the camera

Returns

The projection matrix of the camera

pub fn get_projection_matrix_with_planes( &self, aspect_ratio: f32, near: f32, far: f32, ) -> Mat4

useful for shadow mapping

pub fn get_vp_matrix(&self, aspect_ratio: f32) -> Mat4

get the view projection matrix of the camera

Returns

The view projection matrix of the camera

pub fn get_buffer_data(&self, aspect_ratio: f32) -> Camera3DBufferData

pub fn free_look(sensitivity: f32) -> impl Fn(EventCtx<'_, Update, Camera3D>)

allows the mouse to rotate the camera in a first person way.

this returns a function that can be used as a event_callback

uses camera.sensitivity to factor the look speed. add this function to the update callback to enable the camera to move with the mouse.

pub fn free_fly( speed: f32, sensitivity: f32, ) -> impl Fn(EventCtx<'_, Update, Camera3D>)

take input for the camera and implement basic free cam movement

this returns a function that can be used as a event_callback

Arguments

• input_manager - The input manager to get input from
• delta_time - The time between frames

Trait Implementations

impl Buildable for Camera3D

type Builder = Camera3DBuilder

Node Specific Builder

fn builder() -> <Camera3D as Buildable>::Builder

returns the Builder implementation for a given node

impl Node for Camera3D

fn get_transform(&mut self) -> &mut NodeTransform

gets the transform of the node.