Struct Segment2d

pub struct Segment2d {
    pub vertices: [Vec2; 2],
}

A line segment defined by two endpoints in 2D space.

Fields

vertices: [Vec2; 2]

The endpoints of the line segment.

Implementations

impl Segment2d

pub const fn new(point1: Vec2, point2: Vec2) -> Self

Create a new Segment2d from its endpoints.

pub fn from_points(point1: Vec2, point2: Vec2) -> (Self, Vec2)

👎Deprecated since 0.16.0: Use the new constructor instead

Create a new Segment2d from its endpoints and compute its geometric center.

pub fn from_direction_and_length(direction: Dir2, length: f32) -> Self

Create a new Segment2d centered at the origin with the given direction and length.

The endpoints will be at -direction * length / 2.0 and direction * length / 2.0.

pub fn from_scaled_direction(scaled_direction: Vec2) -> Self

Create a new Segment2d centered at the origin from a vector representing the direction and length of the line segment.

The endpoints will be at -scaled_direction / 2.0 and scaled_direction / 2.0.

pub fn from_ray_and_length(ray: Ray2d, length: f32) -> Self

Create a new Segment2d starting from the origin of the given ray, going in the direction of the ray for the given length.

The endpoints will be at ray.origin and ray.origin + length * ray.direction.

pub fn point1(&self) -> Vec2

Get the position of the first endpoint of the line segment.

pub fn point2(&self) -> Vec2

Get the position of the second endpoint of the line segment.

pub fn center(&self) -> Vec2

Compute the midpoint between the two endpoints of the line segment.

pub fn length(&self) -> f32

Compute the length of the line segment.

pub fn length_squared(&self) -> f32

Compute the squared length of the line segment.

pub fn direction(&self) -> Dir2

Compute the normalized direction pointing from the first endpoint to the second endpoint.

For the non-panicking version, see Segment2d::try_direction.

Panics

Panics if a valid direction could not be computed, for example when the endpoints are coincident, NaN, or infinite.

pub fn try_direction(&self) -> Result<Dir2, InvalidDirectionError>

Try to compute the normalized direction pointing from the first endpoint to the second endpoint.

Returns Err(InvalidDirectionError) if a valid direction could not be computed, for example when the endpoints are coincident, NaN, or infinite.

pub fn scaled_direction(&self) -> Vec2

Compute the vector from the first endpoint to the second endpoint.

pub fn left_normal(&self) -> Dir2

Compute the normalized counterclockwise normal on the left-hand side of the line segment.

For the non-panicking version, see Segment2d::try_left_normal.

Panics

Panics if a valid normal could not be computed, for example when the endpoints are coincident, NaN, or infinite.

pub fn try_left_normal(&self) -> Result<Dir2, InvalidDirectionError>

Try to compute the normalized counterclockwise normal on the left-hand side of the line segment.

Returns Err(InvalidDirectionError) if a valid normal could not be computed, for example when the endpoints are coincident, NaN, or infinite.

pub fn scaled_left_normal(&self) -> Vec2

Compute the non-normalized counterclockwise normal on the left-hand side of the line segment.

The length of the normal is the distance between the endpoints.

pub fn right_normal(&self) -> Dir2

Compute the normalized clockwise normal on the right-hand side of the line segment.

For the non-panicking version, see Segment2d::try_right_normal.

Panics

Panics if a valid normal could not be computed, for example when the endpoints are coincident, NaN, or infinite.

pub fn try_right_normal(&self) -> Result<Dir2, InvalidDirectionError>

Try to compute the normalized clockwise normal on the right-hand side of the line segment.

Returns Err(InvalidDirectionError) if a valid normal could not be computed, for example when the endpoints are coincident, NaN, or infinite.

pub fn scaled_right_normal(&self) -> Vec2

Compute the non-normalized clockwise normal on the right-hand side of the line segment.

The length of the normal is the distance between the endpoints.

pub fn transformed(&self, isometry: impl Into<Isometry2d>) -> Self

Compute the segment transformed by the given Isometry2d.

pub fn translated(&self, translation: Vec2) -> Segment2d

Compute the segment translated by the given vector.

pub fn rotated(&self, rotation: Rot2) -> Segment2d

Compute the segment rotated around the origin by the given rotation.

pub fn rotated_around(&self, rotation: Rot2, point: Vec2) -> Segment2d

Compute the segment rotated around the given point by the given rotation.

pub fn rotated_around_center(&self, rotation: Rot2) -> Segment2d

Compute the segment rotated around its own center.

pub fn centered(&self) -> Segment2d

Compute the segment with its center at the origin, keeping the same direction and length.

pub fn resized(&self, length: f32) -> Segment2d

Compute the segment with a new length, keeping the same direction and center.

pub fn reverse(&mut self)

Reverses the direction of the line segment by swapping the endpoints.

pub fn reversed(self) -> Self

Returns the line segment with its direction reversed by swapping the endpoints.

Trait Implementations

impl Bounded2d for Segment2d

fn aabb_2d(&self, isometry: impl Into<Isometry2d>) -> Aabb2d

Get an axis-aligned bounding box for the shape translated and rotated by the given isometry.

fn bounding_circle(&self, isometry: impl Into<Isometry2d>) -> BoundingCircle

Get a bounding circle for the shape translated and rotated by the given isometry.

impl BoundedExtrusion for Segment2d

fn extrusion_aabb_3d( &self, half_depth: f32, isometry: impl Into<Isometry3d>, ) -> Aabb3d

Get an axis-aligned bounding box for an extrusion with this shape as a base and the given half_depth, transformed by the given translation and rotation.

fn extrusion_bounding_sphere( &self, half_depth: f32, isometry: impl Into<Isometry3d>, ) -> BoundingSphere

Get a bounding sphere for an extrusion of the base_shape with the given half_depth with the given translation and rotation

impl Clone for Segment2d

fn clone(&self) -> Segment2d

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Segment2d

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Segment2d

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<[Vec2; 2]> for Segment2d

fn from(vertices: [Vec2; 2]) -> Self

Converts to this type from the input type.

impl From<(Vec2, Vec2)> for Segment2d

fn from((point1, point2): (Vec2, Vec2)) -> Self

Converts to this type from the input type.

impl FromReflect for Segment2d

where Segment2d: Any + Send + Sync, [Vec2; 2]: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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 Segment2d

where Segment2d: Any + Send + Sync, [Vec2; 2]: FromReflect + TypePath + MaybeTyped + 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.

impl PartialEq for Segment2d

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

where Segment2d: Any + Send + Sync, [Vec2; 2]: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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 debug(&self, f: &mut Formatter<'_>) -> Result

Debug formatter for the value.

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 clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

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

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

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

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

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Segment2d

where Segment2d: Any + Send + Sync, [Vec2; 2]: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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 Serialize for Segment2d

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for Segment2d

where Segment2d: Any + Send + Sync, [Vec2; 2]: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

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

Will return None if TypeInfo is not available.

impl TypePath for Segment2d

where Segment2d: Any + Send + Sync,

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 Segment2d

where Segment2d: Any + Send + Sync, [Vec2; 2]: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Segment2d

impl Primitive2d for Segment2d

impl StructuralPartialEq for Segment2d