Struct Sketch 

pub struct Sketch {

    pub id: Uuid,
    pub paths: Vec<Path>,
    pub inner_paths: Vec<Path>,
    pub on: SketchSurface,
    pub start: BasePath,
    pub tags: IndexMap<String, TagIdentifier>,
    pub artifact_id: ArtifactId,
    pub original_id: Uuid,
    pub mirror: Option<Uuid>,
    pub clone: Option<Uuid>,
    pub synthetic_jump_path_ids: Vec<Uuid>,
    pub units: UnitLength,
    pub meta: Vec<Metadata>,
    pub is_closed: ProfileClosed,
}

Fields

id: Uuid

The id of the sketch (this will change when the engine’s reference to it changes).

paths: Vec<Path>

The paths in the sketch. Only paths on the “outside” i.e. the perimeter. Does not include paths “inside” the profile (for example, edges made by subtracting a profile)

inner_paths: Vec<Path>

Inner paths, resulting from subtract2d to carve profiles out of the sketch.

on: SketchSurface

What the sketch is on (can be a plane or a face).

start: BasePath

The starting path.

tags: IndexMap<String, TagIdentifier>

Tag identifiers that have been declared in this sketch.

artifact_id: ArtifactId

The original id of the sketch. This stays the same even if the sketch is is sketched on face etc.

original_id: Uuid

mirror: Option<Uuid>

If the sketch includes a mirror.

clone: Option<Uuid>

If the sketch is a clone of another sketch.

synthetic_jump_path_ids: Vec<Uuid>

Synthetic pen-jump paths inserted to replay disconnected segment selections.

units: UnitLength

meta: Vec<Metadata>

Metadata.

is_closed: ProfileClosed

Has the profile been closed? If not given, defaults to yes, closed explicitly.

Trait Implementations

impl Clone for Sketch

fn clone(&self) -> Sketch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sketch

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

Formats the value using the given formatter.

impl<'a> FromKclValue<'a> for Box<Sketch>

fn from_kcl_val(arg: &'a KclValue) -> Option<Self>

Try to convert a KclValue into this type.

impl<'a> FromKclValue<'a> for Sketch

fn from_kcl_val(arg: &'a KclValue) -> Option<Self>

Try to convert a KclValue into this type.

impl GeometryTrait for Sketch

type Set = Vec<Sketch>

fn set_id(&mut self, id: Uuid)

fn id(&self) -> Uuid

fn original_id(&self) -> Uuid

fn array_to_point3d( val: &KclValue, source_ranges: Vec<SourceRange>, exec_state: &mut ExecState, ) -> Result<[TyF64; 3], KclError>

async fn flush_batch( _: &Args, _: &mut ExecState, _: &Self::Set, ) -> Result<(), KclError>

impl PartialEq for Sketch

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for Sketch

type WithoutGenerics = Sketch

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = Sketch

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

impl StructuralPartialEq for Sketch