WorldObjects.h

Go to the documentation of this file.

/*
 * WorldObjects.h
 *
 * Part of Fly! Legacy project
 *
 * Copyright 2003 Chris Wallace
 *
 * Fly! Legacy is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 * Fly! Legacy is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 *   along with Fly! Legacy; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include "FlyLegacy.h"
#include "UserVehicles.h"
#include "Airplane.h"

#ifndef WORLDOBJECTS_H
#define WORLDOBJECTS_H


//
// CWorldObjectBase is an abstract parent class for all Fly world object types
//
// Stream file declaration:
//    <wobj>
//    wobj
//    <bgno>
//    <endo>
//
class CWorldObjectBase : public CStreamObject {
public:
  virtual ~CWorldObjectBase (void) {};

  virtual Tag   GetType (void) = 0;
};


//
// The CWorldObject object is a dynamic scenery model with
//   <wobj> signature of TYPE_FLY_WORLDOBJECT
//
// Stream file declaration:
//    <wobj>
//    wobj
//    <bgno>
//    <endo>
//
class CWorldObject : public CWorldObjectBase {
public:
  CWorldObject (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);
  virtual void  ReadFinished (void);

  // CWorldObjectBase methods
  virtual Tag       GetType (void);
  virtual SPosition GetPosition (void);
  virtual void      SetPosition (SPosition pos);
  virtual SVector   GetOrientation (void);
  virtual void      SetOrientation (SVector v);

protected:
  Tag       type;   // Object type
  SPosition geop;   // Position (lat/lon/alt) of the object
  SVector   iang;   // Inertial angular orientation
  bool      geopRead, iangRead;
};


//
// The CModelManager represents a single model representation of a world object
//
class CModelManager : public CStreamObject {
public:
  CModelManager (void);
  virtual ~CModelManager (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);

  // CModelManager methods
  ssgEntity     *GetSSGEntity (void);

protected:
  Tag        tag;
  CModelSMF  *model;     // Model (SMF, ACM or BIN), see Utility.h and ModelXXX.cpp
};


//
// The CModelObject object refines the CWorldObject by adding a static 3D model.
//
// Stream file declaration:
//    <wobj>
//    mobj
//    <bgno>
//    <endo>
//
class CModelObject : public CWorldObject {
public:
  CModelObject (void);
  virtual ~CModelObject (void);

  // CWorldObject methods
  virtual void      SetPosition (SPosition pos);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);
  virtual void  ReadFinished (void);

  // CModelObject methods
  virtual ssgEntity *GetSSGEntity (void);

protected:
  unsigned int  flags;
  int           detail;
  ssgTransform  *top;             // Top-level transform for 3D model
  ssgSelector   *daynight;        // Selector for day/night models
  CModelManager *dayModel;
  CModelManager *nightModel;
};


//
// The CSimulatedObject object has some behaviour tied to the real-time simulation.
//   This could be an animated object, e.g. windsock.
//
// Stream file declaration:
//    <wobj>
//    sobj
//    <bgno>
//    <endo>
//
class CSimulatedObject : public CModelObject {
public:
  // Constructors / destructor
  CSimulatedObject (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);
  virtual void  ReadFinished (void);
};


//
// The CVehicleObject object is ...
//   <wobj> signature of TYPE_FLY_VEHICLEOBJECT
//
// Stream file declaration:
//    <wobj>
//    vehi
//    <bgno>
//    <endo>
//
class CVehicleObject : public CSimulatedObject {
public:
  // Constructors / destructor
  CVehicleObject (void);
  virtual ~CVehicleObject (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);
  virtual void  ReadFinished (void);

  // CVehicleObject methods
  virtual bool              isUserVehicle (void);
  virtual CCameraManager*   GetCameraManager (void);
  virtual CCockpitManager*  GetCockpitManager (void);
  virtual Tag               GetPanel (void) { return 0; }
  virtual void              SetPanel (Tag tag) {}
  virtual void              DrawPanel () {}

protected:
  bool  user;     // Is this the user vehicle?
  Tag   vmode;    // View mode (ID of default camera)
};


//
// The CGroundVehicleObject object is ...
//   <wobj> signature of TYPE_FLY_GROUNDVEHICLEOBJECT
//
// Stream file declaration:
//    <wobj>
//    gveh
//    <bgno>
//    <endo>
//
class CGroundVehicleObject : public CVehicleObject {
public:
  // Constructors / destructor
  CGroundVehicleObject (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);
};


//
// The CAirplane object represents a fixed-wing aircraft
//   with <wobj> signature of TYPE_FLY_AIRPLANE
//
// Stream file declaration:
//    <wobj>
//    plan
//    <bgno>
//    <endo>
//
class CAirplaneObject : public CVehicleObject {
public:
  // Constructors / destructor
  CAirplaneObject (void);
  virtual ~CAirplaneObject (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);
  virtual void  ReadFinished (void);

  // CWorldObject methods
//  virtual void              SetPosition (SPosition pos);

  // CVehicleObject methods
  virtual CCameraManager*   GetCameraManager (void);
  virtual CCockpitManager*  GetCockpitManager (void);
  virtual Tag               GetPanel (void);
  virtual void              SetPanel (Tag tag);
  virtual void              DrawPanel ();

public:
  char        nfoFilename[64];
  CAirplane   *pAirplane;
};


//
// The CHelicopter object represents a rotary-wing aircraft
//   with <wobj> signature of TYPE_FLY_HELICOPTER
//
// Stream file declaration:
//    <wobj>
//    heli
//    <bgno>
//    <endo>
//
class CHelicopterObject : public CVehicleObject {
public:
  // Constructors / destructor
  CHelicopterObject (void);
  virtual ~CHelicopterObject (void);

  // CStreamObject methods
  virtual int   Read (SStream *stream, Tag tag);

  // CVehicleObject methods

protected:
  char      nfoFilename[64];
  CHelicopter   *pHelicopter;
};

#endif // WORLDOBJECTS_H

Documentation generated by