iso::synth::FunctionDescriptor Class Reference

stores function parameters More...

#include <iso_synth_function_descriptor.h>

List of all members.

Public Member Functions
	FunctionDescriptor ()
	FunctionDescriptor (FunctionType pFunctionType, const math::Vector2< sample > &pYLimits, int pFrameCount)
	FunctionDescriptor (FunctionType pFunctionType, const math::Vector2< sample > &pXRange, const math::Vector2< sample > &pYLimits, int pFrameCount)
	FunctionDescriptor (FunctionType pFunctionType, sample pControlParameter, const math::Vector2< sample > &pXRange, const math::Vector2< sample > &pYLimits, int pFrameCount)
	FunctionDescriptor (FunctionType pFunctionType, const math::Vector2< sample > &pYLimits, double pDuration)
	FunctionDescriptor (FunctionType pFunctionType, const math::Vector2< sample > &pXRange, const math::Vector2< sample > &pYLimits, double pDuration)
	FunctionDescriptor (FunctionType pFunctionType, sample pControlParameter, const math::Vector2< sample > &pXRange, const math::Vector2< sample > &pYLimits, double pDuration)
	~FunctionDescriptor ()
Static Public Member Functions
static sample	defaultParameter (FunctionType pFunctionType)
	return default control parameter for function type
Public Attributes
FunctionType	mFunctionType
	function type
sample	mControlParameter
	control parameter (required for certain functions)
math::Vector2< sample >	mXRange
	x range
math::Vector2< sample >	mYLimits
	y min and max values
int	mFrameCount
	frame count of buffer to create
sample	mDuration
	duration of function (in milisecs)
Friends
class	FunctionGenerator

---

Detailed Description

stores function parameters

parameters

Created by Daniel Bisig on 7/19/06. Copyright 2006 Daniel Bisig All rights reserved.

---

Constructor & Destructor Documentation

FunctionDescriptor::FunctionDescriptor

(

)

FunctionDescriptor::FunctionDescriptor	(	FunctionType	pFunctionType,
		const math::Vector2< sample > &	pYLimits,
		int	pFrameCount
	)

FunctionDescriptor::FunctionDescriptor	(	FunctionType	pFunctionType,
		const math::Vector2< sample > &	pXRange,
		const math::Vector2< sample > &	pYLimits,
		int	pFrameCount
	)

FunctionDescriptor::FunctionDescriptor	(	FunctionType	pFunctionType,
		sample	pControlParameter,
		const math::Vector2< sample > &	pXRange,
		const math::Vector2< sample > &	pYLimits,
		int	pFrameCount
	)

FunctionDescriptor::FunctionDescriptor	(	FunctionType	pFunctionType,
		const math::Vector2< sample > &	pYLimits,
		double	pDuration
	)

FunctionDescriptor::FunctionDescriptor	(	FunctionType	pFunctionType,
		const math::Vector2< sample > &	pXRange,
		const math::Vector2< sample > &	pYLimits,
		double	pDuration
	)

FunctionDescriptor::FunctionDescriptor	(	FunctionType	pFunctionType,
		sample	pControlParameter,
		const math::Vector2< sample > &	pXRange,
		const math::Vector2< sample > &	pYLimits,
		double	pDuration
	)

FunctionDescriptor::~FunctionDescriptor

(

)

---

Member Function Documentation

sample FunctionDescriptor::defaultParameter

(

FunctionType

pFunctionType

)

[static]

return default control parameter for function type

Parameters:

pFunctionType

function type

Returns:

default control parameter

since not all function types possess a default control parameter, the value returned is sometimes meaningless

---

Friends And Related Function Documentation

friend class FunctionGenerator [friend]

---

Member Data Documentation

FunctionType iso::synth::FunctionDescriptor::mFunctionType

function type

sample iso::synth::FunctionDescriptor::mControlParameter

control parameter (required for certain functions)

math::Vector2<sample> iso::synth::FunctionDescriptor::mXRange

x range

math::Vector2<sample> iso::synth::FunctionDescriptor::mYLimits

y min and max values

int iso::synth::FunctionDescriptor::mFrameCount

frame count of buffer to create

sample iso::synth::FunctionDescriptor::mDuration

duration of function (in milisecs)

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/util/iso_synth_function_descriptor.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/util/iso_synth_function_descriptor.cpp

---