Struct FreeCamera 

pub struct FreeCamera {

    pub sensitivity: f32,
    pub key_forward: KeyCode,
    pub key_back: KeyCode,
    pub key_left: KeyCode,
    pub key_right: KeyCode,
    pub key_up: KeyCode,
    pub key_down: KeyCode,
    pub key_run: KeyCode,
    pub mouse_key_cursor_grab: MouseButton,
    pub keyboard_key_toggle_cursor_grab: KeyCode,
    pub walk_speed: f32,
    pub run_speed: f32,
    pub scroll_factor: f32,
    pub friction: f32,
}

Stores the settings for the FreeCamera controller.

This component defines static configuration for camera controls, including movement speed, sensitivity, and input bindings.

From the controller’s perspective, this data is treated as immutable, but it may be modified externally (e.g., by a settings UI) at runtime.

Add this component to a Camera entity to enable FreeCamera controls. The associated dynamic state is automatically handled by FreeCameraState, which is added to the entity as a required component.

To activate the controller, add the FreeCameraPlugin to your App.

Fields

sensitivity: f32

Multiplier for pitch and yaw rotation speed.

key_forward: KeyCode

KeyCode for forward translation.

key_back: KeyCode

KeyCode for backward translation.

key_left: KeyCode

KeyCode for left translation.

key_right: KeyCode

KeyCode for right translation.

key_up: KeyCode

KeyCode for up translation.

key_down: KeyCode

KeyCode for down translation.

key_run: KeyCode

KeyCode to use run_speed instead of walk_speed for translation.

mouse_key_cursor_grab: MouseButton

MouseButton for grabbing the mouse focus.

keyboard_key_toggle_cursor_grab: KeyCode

KeyCode for grabbing the keyboard focus.

walk_speed: f32

Base multiplier for unmodified translation speed.

run_speed: f32

Base multiplier for running translation speed.

scroll_factor: f32

Multiplier for how the mouse scroll wheel modifies walk_speed and run_speed.

friction: f32

Friction factor used to exponentially decay velocity over time.

Trait Implementations

impl Component for FreeCamera

where Self: Send + Sync + 'static,

Required Components: FreeCameraState.

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.

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<Self>>

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 FreeCamera

fn default() -> Self

Returns the “default value” for a type.

impl Display for FreeCamera

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

Formats the value using the given formatter.