SBDTypeEasingCurve Class Reference

This class describes an easing curve. More...

Easing curve types
enum	Type {   Linear ,   InSine ,   OutSine ,   InOutSine ,   InQuad ,   OutQuad ,   InOutQuad ,   InCubic ,   OutCubic ,   InOutCubic ,   InQuart ,   OutQuart ,   InOutQuart ,   InQuint ,   OutQuint ,   InOutQuint ,   InExpo ,   OutExpo ,   InOutExpo ,   InCirc ,   OutCirc ,   InOutCirc ,   InBack ,   OutBack ,   InOutBack ,   InElastic ,   OutElastic ,   InOutElastic ,   InBounce ,   OutBounce ,   InOutBounce }
	The type of the easing curve. More...

Debugging
Returns the value for a given type and progress
SBDTypeEasingCurveData *	dataPointer
virtual void	print (unsigned int offset=0) const
	Prints the EasingCurve.
	SB_DECLARE_DATA (SBDTypeEasingCurve)

Constructors and destructors
	SBDTypeEasingCurve (Type type=Linear)
	Constructs an easing curve.
	SBDTypeEasingCurve (const SBDTypeEasingCurve &EasingCurve)
	Constructs an easing curve.
virtual	~SBDTypeEasingCurve ()
	Destructs the easing curve.

Serialization
bool	isSerializable () const
	Returns true.
void	serialize (SBCSerializer *serializer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER) const
	Serializes the easing curve.
void	unserialize (SBCSerializer *serializer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER)
	Unserializes the easing curve.

Identity
Type	getType () const
	Returns the type of the easing curve.
void	setType (Type type)
	Sets the type of the easing curve.
std::string	getTypeString (bool humanReadable=false) const
	Returns a string describing the type of the easing curve.
static std::string	getTypeString (Type type, bool humanReadable=false)
	Returns a string describing the type of the easing curve.

Operators
SBDTypeEasingCurve &	operator= (const SBDTypeEasingCurve &EasingCurve)

Evaluation
double	getValue (double progress) const
static double	getValue (Type type, double progress)
	Returns the value for a given progress.

Detailed Description

This class describes an easing curve in SAMSON.

Member Enumeration Documentation

Type

enum SBDTypeEasingCurve::Type

Enumerator
Linear	The linear easing curve.
InSine	The in sine easing curve.
OutSine	The out sine easing curve.
InOutSine	The in out sine easing curve.
InQuad	The in quad easing curve.
OutQuad	The out quad easing curve.
InOutQuad	The in out quad easing curve.
InCubic	The in cubic easing curve.
OutCubic	The out cubic easing curve.
InOutCubic	The in out cubic easing curve.
InQuart	The in quart easing curve.
OutQuart	The out quart easing curve.
InOutQuart	The in out quart easing curve.
InQuint	The in quint easing curve.
OutQuint	The out quint easing curve.
InOutQuint	The in out quint easing curve.
InExpo	The in expo easing curve.
OutExpo	The out expo easing curve.
InOutExpo	The in out expo easing curve.
InCirc	The in circ easing curve.
OutCirc	The out circ easing curve.
InOutCirc	The in out circ easing curve.
InBack	The in back easing curve.
OutBack	The out back easing curve.
InOutBack	The in out back easing curve.
InElastic	The in elastic easing curve.
OutElastic	The out elastic easing curve.
InOutElastic	The in out elastic easing curve.
InBounce	The in bounce easing curve.
OutBounce	The out bounce easing curve.
InOutBounce	The in out bounce easing curve.

Member Function Documentation

getTypeString() [1/2]

std::string SBDTypeEasingCurve::getTypeString

(

bool

humanReadable = false

)

const

This function is a convenience function used to produce a string corresponding to the easing curve's type.

getTypeString() [2/2]

std::string SBDTypeEasingCurve::getTypeString ( SBDTypeEasingCurve::Type  type, bool  humanReadable = false  )

static

This function is a convenience function used to produce a string corresponding to a given easing curve type.