Struct OrbitCam 

pub struct OrbitCam {

    pub focus: Vec3,
    pub radius: Option<f32>,
    pub yaw: Option<f32>,
    pub pitch: Option<f32>,
    pub target_focus: Vec3,
    pub target_yaw: f32,
    pub target_pitch: f32,
    pub target_radius: f32,
    pub yaw_upper_limit: Option<f32>,
    pub yaw_lower_limit: Option<f32>,
    pub pitch_upper_limit: Option<f32>,
    pub pitch_lower_limit: Option<f32>,
    pub focus_bounds_origin: Vec3,
    pub focus_bounds_shape: Option<FocusBoundsShape>,
    pub zoom_upper_limit: Option<f32>,
    pub zoom_lower_limit: f32,
    pub orbit_sensitivity: f32,
    pub orbit_smoothness: f32,
    pub pan_sensitivity: f32,
    pub pan_smoothness: f32,
    pub zoom_sensitivity: f32,
    pub zoom_smoothness: f32,
    pub button_orbit: MouseButton,
    pub button_pan: MouseButton,
    pub button_zoom: Option<MouseButton>,
    pub button_zoom_axis: ButtonZoomAxis,
    pub modifier_orbit: Option<KeyCode>,
    pub modifier_pan: Option<KeyCode>,
    pub input_control: Option<InputControl>,
    pub upside_down_policy: UpsideDownPolicy,
    pub initialization: InitializationState,
    pub force_update: ForceUpdate,
    pub axis: [Vec3; 3],
    pub time_source: TimeSource,
}

Tags an entity as capable of panning and orbiting.

Provides a way to configure the camera’s behaviour and controls.

Example

fn setup(mut commands: Commands) {
    commands.spawn((
        Transform::from_translation(Vec3::new(0.0, 1.5, 5.0)),
        OrbitCam::default(),
    ));
}

Fields

focus: Vec3

The point to orbit around, and what the camera looks at. Updated automatically. If you want to change the focus programmatically after initialization, set target_focus instead. Defaults to Vec3::ZERO.

radius: Option<f32>

The radius of the orbit, or the distance from the focus point. For orthographic projection, this is ignored, and the projection’s scale is used instead. If set to None, it will be calculated from the camera’s current position during initialization. Automatically updated. Defaults to None.

yaw: Option<f32>

Rotation in radians around the global Y axis (longitudinal). Updated automatically. If both yaw and pitch are 0.0, then the camera will be looking forward, i.e. in the Vec3::NEG_Z direction, with up being Vec3::Y. If set to None, it will be calculated from the camera’s current position during initialization. You should not update this after initialization - use target_yaw instead. Defaults to None.

pitch: Option<f32>

Rotation in radians around the local X axis (latitudinal). Updated automatically. If both yaw and pitch are 0.0, then the camera will be looking forward, i.e. in the Vec3::NEG_Z direction, with up being Vec3::Y. If set to None, it will be calculated from the camera’s current position during initialization. You should not update this after initialization - use target_pitch instead. Defaults to None.

target_focus: Vec3

The target focus point. The camera will smoothly transition to this value. Updated automatically, but you can also update it manually to control the camera independently of the mouse controls, e.g. with the keyboard. Defaults to Vec3::ZERO.

target_yaw: f32

The target yaw value. The camera will smoothly transition to this value. Updated automatically, but you can also update it manually to control the camera independently of the mouse controls, e.g. with the keyboard. Defaults to 0.0.

target_pitch: f32

The target pitch value. The camera will smoothly transition to this value Updated automatically, but you can also update it manually to control the camera independently of the mouse controls, e.g. with the keyboard. Defaults to 0.0.

target_radius: f32

The target radius value. The camera will smoothly transition to this value. Updated automatically, but you can also update it manually to control the camera independently of the mouse controls, e.g. with the keyboard. Defaults to 1.0.

yaw_upper_limit: Option<f32>

Upper limit on the yaw value, in radians. Use this to restrict the maximum rotation around the global Y axis. Defaults to None.

yaw_lower_limit: Option<f32>

Lower limit on the yaw value, in radians. Use this to restrict the maximum rotation around the global Y axis. Defaults to None.

pitch_upper_limit: Option<f32>

Upper limit on the pitch value, in radians. Use this to restrict the maximum rotation around the local X axis. Defaults to None.

pitch_lower_limit: Option<f32>

Lower limit on the pitch value, in radians. Use this to restrict the maximum rotation around the local X axis. Defaults to None.

focus_bounds_origin: Vec3

The origin for a shape to restrict the cameras focus position. Defaults to Vec3::ZERO.

focus_bounds_shape: Option<FocusBoundsShape>

The shape (Sphere or Cuboid) that the focus is restricted by. Centered on the focus_bounds_origin. Defaults to None.

zoom_upper_limit: Option<f32>

Upper limit on the zoom. This applies to radius, in the case of using a perspective camera, or the projection’s scale in the case of using an orthographic camera. Defaults to None.

zoom_lower_limit: f32

Lower limit on the zoom. This applies to radius, in the case of using a perspective camera, or the projection’s scale in the case of using an orthographic camera. Should always be >0 otherwise you’ll get stuck at 0. Defaults to 1e-7.

orbit_sensitivity: f32

The sensitivity of the orbiting motion. A value of 0.0 disables orbiting. Defaults to 1.0.

orbit_smoothness: f32

How much smoothing is applied to the orbit motion. A value of 0.0 disables smoothing, so there’s a 1:1 mapping of input to camera position. A value of 1.0 is infinite smoothing. Defaults to 0.8.

pan_sensitivity: f32

The sensitivity of the panning motion. A value of 0.0 disables panning. Defaults to 1.0.

pan_smoothness: f32

How much smoothing is applied to the panning motion. A value of 0.0 disables smoothing, so there’s a 1:1 mapping of input to camera position. A value of 1.0 is infinite smoothing. Defaults to 0.6.

zoom_sensitivity: f32

The sensitivity of moving the camera closer or further way using the scroll wheel. A value of 0.0 disables zooming. Defaults to 1.0.

zoom_smoothness: f32

How much smoothing is applied to the zoom motion. A value of 0.0 disables smoothing, so there’s a 1:1 mapping of input to camera position. A value of 1.0 is infinite smoothing. Defaults to 0.8. Note that this setting does not apply to pixel-based scroll events, as they are typically already smooth. It only applies to line-based scroll events.

button_orbit: MouseButton

Button used to orbit the camera. Defaults to Button::Left.

button_pan: MouseButton

Button used to pan the camera. Defaults to Button::Right.

button_zoom: Option<MouseButton>

Button used to zoom the camera, by holding it down and moving the mouse forward and back. Defaults to None.

button_zoom_axis: ButtonZoomAxis

Which axis should zoom the camera when using button_zoom. Defaults to ButtonZoomAxis::Y.

modifier_orbit: Option<KeyCode>

Key that must be pressed for button_orbit to work. Defaults to None (no modifier).

modifier_pan: Option<KeyCode>

Key that must be pressed for button_pan to work. Defaults to None (no modifier).

input_control: Option<InputControl>

Interactive input configuration. Set to None to disable all user input for this camera. Defaults to Some(InputControl::default()).

upside_down_policy: UpsideDownPolicy

Whether to allow the camera to go upside down. Defaults to UpsideDownPolicy::Prevent.

initialization: InitializationState

Whether OrbitCam has been initialized with the initial config. Set to InitializationState::Complete if you want the camera to smoothly animate to its initial position. Defaults to InitializationState::Pending.

force_update: ForceUpdate

Whether to update the camera’s transform regardless of whether there are any changes/input. Set to ForceUpdate::Pending if you want to modify values directly. This will be automatically set back to ForceUpdate::Idle after one frame. Defaults to ForceUpdate::Idle.

axis: [Vec3; 3]

Axis order definition. This can be used to e.g. define a different default up direction. The default up is Y, but if you want the camera rotated. The axis can be switched. Defaults to [Vec3::X, Vec3::Y, Vec3::Z].

time_source: TimeSource

Which time source drives camera smoothing. Defaults to TimeSource::Virtual.

Trait Implementations

impl Clone for OrbitCam

fn clone(&self) -> OrbitCam

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for OrbitCam

where Self: Send + Sync + 'static,

Required Components: Camera3d, [OrbitDragState].

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 Debug for OrbitCam

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

Formats the value using the given formatter.

impl Default for OrbitCam

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for OrbitCam

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for OrbitCam

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for OrbitCam

fn eq(&self, other: &OrbitCam) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for OrbitCam

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for OrbitCam

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Struct for OrbitCam

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for OrbitCam

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for OrbitCam

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for OrbitCam

impl StructuralPartialEq for OrbitCam