modeling-app/docs/kcl-std/functions/std-sketch-planeOf.md

title, subtitle, excerpt, layout

title	subtitle	excerpt	layout
planeOf	Function in std::sketch	Find the plane a face lies on. Returns an error if the face doesn't lie on any plane (for example, the curved face of a cylinder)	manual

Find the plane a face lies on. Returns an error if the face doesn't lie on any plane (for example, the curved face of a cylinder)

planeOf(
  @solid: Solid,
  face: TaggedFace,
): Plane

Arguments

Name	Type	Description	Required
solid	Solid	The solid whose face is being queried.	Yes
face	TaggedFace	Find the plane which this face lies on.	Yes

Returns

Plane - An abstract plane.

Examples

triangle = startSketchOn(XY)
  |> polygon(radius = 3, numSides = 3, center = [0, 0])
  |> extrude(length = 2)

// Find the plane of the triangle's top face.
topPlane = planeOf(triangle, face = END)

// Create a new plane, 10 units above the triangle's top face.
startSketchOn(offsetPlane(topPlane, offset = 10))