Files
modeling-app/docs/kcl/segAng.md
Paul Tagliamonte e1c45bdb33 Start to rework some of our kcl docs (#3222)
* Start to rework some of our kcl docs

Signed-off-by: Paul R. Tagliamonte <paul@zoo.dev>
2024-08-06 20:27:26 -04:00

176 KiB

title, excerpt, layout
title excerpt layout
segAng Compute the angle (in degrees) of the provided line segment. manual

Compute the angle (in degrees) of the provided line segment.

segAng(tag: TagIdentifier) -> number

Examples

const exampleSketch = startSketchOn('XZ')
  |> startProfileAt([0, 0], %)
  |> line([10, 0], %)
  |> line([5, 10], %, $seg01)
  |> line([-10, 0], %)
  |> angledLine([segAng(seg01), 10], %)
  |> line([-10, 0], %)
  |> angledLine([segAng(seg01), -15], %)
  |> close(%)

const example = extrude(4, exampleSketch)

Rendered example of segAng 0

Arguments

  • tag: TagIdentifier (REQUIRED)
{
	// Engine information for a tag.
	info: {
	// The id of the tagged object.
	id: uuid,
	// The path the tag is on.
	path: {
	// The from point.
	from: [number, number],
	// The tag of the path.
	tag: {
	digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
	end: number,
	start: number,
	value: string,
},
	// The to point.
	to: [number, number],
},
	// The sketch group the tag is on.
	sketchGroup: uuid,
	// The surface information for the tag.
	surface: {
	// The face id for the extrude plane.
	faceId: uuid,
	// The id of the geometry.
	id: uuid,
	// The source range.
	sourceRange: [number, number],
	// The tag.
	tag: {
	digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
	end: number,
	start: number,
	value: string,
},
	type: "extrudePlane",
} |
{
	// The face id for the extrude plane.
	faceId: uuid,
	// The id of the geometry.
	id: uuid,
	// The source range.
	sourceRange: [number, number],
	// The tag.
	tag: {
	digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
	end: number,
	start: number,
	value: string,
},
	type: "extrudeArc",
} |
{
	// The id for the chamfer surface.
	faceId: uuid,
	// The id of the geometry.
	id: uuid,
	// The source range.
	sourceRange: [number, number],
	// The tag.
	tag: {
	digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
	end: number,
	start: number,
	value: string,
},
	type: "chamfer",
} |
{
	// The id for the fillet surface.
	faceId: uuid,
	// The id of the geometry.
	id: uuid,
	// The source range.
	sourceRange: [number, number],
	// The tag.
	tag: {
	digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
	end: number,
	start: number,
	value: string,
},
	type: "fillet",
},
},
	value: string,
}

Returns

number