Struct TrackballViewport

pub struct TrackballViewport { /* private fields */ }

Trackball viewport currently focused and hence capturing input events.

• Enables multiple viewports/windows with individual controllers/cameras.
• Enables UI systems to steal the viewport in order to capture input events.

Implementations

impl TrackballViewport

pub fn stolen(viewport: Res<'_, Self>) -> bool

Condition whether the viewport has been stolen, evaluated by IntoScheduleConfigs::run_if.

Interferes with automatic viewport stealing if the bevy_egui feature is enabled. As automatic viewport stealing gives the viewport back with set_stolen(None) instead of set_stolen(Some(0)), you can override it in the same frame for your own input capturing.

pub const fn was_stolen(&self) -> bool

Whether viewport has just been given back.

Interferes with automatic viewport stealing if the bevy_egui feature is enabled. As automatic viewport stealing gives the viewport back with set_stolen(None) instead of set_stolen(Some(0)), you can override it in the same frame for your own input capturing.

pub const fn set_stolen(&mut self, stolen: Option<usize>)

Steals the viewport or gives it back.

Interferes with automatic viewport stealing if the bevy_egui feature is enabled. As automatic viewport stealing gives the viewport back with set_stolen(None) instead of set_stolen(Some(0)), you can override it in the same frame for your own input capturing.

Examples

Steals the viewport for Some(frames) and lets it count frames down with None:

fn system(/* ... */) {
	viewport.set_stolen(just_stolen.then_some(3));
}

// frame 0: just_stolen = true  -> set_stolen(Some(3)) -> frames = 3 -> stolen = true
// frame 1: just_stolen = false -> set_stolen(None)    -> frames = 2 -> stolen = true
// frame 2: just_stolen = false -> set_stolen(None)    -> frames = 1 -> stolen = true
// frame 3: just_stolen = false -> set_stolen(None)    -> frames = 0 -> stolen = false

Steals the viewport with Some(1) and gives it back with Some(0):

fn system(/* ... */) {
	if just_stolen {
		viewport.set_stolen(Some(1));
	}
	if just_give_back {
		viewport.set_stolen(Some(0));
	}
}

// frame  0: just_stolen = true    -> set_stolen(Some(1)) -> frames = 1 -> stolen = true
// frame  1: just_stolen = false   ->                     -> frames = 1 -> stolen = true
// frame 25: just_stolen = false   ->                     -> frames = 1 -> stolen = true
// frame 50: just_give_back = true -> set_stolen(Some(0)) -> frames = 0 -> stolen = false

Trait Implementations

impl Clone for TrackballViewport

fn clone(&self) -> TrackballViewport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrackballViewport

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

Formats the value using the given formatter.

impl Default for TrackballViewport

fn default() -> TrackballViewport

Returns the “default value” for a type.

impl PartialEq for TrackballViewport

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

impl Resource for TrackballViewport

where Self: Send + Sync + 'static,

impl StructuralPartialEq for TrackballViewport