Struct PanCamera 

pub struct PanCamera {

    pub enabled: bool,
    pub zoom_factor: f32,
    pub min_zoom: f32,
    pub max_zoom: f32,
    pub zoom_speed: f32,
    pub key_zoom_in: Option<KeyCode>,
    pub key_zoom_out: Option<KeyCode>,
    pub pan_speed: f32,
    pub key_up: Option<KeyCode>,
    pub key_down: Option<KeyCode>,
    pub key_left: Option<KeyCode>,
    pub key_right: Option<KeyCode>,
    pub rotation_speed: f32,
    pub key_rotate_ccw: Option<KeyCode>,
    pub key_rotate_cw: Option<KeyCode>,
}

Available on crate feature pan_camera only.

Configuration and state for a 2D panning camera controller.

Add this component to a Camera entity to enable keyboard and mouse controls for panning, zooming, and optional rotation. Requires the PanCameraPlugin.

Fields

enabled: bool

Enables this PanCamera when true.

zoom_factor: f32

Current zoom level (factor applied to camera scale).

min_zoom: f32

Minimum allowed zoom level.

max_zoom: f32

Maximum allowed zoom level.

zoom_speed: f32

Translation speed for panning movement.

key_zoom_in: Option<KeyCode>

KeyCode to zoom in.

key_zoom_out: Option<KeyCode>

KeyCode to zoom out.

pan_speed: f32

This PanCamera’s translation speed.

key_up: Option<KeyCode>

KeyCode for upward translation.

key_down: Option<KeyCode>

KeyCode for downward translation.

key_left: Option<KeyCode>

KeyCode for leftward translation.

key_right: Option<KeyCode>

KeyCode for rightward translation.

rotation_speed: f32

Rotation speed multiplier (in radians per second).

key_rotate_ccw: Option<KeyCode>

KeyCode for counter-clockwise rotation.

key_rotate_cw: Option<KeyCode>

KeyCode for clockwise rotation.

Trait Implementations

impl Component for PanCamera

where PanCamera: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<PanCamera>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Default for PanCamera

Provides the default values for the PanCamera controller.

The default settings are:

• Zoom factor: 1.0
• Min zoom: 0.1
• Max zoom: 5.0
• Zoom speed: 0.1
• Zoom in/out key: +/-
• Pan speed: 500.0
• Move up/down: W/S
• Move left/right: A/D
• Rotation speed: PI (radiradians per second)
• Rotation ccw/cw: Q/E

fn default() -> PanCamera

Provides the default values for the PanCamera controller.

Users can override these values by manually creating a PanCamera instance or modifying the default instance.

impl Display for PanCamera

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

Formats the value using the given formatter.