pViewControlInter.h

Go to the documentation of this file.

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


#pragma once

#include <portal/pInteraction.h>
#include <vlutil/vlNetTypes.h>
#include <vlutil/vlString.h>
#include <matrix/vlVector.h>

#define DtDEC_ATTRIBUTE_PRESENT(T, N, n) \
   public : \
   void set##N(const T& val) { my##N = val; long long shiftNum = (1ull << DtVC##N); myOptionPresent = myOptionPresent | shiftNum; }\
   const T& n() const { return my##N;} \
   T& n() { return my##N;} \
   protected: \
   T my##N;

#define DtDEC_ATTRIBUTE_PRESENT2(T, N, n) \
   public : \
   void set##N(const T& val) { my##N = val; long long shiftNum = (1ul << DtVC##N); myOptionPresent2 = myOptionPresent2 | shiftNum; }\
   const T& n() const { return my##N;} \
   T& n() { return my##N;} \
   protected: \
   T my##N;

namespace MAKVrExchange
{

   class DtPortalConnection;

   enum DtViewControlOption
   {
      DtVCOverlayOption = 0,
      DtVCLocatorRange,
      DtVCSmoothing,
      DtVCSmoothingPeriod,
      DtVCSound,
      DtVCEntityLabels,
      DtVCTrailingEffects,
      DtVCTrajectoryHistory,
      DtVCRecording,
      DtVCAggregateLevel,
      DtVCAggregateHighestOnly,
      DtVCAggregatesAltitudeControlled,
      DtVCNestedAggregates,
      DtVCNestedEntities,
      DtVCGroundClamping,
      DtVCClampRange,
      DtVCFollowGround,
      DtVCConstrainWithFloor,
      DtVCFloor,
      DtVCTimeOfDay,
      DtVCNearClip,
      DtVCFarClip,
      DtVCFov,
      DtVCFog,
      DtVCNearFog,
      DtVCFarFog,
      DtVCTexture,
      DtVCDatabaseToLoad,
      DtVCStepsize,
      DtVCTurnrate,
      DtVCDate,
      DtVCIncrementStepsize,
      DtVCIncrementTurnrate,
      DtVCDecrementStepsize,
      DtVCDecrementTurnrate,
      DtVCXr,
      DtVCHatLabels,
      DtVCShowNextModelSet,
      DtVCShowPrevModelSet,
      DtVCCurrentModelSet,
      DtVCShowPrevTextureSet,
      DtVCShowNextTextureSet,
      DtVCCurrentTextureSet,
      DtVCTerrainScale,
      DtVCObjectScale,
      DtVCClouds,
      DtVCSkyDome,
      DtVCExit,
      DtVCMirroring,
      DtVCMirrorMessageEveryFrame,
      DtVCBroadcasting,
      DtVCClusteringLabels,
      DtVCTacticalGraphicsLabels,
      DtVCTacticalGraphics,
      DtVCShowAggregates,
      DtVCShowEmitters,
      DtVCVideoCaptureCommand,
      DtVCVideoCaptureFilename,
      DtVCVideoCaptureDirectory,
      DtVCVideoCaptureFilenameBase,
      DtVCVideoCaptureRecordInsets,
      DtVCVideoCaptureFramesPerSecond,
      DtVCConstrainedToAll
   };

   enum DtViewControlOption2
   {
      DtVCBlockedDistance = 0,
      DtVCUseNearClipForBlockedDistance,
      DtVCFeatureFilename,
      DtVCFeatureCommand
   };

   class DT_DLL_LIBPORTAL DtPortalViewControlInteraction
      : public DtPortalInteraction
   {
   public:

      typedef void (*DtPortalViewControlInteractionCb) (
         const DtPortalViewControlInteraction& inter, void* usr );

      DtPortalViewControlInteraction();

      virtual ~DtPortalViewControlInteraction();

      virtual bool contains( DtViewControlOption opt ) const;
      virtual bool contains( DtViewControlOption2 opt ) const;

      static void addCallback( DtPortalConnection* conn,
         DtPortalViewControlInteractionCb cb, void* usr );

      static void removeCallback( DtPortalConnection* conn,
         DtPortalViewControlInteractionCb cb, void* usr );


      DtDEC_ATTRIBUTE(DtString, ViewerId, viewerId);

      DtDEC_ATTRIBUTE(DtString, SenderId, senderId);

      DtDEC_ATTRIBUTE(DtU32, ViewerCommand, viewerCommand);

      DtDEC_ATTRIBUTE(DtU32, IgnoreFlag, ignoreFlag);

      DtDEC_ATTRIBUTE(DtBoolean, StatusCommand, statusCommand);

      DtDEC_ATTRIBUTE(DtString, ViewString, viewString);

      DtDEC_ATTRIBUTE(std::vector<DtString>, ObjectIds, objectIds);

      DtDEC_ATTRIBUTE(DtU64, OptionPresent, optionPresent);
      DtDEC_ATTRIBUTE(DtU64, OptionPresent2, optionPresent2);

      DtDEC_ATTRIBUTE_PRESENT(DtU32, OverlayOption, overlayOption);
      DtDEC_ATTRIBUTE_PRESENT(double, LocatorRange, locatorRange);
      DtDEC_ATTRIBUTE_PRESENT(DtU32, Smoothing, smoothing);
      DtDEC_ATTRIBUTE_PRESENT(double, SmoothingPeriod, smoothingPeriod);
      DtDEC_ATTRIBUTE_PRESENT(bool, Sound, sound);
      DtDEC_ATTRIBUTE_PRESENT(bool, EntityLabels, entityLabels);
      DtDEC_ATTRIBUTE_PRESENT(bool, TrailingEffects, trailingEffects);
      DtDEC_ATTRIBUTE_PRESENT(bool, TrajectoryHistory, trajectoryHistory);
      DtDEC_ATTRIBUTE_PRESENT(bool, Recording, recording);
      DtDEC_ATTRIBUTE_PRESENT(DtU32, AggregateLevel, aggregateLevel);
      DtDEC_ATTRIBUTE_PRESENT(bool, AggregateHighestOnly, aggregateHighestOnly);
      DtDEC_ATTRIBUTE_PRESENT(bool, AggregatesAltitudeControlled, aggregatesAltitudeControlled);
      DtDEC_ATTRIBUTE_PRESENT(bool, NestedAggregates, nestedAggregates);
      DtDEC_ATTRIBUTE_PRESENT(bool, NestedEntities, nestedEntities);
      DtDEC_ATTRIBUTE_PRESENT(bool, GroundClamping, groundClamping);
      DtDEC_ATTRIBUTE_PRESENT(double, ClampRange, clampRange);
      DtDEC_ATTRIBUTE_PRESENT(bool, FollowGround, followGround);
      DtDEC_ATTRIBUTE_PRESENT(bool, ConstrainWithFloor, constrainWithFloor);
      DtDEC_ATTRIBUTE_PRESENT(double, Floor, floor);
      DtDEC_ATTRIBUTE_PRESENT(double, TimeOfDay, timeOfDay);
      DtDEC_ATTRIBUTE_PRESENT(double, NearClip, nearClip);
      DtDEC_ATTRIBUTE_PRESENT(double, FarClip, farClip);
      DtDEC_ATTRIBUTE_PRESENT(double, Fov, fov);
      DtDEC_ATTRIBUTE_PRESENT(bool, Fog, fog);
      DtDEC_ATTRIBUTE_PRESENT(double, NearFog, nearFog);
      DtDEC_ATTRIBUTE_PRESENT(double, FarFog, farFog);
      DtDEC_ATTRIBUTE_PRESENT(bool, Texture, texture);
      DtDEC_ATTRIBUTE_PRESENT(DtString, DatabaseToLoad, databaseToLoad);
      DtDEC_ATTRIBUTE_PRESENT(float, Stepsize, stepsize);
      DtDEC_ATTRIBUTE_PRESENT(float, Turnrate, turnrate);
      DtDEC_ATTRIBUTE_PRESENT(bool, IncrementStepsize, incrementStepsize);
      DtDEC_ATTRIBUTE_PRESENT(bool, IncrementTurnrate, incrementTurnrate);
      DtDEC_ATTRIBUTE_PRESENT(bool, DecrementStepsize, decrementStepsize);
      DtDEC_ATTRIBUTE_PRESENT(bool, DecrementTurnrate, decrementTurnrate);
      DtDEC_ATTRIBUTE_PRESENT(DtString, Date, date);
      DtDEC_ATTRIBUTE_PRESENT(bool, Xr, xr);
      DtDEC_ATTRIBUTE_PRESENT(bool, HatLabels, hatLabels);
      DtDEC_ATTRIBUTE_PRESENT(DtString, CurrentModelSet, currentModelSet);
      DtDEC_ATTRIBUTE_PRESENT(bool, ShowNextModelSet, showNextModelSet);
      DtDEC_ATTRIBUTE_PRESENT(bool, ShowPrevModelSet, showPrevModelSet);
      DtDEC_ATTRIBUTE_PRESENT(DtString, CurrentTextureSet, currentTextureSet);
      DtDEC_ATTRIBUTE_PRESENT(bool, ShowNextTextureSet, showNextTextureSet);
      DtDEC_ATTRIBUTE_PRESENT(bool, ShowPrevTextureSet, showPrevTextureSet);
      DtDEC_ATTRIBUTE_PRESENT(double, TerrainScale, terrainScale);
      DtDEC_ATTRIBUTE_PRESENT(double, ObjectScale, objectScale);
      DtDEC_ATTRIBUTE_PRESENT(bool, Exit, exit);
      DtDEC_ATTRIBUTE_PRESENT(bool, SkyDome, skyDome);
      DtDEC_ATTRIBUTE_PRESENT(bool, Clouds, clouds);
      DtDEC_ATTRIBUTE_PRESENT(bool, Mirroring, mirroring);
      DtDEC_ATTRIBUTE_PRESENT(bool, MirrorMessageEveryFrame, mirrorMessageEveryFrame);
      DtDEC_ATTRIBUTE_PRESENT(bool, Broadcasting, broadcasting);
      DtDEC_ATTRIBUTE_PRESENT(bool, ClusteringLabels, clusteringLabels);
      DtDEC_ATTRIBUTE_PRESENT(bool, TacticalGraphicsLabels, tacticalGraphicsLabels);
      DtDEC_ATTRIBUTE_PRESENT(bool, TacticalGraphics, tacticalGraphics);
      DtDEC_ATTRIBUTE_PRESENT(bool, ShowAggregates, showAggregates);
      DtDEC_ATTRIBUTE_PRESENT(bool, ShowEmitters, showEmitters);
      DtDEC_ATTRIBUTE_PRESENT(DtU32, VideoCaptureCommand, videoCaptureCommand);
      DtDEC_ATTRIBUTE_PRESENT(bool, VideoCaptureRecordInsets, videoCaptureRecordInsets);
      DtDEC_ATTRIBUTE_PRESENT(DtU32, VideoCaptureFramesPerSecond, videoCaptureFramesPerSecond);
      DtDEC_ATTRIBUTE_PRESENT(DtString, VideoCaptureFilename, videoCaptureFilename);
      DtDEC_ATTRIBUTE_PRESENT(DtString, VideoCaptureFilenameBase, videoCaptureFilenameBase);
      DtDEC_ATTRIBUTE_PRESENT(DtString, VideoCaptureDirectory, videoCaptureDirectory);
      DtDEC_ATTRIBUTE_PRESENT(bool, ConstrainedToAll, constrainedToAll);

      DtDEC_ATTRIBUTE_PRESENT2(double, BlockedDistance, blockedDistance);
      DtDEC_ATTRIBUTE_PRESENT2(bool, UseNearClipForBlockedDistance, useNearClipForBlockedDistance);
      DtDEC_ATTRIBUTE_PRESENT2(DtU32, FeatureCommand, featureCommand);
      DtDEC_ATTRIBUTE_PRESENT2(DtString, FeatureFilename, featureFilename);

   public:

      static const DtPortalMessageKind theKind;

      static DtPortalMessage* create();

      virtual unsigned int netSize() const;
      virtual void writeSelfToBuffer( void* buffer, int bufferSize ) const;
      virtual void readSelfFromBuffer( const void* buffer, int bufferSize );

      virtual std::ostream& printDataToStream( std::ostream& str ) const;

   };


   inline DtPortalMessage* DtPortalViewControlInteraction::create()
   {
      return new DtPortalViewControlInteraction();
   }

}