Class SBDTypeEasingCurve

ClassList > SBDTypeEasingCurve

This class describes an easing curve. More...

• #include <SBDTypeEasingCurve.hpp>

Public Types

Type	Name
enum	Type The type of the easing curve.

Public Functions

Type	Name
	SBDTypeEasingCurve (Type type=Linear) Constructs an easing curve.
	SBDTypeEasingCurve (const SBDTypeEasingCurve & EasingCurve) Constructs an easing curve.
	SB_DECLARE_DATA (SBDTypeEasingCurve)
Type	getType () const Returns the type of the easing curve.
std::string	getTypeString (bool humanReadable=false) const Returns a string describing the type of the easing curve.
double	getValue (double progress) const
bool	isSerializable () const Returns true.
SBDTypeEasingCurve &	operator= (const SBDTypeEasingCurve & EasingCurve)
virtual void	print (unsigned int offset=0) const Prints the EasingCurve.
void	serialize (SBCSerializer * serializer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER) const Serializes the easing curve.
void	setType (Type type) Sets the type of the easing curve.
void	unserialize (SBCSerializer * serializer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER) Unserializes the easing curve.
virtual	~SBDTypeEasingCurve () Destructs the easing curve.

Public Static Functions

Type	Name
std::string	getTypeString (Type type, bool humanReadable=false) Returns a string describing the type of the easing curve.
double	getValue (Type type, double progress) Returns the value for a given progress .

Protected Attributes

Type	Name
SBDTypeEasingCurveData *	dataPointer

Detailed Description

This class describes an easing curve in SAMSON.

Short name: SBEasingCurve

Public Types Documentation

enum Type

The type of the easing curve.

enum SBDTypeEasingCurve::Type {
    Linear = 1,
    InSine = 10,
    OutSine = 11,
    InOutSine = 12,
    InQuad = 20,
    OutQuad = 21,
    InOutQuad = 22,
    InCubic = 30,
    OutCubic = 31,
    InOutCubic = 32,
    InQuart = 40,
    OutQuart = 41,
    InOutQuart = 42,
    InQuint = 50,
    OutQuint = 51,
    InOutQuint = 52,
    InExpo = 60,
    OutExpo = 61,
    InOutExpo = 62,
    InCirc = 70,
    OutCirc = 71,
    InOutCirc = 72,
    InBack = 80,
    OutBack = 81,
    InOutBack = 82,
    InElastic = 90,
    OutElastic = 91,
    InOutElastic = 92,
    InBounce = 100,
    OutBounce = 101,
    InOutBounce = 102
};

---

Public Functions Documentation

function SBDTypeEasingCurve [1/2]

Constructs an easing curve.

SBDTypeEasingCurve::SBDTypeEasingCurve (
    Type type=Linear
) 

---

function SBDTypeEasingCurve [2/2]

Constructs an easing curve.

SBDTypeEasingCurve::SBDTypeEasingCurve (
    const SBDTypeEasingCurve & EasingCurve
) 

---

function SB_DECLARE_DATA

SBDTypeEasingCurve::SB_DECLARE_DATA (
    SBDTypeEasingCurve
) 

---

function getType

Returns the type of the easing curve.

Type SBDTypeEasingCurve::getType () const

---

function getTypeString [1/2]

Returns a string describing the type of the easing curve.

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.

---

function getValue [1/2]

double SBDTypeEasingCurve::getValue (
    double progress
) const

---

function isSerializable

Returns true.

bool SBDTypeEasingCurve::isSerializable () const

---

function operator=

SBDTypeEasingCurve & SBDTypeEasingCurve::operator= (
    const SBDTypeEasingCurve & EasingCurve
) 

---

function print

Prints the EasingCurve.

virtual void SBDTypeEasingCurve::print (
    unsigned int offset=0
) const

---

function serialize

Serializes the easing curve.

void SBDTypeEasingCurve::serialize (
    SBCSerializer * serializer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER
) const

---

function setType

Sets the type of the easing curve.

void SBDTypeEasingCurve::setType (
    Type type
) 

---

function unserialize

Unserializes the easing curve.

void SBDTypeEasingCurve::unserialize (
    SBCSerializer * serializer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER
) 

---

function ~SBDTypeEasingCurve

Destructs the easing curve.

virtual SBDTypeEasingCurve::~SBDTypeEasingCurve () 

---

Public Static Functions Documentation

function getTypeString [2/2]

Returns a string describing the type of the easing curve.

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

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

---

function getValue [2/2]

Returns the value for a given progress .

static double SBDTypeEasingCurve::getValue (
    Type type,
    double progress
) 

---

Protected Attributes Documentation

variable dataPointer

SBDTypeEasingCurveData* dataPointer;

---