Struct ambient_api_core::core::primitives::concepts::Sphere

pub struct Sphere {
    pub sphere: (),
    pub sphere_radius: f32,
    pub sphere_sectors: u32,
    pub sphere_stacks: u32,
}

Sphere: A primitive sphere.

Required:

• sphere: If attached to an entity alongside the other sphere_* components, the entity will be converted to a sphere primitive. To easily instantiate a unit-diameter sphere, consider using the Sphere concept.
• sphere_radius: Set the radius of a sphere entity.
• sphere_sectors: Set the longitudinal sectors of a sphere entity.
• sphere_stacks: Set the latitudinal stacks of a sphere entity.

Fields

sphere: ()

Component: ambient_core::primitives::sphere

Suggested value: ()

Component description: If attached to an entity alongside the other sphere_* components, the entity will be converted to a sphere primitive. To easily instantiate a unit-diameter sphere, consider using the Sphere concept.

sphere_radius: f32

Component: ambient_core::primitives::sphere_radius

Suggested value: 0.5f32

Component description: Set the radius of a sphere entity.

sphere_sectors: u32

Component: ambient_core::primitives::sphere_sectors

Suggested value: 36u32

Component description: Set the longitudinal sectors of a sphere entity.

sphere_stacks: u32

Component: ambient_core::primitives::sphere_stacks

Suggested value: 18u32

Component description: Set the latitudinal stacks of a sphere entity.

Trait Implementations

impl Clone for Sphere

fn clone(&self) -> Sphere

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Concept for Sphere

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 Sphere

type Required = (Component<()>, 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 Sphere

fn suggested() -> Self

sphere: (),
sphere_radius: 0.5f32,
sphere_sectors: 36u32,
sphere_stacks: 18u32,

impl Debug for Sphere

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sphere

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sphere

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

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 Sphere