f5c244dbb1
This has been enforced by the parser since #6639, so there's no need for `keywords = true` in every stdlib function anymore.
315 lines
9.0 KiB
Rust
315 lines
9.0 KiB
Rust
//! Standard library appearance.
|
|
|
|
use anyhow::Result;
|
|
use kcl_derive_docs::stdlib;
|
|
use kcmc::{each_cmd as mcmd, ModelingCmd};
|
|
use kittycad_modeling_cmds::{self as kcmc, shared::Color};
|
|
use regex::Regex;
|
|
use rgba_simple::Hex;
|
|
|
|
use super::args::TyF64;
|
|
use crate::{
|
|
errors::{KclError, KclErrorDetails},
|
|
execution::{types::RuntimeType, ExecState, KclValue, SolidOrImportedGeometry},
|
|
std::Args,
|
|
};
|
|
|
|
lazy_static::lazy_static! {
|
|
static ref HEX_REGEX: Regex = Regex::new(r"^#[0-9a-fA-F]{6}$").unwrap();
|
|
}
|
|
|
|
/// Set the appearance of a solid. This only works on solids, not sketches or individual paths.
|
|
pub async fn appearance(exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
|
|
let solids = args.get_unlabeled_kw_arg_typed(
|
|
"solids",
|
|
&RuntimeType::Union(vec![RuntimeType::solids(), RuntimeType::imported()]),
|
|
exec_state,
|
|
)?;
|
|
|
|
let color: String = args.get_kw_arg("color")?;
|
|
let metalness: Option<TyF64> = args.get_kw_arg_opt_typed("metalness", &RuntimeType::count(), exec_state)?;
|
|
let roughness: Option<TyF64> = args.get_kw_arg_opt_typed("roughness", &RuntimeType::count(), exec_state)?;
|
|
|
|
// Make sure the color if set is valid.
|
|
if !HEX_REGEX.is_match(&color) {
|
|
return Err(KclError::Semantic(KclErrorDetails::new(
|
|
format!("Invalid hex color (`{}`), try something like `#fff000`", color),
|
|
vec![args.source_range],
|
|
)));
|
|
}
|
|
|
|
let result = inner_appearance(
|
|
solids,
|
|
color,
|
|
metalness.map(|t| t.n),
|
|
roughness.map(|t| t.n),
|
|
exec_state,
|
|
args,
|
|
)
|
|
.await?;
|
|
Ok(result.into())
|
|
}
|
|
|
|
/// Set the appearance of a solid. This only works on solids, not sketches or individual paths.
|
|
///
|
|
/// This will work on any solid, including extruded solids, revolved solids, and shelled solids.
|
|
/// ```no_run
|
|
/// // Add color to an extruded solid.
|
|
/// exampleSketch = startSketchOn(XZ)
|
|
/// |> startProfile(at = [0, 0])
|
|
/// |> line(endAbsolute = [10, 0])
|
|
/// |> line(endAbsolute = [0, 10])
|
|
/// |> line(endAbsolute = [-10, 0])
|
|
/// |> close()
|
|
///
|
|
/// example = extrude(exampleSketch, length = 5)
|
|
/// // There are other options besides 'color', but they're optional.
|
|
/// |> appearance(color='#ff0000')
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // Add color to a revolved solid.
|
|
/// sketch001 = startSketchOn(XY)
|
|
/// |> circle( center = [15, 0], radius = 5 )
|
|
/// |> revolve( angle = 360, axis = Y)
|
|
/// |> appearance(
|
|
/// color = '#ff0000',
|
|
/// metalness = 90,
|
|
/// roughness = 90
|
|
/// )
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // Add color to different solids.
|
|
/// fn cube(center) {
|
|
/// return startSketchOn(XY)
|
|
/// |> startProfile(at = [center[0] - 10, center[1] - 10])
|
|
/// |> line(endAbsolute = [center[0] + 10, center[1] - 10])
|
|
/// |> line(endAbsolute = [center[0] + 10, center[1] + 10])
|
|
/// |> line(endAbsolute = [center[0] - 10, center[1] + 10])
|
|
/// |> close()
|
|
/// |> extrude(length = 10)
|
|
/// }
|
|
///
|
|
/// example0 = cube(center = [0, 0])
|
|
/// example1 = cube(center = [20, 0])
|
|
/// example2 = cube(center = [40, 0])
|
|
///
|
|
/// appearance([example0, example1], color='#ff0000', metalness=50, roughness=50)
|
|
/// appearance(example2, color='#00ff00', metalness=50, roughness=50)
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // You can set the appearance before or after you shell it will yield the same result.
|
|
/// // This example shows setting the appearance _after_ the shell.
|
|
/// firstSketch = startSketchOn(XY)
|
|
/// |> startProfile(at = [-12, 12])
|
|
/// |> line(end = [24, 0])
|
|
/// |> line(end = [0, -24])
|
|
/// |> line(end = [-24, 0])
|
|
/// |> close()
|
|
/// |> extrude(length = 6)
|
|
///
|
|
/// shell(
|
|
/// firstSketch,
|
|
/// faces = [END],
|
|
/// thickness = 0.25,
|
|
/// )
|
|
/// |> appearance(
|
|
/// color = '#ff0000',
|
|
/// metalness = 90,
|
|
/// roughness = 90
|
|
/// )
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // You can set the appearance before or after you shell it will yield the same result.
|
|
/// // This example shows setting the appearance _before_ the shell.
|
|
/// firstSketch = startSketchOn(XY)
|
|
/// |> startProfile(at = [-12, 12])
|
|
/// |> line(end = [24, 0])
|
|
/// |> line(end = [0, -24])
|
|
/// |> line(end = [-24, 0])
|
|
/// |> close()
|
|
/// |> extrude(length = 6)
|
|
/// |> appearance(
|
|
/// color = '#ff0000',
|
|
/// metalness = 90,
|
|
/// roughness = 90
|
|
/// )
|
|
///
|
|
/// shell(
|
|
/// firstSketch,
|
|
/// faces = [END],
|
|
/// thickness = 0.25,
|
|
/// )
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // Setting the appearance of a 3D pattern can be done _before_ or _after_ the pattern.
|
|
/// // This example shows _before_ the pattern.
|
|
/// exampleSketch = startSketchOn(XZ)
|
|
/// |> startProfile(at = [0, 0])
|
|
/// |> line(end = [0, 2])
|
|
/// |> line(end = [3, 1])
|
|
/// |> line(end = [0, -4])
|
|
/// |> close()
|
|
///
|
|
/// example = extrude(exampleSketch, length = 1)
|
|
/// |> appearance(
|
|
/// color = '#ff0000',
|
|
/// metalness = 90,
|
|
/// roughness = 90
|
|
/// )
|
|
/// |> patternLinear3d(
|
|
/// axis = [1, 0, 1],
|
|
/// instances = 7,
|
|
/// distance = 6
|
|
/// )
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // Setting the appearance of a 3D pattern can be done _before_ or _after_ the pattern.
|
|
/// // This example shows _after_ the pattern.
|
|
/// exampleSketch = startSketchOn(XZ)
|
|
/// |> startProfile(at = [0, 0])
|
|
/// |> line(end = [0, 2])
|
|
/// |> line(end = [3, 1])
|
|
/// |> line(end = [0, -4])
|
|
/// |> close()
|
|
///
|
|
/// example = extrude(exampleSketch, length = 1)
|
|
/// |> patternLinear3d(
|
|
/// axis = [1, 0, 1],
|
|
/// instances = 7,
|
|
/// distance = 6
|
|
/// )
|
|
/// |> appearance(
|
|
/// color = '#ff0000',
|
|
/// metalness = 90,
|
|
/// roughness = 90
|
|
/// )
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // Color the result of a 2D pattern that was extruded.
|
|
/// exampleSketch = startSketchOn(XZ)
|
|
/// |> startProfile(at = [.5, 25])
|
|
/// |> line(end = [0, 5])
|
|
/// |> line(end = [-1, 0])
|
|
/// |> line(end = [0, -5])
|
|
/// |> close()
|
|
/// |> patternCircular2d(
|
|
/// center = [0, 0],
|
|
/// instances = 13,
|
|
/// arcDegrees = 360,
|
|
/// rotateDuplicates = true
|
|
/// )
|
|
///
|
|
/// example = extrude(exampleSketch, length = 1)
|
|
/// |> appearance(
|
|
/// color = '#ff0000',
|
|
/// metalness = 90,
|
|
/// roughness = 90
|
|
/// )
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // Color the result of a sweep.
|
|
///
|
|
/// // Create a path for the sweep.
|
|
/// sweepPath = startSketchOn(XZ)
|
|
/// |> startProfile(at = [0.05, 0.05])
|
|
/// |> line(end = [0, 7])
|
|
/// |> tangentialArc(angle = 90, radius = 5)
|
|
/// |> line(end = [-3, 0])
|
|
/// |> tangentialArc(angle = -90, radius = 5)
|
|
/// |> line(end = [0, 7])
|
|
///
|
|
/// pipeHole = startSketchOn(XY)
|
|
/// |> circle(
|
|
/// center = [0, 0],
|
|
/// radius = 1.5,
|
|
/// )
|
|
///
|
|
/// sweepSketch = startSketchOn(XY)
|
|
/// |> circle(
|
|
/// center = [0, 0],
|
|
/// radius = 2,
|
|
/// )
|
|
/// |> subtract2d(tool = pipeHole)
|
|
/// |> sweep(path = sweepPath)
|
|
/// |> appearance(
|
|
/// color = "#ff0000",
|
|
/// metalness = 50,
|
|
/// roughness = 50
|
|
/// )
|
|
/// ```
|
|
///
|
|
/// ```no_run
|
|
/// // Change the appearance of an imported model.
|
|
///
|
|
/// import "tests/inputs/cube.sldprt" as cube
|
|
///
|
|
/// cube
|
|
/// |> appearance(
|
|
/// color = "#ff0000",
|
|
/// metalness = 50,
|
|
/// roughness = 50
|
|
/// )
|
|
/// ```
|
|
#[stdlib {
|
|
name = "appearance",
|
|
unlabeled_first = true,
|
|
args = {
|
|
solids = { docs = "The solid(s) whose appearance is being set" },
|
|
color = { docs = "Color of the new material, a hex string like '#ff0000'"},
|
|
metalness = { docs = "Metalness of the new material, a percentage like 95.7." },
|
|
roughness = { docs = "Roughness of the new material, a percentage like 95.7." },
|
|
}
|
|
}]
|
|
async fn inner_appearance(
|
|
solids: SolidOrImportedGeometry,
|
|
color: String,
|
|
metalness: Option<f64>,
|
|
roughness: Option<f64>,
|
|
exec_state: &mut ExecState,
|
|
args: Args,
|
|
) -> Result<SolidOrImportedGeometry, KclError> {
|
|
let mut solids = solids.clone();
|
|
|
|
for solid_id in solids.ids(&args.ctx).await? {
|
|
// Set the material properties.
|
|
let rgb = rgba_simple::RGB::<f32>::from_hex(&color).map_err(|err| {
|
|
KclError::Semantic(KclErrorDetails::new(
|
|
format!("Invalid hex color (`{color}`): {err}"),
|
|
vec![args.source_range],
|
|
))
|
|
})?;
|
|
|
|
let color = Color {
|
|
r: rgb.red,
|
|
g: rgb.green,
|
|
b: rgb.blue,
|
|
a: 100.0,
|
|
};
|
|
|
|
args.batch_modeling_cmd(
|
|
exec_state.next_uuid(),
|
|
ModelingCmd::from(mcmd::ObjectSetMaterialParamsPbr {
|
|
object_id: solid_id,
|
|
color,
|
|
metalness: metalness.unwrap_or_default() as f32 / 100.0,
|
|
roughness: roughness.unwrap_or_default() as f32 / 100.0,
|
|
ambient_occlusion: 0.0,
|
|
}),
|
|
)
|
|
.await?;
|
|
|
|
// Idk if we want to actually modify the memory for the colors, but I'm not right now since
|
|
// I can't think of a use case for it.
|
|
}
|
|
|
|
Ok(solids)
|
|
}
|