CompositeValueCurve
An animation curve that groups child FloatCurves which each animate a different component of a non-unary value.
| Memory category | Instances |
|---|
Member index 3
Description
An animation curve that groups child FloatCurves which each animate a different component of a non-unary value. The CurveType property specifies the type of value to be animated and, depending on this value, differently named children are used to drive the animation of the components of the value.
As follows are the names of the child curves that drive the animation for each possible CompositeValueCurveType value for CurveType:
- ColorRGB: {
"R","G","B"} - ColorHSV: {
"H","S","V"} - NumberRange: {
"Min","Max"} - Rect: {
"MinX","MaxX","MinY","MaxY"} - UDim: {
"Scale","Offset"} - UDim2: {
"ScaleX","OffsetX","ScaleY","OffsetY"} - Vector2: {
"X","Y"} - Vector3: {
"X","Y","Z"}
The children that drive the animation can be accessed via the GetComponentCurves() method which returns an array of curves in the order specified above. The value of the curve at a given time in the animation may be sampled by the GetValueAtTime() method.
History 4
- 701 Add GetValueAtTime
- 701 Add GetComponentCurves
- 701 Add CurveType
- 701 Add CompositeValueCurve
Members 3
CurveType
| Type | Default | |
|---|---|---|
| CompositeValueCurveType | NumberRange | |
The type of value animated by this CompositeValueCurve. See CompositeValueCurveType for options.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
GetComponentCurves
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Instances | ||
This method returns the child curves with the given names for the CurveType of this CompositeValueCurve, in the order given by the list of child curves outlined at the top of this page. Any curve that does not exist prior to calling this method will be created and added as a child with the appropriate name. That new curve will be an empty FloatCurve.
| Thread safety | Unsafe |
|---|
History 1
GetValueAtTime
| Parameters (1) | ||
|---|---|---|
| time | float | |
| Returns (1) | ||
| Variant | ||
This method returns the sampled animated value at the passed time
argument. The type of the returned value will match that specified by the
CurveType property.
If any child curve is missing from the children of the curve, the
corresponding value in the returned property will be 0. For example, if
a curve has a CurveType of
CompositeValueCurveType.ColorRGB but only one FloatCurve
child named "G", then the returned FloatCurve will have values
of 0 for "R" and "B", but the "G" value will be sampled from the
child curve.
| Thread safety | Unsafe |
|---|
History 1
- 701 Add GetValueAtTime