Struct ambient_api_core::core::primitives::concepts::Capsule

pub struct Capsule {
    pub capsule: (),
    pub capsule_radius: f32,
    pub capsule_half_height: f32,
    pub capsule_rings: u32,
    pub capsule_latitudes: u32,
    pub capsule_longitudes: u32,
}

Capsule: A primitive capsule. Defined as a cylinder capped by hemispheres.

Required:

• capsule: If attached to an entity alongside the other capsule_* components, the entity will be converted to a capsule primitive. To easily instantiate a default capsule, consider using the Capsule concept.
• capsule_radius: Set the radius of a capsule entity, spanning XY-plane.
• capsule_half_height: Set the half-height of the capsule entity, spanning Z-axis, excluding the caps.
• capsule_rings: Set the number of sections between the caps.
• capsule_latitudes: Set the number of latitudinal sections. Should be even.
• capsule_longitudes: Set the number of longitudinal sections.

Fields

capsule: ()

Component: ambient_core::primitives::capsule

Suggested value: ()

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

capsule_radius: f32

Component: ambient_core::primitives::capsule_radius

Suggested value: 0.5f32

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

capsule_half_height: f32

Component: ambient_core::primitives::capsule_half_height

Suggested value: 0.5f32

Component description: Set the half-height of the capsule entity, spanning Z-axis, excluding the caps.

capsule_rings: u32

Component: ambient_core::primitives::capsule_rings

Suggested value: 0u32

Component description: Set the number of sections between the caps.

capsule_latitudes: u32

Component: ambient_core::primitives::capsule_latitudes

Suggested value: 16u32

Component description: Set the number of latitudinal sections. Should be even.

capsule_longitudes: u32

Component: ambient_core::primitives::capsule_longitudes

Suggested value: 32u32

Component description: Set the number of longitudinal sections.

Trait Implementations

impl Clone for Capsule

fn clone(&self) -> Capsule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Concept for Capsule

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 Capsule

type Required = (Component<()>, Component<f32>, Component<f32>, Component<u32>, 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 Capsule

fn suggested() -> Self

capsule: (),
capsule_radius: 0.5f32,
capsule_half_height: 0.5f32,
capsule_rings: 0u32,
capsule_latitudes: 16u32,
capsule_longitudes: 32u32,

impl Debug for Capsule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Capsule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Capsule

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

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 Capsule