Struct SceneCameraScreen 

pub struct SceneCameraScreen { /* private fields */ }

Shows a picture through a window: the cursor actions pan (held), Confirm steps the zoom 1× to MAX_ZOOM and round again, Cancel closes.

Implementations

impl SceneCameraScreen

pub const NAME: &'static str = "scene_camera"

Name reported by Screen::name.

pub fn new( console: ConsoleSpec, picture: Option<Rc<GlyphBuffer>>, layout: CameraLayout, missing: String, ) -> Self

The camera at 1× over the middle of picture, with layout on a console of console’s cells; missing is what it says without a picture.

pub fn picture(&self) -> Option<&Rc<GlyphBuffer>>

The picture shown, if there is one.

pub fn window_px(&self) -> (u32, u32)

The window’s size in console pixels.

pub fn centre(&self) -> (f32, f32)

The scene pixel in the middle of the window.

pub fn zoom(&self) -> u8

Console pixels per scene pixel: 1 to MAX_ZOOM.

pub fn origin_px(&self) -> (f32, f32)

The scene pixel at the window’s top-left (cinema::view).

pub fn view<G: GameData>(&self, ctx: &Ctx<G>) -> SceneCameraView

What the camera shows, naming the keys of the device used last.

Trait Implementations

impl Clone for SceneCameraScreen

fn clone(&self) -> SceneCameraScreen

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SceneCameraScreen

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

Formats the value using the given formatter.

impl<G: GameData> Screen<G> for SceneCameraScreen

fn actions(&self) -> Option<Vec<G::Action>>

Confirm zooms, Cancel closes, the held directions pan.

fn name(&self) -> &'static str

A stable, unique snake_case name, for tests and debugging.

fn update( &mut self, ctx: &mut Ctx<G>, input: &FrameInput<G::Action>, ) -> Transition<G>

Handles one frame: input holds this frame’s actions (often none) and elapsed time. Called only while this screen is on top.

fn draw(&self, ctx: &Ctx<G>, buf: &mut GlyphBuffer)

Paints the screen. An opaque screen must cover the whole buffer.

fn as_any(&self) -> Option<&dyn Any>

This screen as Any, for tests that look inside a screen on the stack (ScreenStack::find). None unless the screen opts in.

fn debug_draw(&self, ctx: &Ctx<G>, out: &mut Gizmos)

Hands in what the debug view shows of this screen (ADR-0085): its gizmos, each in its channel, in console pixels, built from self and ctx alone, so looking changes nothing. A channel’s helper (the grid kit’s layout_gizmos) does the work. Called after draw on every screen drawn, bottom up, only while debug tools are on (Ctx::debug_tools). Does nothing unless the screen has something to show.

fn is_overlay(&self) -> bool

Whether the screen below shows through (drawn first, then this one).

fn state_hash(&self) -> Option<StateHash>

The hash of the game’s state this screen holds, which goes in each frame’s hash in a session record (Game::state_hash), most simply shuyi_core::state_hash(&self.rules).ok(): so a playback that plays differently is found at the frame the state moved. None unless the screen opts in.

fn as_any_mut(&mut self) -> Option<&mut dyn Any>

as_any, mutable (ScreenStack::find_mut).

fn covered(&mut self, _ctx: &mut Ctx<G>)

Called when a screen is pushed on top of this one (Transition::Push): it is no longer updated until it is uncovered. Not called when the screen above swaps itself for another (Transition::Replace). Does nothing unless the screen needs it.

fn uncovered( &mut self, ctx: &mut Ctx<G>, result: Option<ScreenResult>, ) -> Transition<G>

Called when the screen above pops and this one is on top again: result is what it popped with (Transition::PopWith), None after a plain Transition::Pop. The transition returned is applied at once, as if from update, so a screen can act on the answer in the same frame: push the next screen, or pop with an answer of its own. By default, nothing happens.