Enum EntityRef 

pub enum EntityRef {
    Vertex {
        name: String,
    },
    Edge {
        name: String,
    },
    Face {
        name: String,
    },
    Datum {
        name: String,
        component: Option<DatumComponent>,
    },
    Solid {
        name: String,
    },
    Sketch {
        name: String,
    },
    SketchCurve {
        sketch: String,
        curve: CurveId,
    },
    SketchPoint {
        sketch: String,
        point: PointId,
    },
}

Something picked in the viewport, to build on or to use.

Variants

Vertex

Fields

name: String

Edge

Fields

name: String

Face

A face: planar, its plane — normal pointing out of its solid, sketch origin the world origin’s projection onto it and sketch x the world axis most parallel to it, projected, so sketches on parallel faces line up. Round, its axis.

Fields

name: String

Datum

A datum — or, of a frame, one of its axes or planes (see geop_core_math::primitives::Datum::component). Every part has the frame ORIGIN.

Fields

name: String

component: Option<DatumComponent>

Solid

A solid, as a whole.

Fields

name: String

Sketch

A sketch: its plane.

Fields

name: String

SketchCurve

A curve of a sketch, by its id in the sketch.

Fields

sketch: String

curve: CurveId

SketchPoint

A point of a sketch, by its id in the sketch.

Fields

sketch: String

point: PointId

Implementations

impl EntityRef

pub fn datum(name: impl Into<String>) -> Self

A datum, as a whole.

pub fn datum_component( name: impl Into<String>, component: DatumComponent, ) -> Self

A component of the frame datum name.

pub fn label(&self) -> String

How the entity is shown: its name, and which component of a frame.

impl EntityRef

pub fn lies_in(&self, scope: &EntityRef) -> bool

Whether it is scope or part of it: a curve or a point of a sketch.

impl EntityRef

pub fn resolve_datum<S: Scalar>(&self, part: &Part<S>) -> GeopResult<Datum<S>>

The datum it refers to in part — for a component of a frame, that component as a datum of its own. Fails if it is no datum of the part.

pub fn resolve_plane<S: Scalar>( &self, part: &Part<S>, ) -> GeopResult<CoordinateSystem<S>>

The plane it lies in, as a frame with u/v a sketch’s x/y on it and w = u x v its normal: a planar face’s — normal pointing out of its solid, origin the world origin’s projection onto it and u the world axis most parallel to it, so sketches on parallel faces line up — a datum plane’s, a frame’s plane’s, or a sketch’s. Fails for anything else.

Trait Implementations

impl Clone for EntityRef

fn clone(&self) -> EntityRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityRef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EntityRef

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

Formats the value using the given formatter.

impl PartialEq for EntityRef

fn eq(&self, other: &EntityRef) -> 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 EntityRef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EntityRef