PUDynamicAttributeOscillate Class Reference

This class generates values based on an oscillating function (i.e. More...

Inherits PUDynamicAttribute.

Public Member Functions
	PUDynamicAttributeOscillate (void)
	Constructor.
	PUDynamicAttributeOscillate (const PUDynamicAttributeOscillate &dynamicAttributeOscillate)
	Copy constructor.
	~PUDynamicAttributeOscillate (void)
	Destructor.
virtual float	getValue (float x=0) override
	Todo.
OscillationType	getOscillationType (void) const
	Get the oscillation type. More...
var	getOscillationType ()
	Get the oscillation type. More...
local	getOscillationType ()
	Get the oscillation type. More...
void	setOscillationType (OscillationType oscillationType)
	Set the oscillation type. More...
float	getFrequency (void) const
	Get the frequency. More...
void	setFrequency (float frequency)
	Set the frequency. More...
var	setFrequency ( var frequency)
	Set the frequency. More...
local	setFrequency ( local frequency)
	Set the frequency. More...
float	getPhase (void) const
	Get the phase. More...
var	getPhase ()
	Get the phase. More...
local	getPhase ()
	Get the phase. More...
void	setPhase (float phase)
	Set the phase. More...
float	getBase (void) const
	Get the Base Line. More...
void	setBase (float base)
	Set the Base Line. More...
float	getAmplitude (void) const
	Get the amplitude. More...
void	setAmplitude (float amplitude)
	Set the amplitude. More...
virtual PUDynamicAttributeOscillate *	clone () override
	override
local	clone ()
	override
virtual void	copyAttributesTo (PUDynamicAttribute *dynamicAttribute) override
	override
var	copyAttributesTo ( var dynamicAttribute)
	override
local	copyAttributesTo ( local dynamicAttribute)
	override
Public Member Functions inherited from PUDynamicAttribute
	PUDynamicAttribute (void)
	Constructor.
virtual	~PUDynamicAttribute (void)
	Destructor.
DynamicAttributeType	getType (void) const
	Get the type of dynamic attribute. More...
local	getType ()
	Get the type of dynamic attribute. More...
void	setType (DynamicAttributeType type)
	Set the type of dynamic attribute. More...
bool	isValueChangedExternally (void) const
	Returns true if one of the attributes was changed by an external source. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
local	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
local	getReferenceCount ()
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor.

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
local	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
local	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
local	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
local	_rooted
	When true, it means that the object was already rooted.
bool	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...
local	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...

Detailed Description

This class generates values based on an oscillating function (i.e.

Sine)

Member Function Documentation

OscillationType getOscillationType

(

void

)

const

Get the oscillation type.

The oscillation type.

var getOscillationType

(

)

Get the oscillation type.

The oscillation type.

local getOscillationType

(

)

Get the oscillation type.

The oscillation type.

void setOscillationType

(

OscillationType

oscillationType

)

Set the oscillation type.

The oscillation type.

var setOscillationType

(

var

oscillationType

)

Set the oscillation type.

The oscillation type.

local setOscillationType

(

local

oscillationType

)

Set the oscillation type.

The oscillation type.

float getFrequency

(

void

)

const

Get the frequency.

The frequency.

var getFrequency

(

)

Get the frequency.

The frequency.

local getFrequency

(

)

Get the frequency.

The frequency.

void setFrequency

(

float

frequency

)

Set the frequency.

The frequency.

var setFrequency

(

var

frequency

)

Set the frequency.

The frequency.

local setFrequency

(

local

frequency

)

Set the frequency.

The frequency.

float getPhase

(

void

)

const

Get the phase.

The phase.

var getPhase

(

)

Get the phase.

The phase.

local getPhase

(

)

Get the phase.

The phase.

void setPhase

(

float

phase

)

Set the phase.

The phase.

var setPhase

(

var

phase

)

Set the phase.

The phase.

local setPhase

(

local

phase

)

Set the phase.

The phase.

float getBase

(

void

)

const

Get the Base Line.

The Base Line.

var getBase

(

)

Get the Base Line.

The Base Line.

local getBase

(

)

Get the Base Line.

The Base Line.

void setBase

(

float

base

)

Set the Base Line.

The Base Line.

var setBase

(

var

base

)

Set the Base Line.

The Base Line.

local setBase

(

local

base

)

Set the Base Line.

The Base Line.

float getAmplitude

(

void

)

const

Get the amplitude.

The amplitude.

var getAmplitude

(

)

Get the amplitude.

The amplitude.

local getAmplitude

(

)

Get the amplitude.

The amplitude.

void setAmplitude

(

float

amplitude

)

Set the amplitude.

The amplitude.

var setAmplitude

(

var

amplitude

)

Set the amplitude.

The amplitude.

local setAmplitude

(

local

amplitude

)

Set the amplitude.

The amplitude.

---

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

• CCPUDynamicAttribute.h