Frapper::Key Class Reference

Class representing keyframes in a NumberParameter value animation. More...

#include <Key.h>

Collaboration diagram for Frapper::Key:

Public Member Functions
	Key (const float &index, const QVariant &value, NumberParameter *parameter=0)
	Constructor of the Key class.
	Key ()
	Standard constructor of the Key class with inex and value = 0.0.
	Key (const Key &key)
	Copy constructor of the Key class.
	~Key ()
	Destructor of the Key class.
float	getIndex () const
	Returns the key's index.
void	setIndex (const float &index)
	Sets the index of the key to the given index.
QVariant	getValue () const
	Returns the key's value.
void	setValue (const QVariant &value)
	Sets the value of the key to the given value.
void	setParameter (NumberParameter *parameter)
	Sets the parent parameter of the key.
Key &	operator/= (const float &fScalar)
	Operators.

Private Attributes
float	m_index
	The key's index.
QVariant	m_value
	The key's value.
NumberParameter *	m_numberParameter
	The key's parent numberparameter.

Detailed Description

Class representing keyframes in a NumberParameter value animation.

Constructor & Destructor Documentation

Frapper::Key::Key	(	const float &	index,
		const QVariant &	value,
		NumberParameter *	numberParameter = 0
	)

Constructor of the Key class.

Constructors and Destructors.

Parameters

index	The index for the new key.
value	The value for the new key.
numberParameter	The parent parameter for the new key.

Constructor of the Key class.

Parameters

index	The index for the new key.
value	The value for the new key.
numberParameter	The parent parameter for the new key.

Frapper::Key::Key

(

)

Standard constructor of the Key class with inex and value = 0.0.

Standard constructor of the Key class with inex = value = 0.0.

Frapper::Key::Key

(

const Key &

key

)

Copy constructor of the Key class.

Parameters

parameter

The parameter to copy.

Frapper::Key::~Key

(

)

Destructor of the Key class.

Member Function Documentation

float Frapper::Key::getIndex

(

)

const

Returns the key's index.

Public Functions.

Returns

The key's index.

Returns the key's index.

Returns

The key's index.

void Frapper::Key::setIndex

(

const float &

index

)

Sets the index of the key to the given index.

Parameters

index

The index for the key.

QVariant Frapper::Key::getValue

(

)

const

Returns the key's value.

Returns

The key's value.

void Frapper::Key::setValue

(

const QVariant &

value

)

Sets the value of the key to the given value.

Parameters

value

The value for the key.

void Frapper::Key::setParameter

(

NumberParameter *

parameter

)

Sets the parent parameter of the key.

Parameters

parameter

The parent parameter for the key.

Key& Frapper::Key::operator/= ( const float &  fScalar )

inline

Operators.

Multiplies the Value of the key with the given scalar

Parameters

Thie	geven scalar

Member Data Documentation

float Frapper::Key::m_index

private

The key's index.

QVariant Frapper::Key::m_value

private

The key's value.

NumberParameter* Frapper::Key::m_numberParameter

private

The key's parent numberparameter.

---

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

• Key.h
• Key.cpp