Struct Root 

pub struct Root { /* private fields */ }

The hub of the client. Spatially this is positioned where the client is started so is a stable base to position things relative to.

Implementations

impl Root

pub fn as_spatial_ref(self) -> SpatialRef

Trait Implementations

impl Clone for Root

fn clone(&self) -> Root

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Root

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

Formats the value using the given formatter.

impl Hash for Root

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 Root

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 PartialEq for Root

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 RootAspect for Root

fn recv_root_event(&self) -> Option<RootEvent>

async fn get_state(&self) -> NodeResult<ClientState>

Get the current state. Useful to check the state before you initialize your application!

async fn generate_state_token(&self, state: ClientState) -> NodeResult<String>

Generate a client state token and return it back.

async fn get_connection_environment(&self) -> NodeResult<Map<String, String>>

Get a hashmap of all the environment variables to connect a given app to the stardust server

fn set_base_prefixes(&self, prefixes: &[String]) -> NodeResult<()>

Set initial list of folders to look for namespaced resources in

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

Cleanly disconnect from the server

impl Serialize for Root

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

Serialize this value into the given Serde serializer.

impl SpatialRefAspect for Root

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 Root