Struct bevy_tiled_camera::TiledCamera

pub struct TiledCamera {
    pub pixels_per_tile: UVec2,
    pub tile_count: UVec2,
    /* private fields */
}

A camera with a virtual grid for displaying low resolution pixel art.

Contains various functions for translating points between world space and the camera’s virtual grid tiles.

Fields

pixels_per_tile: UVec2

Pixels per tile determines the size of your tiles/art, depending on the camera’s WorldSpace.

tile_count: UVec2

The number of virtual grid tiles in the camera’s viewport.

Implementations

impl TiledCamera

pub fn unit_cam(tile_count: impl Size2d, pixels_per_tile: impl Size2d) -> Self

Creates a camera set to WorldSpace::Units.

pub fn pixel_cam(tile_count: impl Size2d, pixels_per_tile: impl Size2d) -> Self

Creates a camera set to WorldSpace::Pixels.

pub fn target_resolution(&self) -> UVec2

Retrieve the target resolution (in pixels) of the camera.

pub fn viewport_size(&self) -> UVec2

pub fn viewport_pos(&self) -> UVec2

pub fn window_resolution(&self) -> UVec2

Window resolution from the last viewport update

pub fn orthographic_size(&self) -> f32

The orthographic size of the camera from the last viewport update

pub fn tile_center_iter( &self, transform: &GlobalTransform ) -> impl Iterator<Item = Vec2>

Returns an iterator that yields the center of the camera’s virtual grid tiles in world space.

pub fn tile_pos_iter( &self, cam_transform: &GlobalTransform ) -> impl Iterator<Item = Vec2>

Returns an iterator that yields the position of the camera’s virtual grid tiles in world space.

A tile’s “position” refers to the bottom left corner of the tile.

pub fn world_to_local( &self, cam_transform: &GlobalTransform, world_pos: impl Point2d ) -> Vec2

Transform from world space to camera-local space.

pub fn local_to_world( &self, cam_transform: &GlobalTransform, local_pos: impl Point2d ) -> Vec2

Transform from camera-local space to world space.

pub fn world_to_index( &self, cam_transform: &GlobalTransform, world_pos: impl Point2d ) -> IVec2

Convert a world position to it’s virtual tile index.

Tile indices are relative to the camera center.

pub fn world_to_tile( &self, cam_transform: &GlobalTransform, world_pos: impl Point2d ) -> Vec2

Convert a world position to it’s virtual tile position.

A tile’s “position” refers to the bottom left point of the tile.

pub fn index_to_tile_pos( &self, cam_transform: &GlobalTransform, pos: impl GridPoint ) -> Vec2

Convert a tile index to it’s virtual tile position in world space.

Tiles indices are relative to the camera center.

A tile’s “position” refers to the bottom left point of the tile.

pub fn index_to_tile_center( &self, cam_transform: &GlobalTransform, index: impl GridPoint ) -> Vec2

Return the world center of the virtual tile at the given tile index.

Tile indices are relative to the camera center.

pub fn set_world_space(&mut self, world_space: WorldSpace)

Change the camera’s WorldSpace.

pub fn world_space(&self) -> WorldSpace

Get the camera’s WorldSpace.

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

Get unit size or None, depending on the camera’s WorldSpace.

This can be used for sizing spawned sprites. If the camera’s WorldSpace is WorldSpace::Units then a unit sized sprite should be the size of a tile. Otherwise it should use the default sprite size, which is the pixel dimensions of the sprite’s texture.

pub fn zoom(&self) -> u32

How much the camera view is scaled up, based on target resolution and window size.

pub fn screen_to_world( &self, screen_pos: Vec2, camera: &Camera, camera_transform: &GlobalTransform ) -> Option<Vec2>

Convert a screen position (IE: The mouse cursor position) to it’s corresponding world position.

pub fn world_to_screen( &self, world_pos: impl Point2d, camera: &Camera, camera_transform: &GlobalTransform ) -> Option<Vec2>

Converts a world position to a screen position (0..resolution)

pub fn world_grid(&self) -> &WorldGrid

Retrieve the camera’s WorldGrid.

Trait Implementations

impl Component for TiledCamera

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Default for TiledCamera

fn default() -> Self

Returns the “default value” for a type.