Struct Spatial 

pub struct Spatial { /* private fields */ }

A node with spatial attributes (position, rotation, scale) that can be manipulated by zones if zoneable.

Equivalent to a Transform in Unity, Spatial in Godot, etc.

Implementations

impl Spatial

pub fn as_spatial_ref(self) -> SpatialRef

impl Spatial

pub fn create( spatial_parent: &impl SpatialRefAspect, transform: Transform, zoneable: bool, ) -> NodeResult<Self>

Trait Implementations

impl Clone for Spatial

fn clone(&self) -> Spatial

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spatial

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

Formats the value using the given formatter.

impl Hash for Spatial

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NodeType for Spatial

fn node(&self) -> &NodeCore

Get a reference to the node.

fn id(&self) -> u64

fn client(&self) -> &Arc<ClientHandle>

Try to get the client

fn set_enabled(&self, enabled: bool) -> Result<(), NodeError>

Set whether the node is active or not. This has different effects depending on the node.

impl OwnedAspect for Spatial

fn set_enabled(&self, enabled: bool) -> NodeResult<()>

Set if this node is enabled or not. Disabled drawables won’t render, input handlers won’t receive input, etc.

fn destroy(&self) -> NodeResult<()>

Destroy this node immediately. Not all nodes will have this method, those that don’t can be dropped client-side without issue.

impl PartialEq for Spatial

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Spatial

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl SpatialAspect for Spatial

fn set_local_transform(&self, transform: Transform) -> NodeResult<()>

Set the transform of this spatial relative to its spatial parent.

fn set_relative_transform( &self, relative_to: &impl SpatialRefAspect, transform: Transform, ) -> NodeResult<()>

Set the transform of this spatial relative to another node.

fn set_spatial_parent(&self, parent: &impl SpatialRefAspect) -> NodeResult<()>

Set the spatial parent with its local transform remaining the same. It will silently error and not set the spatial parent if it is to a child of itself.

fn set_spatial_parent_in_place( &self, parent: &impl SpatialRefAspect, ) -> NodeResult<()>

Set the spatial parent with its “global” transform remaining the same. It will silently error and not set the spatial parent if it is to a child of itself.

fn set_zoneable(&self, zoneable: bool) -> NodeResult<()>

Set if this spatial is zoneable or not. You may want to set this to false when being grabbed or interacted with, then back to true when it’s floating inert in space.

async fn export_spatial(&self) -> NodeResult<u64>

Return a UUID representing this node’s SpatialRef that you can send to other clients

impl SpatialRefAspect for Spatial

async fn get_local_bounding_box(&self) -> NodeResult<BoundingBox>

Get the bounding box of this spatial and its children relative to another spatial

async fn get_relative_bounding_box( &self, relative_to: &impl SpatialRefAspect, ) -> NodeResult<BoundingBox>

Get the bounding box of this spatial and its children relative to itself

async fn get_transform( &self, relative_to: &impl SpatialRefAspect, ) -> NodeResult<Transform>

Get the transform relative to some other spatial node.

impl Eq for Spatial