Constructor
new AxisSet(_axes)
Creates an instance of AxisSet.
Parameters:
| Name | Type | Description |
|---|---|---|
_axes |
Array.<Axis> | An array of Axis. Each axis must have a unique hyperparameter. |
- Source:
Methods
AdvanceAxis(index)
Pass-through to advance an axis.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number | The axis to advance. |
- Source:
CheckAxisComplete(index) → {boolean}
Pass-through to check completion.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number | The axis to check. |
Returns:
- Type
- boolean
- Source:
CreateParams() → {StringKeyedNumbersObject}
Builds a simple map in the format "{ axis0-name: axis0-value, ... }"
Returns:
- Type
- StringKeyedNumbersObject
- Source:
GetTotalAxes() → {number}
Gets the collection size.
Returns:
- Type
- number
- Source:
ResetAxis(index)
Pass-through to reset an axis.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number | The axis to reset. |
- Source:
Walk(callback)
Traverses the axis collection, invoking a callback for each.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | The function to be invoked with an instance of Axis. |
- Source:
WriteAxisReport(index, compact) → {string}
Pass-through to get axis reports.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number | The axis to report. |
compact |
boolean | Whether to get a detailed report. |
Returns:
- Type
- string
- Source: