Struct bevy::math::primitives::Torus

pub struct Torus {
    pub minor_radius: f32,
    pub major_radius: f32,
}

A torus primitive, often representing a ring or donut shape

Fields

minor_radius: f32

The radius of the tube of the torus

major_radius: f32

The distance from the center of the torus to the center of the tube

Implementations

impl Torus

pub fn new(inner_radius: f32, outer_radius: f32) -> Torus

Create a new Torus from an inner and outer radius.

The inner radius is the radius of the hole, and the outer radius is the radius of the entire object

pub fn inner_radius(&self) -> f32

Get the inner radius of the torus. For a ring torus, this corresponds to the radius of the hole, or major_radius - minor_radius

pub fn outer_radius(&self) -> f32

Get the outer radius of the torus. This corresponds to the overall radius of the entire object, or major_radius + minor_radius

pub fn kind(&self) -> TorusKind

Get the TorusKind determined by the minor and major radii.

The torus can either be a ring torus that has a hole, a horn torus that doesn’t have a hole but also isn’t self-intersecting, or a spindle torus that is self-intersecting.

If the minor or major radius is non-positive, infinite, or NaN, TorusKind::Invalid is returned

pub fn area(&self) -> f32

Get the surface area of the torus. Note that this only produces the expected result when the torus has a ring and isn’t self-intersecting

pub fn volume(&self) -> f32

Get the volume of the torus. Note that this only produces the expected result when the torus has a ring and isn’t self-intersecting

Trait Implementations

impl Bounded3d for Torus

fn aabb_3d(&self, translation: Vec3, rotation: Quat) -> Aabb3d

Get an axis-aligned bounding box for the shape with the given translation and rotation

fn bounding_sphere(&self, translation: Vec3, _rotation: Quat) -> BoundingSphere

Get a bounding sphere for the shape with the given translation and rotation

impl Clone for Torus

fn clone(&self) -> Torus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Torus

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

Formats the value using the given formatter.

impl Default for Torus

fn default() -> Torus

Returns the default Torus with a minor radius of 0.25 and a major radius of 0.75.

impl<'de> Deserialize<'de> for Torus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Torus> for Mesh

fn from(torus: Torus) -> Mesh

Converts to this type from the input type.

impl FromReflect for Torus

where Torus: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Torus>

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 Torus

where Torus: Any + Send + Sync, f32: 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<'w, 's, Config, Clear> GizmoPrimitive3d<Torus> for Gizmos<'w, 's, Config, Clear>

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

type Output<'a> = Torus3dBuilder<'a, 'w, 's, Config, Clear> where Gizmos<'w, 's, Config, Clear>: 'a

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

fn primitive_3d( &mut self, primitive: Torus, position: Vec3, rotation: Quat, color: impl Into<Color> ) -> <Gizmos<'w, 's, Config, Clear> as GizmoPrimitive3d<Torus>>::Output<'_>

Renders a 3D primitive with its associated details.

impl Meshable for Torus

type Output = TorusMeshBuilder

The output of Self::mesh. This can either be a Mesh or a builder used for creating a Mesh.

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

Creates a Mesh for a shape.

impl PartialEq for Torus

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for Torus

where Torus: Any + Send + Sync, f32: 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<Torus>) -> 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<Torus>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

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

Casts this type to a reflected value.

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

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 apply(&mut self, value: &(dyn Reflect + 'static))

Applies 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<Torus>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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

Debug formatter for the 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 Serialize for Torus

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 Torus

where Torus: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

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

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

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

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

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 Torus

where Torus: 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 Torus

where Torus: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Torus

impl Primitive3d for Torus

impl StructuralPartialEq for Torus