CrystalSpace

Public API Reference

CS::Math::Noise::Module::Max Class Reference
[Combiner Modules]

Noise module that outputs the larger of the two output values from two source modules. More...

#include <cstool/noise/module/max.h>

Inheritance diagram for CS::Math::Noise::Module::Max:

List of all members.

Public Member Functions

virtual int GetSourceModuleCount () const
 Returns the number of source modules required by this noise module.
virtual double GetValue (double x, double y, double z) const
 Generates an output value given the coordinates of the specified input value.
 Max ()
 Constructor.

Detailed Description

Noise module that outputs the larger of the two output values from two source modules.

modulemax.png

This noise module requires two source modules.

Definition at line 48 of file max.h.


Constructor & Destructor Documentation

CS::Math::Noise::Module::Max::Max (  ) 

Constructor.


Member Function Documentation

virtual int CS::Math::Noise::Module::Max::GetSourceModuleCount (  )  const [inline, virtual]

Returns the number of source modules required by this noise module.

Returns:
The number of source modules required by this noise module.

Implements CS::Math::Noise::Module::Module.

Definition at line 56 of file max.h.

virtual double CS::Math::Noise::Module::Max::GetValue ( double  x,
double  y,
double  z 
) const [virtual]

Generates an output value given the coordinates of the specified input value.

Parameters:
x The x coordinate of the input value.
y The y coordinate of the input value.
z The z coordinate of the input value.
Returns:
The output value.
Precondition:
All source modules required by this noise module have been passed to the SetSourceModule() method.

Before an application can call this method, it must first connect all required source modules via the SetSourceModule() method. If these source modules are not connected to this noise module, this method raises a debug assertion.

To determine the number of source modules required by this noise module, call the GetSourceModuleCount() method.

Implements CS::Math::Noise::Module::Module.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1