Struct ark_api::world::Bounds

pub struct Bounds { /* private fields */ }

Bounds component.

Use to set custom bounds or read bounds defined by a mesh.

If an entity has a render component and it doesn’t exist it will be added and set to match the mesh, but will be available a frame later.

Implementations

impl Bounds

pub fn bounding_box(&self) -> BoundingBox

Get the local space bounding box.

Convenience for calling Self::bounding_box_min and Self::bounding_box_max.

pub fn set_bounding_box(&self, bbox: BoundingBox)

Set the local space bounding box.

Convenience for calling Self::bounding_box_min and Self::bounding_box_max.

impl Bounds

pub fn bounding_box_min(&self) -> ValueAccessorReadWriteAnimate<Vec3>

Returns a ValueAccessor for the bounding box min of the entity.

Used to set/get/animate the min.

For physics this will be used when the body is setup, for spatial queries it will be used as is.

pub fn bounding_box_max(&self) -> ValueAccessorReadWriteAnimate<Vec3>

Returns a ValueAccessor for the bounding box max of the entity.

Used to set/get/animate the max.

For physics this will be used when the body is setup, for spatial queries it will be used as is.

pub fn bounding_sphere_radius(&self) -> ValueAccessorReadWriteAnimate<f32>

Returns a ValueAccessor for the bounding sphere radius of the entity.

Used to set/get/animate the radius.

For physics this will be used when the body is setup, for spatial queries it will be used as is.

pub fn match_render_shape(&self) -> ValueAccessorReadWrite<bool>

Returns a ValueAccessor for the match render shape toggle of the entity.

Used to set/get whether these bounds will match the render shape.

Set this to false if you want to set a custom bounding shape, box or sphere when the entity has a render component with a shape set.

pub fn shape(&self) -> ValueAccessorDataReadWrite<Shape>

Returns a ValueAccessor for the bounding shape of the entity.

Used to set/get the bounding shape.

Use this to set a custom collider/physics/spatial query shape with MatchRenderShape set to false.

pub fn create_sphere_bounds(&self, radius: f32)

Convenience method to set up both the sphere and the bounding box to contain a certain radius.

Trait Implementations

impl ComponentTrait for Bounds

fn get_type() -> ComponentType

The type of the component, as a ComponentType enum.

fn from_entity(handle: Entity) -> Self

Adopt an Entity, wrap in a component struct.

fn try_from_entity(handle: Entity) -> Option<Self>

Try to adopt an Entity, wrapping it in a component struct.

fn entity(&self) -> Entity

Get the entity that the component belongs to.

impl Debug for Bounds

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

Formats the value using the given formatter.