include/vrfobjcore/attachedTerrain.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once


#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rdrWritr.h"
#include "vrfutil/rwObjType.h"
#include <matrix/vlDcm.h>
#include <geometry/intersectionRecord.h>
#include <geometry/point.h>
#include <geometry/chord.h>
#include "vrfobjcore/objectGeometricModel.h"

class Coordinate_System;
class DtVectorNetworkRecord;
class DtVectorNetworkIntersectionRecord;
class DtObjectGeometricModelEntry;
class DtPhysicalWorld;
class DtGdbNode;
class DtTerrainDatabase;
class DtVrfObject;
class DtChordIntersectionRecord;
class DtSurface;
class DtVectorNetwork;

class DT_DLL_vrfobjcore DtAttachedTerrain : public DtReaderWriter
{
public:

   DtAttachedTerrain();

   DtAttachedTerrain(const DtString& name, 
      DtReaderWriterRegistry* const parentRegistry = 0);

   DtAttachedTerrain(const DtSymbolString& name, 
      DtReaderWriterRegistry* const parentRegistry = 0);

   DtAttachedTerrain(const DtString& name, const DtAttachedTerrain& orig, 
                      DtReaderWriterRegistry* const parentRegistry = 0);

   DtAttachedTerrain(const DtSymbolString& name, const DtAttachedTerrain& 
      from, DtReaderWriterRegistry* const parentRegistry = 0);

   virtual ~DtAttachedTerrain();

   DtAttachedTerrain& operator=(const DtAttachedTerrain & orig);
   DtAttachedTerrain& operator=(const DtObjectGeometricModelEntry& orig);

   virtual const char* readerWriterType() const;

   DtAttachedTerrain& operator=(const DtObjectType& type);

public:
   virtual const Coordinate_System* coordinateSystem() const;
   virtual Coordinate_System* coordinateSystem();
   virtual const Coordinate_System* objectModelCoordinateSystem() const;


   virtual double terrainHeight(const DtVector& localLocation, 
      bool* dataAvailable = 0, bool overrideBlockingAssert = false) const;
   virtual bool terrainHeight(const DtVector& localLocation, 
      double& terrainHeight, bool* dataAvailable = 0, 
      bool overrideBlockingAssert = false) const;

   virtual bool terrainHeightAndSurface(const DtVector& localLocation, 
      double& terrainHeight, DtSurface& surface, bool* dataAvailable = 0,
      bool overrideBlockingAssert = false) const;


   virtual bool closestIntersection(const DtVector& localLocation, 
      DtPoint& intersectionPoint, 
      DtVectorNetworkRecord* vectorNetworkRecord = 0, 
      DtVectorNetworkIntersectionRecord* vecNetworkIntersectionRecord = 0,
      bool* dataAvailable = 0, bool overrideBlockingAssert = false) const;

   virtual bool closestIntersection(const DtVector& localLocation, 
      DtVector& intersectionPoint,
      DtVectorNetworkRecord* vectorNetworkRecord = 0, 
      DtVectorNetworkIntersectionRecord* vecNetworkIntersectionRecord = 0,
      bool* dataAvailable = 0, bool overrideBlockingAssert = false) const;

   virtual bool closestIntersection(const DtVector& localLocation, 
      DtChordIntersectionRecord& record,
      DtIntersectionRecord::DtIntersectionType irtFlag = 
      DtIntersectionRecord::INT_ALL_DATA,
      DtVectorNetworkRecord* vectorDatarecord = 0, 
      DtVectorNetworkIntersectionRecord* vectorIntersectionRecord = 0,
      bool* dataAvailable = 0, bool overrideBlockingAssert = false) const;

   virtual bool intersect(const DtChord& chord, DtPoint& intersectionPoint, 
      double& intersectionTime, DtVectorNetworkRecord *record = 0, 
      DtVectorNetworkIntersectionRecord *intersectionRecord = 0,
      bool* dataAvailable = 0, bool overrideBlockingAssert = false) const;
    
   virtual bool intersect(const DtChord& chord, 
      DtChordIntersectionRecord& record,
      DtIntersectionRecord::DtIntersectionType irtFlag = 
      DtIntersectionRecord::INT_ALL_DATA,
      DtVectorNetworkRecord *vectorDatarecord = 0, 
      DtVectorNetworkIntersectionRecord *vectorIntersectionRecord = 0,
      bool* dataAvailable = 0, bool overrideBlockingAssert = false) const;

   virtual bool closestIntersection(const DtVector& curPosition, 
      DtVector& intersection, bool ignoreWater, bool* dataAvailable = 0,
      bool overrideBlockingAssert = false) const;

   virtual const DtVectorNetwork* vectorNetwork() const;

protected:
   bool testInvariant() const;

   virtual double setOriginToDatabase();

   virtual const DtDcm& rotateToDcm() const;
   virtual const DtDcm& rotateBackDcm() const;

   virtual DtVector rotateTerrainLocation(const DtVector& source) const;

   virtual DtChord convertAndRotateChordToLocal(const DtChord& source) const;

   virtual DtPoint convertLocalToSimTerrain(const DtPoint&, double addHeight = 0.) const;

   virtual void convertLocalToSimTerrain(DtChordIntersectionRecord&, double addHeight = 0.) const;

public:
   void setObjectName(const DtString&);
   const DtString objectName() const;

   void setObjectType(const DtObjectType&);
   const DtObjectType& objectType() const;

   void addRef();
   void removeRef();
   int referenceCount() const;

   void setObjectGeometricModel(const DtObjectGeometricModel* newObjGeomModel);
   const DtObjectGeometricModel* objectGeometricModel() const;

   void setEntity(const DtVrfObject*);
   const DtVrfObject* entity() const;

   void setPhysicalWorld(DtPhysicalWorld* newPhysicalWorld);
   DtPhysicalWorld* physicalWorld();
   const DtPhysicalWorld* physicalWorld() const;

   void clear();

   virtual DtAttachedTerrain* clone(const DtString& name, DtReaderWriterRegistry* const parentRegistry = 0) const;

protected:
   DtRwString                 myObjectName;
   DtRwObjectType             myObjectType;
   int                        myReferenceCount;

   const DtObjectGeometricModel*   myObjectGeometricModel;

   const DtVrfObject*         myEntity;

   DtPhysicalWorld*           myPhysicalWorld;

   mutable DtTaitBryan        myLastEntityOrientation;
   mutable DtDcm              myRotateToDcm;
   mutable DtDcm              myRotateBackDcm;
};