noise::module::Min Class Reference
[Combiner Modules]

#include <min.h>

Inheritance diagram for noise::module::Min:

List of all members.

Detailed Description

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

This noise module requires two source modules.


Public Member Functions
	Min ()
	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.

Member Function Documentation

virtual int noise::module::Min::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 noise::module::Module.

double Min::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 noise::module::Module.

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

min.h
min.cpp

noise::module::Min Class Reference [Combiner Modules]

Detailed Description

Public Member Functions

Member Function Documentation

noise::module::Min Class Reference
[Combiner Modules]