Struct rin::graphics::camera::arcball_camera::Builder

pub struct Builder { /* fields omitted */ }

Implementations

impl Builder

pub fn new<S>(
    events_stream: S,
    window_size: Matrix<i32, U2, U1, <DefaultAllocator as Allocator<i32, U2, U1>>::Buffer>
) -> Builder where
    S: StreamExt<'static, Event>, 

Create an ArcballCameraBuilder from a window event stream and a window size

pub fn from_window<W>(window: &mut W) -> Builder where
    W: WindowExt, 

Creates an arcball camera Builder using a window to extract the needed info

Takes event_stream and viewport from the window passed as parameter

pub fn from_camera_view_events<S, C, V>(
    camera: C,
    event_stream: S,
    view_events: V,
    window_size: Matrix<i32, U2, U1, <DefaultAllocator as Allocator<i32, U2, U1>>::Buffer>
) -> ArcballCamera<C> where
    C: CameraExt,
    V: StreamExt<'static, ViewsEvent>,
    S: StreamExt<'static, Event>, 

pub fn from_camera<S, C>(
    camera: C,
    event_stream: S,
    window_size: Matrix<i32, U2, U1, <DefaultAllocator as Allocator<i32, U2, U1>>::Buffer>
) -> ArcballCamera<C> where
    C: CameraExt,
    S: StreamExt<'static, Event>, 

Create an ArcballCameraBuilder from an already existing camera

pub fn clip_planes(self, znear: f32, zfar: f32) -> Builder

Near and far clip planes

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

Up vector (defaults to Vec3::y_axis())

pub fn position(self, pos: Point<f32, U3>) -> Builder

Position of the camera (defaults to origin)

pub fn look_at(self, target: Point<f32, U3>) -> Builder

Position the camera will look at (defaults to pnt3(0., 0., -1))

pub fn fov(self, fov: Deg<f32>) -> Builder

pub fn aspect_ratio(self, aspect_ratio: f32) -> Builder

Aspect ratio of the viewport

pub fn do_roll(self, do_roll: bool) -> Builder

If the resulting camera will roll around the relative z axis when left mouse dragging outside a circle with a radius of the height of the screen (defaults to false)

pub fn view_events<S>(self, view_events: S) -> Builder where
    S: StreamExt<'static, ViewsEvent>, 

Custom view events to change the default keyboard mappings or use something enterely different from key presses

pub fn build(self) -> Result<ArcballCamera<Camera>, Error>

Create the arcball camera