src/Tizen.NUI/src/public/KeyFrames.cs

   1 /*
   2  * Copyright(c) 2017 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 using System;
  19 using System.ComponentModel;
  20
  21 namespace Tizen.NUI
  22 {
  23
  24     /// <summary>
  25     /// A set of key frames for a property that can be animated using DALi animation.<br />
  26     /// This allows the generation of key frame objects from individual Property::Values.<br />
  27     /// </summary>
  28     /// <since_tizen> 3 </since_tizen>
  29     public class KeyFrames : BaseHandle
  30     {
  31         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  32
  33         internal KeyFrames(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.KeyFrames_SWIGUpcast(cPtr), cMemoryOwn)
  34         {
  35             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  36         }
  37
  38         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(KeyFrames obj)
  39         {
  40             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  41         }
  42
  43         /// <summary>
  44         /// Dispose.
  45         /// </summary>
  46         /// <since_tizen> 3 </since_tizen>
  47         protected override void Dispose(DisposeTypes type)
  48         {
  49             if(disposed)
  50             {
  51                 return;
  52             }
  53
  54             if(type == DisposeTypes.Explicit)
  55             {
  56                 //Called by User
  57                 //Release your own managed resources here.
  58                 //You should release all of your own disposable objects here.
  59             }
  60
  61             //Release your own unmanaged resources here.
  62             //You should not access any managed member here except static instance.
  63             //because the execution order of Finalizes is non-deterministic.
  64
  65             if (swigCPtr.Handle != global::System.IntPtr.Zero)
  66             {
  67                 if (swigCMemOwn)
  68                 {
  69                     swigCMemOwn = false;
  70                     NDalicPINVOKE.delete_KeyFrames(swigCPtr);
  71                 }
  72                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
  73             }
  74
  75             base.Dispose(type);
  76         }
  77
  78
  79
  80         /// <summary>
  81         /// Adds a key frame.
  82         /// </summary>
  83         /// <param name="progress">A progress value between 0.0 and 1.0.</param>
  84         /// <param name="value">A value.</param>
  85         /// <since_tizen> 3 </since_tizen>
  86         public void Add(float progress, object value)
  87         {
  88             PropertyValue val = PropertyValue.CreateFromObject(value);
  89             Add(progress, val);
  90         }
  91
  92         /// <summary>
  93         /// Adds a key frame.
  94         /// </summary>
  95         /// <param name="progress">A progress value between 0.0 and 1.0.</param>
  96         /// <param name="value">A value</param>
  97         /// <param name="alpha">The alpha function used to blend to the next keyframe.</param>
  98         /// <since_tizen> 3 </since_tizen>
  99         public void Add(float progress, object value, AlphaFunction alpha)
 100         {
 101             PropertyValue val = PropertyValue.CreateFromObject(value);
 102             Add(progress, val, alpha);
 103         }
 104
 105         /// <summary>
 106         /// Creates an initialized KeyFrames handle.
 107         /// </summary>
 108         /// <since_tizen> 3 </since_tizen>
 109         public KeyFrames() : this(NDalicPINVOKE.KeyFrames_New(), true)
 110         {
 111             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 112
 113         }
 114
 115         /// <summary>
 116         /// Downcasts a handle to keyFrame handle.
 117         /// </summary>
 118         /// <since_tizen> 3 </since_tizen>
 119         /// Please do not use! this will be deprecated!
 120         /// Instead please use as keyword.
 121         [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")]
 122         [EditorBrowsable(EditorBrowsableState.Never)]
 123         public static KeyFrames DownCast(BaseHandle handle)
 124         {
 125             KeyFrames ret =  Registry.GetManagedBaseHandleFromNativePtr(handle) as KeyFrames;
 126             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 127             return ret;
 128         }
 129
 130         /// <summary>
 131         /// Gets the type of the key frame.
 132         /// </summary>
 133         /// <returns>The key frame property type</returns>
 134         /// <since_tizen> 3 </since_tizen>
 135         public new PropertyType GetType()
 136         {
 137             PropertyType ret = (PropertyType)NDalicPINVOKE.KeyFrames_GetType(swigCPtr);
 138             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 139             return ret;
 140         }
 141
 142         /// <summary>
 143         /// Adds a key frame.
 144         /// </summary>
 145         /// <param name="progress">A progress value between 0.0 and 1.0.</param>
 146         /// <param name="value">A value.</param>
 147         /// <since_tizen> 3 </since_tizen>
 148         public void Add(float progress, PropertyValue value)
 149         {
 150             NDalicPINVOKE.KeyFrames_Add__SWIG_0(swigCPtr, progress, PropertyValue.getCPtr(value));
 151             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 152         }
 153
 154         /// <summary>
 155         /// Adds a key frame.
 156         /// </summary>
 157         /// <param name="progress">A progress value between 0.0 and 1.0.</param>
 158         /// <param name="value">A value.</param>
 159         /// <param name="alpha">The alpha function used to blend to the next keyframe.</param>
 160         /// <since_tizen> 3 </since_tizen>
 161         public void Add(float progress, PropertyValue value, AlphaFunction alpha)
 162         {
 163             NDalicPINVOKE.KeyFrames_Add__SWIG_1(swigCPtr, progress, PropertyValue.getCPtr(value), AlphaFunction.getCPtr(alpha));
 164             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 165         }
 166
 167     }
 168
 169 }