Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
Sine

Package | spark.effects.easing
Class | public class Sine
Inheritance | Sine EaseInOutBase Object

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The Sine class defines easing functionality using a Sine function. Easing consists of two phases: the acceleration, or ease in phase, followed by the deceleration, or ease out phase. Use the `easeInFraction` property to specify the percentage of an animation accelerating.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<s:Sine>` tag inherits all of the tag attributes of its of its superclass, and adds the following tag attributes:

      <s:Sine
        id="ID"
       />

View the examples

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | easeInFraction : Number The percentage of an animation that should be spent accelerating. | EaseInOutBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Sine(easeInFraction:Number = 0.5) Constructor. | Sine
|  | ease(fraction:Number):Number Takes the fraction representing the elapsed duration of an animation (a value between 0.0 to 1.0) and returns a new elapsed value. | EaseInOutBase

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | easeIn(fraction:Number):Number Returns a value that represents the eased fraction during the ease in phase of the animation. | EaseInOutBase
|  | easeOut(fraction:Number):Number Returns a value that represents the eased fraction during the ease out phase of the animation. | EaseInOutBase

Constructor Detail

Sine | () | Constructor

`public function Sine(easeInFraction:Number = 0.5)`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `easeInFraction:Number` (default = `0.5`)`` — Sets the value of the `easeInFraction` property. The default value is `EasingFraction.IN_OUT`, which eases in for the first half of the time and eases out for the remainder.

Examples
SinePowerEffectExample.mxml

    <?xml version="1.0"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You 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.

    -->
    <!-- Simple example to demonstrate the s:Sine and s:Power classes. -->
    <s:Application
        xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:mx="library://ns.adobe.com/flex/mx"
        xmlns:s="library://ns.adobe.com/flex/spark">

        <fx:Declarations>
            <s:Sine id="sineEasing"
                easeInFraction="0.3"/>
            <s:Power id="powerEasing"
                exponent="4"/>
            <s:Move id="moveRight"
                target="{myImage}"
                xBy="500"
                duration="2000"
                easer="{powerEasing}"/>
            <s:Move id="moveLeft"
                target="{myImage}"
                xBy="-500"
                duration="2000"
                easer="{sineEasing}"/>
        </fx:Declarations>

        <s:Panel id="examplePanel"
            title="Sine and Power Effect Example"
            width="75%" height="75%">

            <!-- Directions -->
            <s:VGroup id="detailsBox" width="50%" top="5" left="5">
                <s:Label width="99%" color="blue"
                    text="Click the buttons to watch the effect."/>
            </s:VGroup>

            <mx:Image id="myImage" top="20"
                source="@Embed(source='assets/logo.jpg')"/>

            <s:Button label="Move Right"
                 bottom="10" left="5"
                click="moveRight.end();moveRight.play();"/>

            <s:Button label="Move Left"
                bottom="10" left="100"
                click="moveLeft.end();moveLeft.play();"/>
        </s:Panel>
    </s:Application>

Wed Nov 15 2017, 09:50 AM +01:00