Guiliani  Version 2.5 revision 7293 (documentation build 13)
CGUIAnimatedAttribute Class Reference

This class defines a generic interface for attribute which are modified by animations. More...

#include <GUIAnimatedAttribute.h>

Public Types

enum  AnimatedAttribute_t {
  ATTR_NONE = -1 , ATTR_FIRST , ATTR_XPOS = ATTR_FIRST , ATTR_YPOS ,
  ATTR_WIDTH , ATTR_HEIGHT , ATTR_ALPHA , ATTR_COUNT
}
 

Public Member Functions

 CGUIAnimatedAttribute ()
 
 CGUIAnimatedAttribute (const AnimatedAttribute_t &eAttributeType, const CGUIEasing::EasingType_t &eEasingType, const eC_Value &vStartValue, const eC_Value &vTargetValue)
 
AnimatedAttribute_t GetAttributeType () const
 
CGUIEasing::EasingType_t GetEasingType () const
 
eC_Value GetStartValue () const
 
eC_Value GetTargetValue () const
 
void SetEasingType (const CGUIEasing::EasingType_t &eEasingType)
 
void SetStartValue (const eC_Value &vValue)
 
void SetTargetValue (const eC_Value &vValue)
 

Detailed Description

This class defines a generic interface for attribute which are modified by animations.

Member Enumeration Documentation

◆ AnimatedAttribute_t

different types of attributes

Enumerator
ATTR_NONE 

none

ATTR_FIRST 

first in list

ATTR_XPOS 

x-position

ATTR_YPOS 

y-position

ATTR_WIDTH 

width

ATTR_HEIGHT 

height

ATTR_ALPHA 

alpha-value

ATTR_COUNT 

number of enums

Constructor & Destructor Documentation

◆ CGUIAnimatedAttribute() [1/2]

CGUIAnimatedAttribute::CGUIAnimatedAttribute ( const AnimatedAttribute_t eAttributeType,
const CGUIEasing::EasingType_t eEasingType,
const eC_Value &  vStartValue,
const eC_Value &  vTargetValue 
)

Create a new AnimatedAttribute

Parameters
eAttributeTypetype of attribute
eEasingTypeused easing
vStartValuestarting-value
vTargetValuetarget value

◆ CGUIAnimatedAttribute() [2/2]

CGUIAnimatedAttribute::CGUIAnimatedAttribute ( )

default-constructor

Member Function Documentation

◆ GetAttributeType()

AnimatedAttribute_t CGUIAnimatedAttribute::GetAttributeType ( ) const

get attribute-type

Returns
attribute-type

◆ GetEasingType()

CGUIEasing::EasingType_t CGUIAnimatedAttribute::GetEasingType ( ) const

get easing-type

Returns
easing-type

◆ GetStartValue()

eC_Value CGUIAnimatedAttribute::GetStartValue ( ) const

get start-value

Returns
start-value

◆ GetTargetValue()

eC_Value CGUIAnimatedAttribute::GetTargetValue ( ) const

get target-value

Returns
target-value

◆ SetEasingType()

void CGUIAnimatedAttribute::SetEasingType ( const CGUIEasing::EasingType_t eEasingType)

set the easing-type

Parameters
eEasingTypenew easing-type

◆ SetStartValue()

void CGUIAnimatedAttribute::SetStartValue ( const eC_Value &  vValue)

set the start-value

Parameters
vValuenew start-value

◆ SetTargetValue()

void CGUIAnimatedAttribute::SetTargetValue ( const eC_Value &  vValue)

set the target-value

Parameters
vValuenew target-value

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