terrainIntersectorRecord.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: terrainIntersectorRec.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/
#ifndef terrainIntersectorRecord_H_
#define terrainIntersectorRecord_H_

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include "terrainDbFactory/metafileRecord.h"

#include <map>

class DtTerrainIntersectorDescriptor;
class DtTerrainIntersectorRecord;

// This factory will map descriptor types to record creators.  Each creator
// will be able to fully populate a descriptor from the descriptor record

typedef DtTerrainIntersectorRecord* (*DtTerrainIntDescCreatorFcn)(const DtTerrainIntersectorDescriptor*);
typedef std::map<int, DtTerrainIntDescCreatorFcn> DtTerrainIntDescCreatorMap;

class DT_DLL_terrainDbFactory DtTerrainIntersectorDescriptorFactory
{
public:
   // Constructor will add default descriptors
   DtTerrainIntersectorDescriptorFactory();

   DtTerrainIntersectorRecord* createRecordFromDescriptor(const DtTerrainIntersectorDescriptor*);
   void addCreator(int, DtTerrainIntDescCreatorFcn);

protected:

   DtTerrainIntDescCreatorMap myFactory;
};

// This class in and of itself does nothing.  It is used as a base class
// for intersectors that are implemented by the system
class DT_DLL_terrainDbFactory DtTerrainIntersectorRecord : public DtMetafileRecord
{
public:

   // default constructor.
   DtTerrainIntersectorRecord();

   // destructor
   virtual ~DtTerrainIntersectorRecord() override;

   // copy constructor
   DtTerrainIntersectorRecord(const DtTerrainIntersectorRecord& orig);

   // assignment operator
   DtTerrainIntersectorRecord& operator=(const DtTerrainIntersectorRecord& rhs);

   // Returns "DtNoTerrainIntersectorRecordString".
   virtual DtString recordTypeName() const override;
   virtual DtConfigCategoryType recordCategory() const override;

   virtual int terrainIntersectorType() const = 0;
   virtual DtTerrainIntersectorRecord* clone() const = 0;
   virtual DtTerrainIntersectorDescriptor* createIntersectorDescriptor() const = 0;

   static DtTerrainIntersectorDescriptorFactory* factory();

protected:
   static DtTerrainIntersectorDescriptorFactory gTerrainRecordDescriptorFactory;;
};

class DT_DLL_terrainDbFactory DtNativeIntersectorRecord : public DtTerrainIntersectorRecord
{
public:

   // default constructor.
   DtNativeIntersectorRecord();

   // destructor
   virtual ~DtNativeIntersectorRecord() override;

   // copy constructor
   DtNativeIntersectorRecord(const DtNativeIntersectorRecord& orig);

   // assignment operator
   DtNativeIntersectorRecord& operator=(const DtNativeIntersectorRecord& rhs);

   // Returns "DtNativeTerrainIntersectorRecordString".
   virtual DtString recordTypeName() const override;
   virtual DtConfigCategoryType recordCategory() const override;

   virtual int terrainIntersectorType() const override;

   static DtMetafileRecord* create();
   static DtTerrainIntersectorRecord* createFromDescriptor(const DtTerrainIntersectorDescriptor*);

   virtual DtTerrainIntersectorRecord *clone() const override;
   virtual DtTerrainIntersectorDescriptor *
   createIntersectorDescriptor() const override;
};

class DT_DLL_terrainDbFactory DtSpatialSubdivisionIntersectorRecord : public DtTerrainIntersectorRecord
{
public:

   // default constructor.
   DtSpatialSubdivisionIntersectorRecord();

   // destructor
   virtual ~DtSpatialSubdivisionIntersectorRecord() override;

   // copy constructor
   DtSpatialSubdivisionIntersectorRecord(const DtSpatialSubdivisionIntersectorRecord& orig);

   // assignment operator
   DtSpatialSubdivisionIntersectorRecord& operator=(const DtSpatialSubdivisionIntersectorRecord& rhs);

   // Returns "DtNoTerrainIntersectorRecordString".
   virtual DtString recordTypeName() const override;
   virtual DtConfigCategoryType recordCategory() const override;

   virtual int terrainIntersectorType() const override;

   virtual void setSpatialSubdivisionCells(int x = 100, int y = 100, int z = 100);
   virtual void spatialSubdivisionCells(int& x, int& y, int &z);

   static DtMetafileRecord* create();
   static DtTerrainIntersectorRecord* createFromDescriptor(const DtTerrainIntersectorDescriptor*);

   virtual DtTerrainIntersectorRecord *clone() const override;

   // identifies a token or passes it to the parent class.
   virtual bool processToken(std::istream &stream, DtString &token) override;
   virtual DtTerrainIntersectorDescriptor *
   createIntersectorDescriptor() const override;

protected:

   // Write self to stream.
   virtual bool writeAttributes(std::ostream &stream) const override;
   virtual bool getAttribute(const DtString attrName, DtString &value,
                             unsigned index = 0) override;
   virtual bool setToken(const DtString &token, const DtString value) override;

protected:
   int myX;
   int myY;
   int myZ;
};

class DT_DLL_terrainDbFactory DtOpcodeIntersectorRecord : public DtTerrainIntersectorRecord
{
public:

   // default constructor.
   DtOpcodeIntersectorRecord();

   // destructor
   virtual ~DtOpcodeIntersectorRecord() override;

   // copy constructor
   DtOpcodeIntersectorRecord(const DtOpcodeIntersectorRecord& orig);

   // assignment operator
   DtOpcodeIntersectorRecord& operator=(const DtOpcodeIntersectorRecord& rhs);

   // Returns "DtNoTerrainIntersectorRecordString".
   virtual DtString recordTypeName() const override;
   virtual DtConfigCategoryType recordCategory() const override;

   virtual int terrainIntersectorType() const override;

   static DtMetafileRecord* create();
   static DtTerrainIntersectorRecord* createFromDescriptor(const DtTerrainIntersectorDescriptor*);

   virtual DtTerrainIntersectorRecord *clone() const override;
   virtual DtTerrainIntersectorDescriptor *
   createIntersectorDescriptor() const override;
};

inline DtTerrainIntersectorDescriptorFactory* DtTerrainIntersectorRecord::factory()
{
   return &gTerrainRecordDescriptorFactory;
}

#endif