AnimateWidget Interface Reference

Inheritance diagram for AnimateWidget:

Public Member Functions
void	UpdateAnimations (float timeSlice)
void	AnimateWidget ()

Static Public Member Functions
static AnimateWidget	GetInstance ()
static bool	StopAnimation (Widget w, TypeName typeName)
	Stop either all animations on the widget, or an animation of a specific type.
static bool	StopAnimation (WidgetAnimationBase anim)
	Stop animation.
static void	StopAllAnimations (Widget w)
	Stop all animation on given widget.
static bool	IsAnimating (Widget w)
static bool	IsAnimatingType (Widget w, TypeName type)
static WidgetAnimationBase	GetAnimation (Widget w, TypeName type)
static bool	IsActive ()
	Is.
static bool	AddAnimation (notnull WidgetAnimationBase animation)
static WidgetAnimationBlurIntensity	BlurIntensity (Widget widget, float targetValue, float speed)
static WidgetAnimationOpacity	Opacity (Widget widget, float targetValue, float speed, bool toggleVisibility=false)
static WidgetAnimationImageSaturation	Saturation (Widget widget, float targetValue, float speed)
static WidgetAnimationAlphaMask	AlphaMask (Widget widget, float targetValue, float speed)
static WidgetAnimationColor	Color (Widget widget, Color color, float speed)
static WidgetAnimationFrameSize	Size (Widget widget, float size[2], float speed)
static WidgetAnimationPosition	Position (Widget widget, float position[2], float speed)
static WidgetAnimationPadding	Padding (Widget widget, float padding[4], float speed)
static WidgetAnimationLayoutFill	LayoutFill (Widget widget, float targetValue, float speed)
static WidgetAnimationImageRotation	Rotation (Widget widget, float targetValue, float speed)
static WidgetAnimationValue	Value (float defaultValue, float targetValue, float speed)

Public Attributes
ref ScriptInvoker	m_OnAnimatingStarted = new ScriptInvoker()
ref ScriptInvoker	m_OnAnimatingCompleted = new ScriptInvoker()

Static Protected Member Functions
static bool	PrepareAnimation (Widget w, float speed, TypeName typeName)
	Make sure that animation can be played, and animator is ready to run it.

Protected Attributes
ref array< ref WidgetAnimationBase >	m_aAnimations = {}

Static Protected Attributes
static AnimateWidget	s_Instance

Constructor & Destructor Documentation

AnimateWidget()

void AnimateWidget.AnimateWidget

(

)

Member Function Documentation

AddAnimation()

static bool AnimateWidget.AddAnimation ( notnull WidgetAnimationBase animation )

static

AlphaMask()

static WidgetAnimationAlphaMask AnimateWidget.AlphaMask ( Widget widget, float targetValue, float speed )

static

BlurIntensity()

static WidgetAnimationBlurIntensity AnimateWidget.BlurIntensity ( Widget widget, float targetValue, float speed )

static

Color()

static WidgetAnimationColor AnimateWidget.Color ( Widget widget, Color color, float speed )

static

GetAnimation()

static WidgetAnimationBase AnimateWidget.GetAnimation ( Widget w, TypeName type )

static

GetInstance()

static AnimateWidget AnimateWidget.GetInstance ( )

staticsealed

IsActive()

static bool AnimateWidget.IsActive ( )

static

Is.

IsAnimating()

static bool AnimateWidget.IsAnimating ( Widget w )

static

IsAnimatingType()

static bool AnimateWidget.IsAnimatingType ( Widget w, TypeName type )

static

LayoutFill()

static WidgetAnimationLayoutFill AnimateWidget.LayoutFill ( Widget widget, float targetValue, float speed )

static

Opacity()

static WidgetAnimationOpacity AnimateWidget.Opacity ( Widget widget, float targetValue, float speed, bool toggleVisibility = false )

static

Padding()

static WidgetAnimationPadding AnimateWidget.Padding ( Widget widget, float padding[4], float speed )

static

Position()

static WidgetAnimationPosition AnimateWidget.Position ( Widget widget, float position[2], float speed )

static

PrepareAnimation()

static bool AnimateWidget.PrepareAnimation ( Widget w, float speed, TypeName typeName )

staticprotected

Make sure that animation can be played, and animator is ready to run it.

Rotation()

static WidgetAnimationImageRotation AnimateWidget.Rotation ( Widget widget, float targetValue, float speed )

static

Saturation()

static WidgetAnimationImageSaturation AnimateWidget.Saturation ( Widget widget, float targetValue, float speed )

static

Size()

static WidgetAnimationFrameSize AnimateWidget.Size ( Widget widget, float size[2], float speed )

static

StopAllAnimations()

static void AnimateWidget.StopAllAnimations ( Widget w )

static

Stop all animation on given widget.

Parameters

w	Target widget

StopAnimation() [1/2]

static bool AnimateWidget.StopAnimation ( Widget w, TypeName typeName )

static

Stop either all animations on the widget, or an animation of a specific type.

StopAnimation() [2/2]

static bool AnimateWidget.StopAnimation ( WidgetAnimationBase anim )

static

Stop animation.

Parameters

anim	Animation class

Returns

True if the animation was removed

UpdateAnimations()

void AnimateWidget.UpdateAnimations

(

float

timeSlice

)

Value()

static WidgetAnimationValue AnimateWidget.Value ( float defaultValue, float targetValue, float speed )

static

Member Data Documentation

m_aAnimations

ref array<ref WidgetAnimationBase> AnimateWidget.m_aAnimations = {}

protected

m_OnAnimatingCompleted

ref ScriptInvoker AnimateWidget.m_OnAnimatingCompleted = new ScriptInvoker()

m_OnAnimatingStarted

ref ScriptInvoker AnimateWidget.m_OnAnimatingStarted = new ScriptInvoker()

s_Instance

AnimateWidget AnimateWidget.s_Instance

staticprotected

---

The documentation for this interface was generated from the following file:

• GameLib/AnimateWidget.c