SCR_HorizontalScrollAnimationComponent Interface Reference

Inheritance diagram for SCR_HorizontalScrollAnimationComponent:

Public Member Functions
void	AnimationStop ()
void	AnimationStart (bool IsVerticalAnimation=false)
bool	IsAnimating ()
void	ResetPosition ()
	Sets X position to its initial value when component was initialized.
bool	GetContentFitX ()
	Returns true when content fits the parent widget.
bool	GetContentFitY ()
	Returns true when content fits the parent widget.
override void	HandlerDeattached (Widget w)

Static Public Member Functions
static SCR_HorizontalScrollAnimationComponent	FindComponent (notnull Widget w)

Protected Member Functions
void	SetupValues ()
override void	HandlerAttached (Widget w)
void	OnFrame ()
bool	AnimateHorizontalPosition (float tDelta, float speed, float target)
bool	AnimateVerticalPosition (float tDelta, float speed, float target)

Protected Attributes
string	m_sAnimationContentWidget
float	m_fAnimationSpeedPxPerSec
float	m_fWaitTimeLeftSec
float	m_fWaitTimeRightSec
bool	m_bAnimateBack
float	m_fOffsetRight
float	m_fOffsetLeft
SCR_EScrollAnimationState	m_eInitialState
SCR_EScrollAnimationState	m_eState
Widget	m_wContent
Widget	m_wRoot
float	m_fStartPosX
float	m_fStartPosY
float	m_fTimer
float	m_fTargetPosX
float	m_fTargetPosY
bool	m_bIsVerticalAnimation

Member Function Documentation

AnimateHorizontalPosition()

bool SCR_HorizontalScrollAnimationComponent.AnimateHorizontalPosition ( float tDelta, float speed, float target )

protected

AnimateVerticalPosition()

bool SCR_HorizontalScrollAnimationComponent.AnimateVerticalPosition ( float tDelta, float speed, float target )

protected

AnimationStart()

void SCR_HorizontalScrollAnimationComponent.AnimationStart

(

bool

IsVerticalAnimation = false

)

AnimationStop()

void SCR_HorizontalScrollAnimationComponent.AnimationStop

(

)

FindComponent()

static SCR_HorizontalScrollAnimationComponent SCR_HorizontalScrollAnimationComponent.FindComponent ( notnull Widget w )

static

GetContentFitX()

bool SCR_HorizontalScrollAnimationComponent.GetContentFitX

(

)

Returns true when content fits the parent widget.

GetContentFitY()

bool SCR_HorizontalScrollAnimationComponent.GetContentFitY

(

)

Returns true when content fits the parent widget.

HandlerAttached()

override void SCR_HorizontalScrollAnimationComponent.HandlerAttached ( Widget w )

protected

HandlerDeattached()

override void SCR_HorizontalScrollAnimationComponent.HandlerDeattached

(

Widget

w

)

IsAnimating()

bool SCR_HorizontalScrollAnimationComponent.IsAnimating

(

)

OnFrame()

void SCR_HorizontalScrollAnimationComponent.OnFrame ( )

protected

ResetPosition()

void SCR_HorizontalScrollAnimationComponent.ResetPosition

(

)

Sets X position to its initial value when component was initialized.

SetupValues()

void SCR_HorizontalScrollAnimationComponent.SetupValues ( )

protected

Member Data Documentation

m_bAnimateBack

bool SCR_HorizontalScrollAnimationComponent.m_bAnimateBack

protected

m_bIsVerticalAnimation

bool SCR_HorizontalScrollAnimationComponent.m_bIsVerticalAnimation

protected

m_eInitialState

SCR_EScrollAnimationState SCR_HorizontalScrollAnimationComponent.m_eInitialState

protected

m_eState

SCR_EScrollAnimationState SCR_HorizontalScrollAnimationComponent.m_eState

protected

m_fAnimationSpeedPxPerSec

float SCR_HorizontalScrollAnimationComponent.m_fAnimationSpeedPxPerSec

protected

m_fOffsetLeft

float SCR_HorizontalScrollAnimationComponent.m_fOffsetLeft

protected

m_fOffsetRight

float SCR_HorizontalScrollAnimationComponent.m_fOffsetRight

protected

m_fStartPosX

float SCR_HorizontalScrollAnimationComponent.m_fStartPosX

protected

m_fStartPosY

float SCR_HorizontalScrollAnimationComponent.m_fStartPosY

protected

m_fTargetPosX

float SCR_HorizontalScrollAnimationComponent.m_fTargetPosX

protected

m_fTargetPosY

float SCR_HorizontalScrollAnimationComponent.m_fTargetPosY

protected

m_fTimer

float SCR_HorizontalScrollAnimationComponent.m_fTimer

protected

m_fWaitTimeLeftSec

float SCR_HorizontalScrollAnimationComponent.m_fWaitTimeLeftSec

protected

m_fWaitTimeRightSec

float SCR_HorizontalScrollAnimationComponent.m_fWaitTimeRightSec

protected

m_sAnimationContentWidget

string SCR_HorizontalScrollAnimationComponent.m_sAnimationContentWidget

protected

m_wContent

Widget SCR_HorizontalScrollAnimationComponent.m_wContent

protected

m_wRoot

Widget SCR_HorizontalScrollAnimationComponent.m_wRoot

protected

---

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

• Game/UI/Components/SCR_HorizontalScrollAnimationComponent.c