Class: BuildStatus

SolidML.BuildStatus()

Represents various status while building structure, passed by the callback of SolidML#build

Constructor

new BuildStatus()

[SHOULD NOT CREATE new instance] SolidML.BuildStatus instance is created by SolidML
Source:

Members

color :SolidML.ColorHSBA

color for the object. get RGBA values by SolidML.ColorHSBA#getRGBA. this instance has been updated in the building computation. Use SolidML.ColorHSBA#clone to remember and reuse the status.
Type:
Source:

label :string

name of the object
Type:
  • string
Source:

lastContinuousMesh :SolidML.BuildStatus

parent rule's last called contnuous mesh ("mesh", "cmesh", "tube" and "ctube")
Type:
Source:

matrix :SolidML.Matrix4

matrix to transform the object. convert for three.js by pass this to THREE.Matrix4.copy(). this instance has been updated in the building computation. Use SolidML.Matrix4#clone to remember and reuse the status.
Type:
Source:

objectCount :int

current object count
Type:
  • int
Source:

option :string

Array of options of the object written as "name:option"
Type:
  • string
Source:

param :string

parameters of the object written as "name[param]"
Type:
  • string
Source:

referenceID :int

increment when the rule is called. used in composing contnuous mesh
Type:
  • int
Source:

result :object

return value of SolidML#build
Type:
  • object
Source:

rule :SolidML.Rule

current rule
Type:
Source:

Methods

reference() → {Object}

create new Object including clones of current status
Source:
Returns:
typeof {matrix, color, label, option, param, referenceID, objectCount}. rule, lastContinuousMesh and result are not cloned.
Type
Object

stopBuilding()

call this method to stop building immediately
Source: