Duality-BackgroundScroller-Example/Plugins/AnimationPlugin.core.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AnimationPlugin.core</name>
    </assembly>
    <members>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimBuilder">
            <summary>
                Use this class to build the animation in your AnimResources. Supports fluent syntax.
            </summary>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.AnimBuilder.Start">
            <summary>
                Starting point of the animation chain.
            </summary>
            <returns></returns>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.AnimBuilder.Add(MFEP.Duality.Plugins.Animation.IAnimPiece,System.Single)">
            <summary>
                Adds a single AnimPiece to the animation chain.
            </summary>
            <param name="piece">The IAnimPiece to add.</param>
            <param name="time">The time (seconds) this AnimPiece takes to finish.</param>
            <returns></returns>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.AnimBuilder.Add(MFEP.Duality.Plugins.Animation.IAnimPiece[],System.Single)">
            <summary>
                Adds an array of AnimPieces that will play simultaneously.
            </summary>
            <param name="pieces"></param>
            <param name="time">Time (seconds) these pieces will take to finish.</param>
            <returns></returns>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimationPlayer">
            <summary>
                Loads and plays AnimResources on the GameObject. Manages the animation's state, and provides interface to control
                it (Play, Pause, Stop).
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimationPlayer.Percent">
            <summary>
                The current animation progress. Between 0 and 1. Readonly for now.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimationPlayer.Animation">
            <summary>
                The AnimResource that is played.
                Default is null
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimationPlayer.AutoPlay">
            <summary>
                Wheter the animation starts at staring the game/sandbox.
                Default is false
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimationPlayer.Looping">
            <summary>
                Wheter the animation starts from the beginning when reached its end.
                Default is false
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimationPlayer.PlaybackRate">
            <summary>
                The relative speed the animation is playing back.
                Default is 1f
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimationPlayer.PlaybackLength">
            <summary>
                The original length of the AnimResource multiplied by PlaybackRate
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimationPlayer.IsPlaying">
            <summary>
                Wheter the animation is currently playing or is stopped. Settable.
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.EllipseMovement">
            <summary>
                Moves the gameObject on an elliptical arc. This path can be a circle/ellipse/circular arc depending on the
                parameters.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.EllipseMovement.RadiusX">
            <summary>
                The size of the path ellipse on the X axis.
                Default is 200f
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.EllipseMovement.RadiusXGen">
            <summary>
                RadiusX's multiplier function.
                Default is Const1
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.EllipseMovement.RadiusY">
            <summary>
                The size of the path ellipse on the Y axis.
                Default is 200f
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.EllipseMovement.RadiusYGen">
            <summary>
                RadiusY's multiplier function.
                Default is Const1
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.EllipseMovement.StartPhase">
            <summary>
                The starting phase angle on the path in radians. Determines the starting point on the arc. 0 means the most right
                point, Pi/2 is the bottom one, and so along.
                Default is 0f
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.EllipseMovement.EndPhase">
            <summary>
                The ending phase angle on the path in radians.
                Default is 0f
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.EllipseMovement.Relative">
            <summary>
                Wheter the movement is combineable with other movement. Even if false, the movement takes place in local space.
                Default is true
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.CallbackProvider">
            <summary>
                Use this AnimPiece to implement custom behaviour in the AnimResource.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.CallbackProvider.Callback">
            <summary>
                This function is going to be called at every update, getting the current AnimPercent and the AnimationPlayer
                GameObject as argument.
                Default does nothing.
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.CustomComponentUpdate">
            <summary>
                This AnimPiece invokes the AnimTickCallback function on every Component which implements ICmpAnimUpdatable on the
                AnimationPlayer's GameObject.
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.LerpNoiseMovement">
            <summary>
                Implements random movement based on a simple noise algorithm. The Direction attribute controls the direction of the
                movement.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.LerpNoiseMovement.Direction">
            <summary>
                Controls the direction of the random movement. Its length is indifferent, will be normalized.
                Default is Vector2.UnitX
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.LerpNoiseMovement.Frequency">
            <summary>
                The frequency of the direction changes.
                Default is 10f
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.LerpNoiseMovement.FrequencyGen">
            <summary>
                real_frequency := Frequency * FreqencyGen (currentAnimPercent)
                Default is Const1
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.LerpNoiseMovement.Amplitude">
            <summary>
                The noise amplitude, the strength of this effect.
                Default is 100f
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.LerpNoiseMovement.AmplitudeGen">
            <summary>
                real_Amplitude := Amplitude * AmplitudeGen (currentAnimPercent)
                Default is ExponentialDecr
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.LerpNoiseMovement.Relative">
            <summary>
                Wheter the movement is combineable with other movement. Even if false, the movement takes place in local space.
                Default is true
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.Rotate">
            <summary>
                Simple rotating AnimPiece.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.Rotate.Frequency">
            <summary>
                The rotation frequency. 1f means one rotation over the animation.
                Default is 1f
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.Rotate.FrequencyGen">
            <summary>
                The mapping of the angular movement.
                Default value is Unity
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.Rotate.Relative">
            <summary>
                Wheter this Piece's effect overrides all other rotation.
                Default is true
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleColor">
            <summary>
                Simple color interpolating AnimPiece.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleColor.StartColor">
            <summary>
                Color at animation start.
                Default is ColorRgba.Black
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleColor.EndColor">
            <summary>
                Color at animation end.
                Default is ColorRgba.White
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleColor.ColorGen">
            <summary>
                Color interpolating function.
                Default is Unity
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleMovement">
            <summary>
                Move the GameObject on the line between StartPos and EndPos.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleMovement.StartPos">
            <summary>
                Starting position of the animation. Local space.
                Default is Vector2.Zero
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleMovement.EndPos">
            <summary>
                Final position of the animation. Local space.
                Default is Vector2.Zero
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleMovement.PosGen">
            <summary>
                Position interpolation function.
                Default is Unity
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.SimpleMovement.Relative">
            <summary>
                Wheter the movement is combineable with other movement. Even if false, the movement takes place in local space.
                Default is true
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.PathFollowMovement">
            <summary>
                Moves the animated GameObject along a preinitialized path. The path consists of the segments between the
                PathVertices.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.PathFollowMovement.PathVertices">
            <summary>
                MUST BE DECLARED. The local coordinates of the path the animation will follow.
                Default is null
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.PathFollowMovement.ConstantVelocity">
            <summary>
                If set to false, running every segment takes the same time, the segments' length does not count. Otherwise, the
                speeed will be constant.
                Default is true
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.PathFollowMovement.Relative">
            <summary>
                Wheter the movement is combineable with other movement. Even if false, the movement takes place in local space.
                Default is true
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.PathFollowMovement.Closed">
            <summary>
                If set to true, the algorithm automaticallt generates one more segment between the first and last vertex.
                Default is false
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.PathFollowMovement.OverSpeedGen">
            <summary>
                TODO
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.PathFollowMovement.SegmentSpeedGen">
            <summary>
                TODO
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D">
            <summary>
                Provides more advanced controls over the trigonometric functions which move the gameObject. Simpler version is
                EllipseMovement.
                Consists of two trigonometric expression: one in the X, one in the Y direction.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.Frequency">
            <summary>
                The 'speed' of the trigonometric functions in the X and Y directions.
                The frequency of 1 means one period over the animation.
                Default is Vector2.One
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.FreqGenX">
            <summary>
                Frequency multiplier function in the X direction.
                Default is Const1
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.FreqGenY">
            <summary>
                Frequency multiplier function in the Y direction.
                Default is Const1
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.Amplitude">
            <summary>
                The magnitude of the movement in X and Y direction.
                Default is Vector2 (200f, 200f)
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.AmpGenX">
            <summary>
                Amplitude multiplier function in the X direction.
                Default is Const1
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.AmpGenY">
            <summary>
                Amplitude multiplier function in the Y direction.
                Default is Const1
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.Phase">
            <summary>
                The phase of the trigonometric expression in X and Y direction.
                Default is Vector2.Zero
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.PhaseGenX">
            <summary>
                Phase multiplier function in the X direction.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.PhaseGenY">
            <summary>
                Phase multiplier function in the Y direction.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.AnimPieces.TrigonometricMovement2D.Relative">
            <summary>
                Wheter the movement is combineable with other movement. Even if false, the movement takes place in local space.
                Default is true
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimPieces.Wait">
            <summary>
                Does not do anything during the animation. Useful to introduce waiting times between two animation blocks.
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.Extras.AnimControllerComp">
            <summary>
                Can control the animation state of the attached GameObject's AnimationPlayer.
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.Extras.PathVisualizer">
            <summary>
                Draws a line that connects the GameObject's positions in the last n frame.
                Beware! Not very effective.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Extras.PathVisualizer.Color">
            <summary>
                Color of the line drawn.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Extras.PathVisualizer.FollowedFrames">
            <summary>
                How many frames' positions should connect. Don't set this too high.
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.IAnimPiece">
            <summary>
                Building block of the animations.
                Initialize runs at the start of the animation.
                Tick runs at every update.
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.AnimResource">
            <summary>
                Inherit from this class when creating custom AnimResources. Have to implement the InitializePieces method.
            </summary>
        </member>
        <member name="T:MFEP.Duality.Plugins.Animation.ProceduralAnimationCorePlugin">
            <summary>
                Defines a Duality core plugin.
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Utils.Const1">
            <summary>
                f(x) = 1
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Utils.Unity">
            <summary>
                f(x) = x
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Utils.SmoothStep">
            <summary>
                f(x) = 3x^2 - 2x^3
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Utils.SimpleSin">
            <summary>
                f(x) = sin(2πx)
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Utils.SimpleCos">
            <summary>
                f(x) = cos(2πx)
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Utils.AbsSin">
            <summary>
                f(x) = |sin(2πx)|
            </summary>
        </member>
        <member name="P:MFEP.Duality.Plugins.Animation.Utils.AbsCos">
            <summary>
                f(x) = |cos(2πx)|
            </summary>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.Utils.Const(System.Single)">
            <summary>
                f(x) = c
            </summary>
            <param name="constValue">c</param>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.Utils.Linear(System.Single,System.Single)">
            <summary>
                f(x) = ax + b
            </summary>
            <param name="multiplier">a</param>
            <param name="offset">b</param>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.Utils.Polinomial(System.Single)">
            <summary>
                f(x) = x^n
            </summary>
            <param name="exponent">n</param>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.Utils.ExponentialGrow(System.Single)">
            <summary>
                f(x) = (e^(sx) - 1) / (e^s - 1)
            </summary>
            <param name="slope">s</param>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.Utils.ExponentialDecr(System.Single)">
            <summary>
                f(x) = - (e^(sx) - 1) / (e^s - 1) + 1
            </summary>
            <param name="slope">s</param>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.Utils.Sin(System.Single,System.Single,System.Single,System.Single)">
            <summary>
                f(x) = sin(2πfx + φ) + c
            </summary>
            <param name="freq">f</param>
            <param name="amp">A</param>
            <param name="phase">φ</param>
            <param name="offset">c</param>
        </member>
        <member name="M:MFEP.Duality.Plugins.Animation.Utils.Cos(System.Single,System.Single,System.Single,System.Single)">
            <summary>
                f(x) = cos(2πfx + φ) + c
            </summary>
            <param name="freq">f</param>
            <param name="amp">A</param>
            <param name="phase">φ</param>
            <param name="offset">c</param>
        </member>
    </members>
</doc>