Skip to main content

Geometry

autumn_plugin_three

Enum Geometry

#[non_exhaustive]pub enum Geometry {
Show 13 variants    Box {
        width: f32,
        height: f32,
        depth: f32,
    },
    Sphere {
        radius: f32,
    },
    Plane {
        width: f32,
        height: f32,
    },
    Torus {
        radius: f32,
        tube: f32,
    },
    TorusKnot {
        radius: f32,
        tube: f32,
    },
    Cylinder {
        radius_top: f32,
        radius_bottom: f32,
        height: f32,
    },
    Cone {
        radius: f32,
        height: f32,
    },
    Capsule {
        radius: f32,
        length: f32,
    },
    Icosahedron {
        radius: f32,
    },
    Dodecahedron {
        radius: f32,
    },
    Octahedron {
        radius: f32,
    },
    Tetrahedron {
        radius: f32,
    },
    Ring {
        inner_radius: f32,
        outer_radius: f32,
    },
}

Expand description

A primitive geometry. Sizes are in Three.js units.

A size that is not finite, or is negative, renders as the default size for that geometry.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Box

A box (box). Default 1,1,1.

Fields

§width: f32

Size on X.

§height: f32

Size on Y.

§depth: f32

Size on Z.

Sphere

A sphere (sphere). Default radius 0.5.

Fields

§radius: f32

Radius.

Plane

A flat plane in the XY plane (plane). Default 1,1.

Fields

§width: f32

Size on X.

§height: f32

Size on Y.

Torus

A torus (torus). Default 0.5,0.2.

Fields

§radius: f32

Radius from the center to the tube center.

§tube: f32

Tube radius.

TorusKnot

A torus knot (torus-knot). Default 0.5,0.15.

Fields

§radius: f32

Radius of the knot.

§tube: f32

Tube radius.

Cylinder

A cylinder (cylinder). Default 0.5,0.5,1.

Fields

§radius_top: f32

Top radius.

§radius_bottom: f32

Bottom radius.

§height: f32

Height.

Cone

A cone (cone). Default 0.5,1.

Fields

§radius: f32

Base radius.

§height: f32

Height.

Capsule

A capsule (capsule). Default 0.3,0.6.

Fields

§radius: f32

Radius.

§length: f32

Length of the middle section.

Icosahedron

An icosahedron (icosahedron). Default radius 0.5.

Fields

§radius: f32

Radius.

Dodecahedron

A dodecahedron (dodecahedron). Default radius 0.5.

Fields

§radius: f32

Radius.

Octahedron

An octahedron (octahedron). Default radius 0.5.

Fields

§radius: f32

Radius.

Tetrahedron

A tetrahedron (tetrahedron). Default radius 0.5.

Fields

§radius: f32

Radius.

Ring

A flat ring in the XY plane (ring). Default 0.25,0.5.

Fields

§inner_radius: f32

Inner radius.

§outer_radius: f32

Outer radius.

Implementations§

impl Geometry

pub const fn kind(&self) -> &'static str

The data-three-mesh value.

Trait Implementations§

impl Clone for Geometry

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for Geometry

impl Debug for Geometry

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

Formats the value using the given formatter. Read more

impl PartialEq for Geometry

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl StructuralPartialEq for Geometry

Auto Trait Implementations§

impl Forget for Geometry

impl Freeze for Geometry

impl RefUnwindSafe for Geometry

impl Send for Geometry

impl Sync for Geometry

impl Unpin for Geometry

impl UnsafeUnpin for Geometry

impl UnwindSafe for Geometry

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Scoped for T
where T: Send + Sync + 'static,

fn scope(ctx: &PolicyContext) -> ScopeQuery<'_, Self>

Open a deferred ScopeQuery for this type. Resolves the registered scope at .load() time, not here.

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, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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