ScalePoint

Noise module that scales the coordinates of the input value before returning the output value from a source module.

@image html modulescalepoint.png

The GetValue() method multiplies the ( @a x, @a y, @a z ) coordinates of the input value with a scaling factor before returning the output value from the source module. To set the scaling factor, call the SetScale() method. To set the scaling factor to apply to the individual @a x, @a y, or @a z coordinates, call the SetXScale(), SetYScale() or SetZScale() methods, respectively.

This noise module requires one source module.

Constructors

this
this()

Constructor.

Members

Functions

GetSourceModCount
int GetSourceModCount()
Undocumented in source. Be warned that the author may not have intended to support it.
GetValue
double GetValue(double x, double y, double z)
Undocumented in source. Be warned that the author may not have intended to support it.
GetXScale
double GetXScale()

Returns the scaling factor applied to the @a x coordinate of the input value.

GetYScale
double GetYScale()

Returns the scaling factor applied to the @a y coordinate of the input value.

GetZScale
double GetZScale()

Returns the scaling factor applied to the @a z coordinate of the input value.

SetScale
void SetScale(double scale)

Sets the scaling factor to apply to the input value.

SetScale
void SetScale(double xScale, double yScale, double zScale)

Sets the scaling factor to apply to the ( @a x, @a y, @a z ) coordinates of the input value.

SetXScale
void SetXScale(double xScale)

Sets the scaling factor to apply to the @a x coordinate of the input value.

SetYScale
void SetYScale(double yScale)

Sets the scaling factor to apply to the @a y coordinate of the input value.

SetZScale
void SetZScale(double zScale)

Sets the scaling factor to apply to the @a z coordinate of the input value.

Variables

m_xScale
double m_xScale;

Scaling factor applied to the @a x coordinate of the input value.

m_yScale
double m_yScale;

Scaling factor applied to the @a y coordinate of the input value.

m_zScale
double m_zScale;

Scaling factor applied to the @a z coordinate of the input value.

Inherited Members

From Mod

~this
~this()

Destructor.

GetSourceMod
const(Mod) GetSourceMod(int index)

Returns a reference to a source module connected to this noise module.

GetSourceModCount
int GetSourceModCount()

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

GetValue
double GetValue(double x, double y, double z)

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

SetSourceMod
void SetSourceMod(int index, const(Mod)* sourceMod)

Connects a source module to this noise module.

m_pSourceMod
const(Mod)*[] m_pSourceMod;

An array containing the pointers to each source module required by this noise module.

Meta