vrfMovingObjectStateRepository.h

Go to the documentation of this file.

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


#pragma once

#include <vrfobjcore/vrfobjcoreDefines.h>
#include <vrfobjcore/vrfObjectStateRepository.h>
#include <vrfutil/actionUrgencyLevel.h>

class DtMovingObjectParameters;
class DtRwDIGuyCharacterState;
class DtPatchIdentifier;

class DT_DLL_vrfobjcore DtVrfMovingObjectStateRepository : public DtVrfObjectStateRepository
{
private:

   DtVrfMovingObjectStateRepository( const DtVrfMovingObjectStateRepository& orig );

   DtVrfMovingObjectStateRepository& operator = ( const DtVrfMovingObjectStateRepository& orig );

public:

   DtVrfMovingObjectStateRepository( DtLocalObject* vrfObject,
      const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0 );

   virtual ~DtVrfMovingObjectStateRepository() override;

   static DtVrfObjectStateRepository* creator( const DtString& name,
      DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry );

   virtual void tick() override;

   virtual DtString type() const override;

   virtual const int vrfObjectStateRepositorySubType() const override;

   virtual const int vrfMovingObjectStateRepositorySubType() const;

   virtual void initializeFromParameters() override;

   const DtMovingObjectParameters* movingObjectParameters() const;

   virtual bool canPivot() const;
   virtual void setCanPivot( const bool canPivot );

   virtual DtReal maxPivotSpeed() const;
   virtual void setMaxPivotSpeed( DtReal maxPivotSpeed );

   virtual const DtGroundInteractionPt* rightSupport() const;
   virtual DtGroundInteractionPt* rightSupport();
   virtual void setRightSupport( const DtVector& vec );

   virtual const DtGroundInteractionPt* leftSupport() const;
   virtual DtGroundInteractionPt* leftSupport();
   virtual void setLeftSupport( const DtVector& vec );

   virtual const DtGroundInteractionPt* otherSupport() const;
   virtual DtGroundInteractionPt* otherSupport();
   virtual void setOtherSupport( const DtVector& vec );

   virtual DtReal maxSpeed() const;
   virtual void setMaxSpeed( const DtReal speed );

   virtual DtReal maxReverseSpeed() const;
   virtual void setMaxReverseSpeed( const DtReal speed );

   virtual DtReal turningRadius() const;
   virtual void setTurningRadius( const DtReal turningRadius );

   virtual DtReal maxSlope() const;
   virtual void setMaxSlope( const DtReal slope );


   virtual const DtVector& localEstimatedPositionError() const;
   virtual void setLocalEstimatedPositionError(const DtVector& localEstimatedPositionError);


   virtual const DtVector localEstimatedPosition() const;
   virtual const DtVector worldEstimatedPosition() const;


   virtual DtReal orderedSpeed() const;
   virtual void setOrderedSpeed(const DtReal speed);

   virtual DtReal orderedSpeedConstrained() const;

   virtual void setOrderedHeading(const DtReal heading);
   virtual DtReal orderedHeading() const;

   virtual DtReal maneuverAggressiveness() const;
   virtual void setManeuverAggressiveness(const DtReal fraction);

   virtual DtActionUrgencyLevel actionUrgency() const;
   virtual void setActionUrgency( DtActionUrgencyLevel urgency );

   virtual void setCurrentPitch( double );

   virtual DtReal orderedAltitude() const;
   virtual void setOrderedAltitude( const DtReal orderedAltitude );
   virtual bool orderedAltitudeSpecified() const;
   virtual void setOrderedAltitudeSpecified( bool );
   virtual bool useOrderedAltitudeForRoutes() const;
   virtual void setUseOrderedAltitureForRoutes( bool c );

   virtual DtReal maxAcceleration() const;
   virtual void setMaxAcceleration( const DtReal maxAcceleration );

   virtual DtReal maxStoppingDeceleration() const;
   virtual void setMaxStoppingDeceleration( const DtReal maxStoppingDeceleration );

   virtual DtReal maxLateralAcceleration() const;
   virtual void setMaxLateralAcceleration( const DtReal maxLateralAcceleration );

   virtual DtReal inverseStoppingDeceleration() const;

   virtual bool haveSupplies() const;
   virtual void setHaveSupplies( const bool doHave );

   virtual double nextSupplyCheckTime() const;
   virtual void setNextSupplyCheckTime( const double time );

   virtual bool forward() const;
   virtual void setForward( const bool forward );

   virtual bool amClampedToGround() const;
   virtual void setAmClampedToGround( const bool clamp );

   virtual void reclampToGround() override;

   virtual bool usingRailMovement() const;
   virtual void setUsingRailMovement(const bool rails);

   virtual void clampToGround( const DtVector& location, const DtReal heading,
      bool* dataAvailable = 0, bool requireAllData = false );

   virtual void clampToGround( const DtVector& location, const DtReal heading,
      bool gravityAligned, bool* dataAvailable = 0, bool requireAllData = false );

   virtual void updateSupportPoints(const DtVector& newPosition, const DtReal newHeading) override;

   virtual void place(const DtVector& location, bool* dataAvailable = 0, bool requireAllData = false) override;

   virtual void place(const DtReal heading, bool* dataAvailable = 0, bool requireAllData = false) override;

   virtual void place(const DtVector& location, const DtReal heading, bool clampToGroundFlag = true,
      bool* dataAvailable = 0, bool requireAllData = false) override;

   virtual void placeAtAltitude( const DtVector& location, const DtReal heading );

   bool hasHumanComponent() const;

   virtual void setDIGuyCharacterState( const DtRwDIGuyCharacterState& info );
   virtual DtRwDIGuyCharacterState diGuyCharacterState() const;

   virtual void setDiguyCharacter( const DtString& animation );
   virtual DtString diguyCharacter() const;

   virtual void setDiguyAnimation( const DtString& animation );
   virtual DtString diguyAnimation() const;

   virtual void setDiguyUsingAnimationOffset( bool usingOffset );
   virtual bool diguyUsingAnimationOffset() const;

   virtual void setDiguyAnimationOffset( const DtVector& offset );
   virtual DtVector diguyAnimationOffset() const;

   virtual void setDiguyTransitionSpeed( float transitionSpeed );
   virtual float diguyTransitionSpeed() const;

   virtual void setDiguyBodyWeight( double w );
   virtual double diguyBodyWeight() const;

   virtual void setDiguyAppearance( const DtString& app );
   virtual DtString diguyAppearance() const;

   virtual const DtRwNLengthStringVector& randomAppearancesList() const;

   virtual void setDiguyHandItem( const DtString& app );
   virtual DtString diguyHandItem() const;

   virtual void setDiguyHead( const DtString& app );
   virtual DtString diguyHead() const;


   virtual void setDiguyPrimaryUnitPatch( const DtPatchIdentifier& patchId );
   virtual DtPatchIdentifier diguyPrimaryUnitPatch() const;
   virtual void setDiguySecondaryUnitPatch( const DtPatchIdentifier& patchId );
   virtual DtPatchIdentifier diguySecondaryUnitPatch() const;
   virtual void setDiguyRankPatch( const DtPatchIdentifier& patchId );
   virtual DtPatchIdentifier diguyRankPatch() const;
   virtual void setDiguyCharacterName( const DtString& name );
   virtual DtString diguyCharacterName() const;


   boost::signals2::signal<void ()> signal_currentPitchChanged;

protected:

   virtual void createLegacyRWData() override;
   virtual void setToLegacyRWData() override;
   virtual void restoreFromLegacyRWData() override;
   virtual void preGetSelf() override;
   virtual void prePutSelf() override;

   virtual void determineDiGuyAppearance();

   virtual void determineVisualMarkingAppearance();

protected:

   DtVrfMovingObjectStateRepository();

   DtGroundInteractionPt myLeftSupport;
   DtGroundInteractionPt myRightSupport;
   DtGroundInteractionPt myOtherSupport;

   DtRwVector myLocalEstimatedPositionError;
   DtRwReal myOrderedSpeed;
   DtRwReal myManeuverAggressiveness;
   DtRwInt myActionUrgency;
   DtRwReal myOrderedAltitude;
   DtRwBoolean myUseOrderedAltitudeForRoutes; //default false
   DtRwReal myMaxSpeed;
   DtRwReal myMaxReverseSpeed;
   DtRwReal myTurningRadius;
   DtRwReal myMaxSlope;
   DtRwBoolean myForward;
   DtRwReal myMaxAcceleration;
   DtRwReal myMaxStoppingDeceleration;
   DtRwReal myMaxLateralAcceleration;
   DtRwBoolean myCanPivot;
   DtRwBoolean myClampToGround;
   DtRwBoolean myUsingRailMovement;
   DtRwReal myMaxPivotSpeed;

   DtString myDIGuyCharacter;

   DtReal myInverseStoppingDeceleration;

   DtRwBoolean myKeepGroundClampingFlag;

   DtRwBoolean myPitchSet;

   DtRwBoolean myHaveSupplies;

   DtRwReal myNextSupplyCheckTime;

public:


   VRF4API_METHOD static DtVrfMovingObjectStateRepository* isVrfMovingObjectStateRepository(DtSimObjectStateRepository* rep)
   {
      return rep->as<DtVrfMovingObjectStateRepository>();
   }

   VRF4API_METHOD const DtMovingObjectParameters* vrfParameters() const { return movingObjectParameters(); };


};