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

Package-level declarations

Types

BezierEase

class BezierEase(x1: Double, y1: Double, x2: Double, y2: Double) : Ease

Imagine a 2D bezier curve from 0,0 to 1,1 using the intermediate points x1,y1 and x2,y2.

Color

class Color(r: Float, g: Float, b: Float, o: Float)

Custom

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY_GETTER])

annotation class Custom(val about: String = "", val min: Double = java.lang.Double.NEGATIVE_INFINITY, val max: Double = java.lang.Double.POSITIVE_INFINITY, val slider: Boolean = false, val lines: Int = 1, val fontName: Boolean = false, val additional: Boolean = false)

Tag var fields of your Model, and they will appear in the customiser. This will let you (or others) create alternate versions of the model with customised parameters values.

Degrees

class Degrees

Trig functions, which take and return angles in degrees rather than radians.

Ease

interface Ease

Takes a number in the range 0..1 and returns another in the same range

Eases

object Eases

LinearEase

class LinearEase : Ease

Log

class Log

Note, this is a fully static class, with @JvmStatic methods, so that Feather Scripts can use these methods.

Logger

interface Logger

Matrix2d

class Matrix2d(val x1y1: Double = 1.0, val x2y1: Double = 0.0, val x3y1: Double = 0.0, val x1y2: Double = 0.0, val x2y2: Double = 1.0, val x3y2: Double = 0.0)

Note. if this only needed for affine transformations, then the bottom row can be hard coded to 0,0,1 This will simplify the maths.

Matrix3d

class Matrix3d(val x1y1: Double = 1.0, val x2y1: Double = 0.0, val x3y1: Double = 0.0, val x4y1: Double = 0.0, val x1y2: Double = 0.0, val x2y2: Double = 1.0, val x3y2: Double = 0.0, val x4y2: Double = 0.0, val x1y3: Double = 0.0, val x2y3: Double = 0.0, val x3y3: Double = 1.0, val x4y3: Double = 0.0)

Note. if this only needed for affine transformations, then the bottom row can be hard coded to 0,0,0,1 This will simplify the maths.

NoFacesException

class NoFacesException(val shape: Shape3d) : Exception

Most 3D shapes do not know their Shape3d.points nor Shape3d.faces, and throw this exception when either are accessed. Most 3D shapes rely on OpenSCAD's renderer.

NoPathsException

class NoPathsException(val shape: Shape2d) : Exception

Some 2d shapes, such as Union2d, Difference2d and Hull2d do not store the points which make up the shape. This exception is thrown when such a shape is used with a method that requires the point data.

NullLogger

object NullLogger : Logger

SystemOutLogger

class SystemOutLogger : Logger

Vector2

class Vector2(val x: Double, val y: Double)

Vector3

class Vector3(val x: Double, val y: Double, val z: Double)

Properties

isWindows

val isWindows: Boolean

Are we running on a Windows operating system?

pathWithoutExtension

val File.pathWithoutExtension: String

Functions

barrelGet

fun <T> List<T>.barrelGet(index: Int): T

bezierTo

fun bezierTo(a: Vector2, b: Vector2, c: Vector2, d: Vector2): List<Vector2>

fun bezierTo(a: Vector3, b: Vector3, c: Vector3, d: Vector3): List<Vector3>

fun bezierTo(a: Vector2, b: Vector2, c: Vector2, d: Vector2, sides: Int): List<Vector2>

fun bezierTo(a: Vector3, b: Vector3, c: Vector3, d: Vector3, sides: Int): List<Vector3>

bezierToWithEnd

fun bezierToWithEnd(a: Vector2, b: Vector2, c: Vector2, d: Vector2, sides: Int): List<Vector2>

ellipticalArc

fun ellipticalArc(a: Vector2, b: Vector2, radius: Vector2, degrees: Double, largeArc: Boolean, sweep: Boolean): List<Vector2>

fun ellipticalArc(a: Vector2, b: Vector2, radius: Vector2, degrees: Double, largeArc: Boolean, sweep: Boolean, sides: Int?): List<Vector2>

Creates an elliptical arc from point a to point b whose radius is radius and whose x axis is rotated by degrees. See https://www.w3.org/TR/SVG11/paths.html#PathDataEllipticalArcCommands

humanString

fun Double.humanString(): String

fun Float.humanString(): String

max2