Struct three::controls::first_person::Builder

pub struct Builder { /* private fields */ }

Constructs custom FirstPerson controls.

Implementations

impl Builder

pub fn new<T: Object>(object: &T) -> Self

Create new Builder with default parameters.

pub fn yaw(&mut self, yaw: f32) -> &mut Self

Set the initial yaw angle in radians.

Default is 0.0.

pub fn pitch(&mut self, pitch: f32) -> &mut Self

Set the initial pitch angle in radians.

Defaults to 0.0.

pub fn pitch_range(&mut self, range: Option<Range<f32>>) -> &mut Self

Set the initial pitch range in radians.

Defaults to Some(-PI / 2.0 .. PI / 2.0).

pub fn position<P>(&mut self, position: P) -> &mut Selfwhere
    P: Into<Point3<f32>>,

Set the initial position.

Defaults to the world origin.

pub fn move_speed(&mut self, speed: f32) -> &mut Self

Setup the movement speed in world units per second.

Defaults to 1.0 world units per second.

pub fn look_speed(&mut self, speed: f32) -> &mut Self

Setup mouse sensitivity.

Defaults to 0.5

pub fn vertical_movement(&mut self, value: bool) -> &mut Self

Setup whether controlled object should move along y axis when looking down or up.

Defaults to true.

pub fn vertical_look(&mut self, value: bool) -> &mut Self

Setup whether controlled object can adjust pitch using mouse.

Defaults to true.

pub fn axis_forward(&mut self, axis: Option<Key>) -> &mut Self

Setup key axis for moving forward/backward.

Defaults to W and S keys.

pub fn axis_strafing(&mut self, axis: Option<Key>) -> &mut Self

Setup button for “strafing” left/right.

Defaults to A and D keys.

pub fn axis_vertical(&mut self, axis: Option<Key>) -> &mut Self

Setup button for moving up/down.

Defaults to None.

pub fn build(&mut self) -> FirstPerson

Finalize builder and create new FirstPerson controls.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder