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

Constructs a bounding circle from its center and radius.

pub fn from_point_cloud( isometry: impl Into<Isometry2d>, points: &[Vec2], ) -> BoundingCircle

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

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 Rot2 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) -> <BoundingCircle as BoundingVolume>::Translation

Returns the center of the bounding volume.

fn half_size(&self) -> <BoundingCircle as BoundingVolume>::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: &BoundingCircle) -> bool

Checks if this bounding volume contains another one.

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

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

fn grow( &self, amount: impl Into<<BoundingCircle as BoundingVolume>::HalfSize>, ) -> BoundingCircle

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

fn shrink( &self, amount: impl Into<<BoundingCircle as BoundingVolume>::HalfSize>, ) -> BoundingCircle

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

fn scale_around_center( &self, scale: impl Into<<BoundingCircle as BoundingVolume>::HalfSize>, ) -> BoundingCircle

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

fn translate_by( &mut self, translation: impl Into<<BoundingCircle as BoundingVolume>::Translation>, )

Translates the bounding volume by the given translation.

fn rotate_by( &mut self, rotation: impl Into<<BoundingCircle as BoundingVolume>::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 duplicate 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BoundingCircle

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for BoundingCircle

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

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 BoundingCircle

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: &BoundingCircle) -> 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 PartialEq for BoundingCircle

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

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<BoundingCircle>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<BoundingCircle>, ) -> 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<BoundingCircle>) -> 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 BoundingCircle

fn into_any(self: Box<BoundingCircle>) -> 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<BoundingCircle>) -> 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 BoundingCircle

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 BoundingCircle

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 BoundingCircle

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for BoundingCircle

impl StructuralPartialEq for BoundingCircle