Skip to main content

Polygon

Extends ExtrudableGeometry

Inherited from Geometry

guide()

guide(): this

Marks this sketch geometry as construction geometry. Guide geometries are excluded from the final sketch output (e.g., extrude, revolve) unless explicitly included.


start()

start(): Vertex

Returns a lazy-evaluated vertex at the start point of this geometry element.

Returns: Vertex


end()

end(): Vertex

Returns a lazy-evaluated vertex at the end point of this geometry element.

Returns: Vertex


tangent()

tangent(): Vertex

Returns a lazy-evaluated vertex representing the tangent direction at the end of this geometry. Used to determine the direction of subsequent geometry elements.

Returns: Vertex

Inherited from SceneObject

name()

name(value: string): this

Sets a custom display name for this object, overriding the default type-based name.

ParameterTypeDescription
valuestringThe display name to assign.

reusable()

reusable(): this

Marks this object as reusable. Reusable objects retain their shapes when consumed by features (e.g., extrude, revolve), allowing multiple features to reference the same source geometry. Use remove(obj) to force-remove shapes from a reusable object.

Methods

getEdge()

getEdge(index: number): SceneObject

Returns a specific edge of the polygon by index.

Returns: SceneObject

ParameterTypeDescription
indexnumberZero-based edge index.

getVertex()

getVertex(index: number): Vertex

Returns a lazy-evaluated vertex at a specific corner of the polygon.

Returns: Vertex

ParameterTypeDescription
indexnumberZero-based vertex index.