Struct ambient_api_core::core::primitives::concepts::Torus

pub struct Torus {
    pub torus: (),
    pub torus_inner_radius: f32,
    pub torus_outer_radius: f32,
    pub torus_slices: u32,
    pub torus_loops: u32,
}

Torus: A primitive Torus, surface of revolution generated by revolving a circle in three-dimensional space one full revolution.

Required:

• torus: If attached to an entity alongside the other torus_* components, the entity will be converted to a torus primitive. To easily instantiate a default torus, consider using the Torus concept.
• torus_inner_radius: Set the inner radius of a torus entity, spanning XY-plane.
• torus_outer_radius: Set the outer radius of a torus entity, spanning XY-plane.
• torus_slices: Set the slices of a torus entity, spanning XY-plane.
• torus_loops: Set the loops of a torus entity, spanning XY-plane.

Fields

torus: ()

Component: ambient_core::primitives::torus

Suggested value: ()

Component description: If attached to an entity alongside the other torus_* components, the entity will be converted to a torus primitive. To easily instantiate a default torus, consider using the Torus concept.

torus_inner_radius: f32

Component: ambient_core::primitives::torus_inner_radius

Suggested value: 0.25f32

Component description: Set the inner radius of a torus entity, spanning XY-plane.

torus_outer_radius: f32

Component: ambient_core::primitives::torus_outer_radius

Suggested value: 0.35f32

Component description: Set the outer radius of a torus entity, spanning XY-plane.

torus_slices: u32

Component: ambient_core::primitives::torus_slices

Suggested value: 32u32

Component description: Set the slices of a torus entity, spanning XY-plane.

torus_loops: u32

Component: ambient_core::primitives::torus_loops

Suggested value: 16u32

Component description: Set the loops of a torus entity, spanning XY-plane.

Trait Implementations

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 Concept for Torus

fn make(self) -> Entity

Creates an entity with the components defined by this concept.

fn get_spawned(id: EntityId) -> Option<Self>

If the entity with id exists and has the components defined by this concept, returns this concept with all of the values of the components in the entity.

fn get_unspawned(entity: &Entity) -> Option<Self>

If the entity has the components defined by this concept, returns this concept with all of the values of the components in the entity.

fn contained_by_spawned(id: EntityId) -> bool

Returns true if id exists and contains the components defined by this concept.

fn contained_by_unspawned(entity: &Entity) -> bool

Returns true if contains the components defined by this concept.

fn spawn(self) -> EntityId

where Self: Sized,

Spawns this concept into the world. If you want to modify state before spawning, use make instead.

impl ConceptComponents for Torus

type Required = (Component<()>, Component<f32>, Component<f32>, Component<u32>, Component<u32>)

A tuple of the required components for this concept.

type Optional = ()

A tuple of the optional components for this concept.

fn required() -> Self::Required

Returns a tuple of the required components for this concept.

fn optional() -> Self::Optional

Returns a tuple of the optional components for this concept.

fn from_required_data( required: <Self::Required as ComponentsTuple>::Data ) -> Self

Converts a tuple of data back to a concept.

fn as_query() -> ConceptQuery<Self>

where Self: Sized,

Creates a ConceptQuery that can be passed into queries.

impl ConceptSuggested for Torus

fn suggested() -> Self

torus: (),
torus_inner_radius: 0.25f32,
torus_outer_radius: 0.35f32,
torus_slices: 32u32,
torus_loops: 16u32,

impl Debug for Torus

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for Torus

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Torus