foocad-core/uk.co.nickthecoder.foocad.core.primitives

Package-level declarations

Types

Circle

class Circle(val radius: Double, val sides: Int) : Shape2d

A circle, and can also be used to form ellipses, and regular polygons.

Cube

open class Cube(val size: Vector3) : Shape3d

Cylinder

class Cylinder : Shape3d

A Cylinder, cone or truncated cone (whose top is parallel with the bottom).

FontNames

class FontNames

HAlignment

enum HAlignment : Enum<HAlignment>

Horizontal alignment of Text. Used within TextStyle.

Polygon

class Polygon : Shape2d

A general polygon from lists of points. A simple polygon has a single Path2d defining its outline. However here we have a list of paths, which can be used in two ways...

Polyhedron

class Polyhedron(val points: List<Vector3>, val faces: List<List<Int>>, val convexity: Int? = null) : Shape3d

A general purpose polyhedron created by defining all the vertices (points), and how these vertices are joined to form faces.

Sphere

class Sphere(val radius: Double, val sides: Int) : Shape3d

A sphere. Like all shapes in FooCAD, the sphere is approximated using a number of triangles. You can let FooCAD determine the number of triangles by omitting sides.

Square

class Square(val size: Vector2) : Shape2d

Text

class Text(val text: String, val style: TextStyle) : Shape2d, Customisable

By default, the text is rendered by OpenSCAD. However, sometimes we want to know the size of this shape (e.g. when using center). So we sometimes need to render the text within FooCAD too. This can cause problems, because the two font rendering system are different, and can give quite different results. In particular the size as reported by FooCAD is often slightly wrong compared with the actual size seen within OpenSCAD.

TextDirection

enum TextDirection : Enum<TextDirection>

Text direction, currently only left to right, and right to left are supported. Note OpenSCAD also support top to bottom and bottom to top. These may be added at a later date. Get in touch if you care about these other directions.

TextStyle

class TextStyle(val fontName: String, val fontSize: Float = 10.0f, val hAlign: HAlignment = HAlignment.LEFT, val vAlign: VAlignment = VAlignment.BASELINE, val spacing: Double = 1.0, val direction: TextDirection = TextDirection.LTR, val lineSpacing: Double = 1.0, val color: Color? = null) : Customisable

A TextStyle allows you to define a style, and then use it for many Text objects, which cuts down on duplicate code.

VAlignment

enum VAlignment : Enum<VAlignment>

Vertical alignment of Text. Used within TextStyle.

Properties

STANDARD_FONT_NAMES

val STANDARD_FONT_NAMES: Map<String, String>