Struct NamedViewArtifact 

pub struct NamedViewArtifact {
    pub id: ArtifactId,
    pub name: String,
    pub camera: ArtifactCameraView,
    pub baseline: ArtifactVisibility,
    pub show_ids: Vec<ArtifactId>,
    pub hide_ids: Vec<ArtifactId>,
    pub code_ref: CodeRef,
}

A named view declared in KCL by view::named: a display name, camera intent and the objects the view shows or hides.

The view is data for a consumer to activate later, so this artifact holds no engine geometry and its creation sends no engine command. The objects are named by ARTIFACT id, so a consumer resolves each one through the artifact graph; an extruded solid’s engine id differs from its artifact id, and the translation belongs to whoever applies the view.

Fields

id: ArtifactId

name: String

The display name the author gave the view. Required, and unique among the views declared by the same module.

camera: ArtifactCameraView

baseline: ArtifactVisibility

Whether objects start visible or hidden, which decides which of the two lists below can act.

show_ids: Vec<ArtifactId>

Artifacts the view shows. Meaningful under a Hide baseline, where they are the only visible objects.

hide_ids: Vec<ArtifactId>

Artifacts the view hides. Meaningful under a Show baseline, where they are the only hidden objects.

code_ref: CodeRef

Trait Implementations

impl Clone for NamedViewArtifact

fn clone(&self) -> NamedViewArtifact

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NamedViewArtifact

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NamedViewArtifact

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for NamedViewArtifact

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(generator: &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 NamedViewArtifact

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for NamedViewArtifact

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NamedViewArtifact

impl TS for NamedViewArtifact

type WithoutGenerics = NamedViewArtifact

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 = NamedViewArtifact

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 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 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 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.