SCR_HorizontalScrollAnimationComponent.c File Reference

Go to the source code of this file.

Enumerations
enum	SCR_EScrollAnimationState

Functions
enum SCR_EScrollAnimationState	Attribute ("Content", UIWidgets.EditBox, "Name of widget which will be animated")] protected string m_sAnimationContentWidget
void	AnimationStop ()
void	AnimationStart (bool IsVerticalAnimation=false)
bool	IsAnimating ()
void	SetupValues ()
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	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
void	OnFrame ()
bool	AnimateHorizontalPosition (float tDelta, float speed, float target)
bool	AnimateVerticalPosition (float tDelta, float speed, float target)

Variables
	NONE
	MOVING_LEFT
	MOVING_LEFT_DONE_WAITING
	MOVING_RIGHT
	MOVING_RIGHT_DONE_WAITING
	MOVING_TOP
	MOVING_TOP_DONE_WAITING
	MOVING_BOTTOM
	MOVING_BOTTOM_DONE_WAITING
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

Enumeration Type Documentation

SCR_EScrollAnimationState

enum SCR_EScrollAnimationState

This component is meant for cases when content (expecially text) is too long horizontally/vertically and doesn't fit into UI. The component animates content left-right when activated.

!!! WARNING !!! The content widget (the one which will be animated) must be in a Frame Slot! In most basic case you should create a Frame, attach the component to it, and and put a text widget inside the Frame.

Root (this component need to be here) Frame ContentWrapper (must be a Frame Slot - will be the one being moved) elementsBeingScrolled elementsBeingScrolled elementsBeingScrolled

Definition at line 17 of file SCR_HorizontalScrollAnimationComponent.c.

Function Documentation

AnimateHorizontalPosition()

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

protected

Definition at line 327 of file SCR_HorizontalScrollAnimationComponent.c.

AnimateVerticalPosition()

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

protected

Definition at line 347 of file SCR_HorizontalScrollAnimationComponent.c.

AnimationStart()

void AnimationStart ( bool IsVerticalAnimation = false )

protected

Definition at line 85 of file SCR_HorizontalScrollAnimationComponent.c.

AnimationStop()

void AnimationStop ( )

protected

Definition at line 76 of file SCR_HorizontalScrollAnimationComponent.c.

Attribute()

enum SCR_EScrollAnimationState Attribute	(	"Content"	,
		UIWidgets.	EditBox,
		"Name of widget which will be animated"	)

GetContentFitX()

bool GetContentFitX ( )

protected

Returns true when content fits the parent widget.

Definition at line 144 of file SCR_HorizontalScrollAnimationComponent.c.

GetContentFitY()

bool GetContentFitY ( )

protected

Returns true when content fits the parent widget.

Definition at line 158 of file SCR_HorizontalScrollAnimationComponent.c.

HandlerAttached()

override void HandlerAttached ( Widget w )

protected

Definition at line 174 of file SCR_HorizontalScrollAnimationComponent.c.

HandlerDeattached()

override void HandlerDeattached ( Widget w )

protected

Definition at line 199 of file SCR_HorizontalScrollAnimationComponent.c.

IsAnimating()

bool IsAnimating ( )

protected

Definition at line 106 of file SCR_HorizontalScrollAnimationComponent.c.

OnFrame()

void OnFrame ( )

protected

Definition at line 206 of file SCR_HorizontalScrollAnimationComponent.c.

ResetPosition()

void ResetPosition ( )

protected

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

Definition at line 131 of file SCR_HorizontalScrollAnimationComponent.c.

SetupValues()

void SetupValues ( )

protected

Definition at line 112 of file SCR_HorizontalScrollAnimationComponent.c.

Variable Documentation

m_bAnimateBack

bool m_bAnimateBack

protected

Definition at line 48 of file SCR_HorizontalScrollAnimationComponent.c.

m_bIsVerticalAnimation

bool m_bIsVerticalAnimation

protected

Definition at line 70 of file SCR_HorizontalScrollAnimationComponent.c.

m_eInitialState

SCR_EScrollAnimationState m_eInitialState

protected

Definition at line 57 of file SCR_HorizontalScrollAnimationComponent.c.

m_eState

SCR_EScrollAnimationState m_eState

protected

Definition at line 59 of file SCR_HorizontalScrollAnimationComponent.c.

m_fAnimationSpeedPxPerSec

float m_fAnimationSpeedPxPerSec

protected

Definition at line 39 of file SCR_HorizontalScrollAnimationComponent.c.

m_fOffsetLeft

float m_fOffsetLeft

protected

Definition at line 54 of file SCR_HorizontalScrollAnimationComponent.c.

m_fOffsetRight

float m_fOffsetRight

protected

Definition at line 51 of file SCR_HorizontalScrollAnimationComponent.c.

m_fStartPosX

float m_fStartPosX

protected

Definition at line 63 of file SCR_HorizontalScrollAnimationComponent.c.

m_fStartPosY

float m_fStartPosY

protected

Definition at line 64 of file SCR_HorizontalScrollAnimationComponent.c.

m_fTargetPosX

float m_fTargetPosX

protected

Definition at line 67 of file SCR_HorizontalScrollAnimationComponent.c.

m_fTargetPosY

float m_fTargetPosY

protected

Definition at line 68 of file SCR_HorizontalScrollAnimationComponent.c.

m_fTimer

float m_fTimer

protected

Definition at line 65 of file SCR_HorizontalScrollAnimationComponent.c.

m_fWaitTimeLeftSec

float m_fWaitTimeLeftSec

protected

Definition at line 42 of file SCR_HorizontalScrollAnimationComponent.c.

m_fWaitTimeRightSec

float m_fWaitTimeRightSec

protected

Definition at line 45 of file SCR_HorizontalScrollAnimationComponent.c.

m_wContent

Widget m_wContent

protected

Definition at line 60 of file SCR_HorizontalScrollAnimationComponent.c.

m_wRoot

Widget m_wRoot

protected

Definition at line 61 of file SCR_HorizontalScrollAnimationComponent.c.

MOVING_BOTTOM

MOVING_BOTTOM

Definition at line 9 of file SCR_HorizontalScrollAnimationComponent.c.

MOVING_BOTTOM_DONE_WAITING

MOVING_BOTTOM_DONE_WAITING

Definition at line 10 of file SCR_HorizontalScrollAnimationComponent.c.

MOVING_LEFT

MOVING_LEFT

Definition at line 2 of file SCR_HorizontalScrollAnimationComponent.c.

MOVING_LEFT_DONE_WAITING

MOVING_LEFT_DONE_WAITING

Definition at line 3 of file SCR_HorizontalScrollAnimationComponent.c.

MOVING_RIGHT

MOVING_RIGHT

Definition at line 4 of file SCR_HorizontalScrollAnimationComponent.c.

MOVING_RIGHT_DONE_WAITING

MOVING_RIGHT_DONE_WAITING

Definition at line 5 of file SCR_HorizontalScrollAnimationComponent.c.

MOVING_TOP

MOVING_TOP

Definition at line 7 of file SCR_HorizontalScrollAnimationComponent.c.

MOVING_TOP_DONE_WAITING

MOVING_TOP_DONE_WAITING

Definition at line 8 of file SCR_HorizontalScrollAnimationComponent.c.

NONE

@ NONE

Definition at line 0 of file SCR_HorizontalScrollAnimationComponent.c.