src/WeatherCM/FGWindItem.h

   1 /*****************************************************************************
   2
   3  Header:       FGWindItem.h
   4  Author:       Christian Mayer
   5  Date started: 28.05.99
   6
   7  -------- Copyright (C) 1999 Christian Mayer (fgfs@christianmayer.de) --------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  14  This program is distributed in the hope that it will be useful, but WITHOUT
  15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU General Public License along with
  20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  21  Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23  Further information about the GNU General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 FUNCTIONAL DESCRIPTION
  27 ------------------------------------------------------------------------------
  28 wind item that gets stored in the micro weather class
  29
  30 HISTORY
  31 ------------------------------------------------------------------------------
  32 28.05.1999 Christian Mayer      Created
  33 16.06.1999 Durk Talsma          Portability for Linux
  34 20.06.1999 Christian Mayer      added lots of consts
  35 11.10.1999 Christian Mayer      changed set<> to map<> on Bernie Bright's
  36                                 suggestion
  37 19.10.1999 Christian Mayer      change to use PLIB's sg instead of Point[2/3]D
  38                                 and lots of wee code cleaning
  39 *****************************************************************************/
  40
  41 /****************************************************************************/
  42 /* SENTRY                                                                   */
  43 /****************************************************************************/
  44 #ifndef FGWindItem_H
  45 #define FGWindItem_H
  46
  47 /****************************************************************************/
  48 /* INCLUDES                                                                 */
  49 /****************************************************************************/
  50 #include "sg.h"
  51
  52 #include "FGWeatherDefs.h"
  53
  54 /****************************************************************************/
  55 /* DEFINES                                                                  */
  56 /****************************************************************************/
  57 class FGWindItem;
  58 FGWindItem operator-(const FGWindItem& arg);
  59
  60 /****************************************************************************/
  61 /* CLASS DECLARATION                                                        */
  62 /****************************************************************************/
  63 class FGWindItem
  64 {
  65 private:
  66     sgVec3 value;
  67
  68 protected:
  69 public:
  70
  71     FGWindItem(const sgVec3& v) { sgCopyVec3(value, v); }
  72     FGWindItem()                { sgZeroVec3(value);    }
  73
  74     void          getValue(sgVec3 ret) const { sgCopyVec3(ret, value); };
  75     const sgVec3* getValue(void)       const { return &value;          };
  76
  77     WeatherPrecision x(void) const { return value[0]; };
  78     WeatherPrecision y(void) const { return value[1]; };
  79     WeatherPrecision z(void) const { return value[2]; };
  80
  81     FGWindItem& operator*= (const WeatherPrecision arg);
  82     FGWindItem& operator+= (const FGWindItem&      arg);
  83     FGWindItem& operator-= (const FGWindItem&      arg);
  84
  85     friend FGWindItem operator-(const FGWindItem& arg);
  86 };
  87
  88 inline FGWindItem& FGWindItem::operator*= (const WeatherPrecision arg)
  89 {
  90   sgScaleVec3(value, arg);
  91   return *this;
  92 }
  93
  94 inline FGWindItem& FGWindItem::operator+= (const FGWindItem& arg)
  95 {
  96   sgAddVec3(value, *arg.getValue());
  97   return *this;
  98 }
  99
 100 inline FGWindItem& FGWindItem::operator-= (const FGWindItem& arg)
 101 {
 102   sgSubVec3(value, *arg.getValue());
 103   return *this;
 104 }
 105
 106
 107 inline FGWindItem operator-(const FGWindItem& arg)
 108 {
 109     sgVec3 temp;
 110
 111     sgNegateVec3(temp, *arg.getValue());
 112
 113     return FGWindItem(temp);
 114 }
 115
 116 /****************************************************************************/
 117 #endif /*FGWindItem_H*/