Struct kcl_lib::executor::SketchGroup

pub struct SketchGroup {
    pub id: Uuid,
    pub value: Vec<Path>,
    pub start: BasePath,
    pub position: Position,
    pub rotation: Rotation,
    pub meta: Vec<Metadata>,
}

A sketch group is a collection of paths.

Fields

id: Uuid

The id of the sketch group.

value: Vec<Path>

The paths in the sketch group.

start: BasePath

The starting path.

position: Position

The position of the sketch group.

rotation: Rotation

The rotation of the sketch group.

meta: Vec<Metadata>

Metadata.

Implementations

impl SketchGroup

pub fn get_path_by_id(&self, id: &Uuid) -> Option<&Path>

pub fn get_path_by_name(&self, name: &str) -> Option<&Path>

pub fn get_base_by_name_or_start(&self, name: &str) -> Option<&BasePath>

pub fn get_coords_from_paths(&self) -> Result<Point2d, KclError>

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 JsonSchema for SketchGroup

fn schema_name() -> String

The name of the generated JSON Schema.

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<SketchGroup> for SketchGroup

fn eq(&self, other: &SketchGroup) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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

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

fn decl() -> String

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

fn name() -> String

Name of this type in TypeScript.

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 an type declaration. This function will panic if the type cannot be flattened.

fn dependencies() -> Vec<Dependency>where Self: 'static,

Information about types this type depends on. This is used for resolving imports when exporting to a file.

fn transparent() -> bool

true if this is a transparent type, e.g tuples or a list. This is used for resolving imports when using the export! macro.

fn name_with_type_args(args: Vec<String, Global>) -> String

Name of this type in TypeScript, with type arguments.

fn export() -> Result<(), ExportError>where Self: 'static,

Manually export this type to a file. The output file can be specified by annotating the type with #[ts(export_to = ".."]. By default, the filename will be derived from the types name.

fn export_to(path: impl AsRef<Path>) -> Result<(), ExportError>where Self: 'static,

Manually export this type to a file with a file with the specified path. This function will ignore the #[ts(export_to = "..)] attribute.

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.

impl StructuralPartialEq for SketchGroup