Utility data objects
[Desktop Automation]
LUAVector3
The Lua representation of a vector with 3 components (x, y, z)
Properties
| Property | Read/write | Type | Description |
|---|---|---|---|
| x | Read/write | Number | X-Component of the vector |
| y | Read/write | Number | Y-Component of the vector |
| z | Read/write | Number | Z-Component of the vector |
Methods
None.
LUAVector4
The Lua representation of a vector with 4 components (w, x, y, z)
Properties
| Property | Read/write | Type | Description |
|---|---|---|---|
| w | Read/write | Number | W-Component of the vector |
| x | Read/write | Number | X-Component of the vector |
| y | Read/write | Number | Y-Component of the vector |
| z | Read/write | Number | Z-Component of the vector |
Methods
None.
LUAArray
Properties
| Property | Read/write | Type | Description |
|---|---|---|---|
| length | Read | Integer | Length of the array |
Methods
| Name | Syntax | Description |
|---|---|---|
| get | array:get(index:integer) | Get the array value at index |
| set | array:set(index:integer; value:number) | Set the array value at index |
LUAStringMap
The Lua representation of a map of strings (key/value pairs)
Properties
| Property | Read/write | Type | Description |
|---|---|---|---|
| count | Read | Integer | Number of items in the map |
Methods
| Name | Syntax | Description |
|---|---|---|
| setitem | Map:setitem(AKey:String; Avalue:String) | Set an Item (add or replace) |
| getitem | Item = Map:getitem(AKey:String) | Get an Item by key |
| deleteitem | Map:deleteitem(AKey:String) | Delete an item with a key |
| getitembyindex | KeyItem = Map:getitembyindex(AIndex:Integer) | Get an item with key by index (Format: "Key"="Value") |
LUAMatrix4f
The Lua representation of a 4x4 Matrix.
Properties
None
Methods
| Name | Syntax | Description |
|---|---|---|
| get | matrix:get(x:integer; y:integer) | Get the matrix value at x and y |
| set | matrix:set(x:integer; y:integer; value:number) | Set the matrix value at x and y |
LUAAlignment
Properties
| Property | Read/write | Type | Description |
|---|---|---|---|
| firstaxis | Read | TLUAVector3f | First principal axis designating the shortest axis of the reference mesh. Can be used to set up the camera for rendering |
| newmodeltoworldmatrix | Read | TLUAMatrix4f | A new model to world matrix for the mesh/model to be transformed |
| secondaxis | Read | TLUAVector3f | Second principal axis designating the longest axis of the reference mesh. Can be used to set up the camera for rendering |
| thirdaxis | Read | TLUAVector3f | Third principal axis designating the remaining axis of the reference mesh. Can be used to set up the camera for rendering |
| transformationmatrix | Read | TLUAMatrix4f | The matrix that must be multiplied with the model to world matrix to align the mesh/model to be aligned with the reference mesh/model |
Methods
None
Outbox
This object represents a bounding box. For legacy reasons, keywords retain the naming of and around "outbox".
Properties
| Property | Read/write | Type | Description |
|---|---|---|---|
| minx | Read/write | Number | Returns the min_x (in mm) |
| miny | Read/write | Number | Returns the min_y (in mm) |
| minz | Read/write | Number | Returns the min_z (in mm) |
| maxx | Read/write | Number | Returns the max_x (in mm) |
| maxy | Read/write | Number | Returns the max_y (in mm) |
| maxz | Read/write | Number | Returns the max_z (in mm) |
Methods
None.