Struct observation_tools_client::artifacts::Point2Builder

pub struct Point2Builder { /* private fields */ }

A 2D point.

Example

use observation_tools_client::artifacts::Point2Builder;

#[tokio::main]
async fn main() -> Result<(), observation_tools_client::ClientError> {
    tracing_subscriber::fmt::init();
    let client = observation_tools_client::test_utils::create_doc_test_client()?;

    // Set up a 2D group:
    let run = client.create_run("create_point2")?;
    let group2d = run.child_uploader_2d("point2_world")?;

    // Basic usage:
    group2d.create_object2("my_point", Point2Builder::new(1.0, 2.0))?;
    // Point2s can be created directly from tuples:
    let tuple_point: Point2Builder = (3.0, 4.0).into();
    group2d.create_object2("my_tuple_point", tuple_point)?;

    // Convert from an nalgebra point:
    let nalgebra_point: Point2Builder = nalgebra::Point2::new(5.0, 3.0).into();
    group2d.create_object2("nalgebra_point", nalgebra_point)?;

    client.shutdown().await?;
    Ok(())
}

Implementations

impl Point2Builder

pub fn new( x: impl Into<NumberBuilder>, y: impl Into<NumberBuilder> ) -> Point2Builder

Create a point at (x, y).

impl Point2Builder

pub fn origin() -> Point2Builder

Create a point at (0,0).

Trait Implementations

impl Clone for Point2Builder

fn clone(&self) -> Point2Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A, B> From<(A, B)> for Point2Builder

where A: Into<NumberBuilder>, B: Into<NumberBuilder>,

fn from((x, y): (A, B)) -> Point2Builder

Converts to this type from the input type.

impl From<Point2Builder> for JsValue

fn from(value: Point2Builder) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Point2Builder

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl Into<Object2Builder> for Point2Builder

fn into(self) -> Object2Builder

Converts this type into the (usually inferred) input type.

impl<T: Scalar + Into<NumberBuilder>> Into<Point2Builder> for Point2<T>

fn into(self) -> Point2Builder

Converts this type into the (usually inferred) input type.

impl IntoWasmAbi for Point2Builder

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Point2Builder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, Point2Builder>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Point2Builder

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Point2Builder

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Point2Builder

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Point2Builder>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Point2Builder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Point2Builder>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for Point2Builder

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for Point2Builder

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Point2Builder]>

impl VectorIntoWasmAbi for Point2Builder

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Point2Builder]>) -> Self::Abi

impl WasmDescribe for Point2Builder

fn describe()

impl WasmDescribeVector for Point2Builder

fn describe_vector()