Struct omf::Element

pub struct Element {
    pub name: String,
    pub description: String,
    pub color: Option<Color>,
    pub metadata: Map<String, Value>,
    pub attributes: Vec<Attribute>,
    pub geometry: Geometry,
}

Defines a single “object” or “shape” within the OMF file.

Each shape has a name plus other optional metadata, a “geometry” that describes a point-set, surface, etc., and a list of attributes that that exist on that geometry.

Fields

name: String

The element name. Names should be non-empty and unique.

description: String

Optional element description.

color: Option<Color>

Optional solid color.

metadata: Map<String, Value>

Arbitrary metadata.

attributes: Vec<Attribute>

List of attributes, if any.

geometry: Geometry

The geometry of the element.

Implementations

impl Element

pub fn new(name: impl Into<String>, geometry: impl Into<Geometry>) -> Self

Create a new element with the given name and geometry.

Geometries will be automatically converted from their objects into enum variants.

pub fn valid_locations(&self) -> &'static [Location]

Returns the valid locations for attributes on this element.

pub fn location_len(&self, location: Location) -> Option<u64>

Returns the number of values needed for the given location.

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Element

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Element

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Element

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Element

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for Element

fn validate(&mut self) -> Result<Problems, Problems>

Call to validate the object, returning errors and warnings.

impl StructuralPartialEq for Element