Basics
Matrix - CreateMatrix_CreateFromData
Constructs a new Matrix object, from existing data.
IN
| Name | Type | Description |
|---|---|---|
| InRows | Int | Number of rows. Range: 〔0, +inf）. |
| InCols | Int | Number of columns. Range: 〔0, +inf）. |
| InData | FloatArray | Data pointer. |
| InDeepCopy | Bool | Whether to make a deep copy of the data or to use the current pointer. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutMatrix | Matrix | The Matrix instance. |
| Error | ErrorState | Gets the execution error message |
Matrix - Deserialize
De-serialize a Matrix buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutMatrix | Matrix | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Matrix - GetData
Returns the pointer to the data inside the matrix.
IN
| Name | Type | Description |
|---|---|---|
| InMatrix | Matrix | The input Matrix |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | FloatArray | Data pointer. |
| Error | ErrorState | Gets the execution error message |
Matrix - GetHeight
Returns the height of the matrix.
IN
| Name | Type | Description |
|---|---|---|
| InMatrix | Matrix | The input Matrix |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Height. |
| Error | ErrorState | Gets the execution error message |
Matrix - GetSize
Returns a Size object containing the matrix's width and height.
IN
| Name | Type | Description |
|---|---|---|
| InMatrix | Matrix | The input Matrix |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSize | Size | Size. |
| Error | ErrorState | Gets the execution error message |
Matrix - GetWidth
Returns the width of the matrix.
IN
| Name | Type | Description |
|---|---|---|
| InMatrix | Matrix | The input Matrix |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Width. |
| Error | ErrorState | Gets the execution error message |
Matrix - IsEmpty
Checks if the matrix is empty.
IN
| Name | Type | Description |
|---|---|---|
| InMatrix | Matrix | The input Matrix |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBool | Bool | true if the matrix is empty, false otherwise. |
| Error | ErrorState | Gets the execution error message |
Matrix - Serialize
Serialize the Matrix object using flatbuffers.
IN
| Name | Type | Description |
|---|---|---|
| InMatrix | Matrix | The input Matrix |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Buffer where the object is stored. |
| Error | ErrorState | Gets the execution error message |