CurvePart¶
class CurvePart
A segment of a Curve.
A CurvePart allows a curve to have different fading algorithms at the same time. Each CurvePart has a start and end point, and the fading algorithm which moves the value from the start point to the end point.
Functions¶
| Name | Description |
|---|---|
| CurvePart | Creates an empty CurvePart. |
| ~CurvePart | Destroys this CurvePart. |
| Initialize | Initializes this CurvePart from a definition. |
| GetStart | Returns the start point of this CurvePart. |
| SetStart | Sets the start point of this CurvePart. |
| GetEnd | Returns the end point of this CurvePart. |
| SetEnd | Sets the end point of this CurvePart. |
| GetFader | Returns the Fader of this CurvePart. |
| SetFader | Sets the fader of this CurvePart. |
| Get | Gets the Y coordinates of a point given its coordinates over the X axis. |
Function Details¶
CurvePart¶
CurvePart()
Creates an empty CurvePart.
Get¶
[[nodiscard]] AmReal32 Get(AmReal64 x) const
Gets the Y coordinates of a point given its coordinates over the X axis.
- Parameter
x - The coordinates of the point over the X axis.
- Return
- The Y coordinates of the point.
GetEnd¶
[[nodiscard]] const CurvePoint& GetEnd() const
Returns the end point of this CurvePart.
- Return
- The end point of this
CurvePart.
GetFader¶
[[nodiscard]] FaderInstance* GetFader() const
Returns the Fader of this CurvePart.
- Return
- The
FaderInstanceof thisCurvePart.
GetStart¶
[[nodiscard]] const CurvePoint& GetStart() const
Returns the start point of this CurvePart.
- Return
- The start point of this
CurvePart.
Initialize¶
void Initialize(const CurvePartDefinition* definition)
Initializes this CurvePart from a definition.
- Parameter
definition - The definition of the curve part generated from a flatbuffer binary.
SetEnd¶
void SetEnd(const CurvePoint& end)
Sets the end point of this CurvePart.
- Parameter
end - The new end point.
SetFader¶
void SetFader(const AmString& fader)
Sets the fader of this CurvePart.
- Parameter
fader - The name of the
Faderto set.
SetStart¶
void SetStart(const CurvePoint& start)
Sets the start point of this CurvePart.
- Parameter
start - The new start point.
~CurvePart¶
~CurvePart()
Destroys this CurvePart.