entityStateRepository.h

Go to the documentation of this file.

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


#pragma once

#include <vl/baseEntityStateRepository.h>
#include <vl/diGuyObjectStateRepository.h>
#include <vl/entityAssociationVPRecord.h>
#include <vl/vectoringNozzleSystem.h>
#include <vl/entityTypeVPRecord.h>
#include <vl/separationVPRecord.h>
#include <vl/propulsionSystem.h>

#include <vlpi/articulatedPartCollection.h>
#include <vlpi/attachedPartCollection.h>
#include <vlpi/patchIdentifier.h>

#include <iosfwd>

class DT_DLL_VL DtEntityStateRepository : public DtBaseEntityStateRepository
{
public:

   static DtEntityStateRepository* create();

   DtEntityStateRepository();

   DtEntityStateRepository( const DtEntityStateRepository& orig );

   virtual ~DtEntityStateRepository();

   DtEntityStateRepository& operator = ( const DtEntityStateRepository& orig );

   virtual DtStateRepository* clone( bool copy = false ) const;

   virtual void setForceId( DtForceType force );
   virtual DtForceType forceId() const;

   virtual void setGuise( const DtEntityType& type );
   virtual const DtEntityType& guise() const;

   virtual void setMarkingCharSet( int charSet );
   virtual int markingCharSet() const;

   virtual void setMarkingText( const char* text );
   virtual const char* markingText() const;


   virtual void setAppearance( DtU32 app );
   virtual DtU32 appearance() const;

   virtual void setAppearanceAttribute( const DtAppearAttribute attr,
      const DtAppearAttrVal val );
   virtual DtAppearAttrVal appearanceAttribute( const DtAppearAttribute attr ) const;

   virtual void setFrozen( bool onOff );
   virtual bool frozen() const;

   virtual void setPowerPlantOn( bool onOff );
   virtual bool powerPlantOn() const;

   virtual void setDamageState( DtDamageState s );
   virtual DtDamageState damageState() const;

   virtual void setEngineSmokeOn( bool onOff );
   virtual bool engineSmokeOn() const;

   virtual void setFlamesPresent( bool onOff );
   virtual bool flamesPresent() const;

   virtual void setHasFuelSupplyCap( bool onOff );
   virtual bool hasFuelSupplyCap() const;

   virtual void setHasRecoveryCap( bool onOff );
   virtual bool hasRecoveryCap() const;

   virtual void setHasRepairCap( bool onOff );
   virtual bool hasRepairCap() const;

   virtual void setHatchState( DtHatchState s );
   virtual DtHatchState hatchState() const;

   virtual void setImmobilized( bool onOff );
   virtual bool immobilized() const;

   virtual void setLifeformState( DtLifeformState s );
   virtual DtLifeformState lifeformState() const;

   virtual void setLightState( DtLightType s, bool onOff );
   virtual bool lightState( DtLightType s ) const;

   virtual void setLightState( DtLightState s );
   virtual DtLightState lightState() const;

   virtual void setDensity( DtDensityType dens );
   virtual DtDensityType density() const;

   virtual void setRampDeployed( bool onOff );
   virtual bool rampDeployed() const;

   virtual void setSmokePlumePresent( bool onOff );
   virtual bool smokePlumePresent() const;

   virtual void setTentDeployed( bool onOff );
   virtual bool tentDeployed() const;

   virtual void setTrailState( DtTrailState s );
   virtual DtTrailState trailState() const;

   virtual void setCamouflageType( DtCamouflageType type );
   virtual DtCamouflageType camouflageType() const;

   virtual void setFirePowerDisabled( bool onOff );
   virtual bool firePowerDisabled() const;

   virtual void setIsConcealed( bool onOff );
   virtual bool isConcealed() const;

   virtual void setAfterburnerOn( bool onOff );
   virtual bool afterburnerOn() const;

   virtual void setHasAmmunitionSupplyCap( bool onOff );
   virtual bool hasAmmunitionSupplyCap() const;

   virtual void setLauncherRaised( bool onOff );
   virtual bool launcherRaised() const;

   virtual void setLauncherFlashPresent( bool onOff );
   virtual bool launcherFlashPresent() const;

   virtual void setPrimaryWeaponState( DtWeaponState s );
   virtual DtWeaponState primaryWeaponState() const;

   virtual void setSecondaryWeaponState( DtWeaponState s );
   virtual DtWeaponState secondaryWeaponState() const;

   virtual void setComplianceState( DtComplianceState s );
   virtual DtComplianceState complianceState() const;

   virtual void setAntennaRaised( bool upDown );
   virtual bool antennaRaised() const;

   virtual void setMissionKill( bool yesNo );
   virtual bool missionKill() const;

   virtual void setInternalHeatSource( bool onOff );
   virtual bool internalHeatSource() const;

   virtual void setMaskedCloaked( bool onOff );
   virtual bool maskedCloaked() const;



   virtual const DtArticulatedPartCollection* artPartList() const;
   virtual DtArticulatedPartCollection* artPartList();



   virtual const DtAttachedPartCollection* attPartList() const;
   virtual DtAttachedPartCollection* attPartList();


#ifdef DtDIS


   virtual const std::vector<DtVPRecord*>* variableParameterList() const;
   virtual std::vector<DtVPRecord*>* variableParameterList();


#endif

   virtual void setInfraRedSigRepIndex( DtU16 value );
   virtual DtU16 infraRedSigRepIndex() const;

   virtual void setAcousticSigRepIndex( DtU16 value );
   virtual DtU16 acousticSigRepIndex() const;

   virtual void setRadarSigRepIndex( DtU16 value );
   virtual DtU16 radarSigRepIndex() const;

   virtual void setCapabilities( DtU32 cap );
   virtual DtU32 capabilities() const;

   virtual void setMeasuredSpeed( DtU16 value );
   virtual DtU16 measuredSpeed() const;

   void setNumPropulsionSystems( DtU16 value );
   DtU16 numPropulsionSystems() const;

   void setNumNozzleSystems( DtU16 value );
   DtU16 numNozzleSystems() const;

   bool setPropulsionSystem( int index, const DtPropulsionSystem& record );
   bool getPropulsionSystem( int index, DtPropulsionSystem& record ) const;

   bool setNozzleSystem( int index, const DtVectoringNozzleSystem& record );
   bool getNozzleSystem( int index, DtVectoringNozzleSystem& record ) const;

   virtual void setClock( DtClock* clock );


   virtual void setEntityId( const DtEntityIdentifier& id );

   virtual void setDiGuyStateRepository( DtDIGuyObjectStateRepository* diGuyStateRep );
   virtual const DtDIGuyObjectStateRepository* diGuyStateRepository() const;
   virtual DtDIGuyObjectStateRepository* diGuyStateRepository();

   virtual void enableDiGuyObject(bool enable = true);

   virtual bool isEnabledDiGuyObject();

   virtual void setDiGuyAppearance( const DtString& val );
   virtual const DtString& diGuyAppearance() const;

   virtual void setDiGuyArc( const std::vector<char>& val );
   virtual const std::vector<char>& diGuyArc() const;

   virtual void setDiGuyParent( const DtEntityIdentifier& val );
   virtual const DtEntityIdentifier& diGuyParent() const;

   virtual void setDiGuyType( const DtString& newDiGuyType,
      const DtString& newDiGuyAppearance );
   virtual void setDiGuyType( const DtString& val );
   virtual const DtString& diGuyType() const;

   virtual void setDiGuyBodyAppearance( const DtString& val );
   virtual const DtString& diGuyBodyAppearance() const;

   virtual void setDiGuyBodyWeight( double val );
   virtual double diGuyBodyWeight() const;

   virtual void setDiGuyHeadAppearance( const DtString& val );
   virtual const DtString& diGuyHeadAppearance() const;

   virtual void setDiGuyItemAppearance( const DtString& val );
   virtual const DtString& diGuyItemAppearance() const;

   virtual bool setDiGuyAccessoryAppearance( unsigned int index, const DtString& val );
   virtual const DtString& diGuyAccessoryAppearance( unsigned int index ) const;

   virtual void setDiGuyAccessoryAppearanceCount( unsigned int index );
   virtual unsigned int diGuyAccessoryAppearanceCount() const;

   virtual void setDiGuyAction( const DtString& val );

   virtual void setDiGuyAction(const DtString& val, bool paused, double speed = 0.0,
      bool useActionPositioning = false, const DtVector& offset = DtVector(0, 0, 0), double transitionSpeed = 1.0);

   virtual const DtString& diGuyAction() const;
   virtual const DtString& diGuyAction( bool& paused ) const;

   virtual void setDiGuyActionPaused( bool paused );
   virtual bool isDiGuyActionPaused() const;

   virtual void setDiGuyActionSpeed( double speed );
   virtual double diGuyActionSpeed() const;

   virtual void setDiGuyVisible( bool visibile );
   virtual bool isDiGuyVisible() const;

   virtual void setDiGuyCharacterScale( const DtVector& scale );
   virtual const DtVector& diGuyCharacterScale() const;


   virtual void addDiGuyShapeVariation( unsigned int linkIndex, unsigned int shapeIndex, const DtDiGuyPixelData& pixelData );
   virtual void removeDiGuyShapeVariation( unsigned int linkIndex, unsigned int shapeIndex );
   virtual const DtDiGuyPixelData& diGuyShapeVariation( unsigned int linkIndex, unsigned int shapeIndex, bool& dataIsValid ) const;
   virtual bool getDiGuyShapeVariation( unsigned int linkIndex, unsigned int shapeIndex, DtDiGuyPixelData& pixelData ) const;
   virtual void setDiGuyShapeVariations( const DtDiGuyLinkShapeMap& shapeVariations );
   virtual const DtDiGuyLinkShapeMap& diGuyShapeVariations() const;



   virtual void setDiGuyUnit( const DtPatchIdentifier& patchId );
   virtual const DtPatchIdentifier& diGuyUnit() const;

   virtual void setDiGuyPersonalUnit( const DtPatchIdentifier& patchId );
   virtual const DtPatchIdentifier& diGuyPersonalUnit() const;

   virtual void setDiGuyRank( const DtPatchIdentifier& patchId );
   virtual const DtPatchIdentifier& diGuyRank() const;

   virtual void setDiGuyName( const DtString& val );
   virtual const DtString& diGuyName() const;



   virtual void printData() const;

   virtual void printDataToStream( std::ostream& stream ) const;

protected:

   DtEntityStateRepository* self() const;

   void internalSetMarkingText( const char* text );

   virtual void createDiGuyStateRep();

protected:

   DtArticulatedPartCollection myArtPartList;
   DtAttachedPartCollection myAttPartList;

#ifdef DtDIS
   std::vector<DtVPRecord*> myVPRecordCollection;
#endif

   DtForceType myForceId;
   DtEntityType myGuise;
   DtU32 myAppearance;
   int myMarkingCharSet;
   DtString myMarkingText;
   DtU32 myCapabilities;
   DtU16 myLiveEntityMeasuredSpeed;

   DtU16 myAcousticsSignatureIndex;
   DtU16 myInfaredSignatureIndex;
   DtU16 myRadarCrossSectionSignatureIndex;

   int myNumPropulsionSystemsData;
   int myNumVectoringNozzleSystemData;
   DtPropulsionSystem *myPropulsionSystemsDataList;
   DtVectoringNozzleSystem *myVectoringNozzleSystemDataList;

   std::vector<char> myDiGuyArc;
   DtEntityIdentifier myDiGuyParent;
   DtDIGuyObjectStateRepository* myDiGuyStateRep;
   bool myUseDiGuyObject;

};


inline void DtEntityStateRepository::setForceId( DtForceType force )
{
   myForceId = force;
}

inline DtForceType DtEntityStateRepository::forceId() const
{
   return myForceId;
}

inline void DtEntityStateRepository::setGuise( const DtEntityType& type )
{
   myGuise = type;
}

inline const DtEntityType& DtEntityStateRepository::guise() const
{
   return myGuise;
}

inline void DtEntityStateRepository::setMarkingCharSet( int charSet )
{
   myMarkingCharSet = charSet;
}

inline int DtEntityStateRepository::markingCharSet() const
{
   return myMarkingCharSet;
}

inline void DtEntityStateRepository::setMarkingText( const char* a_text )
{
   internalSetMarkingText( a_text );
}

inline const char* DtEntityStateRepository::markingText() const
{
   return myMarkingText.c_str();
}

inline const DtArticulatedPartCollection* DtEntityStateRepository::artPartList() const
{
   return &myArtPartList;
}

inline DtArticulatedPartCollection* DtEntityStateRepository::artPartList()
{
   return &myArtPartList;
}

inline const DtAttachedPartCollection* DtEntityStateRepository::attPartList() const
{
   return &myAttPartList;
}

inline DtAttachedPartCollection* DtEntityStateRepository::attPartList()
{
   return &myAttPartList;
}

#ifdef DtDIS

inline const std::vector<DtVPRecord*>* DtEntityStateRepository::variableParameterList() const
{
   return &myVPRecordCollection;
}

inline std::vector<DtVPRecord*>* DtEntityStateRepository::variableParameterList()
{
   return &myVPRecordCollection;
}

#endif

inline void DtEntityStateRepository::setInfraRedSigRepIndex( DtU16 value )
{
   myInfaredSignatureIndex = value;
}

inline DtU16 DtEntityStateRepository::infraRedSigRepIndex() const
{
   return myInfaredSignatureIndex;
}

inline void DtEntityStateRepository::setAcousticSigRepIndex( DtU16 value )
{
   myAcousticsSignatureIndex = value;
}

inline DtU16 DtEntityStateRepository::acousticSigRepIndex() const
{
   return myAcousticsSignatureIndex;
}

inline void DtEntityStateRepository::setRadarSigRepIndex( DtU16 value )
{
   myRadarCrossSectionSignatureIndex = value;
}

inline DtU16 DtEntityStateRepository::radarSigRepIndex() const
{
   return myRadarCrossSectionSignatureIndex;
}

inline void DtEntityStateRepository::setCapabilities( DtU32 cap )
{
   myCapabilities = cap;
}

inline DtU32 DtEntityStateRepository::capabilities() const
{
   return myCapabilities;
}

inline void DtEntityStateRepository::setMeasuredSpeed( DtU16 value )
{
   myLiveEntityMeasuredSpeed = value;
}

inline DtU16 DtEntityStateRepository::measuredSpeed() const
{
   return myLiveEntityMeasuredSpeed;
}

inline DtEntityStateRepository* DtEntityStateRepository::self() const
{
   return (DtEntityStateRepository*)this;
}

inline void DtEntityStateRepository::internalSetMarkingText( const char* a_text )
{
   myMarkingText = a_text;
}