docs/triton/_wind_fetch_8h_source.html

// Copyright (c) 2011-2013 Sundog Software LLC. All rights reserved worldwide.


#ifndef TRITON_WINDFETCH_H

#define TRITON_WINDFETCH_H


#ifdef SWIG

%module TritonWindFetch

#define TRITONAPI

%{

#include "WindFetch.h"

using namespace Triton;

%}

#endif


#include "Vector3.h"


#pragma pack(push)

#pragma pack(8)


namespace Triton

{

class WindFetch : public MemObject

{

public:

    WindFetch();


    void TRITONAPI SetWind(double speed, double direction);


    void TRITONAPI SetLocalization(const Vector3& center, const Vector3& radii);


    void TRITONAPI SetFetchLength(double fetch);


    void TRITONAPI ClearLocalization();


    void TRITONAPI ClearFetchLength();


    void TRITONAPI GetWindAtLocation(const Vector3& position, double& windSpeed, double& windDirection, double& fetchLength) const;


    // Called internally:

    void TRITONAPI AdjustForLeftHanded();


protected:

    bool isGlobal;

    Vector3 center, radii;

    double speed, direction, fetchLength;

};

}


#pragma pack(pop)


#endif

Vector3.h
A 3D Vector class and its operations.

WindFetch.h
A localized or global area of wind of given speed and direction.

Triton::MemObject
This base class for all Triton objects intercepts the new and delete operators, routing them through ...
Definition: MemAlloc.h:71

Triton::Vector3
A 3D double-precision Vector class and its operations.
Definition: Vector3.h:36

Triton::WindFetch
A localized or global area of wind of given speed and direction.
Definition: WindFetch.h:27

Triton::WindFetch::SetFetchLength
void TRITONAPI SetFetchLength(double fetch)
If using the JONSWAP model, swells will increase depending on the "fetch length," or the distance the...

Triton::WindFetch::SetLocalization
void TRITONAPI SetLocalization(const Vector3 &center, const Vector3 &radii)
Sets a localized area, in the form of an ellipsoid, in which the wind fetch is active.

Triton::WindFetch::ClearLocalization
void TRITONAPI ClearLocalization()
Clears any localization and makes this wind fetch globally applied.

Triton::WindFetch::WindFetch
WindFetch()
Default constructor.

Triton::WindFetch::SetWind
void TRITONAPI SetWind(double speed, double direction)
Sets the wind speed and direction of this wind fetch.

Triton::WindFetch::GetWindAtLocation
void TRITONAPI GetWindAtLocation(const Vector3 &position, double &windSpeed, double &windDirection, double &fetchLength) const
Retrieves the wind direction and speed from this wind fetch at the given location.

Triton::WindFetch::ClearFetchLength
void TRITONAPI ClearFetchLength()
Clears any explicit fetch length specified by SetFetchLength().