HatchitGame
Public Member Functions | List of all members
Hatchit::Game::TweenValue Class Reference

Defines a tween value. More...

#include <ht_tween_value.h>

Public Member Functions

 TweenValue (float value)
 Creates a new tween value. More...
 
 TweenValue (const Math::Float2 &value)
 Creates a new tween value. More...
 
 TweenValue (const Math::Float3 &value)
 Creates a new tween value. More...
 
 TweenValue (const Math::Float4 &value)
 Creates a new tween value. More...
 
float GetFloat () const
 Gets this tween value as a single float.
 
Math::Float2 GetFloat2 () const
 Gets this tween value as a single float2.
 
Math::Float3 GetFloat3 () const
 Gets this tween value as a single float3.
 
Math::Float4 GetFloat4 () const
 Gets this tween value as a single float4.
 
TweenValueType GetType () const
 Gets this tween value's type.
 
void SetValue (float value)
 Sets this tween value's underlying value. More...
 
void SetValue (const Math::Float2 &value)
 Sets this tween value's underlying value. More...
 
void SetValue (const Math::Float3 &value)
 Sets this tween value's underlying value. More...
 
void SetValue (const Math::Float4 &value)
 Sets this tween value's underlying value. More...
 
bool operator== (const TweenValue &other) const
 Checks to see if this tween value is equal to another.
 
bool operator!= (const TweenValue &other) const
 Checks to see if this tween value is equal to another.
 

Detailed Description

Defines a tween value.

Constructor & Destructor Documentation

Hatchit::Game::TweenValue::TweenValue ( float  value)

Creates a new tween value.

Parameters
valueThe initial value.
Hatchit::Game::TweenValue::TweenValue ( const Math::Float2 &  value)

Creates a new tween value.

Parameters
valueThe initial value.
Hatchit::Game::TweenValue::TweenValue ( const Math::Float3 &  value)

Creates a new tween value.

Parameters
valueThe initial value.
Hatchit::Game::TweenValue::TweenValue ( const Math::Float4 &  value)

Creates a new tween value.

Parameters
valueThe initial value.

Member Function Documentation

void Hatchit::Game::TweenValue::SetValue ( float  value)

Sets this tween value's underlying value.

Parameters
valueThe new value.
void Hatchit::Game::TweenValue::SetValue ( const Math::Float2 &  value)

Sets this tween value's underlying value.

Parameters
valueThe new value.
void Hatchit::Game::TweenValue::SetValue ( const Math::Float3 &  value)

Sets this tween value's underlying value.

Parameters
valueThe new value.
void Hatchit::Game::TweenValue::SetValue ( const Math::Float4 &  value)

Sets this tween value's underlying value.

Parameters
valueThe new value.

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