vrfMovingObjectStateRepository.h

Go to the documentation of this file.

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


#pragma once

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

class DtMovingObjectParameters;
class DtRwDIGuyCharacterState;

class DT_DLL_vrfobjcore DtVrfMovingObjectStateRepository : public DtVrfObjectStateRepository
{
public:

   static DtVrfObjectStateRepository* creator( const DtString& name, DtVrfObject* vrfObject,
      const DtObjectType& objectType, DtVrfObjectParameters* parameters,
      DtReaderWriterRegistry* parentRegistry );

   virtual DtSimObjectStateRepository* clone( const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0 ) const;

   DtVrfMovingObjectStateRepository( DtVrfObject* vrfObject,
      const DtObjectType& objectType, DtVrfObjectParameters* parameters,
      const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0 );

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

   DtVrfMovingObjectStateRepository& operator = ( const DtVrfMovingObjectStateRepository& orig );

   virtual ~DtVrfMovingObjectStateRepository();

   static DtVrfMovingObjectStateRepository* isVrfMovingObjectStateRepository(
      DtSimObjectStateRepository* repository );

   static const DtVrfMovingObjectStateRepository* isVrfMovingObjectStateRepository(
      const DtSimObjectStateRepository* repository );

   virtual void tick();

   virtual DtString type() const;

   virtual const int vrfObjectStateRepositorySubType() const;

   virtual const int vrfMovingObjectStateRepositorySubType() const;

   virtual bool createParameters();
   virtual void initializeFromParameters();

   virtual void addRangeItem( const DtRangeItem& item );
   virtual void setRangeItems( const DtRangeItems& item );
   virtual void removeRangeItem( int index );

   virtual void updateMaximumSensorRangeRing();
   virtual 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 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 double currentPitch() const;

   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 fuelEfficiency() const;
   virtual void setFuelEfficiency(const DtReal fuelEfficiency);

   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();

   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 );

   virtual DtVector parentPosition();

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

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

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

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

   virtual void setDIGuyCharacterState( DtRwDIGuyCharacterState * info );
   virtual  DtRwDIGuyCharacterState * diGuyCharacterState();

   virtual void setDIGuyCharacter( const DtString & animation );
   virtual const DtString & dIGuyCharacter() const;

   virtual void setDIGuyAnimation( const DtString & animation );
   virtual const DtString & dIGuyAnimation() const;

   virtual void setDIGuyUsingAnimationOffset( bool usingOffset );
   virtual bool dIGuyUsingAnimationOffset() const;

   virtual void setDIGuyAnimationOffset( const DtVector& offset );
   virtual const 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 const DtString& dIGuyAppearance() const;

   virtual const DtRwNLengthStringVector& randomAppearancesList() const;

   virtual void setDIGuyHandItem( const DtString & app );
   virtual const DtString& dIGuyHandItem() const;

   virtual void setDIGuyHead( const DtString & app );
   virtual const DtString& dIGuyHead() const;

   virtual void addCurrentPitchCallback( DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void* usr );
   virtual void removeCurrentPitchCallback( DtVrfObjectCallbackList::DtCallbackFunctionType fcn, void* usr );
   virtual void invokeCurrentPitchCallbacks();

protected:

   virtual void getSelf( DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings );

   virtual void determineDiGuyAppearance();

   virtual void determineVisualMarkingAppearance();

   virtual DtRwDIGuyCharacterState* createDIGuyCharacterState();

private:

   DtVrfMovingObjectStateRepository();

protected:

   DtGroundInteractionPt myLeftSupport;
   DtGroundInteractionPt myRightSupport;
   DtGroundInteractionPt myOtherSupport;

   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;
   DtRwReal myFuelEfficiency;
   DtRwBoolean myCanPivot;
   DtRwBoolean myClampToGround;
   DtRwBoolean myUsingRailMovement;
   DtRwReal myMaxPivotSpeed;

   DtRwDIGuyCharacterState* myDIGuyCharacterState;

   DtString myDIGuyCharacter;

   DtReal myInverseStoppingDeceleration;

   DtRwBoolean myKeepGroundClampingFlag;

   DtRwBoolean myPitchSet;

   DtRwBoolean myHaveSupplies;

   DtRwReal myNextSupplyCheckTime;

   DtVrfObjectCallbackList myCurrentPitchCallbacks;

};