Module primitives

Module primitives 

Source
Expand description

This module defines primitive shapes. The origin is (0, 0) for 2D primitives and (0, 0, 0) for 3D primitives, unless stated otherwise.

Structs§

Annulus
A primitive shape formed by the region between two circles, also known as a ring.
Arc2d
A primitive representing an arc between two points on a circle.
Capsule2d
A 2D capsule primitive, also known as a stadium or pill shape.
Capsule3d
A 3D capsule primitive centered on the origin A three-dimensional capsule is defined as a surface at a distance (radius) from a line
Circle
A circle primitive, representing the set of points some distance from the origin
CircularSector
A primitive representing a circular sector: a pie slice of a circle.
CircularSegment
A primitive representing a circular segment: the area enclosed by the arc of a circle and its chord (the line between its endpoints).
Cone
A cone primitive centered on the midpoint between the tip of the cone and the center of its base.
ConicalFrustum
A conical frustum primitive. A conical frustum can be created by slicing off a section of a cone.
ConvexPolygon
A convex polygon with N vertices.
Cuboid
A cuboid primitive, which is like a cube, except that the x, y, and z dimensions are not required to be the same.
Cylinder
A cylinder primitive centered on the origin
Ellipse
An ellipse primitive, which is like a circle, but the width and height can be different
Extrusion
A 3D shape representing an extruded 2D base_shape.
InfinitePlane3d
An unbounded plane in 3D space. It forms a separating surface through the origin, stretching infinitely far
Line2d
An infinite line going through the origin along a direction in 2D space.
Line3d
An infinite line going through the origin along a direction in 3D space.
Plane2d
An unbounded plane in 2D space. It forms a separating surface through the origin, stretching infinitely far
Plane3d
A bounded plane in 3D space. It forms a surface starting from the origin with a defined height and width.
Polygon
A polygon with N vertices.
Polyline2d
A series of connected line segments in 2D space.
Polyline3d
A series of connected line segments in 3D space.
Rectangle
A rectangle primitive, which is like a square, except that the width and height can be different
RegularPolygon
A polygon centered on the origin where all vertices lie on a circle, equally far apart.
Rhombus
A rhombus primitive, also known as a diamond shape. A four sided polygon, centered on the origin, where opposite sides are parallel but without requiring right angles.
Segment2d
A line segment defined by two endpoints in 2D space.
Segment3d
A line segment defined by two endpoints in 3D space.
Sphere
A sphere primitive, representing the set of all points some distance from the origin
Tetrahedron
A tetrahedron primitive.
Torus
A torus primitive, often representing a ring or donut shape The set of points some distance from a circle centered at the origin
Triangle2d
A triangle in 2D space
Triangle3d
A 3D triangle primitive.

Enums§

ConvexPolygonError
An error that happens when creating a ConvexPolygon.
TorusKind
The type of torus determined by the minor and major radii
WindingOrder
The winding order for a set of points

Traits§

Measured2d
A trait for getting measurements of 2D shapes
Measured3d
A trait for getting measurements of 3D shapes
Primitive2d
A marker trait for 2D primitives
Primitive3d
A marker trait for 3D primitives