Struct BoundingCircle

pub struct BoundingCircle {
    pub center: Vec2,
    pub circle: Circle,
}

A bounding circle

Fields

center: Vec2

The center of the bounding circle

circle: Circle

The circle

Implementations

impl BoundingCircle

pub fn new(center: Vec2, radius: f32) -> Self

Constructs a bounding circle from its center and radius.

pub fn from_point_cloud( translation: Vec2, rotation: impl Into<Rot2>, points: &[Vec2], ) -> BoundingCircle

Computes a BoundingCircle containing the given set of points, transformed by translation and rotation.

The bounding circle is not guaranteed to be the smallest possible.

pub fn radius(&self) -> f32

Get the radius of the bounding circle

pub fn aabb_2d(&self) -> Aabb2d

Computes the smallest Aabb2d containing this BoundingCircle.

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

Finds the point on the bounding circle that is closest to the given point.

If the point is outside the circle, the returned point will be on the perimeter of the circle. Otherwise, it will be inside the circle and returned as is.

Trait Implementations

impl BoundingVolume for BoundingCircle

type Translation = Vec2

The position type used for the volume. This should be Vec2 for 2D and Vec3 for 3D.

type Rotation = Rot2

The rotation type used for the volume. This should be f32 for 2D and Quat for 3D.

type HalfSize = f32

The type used for the size of the bounding volume. Usually a half size. For example an f32 radius for a circle, or a Vec3 with half sizes for x, y and z for a 3D axis-aligned bounding box

fn center(&self) -> Self::Translation

Returns the center of the bounding volume.

fn half_size(&self) -> Self::HalfSize

Returns the half size of the bounding volume.

fn visible_area(&self) -> f32

Computes the visible surface area of the bounding volume. This method can be useful to make decisions about merging bounding volumes, using a Surface Area Heuristic.

fn contains(&self, other: &Self) -> bool

Checks if this bounding volume contains another one.

fn merge(&self, other: &Self) -> Self

Computes the smallest bounding volume that contains both self and other.

fn grow(&self, amount: impl Into<Self::HalfSize>) -> Self

Increases the size of the bounding volume in each direction by the given amount.

fn shrink(&self, amount: impl Into<Self::HalfSize>) -> Self

Decreases the size of the bounding volume in each direction by the given amount.

fn scale_around_center(&self, scale: impl Into<Self::HalfSize>) -> Self

Scale the size of the bounding volume around its center by the given amount

fn translate_by(&mut self, translation: impl Into<Self::Translation>)

Translates the bounding volume by the given translation.

fn rotate_by(&mut self, rotation: impl Into<Self::Rotation>)

Rotates the bounding volume around the origin by the given rotation.

fn transformed_by( self, translation: impl Into<Self::Translation>, rotation: impl Into<Self::Rotation>, ) -> Self

Transforms the bounding volume by first rotating it around the origin and then applying a translation.

fn transform_by( &mut self, translation: impl Into<Self::Translation>, rotation: impl Into<Self::Rotation>, )

Transforms the bounding volume by first rotating it around the origin and then applying a translation.

fn translated_by(self, translation: impl Into<Self::Translation>) -> Self

Translates the bounding volume by the given translation.

fn rotated_by(self, rotation: impl Into<Self::Rotation>) -> Self

Rotates the bounding volume around the origin by the given rotation.

impl Clone for BoundingCircle

fn clone(&self) -> BoundingCircle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundingCircle

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

Formats the value using the given formatter.

impl FromReflect for BoundingCircle

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath + RegisterForReflection, Circle: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

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.

impl GetTypeRegistration for BoundingCircle

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath + RegisterForReflection, Circle: 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.

impl IntersectsVolume<Aabb2d> for BoundingCircle

fn intersects(&self, aabb: &Aabb2d) -> bool

Check if a volume intersects with this intersection test

impl IntersectsVolume<BoundingCircle> for Aabb2d

fn intersects(&self, circle: &BoundingCircle) -> bool

Check if a volume intersects with this intersection test

impl IntersectsVolume<BoundingCircle> for BoundingCircle

fn intersects(&self, other: &Self) -> bool

Check if a volume intersects with this intersection test

impl IntersectsVolume<BoundingCircle> for BoundingCircleCast

fn intersects(&self, volume: &BoundingCircle) -> bool

Check if a volume intersects with this intersection test

impl IntersectsVolume<BoundingCircle> for RayCast2d

fn intersects(&self, volume: &BoundingCircle) -> bool

Check if a volume intersects with this intersection test

impl Reflect for BoundingCircle

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath + RegisterForReflection, Circle: FromReflect + TypePath + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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 reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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

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

fn try_apply(&mut self, value: &dyn Reflect) -> 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 reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

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

Applies a reflected value to this value.

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

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

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

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for BoundingCircle

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath + RegisterForReflection, Circle: FromReflect + TypePath + RegisterForReflection,

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

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>

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>

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>

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 BoundingCircle

where Self: 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 BoundingCircle

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath + RegisterForReflection, Circle: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for BoundingCircle