Files
simple-makes-complex/docs/docs/modules/MapGen.Tetrahedron.md

7.0 KiB

global MapGen.Tetrahedron


methods


Tetrahedron.new


function Tetrahedron.new(
  p1: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
},
  p2: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
},
  p3: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
},
  p4: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
}
) ->  MapGen.Tetrahedron {
    p1 = MapGen.Peak,
    p2 = MapGen.Peak,
    p3 = MapGen.Peak,
    p4 = MapGen.Peak,
    h1 = MapGen.Triangulation.Edge,
    h2 = MapGen.Triangulation.Edge,
    h3 = MapGen.Triangulation.Edge,
    h4 = MapGen.Triangulation.Edge,
    f1 = MapGen.Triangle,
    f2 = MapGen.Triangle,
    f3 = MapGen.Triangle,
    f4 = MapGen.Triangle,
    new = function,
    toString = function,
    getHeight = function,
    getCircumSphereCenter = function,
    getCircumSphereRadius = function,
    inCircumSphere = function,
}

Tetrahedron.toString


function Tetrahedron.toString() ->  string

Returns a string describing the object in a readable form.

Tetrahedron.getHeight


function Tetrahedron.getHeight(
  p1: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
},
  p2: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
},
  p3: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
},
  p4: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
}
) ->  MapGen.Triangulation.Edge?

Tetrahedron.getCircumSphereCenter


function Tetrahedron.getCircumSphereCenter() ->  vector

Returns the center of the circumscribed sphere.

Tetrahedron.getCircumSphereRadius


function Tetrahedron.getCircumSphereRadius() ->  number

Returns the radius of the circumscribed sphere.

Tetrahedron.inCircumSphere


function Tetrahedron.inCircumSphere(p: MapGen.Peak {
    id = number,
    getPeakPos = function,
    getColor = function,
    getGroups = function,
    new = function,
    toString = function,
    eq = function,
}) ->  boolean

Checks whether a given point lies within the circumscribed sphere of a tetrahedron.

fields


Tetrahedron.p1


Tetrahedron.p1 : MapGen.Peak {
    id: number,
    getPeakPos: function,
    getColor: function,
    getGroups: function,
    new: function,
    toString: function,
    eq: function,
}

Tetrahedron.p2


Tetrahedron.p2 : MapGen.Peak {
    id: number,
    getPeakPos: function,
    getColor: function,
    getGroups: function,
    new: function,
    toString: function,
    eq: function,
}

Tetrahedron.p3


Tetrahedron.p3 : MapGen.Peak {
    id: number,
    getPeakPos: function,
    getColor: function,
    getGroups: function,
    new: function,
    toString: function,
    eq: function,
}

Tetrahedron.p4


Tetrahedron.p4 : MapGen.Peak {
    id: number,
    getPeakPos: function,
    getColor: function,
    getGroups: function,
    new: function,
    toString: function,
    eq: function,
}

Tetrahedron.h1


Tetrahedron.h1 : MapGen.Triangulation.Edge {
    p1: MapGen.Peak,
    p2: MapGen.Peak,
    new: function,
    toString: function,
    eq: function,
    same: function,
    length: function,
    getMidPoint: function,
}

Tetrahedron.h2


Tetrahedron.h2 : MapGen.Triangulation.Edge {
    p1: MapGen.Peak,
    p2: MapGen.Peak,
    new: function,
    toString: function,
    eq: function,
    same: function,
    length: function,
    getMidPoint: function,
}

Tetrahedron.h3


Tetrahedron.h3 : MapGen.Triangulation.Edge {
    p1: MapGen.Peak,
    p2: MapGen.Peak,
    new: function,
    toString: function,
    eq: function,
    same: function,
    length: function,
    getMidPoint: function,
}

Tetrahedron.h4


Tetrahedron.h4 : MapGen.Triangulation.Edge {
    p1: MapGen.Peak,
    p2: MapGen.Peak,
    new: function,
    toString: function,
    eq: function,
    same: function,
    length: function,
    getMidPoint: function,
}

Tetrahedron.f1


Tetrahedron.f1 : MapGen.Triangle {
    p1: MapGen.Peak,
    p2: MapGen.Peak,
    p3: MapGen.Peak,
    e1: MapGen.Triangulation.Edge,
    e2: MapGen.Triangulation.Edge,
    e3: MapGen.Triangulation.Edge,
    h1: MapGen.Triangulation.Edge,
    h2: MapGen.Triangulation.Edge,
    h3: MapGen.Triangulation.Edge,
    neighbours: MapGen.Triangle.Neighbours,
    color: ColorString?,
    new: function,
    ...(+13)
}

Tetrahedron.f2


Tetrahedron.f2 : MapGen.Triangle {
    p1: MapGen.Peak,
    p2: MapGen.Peak,
    p3: MapGen.Peak,
    e1: MapGen.Triangulation.Edge,
    e2: MapGen.Triangulation.Edge,
    e3: MapGen.Triangulation.Edge,
    h1: MapGen.Triangulation.Edge,
    h2: MapGen.Triangulation.Edge,
    h3: MapGen.Triangulation.Edge,
    neighbours: MapGen.Triangle.Neighbours,
    color: ColorString?,
    new: function,
    ...(+13)
}

Tetrahedron.f3


Tetrahedron.f3 : MapGen.Triangle {
    p1: MapGen.Peak,
    p2: MapGen.Peak,
    p3: MapGen.Peak,
    e1: MapGen.Triangulation.Edge,
    e2: MapGen.Triangulation.Edge,
    e3: MapGen.Triangulation.Edge,
    h1: MapGen.Triangulation.Edge,
    h2: MapGen.Triangulation.Edge,
    h3: MapGen.Triangulation.Edge,
    neighbours: MapGen.Triangle.Neighbours,
    color: ColorString?,
    new: function,
    ...(+13)
}

Tetrahedron.f4


Tetrahedron.f4 : MapGen.Triangle {
    p1: MapGen.Peak,
    p2: MapGen.Peak,
    p3: MapGen.Peak,
    e1: MapGen.Triangulation.Edge,
    e2: MapGen.Triangulation.Edge,
    e3: MapGen.Triangulation.Edge,
    h1: MapGen.Triangulation.Edge,
    h2: MapGen.Triangulation.Edge,
    h3: MapGen.Triangulation.Edge,
    neighbours: MapGen.Triangle.Neighbours,
    color: ColorString?,
    new: function,
    ...(+13)
}