Struct Field 

pub struct Field { /* private fields */ }

A signed distance field with adjustable shape. Replaces colliders.

Implementations

impl Field

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

impl Field

pub fn as_field_ref(self) -> FieldRef

pub fn as_spatial_ref(self) -> SpatialRef

pub fn as_spatial(self) -> Spatial

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl FieldAspect for Field

fn set_shape(&self, shape: Shape) -> NodeResult<()>

Set the shape of this field (and its parameters)

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

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

impl FieldRefAspect for Field

async fn distance( &self, space: &impl SpatialRefAspect, point: impl Into<Vector3<f32>>, ) -> NodeResult<f32>

Get the distance to the surface of this field relative to the point in space

async fn normal( &self, space: &impl SpatialRefAspect, point: impl Into<Vector3<f32>>, ) -> NodeResult<Vector3<f32>>

Get a vector pointing away from surface of this field relative to the point in space

async fn closest_point( &self, space: &impl SpatialRefAspect, point: impl Into<Vector3<f32>>, ) -> NodeResult<Vector3<f32>>

Get the closest point on the surface of this field relative to the point in space

async fn ray_march( &self, space: &impl SpatialRefAspect, ray_origin: impl Into<Vector3<f32>>, ray_direction: impl Into<Vector3<f32>>, ) -> NodeResult<RayMarchResult>

Get information from the server raymarching the given ray in space through this field such as steps, closest/deepest distance, etc.

impl Hash for Field

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 Field

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 Field

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 Field

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 Field

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

Serialize this value into the given Serde serializer.

impl SpatialAspect for Field

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 Field

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 Field