WakeGeneratorParameters contains the parameters required to construct a Triton::WakeGenerator object. More...
#include <WakeGenerator.h>
Public Attributes | |
| bool | sprayEffects |
| Whether you wish this wake to emit spray particles originating from this wake generator. | |
| double | bowSprayOffset |
| Use this to have spray particles emitted from a point different from the ship position. | |
| bool | bowWave |
| Whether the bow wave effect should exist on this object. | |
| double | bowWaveOffset |
| Offset from the ship position, along the direction of travel, at which bow waves will originate. | |
| double | bowWaveScale |
| A scaling factor for the bow wave's amplitude at the bow of the ship. | |
| double | bowWaveMax |
| The maximum amplitude of the bow wave, or -1.0 for unbounded. | |
| double | bowSize |
| The size of the bow in world units; affects the wavelength of the bow wave, and the initial spread of spray particles at the bow. | |
| bool | sternWaves |
| Whether stern wakes should be generated from this object. | |
| double | sternWaveOffset |
| Offset for the stern wakes. | |
| double | length |
| The length of the object generating the wake. | |
| double | beamWidth |
| The width of the object generating the wake. | |
| double | draft |
| The "draft" of the ship, or the depth the hull extends to underwater. | |
| bool | propWash |
| Whether you want propeller backwash effects generated from this wake generator. | |
| double | propWashOffset |
| Use this to have propeller backwash effects generated from a point different from the ship position. | |
| double | propWashWidthMultiplier |
| Multiplies the beam width by this value to arrive at the width of the prop wash effect. | |
| double | propWashFadeTime |
| The amount of time, in seconds, over which the prop wash will dissipate. | |
| int | numHullSprays |
| How many spray particle systems are emitted periodically along the hull of the ship. | |
| double | hullSprayStartOffset |
| The offset at which hull spray effects begin. | |
| double | hullSprayEndOffset |
| The offset at which hull spray effects end. | |
| double | hullSprayScale |
| The initial velocity of hull spray particles as a percent of the ship velocity (0-1) | |
| double | hullSpraySizeScale |
| A scaling factor applied to the hull spray particles. | |
| double | hullSprayVerticalOffset |
| A vertical offset to the starting point of new hull spray particles. | |
| double | bowWakeMultiplier |
| A scaling factor applied to the bow Kelvin wake effect. | |
| double | sternWakeMultiplier |
| A scaling factor applied to the stern Kelvin wake effects. | |
| float | hullWakeWidth |
| Mulitplier for width of hull wake. | |
| float | hullWakeLength |
| Multiplier for length of hull wake. | |
| float | shipSpeedMaxFoam |
| Ship speed corresponding to maximum foam. | |
| float | shipSpeedMinFoam |
| Minimum ship speed before foam is created. | |
Detailed Description
WakeGeneratorParameters contains the parameters required to construct a Triton::WakeGenerator object.
Member Data Documentation
◆ bowSize
| double Triton::WakeGeneratorParameters::bowSize |
The size of the bow in world units; affects the wavelength of the bow wave, and the initial spread of spray particles at the bow.
For a pointy bow, use a value of 0. Generally you'd only use this for things like ferries or LCACs.
◆ bowSprayOffset
| double Triton::WakeGeneratorParameters::bowSprayOffset |
Use this to have spray particles emitted from a point different from the ship position.
This distance will be added to the current wake generator's position along the direction of travel. Unused if sprayEffects is false.
◆ draft
| double Triton::WakeGeneratorParameters::draft |
The "draft" of the ship, or the depth the hull extends to underwater.
This affects the size of the bow wake.
◆ numHullSprays
| int Triton::WakeGeneratorParameters::numHullSprays |
How many spray particle systems are emitted periodically along the hull of the ship.
Set to 0 to disable hull sprays.
The documentation for this class was generated from the following file:
- C:/triton/Public Headers/WakeGenerator.h
