WakeGenerator.h

Go to the documentation of this file.

// Copyright (c) 2011-2016 Sundog Software, LLC. All rights reserved worldwide.
 
#ifndef TRITON_WAKE_GENERATOR_H
#define TRITON_WAKE_GENERATOR_H
 
#ifdef SWIG
%module TritonWakeGenerator
%import "Ocean.h"
#define TRITONAPI
%{
#include "WakeGenerator.h"
using namespace Triton;
%}
#endif
 
#include "TritonCommon.h"
#include "Vector3.h"
#include "TritonVector.h"
 
#pragma pack(push)
#pragma pack(8)
 
namespace Triton
{
class Ocean;
 
struct SBowSprayEmitter
{
  int numSprays;                  
  Vector3f offset;                
  double sprayVelocityScale;      
 
  double spraySizeScale;          
 
  SBowSprayEmitter(int _numSprays, double _sprayVelocityScale, double _spraySizeScale)
    : numSprays(_numSprays), offset(0,0,0), sprayVelocityScale(_sprayVelocityScale), spraySizeScale(_spraySizeScale)
  {
    
  }
};
 
class WakeGeneratorParameters : public MemObject
{
public:
    WakeGeneratorParameters();
    ~WakeGeneratorParameters();
 
    // Bow spray settings:
    bool   sprayEffects;            
 
    double bowSprayOffset;          
 
    std::vector<SBowSprayEmitter> bowSprayEmitters;
 
    // Kelvin wake settings:
    bool bowWave;                   
 
    double bowWaveOffset;           
 
    double bowWaveScale;            
 
    double bowWaveMax;              
 
    double bowSize;                 
 
    bool sternWaves;                
 
    double sternWaveOffset;         
 
    // Ship geometry:
    double length;                  
 
    double beamWidth;               
 
    double draft;                   
 
    // Prop wash / tubulent wake settings:
    bool   propWash;                
 
    double propWashOffset;          
 
    double propWashWidthMultiplier; 
 
    double propWashFadeTime;        
 
    // Hull spray settings:
    int    numHullSprays;           
 
    double hullSprayStartOffset;    
 
    double hullSprayEndOffset;      
 
    double hullSprayScale;          
 
    double hullSpraySizeScale;      
 
    double hullSprayVerticalOffset;
 
        double bowWakeMultiplier;               
        
        double sternWakeMultiplier;             
 
    // Hull wake settings
    float hullWakeWidth;  
    float hullWakeLength; 
    float shipSpeedMaxFoam; 
    float shipSpeedMinFoam; 
};
 
class WakeGenerator : public MemObject
{
public:
    WakeGenerator(Ocean *pOcean, const WakeGeneratorParameters& parameters);
 
        virtual ~WakeGenerator();
 
    void TRITONAPI Update(const Vector3& pPosition, const Vector3& pDirection, double pVelocity, double pTime, bool pDisableWash = false);
 
    void ClearWakes();
 
    Vector3 TRITONAPI GetPosition() const {
        return position;
    }
 
    Vector3 TRITONAPI GetSternPosition() const {
        return sternPosition;
    }
 
    double TRITONAPI GetVelocity() const {
        return velocity;
    }
 
    bool TRITONAPI HasPropWash() const {
        return params.propWash;
    }
 
    void TRITONAPI SetLODDistance(double distance) {
        lodDistance = distance;
    }
 
    double TRITONAPI GetLODDistance() const {
        return lodDistance;
    }
 
    const WakeGeneratorParameters& TRITONAPI GetParameters() const;
 
    void TRITONAPI SetParameters(const WakeGeneratorParameters& parameters);
 
    // Used internally to clear out the ocean reference when it is deleted.
    void OceanDestroyed() {
        ocean = 0;
        registered = false;
    }
 
    // Used internally to clear out the wake manager reference when it is deleted.
    void WakeManagerDestroyed() {
        registeredWakeManager = false;
    }
 
    // Used internally to keep track of the current max wake number.
    int GetMaxWakeNumber() const {
        return wakeNumber - 1;
    }
 
    // Used internally for fading prop wash effects.
    double GetDistanceTravelled() const {
        return distanceTravelled;
    }
 
    // Return the Ocean object this wake is attached to (if any)
    // Used internally.
    const Ocean *GetOcean() const {
       return ocean;
    }
 
protected:
    Vector3 position, sternPosition, lastPosition, washPosition, lastEmitPosition, lastWaveEmitPosition, lastLastEmitPosition;
    Vector3 lastEmitSourcePosition, lastWakePosition;
    double velocity;
    double distanceTravelled;
    Ocean *ocean;
    double lastSprayEmitTime, lastWaveEmitTime;
    double lodDistance, hullSpeed;
    double sprayCullDist;
    bool firstEmit, firstWaveEmit, registered, registeredWakeManager;
    int wakeNumber, lastWakeNumber;
    double minPropSegmentLength, decayRate, washDecayRate;
    double sprayPositionVariation, curveGenerationFactor;
    double gravity, maxDistanceSquared;
    int maxWakes;
    bool wakesAffectHeight;
 
    WakeGeneratorParameters params;
};
}
 
#pragma pack(pop)
 
#endif