Struct kcl_lib::executor::SketchGroup

pub struct SketchGroup {
    pub id: Uuid,
    pub value: Vec<Path>,
    pub on: SketchSurface,
    pub start: BasePath,
    pub tags: HashMap<String, TagIdentifier>,
    pub original_id: Uuid,
    pub meta: Vec<Metadata>,
}

A sketch group is a collection of paths.

Fields

id: Uuid

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

value: Vec<Path>

The paths in the sketch group.

on: SketchSurface

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

start: BasePath

The starting path.

tags: HashMap<String, TagIdentifier>

Tag identifiers that have been declared in this sketch group.

original_id: Uuid

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

meta: Vec<Metadata>

Metadata.

Trait Implementations

impl Clone for SketchGroup

fn clone(&self) -> SketchGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SketchGroup

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SketchGroup

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SketchGroup> for Vec<Box<SketchGroup>>

fn from(sg: &SketchGroup) -> Self

Converts to this type from the input type.

impl From<SketchGroup> for SketchGroupSet

fn from(sg: SketchGroup) -> Self

Converts to this type from the input type.

impl<'a> FromKclValue<'a> for SketchGroup

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

Try to convert a KclValue into this type.

impl JsonSchema for SketchGroup

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 SketchGroup

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

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 SketchGroup

type WithoutGenerics = SketchGroup

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.

fn ident() -> String

Identifier of this type, excluding generic parameters.

const DOCS: Option<&'static str> = _

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

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> 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() -> String

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

fn inline() -> 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() -> 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<&'static Path>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> 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() -> 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_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> 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.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl StructuralPartialEq for SketchGroup