Struct ActiveCameraData

pub struct ActiveCameraData {
    pub entity: Option<Entity>,
    pub viewport_size: Option<Vec2>,
    pub window_size: Option<Vec2>,
    pub manual: bool,
}

Tracks which PanOrbitCamera is active (should handle input events), along with the window and viewport dimensions, which are used for scaling mouse motion. PanOrbitCameraPlugin manages this resource automatically, in order to support multiple viewports/windows. However, if this doesn’t work for you, you can take over and manage it yourself, e.g. when you want to control a camera that is rendering to a texture.

Fields

entity: Option<Entity>

ID of the entity with PanOrbitCamera that will handle user input. In other words, this is the camera that will move when you orbit/pan/zoom.

viewport_size: Option<Vec2>

The viewport size. This is only used to scale the panning mouse motion. I recommend setting this to the actual render target dimensions (e.g. the image or viewport), and changing PanOrbitCamera::pan_sensitivity to adjust the sensitivity if required.

window_size: Option<Vec2>

The size of the window. This is only used to scale the orbit mouse motion. I recommend setting this to actual dimensions of the window that you want to control the camera from, and changing PanOrbitCamera::orbit_sensitivity to adjust the sensitivity if required.

manual: bool

Indicates to PanOrbitCameraPlugin that it should not update/overwrite this resource. If you are manually updating this resource you should set this to true. Note that setting this to true will effectively break multiple viewport/window support unless you manually reimplement it.

Trait Implementations

impl Debug for ActiveCameraData

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

Formats the value using the given formatter.

impl Default for ActiveCameraData

fn default() -> ActiveCameraData

Returns the “default value” for a type.

impl PartialEq for ActiveCameraData

fn eq(&self, other: &ActiveCameraData) -> 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 Resource for ActiveCameraData

where Self: Send + Sync + 'static,

impl StructuralPartialEq for ActiveCameraData