DtTreeRecord.h

Go to the documentation of this file.

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


#ifndef DtTreeRecord_H_ 
#define DtTreeRecord_H_ 

#include <vrvCore/vrvCore.h> 
#include <vrvCore/DtUniqueID.h>

#include <matrix/vlVector.h>
#include <matrix/vlQuaternion.h>

#include <string>

#include <vrvGraphicsUtils/DtMath.h>


namespace makVrv 
{ 
   class DtMessage;

   class DT_DLL_VRVCORE DtTreeRecord 
   { 

   public:

      DtTreeRecord();

      DtTreeRecord(DtUniqueID id, const DtVector& pos, const std::string& modelDefinitionName);

      DtTreeRecord(const DtTreeRecord& orig);

      DtTreeRecord& operator=(const DtTreeRecord& orig);

      bool operator==(const DtTreeRecord& other) const;

      bool operator<(const DtTreeRecord& other) const;

      virtual ~DtTreeRecord();

      virtual void setUniqueId(DtUniqueID id);

      virtual DtUniqueID uniqueId() const;

      void setCellID(DtUniqueID id);

      DtUniqueID cellId(void) const;

      virtual void setPostion(const DtVector& pos);

      virtual const DtVector& position() const;

      virtual void setModelDefinition(const std::string& modelDef);

      virtual const std::string& modelDefinition() const;

      virtual void setScale(float fScale);
      virtual float scale(void) const;

      virtual void setOrientationDegrees(const DtDegrees& orientation);
      virtual DtDegrees orientationDegrees(void) const;

      // Get a deterministic randomized scale (between fMinScale and 
      // fMaxScale based upon unique id
      static void getRandomizedScale(float& fScale, float fMinScale, 
         float fMaxScale, DtUniqueID id);

      // Get a deterministic randomized orientation based upon unique id
      static void getRandomizedOrientation(DtDegrees& orientation, 
         DtUniqueID id);

      // Get the type of the tree resulted from the osg nodes extraction process
      virtual const std::string& treeType() const;
      // Set the type of the tree resulted from the osg nodes extraction process
      virtual void setTreeType(const std::string& val);

      // VR-Vantage does not use these quaternion forms anywhere, but they are used by VR-Forces,
      // so please do not remove them. TDL

      // Get the orientation of the tree represented as a quaternion
      virtual const DtQuaternion& orientation() const;

      // Set the orientation of the tree represented as a quaternion
      virtual void setOrientation(const DtQuaternion& val);

   protected:

      void copyHelper(const DtTreeRecord& orig);

   protected:

      DtUniqueID myUniqueId;

      // An optional id to associate a tree record with a 'cell'
      // Can be used to map trees to cells/pages/etc
      DtUniqueID myCellId;

      DtVector myPosition;
      std::string myModelDefinition;
      float myScale;
      DtDegrees myOrientationDegrees;

      // this attribute is set only for Props purpose 
      std::string myTreeType;

      DtQuaternion myOrientation;


      //Rev 153241 in svn has #if'd out code for using the boost randomizer here. Might improve randomness at a possible performance cost
      
   }; 

   typedef std::vector<DtTreeRecord*> DtVectorTreeRecords;

   DT_DLL_VRVCORE DtMessage& operator<<( DtMessage& msg,const DtTreeRecord& record );

   DT_DLL_VRVCORE DtMessage& operator>>( DtMessage& msg,DtTreeRecord& record );
} 

#endif