pub struct Scope<N>{ /* private fields */ }
Expand description
Scope defining enclosing viewing frustum.
Implements Default
and can be created with Scope::default()
.
Implementations§
Source§impl<N> Scope<N>
impl<N> Scope<N>
Sourcepub const fn fov(&self) -> Fixed<N>
pub const fn fov(&self) -> Fixed<N>
Fixed quantity wrt field of view, see Self::set_fov()
.
Sourcepub fn set_fov(&mut self, fov: impl Into<Fixed<N>>)
pub fn set_fov(&mut self, fov: impl Into<Fixed<N>>)
Sets fixed quantity wrt field of view.
Default is fixed vertical field of view of π/4.
use nalgebra::Point2;
use trackball::Scope;
// Current screen size.
let max = Point2::new(800, 600);
// Default scope with fixed vertical field of view of π/4:
//
// * Increasing width increases horizontal field of view (more can be seen).
// * Increasing height scales scope zooming in as vertical field of view is fixed.
let mut scope = Scope::default();
// Unfix vertical field of view by fixing current unit per pixel on focus plane at distance
// from eye of one, that is effectively `upp` divided by `zat` to make it scale-independant:
//
// * Increasing width increases horizontal field of view (more can be seen).
// * Increasing height increases vertical field of view (more can be seen).
scope.set_fov(scope.fov().to_upp(&max.cast::<f32>()));
Examples found in repository?
28fn setup(
29 mut windows: Query<&mut Window>,
30 mut commands: Commands,
31 mut meshes: ResMut<Assets<Mesh>>,
32 mut materials: ResMut<Assets<StandardMaterial>>,
33) {
34 // circular base
35 commands.spawn((
36 Mesh3d(meshes.add(Circle::new(4.0))),
37 MeshMaterial3d(materials.add(Color::WHITE)),
38 Transform::from_rotation(Quat::from_rotation_x(-std::f32::consts::FRAC_PI_2)),
39 ));
40 // cube
41 commands.spawn((
42 Mesh3d(meshes.add(Cuboid::new(1.0, 1.0, 1.0))),
43 MeshMaterial3d(materials.add(Color::srgb_u8(124, 144, 255))),
44 Transform::from_xyz(0.0, 0.5, 0.0),
45 ));
46 // light
47 commands.spawn((
48 PointLight {
49 shadows_enabled: true,
50 ..default()
51 },
52 Transform::from_xyz(4.0, 8.0, 4.0),
53 ));
54
55 // Windows
56 let mut window1 = windows.single_mut().unwrap();
57 "Fixed Vertical Field of View (Perspective vs Orthographic)".clone_into(&mut window1.title);
58 let res = &window1.resolution;
59 let max = Vec2::new(res.width() * 0.5, res.height()).into();
60 // Left and right camera orientation.
61 let [target, eye, up] = [Vec3::Y * 0.5, Vec3::new(-2.5, 4.5, 9.0) * 1.2, Vec3::Y];
62 // Spawn a 2nd window.
63 let window2 = commands
64 .spawn(Window {
65 title: "Fixed Horizontal Field of View (Perspective vs Orthographic)".to_owned(),
66 ..default()
67 })
68 .id();
69 // Spawn a 3rd window.
70 let window3 = commands
71 .spawn(Window {
72 title: "Fixed Unit Per Pixels (Perspective vs Orthographic)".to_owned(),
73 ..default()
74 })
75 .id();
76
77 // Cameras
78 let mut order = 0;
79 let fov = Fixed::default();
80 for (fov, window) in [
81 (fov, WindowRef::Primary),
82 (fov.to_hor(&max), WindowRef::Entity(window2)),
83 (fov.to_upp(&max), WindowRef::Entity(window3)),
84 ] {
85 let mut scope = Scope::default();
86 scope.set_fov(fov);
87 // Left trackball controller and camera 3D bundle.
88 let left = commands
89 .spawn((
90 TrackballController::default(),
91 Camera {
92 target: RenderTarget::Window(window),
93 // Renders the right camera after the left camera,
94 // which has a default priority of 0.
95 order,
96 ..default()
97 },
98 Camera3d::default(),
99 LeftCamera,
100 ))
101 .id();
102 order += 1;
103 // Right trackball controller and camera 3D bundle.
104 let right = commands
105 .spawn((
106 TrackballController::default(),
107 Camera {
108 target: RenderTarget::Window(window),
109 // Renders the right camera after the left camera,
110 // which has a default priority of 0.
111 order,
112 // Don't clear on the second camera
113 // because the first camera already cleared the window.
114 clear_color: ClearColorConfig::None,
115 ..default()
116 },
117 Camera3d::default(),
118 RightCamera,
119 ))
120 .id();
121 order += 1;
122 // Insert left trackball camera and make it sensitive to right trackball controller as well.
123 commands.entity(left).insert(
124 TrackballCamera::look_at(target, eye, up)
125 .with_scope(scope)
126 .add_controller(right, true),
127 );
128 // Set orthographic projection mode for right camera.
129 scope.set_ortho(true);
130 // Insert right trackball camera and make it sensitive to left trackball controller as well.
131 commands.entity(right).insert(
132 TrackballCamera::look_at(target, eye, up)
133 .with_scope(scope)
134 .add_controller(left, true),
135 );
136 }
137}
Sourcepub fn clip_planes(&self, zat: N) -> (N, N)
pub fn clip_planes(&self, zat: N) -> (N, N)
Clip plane distances from eye regardless of Self::scale()
wrt to distance between eye
and target.
Default is (1e-1, 1e+3)
measured from eye.
Sourcepub const fn set_clip_planes(&mut self, znear: N, zfar: N)
pub const fn set_clip_planes(&mut self, znear: N, zfar: N)
Sets clip plane distances from target or eye whether Self::scale()
.
Default is (1e-1, 1e+3)
measured from eye.
Sourcepub const fn scale(&self) -> bool
pub const fn scale(&self) -> bool
Object inspection mode.
Scales clip plane distances by measuring from target instead of eye. Default is false
.
Sourcepub const fn set_scale(&mut self, oim: bool)
pub const fn set_scale(&mut self, oim: bool)
Sets object inspection mode.
Scales clip plane distances by measuring from target instead of eye. Default is false
.
Sourcepub const fn ortho(&self) -> bool
pub const fn ortho(&self) -> bool
Orthographic projection mode.
Computes scale-identical orthographic instead of perspective projection. Default is false
.
Sourcepub const fn set_ortho(&mut self, opm: bool)
pub const fn set_ortho(&mut self, opm: bool)
Sets orthographic projection mode.
Computes scale-identical orthographic instead of perspective projection. Default is false
.
Examples found in repository?
28fn setup(
29 mut windows: Query<&mut Window>,
30 mut commands: Commands,
31 mut meshes: ResMut<Assets<Mesh>>,
32 mut materials: ResMut<Assets<StandardMaterial>>,
33) {
34 // circular base
35 commands.spawn((
36 Mesh3d(meshes.add(Circle::new(4.0))),
37 MeshMaterial3d(materials.add(Color::WHITE)),
38 Transform::from_rotation(Quat::from_rotation_x(-std::f32::consts::FRAC_PI_2)),
39 ));
40 // cube
41 commands.spawn((
42 Mesh3d(meshes.add(Cuboid::new(1.0, 1.0, 1.0))),
43 MeshMaterial3d(materials.add(Color::srgb_u8(124, 144, 255))),
44 Transform::from_xyz(0.0, 0.5, 0.0),
45 ));
46 // light
47 commands.spawn((
48 PointLight {
49 shadows_enabled: true,
50 ..default()
51 },
52 Transform::from_xyz(4.0, 8.0, 4.0),
53 ));
54
55 // Windows
56 let mut window1 = windows.single_mut().unwrap();
57 "Fixed Vertical Field of View (Perspective vs Orthographic)".clone_into(&mut window1.title);
58 let res = &window1.resolution;
59 let max = Vec2::new(res.width() * 0.5, res.height()).into();
60 // Left and right camera orientation.
61 let [target, eye, up] = [Vec3::Y * 0.5, Vec3::new(-2.5, 4.5, 9.0) * 1.2, Vec3::Y];
62 // Spawn a 2nd window.
63 let window2 = commands
64 .spawn(Window {
65 title: "Fixed Horizontal Field of View (Perspective vs Orthographic)".to_owned(),
66 ..default()
67 })
68 .id();
69 // Spawn a 3rd window.
70 let window3 = commands
71 .spawn(Window {
72 title: "Fixed Unit Per Pixels (Perspective vs Orthographic)".to_owned(),
73 ..default()
74 })
75 .id();
76
77 // Cameras
78 let mut order = 0;
79 let fov = Fixed::default();
80 for (fov, window) in [
81 (fov, WindowRef::Primary),
82 (fov.to_hor(&max), WindowRef::Entity(window2)),
83 (fov.to_upp(&max), WindowRef::Entity(window3)),
84 ] {
85 let mut scope = Scope::default();
86 scope.set_fov(fov);
87 // Left trackball controller and camera 3D bundle.
88 let left = commands
89 .spawn((
90 TrackballController::default(),
91 Camera {
92 target: RenderTarget::Window(window),
93 // Renders the right camera after the left camera,
94 // which has a default priority of 0.
95 order,
96 ..default()
97 },
98 Camera3d::default(),
99 LeftCamera,
100 ))
101 .id();
102 order += 1;
103 // Right trackball controller and camera 3D bundle.
104 let right = commands
105 .spawn((
106 TrackballController::default(),
107 Camera {
108 target: RenderTarget::Window(window),
109 // Renders the right camera after the left camera,
110 // which has a default priority of 0.
111 order,
112 // Don't clear on the second camera
113 // because the first camera already cleared the window.
114 clear_color: ClearColorConfig::None,
115 ..default()
116 },
117 Camera3d::default(),
118 RightCamera,
119 ))
120 .id();
121 order += 1;
122 // Insert left trackball camera and make it sensitive to right trackball controller as well.
123 commands.entity(left).insert(
124 TrackballCamera::look_at(target, eye, up)
125 .with_scope(scope)
126 .add_controller(right, true),
127 );
128 // Set orthographic projection mode for right camera.
129 scope.set_ortho(true);
130 // Insert right trackball camera and make it sensitive to left trackball controller as well.
131 commands.entity(right).insert(
132 TrackballCamera::look_at(target, eye, up)
133 .with_scope(scope)
134 .add_controller(left, true),
135 );
136 }
137}
Sourcepub fn projection_and_upp(
&self,
zat: N,
max: &OPoint<N, Const<2>>,
) -> (Matrix<N, Const<4>, Const<4>, ArrayStorage<N, 4, 4>>, N)
pub fn projection_and_upp( &self, zat: N, max: &OPoint<N, Const<2>>, ) -> (Matrix<N, Const<4>, Const<4>, ArrayStorage<N, 4, 4>>, N)
Projection transformation and unit per pixel on focus plane wrt distance between eye and target and maximum position in screen space.
Trait Implementations§
Source§impl<'de, N> Deserialize<'de> for Scope<N>
impl<'de, N> Deserialize<'de> for Scope<N>
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<Scope<N>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<Scope<N>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Source§impl<N> Serialize for Scope<N>
impl<N> Serialize for Scope<N>
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl<N> Copy for Scope<N>
impl<N> Eq for Scope<N>
impl<N> StructuralPartialEq for Scope<N>
Auto Trait Implementations§
impl<N> Freeze for Scope<N>where
N: Freeze,
impl<N> RefUnwindSafe for Scope<N>where
N: RefUnwindSafe,
impl<N> Send for Scope<N>
impl<N> Sync for Scope<N>
impl<N> Unpin for Scope<N>where
N: Unpin,
impl<N> UnwindSafe for Scope<N>where
N: UnwindSafe,
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
Source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using default()
.
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Serialize for T
impl<T> Serialize for T
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>
fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.