# Struct bevy::math::primitives::InfinitePlane3d

``````pub struct InfinitePlane3d {
pub normal: Dir3,
}``````
Expand description

An unbounded plane in 3D space. It forms a separating surface through the origin, stretching infinitely far

## Fields§

§`normal: Dir3`

The normal of the plane. The plane will be placed perpendicular to this direction

## Implementations§

§

### impl InfinitePlane3d

#### pub fn new<T>(normal: T) -> InfinitePlane3dwhere T: TryInto<Dir3>, <T as TryInto<Dir3>>::Error: Debug,

Create a new `InfinitePlane3d` from a normal

##### §Panics

Panics if the given `normal` is zero (or very close to zero), or non-finite.

##### Examples found in repository?
examples/3d/3d_viewport_to_world.rs (line 33)
```13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
```
``````fn draw_cursor(
camera_query: Query<(&Camera, &GlobalTransform)>,
ground_query: Query<&GlobalTransform, With<Ground>>,
windows: Query<&Window>,
mut gizmos: Gizmos,
) {
let (camera, camera_transform) = camera_query.single();
let ground = ground_query.single();

let Some(cursor_position) = windows.single().cursor_position() else {
return;
};

// Calculate a ray pointing from the camera into the world based on the cursor's position.
let Some(ray) = camera.viewport_to_world(camera_transform, cursor_position) else {
return;
};

// Calculate if and where the ray is hitting the ground plane.
let Some(distance) =
ray.intersect_plane(ground.translation(), InfinitePlane3d::new(ground.up()))
else {
return;
};
let point = ray.get_point(distance);

// Draw a circle just above the ground plane at that position.
gizmos.circle(point + ground.up() * 0.01, ground.up(), 0.2, Color::WHITE);
}``````
More examples
```468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
```
``````fn handle_mouse_clicks(
buttons: Res<ButtonInput<MouseButton>>,
windows: Query<&Window, With<PrimaryWindow>>,
cameras: Query<(&Camera, &GlobalTransform)>,
mut main_objects: Query<&mut Transform, With<MainObject>>,
) {
if !buttons.pressed(MouseButton::Left) {
return;
}
let Some(mouse_position) = windows
.iter()
.next()
.and_then(|window| window.cursor_position())
else {
return;
};
let Some((camera, camera_transform)) = cameras.iter().next() else {
return;
};

// Figure out where the user clicked on the plane.
let Some(ray) = camera.viewport_to_world(camera_transform, mouse_position) else {
return;
};
let Some(ray_distance) = ray.intersect_plane(Vec3::ZERO, InfinitePlane3d::new(Vec3::Y)) else {
return;
};
let plane_intersection = ray.origin + ray.direction.normalize() * ray_distance;

// Move all the main objeccts.
for mut transform in main_objects.iter_mut() {
transform.translation = vec3(
plane_intersection.x,
transform.translation.y,
plane_intersection.z,
);
}
}``````

#### pub fn from_points(a: Vec3, b: Vec3, c: Vec3) -> (InfinitePlane3d, Vec3)

Create a new `InfinitePlane3d` based on three points and compute the geometric center of those points.

The direction of the plane normal is determined by the winding order of the triangular shape formed by the points.

##### §Panics

Panics if a valid normal can not be computed, for example when the points are collinear and lie on the same line.

## Trait Implementations§

§

### impl Bounded3d for InfinitePlane3d

§

#### fn aabb_3d(&self, translation: Vec3, rotation: Quat) -> Aabb3d

Get an axis-aligned bounding box for the shape with the given translation and rotation
§

#### fn bounding_sphere(&self, translation: Vec3, _rotation: Quat) -> BoundingSphere

Get a bounding sphere for the shape with the given translation and rotation
§

### impl Clone for InfinitePlane3d

§

#### fn clone(&self) -> InfinitePlane3d

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
§

### impl Debug for InfinitePlane3d

§

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

Formats the value using the given formatter. Read more
§

### impl Default for InfinitePlane3d

§

#### fn default() -> InfinitePlane3d

Returns the default `InfinitePlane3d` with a normal pointing in the `+Y` direction.

§

### impl<'de> Deserialize<'de> for InfinitePlane3d

§

#### fn deserialize<__D>( __deserializer: __D, ) -> Result<InfinitePlane3d, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

### impl FromReflect for InfinitePlane3dwhere InfinitePlane3d: Any + Send + Sync, Dir3: FromReflect + TypePath + RegisterForReflection,

§

#### fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<InfinitePlane3d>

Constructs a concrete instance of `Self` from a reflected value.
§

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

Attempts to downcast the given value to `Self` using, constructing the value using `from_reflect` if that fails. Read more
§

### impl GetTypeRegistration for InfinitePlane3dwhere InfinitePlane3d: Any + Send + Sync, Dir3: FromReflect + TypePath + RegisterForReflection,

§

#### 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. Read more
§

### impl PartialEq for InfinitePlane3d

§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

### impl Reflect for InfinitePlane3dwhere InfinitePlane3d: Any + Send + Sync, Dir3: FromReflect + TypePath + RegisterForReflection,

§

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

Returns the `TypeInfo` of the type represented by this value. Read more
§

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

Returns the value as a `Box<dyn Any>`.
§

#### fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a `&dyn Any`.
§

#### fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a `&mut dyn Any`.
§

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

Casts this type to a boxed reflected value.
§

#### fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.
§

#### fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.
§

#### fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a `Reflect` trait object. Read more
§

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

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

#### fn try_apply( &mut self, value: &(dyn Reflect + 'static), ) -> Result<(), ApplyError>

Tries to `apply` a reflected value to this value. Read more
§

#### fn reflect_kind(&self) -> ReflectKind

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

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

Returns an immutable enumeration of “kinds” of type. Read more
§

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

Returns a mutable enumeration of “kinds” of type. Read more
§

#### fn reflect_owned(self: Box<InfinitePlane3d>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type. Read more
§

#### fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result. Read more
§

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

Debug formatter for the value. Read more
§

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

Applies a reflected value to this value. Read more
§

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

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

#### fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value. Read more
§

#### fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type. Read more
§

### impl Serialize for InfinitePlane3d

§

#### fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

### impl Struct for InfinitePlane3dwhere InfinitePlane3d: Any + Send + Sync, Dir3: FromReflect + TypePath + RegisterForReflection,

§

#### fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named `name` as a `&dyn Reflect`.
§

#### fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

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

#### fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index `index` as a `&dyn Reflect`.
§

#### fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

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

#### 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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a `DynamicStruct`.
§

### impl TypePath for InfinitePlane3dwhere InfinitePlane3d: Any + Send + Sync,

§

#### fn type_path() -> &'static str

Returns the fully qualified path of the underlying type. Read more
§

#### fn short_type_path() -> &'static str

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

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

Returns the name of the type, or `None` if it is anonymous. Read more
§

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

Returns the name of the crate the type is in, or `None` if it is anonymous. Read more
§

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

Returns the path to the module the type is in, or `None` if it is anonymous. Read more
§

### impl Typed for InfinitePlane3dwhere InfinitePlane3d: Any + Send + Sync, Dir3: FromReflect + TypePath + RegisterForReflection,

§

#### fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.
§

§

§

§

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
§

### impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

§

#### fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the `T` `ShaderType` for `self`. When used in `AsBindGroup` derives, it is safe to assume that all images in `self` exist.
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

§

§

### impl<T> Downcast for Twhere T: Any,

§

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

Convert `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`.
§

#### fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert `Rc<Trait>` (where `Trait: Downcast`) to `Rc<Any>`. `Rc<Any>` can then be further `downcast` into `Rc<ConcreteType>` where `ConcreteType` implements `Trait`.
§

#### fn as_any(&self) -> &(dyn Any + 'static)

Convert `&Trait` (where `Trait: Downcast`) to `&Any`. This is needed since Rust cannot generate `&Any`’s vtable from `&Trait`’s.
§

#### fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert `&mut Trait` (where `Trait: Downcast`) to `&Any`. This is needed since Rust cannot generate `&mut Any`’s vtable from `&mut Trait`’s.
§

### impl<T> DowncastSync for Twhere T: Any + Send + Sync,

§

#### fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert `Arc<Trait>` (where `Trait: Downcast`) to `Arc<Any>`. `Arc<Any>` can then be further `downcast` into `Arc<ConcreteType>` where `ConcreteType` implements `Trait`.
§

§

§

§

§

§

source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

§

§

### impl<T> FromWorld for Twhere T: Default,

§

#### fn from_world(_world: &mut World) -> T

Creates `Self` using data from the given `World`.
§

### impl<S> GetField for Swhere S: Struct,

§

#### fn get_field<T>(&self, name: &str) -> Option<&T>where T: Reflect,

Returns a reference to the value of the field named `name`, downcast to `T`.
§

#### fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>where T: Reflect,

Returns a mutable reference to the value of the field named `name`, downcast to `T`.
§

### impl<T> GetPath for Twhere T: Reflect + ?Sized,

§

#### fn reflect_path<'p>( &self, path: impl ReflectPath<'p>, ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>

Returns a reference to the value specified by `path`. Read more
§

#### fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a mutable reference to the value specified by `path`. Read more
§

#### fn path<'p, T>( &self, path: impl ReflectPath<'p>, ) -> Result<&T, ReflectPathError<'p>>where T: Reflect,

Returns a statically typed reference to the value specified by `path`. Read more
§

#### fn path_mut<'p, T>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut T, ReflectPathError<'p>>where T: Reflect,

Returns a statically typed mutable reference to the value specified by `path`. Read more
§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> IntoEither for T

source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts `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 more
source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

Converts `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 more
§

§

§

### impl<T> NoneValue for Twhere T: Default,

§

§

#### fn null_value() -> T

The none-equivalent value.
§

### impl<T> Pointable for T

§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

source§

Read this value from the supplied reader. Same as `ReadEndian::read_from_little_endian()`.
source§

Read this value from the supplied reader. Same as `ReadEndian::read_from_big_endian()`.
source§

Read this value from the supplied reader. Same as `ReadEndian::read_from_native_endian()`.
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

source§

source§

source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

§

source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

§

§

§

§

§

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
§

source§

§

§

§

§

§