Struct TerminalCamera

pub struct TerminalCamera {
    pub track_cursor: bool,
    /* private fields */
}

A camera component to assist in rendering terminals and translating cursor coordinates to and from terminal grid coordinates.

Fields

track_cursor: bool

Implementations

impl TerminalCamera

pub fn new() -> Self

pub fn cursor_world_pos(&self) -> Option<Vec2>

Returns the world position of the main window cursor using the last cached camera data.

Will return None if the camera data has not been initialized.

For accurate results this should be called after TerminalSystemsCacheCameraData which runs in PostUpdate.

pub fn cursor_viewport_pos(&self) -> Option<Vec2>

The viewport position of the main window cursor as of the last camera update.

Will return None if the camera data has not been initialized.

For accurate results this should be called after [TerminalSystemCameraCacheData] which runs in PostUpdate.

pub fn viewport_to_world(&self, viewport_position: Vec2) -> Option<Vec2>

Transform a viewport position to it’s corresponding world position using the last cached camera data.

If you are attempting to translate the cursor position to/from terminal grid coordinates, consider using TerminalCamera::cursor_world_pos along with TerminalTransform::world_to_tile instead.

Trait Implementations

impl Component for TerminalCamera

where Self: Send + Sync + 'static,

Required Components: Camera2d, Transform.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Default for TerminalCamera

fn default() -> Self

Returns the “default value” for a type.