Click or drag to resize

Shake2D Class

An object that can shake a Vector2 over time.
Inheritance Hierarchy
SystemObject
  Archon.SwissArmyLib.Utils.ShakeBaseShakeVector2
    Archon.SwissArmyLib.Utils.ShakeShake2D

Namespace:  Archon.SwissArmyLib.Utils.Shake
Assembly:  Archon.SwissArmyLib (in Archon.SwissArmyLib.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public class Shake2D : BaseShake<Vector2>
Request Example View Source

The Shake2D type exposes the following members.

Constructors
  NameDescription
Public methodShake2D
Initializes a new instance of the Shake2D class
Top
Properties
  NameDescription
Public propertyAmplitude
Gets the amplitude of the shake.
(Inherited from BaseShakeT.)
Protected propertyCurrentTime
Gets the current scaled or unscaled time.
(Inherited from BaseShakeT.)
Public propertyDuration
Gets how long the shake last.
(Inherited from BaseShakeT.)
Public propertyFrequency
Gets the frequency of the shake.
(Inherited from BaseShakeT.)
Public propertyIsDone
Gets whether the shake is done.
(Inherited from BaseShakeT.)
Public propertyNormalizedTime
Gets the shake's current progress in the range 0 to 1.
(Inherited from BaseShakeT.)
Protected propertyStartTime
Gets or sets the time that the shake started.
(Inherited from BaseShakeT.)
Public propertyUnscaledTime
Gets or sets whether the shake should use time or unscaledTime.
(Inherited from BaseShakeT.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAmplitude
Gets the amplitude at the current time.
(Inherited from BaseShakeT.)
Public methodGetAmplitude(Single)
Gets the amplitude at a specific (normalized) time.
(Overrides BaseShakeTGetAmplitude(Single).)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStart
Starts (or restarts) the shake with new parameters.
(Overrides BaseShakeTStart(Single, Int32, Single).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldHorizontal
The shake used for shaking the x value of the Vector2.
Public fieldVertical
The shake used for shaking the y value of the Vector2.
Top
See Also