Struct StandardCameras 

pub struct StandardCameras { /* private fields */ }

Bundle of inputs specifying the “standard” configuration of Cameras and other things to render an All is Cubes scene and user interface.

All of its data is provided through listen::DynSources, and consists of:

• GraphicsOptions.
• A Viewport specifying the dimensions of image to render.
• A Handle to the Character whose eyes we look through to render the “world” Space.
• A Handle to the UI/HUD Space overlaid on the world, if any.

When StandardCameras::update() is called, all of these data sources are read and used to update the Camera data. Those cameras, and copies of the input data, are then available for use while rendering.

Because every input is a listen::DynSource, it is never necessary to call a setter. Every StandardCameras which was created with the same sources will have the same results (after update()).

Design note: The sense in which this is “standard” is that if an application wished to, for example, have multiple views into the same Space, it would need to create additional Cameras (or multiple StandardCameras) and update them itself.

Implementations

impl StandardCameras

pub fn update(&mut self, read_tickets: Layers<ReadTicket<'_>>) -> bool

Updates camera state from data sources.

This should be called at the beginning of each frame or as needed when the cameras are to be used.

Returns whether any values actually changed. (This does not include tracking changes to space content — only which part of which spaces are being looked at.)

pub fn graphics_options(&self) -> &GraphicsOptions

Returns current graphics options as of the last update().

These options are to be used for the world and not the UI.

pub fn graphics_options_source(&self) -> DynSource<Arc<GraphicsOptions>>

Returns a clone of the source of graphics options that this StandardCameras was created with.

These options are to be used for the world and not the UI.

pub fn cameras(&self) -> &Layers<Camera>

Returns Cameras appropriate for drawing each graphical layer.

pub fn character(&self) -> Option<&StrongHandle<Character>>

Returns the character’s viewpoint to draw in the world layer. May be None if there is no current character.

pub fn world_space(&self) -> DynSource<Option<Handle<Space>>>

Returns the space that should be drawn as the game world, using self.cameras().world.

This is a listen::DynSource to make it simple to cache the Space rendering data and follow space transitions. It updates when Self::update() is called.

pub fn ui_space(&self) -> Option<&Handle<Space>>

Returns the UI space, that should be drawn on top of the world using self.cameras().ui.

This implements GraphicsOptions::show_ui by returning None when the option is false.

TODO: Make this also a listen::DynSource

pub fn viewport(&self) -> Viewport

Returns the current viewport.

This is always equal to the viewports of all managed Cameras, and only updates when StandardCameras::update() is called.

pub fn viewport_source(&self) -> DynSource<Viewport>

Returns a clone of the viewport source this is following.

pub fn project_cursor( &self, read_tickets: Layers<ReadTicket<'_>>, ndc_pos: NdcPoint2, ) -> Result<Option<Cursor>, HandleError>

Perform a raycast through these cameras to find what the cursor hits.

Make sure to call StandardCameras::update first so that the cameras are up to date with game state.

pub fn clone_unupdated(&self) -> Self

Returns a StandardCameras which tracks the same data sources (graphics options, scene sources, viewport) as self, but whose local state (such as the last updated camera state) is independent.

The local state is also not updated; you must call StandardCameras::update() on the clone before reading anything from it.

Trait Implementations

impl Debug for StandardCameras

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

Formats the value using the given formatter.

impl Pointer for StandardCameras

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

Formats the value using the given formatter.