Overview
Defines a set of animation APIs of ArkUI on the native side. The APIs in native_animate.h must be called in the main thread.
File to include: <arkui/native_animate.h>
Library: libace_ndk.z.so
System capability: SystemCapability.ArkUI.ArkUI.Full
Since: 12
Related module: ArkUI_NativeModule
Sample: AnimationNDK
[h2]Structs
| Name | typedef Keyword | Description |
|---|---|---|
| ArkUI_ExpectedFrameRateRange | ArkUI_ExpectedFrameRateRange | Defines the expected frame rate range of an animation. This struct defines the frame rate range through the min, max, and expected fields, and the system tries to meet the expected frame rate. |
| ArkUI_AnimateCompleteCallback | ArkUI_AnimateCompleteCallback | Defines the callback type for when the animation playback is complete, which is used to notify you that the animation has ended when the animation playback is complete. You can specify the callback trigger mode through the type field, set a custom callback function through the callback field, and pass user-defined data to the callback function through the userData field. |
| ArkUI_NativeAnimateAPI_1 | ArkUI_NativeAnimateAPI_1 | Defines a set of animation APIs of ArkUI on the native side. |
| ArkUI_AnimateOption | ArkUI_AnimateOption | Defines an animation effect configuration, which is used to set the related attributes of the animation. |
| ArkUI_Curve | ArkUI_Curve | Defines the interpolation object of an animation curve, which is used for interpolation calculation of animation attribute values. |
| ArkUI_Curve* | ArkUI_CurveHandle | Defines the pointer to a curve interpolation object. Curve interpolation is used to control how animation attribute values change over time, and different types of interpolation curves can achieve different animation transition effects. |
| ArkUI_KeyframeAnimateOption | ArkUI_KeyframeAnimateOption | Defines a keyframe animation parameter object, which is used as an input parameter of the keyframe animation APIs. The related APIs must be called on the main thread. |
| ArkUI_AnimatorOption | ArkUI_AnimatorOption | Defines an animator animation parameter object, which is used to set animation attributes when creating an animator animation. |
| ArkUI_Animator* | ArkUI_AnimatorHandle | Defines the pointer to an animator animation object, which is used to operate and control the animation object of ArkUI. |
| ArkUI_AnimatorEvent | ArkUI_AnimatorEvent | Defines an animator callback event object, which is used to receive events in the animation state change callback. |
| ArkUI_AnimatorOnFrameEvent | ArkUI_AnimatorOnFrameEvent | Defines the event data object for frame-by-frame callbacks during animator animation playback. |
| ArkUI_TransitionEffect | ArkUI_TransitionEffect | Defines the transition effect parameter object of the transition attribute, which is used to configure the transition animation effect when a component appears or disappears. |
[h2]Functions
[h2]OH_ArkUI_AnimateOption_Create()
ArkUI_AnimateOption* OH_ArkUI_AnimateOption_Create()
Description
Creates an animation configuration.
Since: 12
Return value
| Type | Description |
|---|---|
| ArkUI_AnimateOption* | Pointer to the created animation configuration. |
[h2]OH_ArkUI_AnimateOption_Dispose()
void OH_ArkUI_AnimateOption_Dispose(ArkUI_AnimateOption* option)
Description
Disposes of an animation configuration.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
[h2]OH_ArkUI_AnimateOption_GetDuration()
uint32_t OH_ArkUI_AnimateOption_GetDuration(ArkUI_AnimateOption* option)
Description
Obtains the animation duration, in milliseconds.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, 0 is returned. |
Return value
| Type | Description |
|---|---|
| uint32_t | Animation duration, in milliseconds. If option is invalid, 0 is returned. |
[h2]OH_ArkUI_AnimateOption_GetTempo()
float OH_ArkUI_AnimateOption_GetTempo(ArkUI_AnimateOption* option)
Description
Obtains the playback speed of an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, 0.0 is returned. |
Return value
| Type | Description |
|---|---|
| float | Animation playback speed. Value range: [0, +∞). If option is invalid, 0.0 is returned. |
[h2]OH_ArkUI_AnimateOption_GetCurve()
ArkUI_AnimationCurve OH_ArkUI_AnimateOption_GetCurve(ArkUI_AnimateOption* option)
Description
Obtains an animation curve.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, -1 is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_AnimationCurve | Animation curve. The return values include: ARKUI_CURVE_LINEAR (0, linear curve), ARKUI_CURVE_EASE (1, ease curve), ARKUI_CURVE_EASE_IN (2, ease-in curve), ARKUI_CURVE_EASE_OUT (3, ease-out curve), ARKUI_CURVE_EASE_IN_OUT (4, ease-in-out curve), ARKUI_CURVE_FAST_OUT_SLOW_IN (5, standard curve), ARKUI_CURVE_LINEAR_OUT_SLOW_IN (6, deceleration curve), ARKUI_CURVE_FAST_OUT_LINEAR_IN (7, acceleration curve), ARKUI_CURVE_EXTREME_DECELERATION (8, extreme deceleration curve), ARKUI_CURVE_SHARP (9, sharp curve), ARKUI_CURVE_RHYTHM (10, rhythm curve), ARKUI_CURVE_SMOOTH (11, smooth curve), ARKUI_CURVE_FRICTION (12, friction curve). If option is invalid, -1 is returned. |
[h2]OH_ArkUI_AnimateOption_GetDelay()
int32_t OH_ArkUI_AnimateOption_GetDelay(ArkUI_AnimateOption* option)
Description
Obtains the animation delay, in milliseconds.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, 0 is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Delay of animation playback, in ms. If option is invalid, 0 is returned. |
[h2]OH_ArkUI_AnimateOption_GetIterations()
int32_t OH_ArkUI_AnimateOption_GetIterations(ArkUI_AnimateOption* option)
Description
Obtains the number of times that an animation is played.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, 0 is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Number of times that the animation is played. If option is invalid, 0 is returned. |
[h2]OH_ArkUI_AnimateOption_GetPlayMode()
ArkUI_AnimationPlayMode OH_ArkUI_AnimateOption_GetPlayMode(ArkUI_AnimateOption* option)
Description
Obtains the playback mode of an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, -1 is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_AnimationPlayMode | Animation playback mode. The return values include: ARKUI_ANIMATION_PLAY_MODE_NORMAL (0, forward playback), ARKUI_ANIMATION_PLAY_MODE_REVERSE (1, reverse playback), ARKUI_ANIMATION_PLAY_MODE_ALTERNATE (2, alternate playback), and ARKUI_ANIMATION_PLAY_MODE_ALTERNATE_REVERSE (3, reverse alternate playback). If option is invalid, -1 is returned. |
[h2]OH_ArkUI_AnimateOption_GetExpectedFrameRateRange()
ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimateOption_GetExpectedFrameRateRange(ArkUI_AnimateOption* option)
Description
Obtains the expected frame rate of the animation, in fps.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_ExpectedFrameRateRange* | Pointer to the expected frame rate range of the animation, in fps. If option is invalid, NULL is returned. |
[h2]OH_ArkUI_AnimateOption_SetDuration()
void OH_ArkUI_AnimateOption_SetDuration(ArkUI_AnimateOption* option, int32_t value)
Description
Sets the animation duration, in milliseconds.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
| int32_t value | Animation duration, in ms. The default value is 1000 ms. Value range: [0, +∞). If value is less than 0, 0 is used. |
[h2]OH_ArkUI_AnimateOption_SetTempo()
void OH_ArkUI_AnimateOption_SetTempo(ArkUI_AnimateOption* option, float value)
Description
Sets the playback speed of an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
| float value | Animation playback speed. The default value is 1.0. The value range is [0, +∞). NOTE If the value is less than 0, the default value 1 is used. |
[h2]OH_ArkUI_AnimateOption_SetCurve()
void OH_ArkUI_AnimateOption_SetCurve(ArkUI_AnimateOption* option, ArkUI_AnimationCurve value)
Description
Sets a custom curve for the animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
| ArkUI_AnimationCurve value | Animation curve. Default value: ARKUI_CURVE_EASE_IN_OUT. You are advised to use ARKUI_CURVE_EASE_IN_OUT for a smoother animation effect. If the value is abnormal, the setting does not take effect. Note: If OH_ArkUI_AnimateOption_SetICurve is also set, SetICurve takes precedence and this setting does not take effect. |
[h2]OH_ArkUI_AnimateOption_SetDelay()
void OH_ArkUI_AnimateOption_SetDelay(ArkUI_AnimateOption* option, int32_t value)
Description
Sets the animation delay, in milliseconds.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
| int32_t value | Animation delay, in milliseconds. Value range: (-∞, +∞). Default value: 0, indicating no animation delay. A value greater than 0 means to begin the animation after the specified amount of time has elapsed. A value less than 0 means to begin the animation in advance. If value is less than 0 and the absolute value of value is less than the actual animation duration, the animation starts its first frame from the state at the absolute value. If the absolute value of value is greater than or equal to the actual animation duration, the animation starts its first frame from the end state. The actual animation duration is equal to the duration of a single animation multiplied by the number of animation playback times. |
[h2]OH_ArkUI_AnimateOption_SetIterations()
void OH_ArkUI_AnimateOption_SetIterations(ArkUI_AnimateOption* option, int32_t value)
Description
Sets the number of times that an animation is played.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
| int32_t value | Number of times that the animation is played. Value range: [-1, +∞). If this parameter is set to 0, the animation is not played. If this parameter is set to -1, the animation is played for an infinite number of times. Default value: 1 (played once). If the value is less than -1, the operation is invalid. |
[h2]OH_ArkUI_AnimateOption_SetPlayMode()
void OH_ArkUI_AnimateOption_SetPlayMode(ArkUI_AnimateOption* option, ArkUI_AnimationPlayMode value)
Description
Sets the playback mode for an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
| ArkUI_AnimationPlayMode value | Animation playback mode. Default value: ARKUI_ANIMATION_PLAY_MODE_NORMAL. The value options include: ARKUI_ANIMATION_PLAY_MODE_NORMAL indicates forward playback, ARKUI_ANIMATION_PLAY_MODE_REVERSE indicates reverse playback, ARKUI_ANIMATION_PLAY_MODE_ALTERNATE indicates playback in alternating mode, and ARKUI_ANIMATION_PLAY_MODE_ALTERNATE_REVERSE indicates playback in reverse alternating mode, with reverse playback on odd iterations and forward playback on even iterations. If the value is abnormal, the operation is invalid. |
[h2]OH_ArkUI_AnimateOption_SetExpectedFrameRateRange()
void OH_ArkUI_AnimateOption_SetExpectedFrameRateRange(ArkUI_AnimateOption* option, ArkUI_ExpectedFrameRateRange* value)
Description
Sets the expected frame rate range of the animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
| ArkUI_ExpectedFrameRateRange* value | Pointer to the expected frame rate range of the animation, in fps. If value is set to NULL, the operation is invalid. |
[h2]OH_ArkUI_AnimateOption_SetICurve()
void OH_ArkUI_AnimateOption_SetICurve(ArkUI_AnimateOption* option, ArkUI_CurveHandle value)
Description
Sets the interpolation curve for the animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, the operation is invalid. |
| ArkUI_CurveHandle value | Animation curve parameters. If value is set to NULL, the operation is invalid. |
[h2]OH_ArkUI_AnimateOption_GetICurve()
ArkUI_CurveHandle OH_ArkUI_AnimateOption_GetICurve(ArkUI_AnimateOption* option)
Description
Obtains the interpolation curve of the animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimateOption* option | Pointer to an animation configuration. If option is set to NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Interpolation curve of the animation. NULL is returned if the option parameter is invalid. |
[h2]OH_ArkUI_KeyframeAnimateOption_Create()
ArkUI_KeyframeAnimateOption* OH_ArkUI_KeyframeAnimateOption_Create(int32_t size)
Description
Creates a keyframe animation parameter object.
Since: 12
Parameters
| Name | Description |
|---|---|
| int32_t size | Number of keyframe animation states. Value range: [0, +∞). A positive integer is required to produce an animation effect. NULL is returned if the value of size is less than 0. |
Return value
| Type | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* | Pointer to the keyframe animation parameter object. If the value of size is less than 0 or if option is abnormal, NULL is returned. |
[h2]OH_ArkUI_KeyframeAnimateOption_Dispose()
void OH_ArkUI_KeyframeAnimateOption_Dispose(ArkUI_KeyframeAnimateOption* option)
Description
Disposes of a keyframe animation parameter object.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to the keyframe animation parameter object. If option is set to NULL, the operation is invalid. |
[h2]OH_ArkUI_KeyframeAnimateOption_SetDelay()
int32_t OH_ArkUI_KeyframeAnimateOption_SetDelay(ArkUI_KeyframeAnimateOption* option, int32_t value)
Description
Sets the overall delay of a keyframe animation, in ms. By default, playback is not delayed.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Keyframe animation parameters. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| int32_t value | Animation delay, in milliseconds. Value range: (-∞, +∞). Default value: 0, indicating no animation delay. A value greater than 0 means to begin the animation after the specified amount of time has elapsed. A value less than 0 means to begin the animation in advance. If value is less than 0 and the absolute value of value is less than the actual animation duration, the animation starts its first frame from the state at the absolute value. If the absolute value of value is greater than or equal to the actual animation duration, the animation starts its first frame from the end state. The actual animation duration is equal to the duration of a single animation multiplied by the number of animation playback times. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. Possible cause: The option parameter is NULL. To solve this issue, ensure that option is a valid pointer to an animation parameter object. |
[h2]OH_ArkUI_KeyframeAnimateOption_SetIterations()
int32_t OH_ArkUI_KeyframeAnimateOption_SetIterations(ArkUI_KeyframeAnimateOption* option, int32_t value)
Description
Sets the number of times that the keyframe animation is played. By default, the animation is played once. The value -1 indicates that the animation is played for an unlimited number of times. The value 0 indicates that no animation is played.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| int32_t value | Number of times that the animation is played. Value range: [-1, +∞). If this parameter is set to 0, the animation is not played. If this parameter is set to -1, the animation is played for an infinite number of times. Default value: 1, indicating that the animation is played once. If the value is less than -1, the operation is invalid, and the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback()
int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback(ArkUI_KeyframeAnimateOption* option, void* userData, void (*onFinish)(void* userData))
Description
Sets the callback invoked when the keyframe animation playback is complete. This API is called after the ArkUI_KeyframeAnimateOption has played for the specified number of times.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| void* userData | Pointer to a user-defined object. Abnormal value processing is not involved. |
| void (*onFinish)(void* userData) | Pointer to the callback function. userData: input parameter of the callback, which is a custom object pointer. If onFinish is NULL, the operation is invalid. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate()
int32_t OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate(ArkUI_KeyframeAnimateOption* option, ArkUI_ExpectedFrameRateRange* frameRate)
Description
Sets the expected frame rate for a keyframe animation.
Since: 19
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_ExpectedFrameRateRange* frameRate | Pointer to the expected frame rate for the keyframe animation. If frameRate is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_KeyframeAnimateOption_SetDuration()
int32_t OH_ArkUI_KeyframeAnimateOption_SetDuration(ArkUI_KeyframeAnimateOption* option, int32_t value, int32_t index)
Description
Sets the duration of a keyframe animation, in milliseconds.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| int32_t value | Keyframe animation duration, in ms. The default value is 1000 ms. Value range: [0, +∞). If the value is less than 0, 0 is used. |
| int32_t index | State index. The value range is [0, size-1], where size is the number of keyframe animation states. If index is out of range, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_KeyframeAnimateOption_SetCurve()
int32_t OH_ArkUI_KeyframeAnimateOption_SetCurve(ArkUI_KeyframeAnimateOption* option, ArkUI_CurveHandle value, int32_t index)
Description
Sets the animation curve for a specific keyframe animation segment.
Because the duration does not take effect for the springMotion, responsiveSpringMotion, and interpolatingSpring curves, these three curves are not supported. The keyframe animation supports the springCurve and customCurve curves.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_CurveHandle value | Animation curve to set. Default value: ARKUI_CURVE_EASE_IN_OUT. |
| int32_t index | Index of the keyframe state segment. Value range: [0, size – 1], where size indicates the number of keyframe animation states. If the value of index is less than 0 or out of range, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback()
int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback(ArkUI_KeyframeAnimateOption* option, void* userData, void (*event)(void* userData), int32_t index)
Description
Sets the closure function of the state at the time of the keyframe, that is, the state to be reached at the time of the keyframe.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| void* userData | Pointer to a user-defined object. Abnormal value processing is not involved. |
| void (*event)(void* userData) | Pointer to the closure function. userData: input parameter of the callback function, which is a pointer to a user-defined object. The operation is invalid when event is NULL. |
| int32_t index | Index of the keyframe state segment. Value range: [0, size – 1], where size indicates the number of keyframe animation states. If the value of index is less than 0 or out of range, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_KeyframeAnimateOption_GetDelay()
int32_t OH_ArkUI_KeyframeAnimateOption_GetDelay(ArkUI_KeyframeAnimateOption* option)
Description
Obtains the overall delay of the keyframe animation, in ms.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, 0 is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Overall delay, in ms. The value 0 is returned when option is invalid. |
[h2]OH_ArkUI_KeyframeAnimateOption_GetIterations()
int32_t OH_ArkUI_KeyframeAnimateOption_GetIterations(ArkUI_KeyframeAnimateOption* option)
Description
Obtains the number of times that a keyframe animation is played.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, 0 is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Number of times that the animation is played. If option is invalid, 0 is returned. |
[h2]OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate()
ArkUI_ExpectedFrameRateRange* OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate(ArkUI_KeyframeAnimateOption* option)
Description
Obtains the expected frame rate from keyframe animation parameters.
Since: 19
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_ExpectedFrameRateRange* | Pointer to the expected frame rate obtained. If option is invalid, NULL is returned. |
[h2]OH_ArkUI_KeyframeAnimateOption_GetDuration()
int32_t OH_ArkUI_KeyframeAnimateOption_GetDuration(ArkUI_KeyframeAnimateOption* option, int32_t index)
Description
Obtains the duration of a specific state in a keyframe animation, in milliseconds.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, 0 is returned. |
| int32_t index | State index. The value range is [0, size-1], where size indicates the number of keyframe animation states. If index is out of range, 0 is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Duration, in milliseconds. If option is invalid, 0 is returned. |
[h2]OH_ArkUI_KeyframeAnimateOption_GetCurve()
ArkUI_CurveHandle OH_ArkUI_KeyframeAnimateOption_GetCurve(ArkUI_KeyframeAnimateOption* option, int32_t index)
Description
Obtains the animation curve of a specific state in a keyframe animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_KeyframeAnimateOption* option | Pointer to a keyframe animation configuration. If option is set to NULL, NULL is returned. |
| int32_t index | State index. The value range is [0, size-1], where size indicates the number of keyframe animation states. If index is out of the value range, NULL is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Animation curve. If the parameter is abnormal, NULL is returned. |
[h2]OH_ArkUI_AnimatorOption_Create()
ArkUI_AnimatorOption* OH_ArkUI_AnimatorOption_Create(int32_t keyframeSize)
Description
Creates an AnimatorOption object.
When the value of keyframeSize is greater than 0, the interpolation start point of the animation is 0 by default, and the interpolation end point is 1 by default. They cannot be set.
Since: 12
Parameters
| Name | Description |
|---|---|
| int32_t keyframeSize | Number of keyframes to create. NULL is returned if the value of keyframeSize is less than 0. |
Return value
| Type | Description |
|---|---|
| ArkUI_AnimatorOption* | Pointer to the animator parameter object. NULL is returned if the value of keyframeSize is less than 0 or if option is invalid. |
[h2]OH_ArkUI_AnimatorOption_Dispose()
void OH_ArkUI_AnimatorOption_Dispose(ArkUI_AnimatorOption* option)
Description
Disposes of an AnimatorOption object.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the operation is invalid. |
[h2]OH_ArkUI_AnimatorOption_SetDuration()
int32_t OH_ArkUI_AnimatorOption_SetDuration(ArkUI_AnimatorOption* option, int32_t value)
Description
Sets the playback duration of the animator animation, in ms.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| int32_t value | Playback duration, in ms. The default value is 0 ms. Value range: [0, +∞). If the value is less than 0, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetDelay()
int32_t OH_ArkUI_AnimatorOption_SetDelay(ArkUI_AnimatorOption* option, int32_t value)
Description
Sets the delay time of the animator animation playback, in ms.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| int32_t value | Animation delay, in milliseconds. Value range: (-∞, +∞). Default value: 0, indicating no animation delay. A value greater than 0 means to begin the animation after the specified amount of time has elapsed. A value less than 0 means to begin the animation in advance. If value is less than 0 and the absolute value of value is less than the actual animation duration, the animation starts its first frame from the state at the absolute value. If the absolute value of value is greater than or equal to the actual animation duration, the animation starts its first frame from the end state. The actual animation duration is equal to the duration of a single animation multiplied by the number of animation playback times. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetIterations()
int32_t OH_ArkUI_AnimatorOption_SetIterations(ArkUI_AnimatorOption* option, int32_t value)
Description
Sets the number of times that an animator animation is played. By default, the animation is played once. The value -1 indicates that the animation is played for an unlimited number of times. The value 0 indicates that no animation is played.
If this parameter is set to a negative value other than -1, the value is invalid. In this case, the animation is played once.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| int32_t value | Value range: [-1, +∞). If this parameter is set to 0, the animation is not played. If this parameter is set to -1, the animation is played for an infinite number of times. Default value: 1 (played once). If the value is less than -1, the operation is invalid. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetFill()
int32_t OH_ArkUI_AnimatorOption_SetFill(ArkUI_AnimatorOption* option, ArkUI_AnimationFillMode value)
Description
Sets the state retained by the component before the animation starts and after it ends.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_AnimationFillMode value | State of the component before the animation starts and after it ends during animation execution. Default value: ARKUI_ANIMATION_FILL_MODE_FORWARDS. The value options include: ARKUI_ANIMATION_FILL_MODE_NONE (0) indicates that the component restores to the initial state both before and after the animation. ARKUI_ANIMATION_FILL_MODE_FORWARDS (1) indicates that the component retains the end state after the animation ends. ARKUI_ANIMATION_FILL_MODE_BACKWARDS (2) indicates that the component retains the start state before the animation starts. ARKUI_ANIMATION_FILL_MODE_BOTH (3) indicates that the component retains the corresponding state both before and after the animation. If the value is less than 0, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetDirection()
int32_t OH_ArkUI_AnimatorOption_SetDirection(ArkUI_AnimatorOption* option, ArkUI_AnimationDirection value)
Description
Set the playback direction.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_AnimationDirection value | Animation playback direction. Default value: ARKUI_ANIMATION_DIRECTION_NORMAL. The value options include: ARKUI_ANIMATION_DIRECTION_NORMAL (0) indicates forward playback, ARKUI_ANIMATION_DIRECTION_REVERSE (1) indicates reverse playback, ARKUI_ANIMATION_DIRECTION_ALTERNATE (2) indicates playback in alternating mode, with forward playback on odd iterations and reverse playback on even iterations, and ARKUI_ANIMATION_DIRECTION_ALTERNATE_REVERSE (3) indicates playback in reverse alternating mode, with reverse playback on odd iterations and forward playback on even iterations. If the value is out of the valid range, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetCurve()
int32_t OH_ArkUI_AnimatorOption_SetCurve(ArkUI_AnimatorOption* option, ArkUI_CurveHandle value)
Description
Sets the interpolation curve for the animation of an animator.
The springCurve, springMotion, responsiveSpringMotion, interpolatingSpring, and customCurve animation curves are not supported.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_CurveHandle value | Interpolation curve. Default value: ARKUI_CURVE_LINEAR. You are advised to use ARKUI_CURVE_EASE_IN_OUT to obtain a smoother animation effect. If value is set to NULL, the default curve ARKUI_CURVE_LINEAR is used. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetBegin()
int32_t OH_ArkUI_AnimatorOption_SetBegin(ArkUI_AnimatorOption* option, float value)
Description
Sets the interpolation start point of an animation.
When the animator animation is a keyframe animation, this API returns the error code ARKUI_ERROR_CODE_PARAM_INVALID.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| float value | Start point of the animation interpolation. The default value is 0.0. Value range: (-∞, +∞). |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetEnd()
int32_t OH_ArkUI_AnimatorOption_SetEnd(ArkUI_AnimatorOption* option, float value)
Description
Sets the interpolation end point for the animation of an animator.
When the animator animation is a keyframe animation, this API returns the error code ARKUI_ERROR_CODE_PARAM_INVALID.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| float value | End point of the animation interpolation. Value range: (-∞, +∞). Default value: 1. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange()
int32_t OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange(ArkUI_AnimatorOption* option, ArkUI_ExpectedFrameRateRange* value)
Description
Sets the expected frame rate range of an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_ExpectedFrameRateRange* value | Pointer to the expected frame rate range. If the value is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetKeyframe()
int32_t OH_ArkUI_AnimatorOption_SetKeyframe(ArkUI_AnimatorOption* option, float time, float value, int32_t index)
Description
Sets the keyframe parameters of an animator animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| float time | Keyframe time. Value range: [0, 1]. The time of each keyframe must increase in sequence, that is, the time value of a later keyframe must be greater than that of the previous keyframe. Default value: evenly distributed by index (for example, 0.0 for the first frame, 0.5 for the second frame, and 1.0 for the third frame). If the value of time is less than 0 or greater than 1, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| float value | Interpolation target value corresponding to the keyframe, indicating the attribute value to be reached at the keyframe moment. Value range: (-∞, +∞). |
| int32_t index | Keyframe index. If the value of index is less than 0, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_SetKeyframeCurve()
int32_t OH_ArkUI_AnimatorOption_SetKeyframeCurve(ArkUI_AnimatorOption* option, ArkUI_CurveHandle value, int32_t index)
Description
Sets the keyframe curve type for the animation of an animator.
The springCurve, springMotion, responsiveSpringMotion, interpolatingSpring, and customCurve animation curves are not supported.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_CurveHandle value | Interpolation curve. Default value: NULL, indicating linear interpolation. |
| int32_t index | Index of the keyframe. The value range is [0, keyframeSize-1], where keyframeSize indicates the number of keyframes. If index is out of range, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_GetDuration()
int32_t OH_ArkUI_AnimatorOption_GetDuration(ArkUI_AnimatorOption* option)
Description
Obtains the playback duration of the animator animation, in ms.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, -1 is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Duration of the animation playback, in ms. If option is invalid, 0 is returned. |
[h2]OH_ArkUI_AnimatorOption_GetDelay()
int32_t OH_ArkUI_AnimatorOption_GetDelay(ArkUI_AnimatorOption* option)
Description
Obtains the delay for playing an animation, in ms.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is set to NULL, 0 is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Delay for playing the animation, in ms. If option is invalid, 0 is returned. |
[h2]OH_ArkUI_AnimatorOption_GetIterations()
int32_t OH_ArkUI_AnimatorOption_GetIterations(ArkUI_AnimatorOption* option)
Description
Obtains the number of times that an animator animation is played.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, 0 is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Number of times that the animation is played. If option is invalid, 0 is returned. |
[h2]OH_ArkUI_AnimatorOption_GetFill()
ArkUI_AnimationFillMode OH_ArkUI_AnimatorOption_GetFill(ArkUI_AnimatorOption* option)
Description
Obtains the status of the component before and after the animator animation execution.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, -1 is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_AnimationFillMode | State of the component before the animation starts and after it ends during animation execution. The return values include: ARKUI_ANIMATION_FILL_MODE_NONE (0, restores the initial state after playback is complete), ARKUI_ANIMATION_FILL_MODE_FORWARDS (1, retains the end state after playback is complete), ARKUI_ANIMATION_FILL_MODE_BACKWARDS (2, retains the start state during delayed playback), and ARKUI_ANIMATION_FILL_MODE_BOTH (3, applies both the FORWARDS and BACKWARDS effects). If option is invalid, -1 is returned. |
[h2]OH_ArkUI_AnimatorOption_GetDirection()
ArkUI_AnimationDirection OH_ArkUI_AnimatorOption_GetDirection(ArkUI_AnimatorOption* option)
Description
Obtains the playback direction of an animator animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. |
Return value
| Type | Description |
|---|---|
| ArkUI_AnimationDirection | Animation playback direction. The return values include: ARKUI_ANIMATION_DIRECTION_NORMAL (0, forward playback), ARKUI_ANIMATION_DIRECTION_REVERSE (1, reverse playback), ARKUI_ANIMATION_DIRECTION_ALTERNATE (2, playback in alternating mode, with forward playback on odd iterations and reverse playback on even iterations), and ARKUI_ANIMATION_DIRECTION_ALTERNATE_REVERSE (3, playback in reverse alternating mode, with reverse playback on odd iterations and forward playback on even iterations). If option is invalid, -1 is returned. |
[h2]OH_ArkUI_AnimatorOption_GetCurve()
ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetCurve(ArkUI_AnimatorOption* option)
Description
Obtains the interpolation curve of the animation of an animator.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Interpolation curve. If option is invalid, NULL is returned. |
[h2]OH_ArkUI_AnimatorOption_GetBegin()
float OH_ArkUI_AnimatorOption_GetBegin(ArkUI_AnimatorOption* option)
Description
Obtains the interpolation start point of an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. |
Return value
| Type | Description |
|---|---|
| float | Interpolation start point of the animation. If option is invalid, 0.0 is returned. |
[h2]OH_ArkUI_AnimatorOption_GetEnd()
float OH_ArkUI_AnimatorOption_GetEnd(ArkUI_AnimatorOption* option)
Description
Obtains the interpolation end point of an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. |
Return value
| Type | Description |
|---|---|
| float | Interpolation end point of the animation. If option is invalid, 0.0 is returned. |
[h2]OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange()
ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange(ArkUI_AnimatorOption* option)
Description
Obtains the expected frame rate range of an animator animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_ExpectedFrameRateRange* | Pointer to the expected frame rate range object. Returns NULL if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_GetKeyframeTime()
float OH_ArkUI_AnimatorOption_GetKeyframeTime(ArkUI_AnimatorOption* option, int32_t index)
Description
Obtains the keyframe time of the animator animation. The value range is [0, 1] and is a normalized time ratio.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. |
| int32_t index | Index of the keyframe. The value range is [0, keyframeSize-1], where keyframeSize indicates the number of keyframes. NULL is returned if index is out of range. |
Return value
| Type | Description |
|---|---|
| float | Keyframe time. The value range is [0, 1], which is a normalized time ratio. |
[h2]OH_ArkUI_AnimatorOption_GetKeyframeValue()
float OH_ArkUI_AnimatorOption_GetKeyframeValue(ArkUI_AnimatorOption* option, int32_t index)
Description
Obtains the keyframe value of an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, 0.0 is returned. |
| int32_t index | Index of the keyframe. The value range is [0, keyframeSize-1], where keyframeSize indicates the number of keyframes. If index is out of range, 0.0 is returned. |
Return value
| Type | Description |
|---|---|
| float | Keyframe value. |
[h2]OH_ArkUI_AnimatorOption_GetKeyframeCurve()
ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetKeyframeCurve(ArkUI_AnimatorOption* option, int32_t index)
Description
Obtains the interpolation curve for a keyframe in the animation of an animator.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, a null pointer is returned. |
| int32_t index | Index of the keyframe. The value range is [0, keyframeSize-1], where keyframeSize indicates the number of keyframes. If index is out of range, a null pointer is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Interpolation curve. Returns NULL if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorEvent_GetUserData()
void* OH_ArkUI_AnimatorEvent_GetUserData(ArkUI_AnimatorEvent* event)
Description
Obtains the user-defined object in an animation event object.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorEvent* event | Pointer to the animation event object. If event is NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| void* | Pointer to the user-defined object. |
[h2]OH_ArkUI_AnimatorOnFrameEvent_GetUserData()
void* OH_ArkUI_AnimatorOnFrameEvent_GetUserData(ArkUI_AnimatorOnFrameEvent* event)
Description
Obtains the user-defined object in the frame event of an animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOnFrameEvent* event | Pointer to the animation event object. If event is NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| void* | Pointer to the user-defined object. |
[h2]OH_ArkUI_AnimatorOnFrameEvent_GetValue()
float OH_ArkUI_AnimatorOnFrameEvent_GetValue(ArkUI_AnimatorOnFrameEvent* event)
Description
Obtains the interpolation result in the animation frame callback event object.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOnFrameEvent* event | Pointer to the animation event object. If event is NULL, 0.0 is returned. |
Return value
| Type | Description |
|---|---|
| float | Animation interpolation result. NOTE During the animation, the interpolation result changes between the interpolation start point (OH_ArkUI_AnimatorOption_SetBegin) and the interpolation end point (OH_ArkUI_AnimatorOption_SetEnd) based on the animation parameters. |
[h2]OH_ArkUI_AnimatorOption_RegisterOnFrameCallback()
int32_t OH_ArkUI_AnimatorOption_RegisterOnFrameCallback(ArkUI_AnimatorOption* option, void* userData, void (*callback)(ArkUI_AnimatorOnFrameEvent* event))
Description
Sets the callback invoked when the animator receives a frame.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| void* userData | Pointer to a user-defined configuration. |
| void (*callback)(ArkUI_AnimatorOnFrameEvent* event) | Pointer to the callback function. - event: input parameter of the callback function, which is an animation event object. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_RegisterOnFinishCallback()
int32_t OH_ArkUI_AnimatorOption_RegisterOnFinishCallback(ArkUI_AnimatorOption* option, void* userData, void (*callback)(ArkUI_AnimatorEvent* event))
Description
Sets the callback invoked when the animation playback is complete.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| void* userData | Pointer to a user-defined configuration. |
| void (*callback)(ArkUI_AnimatorEvent* event) | Pointer to the callback function. - event: input parameter of the callback function, which is the animation event object. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_RegisterOnCancelCallback()
int32_t OH_ArkUI_AnimatorOption_RegisterOnCancelCallback(ArkUI_AnimatorOption* option, void* userData, void (*callback)(ArkUI_AnimatorEvent* event))
Description
Sets the callback invoked when the animation playback is canceled.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| void* userData | Pointer to a user-defined configuration. |
| void (*callback)(ArkUI_AnimatorEvent* event) | Pointer to the callback function. - event: input parameter of the callback function, which is the animation event object. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback()
int32_t OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback(ArkUI_AnimatorOption* option, void* userData, void (*callback)(ArkUI_AnimatorEvent* event))
Description
Sets the callback invoked when the animation playback is repeated.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| void* userData | Pointer to a user-defined configuration. |
| void (*callback)(ArkUI_AnimatorEvent* event) | Pointer to the callback function. - event: input parameter of the callback function, which is the animation event object. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_Animator_ResetAnimatorOption()
int32_t OH_ArkUI_Animator_ResetAnimatorOption(ArkUI_AnimatorHandle animatorHandle, ArkUI_AnimatorOption* option)
Description
Resets the configuration of the animator animation.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorHandle animatorHandle | Pointer to the animator animation object. When animatorHandle is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_AnimatorOption* option | Pointer to an animator animation configuration. If option is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_Animator_Play()
int32_t OH_ArkUI_Animator_Play(ArkUI_AnimatorHandle animatorHandle)
Description
Starts the animator animation. This API must be called on the main thread.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorHandle animatorHandle | Animator animation object. If animatorHandle is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_Animator_Finish()
int32_t OH_ArkUI_Animator_Finish(ArkUI_AnimatorHandle animatorHandle)
Description
Finishes the animator animation. The animation jumps to the end state and then stops. The difference from OH_ArkUI_Animator_Cancel is: Cancel immediately interrupts the animation and returns to the initial state, whereas Finish makes the animation jump directly to the end state and then stop. This API must be called on the main thread.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorHandle animatorHandle | Animator animation object. If animatorHandle is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_Animator_Pause()
int32_t OH_ArkUI_Animator_Pause(ArkUI_AnimatorHandle animatorHandle)
Description
Pauses the animation of an animator.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorHandle animatorHandle | Animator animation object. If animatorHandle is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_Animator_Cancel()
int32_t OH_ArkUI_Animator_Cancel(ArkUI_AnimatorHandle animatorHandle)
Description
Cancels the animation of an animator.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorHandle animatorHandle | Animator animation object. If animatorHandle is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_Animator_Reverse()
int32_t OH_ArkUI_Animator_Reverse(ArkUI_AnimatorHandle animatorHandle)
Description
Plays this animation in reverse order.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimatorHandle animatorHandle | Animator animation object. If animatorHandle is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_Curve_CreateCurveByType()
ArkUI_CurveHandle OH_ArkUI_Curve_CreateCurveByType(ArkUI_AnimationCurve curve)
Description
Implements initialization for the interpolation curve, which is used to create an interpolation curve based on the input parameter.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_AnimationCurve curve | Curve type. NULL is returned if the curve value is invalid. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Pointer to the interpolation curve object, used for interpolation calculation of animation attribute values. NULL is returned when the curve value is abnormal. |
[h2]OH_ArkUI_Curve_CreateStepsCurve()
ArkUI_CurveHandle OH_ArkUI_Curve_CreateStepsCurve(int32_t count, bool end)
Description
Creates a step curve.
Since: 12
Parameters
| Name | Description |
|---|---|
| int32_t count | Number of steps. The value must be a positive integer. Value range: [1, +∞). If the value of count is abnormal, the operation is invalid. |
| bool end | Whether the step change occurs at the start or end of each interval. true: The step change occurs at the end of each interval. false: The step change occurs at the start of each interval. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Pointer to the step curve object. NULL is returned if the parameter is invalid. |
[h2]OH_ArkUI_Curve_CreateCubicBezierCurve()
ArkUI_CurveHandle OH_ArkUI_Curve_CreateCubicBezierCurve(float x1, float y1, float x2, float y2)
Description
Creates a cubic Bezier curve.
Since: 12
Parameters
| Name | Description |
|---|---|
| float x1 | X-coordinate of the first point on the Bezier curve. Value range: [0, 1]. A value less than 0 is treated as 0. A value greater than 1 is treated as 1. |
| float y1 | Y-coordinate of the first point on the Bezier curve. Value range: (-∞, +∞). |
| float x2 | X-coordinate of the second point on the Bezier curve. Value range: [0, 1]. A value less than 0 is treated as 0. A value greater than 1 is treated as 1. |
| float y2 | Y-coordinate of the second point on the Bezier curve. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Pointer to the cubic Bezier curve object. |
[h2]OH_ArkUI_Curve_CreateSpringCurve()
ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringCurve(float velocity, float mass, float stiffness, float damping)
Description
Creates a spring curve. The curve shape is determined by the spring parameters, and the animation duration is determined by the duration parameter in the animation parameters.
Since: 12
Parameters
| Name | Description |
|---|---|
| float velocity | Initial velocity. It is a parameter that reflects the impact of external factors on the spring motion, and its purpose is to ensure that the object smoothly transitions from the previous motion state to the spring motion. This velocity is a normalized velocity, whose value equals the actual velocity at the start of the animation divided by the change value of the animation attribute. |
| float mass | Mass. It is the object on which the force acts in the spring system, and it produces an inertial effect on the spring system. The greater the mass, the larger the oscillation amplitude and the slower the speed of returning to the equilibrium position. Value range: [0, +∞). If the value is less than or equal to 0, 1 is used. |
| float stiffness | Stiffness. It is the degree to which an object deforms by resisting the force applied. In an elastic system, the greater the stiffness, the stronger the ability to resist deformation, and the faster the speed of restoring to the equilibrium position. Value range: [0, +∞). If the value is less than or equal to 0, 1 is used. |
| float damping | Damping. It is used to describe the oscillation and attenuation of the system after being disturbed. The greater the damping, the fewer the oscillation times and the smaller the oscillation amplitude of the spring motion. Value range: [0, +∞). If the value is less than or equal to 0, 1 is used. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Pointer to the interpolation object of the interpolator spring curve, used to perform interpolation calculation based on the spring physical model to generate an animation curve from 0 to 1. NULL is returned if the parameter is invalid. |
[h2]OH_ArkUI_Curve_CreateSpringMotion()
ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringMotion(float response, float dampingFraction, float overlapDuration)
Description
Creates a spring animation curve. If multiple spring animations are applied to the same attribute of an object, each animation replaces their predecessor and inherits the velocity.
Since: 12
Parameters
| Name | Description |
|---|---|
| float response | Natural vibration period of the spring, which determines the speed at which the spring resets, in seconds. Value range: (0, +∞). If the value is less than or equal to 0, 0.55 is used. |
| float dampingFraction | Damping coefficient. > 0 and < 1: underdamped. In this case, the spring overshoots the equilibrium position. **1**: critically damped. > 1: overdamped. In this case, the spring approaches equilibrium gradually. Value range: (0, +∞). If the value is less than or equal to 0, 0.825 is used. |
| float overlapDuration | Overlap duration of the spring animation, in seconds. When animation inheritance occurs, if the response values of the two spring animations differ, the response parameter transitions smoothly within the overlapDuration period. Value range: [0, +∞). If the value is less than 0, 0 is used. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Pointer to the interpolation object of the spring animation curve. The curve is constructed using responsive parameters, and velocity inheritance between animations is supported. NULL is returned if the parameter is invalid. |
[h2]OH_ArkUI_Curve_CreateResponsiveSpringMotion()
ArkUI_CurveHandle OH_ArkUI_Curve_CreateResponsiveSpringMotion(float response, float dampingFraction, float overlapDuration)
Description
Creates a responsive spring animation curve. It is a special case of springMotion, with the only difference in the default values. It can be used together with springMotion.
Since: 12
Parameters
| Name | Description |
|---|---|
| float response | Natural vibration period of the spring, which determines the speed at which the spring returns to its resting state, in seconds. Value range: (0, +∞). If the value is less than or equal to 0, 0.15 is used. |
| float dampingFraction | Damping coefficient. > 0 and < 1: underdamped. In this case, the spring overshoots the equilibrium position. **1**: critically damped. > 1: overdamped. In this case, the spring approaches equilibrium gradually. Value range: [0, +∞). If the value is less than 0, 0.86 is used. |
| float overlapDuration | Overlap duration of the spring animation, in seconds. When animation inheritance occurs, if the response values of the two spring animations differ, the response parameter transitions smoothly within the overlapDuration period. Value range: [0, +∞). If the value is less than 0, 0.25 is used. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Pointer to the interpolation object of the responsive spring animation curve. It is a special case of springMotion, differing only in the default parameters. NULL is returned if the parameter is invalid. |
[h2]OH_ArkUI_Curve_CreateInterpolatingSpring()
ArkUI_CurveHandle OH_ArkUI_Curve_CreateInterpolatingSpring(float velocity, float mass, float stiffness, float damping)
Description
Creates an interpolating spring curve animated from 0 to 1. The actual animation value is calculated based on the curve.
Since: 12
Parameters
| Name | Description |
|---|---|
| float velocity | Initial velocity. It is applied by external factors to the spring animation, designed to help ensure the smooth transition from the previous motion state. This is a normalized velocity, and it is calculated as the actual initial velocity divided by the change in the animation attribute. Value range: (-∞, +∞). |
| float mass | Mass. It is the object on which the force acts in the spring system, which produces an inertial effect on the spring system. The greater the mass, the larger the oscillation amplitude and the slower the speed of returning to the equilibrium position. Value range: [0, +∞). If the value is less than or equal to 0, 1 is used. |
| float stiffness | Stiffness. It is the degree to which an object deforms by resisting the force applied. The greater the stiffness, the stronger the ability to resist deformation, and the faster the speed of restoring to the equilibrium position. Value range: [0, +∞). If the value is less than or equal to 0, 1 is used. |
| float damping | Damping. It describes how the system oscillates and decays after being disturbed. The greater the damping, the fewer the oscillation cycles and the smaller the oscillation amplitude of the spring motion. Value range: [0, +∞). If the value is less than or equal to 0, 1 is used. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Pointer to the interpolation object of the curve. Returns NULL if a parameter error occurs. |
[h2]OH_ArkUI_Curve_CreateCustomCurve()
ArkUI_CurveHandle OH_ArkUI_Curve_CreateCustomCurve(void* userData, float (*interpolate)(float fraction, void* userdata))
Description
Creates a custom curve.
Since: 12
Parameters
| Name | Description |
|---|---|
| void* userData | Pointer to user-defined data. |
| float (*interpolate)(float fraction, void* userdata) | Pointer to the user-defined interpolation callback. fraction indicates the input x value for interpolation when the animation starts; value range: [0, 1]. The return value is the y value of the curve. value range: [0, 1]. If fraction is 0, the return value 0 corresponds to the animation start point; any other return value means that the animation jumps at the start point. If fraction is 1, the return value 1 corresponds to the animation end point; any other return value means that the end value of the animation is not the value of the state variable, which will result in an effect of transition from that end value to the value of the state variable. |
Return value
| Type | Description |
|---|---|
| ArkUI_CurveHandle | Pointer to the interpolation object of the curve. Returns NULL if a parameter error occurs. |
[h2]OH_ArkUI_Curve_DisposeCurve()
void OH_ArkUI_Curve_DisposeCurve(ArkUI_CurveHandle curveHandle)
Description
Disposes of a custom curve.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_CurveHandle curveHandle | Pointer to the interpolation object of the curve. The operation is invalid when curveHandle is NULL. |
[h2]OH_ArkUI_CreateOpacityTransitionEffect()
ArkUI_TransitionEffect* OH_ArkUI_CreateOpacityTransitionEffect(float opacity)
Description
Creates an opacity effect object for component transition.
Since: 12
Parameters
| Name | Description |
|---|---|
| float opacity | Opacity. Value range: [0, 1]. The default value is 1. A value less than 0 is treated as 0. A value greater than 1 is treated as 1. The value 1 means fully opaque, and 0 means fully transparent. |
Return value
| Type | Description |
|---|---|
| ArkUI_TransitionEffect* | Pointer to the opacity effect object for component transition. |
[h2]OH_ArkUI_CreateTranslationTransitionEffect()
ArkUI_TransitionEffect* OH_ArkUI_CreateTranslationTransitionEffect(ArkUI_TranslationOptions* translate)
Description
Creates a translation effect object for component transition.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_TranslationOptions* translate | Pointer to the translation parameter object for component transition. If translate is NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_TransitionEffect* | Pointer to the translation effect object for component transition. Returns NULL if a parameter error occurs. |
[h2]OH_ArkUI_CreateScaleTransitionEffect()
ArkUI_TransitionEffect* OH_ArkUI_CreateScaleTransitionEffect(ArkUI_ScaleOptions* scale)
Description
Creates a scaling effect object for component transitions.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_ScaleOptions* scale | Scale parameter object for the component transition. NULL is returned if scale is NULL. |
Return value
| Type | Description |
|---|---|
| ArkUI_TransitionEffect* | Pointer to the scaling effect object for component transition. NULL is returned if a parameter error occurs. |
[h2]OH_ArkUI_CreateRotationTransitionEffect()
ArkUI_TransitionEffect* OH_ArkUI_CreateRotationTransitionEffect(ArkUI_RotationOptions* rotate)
Description
Creates a rotation effect object for component transition.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_RotationOptions* rotate | Pointer to the rotation options object for component transition. If rotate is NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_TransitionEffect* | Pointer to the rotation effect object for component transition. Returns NULL if a parameter error occurs. |
[h2]OH_ArkUI_CreateMovementTransitionEffect()
ArkUI_TransitionEffect* OH_ArkUI_CreateMovementTransitionEffect(ArkUI_TransitionEdge edge)
Description
Creates a movement transition effect object for the component. The slide-in and slide-out directions of the component are controlled by specifying the edge direction (top, bottom, left, or right). This API is suitable for simple scenarios where only the sliding direction needs to be specified. The difference from OH_ArkUI_CreateTranslationTransitionEffect is that the latter supports precise translation parameters in the x, y, and z directions and is suitable for scenarios where a specific displacement distance needs to be specified.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_TransitionEdge edge | Movement transition type, which determines the translation direction when the component appears and disappears. If the edge value is invalid, ARKUI_TRANSITION_EDGE_START is used. The value options include: ARKUI_TRANSITION_EDGE_TOP (0) indicates sliding in/out from the top, ARKUI_TRANSITION_EDGE_BOTTOM (1) indicates sliding in/out from the bottom, ARKUI_TRANSITION_EDGE_START (2) indicates sliding in/out from the left, and ARKUI_TRANSITION_EDGE_END (3) indicates sliding in/out from the right. |
Return value
| Type | Description |
|---|---|
| ArkUI_TransitionEffect* | Pointer to the translation effect object for component transition. Returns NULL if a parameter error occurs. |
[h2]OH_ArkUI_CreateAsymmetricTransitionEffect()
ArkUI_TransitionEffect* OH_ArkUI_CreateAsymmetricTransitionEffect(ArkUI_TransitionEffect* appear, ArkUI_TransitionEffect* disappear)
Description
Creates an asymmetric transition effect.
If this function is not used for ArkUI_TransitionEffect, the transition effect takes effect for both appearance and disappearance of the component.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_TransitionEffect* appear | Pointer to the transition effect when the component appears. If appear is NULL, NULL is returned. |
| ArkUI_TransitionEffect* disappear | Pointer to the transition effect when the component disappears. If disappear is NULL, NULL is returned. |
Return value
| Type | Description |
|---|---|
| ArkUI_TransitionEffect* | Pointer to the asymmetric transition effect. Returns NULL if a parameter error occurs. |
[h2]OH_ArkUI_CreateIdentityTransitionEffect()
ArkUI_TransitionEffect* OH_ArkUI_CreateIdentityTransitionEffect(void)
Description
Creates an effect object with no transition.
Since: 26.0.0
Return value
| Type | Description |
|---|---|
| ArkUI_TransitionEffect* | Pointer to the effect object with no transition. The caller needs to call OH_ArkUI_TransitionEffect_Dispose to release the object. |
[h2]OH_ArkUI_TransitionEffect_Dispose()
void OH_ArkUI_TransitionEffect_Dispose(ArkUI_TransitionEffect* effect)
Description
Disposes of a transition effect.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_TransitionEffect* effect | Pointer to the transition effect object. The operation is invalid when effect is NULL. |
[h2]OH_ArkUI_TransitionEffect_Combine()
int32_t OH_ArkUI_TransitionEffect_Combine(ArkUI_TransitionEffect* firstEffect, ArkUI_TransitionEffect* secondEffect)
Description
Sets a combination of transition effects.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_TransitionEffect* firstEffect | Pointer to the preceding transition effect in the chain, which will be combined with secondEffect to form a TransitionEffect containing multiple transition effects. If firstEffect is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_TransitionEffect* secondEffect | Pointer to the following transition effect to be combined, which will be chained with firstEffect to form a TransitionEffect containing multiple transition effects. If secondEffect is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |
[h2]OH_ArkUI_TransitionEffect_SetAnimation()
int32_t OH_ArkUI_TransitionEffect_SetAnimation(ArkUI_TransitionEffect* effect, ArkUI_AnimateOption* animation)
Description
Sets transition effect animation settings.
If OH_ArkUI_TransitionEffect_Combine is used to combine transition effects, the animation parameter settings of a transition effect are applicable to the one following it.
Since: 12
Parameters
| Name | Description |
|---|---|
| ArkUI_TransitionEffect* effect | Pointer to the transition effect object for which animation parameters are to be set. If effect is NULL, the error code ARKUI_ERROR_CODE_PARAM_INVALID is returned. |
| ArkUI_AnimateOption* animation | Pointer to the animator animation configuration. If animation is NULL, the animation parameters are set to empty. |
Return value
| Type | Description |
|---|---|
| int32_t | Result code. Returns ARKUI_ERROR_CODE_NO_ERROR if the operation is successful. Returns ARKUI_ERROR_CODE_PARAM_INVALID if a parameter error occurs. |