Struct Model 

pub struct Model(/* private fields */);

A reference counted, mutable Model.

Implementations

impl Model

pub fn new(inner: RcMut<ModelInner>) -> Self

Create new model from inner.

pub fn depth(&self) -> usize

Calculate depth of the model.

pub fn is_empty(&self) -> bool

Return true, if model has no children.

pub fn has_no_output(&self) -> bool

Return true, if model wont produce any output

pub fn make_deep_copy(&self) -> Self

Make a deep copy if this model. TODO: isn’t this a Clone?

pub fn addr(&self) -> usize

Return address of this model.

pub fn is_same_as(&self, other: &Model) -> bool

Check if other is and self have the same address.

pub fn remove_child(&self, child: &Model)

Remove child from this model.

pub fn append(&self, model: Model) -> Model

Append a single model as child.

Also tries to set the output type if it has not been determined yet.

pub fn append_children(&self, models: Models) -> Self

Append multiple models as children.

Return self.

pub fn boolean_op(self, op: BooleanOp, other: Model) -> Model

Short cut to generate boolean operator as binary operation with two models.

pub fn multiply(&self, n: Integer) -> Vec<Model>

Multiply a model n times.

pub fn replace_input_placeholders(&self, input_model: &Model) -> Self

Replace each input placeholder with copies of input_model.

pub fn deduce_output_type(&self) -> OutputType

Deduce output type from children and set it and return it.

pub fn render_output_type(&self) -> OutputType

Get render output type. Expects a render output.

pub fn into_group(&self) -> Option<Model>

Return inner group if this model only contains a group as single child.

This function is used when we evaluate operations like subtract() {} or hull() {}. When evaluating these operations, we want to iterate over the group’s children.

pub fn set_id(&self, id: Identifier)

Set the id of a model. This happens if the model was created by an assignment.

For example, the assignment statement a = Circle(4mm) will result in a model with id a.

impl Model

Iterator methods.

pub fn descendants(&self) -> Descendants

Returns an iterator of models to this model and its unnamed descendants, in tree order.

Includes the current model.

pub fn multiplicity_descendants(&self) -> MultiplicityDescendants

An iterator that descends to multiplicity nodes.

pub fn source_file_descendants(&self) -> SourceFileDescendants

Returns an iterator of models that belong to the same source file as this one

pub fn parents(&self) -> Parents

Parents iterator.

pub fn ancestors(&self) -> Ancestors

Ancestors iterator.

pub fn get_property(&self, id: &Identifier) -> Option<Value>

Get a property from this model.

pub fn set_property(&mut self, id: Identifier, value: Value) -> Option<Value>

Set a property in this model.

pub fn add_property(&self, id: Identifier, value: Value)

Add a new property to the model.

impl Model

pub fn prerender(&self, resolution: RenderResolution) -> RenderResult<usize>

Pre-render the model.

Pre-rendering create as render output and calculates the matrices, resolutions and hashes of a model.

Trait Implementations

impl AttributesAccess for Model

fn get_attributes_by_id(&self, id: &Identifier) -> Vec<Attribute>

Get a value attribute by id.

fn get_single_attribute(&self, id: &Identifier) -> Option<Attribute>

Get a single attributes.

fn get_attribute_value(&self, id: &Identifier) -> Value

Get single attribute as value.

fn get_resolution(&self) -> Option<ResolutionAttribute>

Get resolution attribute.

fn get_color(&self) -> Option<Color>

Color (builtin attribute).

fn get_size(&self) -> Option<Size2>

Get size.

fn get_exports(&self) -> Vec<ExportCommand>

Get all export commands.

fn get_measures(&self) -> Vec<MeasureCommand>

Get all measure commands.

fn get_custom_attributes(&self, id: &Identifier) -> Vec<Tuple>

Get custom attributes.

impl CalcBounds2D for Model

fn calc_bounds_2d(&self) -> Bounds2D

Fetch bounds.

impl CallMethod<Option<Model>> for Model

fn call_method( &self, name: &QualifiedName, args: &ArgumentValueList, context: &mut EvalContext, ) -> EvalResult<Option<Model>>

Evaluate method call into a value (if possible)

impl Clone for Model

fn clone(&self) -> Model

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComputedHash for Model

fn computed_hash(&self) -> HashId

Return computed hash value.

impl Debug for Model

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

Formats the value using the given formatter.

impl DerefMut for Model

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Model

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

Formats the value using the given formatter.

impl Eval<Model> for Rc<SourceFile>

fn eval(&self, context: &mut EvalContext) -> EvalResult<Model>

Evaluate a syntax element into a type T.

impl From<&Model> for RenderAttributes

fn from(model: &Model) -> Self

Converts to this type from the input type.

impl From<Model> for Value

fn from(model: Model) -> Self

Converts to this type from the input type.

impl FromIterator<Model> for Models

fn from_iter<T: IntoIterator<Item = Model>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Model

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 PartialEq for Model

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 RenderWithContext<Model> for Model

fn render_with_context( &self, context: &mut RenderContext, ) -> RenderResult<Model>

Render method.

impl RenderWithContext<Rc<WithBounds2D<Geometry2D>>> for Model

This implementation renders a Geometry2D out of a Model.

Notes:

• The impl attaches the output geometry to the model’s render output.
• It is assumed the model has been pre-rendered.

fn render_with_context( &self, context: &mut RenderContext, ) -> RenderResult<Geometry2DOutput>

Render method.

impl RenderWithContext<Rc<WithBounds3D<Geometry3D>>> for Model

This implementation renders a Geometry3D out of a Model.

Notes:

• The impl attaches the output geometry to the model’s render output.
• It is assumed the model has been pre-rendered.

fn render_with_context( &self, context: &mut RenderContext, ) -> RenderResult<Geometry3DOutput>

Render method.

impl SrcReferrer for Model

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.

impl TreeDisplay for Model

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

Write item into f and use {:depth$} syntax in front of your single line output to get proper indention.

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

Display as tree starting at depth 0.

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

Display as tree starting at given depth in debug mode

fn write_tree(&self, f: &mut impl Write) -> Result<()>

Display as tree starting at depth 0 into a file

impl WriteToFile for Model

fn write_to_file(&self, filename: &impl AsRef<Path>) -> Result<()>

Write something to a file.

impl Deref for Model

type Target = RcMut<ModelInner>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.