-
Notifications
You must be signed in to change notification settings - Fork 278
[NUI] Deprecate RiveAnimationView, TCSACR-660 #7742
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: API14
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,6 +26,7 @@ namespace Tizen.NUI.Extension | |
| /// RiveAnimationView renders an animated vector image (Rive file). | ||
| /// </summary> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public class RiveAnimationView : View | ||
| { | ||
| static RiveAnimationView() { } | ||
|
|
@@ -35,6 +36,7 @@ static RiveAnimationView() { } | |
| /// </summary> | ||
| /// <param name="url">The rive resource URL</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since the Consider removing the
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [AI Review] |
||
| public RiveAnimationView(string url) : this(Interop.RiveAnimationView.New(url), true) | ||
| { | ||
| if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); | ||
|
|
@@ -54,6 +56,7 @@ internal RiveAnimationView(global::System.IntPtr cPtr, bool shown = true) : base | |
| /// <param name="animationName">The animation to enable</param> | ||
| /// <param name="on">The enable state of given animation</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void EnableAnimation(string animationName, bool on) | ||
| { | ||
| Interop.RiveAnimationView.EnableAnimation(SwigCPtr, animationName, on); | ||
|
|
@@ -63,6 +66,7 @@ public void EnableAnimation(string animationName, bool on) | |
| /// Play animation. | ||
| /// </summary> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void Play() | ||
| { | ||
| Interop.RiveAnimationView.Play(SwigCPtr); | ||
|
|
@@ -72,6 +76,7 @@ public void Play() | |
| /// Pause animation. | ||
| /// </summary> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void Pause() | ||
| { | ||
| Interop.RiveAnimationView.Pause(SwigCPtr); | ||
|
|
@@ -81,6 +86,7 @@ public void Pause() | |
| /// Stop animation. | ||
| /// </summary> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void Stop() | ||
| { | ||
| Interop.RiveAnimationView.Stop(SwigCPtr); | ||
|
|
@@ -92,6 +98,7 @@ public void Stop() | |
| /// <param name="shapeFillName">The shape fill name</param> | ||
| /// <param name="color">The rgba color</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void SetShapeFillColor(string shapeFillName, Color color) | ||
| { | ||
| if (color == null) | ||
|
|
@@ -105,6 +112,7 @@ public void SetShapeFillColor(string shapeFillName, Color color) | |
| /// <param name="shapeStrokeName">The shape stroke name</param> | ||
| /// <param name="color">The rgba color</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void SetShapeStrokeColor(string shapeStrokeName, Color color) | ||
| { | ||
| if (color == null) | ||
|
|
@@ -118,6 +126,7 @@ public void SetShapeStrokeColor(string shapeStrokeName, Color color) | |
| /// <param name="nodeName">The node name</param> | ||
| /// <param name="opacity">The opacity of given node</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void SetNodeOpacity(string nodeName, float opacity) | ||
| { | ||
| Interop.RiveAnimationView.SetNodeOpacity(SwigCPtr, nodeName, opacity); | ||
|
|
@@ -129,6 +138,7 @@ public void SetNodeOpacity(string nodeName, float opacity) | |
| /// <param name="nodeName">The node name</param> | ||
| /// <param name="scale">The scale of given node</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void SetNodeScale(string nodeName, Vector2 scale) | ||
| { | ||
| if (scale == null) | ||
|
|
@@ -142,6 +152,7 @@ public void SetNodeScale(string nodeName, Vector2 scale) | |
| /// <param name="nodeName">The node name</param> | ||
| /// <param name="degree">The degree of given node</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void SetNodeRotation(string nodeName, Degree degree) | ||
| { | ||
| if (degree == null) | ||
|
|
@@ -155,6 +166,7 @@ public void SetNodeRotation(string nodeName, Degree degree) | |
| /// <param name="nodeName">The node name</param> | ||
| /// <param name="position">The position of given node</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void SetNodePosition(string nodeName, Position position) | ||
| { | ||
| if (position == null) | ||
|
|
@@ -168,6 +180,7 @@ public void SetNodePosition(string nodeName, Position position) | |
| /// <param name="animationName">The animation name</param> | ||
| /// <param name="elapsed">The elapsed time in seconds</param> | ||
| /// <since_tizen> 9 </since_tizen> | ||
| [Obsolete("This has been deprecated in API14, and will be removed in API16")] | ||
| public void SetAnimationElapsedTime(string animationName, float elapsed) | ||
| { | ||
| Interop.RiveAnimationView.SetAnimationElapsedTime(SwigCPtr, animationName, elapsed); | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To prevent the deprecated
RiveAnimationViewclass from cluttering IntelliSense for developers using the SDK, it is recommended to hide it by applying the[EditorBrowsable(EditorBrowsableState.Never)]attribute. SinceSystem.ComponentModelis already imported in this file, you can apply it directly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 [AI Review]
Applying
[EditorBrowsable(EditorBrowsableState.Never)]here would conflict with TizenFX convention: that attribute marks APIs excluded from the official documentation surface, while a deprecated public API stays documented and supported through its grace period (deprecated in API14, removed in API16). The recent TCSACR-647 deprecation (commit 94eed19) followed the same[Obsolete]-only pattern without hiding the APIs from IntelliSense.