INoiseControl Class Reference

This reference page is linked to from the following overview topics: Controller API Elements.

---

Search for all occurrences

#include <istdplug.h>

Inheritance diagram for INoiseControl:

---

Class Description

See also:

Class Control.

Description:

This class provides access to noise controller's parameters. All noise controllers are derived from this class.

All methods of this class are implemented by the system.

Public Member Functions
virtual void	SetSeed (int seed)=0
virtual int	GetSeed ()=0
virtual void	SetFrequency (float f)=0
virtual float	GetFrequency ()=0
virtual void	SetFractal (BOOL f)=0
virtual BOOL	GetFractal ()=0
virtual void	SetRoughness (float f)=0
virtual float	GetRoughness ()=0
virtual void	SetRampIn (TimeValue in)=0
virtual TimeValue	GetRampIn ()=0
virtual void	SetRampOut (TimeValue out)=0
virtual TimeValue	GetRampOut ()=0
virtual void	SetPositiveOnly (int which, BOOL onOff)=0
virtual BOOL	GetPositiveOnly (int which)=0
virtual Control *	GetStrengthController ()=0
virtual void	SetStrengthController (Control *c)=0

---

Member Function Documentation

virtual void SetSeed

(

int

seed

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the seed value for the noise controller.

Parameters:

int seed

The seed value, greater than or equal to zero.

virtual int GetSeed

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the seed value.

virtual void SetFrequency

(

float

f

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the frequency parameter.

Parameters:

float f

The value to set, greater than zero.

virtual float GetFrequency

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the frequency value.

virtual void SetFractal

(

BOOL

f

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the fractal setting on or off.

Parameters:

BOOL f

TRUE for on; FALSE for off.

virtual BOOL GetFractal

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the state of the fractal setting. TRUE if on; FALSE if off.

virtual void SetRoughness

(

float

f

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the roughness setting.

Parameters:

float f

The value to set, between 0.0 and 1.0.

virtual float GetRoughness

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the roughness setting.

virtual void SetRampIn

(

TimeValue

in

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the ramp in setting.

Parameters:

TimeValue in

The value to set, greater than or equal to zero.

virtual TimeValue GetRampIn

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the ramp in setting.

virtual void SetRampOut

(

TimeValue

out

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the ramp out setting.

Parameters:

TimeValue out

The value to set, greater than or equal to zero.

virtual TimeValue GetRampOut

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the ramp out setting.

virtual void SetPositiveOnly	(	int	which,
		BOOL	onOff
	)		[pure virtual]

Search for all occurrences

Remarks:

Sets the positive only setting (>0) for the specified axis to the specified value.

Parameters:

int which

Specifes the axis. One of the following values:

0: X, 1: y, 2: Z.

BOOL onOff

TRUE for on; FALSE for off.

virtual BOOL GetPositiveOnly

(

int

which

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the positive only setting (>0) for the specified axis to the specified value.

Parameters:

int which

Specifes the axis. One of the following values:

0: X, 1: y, 2: Z.

virtual Control* GetStrengthController

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns a pointer to the controller for the strength parameter.

virtual void SetStrengthController

(

Control *

c

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the controller used for the strength parameter.

Parameters:

Control *c

Points to the controller to set.