oevislib_net  0.14.3.0
Loading...
Searching...
No Matches

Functions

 oevislib_net.Profile.Profile ()
 Creates an empty Profile object.
 oevislib_net.Profile.Profile (float inXOffset, float inXScale)
 Creates a new Profile object, defining only its XAxis parameters.
 oevislib_net.Profile.Profile (Array< float > inValues)
 Creates a new Profile object, defining only the array of values.
 oevislib_net.Profile.Profile (float inXOffset, float inXScale, Array< float > inValues)
 Creates a new Profile object.
 oevislib_net.Profile.Profile (float inXOffset, float inXScale, float[] inData, int inSize)
 Creates a new Profile object from raw data.
 oevislib_net.Profile.Profile (float inXOffset, float inXScale, int inSize, float inValue=0.0f)
 Creates a new Profile object using a single value to fill the entire array.
 oevislib_net.Profile.Profile (int inSize, float inValue=0.0f)
 Creates a new Profile object using a single value to fill the entire array.
float oevislib_net.Profile.GetXOffset ()
 Returns the offset of the X transform.
float oevislib_net.Profile.GetXScale ()
 Returns the scale of the X transform.
float oevislib_net.Profile.GetX (float inIndex)
 Return the X value at the specified index.
float oevislib_net.Profile.GetX (int inIndex)
 Return the X value at the specified index.
float oevislib_net.Profile.GetY (int inIndex)
 Return the Y value at the specified index.
float[] oevislib_net.Profile.GetData ()
 Returns the pointer to the first element of the profile.
void oevislib_net.Profile.ResetDomain (Profile inProfile)
 Reset the domain, setting the X transform equal to the other profile and resizing the array.
void oevislib_net.Profile.SetXOffset (float inXOffset)
 Set the offset of the X transform.
void oevislib_net.Profile.SetXScale (float inXScale)
 Set the scale of the X transform.
ByteBuffer oevislib_net.Profile.Serialize ()
 Serialize the Profile object using flatbuffers.
static Profile oevislib_net.Profile.Deserialize (ByteBuffer inBuffer)
 De-serialize a Profile buffer.
Array< int > oevislib_net.Profile.GetIndices ()
 Returns the array of the profile's indices.
float oevislib_net.Profile.GetInterpolatedValue (float inIndex, bool inCyclic=false, bool inCubicInterpolation=false)
 Returns the profile value interpolated at a specified point.
float oevislib_net.Profile.GetInterpolatedValueFromX (float inX, bool inCubicInterpolation=false)
 Returns the profile value interpolated at the specified X coordinate.
float oevislib_net.Profile.GetValue (int inIndex, bool inInverse=false)
 Returns the profile value at a specified index.
float oevislib_net.Profile.GetXCoordinate (int inIndex)
 Returns the X coordinate associated to the provided index.
Array< float > oevislib_net.Profile.GetXCoordinates (Optional< Range > inRange=null)
 Returns an array with all profile's X coordinates.
Array< float > oevislib_net.Profile.GetYCoordinates (Optional< Range > inRange=null)
 Returns an array with all profile's Y coordinates.
void oevislib_net.Profile.SetValue (int inIndex, float inValue, bool inInverse=false)
 Sets the profile value in the specified index.

Detailed Description

Function Documentation

◆ Deserialize()

Profile oevislib_net.Profile.Deserialize ( ByteBuffer inBuffer)
inlinestatic

De-serialize a Profile buffer.

Parameters
inBufferBuffer containing the object.
Returns
Deserialized object.

◆ GetData()

float[] oevislib_net.Profile.GetData ( )
inline

Returns the pointer to the first element of the profile.

Returns
Data pointer.

◆ GetIndices()

Array< int > oevislib_net.Profile.GetIndices ( )
inline

Returns the array of the profile's indices.

Returns
Indices.

◆ GetInterpolatedValue()

float oevislib_net.Profile.GetInterpolatedValue ( float inIndex,
bool inCyclic = false,
bool inCubicInterpolation = false )
inline

Returns the profile value interpolated at a specified point.

Parameters
inIndexIndex. Range: [0, +inf).
inCyclicWhether to consider the profile cyclic.
inCubicInterpolationWhether to use a cubic interpolation, instead of linear one.
Returns
Interpolated value.

◆ GetInterpolatedValueFromX()

float oevislib_net.Profile.GetInterpolatedValueFromX ( float inX,
bool inCubicInterpolation = false )
inline

Returns the profile value interpolated at the specified X coordinate.

Parameters
inXX coordinate.
inCubicInterpolationWhether to use a cubic interpolation, instead of linear one
Returns
Interpolated value.

◆ GetValue()

float oevislib_net.Profile.GetValue ( int inIndex,
bool inInverse = false )
inline

Returns the profile value at a specified index.

Parameters
inIndexIndex. Range: [0, +inf).
inInverseWhether to access the profile in reverse order.
Returns
Output value.

◆ GetX() [1/2]

float oevislib_net.Profile.GetX ( float inIndex)
inline

Return the X value at the specified index.

Parameters
inIndexIndex. Range: [0, +inf).
Returns
X value.

◆ GetX() [2/2]

float oevislib_net.Profile.GetX ( int inIndex)
inline

Return the X value at the specified index.

Parameters
inIndexIndex. Range: [0, +inf).
Returns
X value.

◆ GetXCoordinate()

float oevislib_net.Profile.GetXCoordinate ( int inIndex)
inline

Returns the X coordinate associated to the provided index.

Parameters
inIndexInput index.
Returns
The computed X coordinate.

◆ GetXCoordinates()

Array< float > oevislib_net.Profile.GetXCoordinates ( Optional< Range > inRange = null)
inline

Returns an array with all profile's X coordinates.

Parameters
inRangeRange of values to consider.
Returns
X coordinates.

◆ GetXOffset()

float oevislib_net.Profile.GetXOffset ( )
inline

Returns the offset of the X transform.

Returns
Offset.

◆ GetXScale()

float oevislib_net.Profile.GetXScale ( )
inline

Returns the scale of the X transform.

Returns
Scale.

◆ GetY()

float oevislib_net.Profile.GetY ( int inIndex)
inline

Return the Y value at the specified index.

Parameters
inIndexIndex. Range: [0, +inf).
Returns
Y value.

◆ GetYCoordinates()

Array< float > oevislib_net.Profile.GetYCoordinates ( Optional< Range > inRange = null)
inline

Returns an array with all profile's Y coordinates.

Parameters
inRangeRange of values to consider.
Returns
Y coordinates.

◆ Profile() [1/7]

oevislib_net.Profile.Profile ( )
inline

Creates an empty Profile object.

◆ Profile() [2/7]

oevislib_net.Profile.Profile ( Array< float > inValues)
inline

Creates a new Profile object, defining only the array of values.

Offset and scale are set to the default values.

Parameters
inValuesArray of values.

◆ Profile() [3/7]

oevislib_net.Profile.Profile ( float inXOffset,
float inXScale )
inline

Creates a new Profile object, defining only its XAxis parameters.

Parameters
inXOffsetX offset.
inXScaleX scale. Range: [0, +inf).

◆ Profile() [4/7]

oevislib_net.Profile.Profile ( float inXOffset,
float inXScale,
Array< float > inValues )
inline

Creates a new Profile object.

Parameters
inXOffsetX offset.
inXScaleX scale. Range: [0, +inf).
inValuesArray of values.

◆ Profile() [5/7]

oevislib_net.Profile.Profile ( float inXOffset,
float inXScale,
float[] inData,
int inSize )
inline

Creates a new Profile object from raw data.

Parameters
inXOffsetX offset.
inXScaleX scale. Range: [0, +inf).
inDataData pointer.
inSizeNumber of values. Range: [0, +inf).

◆ Profile() [6/7]

oevislib_net.Profile.Profile ( float inXOffset,
float inXScale,
int inSize,
float inValue = 0::0f )
inline

Creates a new Profile object using a single value to fill the entire array.

Parameters
inXOffsetX offset.
inXScaleX scale. Range: [0, +inf).
inSizeArray size. Range: [0, +inf).
inValueValue.

◆ Profile() [7/7]

oevislib_net.Profile.Profile ( int inSize,
float inValue = 0::0f )
inline

Creates a new Profile object using a single value to fill the entire array.

Parameters
inSizeArray size. Range: [0, +inf).
inValueValue.

◆ ResetDomain()

void oevislib_net.Profile.ResetDomain ( Profile inProfile)
inline

Reset the domain, setting the X transform equal to the other profile and resizing the array.

Parameters
inProfileAnother profile.

◆ Serialize()

ByteBuffer oevislib_net.Profile.Serialize ( )
inline

Serialize the Profile object using flatbuffers.

Returns
Buffer where the object is stored.

◆ SetValue()

void oevislib_net.Profile.SetValue ( int inIndex,
float inValue,
bool inInverse = false )
inline

Sets the profile value in the specified index.

Parameters
inIndexIndex. Range: [0, +inf).
inValueInput value.
inInverseWhether to access the profile in reverse order.

◆ SetXOffset()

void oevislib_net.Profile.SetXOffset ( float inXOffset)
inline

Set the offset of the X transform.

Parameters
inXOffsetOffset.

◆ SetXScale()

void oevislib_net.Profile.SetXScale ( float inXScale)
inline

Set the scale of the X transform.

Parameters
inXScaleScale. Range: [0, +inf).