Skip to main content

Visual

Struct Visual 

Source
pub struct Visual<'a> {
    pub name: Option<&'a str>,
    pub xyz: [f64; 3],
    pub rpy: [f64; 3],
    pub geometry: Geometry,
    pub material: Option<Material<'a>>,
}
Expand description

One shape a link is drawn with.

The shape itself is the one thing a visual cannot default, so Visual::new takes it and leaves the rest to ...

use phoxal_model::AssetId;
use phoxal_model::builder::{Link, Material, RobotBuilder, Visual};
use phoxal_model::structure::Geometry;

let robot = RobotBuilder::new("rover")
    .link(Link {
        name: "base_link",
        visuals: vec![Visual {
            material: Some(Material {
                color: Some([0.2, 0.2, 0.2, 1.0]),
                ..Material::new("carbon")
            }),
            ..Visual::new(Geometry::Mesh {
                asset: AssetId::new("meshes/chassis.stl")?,
                scale: None,
            })
        }],
        ..Link::default()
    })
    .build()?;

let base = robot.structure().link("base_link").expect("the stated link");
assert_eq!(base.visuals().len(), 1);

Fields§

§name: Option<&'a str>

The visual’s own name, when the structure gives it one.

§xyz: [f64; 3]

The shape’s offset from the link’s origin, in metres.

§rpy: [f64; 3]

The shape’s roll, pitch and yaw relative to the link, in radians.

§geometry: Geometry

The shape itself.

§material: Option<Material<'a>>

How the shape is rendered, when the structure says.

Implementations§

Source§

impl Visual<'_>

Source

pub fn new(geometry: Geometry) -> Self

An unnamed, unpainted visual of geometry at the link’s own origin.

Trait Implementations§

Source§

impl<'a> Clone for Visual<'a>

Source§

fn clone(&self) -> Visual<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Visual<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Visual<'a>

§

impl<'a> RefUnwindSafe for Visual<'a>

§

impl<'a> Send for Visual<'a>

§

impl<'a> Sync for Visual<'a>

§

impl<'a> Unpin for Visual<'a>

§

impl<'a> UnsafeUnpin for Visual<'a>

§

impl<'a> UnwindSafe for Visual<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.