class LineWaveGenerator

Defined in: C4Water.h

The LineWaveGenerator class represents a wave generator that generates a wave along a line segment.

Definition

class LineWaveGenerator final : public WaveGenerator

Member Functions

`LineWaveGenerator::GetGeneratorPosition`	Returns an endpoint position of a line wave generator.
`LineWaveGenerator::SetGeneratorPosition`	Sets an endpoint position of a line wave generator.
`LineWaveGenerator::GetGeneratorRadius`	Returns the radius of a line wave generator.
`LineWaveGenerator::SetGeneratorRadius`	Sets the radius of a line wave generator.

Constructor

LineWaveGenerator(const Point2D& p1, const Point2D& p2, float radius, float delta, int32 time);

Parameters

`p1`	The block-relative position of one endpoint of the line segment.
`p2`	The block-relative position of the other endpoint of the line segment.
`radius`	The radius of the area affected by the wave generator.
`delta`	The difference in elevation applied to the water surface during each time step. This can be positive or negative.
`time`	The number of time steps for which the wave generator runs. If this is zero, then the wave generator never stops.

Description

The LineWaveGenerator class generates a wave along a line segment in a water block.

Base Classes

WaveGenerator A LineWaveGenerator is a specific type of wave generator.