Class INoiseControl
See Also: Class Control.
class INoiseControl : public StdControl
Description:
This class is available in release 2.0 and later only.
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.
Methods:
Prototype:
virtual void SetSeed(int seed)=0;
Remarks:
Sets the seed value for the noise controller.
Parameters:
int seed
The seed value, greater than or equal to zero.
Prototype:
virtual int GetSeed()=0;
Remarks:
Returns the seed value.
Prototype:
virtual void SetFrequency(float f)=0;
Remarks:
Sets the frequency parameter.
Parameters:
float f
The value to set, greater than zero.
Prototype:
virtual float GetFrequency()=0;
Remarks:
Returns the frequency value.
Prototype:
virtual void SetFractal(BOOL f)=0;
Remarks:
Sets the fractal setting on or off.
Parameters:
BOOL f
TRUE for on; FALSE for off.
Prototype:
virtual BOOL GetFractal()=0;
Remarks:
Returns the state of the fractal setting. TRUE if on; FALSE if off.
Prototype:
virtual void SetRoughness(float f)=0;
Remarks:
Sets the roughness setting.
Parameters:
float f
The value to set, between 0.0 and 1.0.
Prototype:
virtual float GetRoughness()=0;
Remarks:
Returns the roughness setting.
Prototype:
virtual void SetRampIn(TimeValue in)=0;
Remarks:
Sets the ramp in setting.
Parameters:
TimeValue in
The value to set, greater than or equal to zero.
Prototype:
virtual TimeValue GetRampIn()=0;
Remarks:
Returns the ramp in setting.
Prototype:
virtual void SetRampOut(TimeValue out)=0;
Remarks:
Sets the ramp out setting.
Parameters:
TimeValue out
The value to set, greater than or equal to zero.
Prototype:
virtual TimeValue GetRampOut()=0;
Remarks:
Returns the ramp out setting.
Prototype:
virtual void SetPositiveOnly(int which,BOOL onOff)=0;
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.
Prototype:
virtual BOOL GetPositiveOnly(int which)=0;
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.
Prototype:
virtual Control *GetStrengthController()=0;
Remarks:
Returns a pointer to the controller for the strength parameter.
Prototype:
virtual void SetStrengthController(Control *c)=0;
Remarks:
Sets the controller used for the strength parameter.
Parameters:
Control *c
Points to the controller to set.