CrystalSpace

Public API Reference

CS::Math::Noise::Module::Checkerboard Class Reference
[Generator Modules]

Noise module that outputs a checkerboard pattern. More...

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

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

List of all members.

Public Member Functions

 Checkerboard ()
 Constructor.
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.

Detailed Description

Noise module that outputs a checkerboard pattern.

modulecheckerboard.png

This noise module outputs unit-sized blocks of alternating values. The values of these blocks alternate between -1.0 and +1.0.

This noise module is not really useful by itself, but it is often used for debugging purposes.

This noise module does not require any source modules.

Definition at line 53 of file checkerboard.h.


Constructor & Destructor Documentation

CS::Math::Noise::Module::Checkerboard::Checkerboard (  ) 

Constructor.


Member Function Documentation

virtual int CS::Math::Noise::Module::Checkerboard::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 61 of file checkerboard.h.

virtual double CS::Math::Noise::Module::Checkerboard::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