scriptVrfObject.h

Go to the documentation of this file.

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

#pragma once

#include <vrfobjcore/vrfobjcoreDefines.h>
#include <vrfobjcore/aggregateLocalObjectFacade.h>
#include <vrfobjcore/vrfSimulatedSimObjectFacade.h>
#include <vrfobjcore/platformSimObjectFacade.h>
#include <vrfobjcore/scriptDetonation.h>

#include "vrfobjcore/simObject.h"
#include <vrfutil/rwUUID.h>
#include <vrfutil/scriptGeometry.h>
#include <string>
#include "vrfutil/asciiSerializable.h"
#include <vrfutil/objectCounter.h>
#include <stdexcept>
#include <vrfutil/rwUUID.h>
#include <tbb/spin_rw_mutex.h>

class DtDetonationContext;
class DtFireContext;
class DtScriptComponentSystem;
class DtSimulationServices;
class DtLocalObject;

class DT_DLL_vrfobjcore DtScriptVrfObject
   : public DtAsciiSerializable
#ifdef DtObjectDebugger_Enable
   , public DtObjectDebugger<DtScriptVrfObject>
#endif
{
public:
   DtScriptVrfObject(const DtSimulationServices*, const DtUUID& name);
   DtScriptVrfObject(DtSimObjectReference);
   DtScriptVrfObject(const DtScriptVrfObject& orig);

   DtScriptVrfObject();

   DtScriptVrfObject& operator=(const DtScriptVrfObject& orig);

   virtual ~DtScriptVrfObject() override;

   bool operator==(const DtScriptVrfObject& orig) const;


   virtual DtScriptVrfObject getAssignedTransport();

   virtual DtLocation3D getLocation3D() const;
   virtual DtLocation3D getLocation3dAllSubordinates(bool bIncludeDestroyedSubordinates) const;

   virtual double getDistanceBehind(DtScriptVrfObject) const;

   virtual double getSpeed() const;

   virtual std::string getUUID() const;

   virtual DtVector3D   getDirection3D() const;

   virtual DtVector3D   getVelocity3D() const;

   virtual std::list<std::string> getFormationNames();

   virtual std::list<int> getFormationPromotionOrder(const std::string& formationName);

   virtual std::list<std::string> formationSubFormations(
      const std::string& formationName);

   virtual double getHeightAboveTerrain(bool& available) const;

   virtual bool hasLosToObject(const DtScriptVrfObject &target,
      bool & dataAvailable) const;

   virtual bool isPointInside(const DtLocation3D &point) const;

   virtual bool independentlyTasked() const;

   virtual bool hasLosToLocation(DtLocation3D &targetLoc,
      bool &dataAvailable) const;

   virtual std::string getEntityType() const;

   virtual bool isAggregate() const;

   virtual bool isPseudoAggregate() const;

   virtual std::string getEchelonLevel() const;

   virtual std::string getForceType() const;

   virtual int getForceEnumeration() const;

   virtual std::string getDamageState() const;

   virtual unsigned getLifeformPosture() const;

   virtual unsigned getAppearance() const;

   virtual bool isDestroyed() const;

   virtual bool isFirePowerKilled() const;

   virtual bool isMobilityKilled() const;

   virtual bool isSensorKilled() const;

   virtual bool isInvisible() const;

   virtual bool isEmbarked() const;

   virtual bool isOnTopOf(DtScriptVrfObject&) const;
   virtual bool isOnTopOfWithDistance(DtScriptVrfObject&, double) const;

   virtual DtScriptVrfObject getEmbarkedOn() const;

   virtual std::list<DtScriptVrfObject> getEmbarkedObjects(void)const;

   virtual DtVectorOffset3D getOffsetFromParent() const;

   virtual DtVectorOffset3D getOffsetOfLocation(const DtLocation3D& location) const;

   virtual std::list<DtScriptVrfObject> getSubordinates(void) const;

   virtual std::list<DtScriptVrfObject> getVrfSubordinates(bool isVrf) const;

   virtual DtScriptVrfObject getSuperior() const;

   virtual double getGroundAltitude(bool& isWater, bool& dataAvailable);

   virtual double recalculatePhysicalFootprintFromSubordinates(const std::list<DtScriptVrfObject>&) const;

   virtual DtVectorOffset3D getPartParentPosition(int) const;
   virtual DtLocation3D getPartWorldPosition(int) const;
   virtual double getPartPitch(int) const;
   virtual double getPartPitchIncludingParent(int, bool includeParent = false) const;
   virtual double getPartHeading(int) const;
   virtual double getPartHeadingIncludingParent(int, bool includeParent = false) const;
   virtual double getPartTranslationForward(int) const;
   virtual double getPartTranslationRight(int) const;
   virtual double getPartTranslationUp(int) const;
   virtual double getPartExtension(int) const;

   virtual std::list<DtScriptVrfObject> getAllSubordinates(void) const;

   virtual std::list<DtScriptVrfObject> getAllVrfSubordinates(bool isVrf) const;

   virtual std::list<DtScriptVrfObject> getCapableSubordinates(void) const;
   virtual std::list<DtScriptVrfObject> getCapableVrfSubordinates(bool isVrf) const;

   virtual std::list<DtScriptVrfObject> getAllCapableSubordinates(void) const;
   virtual std::list<DtScriptVrfObject> getAllCapableVrfSubordinates(bool isVrf) const;

   virtual bool isVrfSimulated() const;

   virtual std::list<DtLocation3D> getLocations3D(void)const;

   virtual std::string  getName() const;
   virtual std::string  getLabel() const;
   virtual std::string  getExtendedLabel(int) const;

   virtual int  getAirTurbulence() const;

   virtual std::string getGlobalId() const;
   virtual std::string getObjectId() const;

   virtual double getHeading() const;
   virtual double getPitch() const;
   virtual double getRoll() const;

   virtual double getDraft() const;

   void terrainSurfaceDebug();

   void deleteObject();

   bool isDeleted() const;
   virtual bool isValid() const;

   virtual bool isLocal() const;

   virtual DtVectorOffset3D getBoundingVolume(DtVectorOffset3D& offset) const;

   virtual DtVectorOffset3D getBoundingVolumeAllSubordinates(bool bIncludeDestroyedSubordinates, DtVectorOffset3D& offset) const;

   virtual std::string getNbcDamage(int& dmgPerSec, int& moppLvl) const;

   virtual std::string getNbcAgent() const;

   virtual bool isBreached() const;

   virtual std::string getExtendedData(const std::string& key) const;

   virtual DtLocation3D getClosestPointToLocation2D(const DtLocation3D& location,
      double& distance)  const;

   virtual DtLocation3D getIntersectionPointWithLine2D( const DtLocation3D& point1,
      const DtLocation3D& point2, bool& hasIntersection ) const;

   virtual std::string getCallsign() const;

   virtual bool isActive() const;

   virtual bool hasStateProperty(const std::string& propertyName);
   virtual bool hasParameterProperty( const std::string& propertyName );

   virtual std::string getDiGuyHandItem() const;


   std::string diguyCharacterType() const;

   virtual bool isAnimationAvailable( const std::string& animationName ) const;

   virtual bool isCompatibleAnimationAvailable( const std::string& animationName ) const;

   virtual bool isCharacterAnimationAvailable( const std::string& animationName, bool checkCompatible ) const;

   //\return True if the specified DI-Guy appearance name is available for this object.
   virtual bool isAppearanceAvailable( const std::string& appearanceName ) const;

   //\return True if the specified DI-Guy hand item name is available for this object.
   virtual bool isHandItemAvailable( const std::string& handItemName ) const;

   //\return True if the specified DI-Guy head name is available for this object.
   virtual bool isHeadAvailable( const std::string& headName ) const;

   //\return True if the specified DI-Guy gesture name is available for this object.
   virtual bool isGestureAvailable( const std::string& gestureName ) const;

   //\return The time of animation to run (in seconds).  If not available will return 0
   virtual double animationDuration( const std::string& animationName ) const;

   //\return The speed of animation.  If not available will return 0
   virtual double animationSpeed( const std::string& animationName ) const;

   //\return The duration of the transition motion from the first animation to the second,
   virtual double getAnimationTransitionInfo( const std::string& fromAnimation, const std::string& toAnimation,
      DtVectorOffset3D& deltaPos, double& deltaHeading ) const;


   virtual void setSimulationServices(const DtSimulationServices* simManager);

   virtual DtString objectType() const override;

   virtual DtString serialize() override;

   virtual bool deserialize(const DtString& data) override;

   static DtAsciiSerializable* creator();

   DtSimObjectReference simObjectReference() const { return mySimObjectReference; }

   void testValid() const;

   bool testAggregateSimObjectValid() const;

   static DtScriptVrfObject nullObject()
   {
      return DtScriptVrfObject(0, DtUUID::nullUUID());
   }

   const DtSimulationServices* simulationServices() const;

protected:
   DtRwUUID myUUID;
   const DtSimulationServices* mySimulationServices;
   mutable DtSimObjectReference mySimObjectReference;
   mutable DtVrfSimulatedSimObjectFacade myVrfSimulatedSimObjectFacade;

   mutable DtAggregateSimObjectFacade* myAggregateSimObjectFacade;
   mutable DtPlatformSimObjectFacade myPlatformSimObjectFacade;

public:
   VRF4API_METHOD DtSimObjectReference vrfObject() const { return simObjectReference(); };
};

DT_DEFINE_OBJECT_DEBUGGER_NAME(DtScriptVrfObject);

DT_DLL_vrfobjcore std::ostream& operator<<(std::ostream&, const DtScriptVrfObject&);

class DT_DLL_vrfobjcore DtScriptOwnshipObject
   : public DtScriptVrfObject
#ifdef DtObjectDebugger_Enable
   , public DtObjectDebugger<DtScriptOwnshipObject>
#endif
{
public:
   DtScriptOwnshipObject(DtLocalObject* const localObject);
   DtScriptOwnshipObject(const DtScriptOwnshipObject& orig);
   virtual ~DtScriptOwnshipObject() override;


   void setLocation3D(const DtLocation3D &newloc);
   void setHeading(const double heading);
   void setPitch(const double heading);


   virtual std::string getResourceTypeFromResourceName(std::string resourceName);

   virtual void setLabel(const std::string&);
   virtual void setExtendedLabel(int, const std::string&);
   virtual void setNavigationEnabled(bool);

   DtLocalObject* ownshipObject();
   const DtLocalObject* ownshipObject() const;

   virtual std::list<std::string> getResourceNames(void)const;
   virtual std::list<std::string> getResourceNamesFromBin(int bin)const;

   virtual double getResourceAmounts(const std::string& resourceName, double* fullAmount) const;
   virtual double getResourceAmountsFromBin(const std::string& resourceName, int bin, double* fullAmount) const;

   virtual void depleteResource(const std::string& resourceName, double amount);
   virtual void depleteResourceFromBin(const std::string& resourceName, int bin, double amount);

   virtual void replenishResource(const std::string& resourceName, double amount);
   virtual void replenishResourceFromBin(const std::string& resourceName, int bin, double amount);

   virtual int getNotifyLevel() const;

   virtual std::string getCurrentFormationName();

   virtual DtVectorOffset3D getFormationExtent();

   virtual std::string getMunitionType(const std::string& resourceName);

   virtual bool addResource(const std::string& resourceType, const std::string& resourceName,
      double currentAmount, double fullAmount);
   virtual bool addResourceToBin(const std::string& resourceName,
      double currentAmount, double fullAmount, int bin);

   virtual void updateStateAndParameterProperties();

   virtual void removeResource(const std::string& resourceName);
   virtual void removeResourceFromBin(const std::string& resourceName, int bin);

   virtual double getOrderedSpeed() const;

   virtual bool isUnderFire() const;

   virtual int suppressionLevel() const;

   virtual std::string nonLethalDamageEffect() const;

   virtual std::vector<DtScriptVrfObject> getAllHostileContacts(void) const;

   virtual std::list<DtScriptVrfObject> getAllContacts(void);

   virtual int targetPriority(const DtScriptVrfObject & otherEntity);

   virtual DtScriptVrfObject userTarget();

   virtual DtScriptVrfObject missileTarget();

   virtual bool registerDetonationInterest(double range,
      const std::string& munitionType);

   virtual void setOperationInProgress(int, bool b);

   virtual bool registerFireInterest(double range,
      const std::string& munitionType);

   virtual bool getLastDetonation(std::string& munitionType, DtLocation3D& location);

   virtual void clearLastDetonation();

   virtual bool getLastDetonationInformation(DtScriptDetonation& detonation);

   virtual bool getLastFire(std::string& munitionType, DtLocation3D& location);

   virtual void setDestroyed(bool destroyed);

   virtual std::string getRulesOfEngagement();

   virtual void setRulesOfEngagement(const std::string& rule);

   virtual bool isTargetAllowedByRulesOfEngagement(const DtScriptVrfObject& targetObj);

   virtual bool isInSectorOfResponsibility(const DtScriptVrfObject& targetObj);

   virtual std::list<std::string> embeddedEntityNames();

   virtual std::list<std::string> embeddedEntitiesOfType(std::string typeString);

   virtual std::list<std::string> embeddedEntitiesCapableOf(std::string taskSetName);

   virtual DtScriptVrfObject simObjectByEmbeddedEntityName(std::string eeName);

   virtual std::string embeddedEntityStatus(std::string eeName);

   virtual double normalizedSensorSignature(const DtScriptVrfObject & targetEntity,
      std::string domain);

   virtual void changeAttachment(const std::string& parentUUID );

   virtual void setExtendedData(const std::string& key, const std::string& val);

   virtual bool canFireAt(const DtLocation3D& location);

   virtual std::shared_ptr<DtScriptComponentSystem> lookupSystem(const std::string& systemName);

   virtual std::list<std::string> getSystemNames();

   virtual std::string getSystemCategory(const std::string& systemName);

   virtual bool isCapableOfTask(std::string taskName);



   virtual bool isEmbarked() const override;

   virtual DtScriptVrfObject getEmbarkedOn() const override;

   virtual bool getNavigationEnabled() const;

   virtual void attachToParent(DtScriptVrfObject&) const;

   virtual void clearAssignedTransport() const;
   virtual void setAssignedTransport(DtScriptVrfObject&) const;


   virtual bool hasStateProperty(const std::string& propertyName) override;
   virtual bool hasInternalStateProperty(const std::string& context, const std::string& propertyName);
   virtual bool hasParameterProperty(const std::string& propertyName) override;

   virtual std::list<DtScriptVrfObject> getAllVrfSubordinates(bool isVrf) const override;

   DtSimulationServices* simulationServices() const;

   virtual bool isValid() const override;

protected:

   static bool processDetonation(const DtDetonationContext& detonationContext, void* usr);
   bool processDetonation(const DtDetonationContext& detonationContext);

   static bool processFire(const DtFireContext& fireContext, void* usr);
   bool processFire(const DtFireContext& fireContext);

protected:
   DtScriptDetonation myLastDetonation;

   std::string myLastFireMunition;

   DtLocation3D myLastFireLocation;

   std::map<std::string, DtScriptComponentSystem*> myScriptComponentSystems;

   mutable DtLocalObject* myLocalObject;
};

DT_DEFINE_OBJECT_DEBUGGER_NAME(DtScriptOwnshipObject);