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) -> Segment2d

Create a new Segment2d from its endpoints.

Examples found in repository

examples/2d/2d_shapes.rs (lines 57-60)

fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<ColorMaterial>>,
) {
    commands.spawn(Camera2d);

    let shapes = [
        meshes.add(Circle::new(50.0)),
        meshes.add(CircularSector::new(50.0, 1.0)),
        meshes.add(CircularSegment::new(50.0, 1.25)),
        meshes.add(Ellipse::new(25.0, 50.0)),
        meshes.add(Annulus::new(25.0, 50.0)),
        meshes.add(Capsule2d::new(25.0, 50.0)),
        meshes.add(Rhombus::new(75.0, 100.0)),
        meshes.add(Rectangle::new(50.0, 100.0)),
        meshes.add(RegularPolygon::new(50.0, 6)),
        meshes.add(Triangle2d::new(
            Vec2::Y * 50.0,
            Vec2::new(-50.0, -50.0),
            Vec2::new(50.0, -50.0),
        )),
        meshes.add(Segment2d::new(
            Vec2::new(-50.0, 50.0),
            Vec2::new(50.0, -50.0),
        )),
        meshes.add(Polyline2d::new(vec![
            Vec2::new(-50.0, 50.0),
            Vec2::new(0.0, -50.0),
            Vec2::new(50.0, 50.0),
        ])),
    ];
    let num_shapes = shapes.len();

    for (i, shape) in shapes.into_iter().enumerate() {
        // Distribute colors evenly across the rainbow.
        let color = Color::hsl(360. * i as f32 / num_shapes as f32, 0.95, 0.7);

        commands.spawn((
            Mesh2d(shape),
            MeshMaterial2d(materials.add(color)),
            Transform::from_xyz(
                // Distribute shapes from -X_EXTENT/2 to +X_EXTENT/2.
                -X_EXTENT / 2. + i as f32 / (num_shapes - 1) as f32 * X_EXTENT,
                0.0,
                0.0,
            ),
        ));
    }

    #[cfg(not(target_arch = "wasm32"))]
    commands.spawn((
        Text::new("Press space to toggle wireframes"),
        Node {
            position_type: PositionType::Absolute,
            top: px(12),
            left: px(12),
            ..default()
        },
    ));
}

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

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.

Examples found in repository

examples/math/bounding_2d.rs (lines 234-237)

fn setup(mut commands: Commands) {
    commands.spawn(Camera2d);

    commands.spawn((
        Transform::from_xyz(-OFFSET_X, OFFSET_Y, 0.),
        Shape::Circle(Circle::new(45.)),
        DesiredVolume::Aabb,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(0., OFFSET_Y, 0.),
        Shape::Rectangle(Rectangle::new(80., 80.)),
        Spin,
        DesiredVolume::Circle,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(OFFSET_X, OFFSET_Y, 0.),
        Shape::Triangle(Triangle2d::new(
            Vec2::new(-40., -40.),
            Vec2::new(-20., 40.),
            Vec2::new(40., 50.),
        )),
        Spin,
        DesiredVolume::Aabb,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(-OFFSET_X, -OFFSET_Y, 0.),
        Shape::Line(Segment2d::from_direction_and_length(
            Dir2::from_xy(1., 0.3).unwrap(),
            90.,
        )),
        Spin,
        DesiredVolume::Circle,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(0., -OFFSET_Y, 0.),
        Shape::Capsule(Capsule2d::new(25., 50.)),
        Spin,
        DesiredVolume::Aabb,
        Intersects::default(),
    ));

    commands.spawn((
        Transform::from_xyz(OFFSET_X, -OFFSET_Y, 0.),
        Shape::Polygon(RegularPolygon::new(50., 6)),
        Spin,
        DesiredVolume::Circle,
        Intersects::default(),
    ));

    commands.spawn((
        Text::default(),
        Node {
            position_type: PositionType::Absolute,
            top: px(12),
            left: px(12),
            ..default()
        },
    ));
}

pub fn from_scaled_direction(scaled_direction: Vec2) -> Segment2d

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) -> Segment2d

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 const fn point1(&self) -> Vec2

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

pub const 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>) -> Segment2d

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) -> Segment2d

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

pub fn closest_point(&self, point: Vec2) -> Vec2

Returns the point on the Segment2d that is closest to the specified point.

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 duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for Segment2d

fn default() -> Segment2d

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<[Vec2; 2]> for Segment2d

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

Converts to this type from the input type.

impl From<(Vec2, Vec2)> for Segment2d

fn from(_: (Vec2, Vec2)) -> Segment2d

Converts to this type from the input type.

impl From<Segment2d> for Mesh

fn from(segment: Segment2d) -> Mesh

Converts this segment into a Mesh using a default Segment2dMeshBuilder.

impl FromArg for Segment2d

type This<'from_arg> = Segment2d

The type to convert into.

fn from_arg(arg: Arg<'_>) -> Result<<Segment2d as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for Segment2d

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<Segment2d>

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

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for Segment2d

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<Config, Clear> GizmoPrimitive2d<Segment2d> for GizmoBuffer<Config, Clear>

where Config: GizmoConfigGroup, Clear: 'static + Send + Sync,

type Output<'a> = Segment2dBuilder<'a, Config, Clear> where GizmoBuffer<Config, Clear>: 'a

The output of primitive_2d. This is a builder to set non-default values.

fn primitive_2d( &mut self, primitive: &Segment2d, isometry: impl Into<Isometry2d>, color: impl Into<Color>, ) -> <GizmoBuffer<Config, Clear> as GizmoPrimitive2d<Segment2d>>::Output<'_>

Renders a 2D primitive with its associated details.

impl IntoReturn for Segment2d

fn into_return<'into_return>(self) -> Return<'into_return>

where Segment2d: 'into_return,

Converts Self into a Return value.

impl Meshable for Segment2d

type Output = Segment2dMeshBuilder

The output of Self::mesh. This will be a MeshBuilder used for creating a Mesh.

fn mesh(&self) -> <Segment2d as Meshable>::Output

Creates a Mesh for a shape.

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

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 + 'static), ) -> 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<Segment2d>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Segment2d>, ) -> 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 + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Segment2d>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

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

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

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

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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

fn into_any(self: Box<Segment2d>) -> 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<Segment2d>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

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

Casts this type to a fully-reflected value.

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

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for Segment2d

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

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 + 'static)>

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 + 'static)>

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 + 'static)>

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

Creates a new DynamicStruct from this struct.

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

Will return None if TypeInfo is not available.

impl TypePath for Segment2d

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

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