Struct View

#[repr(C)]
pub struct View { /* private fields */ }

2D camera that defines what region is shown on screen

This is a very powerful concept: you can scroll, rotate or zoom the entire scene without altering the way that your drawable objects are drawn.

Implementations

impl View

Creation

pub fn new() -> SfResult<FBox<Self>>

Creates a default View of (0, 0, 1000, 1000)

pub fn with_center_and_size(center: Vector2f, size: Vector2f) -> FBox<View>

Creates a view with position and size

Arguments

• center - The center of the view
• size - The size of the view

pub fn from_rect(rectangle: FloatRect) -> SfResult<FBox<View>>

Construct a view from a rectangle

Arguments

• rectangle - The rectangle defining the zone to display

impl View

Query properties

pub fn rotation(&self) -> f32

Get the current orientation of a view

Return the rotation angle of the view, in degrees

pub fn center(&self) -> Vector2f

Get the center of a view

Return the center of the view

pub fn size(&self) -> Vector2f

Get the size of a view

Return the size of the view

pub fn viewport(&self) -> FloatRect

Get the target viewport rectangle of a view

Return the viewport rectangle, expressed as a factor of the target size

impl View

Set properties

pub fn set_rotation(&mut self, angle: f32)

Set the orientation of a view

The default rotation of a view is 0 degree.

Arguments

• angle - New angle, in degrees

pub fn rotate(&mut self, angle: f32)

Rotate a view relatively to its current orientation

Arguments

• angle - Angle to rotate, in degrees

pub fn zoom(&mut self, factor: f32)

Resize a view rectangle relatively to its current size

Resizing the view simulates a zoom, as the zone displayed on screen grows or shrinks.

factor is a multiplier:

• 1 keeps the size unchanged
• bigger than 1 makes the view bigger (objects appear smaller)
• smaller than 1 makes the view smaller (objects appear bigger)

Arguments

• factor - Zoom factor to apply

pub fn set_center<C: Into<Vector2f>>(&mut self, center: C)

Set the center of a view

Arguments

• center - New center

pub fn set_size<S: Into<Vector2f>>(&mut self, size: S)

Set the size of a view

Arguments

• size - New size of the view

pub fn move_<O: Into<Vector2f>>(&mut self, offset: O)

Move a view relatively to its current position

Arguments

• offset - Offset

pub fn set_viewport(&mut self, viewport: FloatRect)

Set the target viewport of a view

The viewport is the rectangle into which the contents of the view are displayed, expressed as a factor (between 0 and 1) of the size of the render target to which the view is applied. For example, a view which takes the left side of the target would be defined by a rect of (0, 0, 0.5, 1). By default, a view has a viewport which covers the entire target.

Arguments

• viewport - New viewport rectangle

pub fn reset(&mut self, rectangle: FloatRect)

Reset a view to the given rectangle

Note that this function resets the rotation angle to 0.

Arguments

• rectangle - Rectangle defining the zone to display

Trait Implementations

impl Debug for View

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

Formats the value using the given formatter.

impl Drop for View

fn drop(&mut self)

Executes the destructor for this type.

impl ToOwned for View

type Owned = FBox<View>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.