SCR_HorizontalScrollAnimationComponent Interface Reference

This component is meant for cases when content (expecially text) is too long horisontally and doesn't fit into UI. More...

Inheritance diagram for SCR_HorizontalScrollAnimationComponent:

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

Static Public Member Functions
static SCR_HorizontalScrollAnimationComponent	FindComponent (Widget w)

Public Attributes
string	m_sAnimationContentWidget

Protected Member Functions
override void	HandlerAttached (Widget w)
void	OnEachFrame ()
void	AnimatePosition (float tDelta, float speed)

Protected Attributes
float	m_fAnimationSpeedPxPerSec
float	m_fWaitTimeLeftSec
float	m_fWaitTimeRightSec
bool	m_bAnimateBack
float	m_fOffsetRight
float	m_fOffsetLeft
int	m_State
Widget	m_wContent
Widget	m_wRoot
float	m_fStartPosX
float	m_fTimer

Static Protected Attributes
static const int	STATE_NONE = 0
static const int	STATE_MOVING_LEFT = 1
static const int	STATE_MOVING_LEFT_DONE_WAITING = 2
static const int	STATE_MOVING_RIGHT = 3
static const int	STATE_MOVING_RIGHT_DONE_WAITING = 4

Detailed Description

This component is meant for cases when content (expecially text) is too long horisontally 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. NB: this might cause the font to be cut on top and bottom if set to clip, in which case wrap the text into another widget and give it some padding Frame Wrapper Text (with top & bottom padding)

Member Function Documentation

AnimatePosition()

void SCR_HorizontalScrollAnimationComponent.AnimatePosition ( float  tDelta, float  speed  )

protected

AnimationStart()

void SCR_HorizontalScrollAnimationComponent.AnimationStart

(

)

AnimationStop()

void SCR_HorizontalScrollAnimationComponent.AnimationStop

(

)

FindComponent()

static SCR_HorizontalScrollAnimationComponent SCR_HorizontalScrollAnimationComponent.FindComponent ( Widget  w )

static

GetContentFit()

bool SCR_HorizontalScrollAnimationComponent.GetContentFit

(

)

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

)

OnEachFrame()

void SCR_HorizontalScrollAnimationComponent.OnEachFrame ( )

protected

ResetPosition()

void SCR_HorizontalScrollAnimationComponent.ResetPosition

(

)

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

Member Data Documentation

m_bAnimateBack

bool SCR_HorizontalScrollAnimationComponent.m_bAnimateBack

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_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

m_State

int SCR_HorizontalScrollAnimationComponent.m_State

protected

m_wContent

Widget SCR_HorizontalScrollAnimationComponent.m_wContent

protected

m_wRoot

Widget SCR_HorizontalScrollAnimationComponent.m_wRoot

protected

STATE_MOVING_LEFT

const int SCR_HorizontalScrollAnimationComponent.STATE_MOVING_LEFT = 1

staticprotected

STATE_MOVING_LEFT_DONE_WAITING

const int SCR_HorizontalScrollAnimationComponent.STATE_MOVING_LEFT_DONE_WAITING = 2

staticprotected

STATE_MOVING_RIGHT

const int SCR_HorizontalScrollAnimationComponent.STATE_MOVING_RIGHT = 3

staticprotected

STATE_MOVING_RIGHT_DONE_WAITING

const int SCR_HorizontalScrollAnimationComponent.STATE_MOVING_RIGHT_DONE_WAITING = 4

staticprotected

STATE_NONE

const int SCR_HorizontalScrollAnimationComponent.STATE_NONE = 0

staticprotected

---

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

• Game/UI/Components/SCR_HorizontalScrollAnimationComponent.c