ParticleUniverse::DynamicAttributeOscillate Class Reference

#include <ParticleUniverseDynamicAttribute.h>

Inheritance diagram for ParticleUniverse::DynamicAttributeOscillate:

Public Types
enum	OscillationType { OSCT_SINE, OSCT_SQUARE }
Public Types inherited from ParticleUniverse::DynamicAttribute
enum	DynamicAttributeType { DAT_FIXED, DAT_RANDOM, DAT_CURVED, DAT_OSCILLATE }

Public Member Functions
	DynamicAttributeOscillate (void)
	DynamicAttributeOscillate (const DynamicAttributeOscillate &dynamicAttributeOscillate)
	~DynamicAttributeOscillate (void)
virtual Real	getValue (Real x=0)
OscillationType	getOscillationType (void) const
void	setOscillationType (OscillationType oscillationType)
Real	getFrequency (void) const
void	setFrequency (Real frequency)
Real	getPhase (void) const
void	setPhase (Real phase)
Real	getBase (void) const
void	setBase (Real base)
Real	getAmplitude (void) const
void	setAmplitude (Real amplitude)
virtual void	copyAttributesTo (DynamicAttribute *dynamicAttribute)
Public Member Functions inherited from ParticleUniverse::DynamicAttribute
	DynamicAttribute (void)
virtual	~DynamicAttribute (void)
DynamicAttributeType	getType (void) const
void	setType (DynamicAttributeType type)
bool	isValueChangedExternally (void) const
Public Member Functions inherited from ParticleUniverse::IElement
	IElement (void)
virtual	~IElement (void)

Protected Attributes
OscillationType	mOscillationType
Real	mFrequency
Real	mPhase
Real	mBase
Real	mAmplitude
Protected Attributes inherited from ParticleUniverse::DynamicAttribute
DynamicAttributeType	mType
bool	mValueChangedExternally

Member Enumeration Documentation

enum ParticleUniverse::DynamicAttributeOscillate::OscillationType

Enumerator
OSCT_SINE
OSCT_SQUARE

Constructor & Destructor Documentation

ParticleUniverse::DynamicAttributeOscillate::DynamicAttributeOscillate

(

void

)

Constructor

ParticleUniverse::DynamicAttributeOscillate::DynamicAttributeOscillate

(

const DynamicAttributeOscillate &

dynamicAttributeOscillate

)

Copy constructor

ParticleUniverse::DynamicAttributeOscillate::~DynamicAttributeOscillate

(

void

)

Destructor

Member Function Documentation

virtual void ParticleUniverse::DynamicAttributeOscillate::copyAttributesTo ( DynamicAttribute *  dynamicAttribute )

virtual

Todo

Implements ParticleUniverse::DynamicAttribute.

Real ParticleUniverse::DynamicAttributeOscillate::getAmplitude

(

void

)

const

Get and set the Amplitude

Real ParticleUniverse::DynamicAttributeOscillate::getBase

(

void

)

const

Get and set the Base

Real ParticleUniverse::DynamicAttributeOscillate::getFrequency

(

void

)

const

Get and set the Frequency

OscillationType ParticleUniverse::DynamicAttributeOscillate::getOscillationType

(

void

)

const

Get and set the OscillationType

Real ParticleUniverse::DynamicAttributeOscillate::getPhase

(

void

)

const

Get and set the Phase

virtual Real ParticleUniverse::DynamicAttributeOscillate::getValue ( Real  x = 0 )

virtual

Todo

Implements ParticleUniverse::DynamicAttribute.

void ParticleUniverse::DynamicAttributeOscillate::setAmplitude

(

Real

amplitude

)

void ParticleUniverse::DynamicAttributeOscillate::setBase

(

Real

base

)

void ParticleUniverse::DynamicAttributeOscillate::setFrequency

(

Real

frequency

)

void ParticleUniverse::DynamicAttributeOscillate::setOscillationType

(

OscillationType

oscillationType

)

void ParticleUniverse::DynamicAttributeOscillate::setPhase

(

Real

phase

)

Member Data Documentation

Real ParticleUniverse::DynamicAttributeOscillate::mAmplitude

protected

Real ParticleUniverse::DynamicAttributeOscillate::mBase

protected

Real ParticleUniverse::DynamicAttributeOscillate::mFrequency

protected

OscillationType ParticleUniverse::DynamicAttributeOscillate::mOscillationType

protected

Real ParticleUniverse::DynamicAttributeOscillate::mPhase

protected

---

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

• ParticleUniverseDynamicAttribute.h