Square

ranim_items::vitem::geometry

Struct Square

pub struct Square {
    pub basis: Basis2d,
    pub center: DVec3,
    pub size: f64,
    pub stroke_rgba: AlphaColor<Srgb>,
    pub stroke_width: f32,
    pub fill_rgba: AlphaColor<Srgb>,
}

Expand description

A Square

Fields§

§basis: Basis2d

Basis

§center: DVec3

Center

§size: f64

Size

§stroke_rgba: AlphaColor<Srgb>

Stroke rgba

§stroke_width: f32

Stroke width

§fill_rgba: AlphaColor<Srgb>

Fill rgba

Implementations§

impl Square

pub fn new(size: f64) -> Self

Constructor

pub fn scale(&mut self, scale: f64) -> &mut Self

Scale the square by the given scale, with the given anchor as the center.

Note that this accepts a f64 scale dispite of ScaleTransform’s DVec3, because this keeps the square a square.

pub fn scale_at<T>(&mut self, scale: f64, anchor: T) -> &mut Self
where T: Locate<Self>,

Scale the square by the given scale, with the given anchor as the center.

Note that this accepts a f64 scale dispite of ScaleTransform’s DVec3, because this keeps the square a square.

Trait Implementations§

impl Aabb for Square

fn aabb(&self) -> [DVec3; 2]

Get the Axis-aligned bounding box represent in [<min>, <max>].

fn aabb_size(&self) -> DVec3

Get the size of the Aabb.

fn aabb_center(&self) -> DVec3

Get the center of the Aabb.

impl Alignable for Square

fn is_aligned(&self, _other: &Self) -> bool

Checking if two items are aligned

fn align_with(&mut self, _other: &mut Self)

Aligning two items

impl Clone for Square

fn clone(&self) -> Square

Returns a duplicate of the value. Read more

1.0.0§

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

Performs copy-assignment from source. Read more

impl Debug for Square

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

Formats the value using the given formatter. Read more

impl Extract for Square

type Target = CoreItem

The extraction result

fn extract_into(&self, buf: &mut Vec<Self::Target>)

Extract a Extract::Target from reference.

fn extract(&self) -> Vec<Self::Target>

Extract a Extract::Target from reference.

impl FillColor for Square

fn fill_color(&self) -> AlphaColor<Srgb>

Getting fill color of an item

fn set_fill_color(&mut self, color: AlphaColor<Srgb>) -> &mut Self

Setting fill color(rgba) of an item

fn set_fill_opacity(&mut self, opacity: f32) -> &mut Self

Setting fill opacity of an item

impl From<Square> for Parallelogram

fn from(value: Square) -> Self

Converts to this type from the input type.

impl From<Square> for Polygon

fn from(value: Square) -> Self

Converts to this type from the input type.

impl From<Square> for Rectangle

fn from(value: Square) -> Self

Converts to this type from the input type.

impl From<Square> for RegularPolygon

fn from(value: Square) -> Self

Converts to this type from the input type.

impl From<Square> for VItem

fn from(value: Square) -> Self

Converts to this type from the input type.

impl Interpolatable for Square

fn lerp(&self, other: &Self, t: f64) -> Self

Lerping between values

impl Opacity for Square

fn set_opacity(&mut self, opacity: f32) -> &mut Self

Setting opacity of an item

impl RotateTransform for Square

fn rotate_on_axis(&mut self, axis: DVec3, angle: f64) -> &mut Self

Rotate the item by a given angle about a given axis.

fn rotate_on_x(&mut self, angle: f64) -> &mut Self

Rotate the item by a given angle about the X axis.

fn rotate_on_y(&mut self, angle: f64) -> &mut Self

Rotate the item by a given angle about the Y axis.

fn rotate_on_z(&mut self, angle: f64) -> &mut Self

Rotate the item by a given angle about the Z axis.

impl ShiftTransform for Square

fn shift(&mut self, shift: DVec3) -> &mut Self

Shift the item by a given vector.

impl StrokeColor for Square

fn stroke_color(&self) -> AlphaColor<Srgb>

Getting stroke color of an item

fn set_stroke_color(&mut self, color: AlphaColor<Srgb>) -> &mut Self

Setting stroke color(rgba) of an item

fn set_stroke_opacity(&mut self, opacity: f32) -> &mut Self

Setting stroke opacity of an item

Auto Trait Implementations§

impl Freeze for Square

impl RefUnwindSafe for Square

impl Send for Square

impl Sync for Square

impl Unpin for Square

impl UnwindSafe for Square

Blanket Implementations§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

Mutably borrows from an owned value. Read more

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Color for T
where T: FillColor + StrokeColor + ?Sized,

fn set_color(&mut self, color: AlphaColor<Srgb>) -> &mut Self

Setting color(rgba) of an item

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.

impl<T> Discard for T

fn discard(&self)

Simply returns ()

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> Filterable for T

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromAngle<T> for T

fn from_angle(angle: T) -> T

Performs a conversion from angle.

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.

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

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

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

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

fn into_angle(self) -> U

Performs a conversion into T.

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

impl<T> IntoEither for T

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

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> IntoStimulus<T> for T

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the 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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<T> ShiftTransformExt for T
where T: ShiftTransform + ?Sized,

fn with_origin( &mut self, p: impl Locate<Self>, f: impl FnOnce(&mut Self), ) -> &mut Self

Do something with the origin of the item. Read more

fn move_anchor_to<A>(&mut self, anchor: A, point: DVec3) -> &mut Self
where A: Locate<Self>,

Put anchor at a given point. Read more

fn move_to(&mut self, point: DVec3) -> &mut Self
where AabbPoint: Locate<Self>,

Put pivot at a given point.

fn move_next_to<T>(&mut self, target: &T, anchor: AabbPoint) -> &mut Self
where T: Aabb + ?Sized, AabbPoint: Locate<Self>,

Put negative anchor of self on anchor of target

fn move_next_to_padded<T>( &mut self, target: &T, anchor: AabbPoint, padding: f64, ) -> &mut Self
where T: Aabb + ?Sized, AabbPoint: Locate<Self>,

Put negative anchor of self on anchor of target, with a distance of padding

impl<T> StaticAnim for T
where T: StaticAnimRequirement + 'static,

fn show(&self) -> AnimationCell<T>

Show the item

fn hide(&self) -> AnimationCell<T>

Hide the item

impl<T> StrictAs for T

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

fn strict_cast_from(src: Src) -> Dst

Casts the value.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> With for T

fn with(self, f: impl Fn(&mut Self)) -> Self
where Self: Sized,

Mutating a value in place

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

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.

impl<T> AnyExtractCoreItem for T
where T: Extract<Target = CoreItem> + Any + DynClone,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T
where T: Send + Sync,

impl<T> StaticAnimRequirement for T
where T: Clone,