ShapeGerstner#

Class in WaveHarmonic.Crest, WaveHarmonic.Crest
Extends ShapeWaves

Gerstner wave shape.

Members#

Properties#

_Wavelengths

Wavelengths. Requires Manual Generation to be enabled.

_Amplitudes

Amplitudes. Requires Manual Generation to be enabled.

_Powers

Powers. Requires Manual Generation to be enabled.

_AngleDegrees

Angles. Requires Manual Generation to be enabled.

_Phases

Phases. Requires Manual Generation to be enabled.

ComponentsPerOctave

How many wave components to generate in each octave.

ManualGeneration

Prevent data arrays from being written to so one can provide their own.

RandomSeed

Change to get a different set of waves.

ReverseWaveWeight

The weight of the opposing, second pair of Gerstner waves.

Swell

Use a swell spectrum as the default.

Inherited Members#

Properties#

EvaluateSpectrumAtRunTimeEveryFrame

Whether to evaluate the spectrum every frame.

OverrideGlobalWindDirection

Whether to use the wind direction on this component rather than the global wind direction.

OverrideGlobalWindSpeed

Whether to use the wind speed on this component rather than the global wind speed.

Resolution

Resolution to use for wave generation buffers.

RespectShallowWaterAttenuation

How much these waves respect the shallow water attenuation.

Spectrum

The spectrum that defines the water surface shape.

WaveDirectionHeadingAngle

Primary wave direction heading (degrees).

WindSpeed

Wind speed in km/h. Controls wave conditions.

WindSpeedKPH

The wind speed in kilometers per hour (KPH).

WindSpeedMPS

The wind speed in meters per second (MPS).

Blend

How this input blends into existing data.

FeatherWidth

The width of the feathering to soften the edges to blend inputs.

FollowHorizontalWaveMotion

How this input responds to horizontal displacement.

Mode

The mode for this input.

Queue

The order this input will render.

Weight

Scales the input.

ForceRenderingOff

Disables rendering of input into data, but continues most scripting activities.

Data

Properties specific to LodInput.Mode.

Methods#

GetData

Retrieves the typed data and validates the passed type.