Version 1.6 Copyright © 2021 MAK Technologies All rights Reserved. Printed in the United States. Under copyright laws, no part of this document may be copied or reproduced in any form without prior written consent of MAK Technologies. VR-Exchange™, VR-TheWorld™, VR-Vantage™, DI-Guy™, and DI-Guy Scenario™ are trademarks of MAK Technologies. MÄK Technologies®, VR- Forces®, RTIspy®, B-HAVE®, and VR-Link® are registered trademarks of MAK Technologies. GL Studio® is a registered trademark of The DiSTI® Corporation. Portions of this software utilize SpeedTree® technology (©2008 Interactive Data Visualization, Inc.). SpeedTree is a registered trademark of Interactive Data Visualization, Inc. All rights reserved. SilverLining™ is a trademark of Sundog Software. Terrain Profiles are based in part on the work of the Qwt project (http://qwt.sourceforge.net). 3ds Max® is a registered trademark of Autodesk, Inc. All other trademarks are owned by their respective companies. For third-party license information, please see “Third Party Licenses,” on page xii. MAK Technologies 150 Cambridge Park Drive, 3rd Floor Cambridge, MA 02140 USA Voice: 617-876-8085 Fax: 617-876-9208 [email protected] www.mak.com Revision WVC-1.6-3-210405 Contents Preface How the Manual is Organized ............................................................... vii MAK Products ...................................................................................... viii How to Contact Us ................................................................................... x Document Conventions ........................................................................... xi Mouse Button Naming Conventions .............................................. xii Third Party Licenses .............................................................................. xii Boost License.................................................................................. xiv libXML and libICONV ................................................................... xiv QScintilla and SciTE...................................................................... xiv Chapter 1. The WebLVC Specification 1.1. Introduction to WebLVC ................................................................ 1-2 1.1.1. Introduction to JSON .......................................................... 1-3 1.1.2. A WebLVC Example ........................................................... 1-3 1.2. Basic Protocol Specification ........................................................... 1-4 1.2.1. Header Information ............................................................ 1-4 1.2.2. The Connect Message ......................................................... 1-5 1.2.3. The ObjectDeletion Message .............................................. 1-6 1.2.4. AttributeUpdate Message ................................................... 1-6 1.2.5. Interaction Message ............................................................ 1-8 1.3. Extending the WebLVC Protocol .................................................. 1-8 1.3.1. Extending WebLVC Automatically, Based on DIS .......... 1-9 1.3.2. Extending WebLVC Automatically, Based on an HLA FOM ............................................................................ 1-9 1.3.3. Standard Mapping Rules for HLA and the RPR FOM .... 1-10 The WebLVC Specification iii Contents Chapter 2. The Standard WebLVC Object Model 2.1. The Standard WebLVC Object Model .......................................... 2-2 2.2. Standard AttributeUpdate Messages ........................................... 2-3 2.2.1. WebLVC:PhysicalEntity Attribute Update Message ........ 2-3 2.2.2. WebLVC:AggregateEntity Attribute Update Message ..... 2-5 2.2.3. WebLVC:EnvironmentalEntity Attribute Update Message ............................................................................... 2-6 2.2.4. WebLVC:RadioTransmitter Attribute Update Message .. 2-8 2.3. Standard Interaction Messages .................................................. 2-12 2.3.1. WebLVC:WeaponFire Interaction Message .................... 2-12 2.3.2. WebLVC:MunitionDetonation Interaction Message ....... 2-13 2.3.3. WebLVC:StartResume Interaction Message ................... 2-14 2.3.4. WebLVC:StopFreeze Interaction Message ...................... 2-15 2.3.5. WebLVC:RadioSignal Interaction Message .................... 2-15 Chapter 3. MAK Extensions to the Standard WebLVC Object Model 3.1. Introduction ................................................................................... 3-3 3.2. The MAK Data Logger Control Message ...................................... 3-3 3.3. MAK:VRFBackend Attribute Update Message ........................... 3-7 3.4. VR-Forces Interaction Messages .................................................. 3-8 3.4.1. MAK:VrfCurrentResourceRequest Interaction Message ............................................................................... 3-8 3.4.2. MAK:VrfResourceMonitorResponse Interaction Message ............................................................................... 3-9 3.4.3. MAK:VrfScriptedTask Interaction Message ................... 3-10 3.4.4. MAK:VrfSet Interaction Message .................................... 3-13 3.4.5. MAK:VrfTextReport Interaction Message ....................... 3-14 3.4.6. MAK:VrfChangeTimeOfDay ............................................ 3-14 3.4.7. MAK:VrfChangeGlobalWeather ...................................... 3-15 3.4.8. MAK:VrfCreateObject ...................................................... 3-16 3.4.9. MAK:VrfScenario .............................................................. 3-17 3.4.10. MAK:VrfControl .............................................................. 3-18 3.4.11. MAK:VrfDeleteObject ..................................................... 3-18 3.5. VR-Vantage Messages ................................................................. 3-19 3.5.1. MAK:VrvMimicView ......................................................... 3-19 3.5.2. MAK:VrvMimicTrackView ............................................... 3-20 3.5.3. MAK:VrvFollowView ........................................................ 3-21 3.5.4. MAK:VrvTetherView ........................................................ 3-22 3.5.5. MAK:VrvSensorMode ....................................................... 3-23 3.5.6. MAK:VrvObserverMode ................................................... 3-23 3.5.7. MAK:VrvUseSavedView ................................................... 3-24 3.5.8. MAK:VrvViewMagnification ............................................ 3-25 3.5.9. MAK:VrvSetSystemState ................................................. 3-25 3.5.10. MAK:VrvModelSet .......................................................... 3-26 3.5.11. MAK:VrvModelScaling ................................................... 3-27 3.5.12. MAK:VrvModelScaleFactor ............................................ 3-27 iv MAK Technologies Contents 3.5.13. MAK:VrvKeyPress .......................................................... 3-28 3.5.14. MAK:VrvMouseEvent ..................................................... 3-29 3.5.15. MAK:VrvTrackHistories ................................................. 3-30 3.5.16. MAK:VrvDynamicOcean ................................................. 3-30 Index The WebLVC Specification v Contents vi MAK Technologies Preface This manual is written for persons who need to write WebLVC applications. The manual assumes that you are familiar with your operating system and windowing environment. Please see MAK WebLVC Server Release Notes for updates to this manual and the latest information about your version of WebLVC Server. How the Manual is Organized This manual is organized as follows: Chapter 1, The WebLVC Specification, introduces the WebLVC specification. Chapter 2, The Standard WebLVC Object Model, introduces the Standard Object Model. Chapter 3, MAK Extensions to the Standard WebLVC Object Model, describes WebLVC messages that are specifically for use with MAK applications. The WebLVC Specification vii Preface — MAK Products MAK Products The MAK Technologies product line includes the following: VR-Link® Network Toolkit. VR-Link is an object-oriented library of C++ functions and definitions that implement the High Level Architecture (HLA) and the Distributed Interactive Simulation (DIS) protocol. VR-Link has built-in support for the RPR FOM and allows you to map to other FOMs. This library minimizes the time and effort required to build and maintain new HLA or DIS-compliant applications, and to integrate such compliance into existing applications. VR-Link includes a set of sample debugging applications and their source code. The source code serves as an example of how to use the VR-Link Toolkit to write applications. The executables provide valuable debugging services such as generating a predictable stream of HLA or DIS messages, and displaying the contents of messages transmitted on the network. MAK RTI. An RTI (Run-Time Infrastructure) is required to run applications using the High Level Architecture (HLA). The MAK RTI is optimized for high performance. It has an API, RTIspy®, that allows you to extend the RTI using plug-in modules. It also has a graphical user interface (the RTI Assistant) that helps users with configuration tasks and managing feder- ates and federations. VR-Forces®. VR-Forces is a computer generated forces application and toolkit. It provides an application with a GUI, that gives you 2D and 3D views of a simulated environment. You can create and view entities, aggregate them into hierarchical