Basics
Profile - CreateProfile_CreateFromData
Creates a new Profile object from raw data.
IN
| Name | Type | Description |
|---|---|---|
| InXOffset | Float | X offset. |
| InXScale | Float | X scale. Range: 〔0, +inf）. |
| InData | FloatArray | Data pointer. |
| InSize | Int | Number of values. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The Profile instance. |
| Error | ErrorState | Gets the execution error message |
Profile - CreateProfile_CreateFromFloatArray
Creates a new Profile object, defining only the array of values. Note: Offset and scale are set to the default values.
IN
| Name | Type | Description |
|---|---|---|
| InValues | FloatArray | Array of values. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The Profile instance. |
| Error | ErrorState | Gets the execution error message |
Profile - CreateProfile_CreateFromValue
Creates a new Profile object using a single value to fill the entire array.
IN
| Name | Type | Description |
|---|---|---|
| InSize | Int | Array size. Range: 〔0, +inf）. |
| InValue | Float | Value. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The Profile instance. |
| Error | ErrorState | Gets the execution error message |
Profile - CreateProfile_CreateFromX
Creates a new Profile object, defining only its XAxis parameters.
IN
| Name | Type | Description |
|---|---|---|
| InXOffset | Float | X offset. |
| InXScale | Float | X scale. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The Profile instance. |
| Error | ErrorState | Gets the execution error message |
Profile - CreateProfile_CreateFromXAndFloatArray
Creates a new Profile object.
IN
| Name | Type | Description |
|---|---|---|
| InXOffset | Float | X offset. |
| InXScale | Float | X scale. Range: 〔0, +inf）. |
| InValues | FloatArray | Array of values. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The Profile instance. |
| Error | ErrorState | Gets the execution error message |
Profile - CreateProfile_CreateXAndValue
Creates a new Profile object using a single value to fill the entire array.
IN
| Name | Type | Description |
|---|---|---|
| InXOffset | Float | X offset. |
| InXScale | Float | X scale. Range: 〔0, +inf）. |
| InSize | Int | Array size. Range: 〔0, +inf）. |
| InValue | Float | Value. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The Profile instance. |
| Error | ErrorState | Gets the execution error message |
Profile - Deserialize
De-serialize a Profile 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 |
|---|---|---|
| OutProfile | Profile | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Profile - GetData
Returns the pointer to the first element of the profile.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| 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 |
Profile - GetIndices
Returns the array of the profile's indices.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | IntArray | Indices. |
| Error | ErrorState | Gets the execution error message |
Profile - GetInterpolatedValue
Returns the profile value interpolated at a specified point.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InIndex | Float | Index. Range: 〔0, +inf）. |
| InCyclic | Bool | Whether to consider the profile cyclic. |
| InCubicInterpolation | Bool | Whether to use a cubic interpolation, instead of linear one. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Interpolated value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetInterpolatedValueFromX
Returns the profile value interpolated at the specified X coordinate.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InX | Float | X coordinate. |
| InCubicInterpolation | Bool | Whether to use a cubic interpolation, instead of linear one |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Interpolated value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetValue
Returns the profile value at a specified index.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InIndex | Int | Index. Range: 〔0, +inf）. |
| InInverse | Bool | Whether to access the profile in reverse order. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Output value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetXCoordinate
Returns the X coordinate associated to the provided index.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InIndex | Int | Input index. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The computed X coordinate. |
| Error | ErrorState | Gets the execution error message |
Profile - GetXCoordinates
Returns an array with all profile's X coordinates.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | FloatArray | X coordinates. |
| Error | ErrorState | Gets the execution error message |
Profile - GetXOffset
Returns the offset of the X transform.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Offset. |
| Error | ErrorState | Gets the execution error message |
Profile - GetXScale
Returns the scale of the X transform.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Scale. |
| Error | ErrorState | Gets the execution error message |
Profile - GetX_FromFloat
Return the X value at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InIndex | Float | Index. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | X value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetX_FromInt
Return the X value at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InIndex | Int | Index. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | X value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetY
Return the Y value at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InIndex | Int | Index. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Y value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetYCoordinates
Returns an array with all profile's Y coordinates.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | FloatArray | Y coordinates. |
| Error | ErrorState | Gets the execution error message |
Profile - ResetDomain
Reset the domain, setting the X transform equal to the other profile and resizing the array.
IN
| Name | Type | Description |
|---|---|---|
| InProfile1 | Profile | The input Profile |
| InProfile2 | Profile | Another profile. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile1 | Profile | The modified Core.Data.Types.Profile |
| Error | ErrorState | Gets the execution error message |
Profile - Serialize
Serialize the Profile object using flatbuffers.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| 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 |
Profile - SetValue
Sets the profile value in the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InIndex | Int | Index. Range: 〔0, +inf）. |
| InValue | Float | Input value. |
| InInverse | Bool | Whether to access the profile in reverse order. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The modified Core.Data.Types.Profile |
| Error | ErrorState | Gets the execution error message |
Profile - SetXOffset
Set the offset of the X transform.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InXOffset | Float | Offset. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The modified Core.Data.Types.Profile |
| Error | ErrorState | Gets the execution error message |
Profile - SetXScale
Set the scale of the X transform.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InXScale | Float | Scale. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | The modified Core.Data.Types.Profile |
| Error | ErrorState | Gets the execution error message |