/* * Copyright(c) 2021 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ namespace Tizen.NUI { using System; using System.ComponentModel; using System.Runtime.InteropServices; using Tizen.NUI.BaseComponents; using System.Collections; using System.Collections.Generic; using System.Linq; using System.Reflection; using System.Xml; using Tizen.NUI.Binding.Internals; using Tizen.NUI.Binding; using System.Globalization; using Tizen.NUI.Xaml.Internals; using System.Diagnostics.CodeAnalysis; /// /// Animation can be used to animate the properties of any number of objects, typically view.
/// If the "Finished" event is connected to a member function of an object, it must be disconnected before the object is destroyed.
/// This is typically done in the object destructor, and requires either the animation handle to be stored.
/// The overall animation time is superseded by the values given in the animation time used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods.
/// If any of the individual calls to those functions exceeds the overall animation time (Duration), then the overall animation time is automatically extended.
///
/// 3 public class Animation : BaseHandle { private static bool? disableAnimation = null; private AnimationFinishedEventCallbackType _animationFinishedEventCallback; private System.IntPtr _finishedCallbackOfNative; private AnimationProgressReachedEventCallbackType _animationProgressReachedEventCallback; private string[] _properties = null; private string[] _destValue = null; private int[] _startTime = null; private int[] _endTime = null; private List propertyList = null; private List destValueList = null; private List startTimeList = null; private List endTimeList = null; /// /// Creates an initialized animation.
/// The animation will not loop.
/// The default end action is "Cancel".
/// The default alpha function is linear.
///
/// DurationmSeconds must be greater than zero. /// The duration in milliseconds. /// 3 public Animation(int durationMilliSeconds) : this(Interop.Animation.New((float)durationMilliSeconds / 1000.0f), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal Animation(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn) { _animationFinishedEventCallback = OnFinished; _finishedCallbackOfNative = System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate(_animationFinishedEventCallback); } [UnmanagedFunctionPointer(CallingConvention.StdCall)] private delegate void AnimationFinishedEventCallbackType(IntPtr data); [UnmanagedFunctionPointer(CallingConvention.StdCall)] private delegate void AnimationProgressReachedEventCallbackType(IntPtr data); private event EventHandler _animationFinishedEventHandler; /** * @brief Event for the finished signal which can be used to subscribe or unsubscribe the event handler. * The finished signal is emitted when an animation's animations have finished. */ /// 3 public event EventHandler Finished { add { if (_animationFinishedEventHandler == null && disposed == false) { AnimationSignal finishedSignal = FinishedSignal(); finishedSignal.Connect(_finishedCallbackOfNative); finishedSignal.Dispose(); } _animationFinishedEventHandler += value; } remove { _animationFinishedEventHandler -= value; AnimationSignal finishedSignal = FinishedSignal(); if (_animationFinishedEventHandler == null && finishedSignal.Empty() == false) { finishedSignal.Disconnect(_finishedCallbackOfNative); } finishedSignal.Dispose(); } } private event EventHandler _animationProgressReachedEventHandler; /** * @brief Event for the ProgressReached signal, which can be used to subscribe or unsubscribe the event handler. * The ProgressReached signal is emitted when the animation has reached a given progress percentage, this is set in the api SetProgressNotification. */ /// 3 public event EventHandler ProgressReached { add { if (_animationProgressReachedEventHandler == null) { _animationProgressReachedEventCallback = OnProgressReached; AnimationSignal progressReachedSignal = ProgressReachedSignal(); progressReachedSignal?.Connect(_animationProgressReachedEventCallback); progressReachedSignal?.Dispose(); } _animationProgressReachedEventHandler += value; } remove { _animationProgressReachedEventHandler -= value; AnimationSignal progressReachedSignal = ProgressReachedSignal(); if (_animationProgressReachedEventHandler == null && progressReachedSignal?.Empty() == false) { progressReachedSignal?.Disconnect(_animationProgressReachedEventCallback); } progressReachedSignal.Dispose(); } } /// /// Enumeration for what to do when the animation ends, stopped, or destroyed. /// /// 3 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1717:Only FlagsAttribute enums should have plural names")] public enum EndActions { /// /// When the animation ends, the animated property values are saved. /// Cancel, /// /// When the animation ends, the animated property values are forgotten. /// Discard, /// /// If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like cancel. /// StopFinal } /// /// Enumeration for what interpolation method to use on key-frame animations. /// /// 3 public enum Interpolation { /// /// Values in between key frames are interpolated using a linear polynomial. (Default) /// Linear, /// /// Values in between key frames are interpolated using a cubic polynomial. /// Cubic } /// /// Enumeration for what state the animation is in. /// /// Calling Reset() on this class will not reset the animation. It will call the BaseHandle.Reset() which drops the object handle. /// 3 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1717:Only FlagsAttribute enums should have plural names")] public enum States { /// /// The animation has stopped. /// Stopped, /// /// The animation is playing. /// Playing, /// /// The animation is paused. /// Paused } /// /// Gets or sets the duration in milliseconds of the animation. /// /// 3 public int Duration { set { SetDuration(MilliSecondsToSeconds(value)); } get { return SecondsToMilliSeconds(GetDuration()); } } /// /// Gets or sets the default alpha function for the animation. /// /// 3 public AlphaFunction DefaultAlphaFunction { set { SetDefaultAlphaFunction(value); } get { AlphaFunction ret = GetDefaultAlphaFunction(); return ret; } } /// /// Queries the state of the animation. /// /// 3 public States State { get { return GetState(); } } /// /// Set: Enables looping for a specified number of repeats. A zero is the same as Looping = true; i.e., repeat forever.
/// This property resets the looping value and should not be used with the Looping property.
/// Setting this parameter does not cause the animation to Play().
/// Get: Gets the loop count. A zero is the same as Looping = true; i.e., repeat forever.
/// The loop count is initially 1 for play once.
///
/// 3 public int LoopCount { set { SetLoopCount(value); } get { int ret = GetLoopCount(); return ret; } } /// /// Gets or sets the status of whether the animation will loop.
/// This property resets the loop count and should not be used with the LoopCount property.
/// Setting this parameter does not cause the animation to Play().
///
/// 3 public bool Looping { set { SetLooping(value); } get { bool ret = IsLooping(); return ret; } } /// /// Gets or sets the end action of the animation.
/// This action is performed when the animation ends or if it is stopped.
/// The default end action is cancel.
///
/// 3 public EndActions EndAction { set { SetEndAction(value); } get { return GetEndAction(); } } /// /// Gets the current loop count.
/// A value 0 indicating the current loop count when looping.
///
/// 3 public int CurrentLoop { get { return GetCurrentLoop(); } } /// /// Gets or sets the disconnect action.
/// If any of the animated property owners are disconnected from the stage while the animation is being played, then this action is performed.
/// The default action is cancel.
///
/// 3 public EndActions DisconnectAction { set { Interop.Animation.SetDisconnectAction(SwigCPtr, (int)value); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } get { Animation.EndActions ret = (Animation.EndActions)Interop.Animation.GetDisconnectAction(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve()); return ret; } } /// /// Gets or sets the progress of the animation.
/// The animation will play (or continue playing) from this point.
/// The progress must be in the 0-1 interval or in the play range interval if defined
/// otherwise, it will be ignored.
///
/// 3 public float CurrentProgress { set { Interop.Animation.SetCurrentProgress(SwigCPtr, value); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } get { float ret = Interop.Animation.GetCurrentProgress(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve()); return ret; } } /// /// Gets or sets specificifications of a speed factor for the animation.
/// The speed factor is a multiplier of the normal velocity of the animation.
/// Values between [0, 1] will slow down the animation and values above one will speed up the animation.
/// It is also possible to specify a negative multiplier to play the animation in reverse.
///
/// 3 public float SpeedFactor { set { Interop.Animation.SetSpeedFactor(SwigCPtr, value); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } get { float ret = Interop.Animation.GetSpeedFactor(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve()); return ret; } } /// /// Gets or sets the playing range.
/// Animation will play between the values specified. Both values (range.x and range.y ) should be between 0-1, /// otherwise they will be ignored. If the range provided is not in proper order (minimum, maximum ), it will be reordered.
///
/// 3 public RelativeVector2 PlayRange { set { Interop.Animation.SetPlayRange(SwigCPtr, Vector2.getCPtr(value)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } get { Vector2 ret = new Vector2(Interop.Animation.GetPlayRange(SwigCPtr), true); if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve()); return ret; } } /// /// Gets or sets the progress notification marker which triggers the ProgressReachedSignal.
/// Percentage of animation progress should be greater than 0 and less than 1, for example, 0.3 for 30%
/// One notification can be set on each animation. ///
/// 3 public float ProgressNotification { set { Interop.Animation.SetProgressNotification(SwigCPtr, value); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } get { float ret = Interop.Animation.GetProgressNotification(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve()); return ret; } } /// /// Gets or sets the properties of the animation. /// //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, Will be removed in API11, Please use PropertyList instead")] [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This API will be deprecated, so suppressing the warning for now")] public string[] Properties { get { return _properties; } set { _properties = value; } } /// /// Gets or sets the destination value for each property of the animation. /// //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, Will be removed in API11, Please use DestValueList instead")] [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This API will be deprecated, so suppressing the warning for now")] public string[] DestValue { get { return _destValue; } set { _destValue = value; } } /// /// Gets or sets the start time for each property of the animation. /// //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, Will be removed in API11, Please use StartTimeList instead")] [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This API will be deprecated, so suppressing the warning for now")] public int[] StartTime { get { return _startTime; } set { _startTime = value; } } /// /// Gets or sets the end time for each property of the animation. /// //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, Will be removed in API11, Please use EndTimeList instead")] [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This API will be deprecated, so suppressing the warning for now")] public int[] EndTime { get { return _endTime; } set { _endTime = value; } } /// /// Get the list of the properties of the animation. /// [EditorBrowsable(EditorBrowsableState.Never)] public IList PropertyList { get { if (null == propertyList) { propertyList = new List(); } return propertyList; } } /// /// Get the list of the destination value for each property of the animation. /// [EditorBrowsable(EditorBrowsableState.Never)] public IList DestValueList { get { if (null == destValueList) { destValueList = new List(); } return destValueList; } } /// /// Get the list of the start time for each property of the animation. /// [EditorBrowsable(EditorBrowsableState.Never)] public IList StartTimeList { get { if (null == startTimeList) { startTimeList = new List(); } return startTimeList; } } /// /// Get the list of end time for each property of the animation. /// [EditorBrowsable(EditorBrowsableState.Never)] public IList EndTimeList { get { if (null == endTimeList) { endTimeList = new List(); } return endTimeList; } } private bool DisableAnimation { get { if (disableAnimation.HasValue == false) { string type = Environment.GetEnvironmentVariable("PlatformSmartType"); if (type == "Entry") disableAnimation = true; else disableAnimation = false; } return disableAnimation.Value; } } /// /// Downcasts a handle to animation handle.
/// If handle points to an animation object, the downcast produces a valid handle.
/// If not, the returned handle is left uninitialized.
///
/// Handle to an object. /// Handle to an animation object or an uninitialized handle. /// Thrown when handle is null. internal static Animation DownCast(BaseHandle handle) { if (handle == null) { throw new ArgumentNullException(nameof(handle)); } Animation ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as Animation; if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } /// /// Stops the animation. /// /// The end action can be set. /// 3 public void Stop(EndActions action = EndActions.Cancel) { SetEndAction(action); Interop.Animation.Stop(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Animates a property value by a relative amount.
///
/// The target object to animate. /// The target property to animate. /// The property value will change by this amount. /// The alpha function to apply. /// Thrown when target or property or relativeValue is null. /// Thrown when it failed to find a property from given string or the given relativeValue is invalid format. /// 3 public void AnimateBy(View target, string property, object relativeValue, AlphaFunction alphaFunction = null) { if (target == null) { throw new ArgumentNullException(nameof(target)); } if (property == null) { throw new ArgumentNullException(nameof(property)); } if (relativeValue == null) { throw new ArgumentNullException(nameof(relativeValue)); } using (var result = PropertyHelper.Search(target, property)) { if (result == null) { throw new ArgumentException("string property is invalid"); } var current = result; while (current != null) { var targetValue = current.RefineValue(relativeValue) ?? throw new ArgumentException("Invalid " + nameof(relativeValue)); AnimateBy(current.Property, targetValue, alphaFunction); targetValue.Dispose(); current = current.NextResult; } } } /// /// Animates a property value by a relative amount.
///
/// The target object to animate. /// The target property to animate. /// The property value will change by this amount. /// The start time of the animation. /// The end time of the animation. /// The alpha function to apply. /// Thrown when target or property or relativeValue is null. /// Thrown when it failed to find a property from given string or the given relativeValue is invalid format. /// 3 public void AnimateBy(View target, string property, object relativeValue, int startTime, int endTime, AlphaFunction alphaFunction = null) { if (target == null) { throw new ArgumentNullException(nameof(target)); } if (property == null) { throw new ArgumentNullException(nameof(property)); } if (relativeValue == null) { throw new ArgumentNullException(nameof(relativeValue)); } using (var result = PropertyHelper.Search(target, property)) { if (result == null) { throw new ArgumentException("string property is invalid"); } var current = result; using (var time = new TimePeriod(MilliSecondsToSeconds(startTime), MilliSecondsToSeconds(endTime - startTime))) while (current != null) { var targetValue = current.RefineValue(relativeValue) ?? throw new ArgumentException("Invalid " + nameof(relativeValue)); AnimateBy(current.Property, targetValue, alphaFunction, time); targetValue.Dispose(); current = current.NextResult; } } } /// /// Animates a property to a destination value.
///
/// The target object to animate. /// The target property to animate. /// The destination value. /// The alpha function to apply. /// Thrown when target or property or destinationValue is null. /// Thrown when it failed to find a property from given string or the given destinationValue is invalid format. /// 3 public void AnimateTo(View target, string property, object destinationValue, AlphaFunction alphaFunction = null) { if (target == null) { throw new ArgumentNullException(nameof(target)); } if (property == null) { throw new ArgumentNullException(nameof(property)); } if (destinationValue == null) { throw new ArgumentNullException(nameof(destinationValue)); } using (var result = PropertyHelper.Search(target, property)) { if (result == null) { throw new ArgumentException("string property is invalid"); } var current = result; while (current != null) { var targetValue = current.RefineValue(destinationValue) ?? throw new ArgumentException("Invalid " + nameof(destinationValue)); AnimateTo(current.Property, targetValue, alphaFunction); targetValue.Dispose(); current = current.NextResult; } } } /// /// Animates one or more properties to a destination value.
///
/// The target object to animate. /// Thrown when target is null. public void PlayAnimateTo(View target) { if (target == null) { throw new ArgumentNullException(nameof(target)); } Clear(); if (null != propertyList && null != destValueList && null != startTimeList && null != endTimeList) { if (propertyList.Count == destValueList.Count && startTimeList.Count == endTimeList.Count && propertyList.Count == startTimeList.Count) { int count = propertyList.Count; for (int index = 0; index < count; index++) { var elementType = target.GetType(); PropertyInfo propertyInfo = elementType.GetProperties().FirstOrDefault(fi => fi.Name == propertyList[index]); if (propertyInfo != null) { object destinationValue = ConvertTo(destValueList[index], propertyInfo.PropertyType); if (destinationValue != null) { AnimateTo(target, propertyList[index], destinationValue, startTimeList[index], endTimeList[index]); } } } Play(); } } else { if (_properties.Length == _destValue.Length && _startTime.Length == _endTime.Length && _properties.Length == _startTime.Length) { int length = _properties.Length; for (int index = 0; index < length; index++) { //object destinationValue = _destValue[index]; var elementType = target.GetType(); PropertyInfo propertyInfo = elementType.GetProperties().FirstOrDefault(fi => fi.Name == _properties[index]); //var propertyInfo = elementType.GetRuntimeProperties().FirstOrDefault(p => p.Name == localName); if (propertyInfo != null) { object destinationValue = ConvertTo(_destValue[index], propertyInfo.PropertyType); if (destinationValue != null) { AnimateTo(target, _properties[index], destinationValue, _startTime[index], _endTime[index]); } } } Play(); } } } /// /// Animates a property to a destination value.
///
/// The target object to animate. /// The target property to animate. /// The destination value. /// The start time of the animation. /// The end time of the animation. /// The alpha function to apply. /// Thrown when target or property or destinationValue is null. /// Thrown when it failed to find a property from given string or the given destinationValue is invalid format. /// 3 public void AnimateTo(View target, string property, object destinationValue, int startTime, int endTime, AlphaFunction alphaFunction = null) { if (target == null) { throw new ArgumentNullException(nameof(target)); } if (property == null) { throw new ArgumentNullException(nameof(property)); } if (destinationValue == null) { throw new ArgumentNullException(nameof(destinationValue)); } using (var result = PropertyHelper.Search(target, property)) { if (result == null) { throw new ArgumentException("string property is invalid"); } var current = result; using (var time = new TimePeriod(MilliSecondsToSeconds(startTime), MilliSecondsToSeconds(endTime - startTime))) while (current != null) { var targetValue = current.RefineValue(destinationValue) ?? throw new ArgumentException("Invalid " + nameof(destinationValue)); AnimateTo(current.Property, targetValue, alphaFunction, time); targetValue.Dispose(); current = current.NextResult; } } } /// /// Animates a property between keyframes. /// /// The target object to animate. /// The target property to animate. /// The set of time or value pairs between which to animate. /// The method used to interpolate between values. /// The alpha function to apply. /// Thrown when target or property or keyFrames is null. /// Thrown when it failed to find a property from given string or the given keyFrames has invalid value. /// 3 public void AnimateBetween(View target, string property, KeyFrames keyFrames, Interpolation interpolation = Interpolation.Linear, AlphaFunction alphaFunction = null) { if (target == null) { throw new ArgumentNullException(nameof(target)); } if (property == null) { throw new ArgumentNullException(nameof(property)); } if (keyFrames == null) { throw new ArgumentNullException(nameof(keyFrames)); } using (var result = PropertyHelper.Search(target, property)) { if (result == null) { throw new ArgumentException("string property is invalid"); } var current = result; while (current != null) { // NOTE Do not dispose keyFrames object returned by GetRefinedKeyFrames() here. AnimateBetween(current.Property, current.RefineKeyFrames(keyFrames) ?? throw new ArgumentException("Invalid " + nameof(keyFrames)), alphaFunction, interpolation); current = current.NextResult; } } } /// /// Animates a property between keyframes. /// /// The target object to animate /// The target property to animate /// The set of time/value pairs between which to animate /// The start time of animation in milliseconds. /// The end time of animation in milliseconds. /// The method used to interpolate between values. /// The alpha function to apply. /// Thrown when target or property or keyFrames is null. /// Thrown when it failed to find a property from given string or the given keyFrames has invalid value. /// 3 public void AnimateBetween(View target, string property, KeyFrames keyFrames, int startTime, int endTime, Interpolation interpolation = Interpolation.Linear, AlphaFunction alphaFunction = null) { if (target == null) { throw new ArgumentNullException(nameof(target)); } if (property == null) { throw new ArgumentNullException(nameof(property)); } if (keyFrames == null) { throw new ArgumentNullException(nameof(keyFrames)); } using (var result = PropertyHelper.Search(target, property)) { if (result == null) { throw new ArgumentException("string property is invalid"); } var current = result; using (var time = new TimePeriod(MilliSecondsToSeconds(startTime), MilliSecondsToSeconds(endTime - startTime))) while (current != null) { // NOTE Do not dispose keyFrames object returned by GetRefinedKeyFrames() here. AnimateBetween(current.Property, current.RefineKeyFrames(keyFrames) ?? throw new ArgumentException("Invalid " + nameof(keyFrames)), alphaFunction, time, interpolation); current = current.NextResult; } } } /// /// Animates the view's position and orientation through a predefined path.
/// The view will rotate to orient the supplied forward vector with the path's tangent.
/// If forward is the zero vector then no rotation will happen.
///
/// The view to animate. /// It defines position and orientation. /// The vector (in local space coordinate system) will be oriented with the path's tangent direction. /// The alpha function to apply. /// 3 public void AnimatePath(View view, Path path, Vector3 forward, AlphaFunction alphaFunction = null) { if (alphaFunction == null) { Animate(view, path, forward); } else { Animate(view, path, forward, alphaFunction); } } /// /// Animates the view's position and orientation through a predefined path.
/// The view will rotate to orient the supplied forward vector with the path's tangent.
/// If forward is the zero vector then no rotation will happen.
///
/// The view to animate. /// It defines position and orientation. /// The vector (in local space coordinate system) will be oriented with the path's tangent direction. /// The start time of the animation. /// The end time of the animation. /// The alpha function to apply. /// 3 public void AnimatePath(View view, Path path, Vector3 forward, int startTime, int endTime, AlphaFunction alphaFunction = null) { TimePeriod time = new TimePeriod(MilliSecondsToSeconds(startTime), MilliSecondsToSeconds(endTime - startTime)); if (alphaFunction == null) { Animate(view, path, forward, time); } else { Animate(view, path, forward, alphaFunction, time); } time.Dispose(); } /// /// Creates an initialized animation.
/// The animation will not loop.
/// The default end action is "Cancel".
/// The default alpha function is linear.
///
/// 3 public Animation() : this(Interop.Animation.New(0.0f), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Plays the animation. /// /// 3 public void Play() { Interop.Animation.Play(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); if (DisableAnimation == true) Stop(EndActions.StopFinal); } /// /// Plays the animation from a given point.
/// The progress must be in the 0-1 interval or in the play range interval if defined, /// otherwise, it will be ignored.
///
/// A value between [0,1], or between the play range if specified, from where the animation should start playing. /// 3 public void PlayFrom(float progress) { Interop.Animation.PlayFrom(SwigCPtr, progress); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Plays the animation after a given delay time.
/// The delay time is not included in the looping time.
/// When the delay time is a negative value, it would treat as play immediately.
///
/// The delay time. /// 4 public void PlayAfter(int delayMilliseconds) { Interop.Animation.PlayAfter(SwigCPtr, MilliSecondsToSeconds(delayMilliseconds)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Pauses the animation. /// /// 3 public void Pause() { Interop.Animation.Pause(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Stops the animation. /// /// 3 public void Stop() { Interop.Animation.Stop(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// Clears the animation.
/// This disconnects any objects that were being animated, effectively stopping the animation.
///
/// 3 public void Clear() { Interop.Animation.Clear(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Animation obj) { return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.SwigCPtr; } internal object ConvertTo(object value, Type toType) { Func getConverter = () => { string converterTypeName = GetTypeConverterTypeName(toType.GetTypeInfo().CustomAttributes); if (converterTypeName == null) return null; Type convertertype = Type.GetType(converterTypeName); return Activator.CreateInstance(convertertype); }; return ConvertTo(value, toType, getConverter); } internal object ConvertTo(object value, Type toType, Func getConverter) { if (value == null) return null; var str = value as string; if (str != null) { //If there's a [TypeConverter], use it object converter = getConverter?.Invoke(); var xfTypeConverter = converter as Tizen.NUI.Binding.TypeConverter; if (xfTypeConverter != null) return value = xfTypeConverter.ConvertFromInvariantString(str); var converterType = converter?.GetType(); if (converterType != null) { var convertFromStringInvariant = converterType.GetRuntimeMethod("ConvertFromInvariantString", new[] { typeof(string) }); if (convertFromStringInvariant != null) return value = convertFromStringInvariant.Invoke(converter, new object[] { str }); } //If the type is nullable, as the value is not null, it's safe to assume we want the built-in conversion if (toType.GetTypeInfo().IsGenericType && toType.GetGenericTypeDefinition() == typeof(Nullable<>)) toType = Nullable.GetUnderlyingType(toType); //Obvious Built-in conversions if (toType.GetTypeInfo().IsEnum) return Enum.Parse(toType, str, true); if (toType == typeof(SByte)) return SByte.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(Int16)) return Int16.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(Int32)) return Int32.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(Int64)) return Int64.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(Byte)) return Byte.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(UInt16)) return UInt16.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(UInt32)) return UInt32.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(UInt64)) return UInt64.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(Single)) return Single.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(Double)) return Double.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(Boolean)) return Boolean.Parse(str); if (toType == typeof(TimeSpan)) return TimeSpan.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(DateTime)) return DateTime.Parse(str, CultureInfo.InvariantCulture); if (toType == typeof(Char)) { char c = '\0'; _ = Char.TryParse(str, out c); return c; } if (toType == typeof(String) && str.StartsWith("{}", StringComparison.Ordinal)) return str.Substring(2); if (toType == typeof(String)) return value; if (toType == typeof(Decimal)) return Decimal.Parse(str, CultureInfo.InvariantCulture); } //if the value is not assignable and there's an implicit conversion, convert if (value != null && !toType.IsAssignableFrom(value.GetType())) { var opImplicit = GetImplicitConversionOperator(value.GetType(), value.GetType(), toType) ?? GetImplicitConversionOperator(toType, value.GetType(), toType); //var opImplicit = value.GetType().GetImplicitConversionOperator(fromType: value.GetType(), toType: toType) // ?? toType.GetImplicitConversionOperator(fromType: value.GetType(), toType: toType); if (opImplicit != null) { value = opImplicit.Invoke(null, new[] { value }); return value; } } return value; } internal string GetTypeConverterTypeName(IEnumerable attributes) { var converterAttribute = attributes.FirstOrDefault(cad => Tizen.NUI.Binding.TypeConverterAttribute.TypeConvertersType.Contains(cad.AttributeType.FullName)); if (converterAttribute == null) return null; if (converterAttribute.ConstructorArguments[0].ArgumentType == typeof(string)) return (string)converterAttribute.ConstructorArguments[0].Value; if (converterAttribute.ConstructorArguments[0].ArgumentType == typeof(Type)) return ((Type)converterAttribute.ConstructorArguments[0].Value).AssemblyQualifiedName; return null; } internal MethodInfo GetImplicitConversionOperator(Type onType, Type fromType, Type toType) { #if NETSTANDARD1_0 var mi = onType.GetRuntimeMethod("op_Implicit", new[] { fromType }); #else var bindingFlags = BindingFlags.Public | BindingFlags.Static | BindingFlags.FlattenHierarchy; var mi = onType.GetMethod("op_Implicit", bindingFlags, null, new[] { fromType }, null); #endif if (mi == null) return null; if (!mi.IsSpecialName) return null; if (!mi.IsPublic) return null; if (!mi.IsStatic) return null; if (!toType.IsAssignableFrom(mi.ReturnType)) return null; return mi; } internal Animation(float durationSeconds) : this(Interop.Animation.New(durationSeconds), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal Animation(Animation handle) : this(Interop.Animation.NewAnimation(Animation.getCPtr(handle)), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal Animation Assign(Animation rhs) { Animation ret = new Animation(Interop.Animation.Assign(SwigCPtr, Animation.getCPtr(rhs)), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void SetDuration(float seconds) { Interop.Animation.SetDuration(SwigCPtr, seconds); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal float GetDuration() { float ret = Interop.Animation.GetDuration(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void SetLooping(bool looping) { Interop.Animation.SetLooping(SwigCPtr, looping); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void SetLoopCount(int count) { Interop.Animation.SetLoopCount(SwigCPtr, count); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal int GetLoopCount() { int ret = Interop.Animation.GetLoopCount(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal int GetCurrentLoop() { int ret = Interop.Animation.GetCurrentLoop(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal bool IsLooping() { bool ret = Interop.Animation.IsLooping(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void SetEndAction(Animation.EndActions action) { Interop.Animation.SetEndAction(SwigCPtr, (int)action); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal Animation.EndActions GetEndAction() { Animation.EndActions ret = (Animation.EndActions)Interop.Animation.GetEndAction(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void SetDisconnectAction(Animation.EndActions disconnectAction) { Interop.Animation.SetDisconnectAction(SwigCPtr, (int)disconnectAction); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal Animation.EndActions GetDisconnectAction() { Animation.EndActions ret = (Animation.EndActions)Interop.Animation.GetDisconnectAction(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void SetDefaultAlphaFunction(AlphaFunction alpha) { Interop.Animation.SetDefaultAlphaFunction(SwigCPtr, AlphaFunction.getCPtr(alpha)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal AlphaFunction GetDefaultAlphaFunction() { AlphaFunction ret = new AlphaFunction(Interop.Animation.GetDefaultAlphaFunction(SwigCPtr), true); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void SetCurrentProgress(float progress) { Interop.Animation.SetCurrentProgress(SwigCPtr, progress); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal float GetCurrentProgress() { float ret = Interop.Animation.GetCurrentProgress(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void SetSpeedFactor(float factor) { Interop.Animation.SetSpeedFactor(SwigCPtr, factor); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal float GetSpeedFactor() { float ret = Interop.Animation.GetSpeedFactor(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void SetPlayRange(Vector2 range) { Interop.Animation.SetPlayRange(SwigCPtr, Vector2.getCPtr(range)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal Vector2 GetPlayRange() { Vector2 ret = new Vector2(Interop.Animation.GetPlayRange(SwigCPtr), true); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal Animation.States GetState() { Animation.States ret = (Animation.States)Interop.Animation.GetState(SwigCPtr); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal AnimationSignal FinishedSignal() { AnimationSignal ret = new AnimationSignal(Interop.Animation.FinishedSignal(SwigCPtr), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal AnimationSignal ProgressReachedSignal() { AnimationSignal ret = new AnimationSignal(Interop.Animation.ProgressReachedSignal(SwigCPtr), false); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); return ret; } internal void AnimateBy(Property target, PropertyValue relativeValue, AlphaFunction alpha) { if (alpha == null) { Interop.Animation.AnimateBy(SwigCPtr, Property.getCPtr(target), PropertyValue.getCPtr(relativeValue)); } else { Interop.Animation.AnimateByAlphaFunction(SwigCPtr, Property.getCPtr(target), PropertyValue.getCPtr(relativeValue), AlphaFunction.getCPtr(alpha)); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateBy(Property target, PropertyValue relativeValue, AlphaFunction alpha, TimePeriod period) { if (alpha == null) { Interop.Animation.AnimateByTimePeriod(SwigCPtr, Property.getCPtr(target), PropertyValue.getCPtr(relativeValue), TimePeriod.getCPtr(period)); } else { Interop.Animation.AnimateBy(SwigCPtr, Property.getCPtr(target), PropertyValue.getCPtr(relativeValue), AlphaFunction.getCPtr(alpha), TimePeriod.getCPtr(period)); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateTo(Property target, PropertyValue destinationValue, AlphaFunction alpha) { if (alpha == null) { Interop.Animation.AnimateTo(SwigCPtr, Property.getCPtr(target), PropertyValue.getCPtr(destinationValue)); } else { Interop.Animation.AnimateToAlphaFunction(SwigCPtr, Property.getCPtr(target), PropertyValue.getCPtr(destinationValue), AlphaFunction.getCPtr(alpha)); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateTo(Property target, PropertyValue destinationValue, AlphaFunction alpha, TimePeriod period) { if (alpha == null) { Interop.Animation.AnimateToTimePeriod(SwigCPtr, Property.getCPtr(target), PropertyValue.getCPtr(destinationValue), TimePeriod.getCPtr(period)); } else { Interop.Animation.AnimateTo(SwigCPtr, Property.getCPtr(target), PropertyValue.getCPtr(destinationValue), AlphaFunction.getCPtr(alpha), TimePeriod.getCPtr(period)); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateBetween(Property target, KeyFrames keyFrames) { Interop.Animation.AnimateBetween(SwigCPtr, Property.getCPtr(target), KeyFrames.getCPtr(keyFrames)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateBetween(Property target, KeyFrames keyFrames, AlphaFunction alpha) { Interop.Animation.AnimateBetweenAlphaFunction(SwigCPtr, Property.getCPtr(target), KeyFrames.getCPtr(keyFrames), AlphaFunction.getCPtr(alpha)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateBetween(Property target, KeyFrames keyFrames, AlphaFunction alpha, Animation.Interpolation interpolation) { if (alpha == null) { Interop.Animation.AnimateBetween(SwigCPtr, Property.getCPtr(target), KeyFrames.getCPtr(keyFrames), (int)interpolation); } else { Interop.Animation.AnimateBetweenAlphaFunctionInterpolation(SwigCPtr, Property.getCPtr(target), KeyFrames.getCPtr(keyFrames), AlphaFunction.getCPtr(alpha), (int)interpolation); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateBetween(Property target, KeyFrames keyFrames, TimePeriod period) { Interop.Animation.AnimateBetweenTimePeriod(SwigCPtr, Property.getCPtr(target), KeyFrames.getCPtr(keyFrames), TimePeriod.getCPtr(period)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateBetween(Property target, KeyFrames keyFrames, AlphaFunction alpha, TimePeriod period) { Interop.Animation.AnimateBetween(SwigCPtr, Property.getCPtr(target), KeyFrames.getCPtr(keyFrames), AlphaFunction.getCPtr(alpha), TimePeriod.getCPtr(period)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void AnimateBetween(Property target, KeyFrames keyFrames, AlphaFunction alpha, TimePeriod period, Animation.Interpolation interpolation) { if (alpha == null) { Interop.Animation.AnimateBetweenTimePeriodInterpolation(SwigCPtr, Property.getCPtr(target), KeyFrames.getCPtr(keyFrames), TimePeriod.getCPtr(period), (int)interpolation); } else { Interop.Animation.AnimateBetween(SwigCPtr, Property.getCPtr(target), KeyFrames.getCPtr(keyFrames), AlphaFunction.getCPtr(alpha), TimePeriod.getCPtr(period), (int)interpolation); } if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void Animate(View view, Path path, Vector3 forward) { Interop.Animation.Animate(SwigCPtr, View.getCPtr(view), Path.getCPtr(path), Vector3.getCPtr(forward)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void Animate(View view, Path path, Vector3 forward, AlphaFunction alpha) { Interop.Animation.AnimateAlphaFunction(SwigCPtr, View.getCPtr(view), Path.getCPtr(path), Vector3.getCPtr(forward), AlphaFunction.getCPtr(alpha)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void Animate(View view, Path path, Vector3 forward, TimePeriod period) { Interop.Animation.AnimateTimePeriod(SwigCPtr, View.getCPtr(view), Path.getCPtr(path), Vector3.getCPtr(forward), TimePeriod.getCPtr(period)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void Animate(View view, Path path, Vector3 forward, AlphaFunction alpha, TimePeriod period) { Interop.Animation.Animate(SwigCPtr, View.getCPtr(view), Path.getCPtr(path), Vector3.getCPtr(forward), AlphaFunction.getCPtr(alpha), TimePeriod.getCPtr(period)); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void Show(View view, float delaySeconds) { Interop.Animation.Show(SwigCPtr, View.getCPtr(view), delaySeconds); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } internal void Hide(View view, float delaySeconds) { Interop.Animation.Hide(SwigCPtr, View.getCPtr(view), delaySeconds); if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } /// /// To make animation instance be disposed. /// /// 3 protected override void Dispose(DisposeTypes type) { if (disposed) { return; } if (_animationFinishedEventHandler != null) { AnimationSignal finishedSignal = FinishedSignal(); finishedSignal?.Disconnect(_finishedCallbackOfNative); finishedSignal?.Dispose(); _animationFinishedEventHandler = null; } if (_animationProgressReachedEventCallback != null) { AnimationSignal progressReachedSignal = ProgressReachedSignal(); progressReachedSignal?.Disconnect(_animationProgressReachedEventCallback); progressReachedSignal?.Dispose(); _animationProgressReachedEventCallback = null; } base.Dispose(type); } /// This will not be public opened. [EditorBrowsable(EditorBrowsableState.Never)] protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr) { if (swigCPtr.Handle == IntPtr.Zero || this.HasBody() == false) { Tizen.Log.Fatal("NUI", $"[ERROR] Animation ReleaseSwigCPtr()! IntPtr=0x{swigCPtr.Handle:X} HasBody={this.HasBody()}"); return; } Interop.Animation.DeleteAnimation(swigCPtr); } private void OnFinished(IntPtr data) { if (_animationFinishedEventHandler != null) { //here we send all data to user event handlers _animationFinishedEventHandler(this, null); } } private void OnProgressReached(IntPtr data) { if (_animationProgressReachedEventHandler != null) { //here we send all data to user event handlers _animationProgressReachedEventHandler(this, null); } } private float MilliSecondsToSeconds(int millisec) { return (float)millisec / 1000.0f; } private int SecondsToMilliSeconds(float sec) { return (int)(sec * 1000); } } }