LineWaveGenerator::SetGeneratorPosition

Defined in: C4Water.h

Sets an endpoint position of a line wave generator.

Prototype

void SetGeneratorPosition(int32 index, const Point2D& position);

Parameters

`index`	The index of the endpoint to set. This must be 0 or 1.
`position`	The new wave generator endpoint position.

Description

The SetGeneratorPosition function sets an endpoint position of a line wave generator to that specified by the position parameter. The position coordinates should be specified in the local coordinate system of the water block to which the generator pertains. The index parameter specifies which endpoint position is set.

If an endpoint position of a wave generator is changed after it is already running, then the WaveGenerator::InvalidateWaveGenerator function should also be called to indicate that the wave generator needs to be updated.