Class: SolidML

SolidML(scriptopt, criteriaopt)

Construct fractal-like 3D models by cryptic script based on Structure Synth's' Eisen Script. SolidML.js does not depend on any other libraries. If you want to import model into three.js, see SolidML.BufferGeometry.

Constructor

new SolidML(scriptopt, criteriaopt)

Basically one instance for one script.
Parameters:
Name Type Attributes Default Description
script string <optional>
 null SolidML script to compile, calls SolidML#compile inside.
criteria object <optional>
 null default criteria of this structure, specified by "set *" commands in script.
Source:

Classes

BufferGeometry
BuildStatus
ColorHSBA
ColorPool
Criteria
Material
Matrix4
randMT
Rule

Members

(static) ColorTable :Object

svg name table for colors. SolidML.ColorTable["name"] returns hex string of the color.
Type:
  • Object
Source:

(static) VERSION :String

current version number
Type:
  • String
Source:

criteria :SolidML.Criteria

criteria of this structure, specified by "set *" commands in script
Type:
Source:

randMT :SolidML.randMT

random number generator for constuct model.
Type:
Source:

variables :object

hash map of defined variables, specified by "#define *" commands in script
Type:
  • object
Source:

Methods

build(callbackopt) → {any}

Build object structure. This function has to be called after calling SolidML#compile.
Parameters:
Name Type Attributes Default Description
callback SolidML~buildCallback <optional>
 null function called back when new object has created. Call passed SolidML.BuildStatus#stopBuilding to stop building immediatly.
Source:
Returns:
returned value of callback. when callback is undefined, returns the array of cloned SolidML.BuildStatus.
Type
any

compile(script, seedopt) → {SolidML}

Parse script, make a structure of recursive calls inside.
Parameters:
Name Type Attributes Default Description
script string SolidML script to compile
seed int <optional>
 null seed number for MT-random number calculations, pass null to set by time. this value is overwritten by "set seed" command in the script.
Source:
Returns:
this instance
Type
SolidML

Type Definitions

buildCallback(status) → {any}

callback function passed to SolidML#build
Parameters:
Name Type Description
status SolidML.BuildStatus the status while building structure
Source:
Returns:
value of SolidML.BuildStatus.result.
Type
any