textIf.h

Go to the documentation of this file.

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

#pragma once

#include <vlutil/vlUtil.h>
#include <vlpi/entityIdentifier.h>
#include <vrvControl/vrvControlToolkitDataTypes.h>

#include <string>
#include <map>
#include <list>

#include <boost/function.hpp>


class DtExerciseConn;

namespace vrvControlToolkit
{
   struct DtVrvControl_v1;
}

class DtTextInterface
{
public:

   typedef std::list<std::string> TokenList;
   typedef TokenList::const_iterator TokenIter;
   typedef std::map<std::string, boost::function<void (const TokenList& )> > CommandMap;

   DtTextInterface(DtExerciseConn* controller);
   virtual ~DtTextInterface();

   void readStdin();

   virtual void setTimeToQuit(bool yesNo);
   virtual bool timeToQuit() const;

   void helpCmd(const TokenList& tokens);
   void quitCmd(const TokenList& tokens);

   void resetViewCmd(const TokenList& tokens);
   void absViewCmd(const TokenList& tokens);
   void followViewCmd(const TokenList& tokens);
   void mimicViewCmd(const TokenList& tokens);
   void tetherViewCmd(const TokenList& tokens);
   void trackViewCmd(const TokenList& tokens);
   void mimicTrackViewCmd(const TokenList& tokens);
   void tetherTrackViewCmd(const TokenList& tokens);
   void mimicLocationTrackViewCmd(const TokenList& tokens);
   void tetherLocationTrackViewCmd(const TokenList& tokens);
   void spaceFollowViewCmd(const TokenList& tokens);
   void observerSettingCmd(vrvControlToolkit::DtVrvControlTypeEnum settingType, const TokenList& tokens);

   void groundClampingCmd(const TokenList& tokens);
   void modelSetCmd(const TokenList& tokens);
   void tacticalGraphicsCmd(const TokenList& tokens);
   void tacticalGraphicsLabelsCmd(const TokenList& tokens);
   void tacticalGraphicsShowActiveCmd(const TokenList& tokens);
   void radioCommsCmd( const TokenList& tokens );
   void commLinesCmd( const TokenList& tokens );
   void squawkIndicatorsCmd( const TokenList& tokens );
   void entityLabelsCmd(const TokenList& tokens);
   void entitySmoothingCmd(const TokenList& tokens);
   void fireDetonateLinesCmd(const TokenList& tokens);
   void fogCmd(const TokenList& tokens);
   void elevationalFogCmd(const TokenList& tokens);
   void hazeCmd(const TokenList& tokens);
   void precipitationCmd(const TokenList& tokens);
   void dateTimeCmd(const TokenList& tokens);
   void timeScaleCmd(const TokenList& tokens);
   void shadowCmd(const TokenList& tokens);
   void shadowSettingsCmd(const TokenList& tokens);
   void performanceStatsCmd(const TokenList& tokens);
   void hudsCmd(const TokenList& tokens);
   void remoteGraphicsSetCmd(const TokenList& tokens);
   void wireframeCmd(const TokenList& tokens);
   void observerModeCmd(const TokenList& tokens);
   void zoomCmd(const TokenList& tokens);
   void viewMagnificationCmd(const TokenList& tokens);
   void sensorModeCmd(const TokenList& tokens);
   void sensorBoolParameterCmd(const TokenList& tokens);
   void sensorFloatParameterCmd(const TokenList& tokens);
   void sensorStringParameterCmd(const TokenList& tokens);
   void sensorIntParameterCmd(const TokenList& tokens);
   void streamingVideoCmd(const TokenList& tokens);
   void observerSpeedLinearCmd(const TokenList& tokens);
   void observerSpeedRotationalCmd(const TokenList& tokens);
   void observerSpeedOrbitalCmd(const TokenList& tokens);
   void modelScaleTypeCmd(const TokenList& tokens);
   void modelScaleFactorCmd(const TokenList& tokens);
   void projectionCmd(const TokenList& tokens);
   void audioCmd(const TokenList& tokens);
   void audioVolumeCmd(const TokenList& tokens);
   void terrainScalingCmd(const TokenList& tokens);
   void terrainScaleFactorCmd(const TokenList& tokens);
   void trackHistoryRibbonLengthCmd(const TokenList& tokens);
   void trackHistoryRibbonSpacingCmd(const TokenList& tokens);
   void trackHistoryRibbonTimeoutCmd(const TokenList& tokens);
   void observerModeRestoreCmd(const TokenList& tokens);
   void savedViewCmd(const TokenList& tokens);
   void advancedLightingCmd(const TokenList& tokens);
   void planarReflectionsCmd(const TokenList& tokens);
   void lensFlareCmd(const TokenList& tokens);
   void crepuscularRaysCmd(const TokenList& tokens);
   void rainSplashCmd(const TokenList& tokens);
   void waveSplashCmd(const TokenList& tokens);
   void oceanSprayCmd(const TokenList& tokens);
   void depthOfFieldCmd(const TokenList& tokens);
   void hbaoCmd(const TokenList& tokens);
   void entityHatCmd(const TokenList& tokens);
   void tacticalGraphicsHatCmd(const TokenList& tokens);
   void emitterVolumesCmd(const TokenList& tokens);
   void senderIdCmd(const TokenList& tokens);
   void receiverIdCmd(const TokenList& tokens);
   void wakesCmd(const TokenList& tokens);
   void laserDesignatorsCmd(const TokenList& tokens);
   void wavesSprayEffectCmd(const TokenList& tokens);
   void rotorWashDecalCmd(const TokenList& tokens);
   void seaStateCmd(const TokenList& tokens); // sea state and optional direction (forces manual driven)
   void seaStateCtrlCmd(const TokenList& tokens); // wind driven or manual
   void swellStateCmd(const TokenList& tokens); // swell state and optional direction
   void depthOfFieldAutoFocusCmd(const TokenList& tokens);
   void depthOfFieldFocusDistanceCmd(const TokenList& tokens);
   void depthOfFieldDepthCmd(const TokenList& tokens);

   void hbaoRadiusCmd(const TokenList& tokens);
   void hbaoBiasCmd(const TokenList& tokens);
   void hbaoExponentCmd(const TokenList& tokens);
   void hbaoSmallScalarCmd(const TokenList& tokens);
   void hbaoLargeScalarCmd(const TokenList& tokens);
   void hbaoDepthClampModeCmd(const TokenList& tokens);

   void windDirectionCmd(const TokenList& tokens);
   void elevationalWindDirectionCmd(const TokenList& tokens);
   void windSpeedCmd(const TokenList& tokens);
   void elevationalWindSpeedCmd(const TokenList& tokens);
   void visibilityCmd(const TokenList& tokens);
   void elevationalVisibilityCmd(const TokenList& tokens);
   void globalEnvironmentCmd(const TokenList& tokens);
   void snowGroundAccumulationCmd(const TokenList& tokens);
   void snowRoadAccumulationCmd(const TokenList& tokens);
   void snowMinimumElevationCmd(const TokenList& tokens);
   void snowElevationTransitionCmd(const TokenList& tokens);
   void rainGroundAccumulationCmd(const TokenList& tokens);
   void observerCameraShakeCmd(const TokenList& tokens);
   void observerCameraShakeIntensityCmd(const TokenList& tokens);
   void terrainMagnificationHighLodAngleCmd(const TokenList& tokens);
   void pauseSimTimeCmd();
   void resumeSimTimeCmd();

   void lightPointGroupColorCmd(const TokenList& tokens);

   void useGlobalTimeZoneCmd(const TokenList& tokens);
   void detachViewCmd(const TokenList& tokens);
   void hideModelOnAttachCmd(const TokenList& tokens);

   // Test for example
   void diffuseLightScaleCmd(const TokenList& tokens);
   void ambientLightScaleCmd(const TokenList& tokens);

   void occupantsVisibleCmd(const TokenList& tokens);
   void occupantsVisibleOnEntityCmd(const TokenList& tokens);

   void openTerrainCmd(const TokenList& tokens);

   void wheelRotationCmd(const TokenList& tokens);
   void adaptiveTickRateCmd(const TokenList& tokens);
   void defaultRunwayLightGroupColorCmd(const TokenList& tokens);

   void createSensorViewCmd(const TokenList& tokens);

   void paperMapEnableCmd(const TokenList& tokens);
   void paperMapGroupCmd(const TokenList& tokens);
   void paperMapLayerTimeoutCmd(const TokenList& tokens);
   void paperMapIntersectionOverrideCmd(const TokenList& tokens);
   
   void tidalStreamWakesCmd(const TokenList& tokens);
   void tidalCurrentDirection(const TokenList& tokens);
   void tidalCurrentSpeed(const TokenList& tokens);

   // public for using the command line interface
   void processCmd(const std::string& buff);


protected:

   void prompt();
   TokenList tokenize(const std::string& str, const std::string& delim);
   void packageAndSend( vrvControlToolkit::DtVrvControl_v1* cmd );

   bool myTimeToQuit;
   DtExerciseConn* myExconn;
   CommandMap myCommands;
   DtEntityIdentifier mySenderId;
   DtEntityIdentifier myReceiverId;

};