gleamscad - v1.0.0

gleamscad

Types

CenteredOrNot

</> 
pub type CenteredOrNot {
  Centered
  NotCentered
}

Constructors 

  • Centered
  • NotCentered

OpenSCADExpr

</>

builder pattern for our OpenSCAD expressions:

pub type OpenSCADExpr {
  Union(expressions: List(OpenSCADExpr))
  Difference(expressions: List(OpenSCADExpr))
  Intersection(expressions: List(OpenSCADExpr))
  Translate(expr: OpenSCADExpr, vector: #(Float, Float, Float))
  Rotate(expr: OpenSCADExpr, angle: #(Float, Float, Float))
  Scale(expr: OpenSCADExpr, vector: #(Float, Float, Float))
  Mirror(expr: OpenSCADExpr, vector: #(Float, Float, Float))
  Circle(value: Float, rod: RadiusOrDiameter)
  Square(width: Float, height: Float, center: CenteredOrNot)
  Polygon(List(#(Float, Float)))
  Cube(size: #(Float, Float, Float), center: CenteredOrNot)
  Sphere(value: Float, rod: RadiusOrDiameter)
  Cylinder(
    height: Float,
    value: Float,
    rod: RadiusOrDiameter,
    center: CenteredOrNot,
  )
  Cylinder2(
    height: Float,
    value1: Float,
    value2: Float,
    rod: RadiusOrDiameter,
    center: CenteredOrNot,
  )
  LinearExtrude(
    expr: OpenSCADExpr,
    height: Float,
    center: CenteredOrNot,
    convexity: Float,
    twist: Float,
    slices: Float,
  )
  CustomCode(code: String)
}

Constructors

RadiusOrDiameter

</> 
pub type RadiusOrDiameter {
  Radius
  Diameter
}

Constructors 

  • Radius
  • Diameter

Values

circle

</> 
pub fn circle(
  value: Float,
  rod: RadiusOrDiameter,
) -> OpenSCADExpr

Draws a 2d circle

cube

</> 
pub fn cube(size: Float, center: CenteredOrNot) -> OpenSCADExpr

Creates a 3d cube with all sides of equal length

cube3

</> 
pub fn cube3(
  width: Float,
  depth: Float,
  height: Float,
  center: CenteredOrNot,
) -> OpenSCADExpr

Creates a 3d cube

custom_code

</> 
pub fn custom_code(code: String) -> OpenSCADExpr

Allows for adding custom code

cylinder

</> 
pub fn cylinder(
  height: Float,
  value: Float,
  rod: RadiusOrDiameter,
  center: CenteredOrNot,
) -> OpenSCADExpr

Creates a 3d cylinder

cylinder2

</> 
pub fn cylinder2(
  height: Float,
  value1: Float,
  value2: Float,
  rod: RadiusOrDiameter,
  center: CenteredOrNot,
) -> OpenSCADExpr

Creates a 3d cylinder. Enables you to pass different diameters/radii for top and bottom

difference

</> 
pub fn difference(
  expressions: List(OpenSCADExpr),
) -> OpenSCADExpr

Create a difference of shapes

intersection

</> 
pub fn intersection(
  expressions: List(OpenSCADExpr),
) -> OpenSCADExpr

Creates an intersection of shapes

linear_extrude

</> 
pub fn linear_extrude(
  expr: OpenSCADExpr,
  height: Float,
  center: CenteredOrNot,
  convexity: Float,
  twist: Float,
  slices: Float,
) -> OpenSCADExpr

mirror

</> 
pub fn mirror(
  expr: OpenSCADExpr,
  x: Float,
  y: Float,
  z: Float,
) -> OpenSCADExpr

Mirrors a shape

polygon

</> 
pub fn polygon(polygons: List(#(Float, Float))) -> OpenSCADExpr

Draws a 2d polygon

rotate

</> 
pub fn rotate(
  expr: OpenSCADExpr,
  x: Float,
  y: Float,
  z: Float,
) -> OpenSCADExpr

Rotate a shape

scale

</> 
pub fn scale(
  expr: OpenSCADExpr,
  x: Float,
  y: Float,
  z: Float,
) -> OpenSCADExpr

Scales a shape

sphere

</> 
pub fn sphere(
  value: Float,
  rod: RadiusOrDiameter,
) -> OpenSCADExpr

Creates a 3d sphere

square

</> 
pub fn square(
  width: Float,
  height: Float,
  center: CenteredOrNot,
) -> OpenSCADExpr

Draws a 2d square

to_openscad

</> 
pub fn to_openscad(expr: OpenSCADExpr) -> String

Exports the data to a string, containing OpenSCAD code

translate

</> 
pub fn translate(
  expr: OpenSCADExpr,
  x: Float,
  y: Float,
  z: Float,
) -> OpenSCADExpr

Translate (move) a shape

union

</> 
pub fn union(expressions: List(OpenSCADExpr)) -> OpenSCADExpr

Create a union of shapes

✨ Search Document