FSDeveloper Wiki - User contributions [en-gb]

FSX KML

2012-12-29T14:35:47Z

GaryGB: /* Downloading FSX KML */

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
== Introduction ==

[[Image:before_and_after.jpg|thumb|right|150px|Before and after screenshot]]

FSX KML is a freeware scenery design tool for Microsoft Flight Simulator X (FSX).

It converts KML (Keyhole Markup Language) files generated by Google Earth into FSX scenery.

Using Google Earth to draw polygons and polylines you can accurately and easily create many types of scenery.

===Shp2Vec based scenery===
FSX KML uses the FSX SDK Shp2Vec tool to create the following types of vector scenery:-

* Water polygons including oceans, rivers, lakes and canals
* Islands inside water features
* Irregular shaped land class polygons for cities, parks, beaches, forest, golf courses etc
* Airport boundaries and flatten polygons and AUTOGEN EXCLUSIONS
* Shorelines
* Streams
* Roads
* Railways
* Freeways (ie Moving traffic)
* Utility lines (eg power and telephone lines)
* Exclusions polygons (for vector data)

===BGLComp based scenery===
FSX KML uses the FSX SDK BGLComp tool to create the following types of scenery:-

* Place scenery objects (from the FSX library) along a polyline using a wide variety of [http://www.fsdeveloper.com/wiki/index.php?title=FSX_KML#v1.08_Beta_-_18th_May_2007 placement options]
* Exclusion rectangles
* Extrusion bridges

===Resample based scenery===
FSX KML uses the FSX SDK Resample tool to create the following types of scenery:-

* Land class tiles
* Water class tiles

'''Make sure you also download and install [http://fsdeveloper.com/wiki/index.php?title=FSX_KML#Installing_FWTools FWTools] which is required for creating these types of scenery.'''

== Support Forum ==

You can discuss FSX KML at the fsdeveloper.com
[http://www.fsdeveloper.com/forum/forumdisplay.php?f=81 FSX KML forum]. This is the best place to ask support questions about FSX_KML since other FSX_KML users (as well as the author) can answer your questions.

== Downloading FSX KML ==

The latest version of FSX KML (1.10) can be downloaded from:-

* AVSIM - http://library.avsim.net/esearch.php?CatID=fsxsd&DLID=108495 < dead link >
* Flightsim.com - http://www.flightsim.com/vbfs/fslib.php?do=copyright&fid=115211 < live link: 29/12/2012 >
* The Scenery Hall of Fame - http://www.scenery.org/graphical_editors.htm < dead link >

== Installation ==

=== Installing FSX KML ===

FSX KML can be installed in a folder of your choice. Simply unzip the FSX KML installation zip file into the desired folder.

After unzipping the installation file you should have the following files:-

* FSX_KML.exe
* ShapeLib129.dll
* FreeImage.DLL
* FSX_KML_TAGS.XML


=== Installing the FSX Software Development Kit (SDK) ===

To generate FSX scenery you will need the FSX SDK, which is distributed with the FSX Deluxe version.
To install the SDK:

(1) Browse the FSX Deluxe Edition Disk 1

(2) Open the SDK sub-folder

(3) Double-click the setup.exe

(4) Tell it where to install. Default is C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK

If the SDK is not installed in the default SDK folder you must specify its location on the FSX_KML build tab.

For more info on the SDK installation and Service packs: [http://www.fsdeveloper.com/wiki/index.php?title=SDK_Installation_%28FSX%29 http://www.fsdeveloper.com/wiki/index.php?title=SDK_Installation_%28FSX%29]

=== Installing FWTools ===

FSX KML makes use of the freeware tool set called [http://fwtools.maptools.org/ FWTools]. FW Tools is required for scenery that uses the FSX SDK Resample tool, such as landclass and waterclass.

Download and install the latest version of FWTools.

Specify the location of FWTools on the FSX KML Build tab.

=== Installing Google Earth ===

If you notice some null values for vertices when importing KML files from Google Earth, pls consider to revert to an older version of GE. More information about this issue you can find [ http://www.fsdeveloper.com/forum/showthread.php?p=144034 here]

Google Earth, Vers 5.1 is available here: [http://www.google.com/earth/download/thanks.html#release=previous#os=win#single=yes Google Earth 5.1]

== Building Scenery ==

Building your own scenery with FSX KML is easy.

=== Step 1 - Creating a KML file with Google Earth ===

The first step in creating your FSX scenery is to create a KML file by using Google Earth to "trace" scenery features.

==== Creating polygons and polylines ====

Using Google Earth create a polygon using the "Add Poly" function or create a polyline using the "Add Path" function,
and then trace the scenery feature (for example a lake or road).

After you click the "Add Poly" or "Add Path button" you will be presented with a form as shown to the right

[[Image:GE-polygon-dialog.jpg|thumb|right|150px|Google Earth dialog for creating new polygon or polyline]]

* Name - Give your polygon or polyline a description or leave blank

* Description - This is where you "tag" your polygon or polyline. You may enter a tag from FSX_KML_TAGS.XML or leave blank and tag later using FSX_KML

* Style & Color - You may choose the border and fill color for polyline or polygon

* Altitude - You may enter an altitude for your polyline or polygon. This can be used to specify the elevation of lakes. You may also enter the elevation later using FSX_KML. All elevations must be entered in meters.

Begin tracing your polyline or polygon. You may either click the mouse or hold the mouse button down and drag the mouse to create vertices.

* Use your mouse wheel to zoom the view in and out vertically.

* Use the up, down, left, right arrow keys to move the view horizontally.

* Hold Shift and press left or right arrow to rotate the view.

* Hold Ctrl and press up or down arrow to tilt the view.

To make things easier; it is good to get into the habit of drawing polygon vertices in the same direction, perhaps always draw clockwise. That way if you decide to add new vertices to define details better, then you can simply click to the right of the currently selected vertex (blue) to add a new one in. Avoid adding vertices that make the polygon twisted.
While polygon "properties" is open, take the time to change the transparency (from the colour tab)- if you leave it opaque, then you end up covering important details and spotting mistakes is more difficult.

Once you have finished click OK to save your polygon or polyline.

To edit your polyline or polygon highlight it, right click the mouse and choose properties.

==== "Tagging" the scenery features ====

To describe what scenery feature your polygon or polyline represents it needs to be "tagged". The file FSX_KML_TAGS.XML contains a list of the tags you can use.

There are two ways to tag a polygon or polyline:-

* Place the name of the tag in the description field of the polygon or polyline.
* Place the name of the tag in the description field of the parent folder that contains the polygon or polyline. If a polygon/polyline has no tag then it will inherit its tag from the parent folder.

You can place these tags in GE using the properties dialog of the polygon or polyline, or you can use FSX_KML to place these tags.

To tag using FSX_KML click on a description "cell" and press F2. An arrow will be displayed so then click on the arrow to drop down a list of valid tags. Highlight the tag you want and press ENTER. If you had multi-selected several cells then all the selected cells will be tagged. To select multiple cells hold down the shift key while clicking cells.

==== Saving your work to a KML file ====

Once you're done drawing your polygon(s) or polyline(s), simply right-click on the top-most folder you created (or the polygon itself if you didn't create folders) under the "My Places" tab on the left side of your GE window. Select "Save As", makes sure that you choose .kml as the file type, and select your desired location in your file structure.

=== Step 2 - Processing the KML file with FSX KML ===

[[Image:project.jpg|thumb|right|150px|The Project tab]] [[Image:build.jpg|thumb||150px|The Build tab]]

* Run FSX_KML
* On the "Project" tab, click the "Add KML" button and choose a KML file. The contents of the selected KML file will be displayed. You may add multiple KML files. A FSX BGL file will be generated for each KML input file.
* Change to the "Build" tab
* Set the following build options:-
** "FSX folder" - Input the folder where FSX is installed. By default this is "C:\Program Files\Microsoft Games\Microsoft Flight Simulator X"
** "Terrain SDK" - Input the location of the FSX terrain SDK
** "FW Tools" - Input the location where you installed FW Tools. FW Tools is required for scenery that uses the FSX SDK Resample tool, such as landclass and waterclass.
** "Run SDK tools" - If you select this option FSX KML will automatically run the SDK tools to turn your Shape Files into a FSX BGL
** "Copy generated scenery to FSX Addon Scenery Folder" - If you select this option FSX KML will copy the generated BGLS to the FSX addon scenery directory
* Click the "Build" button. FSX KML will now build your scenery. The progress of the build will be displayed in the build log window. The following actions will occur during the build:-
** For each KML file in your project
*** For vector based scenery an appropriate set of Shape files is generated depending on the features that have been tagged in the KML
*** For resample based scenery an appropriate Tiff file is created.
*** An XML config file is created for use by Shp2Vec, BGLComp and Resample
** A batch file called "Run_SDK_Tools.bat" will be created. This batch file contains the appropriate commands to call the FSX SDK tools (Shp2Vec, BGLComp and Resample)
** If you have selected the "Run SDK Tools" option then the Run_SDK_Tools.bat file will be executed. This will create various scenery .BGL files ready for use by FSX
** If you have selected the "Copy generated scenery..." option then the BGL files(s) will be copied to the FSX addon scenery directory. Please note: If FSX is running and using a previous version of your BGL file then the copy will not work because FSX will have the file "locked". The easiest way to ensure your file is copied to the addon scenery folder is to make sure FSX is not running.

=== Step 3 - Testing the scenery ===

* If you selected the "Copy generated files..." option then your scenery will have been copied to the FSX addon scenery folder. Simply run FSX and goto your scenery location to test the scenery

== Scenery Design Tutorial ==

The [http://www.fsdeveloper.com/wiki/index.php?title=FSX_KML_Tutorial FSX KML Tutorial] provides help with a variety of scenery design tasks.

== Editing a KML file using FSX_KML ==

Using FSX_KML you can easily edit your KML file. The following types of edits can be performed:-

=== Copy ===
To copy a KML item (folder or polygon/polyline) select the item to copy and click the copy button.
=== Delete ===
To delete a KML item select the item to copy and click the delete button.
=== Edit ===
To edit the Name and Description attributes of a KML item select either a single item or multiple items (hold the shift key to multi-select) and then press F2 to display the inline editor. Enter the new value and press enter. Your edit will be applied to the items you selected

=== Saving your changes ===
Click the save button to write your changes back to disk..
.

=== Open in Notepad ===
Click the "Open in Notepad" button to open the selected KML file in Notepad.
=== Open in Google Earth ===
Click the "Open in Google Earth" button to open the selected KML file in Google Earth.
=== Reload a KML file ===
If you have edited the selected KML file using an external program (eg Google Earth or Notepad) then you can reload those changes back into FSX_KML by clicking the reload button.

=== Properties Tab ===

This tab shows the properties for the selected polygon or polyline.

Freeways:
Use the "NumberOfLanes" and "Traffic Direction" attributes to define freeway related data.

Hydropolygons:
Use the "SlopeX" and "SlopeY" attributes to define slope characteristics of hydropolygons.

=== Vertices Tab ===

This tab shows the vertices (ie points) for the selected polygon or polyline.

Click the "Edit" button to display the vertice editor. This editor lets you edit the vertices in several ways:-

Reversing points:
The direction of a polygon or polyline can be reversed by using the REVERSE POINTS button. Click the "Reverse" button to change the direction of points in the polygon/polyline.

Setting elevation:
You can set the elevation for all vertices by clicking the "Set Elevation" button.

Manual editing:
You can manually edit vertices (longtitude, latitude and elevation) by editing data in the vertex grid.

=== XML Tab ===

This tab shows the XML for the selected polygon or polyline.

== FSX_KML_TAGS.XML ==

[[Image:Tags.jpg|thumb|right|150px|FSX_KML_TAGS tab]]

=== What is the FSX_KML_TAGS file? ===

This file holds the "tags" that are used in the KML file to describe FSX scenery features. You can customise this file to add more tags or change existing ones.

An easy way to browse this file is by clicking on the "FSX_KML_TAGS.XML" tab in FSX KML.

This XML contains the following attributes for each "tag":-

* Tag - The unique identifier for this scenery feature. This tag is what you use to "tag" the polygons/polylines in your Google Earth KML file
* Description - A description of the scenery feature. This description is displayed in FSX KML.
* Feature Type - The type of scenery feature and must be one of the following types:-
** WATERPOLY - Water polygons such as coastline, rivers, lakes, canals etc
** WATERPOLYGPS - Low resolution water polygons for use in the GPS
** LANDCLASSPOLY - irregular shaped landclass polygons for towns, forest, beaches, park etc
** AIRPORTBOUNDRY - define airport boundries and also flatten areas and AUTOGEN EXCLUSIONS
** EXCLUSION - exclude default vector scenery from the polygon
** STREAM - create streams
** SHORELINE - create animated shorelines
** ROAD - create roads (NOT road bridges)
** FREEWAY - create moving traffic
** RAILWAY - create railways (NOT rail bridges)
** UTILITY - power lines, telegraph lines, fences etc
** SCENERYOBJECT - place scenery objects
** EXCLUSIONRECTANGLE - excludes scenery objects
** EXTRUSIONBRIDGE - creates extrusion bridges
** LANDCLASS - create land class
** WATERCLASS - create water class
* GUID - The FSX GUID for the scenery feature.

Please refer to the FSX "terrain.cfg" file and terrain SDK documentation for futher information on feature types and GUIDs

=== Editing FSX_KML_TAGS.XML using FSX KML ===

The FSX_KML_TAGS.XML file can be easily edited in FSX KML. To following edits can be performed:-

==== Copy ====
To copy an item select the item to copy and click the copy button.
==== Delete ====
To delete an item select the item to delete and click the delete button.
==== Edit ====
To edit the Tag, Description, FeatureType or GUID attributes of an item select either a single item or multiple items (hold the shift key to multi-select) and then press F2 to display the inline editor. Enter the new value and press enter. Your edit will be applied to the items you selected

==== Saving your changes ====
Click the save button to write your changes back to disk.
==== Open in Notepad ====
Click the "Open in Notepad" button to open the FSX_KML_TAGS.XML file in Notepad.
==== Reload ====
If you have edited the FSX_KML_TAGS.XML file using an external program (eg Notepad) you can reload those changes by clicking the reload button.

== Google Earth ==

=== Downloading Google Earth ===

The free version Google Earth may be downloaded from the [http://earth.google.com/ Google Earth home page]

=== Copyright of Google Earth Data ===

Scenery developers need to be aware that there may be copyright issues associated with the use of data obtained from Google Earth. Please see the [http://earth.google.com/support/ Google Earth support page] for more information on the Google Earth policy of using this data in your freeware or commercial products.

== Freeware scenery using FSX KML ==

The following freeware has used FSX KML during their development:-

* [http://library.avsim.net/esearch.php?DLID=&Name=Isle+of+Wight&FileName=&Author=Len+Hickman&CatID=fsxscen Isle of Wight (UK) reconstructed] by Len Hickman
* [http://library.avsim.net/esearch.php?DLID=&Name=Quebec+Scenery&FileName=&Author=Gilles+Gauthier&CatID=fsxscen Quebec Scenery - Lakes and Rivers] by Gilles Gauthier
* [http://library.avsim.net/esearch.php?DLID=&Name=Catalunya+Coast&FileName=&Author=Bodo+Hesse&CatID=fsxscen Catalunya Coast] by Bodo Hesse
* [http://library.avsim.net/esearch.php?DLID=&Name=Naval+air+station&FileName=&Author=Jim+Dhaenens&CatID=fsxscen Naval Air station Jacksonville (KNIP)] by Jim Dhaenens
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=103120 Naval Air Station Oceana (KNTU)] by Jim Dhaenens
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=102870 Coffs Harbour (YSCH)] by John Ross (also at www.virtualvfr.com)
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=103027 Kitimat/Terrace] by Douglas Keech
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=102995 Los Angeles "clean-up"] by Lance Tucker
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104609 Lord howe Island and Balls Pyramid] by Don Bush
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104853 Falklands 2007] by Brian Jamieson
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104000 Gloucestershire Airport] by Terry Shields
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=105386 Okanagan Valley Landclass and Rivers] by Alex Sievert
* [http://library.avsim.net/esearch.php?DLID=106386&CatID=fsxscen Gold Coast Airport (YBCG)] by John Ross
* [http://marcoh.gratisim.fr Photorealistic Town of Nantes in France] by Marc-henri Guitteny
* [http://library.avsim.net/esearch.php?DLID=109752&CatID=fsxscen Utah Complete v1.0] by James Udall
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=111154 Bushflight Northwest] by Bill Dick / Phil "Snowman" Cayton / Chris Brisland
* [http://library.avsim.net/esearch.php?DLID=114132&CatID=fsxscen Wake Island] by Tony Arnold
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=117501 SICILY VFR X - Lakes and Reservoirs] by Giovanni Miduri
*[http://library.avsim.net/download.php?DLID=121703 Chernobyl Exclusion Zone] by Mike Dalgleish
*[http://fly-wonderful-islands.com/page_89.html La gomera GCGM Spain] by Allen Cremeen
* [http://marcoh.gratisim.fr Photorealistic St Pierre & Miquelon archipelago near Newfoundland] by Marc-henri Guitteny
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=105600 Quebec city v1.0] by Jean St-Cyr and Gilles Boily
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=139471 Quebec city v2.0] by Jean St-Cyr, Gilles Boily, Gilles Gauthier and Jean-Pierre Fillion
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=144264 Angel Falls for FSX] by Jean St-Cyr
Freeware authors please list your freeware scenery here!

== Commercial scenery using FSX KML ==

The following commercial scenery has used FSX KML during their development:-

* [http://www.imaginesim.com/kcvg01.htm KCVG Cincinnati Northern Kentucky International Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/tjsj01.htm TJSJ San Juan Luis Munoz Marin Airport, Puerto Rico] by Imagine Simulation
* [http://www.imaginesim.com/kclt01.htm KCLT Charlotte Douglas Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/mynn01.htm MYNN Nassau International, Bahamas] by Imagine Simulation
* [http://www.imaginesim.com/klga01.htm KLGA New York La Guardia Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/kmci01.htm KMCI Kansas City International Airport, USA] by Imagine Simulation
* [http://www.aerosoft-shop2.com/products/helgolandx/helgolandx.html Helgoland X] by AeroSoft
* [http://www.aerosoft-shop2.com/products/monacox/monacox.html Monaco X] by AeroSoft
* [http://www.aerosoft-shop2.com/products/aspenx/aspenx.html Aspen X] by AeroSoft
* [http://secure.simmarket.com/product_info.php?products_id=2361 Pantanal - The Wetlands] by CenaReal
* [http://www.fly-wonderful-islands.com/Slide/gclp_v1.html GCLP Gran Canaria Airport Canary Islands Spain] by Fly Wonderful Islands
* [http://www.fly-wonderful-islands.com/FWI_GCRRv2/Slide_GCRR_V2/FWI_GCRR_V2.html Lanzarote GCRR Airport Canary Islands Spain] by Fly Wonderful Islands
Please list other commercial scenery here.

== End User Licence ==

Copyright Â© 2007 Innova Software ALL RIGHTS RESERVED

FSX KML ("Software") is distributed without charge to FSX add-on designers, redistribution of the original ZIP file is not allowed. You are NOT allowed to sell this software or ask money for its distribution.

FSX KML may be used free of charge for the production of both freeware and commercial add-ons (including sceneries,missions,aircraft) subject to the following terms and conditions:-
* You notify Innova Software of the use of FSX KML in your add-on
* You give Innova Software a free copy of your add-on (and any updates)
* In your readme file you say that FSX KML was used to help with the production of your add-on
* The copyright and any intellectual property relating to the FSX KML software shall remain the property of Innova Software
* LIMITED WARRANTY - INNOVA SOFTWARE SHALL NOT BE RESPONSIBLE IN TORT OR IN CONTRACT FOR ANY LOSS OR DAMAGE HOWSOEVER CAUSED TO THE PROPERTY OR PERSON OF YOURSELF OR ANY THIRD PARTY AS A RESULT OF ANY DEFECT IN THE SOFTWARE WHETHER PATENT OR LATENT OR AS A RESULT OF ANY FAULT, NEGLIGENCE, WRONGFUL ACT OR OMISSION OF INNOVA SOFTWARE OR ANY OF ITS SERVANTS, EMPLOYEES, CONTRACTS AND AGENTS, AND YOU INDEMNIFY INNOVA SOFTWARE AGAINST ANY CLAIMS MADE AGAINST IT BY ANY THIRD PARTY ARISING OUT OF ANY SUCH DEFAULT OR FAULT, NEGLIGENCE, WRONGFUL ACT OR OMISSION AND IN NO EVENT SHALL INNOVA SOFTWARE BE LIABLE FOR ANY CLAIMS OR DAMAGES INCLUDING, BUT NOT LIMITED TO CLAIMS OF FAULTY DESIGN, NEGLIGENT OR MISLEADING ADVICE, DAMAGES ARISING FROM LOSS OR USE OF THE SOFTWARE AND/OR SUPPLY OF SERVICES; AND ANY INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES OR INJURY TO ANY PERSON, CORPORATION OR OTHER ENTITY BY REASON OF THE PROVISION OF THE SOFTWARE AND/OR PROVISION OF SERVICES PURSUANT TO THESE TERMS AND CONDITIONS

Developers can email acceptance of these terms and conditions to fsx_kml@innovasoftware.com.

== Release History ==

=== v1.00 Beta - 19th 0ct 2006 ===

This is first beta release of FSX KML

=== v1.01 Beta - 19th 0ct 2006 ===

Issues resolved:-
* Fixed error with FSX_KML_TAGS.XML file not found

=== v1.02 Beta - 21st 0ct 2006 ===

Issues resolved:-
* Fixed error reading polygon/poylines. FSX KML could sometimes insert an erroneous point of 0,0

=== v1.03 Beta - 28th 0ct 2006 ===

New features and issues resolved:-
* Better handle tags in description field. Be less strict about "whitespace" and cr/lf
* Better handle international settings for decimals
* Add more excludes to fsx_kml_tags.xml (see tags starting with "exclude__")
* Add support for moving kml items up/down
* Add support for moving kml items via drag drop
* Add support for creating new kml folder
* Create shapes in order they appear in the KML
* Assign UUID (starting at 1) to each shape in the KML based on its order in the KML

Known issues (Features not implemented in this release):-
* Freeway tags (moving traffic) - in v1.03 you must manually edit the FW .DBF file to set traffic density and direction

=== v1.04 Beta - 20th Jan 2007 ===

New features and issues resolved:-

* Use INI file (FSX_KML.INI) to remember settings including list of KML files and FSX folder settings
* Allow multi select of KML files in Add KML file dialog
* Display points for selected polygon/polyline
* Add REVERSE POINTS button to allow direction of polygon/polyline to be reversed
* Add POLYGONHOLE tag to support "holes" in polygons, eg for making islands in rivers
* Add LEGACY_LANDWATERMASK_WATER_NOFLATTEN tag for water polygons that "cling" to mesh
* Default freeway traffic to one lane of traffic

=== v1.05 Beta - 21st Jan 2007 ===

New features and issues resolved:-

* Added "Automatically Reverse Points In Polygon Holes" build option. This option will auto reverse points for polygon holes when creating the shape file. Apparently Google Earth always writes polygons in a clockwise fashion to the KML file irrespective of which way they are actually drawn in Google Earth. This option simplifies the creation of polygon holes because you no longer need to manually reverse point order in FSX KML. Option is on by default.
* Added "Output Folder" build option. This lets you specify the folder where files are written during the build process
* Fixed error when loading the saved list of KML files and a KML file can longer be found.

=== v1.05.1 Beta - 21st Jan 2007 ===

Issues resolved:-

* Fixed bug where directory would not be changed prior to running the RUN_SDK_TOOLS batch file

=== v1.06 Beta - 14th Apr 2007 ===

New features:-

* Added grid to allow manual editing of polygon/polyline points (longitude,latitude,elevation)
* Added button for setting all points in polygon/polyline to a specific elevation
* Added support for tag parameters (eg freeway traffic data and hydro poly slopeX/Y)
* Added option to save backups to backup subdirectory (on by default).
* Added XML tab to show XML for highlighted node
* Remember window size and position

Issues resolved:-

* Changed tag name of "Park" to "LandClassPoly" since landclass polys can be used for more than just parks! Existing "Park" tags are automatically renamed to "LandClassPoly"
* Handle extra '.' in filenames

=== v1.07 Beta - 25th Apr 2007 ===

New features:-

* Added "Shape" tab with support for shape viewing. Select single (or multiple) polygon/polylines to see its shape. Selecting a folder will show all shapes in that folder and any sub folders.
* Added "Select All" function (Ctrl A) to select all polylines/polygons
* Added "New" button to Vertices form to insert vertice.
* Added "Copy" button to Vertices form to copy the selected vertice.
* Added "Delete" button to Vertices form to delete selected vertice.
* Added "Move Up" and "Move Down" button to Vertices form to move selected vertice up or down in list.
* Added Options menu to main form. Moved "Save Backups" to this menu
* Added "Remember Window Position and Size" to the options menu

Issues resolved:-

* Updated the "About" form to credit the 3rd party development libraries used (eg Shapelib)
* Fixed misplaced longitude and latitude labels on vertice grid

=== v1.08 Beta - 18th May 2007 ===

New features:-

* Add BGLCOMP support for placing of FSX library objects along polyline. The use of "Variance" parameters below helps create more naturalistic looking scenery by applying random variance to object positioning. Support the following parameters:-
** Altitude AGL or MSL
** Altitude variance - Random variance in meters applied to alitude (use 0 for no variance)
** Pitch (0 - 360)
** Pitch variance - Random variance in degrees (0 - 180) applied to pitch (use 0 for no variance)
** Bank (0 - 360)
** Bank variance - Random variance in degrees (0 - 180) applied to bank (use 0 for no variance)
** HeadingType
*** Track - Heading of each object follows the direction of each polyline segment
*** Fixed - Heading of all objects is specified by Heading parameter
*** Random - Heading is random for each object
*** Elevation - Heading for each object is specified by elevation of associated polyline vertice
** Heading (0 - 360) - Used when HeadingType = Fixed
** Heading variance - Random variance in degrees (0 - 180) applied to heading (use 0 for no variance)
** Scale - Scale multiply of object (defaults to 1.0)
** ScaleVariance - Random variance in scale to apply to objects. (use 0 for no variance)
** ImageComplexity - VerySparse, Sparse, Normal, Dense, VeryDense, ExtremelyDense
* FSX_KML_Tags tab - Add tags for all default FSX scenery library objects
* Build tab - Add button for setting BGLComp SDK path
* Build tab - Add "Open" button for output folder path to open Windows Explorer on that folder

Issues resolved:-

* Fixed issue with copy button

=== v1.09 Beta - 23rd June 2007 ===

New features:-

* Added BGLCOMP support for scenery exclusion rectangles ("ExclusionRectangle" tag). The exclusion rectangle will be defined by the "bounding" rectangle of the polyline/polygon. Supports the following parameters
** ExcludeAllObjects
** ExcludeBeaconObjects
** ExcludeEffectObjects
** ExcludeGenericBuildingObjects
** ExcludeLibraryObjects
** ExcludeTaxiwaySignObjects
** ExcludeTriggerObjects
** ExcludeWindsockObjects
** ImageComplexity - VerySparse, Sparse, Normal, Dense, VeryDense, ExtremelyDense
* Added BGLCOMP support for Extrusion Bridges ("ExtrusionBridge" tag). Draw a polyline and tag it with "ExclusionBridge", then use the vertice editor to set the height of each bridge segment.
* Added "Change to" button on the Vertice Editor to change shape type from polygon to polyline and vice versa
* Enhanced polygons holes so that if a polygon cannot be found in the same folder as polygon hole ("polygon folder") then the parent folder is searched for the first polygon preceding the polygon folder. This makes it possible to better organize a project by placing polygon holes (i.e islands) in a sub folder and still have them associated with a water polygon in a parent folder

=== v1.10 Beta - 19th August 2007 ===

New features:-

* Land class tiles
* Water class tiles

== Development Roadmap ==

The following features are planned for upcoming releases:-

=== Future releases ===
* Update this manual :)
* Add 10 minute autosave
* Add following params to BGLCOMP support:-
** Heading Type
*** FixedTrack - Heading of all objects is fixed to the direction of first polyline segment
** Divergence - Random divergence (in meters) from vertice. Applied in direction which is perpendicular to direction of polyline segment (use 0 for no variance)
* Add "AutoPolygonHole" to polygon properties sheet. This allows a polygon hole to be automatically created in the shape of the polygon, and removes the need manually create a hole (by copying and tagging as hole)
* Fix - Ensure lon/lat uses '.' and not ','
* FSX_KML_Tags tab - Add support for tag groups
* Add BGLCOMP support for Tag Groups. Tag grouping allows the scenery designer to group together similar scenery library objects into a single group. For example, when populating a car park the designer could use a tag group containing a variety of car models. This would result in car models being chosen at random from the tag group.
* Add shape viewer to Vertice Editor form and have it refresh as vertices are edited.
* Add "Fly to" button to Vertices Editor form to move FSX aircraft to the selected vertice
* Add "Paste Aircraft pos" button to Vertices Editor form to paste the current location of aircraft (longtitude, latitude, and optionally altitude) into the list of Vertices.
* Export - Ability to export selected polygons/polylines to a CSV file, with option for long/lat/elevation ordering
* Scenery Placer - Add support for dynamically previewing scenery objects while FSX is running. This allows very precise and interactive control over the objects placement and orientation without the need to build a BGL and reload FSX.
* Placing FSX library objects inside a polygon. Allow number of objects and elevation to be specified. Objects will be distributed randomly within the polygon. This can be used to populate livestock, wildlife, boats/ships in harbors, people on beaches, birds, hot air balloons etc
* FSX_KML_Tags tab - Texture preview for land class polygons and tiles tags
* FSX_KML_Tags tab - Scenery object preview for default FSX scenery objects
* Ability to inject a QMID 11 grid into the KML to aid with visualization of exclusion areas
* New, Open and Save project buttons to support multiple projects.
* "Check for Update" menu option to check online for updates.

* If possible conditional display of FSX scenery library objects based on various triggers such as date/time, weather conditions and probability factor. For example, this would allow harbors to be populated with pleasure craft on sunny warm days, but not at night or in cold weather. Would allow forest fires to be generated in hot, windy conditions.
* If possible ability to animate FSX scenery library objects along a polyline
* "Photo scenery" ground textures
* Flight plan generation along polyline


== Software by this author ==
[http://fsdeveloper.com/wiki/index.php?title=FSX_KML FSX_KML]

[http://fsdeveloper.com/wiki/index.php?title=FSX_Photoscene FSX_PhotoScene]

[http://fsdeveloper.com/wiki/index.php?title=SRTM_To_BGL SRTM_To_BGL]

[[Category:Manuals]]
[[Category:Tools]]
[[category:Scenery_Design]]

FSX KML

2012-12-29T14:35:20Z

GaryGB: /* Downloading FSX KML */

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
== Introduction ==

[[Image:before_and_after.jpg|thumb|right|150px|Before and after screenshot]]

FSX KML is a freeware scenery design tool for Microsoft Flight Simulator X (FSX).

It converts KML (Keyhole Markup Language) files generated by Google Earth into FSX scenery.

Using Google Earth to draw polygons and polylines you can accurately and easily create many types of scenery.

===Shp2Vec based scenery===
FSX KML uses the FSX SDK Shp2Vec tool to create the following types of vector scenery:-

* Water polygons including oceans, rivers, lakes and canals
* Islands inside water features
* Irregular shaped land class polygons for cities, parks, beaches, forest, golf courses etc
* Airport boundaries and flatten polygons and AUTOGEN EXCLUSIONS
* Shorelines
* Streams
* Roads
* Railways
* Freeways (ie Moving traffic)
* Utility lines (eg power and telephone lines)
* Exclusions polygons (for vector data)

===BGLComp based scenery===
FSX KML uses the FSX SDK BGLComp tool to create the following types of scenery:-

* Place scenery objects (from the FSX library) along a polyline using a wide variety of [http://www.fsdeveloper.com/wiki/index.php?title=FSX_KML#v1.08_Beta_-_18th_May_2007 placement options]
* Exclusion rectangles
* Extrusion bridges

===Resample based scenery===
FSX KML uses the FSX SDK Resample tool to create the following types of scenery:-

* Land class tiles
* Water class tiles

'''Make sure you also download and install [http://fsdeveloper.com/wiki/index.php?title=FSX_KML#Installing_FWTools FWTools] which is required for creating these types of scenery.'''

== Support Forum ==

You can discuss FSX KML at the fsdeveloper.com
[http://www.fsdeveloper.com/forum/forumdisplay.php?f=81 FSX KML forum]. This is the best place to ask support questions about FSX_KML since other FSX_KML users (as well as the author) can answer your questions.

== Downloading FSX KML ==

The latest version of FSX KML (1.10) can be downloaded from:-

* AVSIM - http://library.avsim.net/esearch.php?CatID=fsxsd&DLID=108495 < dead link >
* Flightsim.com - http://www.flightsim.com/vbfs/fslib.php?do=copyright&fid=115211 < live link: 12, 2012 >
* The Scenery Hall of Fame - http://www.scenery.org/graphical_editors.htm < dead link >

== Installation ==

=== Installing FSX KML ===

FSX KML can be installed in a folder of your choice. Simply unzip the FSX KML installation zip file into the desired folder.

After unzipping the installation file you should have the following files:-

* FSX_KML.exe
* ShapeLib129.dll
* FreeImage.DLL
* FSX_KML_TAGS.XML


=== Installing the FSX Software Development Kit (SDK) ===

To generate FSX scenery you will need the FSX SDK, which is distributed with the FSX Deluxe version.
To install the SDK:

(1) Browse the FSX Deluxe Edition Disk 1

(2) Open the SDK sub-folder

(3) Double-click the setup.exe

(4) Tell it where to install. Default is C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK

If the SDK is not installed in the default SDK folder you must specify its location on the FSX_KML build tab.

For more info on the SDK installation and Service packs: [http://www.fsdeveloper.com/wiki/index.php?title=SDK_Installation_%28FSX%29 http://www.fsdeveloper.com/wiki/index.php?title=SDK_Installation_%28FSX%29]

=== Installing FWTools ===

FSX KML makes use of the freeware tool set called [http://fwtools.maptools.org/ FWTools]. FW Tools is required for scenery that uses the FSX SDK Resample tool, such as landclass and waterclass.

Download and install the latest version of FWTools.

Specify the location of FWTools on the FSX KML Build tab.

=== Installing Google Earth ===

If you notice some null values for vertices when importing KML files from Google Earth, pls consider to revert to an older version of GE. More information about this issue you can find [ http://www.fsdeveloper.com/forum/showthread.php?p=144034 here]

Google Earth, Vers 5.1 is available here: [http://www.google.com/earth/download/thanks.html#release=previous#os=win#single=yes Google Earth 5.1]

== Building Scenery ==

Building your own scenery with FSX KML is easy.

=== Step 1 - Creating a KML file with Google Earth ===

The first step in creating your FSX scenery is to create a KML file by using Google Earth to "trace" scenery features.

==== Creating polygons and polylines ====

Using Google Earth create a polygon using the "Add Poly" function or create a polyline using the "Add Path" function,
and then trace the scenery feature (for example a lake or road).

After you click the "Add Poly" or "Add Path button" you will be presented with a form as shown to the right

[[Image:GE-polygon-dialog.jpg|thumb|right|150px|Google Earth dialog for creating new polygon or polyline]]

* Name - Give your polygon or polyline a description or leave blank

* Description - This is where you "tag" your polygon or polyline. You may enter a tag from FSX_KML_TAGS.XML or leave blank and tag later using FSX_KML

* Style & Color - You may choose the border and fill color for polyline or polygon

* Altitude - You may enter an altitude for your polyline or polygon. This can be used to specify the elevation of lakes. You may also enter the elevation later using FSX_KML. All elevations must be entered in meters.

Begin tracing your polyline or polygon. You may either click the mouse or hold the mouse button down and drag the mouse to create vertices.

* Use your mouse wheel to zoom the view in and out vertically.

* Use the up, down, left, right arrow keys to move the view horizontally.

* Hold Shift and press left or right arrow to rotate the view.

* Hold Ctrl and press up or down arrow to tilt the view.

To make things easier; it is good to get into the habit of drawing polygon vertices in the same direction, perhaps always draw clockwise. That way if you decide to add new vertices to define details better, then you can simply click to the right of the currently selected vertex (blue) to add a new one in. Avoid adding vertices that make the polygon twisted.
While polygon "properties" is open, take the time to change the transparency (from the colour tab)- if you leave it opaque, then you end up covering important details and spotting mistakes is more difficult.

Once you have finished click OK to save your polygon or polyline.

To edit your polyline or polygon highlight it, right click the mouse and choose properties.

==== "Tagging" the scenery features ====

To describe what scenery feature your polygon or polyline represents it needs to be "tagged". The file FSX_KML_TAGS.XML contains a list of the tags you can use.

There are two ways to tag a polygon or polyline:-

* Place the name of the tag in the description field of the polygon or polyline.
* Place the name of the tag in the description field of the parent folder that contains the polygon or polyline. If a polygon/polyline has no tag then it will inherit its tag from the parent folder.

You can place these tags in GE using the properties dialog of the polygon or polyline, or you can use FSX_KML to place these tags.

To tag using FSX_KML click on a description "cell" and press F2. An arrow will be displayed so then click on the arrow to drop down a list of valid tags. Highlight the tag you want and press ENTER. If you had multi-selected several cells then all the selected cells will be tagged. To select multiple cells hold down the shift key while clicking cells.

==== Saving your work to a KML file ====

Once you're done drawing your polygon(s) or polyline(s), simply right-click on the top-most folder you created (or the polygon itself if you didn't create folders) under the "My Places" tab on the left side of your GE window. Select "Save As", makes sure that you choose .kml as the file type, and select your desired location in your file structure.

=== Step 2 - Processing the KML file with FSX KML ===

[[Image:project.jpg|thumb|right|150px|The Project tab]] [[Image:build.jpg|thumb||150px|The Build tab]]

* Run FSX_KML
* On the "Project" tab, click the "Add KML" button and choose a KML file. The contents of the selected KML file will be displayed. You may add multiple KML files. A FSX BGL file will be generated for each KML input file.
* Change to the "Build" tab
* Set the following build options:-
** "FSX folder" - Input the folder where FSX is installed. By default this is "C:\Program Files\Microsoft Games\Microsoft Flight Simulator X"
** "Terrain SDK" - Input the location of the FSX terrain SDK
** "FW Tools" - Input the location where you installed FW Tools. FW Tools is required for scenery that uses the FSX SDK Resample tool, such as landclass and waterclass.
** "Run SDK tools" - If you select this option FSX KML will automatically run the SDK tools to turn your Shape Files into a FSX BGL
** "Copy generated scenery to FSX Addon Scenery Folder" - If you select this option FSX KML will copy the generated BGLS to the FSX addon scenery directory
* Click the "Build" button. FSX KML will now build your scenery. The progress of the build will be displayed in the build log window. The following actions will occur during the build:-
** For each KML file in your project
*** For vector based scenery an appropriate set of Shape files is generated depending on the features that have been tagged in the KML
*** For resample based scenery an appropriate Tiff file is created.
*** An XML config file is created for use by Shp2Vec, BGLComp and Resample
** A batch file called "Run_SDK_Tools.bat" will be created. This batch file contains the appropriate commands to call the FSX SDK tools (Shp2Vec, BGLComp and Resample)
** If you have selected the "Run SDK Tools" option then the Run_SDK_Tools.bat file will be executed. This will create various scenery .BGL files ready for use by FSX
** If you have selected the "Copy generated scenery..." option then the BGL files(s) will be copied to the FSX addon scenery directory. Please note: If FSX is running and using a previous version of your BGL file then the copy will not work because FSX will have the file "locked". The easiest way to ensure your file is copied to the addon scenery folder is to make sure FSX is not running.

=== Step 3 - Testing the scenery ===

* If you selected the "Copy generated files..." option then your scenery will have been copied to the FSX addon scenery folder. Simply run FSX and goto your scenery location to test the scenery

== Scenery Design Tutorial ==

The [http://www.fsdeveloper.com/wiki/index.php?title=FSX_KML_Tutorial FSX KML Tutorial] provides help with a variety of scenery design tasks.

== Editing a KML file using FSX_KML ==

Using FSX_KML you can easily edit your KML file. The following types of edits can be performed:-

=== Copy ===
To copy a KML item (folder or polygon/polyline) select the item to copy and click the copy button.
=== Delete ===
To delete a KML item select the item to copy and click the delete button.
=== Edit ===
To edit the Name and Description attributes of a KML item select either a single item or multiple items (hold the shift key to multi-select) and then press F2 to display the inline editor. Enter the new value and press enter. Your edit will be applied to the items you selected

=== Saving your changes ===
Click the save button to write your changes back to disk..
.

=== Open in Notepad ===
Click the "Open in Notepad" button to open the selected KML file in Notepad.
=== Open in Google Earth ===
Click the "Open in Google Earth" button to open the selected KML file in Google Earth.
=== Reload a KML file ===
If you have edited the selected KML file using an external program (eg Google Earth or Notepad) then you can reload those changes back into FSX_KML by clicking the reload button.

=== Properties Tab ===

This tab shows the properties for the selected polygon or polyline.

Freeways:
Use the "NumberOfLanes" and "Traffic Direction" attributes to define freeway related data.

Hydropolygons:
Use the "SlopeX" and "SlopeY" attributes to define slope characteristics of hydropolygons.

=== Vertices Tab ===

This tab shows the vertices (ie points) for the selected polygon or polyline.

Click the "Edit" button to display the vertice editor. This editor lets you edit the vertices in several ways:-

Reversing points:
The direction of a polygon or polyline can be reversed by using the REVERSE POINTS button. Click the "Reverse" button to change the direction of points in the polygon/polyline.

Setting elevation:
You can set the elevation for all vertices by clicking the "Set Elevation" button.

Manual editing:
You can manually edit vertices (longtitude, latitude and elevation) by editing data in the vertex grid.

=== XML Tab ===

This tab shows the XML for the selected polygon or polyline.

== FSX_KML_TAGS.XML ==

[[Image:Tags.jpg|thumb|right|150px|FSX_KML_TAGS tab]]

=== What is the FSX_KML_TAGS file? ===

This file holds the "tags" that are used in the KML file to describe FSX scenery features. You can customise this file to add more tags or change existing ones.

An easy way to browse this file is by clicking on the "FSX_KML_TAGS.XML" tab in FSX KML.

This XML contains the following attributes for each "tag":-

* Tag - The unique identifier for this scenery feature. This tag is what you use to "tag" the polygons/polylines in your Google Earth KML file
* Description - A description of the scenery feature. This description is displayed in FSX KML.
* Feature Type - The type of scenery feature and must be one of the following types:-
** WATERPOLY - Water polygons such as coastline, rivers, lakes, canals etc
** WATERPOLYGPS - Low resolution water polygons for use in the GPS
** LANDCLASSPOLY - irregular shaped landclass polygons for towns, forest, beaches, park etc
** AIRPORTBOUNDRY - define airport boundries and also flatten areas and AUTOGEN EXCLUSIONS
** EXCLUSION - exclude default vector scenery from the polygon
** STREAM - create streams
** SHORELINE - create animated shorelines
** ROAD - create roads (NOT road bridges)
** FREEWAY - create moving traffic
** RAILWAY - create railways (NOT rail bridges)
** UTILITY - power lines, telegraph lines, fences etc
** SCENERYOBJECT - place scenery objects
** EXCLUSIONRECTANGLE - excludes scenery objects
** EXTRUSIONBRIDGE - creates extrusion bridges
** LANDCLASS - create land class
** WATERCLASS - create water class
* GUID - The FSX GUID for the scenery feature.

Please refer to the FSX "terrain.cfg" file and terrain SDK documentation for futher information on feature types and GUIDs

=== Editing FSX_KML_TAGS.XML using FSX KML ===

The FSX_KML_TAGS.XML file can be easily edited in FSX KML. To following edits can be performed:-

==== Copy ====
To copy an item select the item to copy and click the copy button.
==== Delete ====
To delete an item select the item to delete and click the delete button.
==== Edit ====
To edit the Tag, Description, FeatureType or GUID attributes of an item select either a single item or multiple items (hold the shift key to multi-select) and then press F2 to display the inline editor. Enter the new value and press enter. Your edit will be applied to the items you selected

==== Saving your changes ====
Click the save button to write your changes back to disk.
==== Open in Notepad ====
Click the "Open in Notepad" button to open the FSX_KML_TAGS.XML file in Notepad.
==== Reload ====
If you have edited the FSX_KML_TAGS.XML file using an external program (eg Notepad) you can reload those changes by clicking the reload button.

== Google Earth ==

=== Downloading Google Earth ===

The free version Google Earth may be downloaded from the [http://earth.google.com/ Google Earth home page]

=== Copyright of Google Earth Data ===

Scenery developers need to be aware that there may be copyright issues associated with the use of data obtained from Google Earth. Please see the [http://earth.google.com/support/ Google Earth support page] for more information on the Google Earth policy of using this data in your freeware or commercial products.

== Freeware scenery using FSX KML ==

The following freeware has used FSX KML during their development:-

* [http://library.avsim.net/esearch.php?DLID=&Name=Isle+of+Wight&FileName=&Author=Len+Hickman&CatID=fsxscen Isle of Wight (UK) reconstructed] by Len Hickman
* [http://library.avsim.net/esearch.php?DLID=&Name=Quebec+Scenery&FileName=&Author=Gilles+Gauthier&CatID=fsxscen Quebec Scenery - Lakes and Rivers] by Gilles Gauthier
* [http://library.avsim.net/esearch.php?DLID=&Name=Catalunya+Coast&FileName=&Author=Bodo+Hesse&CatID=fsxscen Catalunya Coast] by Bodo Hesse
* [http://library.avsim.net/esearch.php?DLID=&Name=Naval+air+station&FileName=&Author=Jim+Dhaenens&CatID=fsxscen Naval Air station Jacksonville (KNIP)] by Jim Dhaenens
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=103120 Naval Air Station Oceana (KNTU)] by Jim Dhaenens
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=102870 Coffs Harbour (YSCH)] by John Ross (also at www.virtualvfr.com)
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=103027 Kitimat/Terrace] by Douglas Keech
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=102995 Los Angeles "clean-up"] by Lance Tucker
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104609 Lord howe Island and Balls Pyramid] by Don Bush
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104853 Falklands 2007] by Brian Jamieson
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104000 Gloucestershire Airport] by Terry Shields
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=105386 Okanagan Valley Landclass and Rivers] by Alex Sievert
* [http://library.avsim.net/esearch.php?DLID=106386&CatID=fsxscen Gold Coast Airport (YBCG)] by John Ross
* [http://marcoh.gratisim.fr Photorealistic Town of Nantes in France] by Marc-henri Guitteny
* [http://library.avsim.net/esearch.php?DLID=109752&CatID=fsxscen Utah Complete v1.0] by James Udall
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=111154 Bushflight Northwest] by Bill Dick / Phil "Snowman" Cayton / Chris Brisland
* [http://library.avsim.net/esearch.php?DLID=114132&CatID=fsxscen Wake Island] by Tony Arnold
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=117501 SICILY VFR X - Lakes and Reservoirs] by Giovanni Miduri
*[http://library.avsim.net/download.php?DLID=121703 Chernobyl Exclusion Zone] by Mike Dalgleish
*[http://fly-wonderful-islands.com/page_89.html La gomera GCGM Spain] by Allen Cremeen
* [http://marcoh.gratisim.fr Photorealistic St Pierre & Miquelon archipelago near Newfoundland] by Marc-henri Guitteny
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=105600 Quebec city v1.0] by Jean St-Cyr and Gilles Boily
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=139471 Quebec city v2.0] by Jean St-Cyr, Gilles Boily, Gilles Gauthier and Jean-Pierre Fillion
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=144264 Angel Falls for FSX] by Jean St-Cyr
Freeware authors please list your freeware scenery here!

== Commercial scenery using FSX KML ==

The following commercial scenery has used FSX KML during their development:-

* [http://www.imaginesim.com/kcvg01.htm KCVG Cincinnati Northern Kentucky International Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/tjsj01.htm TJSJ San Juan Luis Munoz Marin Airport, Puerto Rico] by Imagine Simulation
* [http://www.imaginesim.com/kclt01.htm KCLT Charlotte Douglas Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/mynn01.htm MYNN Nassau International, Bahamas] by Imagine Simulation
* [http://www.imaginesim.com/klga01.htm KLGA New York La Guardia Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/kmci01.htm KMCI Kansas City International Airport, USA] by Imagine Simulation
* [http://www.aerosoft-shop2.com/products/helgolandx/helgolandx.html Helgoland X] by AeroSoft
* [http://www.aerosoft-shop2.com/products/monacox/monacox.html Monaco X] by AeroSoft
* [http://www.aerosoft-shop2.com/products/aspenx/aspenx.html Aspen X] by AeroSoft
* [http://secure.simmarket.com/product_info.php?products_id=2361 Pantanal - The Wetlands] by CenaReal
* [http://www.fly-wonderful-islands.com/Slide/gclp_v1.html GCLP Gran Canaria Airport Canary Islands Spain] by Fly Wonderful Islands
* [http://www.fly-wonderful-islands.com/FWI_GCRRv2/Slide_GCRR_V2/FWI_GCRR_V2.html Lanzarote GCRR Airport Canary Islands Spain] by Fly Wonderful Islands
Please list other commercial scenery here.

== End User Licence ==

Copyright Â© 2007 Innova Software ALL RIGHTS RESERVED

FSX KML ("Software") is distributed without charge to FSX add-on designers, redistribution of the original ZIP file is not allowed. You are NOT allowed to sell this software or ask money for its distribution.

FSX KML may be used free of charge for the production of both freeware and commercial add-ons (including sceneries,missions,aircraft) subject to the following terms and conditions:-
* You notify Innova Software of the use of FSX KML in your add-on
* You give Innova Software a free copy of your add-on (and any updates)
* In your readme file you say that FSX KML was used to help with the production of your add-on
* The copyright and any intellectual property relating to the FSX KML software shall remain the property of Innova Software
* LIMITED WARRANTY - INNOVA SOFTWARE SHALL NOT BE RESPONSIBLE IN TORT OR IN CONTRACT FOR ANY LOSS OR DAMAGE HOWSOEVER CAUSED TO THE PROPERTY OR PERSON OF YOURSELF OR ANY THIRD PARTY AS A RESULT OF ANY DEFECT IN THE SOFTWARE WHETHER PATENT OR LATENT OR AS A RESULT OF ANY FAULT, NEGLIGENCE, WRONGFUL ACT OR OMISSION OF INNOVA SOFTWARE OR ANY OF ITS SERVANTS, EMPLOYEES, CONTRACTS AND AGENTS, AND YOU INDEMNIFY INNOVA SOFTWARE AGAINST ANY CLAIMS MADE AGAINST IT BY ANY THIRD PARTY ARISING OUT OF ANY SUCH DEFAULT OR FAULT, NEGLIGENCE, WRONGFUL ACT OR OMISSION AND IN NO EVENT SHALL INNOVA SOFTWARE BE LIABLE FOR ANY CLAIMS OR DAMAGES INCLUDING, BUT NOT LIMITED TO CLAIMS OF FAULTY DESIGN, NEGLIGENT OR MISLEADING ADVICE, DAMAGES ARISING FROM LOSS OR USE OF THE SOFTWARE AND/OR SUPPLY OF SERVICES; AND ANY INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES OR INJURY TO ANY PERSON, CORPORATION OR OTHER ENTITY BY REASON OF THE PROVISION OF THE SOFTWARE AND/OR PROVISION OF SERVICES PURSUANT TO THESE TERMS AND CONDITIONS

Developers can email acceptance of these terms and conditions to fsx_kml@innovasoftware.com.

== Release History ==

=== v1.00 Beta - 19th 0ct 2006 ===

This is first beta release of FSX KML

=== v1.01 Beta - 19th 0ct 2006 ===

Issues resolved:-
* Fixed error with FSX_KML_TAGS.XML file not found

=== v1.02 Beta - 21st 0ct 2006 ===

Issues resolved:-
* Fixed error reading polygon/poylines. FSX KML could sometimes insert an erroneous point of 0,0

=== v1.03 Beta - 28th 0ct 2006 ===

New features and issues resolved:-
* Better handle tags in description field. Be less strict about "whitespace" and cr/lf
* Better handle international settings for decimals
* Add more excludes to fsx_kml_tags.xml (see tags starting with "exclude__")
* Add support for moving kml items up/down
* Add support for moving kml items via drag drop
* Add support for creating new kml folder
* Create shapes in order they appear in the KML
* Assign UUID (starting at 1) to each shape in the KML based on its order in the KML

Known issues (Features not implemented in this release):-
* Freeway tags (moving traffic) - in v1.03 you must manually edit the FW .DBF file to set traffic density and direction

=== v1.04 Beta - 20th Jan 2007 ===

New features and issues resolved:-

* Use INI file (FSX_KML.INI) to remember settings including list of KML files and FSX folder settings
* Allow multi select of KML files in Add KML file dialog
* Display points for selected polygon/polyline
* Add REVERSE POINTS button to allow direction of polygon/polyline to be reversed
* Add POLYGONHOLE tag to support "holes" in polygons, eg for making islands in rivers
* Add LEGACY_LANDWATERMASK_WATER_NOFLATTEN tag for water polygons that "cling" to mesh
* Default freeway traffic to one lane of traffic

=== v1.05 Beta - 21st Jan 2007 ===

New features and issues resolved:-

* Added "Automatically Reverse Points In Polygon Holes" build option. This option will auto reverse points for polygon holes when creating the shape file. Apparently Google Earth always writes polygons in a clockwise fashion to the KML file irrespective of which way they are actually drawn in Google Earth. This option simplifies the creation of polygon holes because you no longer need to manually reverse point order in FSX KML. Option is on by default.
* Added "Output Folder" build option. This lets you specify the folder where files are written during the build process
* Fixed error when loading the saved list of KML files and a KML file can longer be found.

=== v1.05.1 Beta - 21st Jan 2007 ===

Issues resolved:-

* Fixed bug where directory would not be changed prior to running the RUN_SDK_TOOLS batch file

=== v1.06 Beta - 14th Apr 2007 ===

New features:-

* Added grid to allow manual editing of polygon/polyline points (longitude,latitude,elevation)
* Added button for setting all points in polygon/polyline to a specific elevation
* Added support for tag parameters (eg freeway traffic data and hydro poly slopeX/Y)
* Added option to save backups to backup subdirectory (on by default).
* Added XML tab to show XML for highlighted node
* Remember window size and position

Issues resolved:-

* Changed tag name of "Park" to "LandClassPoly" since landclass polys can be used for more than just parks! Existing "Park" tags are automatically renamed to "LandClassPoly"
* Handle extra '.' in filenames

=== v1.07 Beta - 25th Apr 2007 ===

New features:-

* Added "Shape" tab with support for shape viewing. Select single (or multiple) polygon/polylines to see its shape. Selecting a folder will show all shapes in that folder and any sub folders.
* Added "Select All" function (Ctrl A) to select all polylines/polygons
* Added "New" button to Vertices form to insert vertice.
* Added "Copy" button to Vertices form to copy the selected vertice.
* Added "Delete" button to Vertices form to delete selected vertice.
* Added "Move Up" and "Move Down" button to Vertices form to move selected vertice up or down in list.
* Added Options menu to main form. Moved "Save Backups" to this menu
* Added "Remember Window Position and Size" to the options menu

Issues resolved:-

* Updated the "About" form to credit the 3rd party development libraries used (eg Shapelib)
* Fixed misplaced longitude and latitude labels on vertice grid

=== v1.08 Beta - 18th May 2007 ===

New features:-

* Add BGLCOMP support for placing of FSX library objects along polyline. The use of "Variance" parameters below helps create more naturalistic looking scenery by applying random variance to object positioning. Support the following parameters:-
** Altitude AGL or MSL
** Altitude variance - Random variance in meters applied to alitude (use 0 for no variance)
** Pitch (0 - 360)
** Pitch variance - Random variance in degrees (0 - 180) applied to pitch (use 0 for no variance)
** Bank (0 - 360)
** Bank variance - Random variance in degrees (0 - 180) applied to bank (use 0 for no variance)
** HeadingType
*** Track - Heading of each object follows the direction of each polyline segment
*** Fixed - Heading of all objects is specified by Heading parameter
*** Random - Heading is random for each object
*** Elevation - Heading for each object is specified by elevation of associated polyline vertice
** Heading (0 - 360) - Used when HeadingType = Fixed
** Heading variance - Random variance in degrees (0 - 180) applied to heading (use 0 for no variance)
** Scale - Scale multiply of object (defaults to 1.0)
** ScaleVariance - Random variance in scale to apply to objects. (use 0 for no variance)
** ImageComplexity - VerySparse, Sparse, Normal, Dense, VeryDense, ExtremelyDense
* FSX_KML_Tags tab - Add tags for all default FSX scenery library objects
* Build tab - Add button for setting BGLComp SDK path
* Build tab - Add "Open" button for output folder path to open Windows Explorer on that folder

Issues resolved:-

* Fixed issue with copy button

=== v1.09 Beta - 23rd June 2007 ===

New features:-

* Added BGLCOMP support for scenery exclusion rectangles ("ExclusionRectangle" tag). The exclusion rectangle will be defined by the "bounding" rectangle of the polyline/polygon. Supports the following parameters
** ExcludeAllObjects
** ExcludeBeaconObjects
** ExcludeEffectObjects
** ExcludeGenericBuildingObjects
** ExcludeLibraryObjects
** ExcludeTaxiwaySignObjects
** ExcludeTriggerObjects
** ExcludeWindsockObjects
** ImageComplexity - VerySparse, Sparse, Normal, Dense, VeryDense, ExtremelyDense
* Added BGLCOMP support for Extrusion Bridges ("ExtrusionBridge" tag). Draw a polyline and tag it with "ExclusionBridge", then use the vertice editor to set the height of each bridge segment.
* Added "Change to" button on the Vertice Editor to change shape type from polygon to polyline and vice versa
* Enhanced polygons holes so that if a polygon cannot be found in the same folder as polygon hole ("polygon folder") then the parent folder is searched for the first polygon preceding the polygon folder. This makes it possible to better organize a project by placing polygon holes (i.e islands) in a sub folder and still have them associated with a water polygon in a parent folder

=== v1.10 Beta - 19th August 2007 ===

New features:-

* Land class tiles
* Water class tiles

== Development Roadmap ==

The following features are planned for upcoming releases:-

=== Future releases ===
* Update this manual :)
* Add 10 minute autosave
* Add following params to BGLCOMP support:-
** Heading Type
*** FixedTrack - Heading of all objects is fixed to the direction of first polyline segment
** Divergence - Random divergence (in meters) from vertice. Applied in direction which is perpendicular to direction of polyline segment (use 0 for no variance)
* Add "AutoPolygonHole" to polygon properties sheet. This allows a polygon hole to be automatically created in the shape of the polygon, and removes the need manually create a hole (by copying and tagging as hole)
* Fix - Ensure lon/lat uses '.' and not ','
* FSX_KML_Tags tab - Add support for tag groups
* Add BGLCOMP support for Tag Groups. Tag grouping allows the scenery designer to group together similar scenery library objects into a single group. For example, when populating a car park the designer could use a tag group containing a variety of car models. This would result in car models being chosen at random from the tag group.
* Add shape viewer to Vertice Editor form and have it refresh as vertices are edited.
* Add "Fly to" button to Vertices Editor form to move FSX aircraft to the selected vertice
* Add "Paste Aircraft pos" button to Vertices Editor form to paste the current location of aircraft (longtitude, latitude, and optionally altitude) into the list of Vertices.
* Export - Ability to export selected polygons/polylines to a CSV file, with option for long/lat/elevation ordering
* Scenery Placer - Add support for dynamically previewing scenery objects while FSX is running. This allows very precise and interactive control over the objects placement and orientation without the need to build a BGL and reload FSX.
* Placing FSX library objects inside a polygon. Allow number of objects and elevation to be specified. Objects will be distributed randomly within the polygon. This can be used to populate livestock, wildlife, boats/ships in harbors, people on beaches, birds, hot air balloons etc
* FSX_KML_Tags tab - Texture preview for land class polygons and tiles tags
* FSX_KML_Tags tab - Scenery object preview for default FSX scenery objects
* Ability to inject a QMID 11 grid into the KML to aid with visualization of exclusion areas
* New, Open and Save project buttons to support multiple projects.
* "Check for Update" menu option to check online for updates.

* If possible conditional display of FSX scenery library objects based on various triggers such as date/time, weather conditions and probability factor. For example, this would allow harbors to be populated with pleasure craft on sunny warm days, but not at night or in cold weather. Would allow forest fires to be generated in hot, windy conditions.
* If possible ability to animate FSX scenery library objects along a polyline
* "Photo scenery" ground textures
* Flight plan generation along polyline


== Software by this author ==
[http://fsdeveloper.com/wiki/index.php?title=FSX_KML FSX_KML]

[http://fsdeveloper.com/wiki/index.php?title=FSX_Photoscene FSX_PhotoScene]

[http://fsdeveloper.com/wiki/index.php?title=SRTM_To_BGL SRTM_To_BGL]

[[Category:Manuals]]
[[Category:Tools]]
[[category:Scenery_Design]]

FSX KML

2012-12-29T14:34:37Z

GaryGB: /* Downloading FSX KML */

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
== Introduction ==

[[Image:before_and_after.jpg|thumb|right|150px|Before and after screenshot]]

FSX KML is a freeware scenery design tool for Microsoft Flight Simulator X (FSX).

It converts KML (Keyhole Markup Language) files generated by Google Earth into FSX scenery.

Using Google Earth to draw polygons and polylines you can accurately and easily create many types of scenery.

===Shp2Vec based scenery===
FSX KML uses the FSX SDK Shp2Vec tool to create the following types of vector scenery:-

* Water polygons including oceans, rivers, lakes and canals
* Islands inside water features
* Irregular shaped land class polygons for cities, parks, beaches, forest, golf courses etc
* Airport boundaries and flatten polygons and AUTOGEN EXCLUSIONS
* Shorelines
* Streams
* Roads
* Railways
* Freeways (ie Moving traffic)
* Utility lines (eg power and telephone lines)
* Exclusions polygons (for vector data)

===BGLComp based scenery===
FSX KML uses the FSX SDK BGLComp tool to create the following types of scenery:-

* Place scenery objects (from the FSX library) along a polyline using a wide variety of [http://www.fsdeveloper.com/wiki/index.php?title=FSX_KML#v1.08_Beta_-_18th_May_2007 placement options]
* Exclusion rectangles
* Extrusion bridges

===Resample based scenery===
FSX KML uses the FSX SDK Resample tool to create the following types of scenery:-

* Land class tiles
* Water class tiles

'''Make sure you also download and install [http://fsdeveloper.com/wiki/index.php?title=FSX_KML#Installing_FWTools FWTools] which is required for creating these types of scenery.'''

== Support Forum ==

You can discuss FSX KML at the fsdeveloper.com
[http://www.fsdeveloper.com/forum/forumdisplay.php?f=81 FSX KML forum]. This is the best place to ask support questions about FSX_KML since other FSX_KML users (as well as the author) can answer your questions.

== Downloading FSX KML ==

The latest version of FSX KML (1.10) can be downloaded from:-

* AVSIM - http://library.avsim.net/esearch.php?CatID=fsxsd&DLID=108495 < dead link >
* Flightsim.com - http://www.flightsim.com/vbfs/fslib.php?do=copyright&fid=115211 < updated December 12, 2012 >
* The Scenery Hall of Fame - http://www.scenery.org/graphical_editors.htm < dead link >

== Installation ==

=== Installing FSX KML ===

FSX KML can be installed in a folder of your choice. Simply unzip the FSX KML installation zip file into the desired folder.

After unzipping the installation file you should have the following files:-

* FSX_KML.exe
* ShapeLib129.dll
* FreeImage.DLL
* FSX_KML_TAGS.XML


=== Installing the FSX Software Development Kit (SDK) ===

To generate FSX scenery you will need the FSX SDK, which is distributed with the FSX Deluxe version.
To install the SDK:

(1) Browse the FSX Deluxe Edition Disk 1

(2) Open the SDK sub-folder

(3) Double-click the setup.exe

(4) Tell it where to install. Default is C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK

If the SDK is not installed in the default SDK folder you must specify its location on the FSX_KML build tab.

For more info on the SDK installation and Service packs: [http://www.fsdeveloper.com/wiki/index.php?title=SDK_Installation_%28FSX%29 http://www.fsdeveloper.com/wiki/index.php?title=SDK_Installation_%28FSX%29]

=== Installing FWTools ===

FSX KML makes use of the freeware tool set called [http://fwtools.maptools.org/ FWTools]. FW Tools is required for scenery that uses the FSX SDK Resample tool, such as landclass and waterclass.

Download and install the latest version of FWTools.

Specify the location of FWTools on the FSX KML Build tab.

=== Installing Google Earth ===

If you notice some null values for vertices when importing KML files from Google Earth, pls consider to revert to an older version of GE. More information about this issue you can find [ http://www.fsdeveloper.com/forum/showthread.php?p=144034 here]

Google Earth, Vers 5.1 is available here: [http://www.google.com/earth/download/thanks.html#release=previous#os=win#single=yes Google Earth 5.1]

== Building Scenery ==

Building your own scenery with FSX KML is easy.

=== Step 1 - Creating a KML file with Google Earth ===

The first step in creating your FSX scenery is to create a KML file by using Google Earth to "trace" scenery features.

==== Creating polygons and polylines ====

Using Google Earth create a polygon using the "Add Poly" function or create a polyline using the "Add Path" function,
and then trace the scenery feature (for example a lake or road).

After you click the "Add Poly" or "Add Path button" you will be presented with a form as shown to the right

[[Image:GE-polygon-dialog.jpg|thumb|right|150px|Google Earth dialog for creating new polygon or polyline]]

* Name - Give your polygon or polyline a description or leave blank

* Description - This is where you "tag" your polygon or polyline. You may enter a tag from FSX_KML_TAGS.XML or leave blank and tag later using FSX_KML

* Style & Color - You may choose the border and fill color for polyline or polygon

* Altitude - You may enter an altitude for your polyline or polygon. This can be used to specify the elevation of lakes. You may also enter the elevation later using FSX_KML. All elevations must be entered in meters.

Begin tracing your polyline or polygon. You may either click the mouse or hold the mouse button down and drag the mouse to create vertices.

* Use your mouse wheel to zoom the view in and out vertically.

* Use the up, down, left, right arrow keys to move the view horizontally.

* Hold Shift and press left or right arrow to rotate the view.

* Hold Ctrl and press up or down arrow to tilt the view.

To make things easier; it is good to get into the habit of drawing polygon vertices in the same direction, perhaps always draw clockwise. That way if you decide to add new vertices to define details better, then you can simply click to the right of the currently selected vertex (blue) to add a new one in. Avoid adding vertices that make the polygon twisted.
While polygon "properties" is open, take the time to change the transparency (from the colour tab)- if you leave it opaque, then you end up covering important details and spotting mistakes is more difficult.

Once you have finished click OK to save your polygon or polyline.

To edit your polyline or polygon highlight it, right click the mouse and choose properties.

==== "Tagging" the scenery features ====

To describe what scenery feature your polygon or polyline represents it needs to be "tagged". The file FSX_KML_TAGS.XML contains a list of the tags you can use.

There are two ways to tag a polygon or polyline:-

* Place the name of the tag in the description field of the polygon or polyline.
* Place the name of the tag in the description field of the parent folder that contains the polygon or polyline. If a polygon/polyline has no tag then it will inherit its tag from the parent folder.

You can place these tags in GE using the properties dialog of the polygon or polyline, or you can use FSX_KML to place these tags.

To tag using FSX_KML click on a description "cell" and press F2. An arrow will be displayed so then click on the arrow to drop down a list of valid tags. Highlight the tag you want and press ENTER. If you had multi-selected several cells then all the selected cells will be tagged. To select multiple cells hold down the shift key while clicking cells.

==== Saving your work to a KML file ====

Once you're done drawing your polygon(s) or polyline(s), simply right-click on the top-most folder you created (or the polygon itself if you didn't create folders) under the "My Places" tab on the left side of your GE window. Select "Save As", makes sure that you choose .kml as the file type, and select your desired location in your file structure.

=== Step 2 - Processing the KML file with FSX KML ===

[[Image:project.jpg|thumb|right|150px|The Project tab]] [[Image:build.jpg|thumb||150px|The Build tab]]

* Run FSX_KML
* On the "Project" tab, click the "Add KML" button and choose a KML file. The contents of the selected KML file will be displayed. You may add multiple KML files. A FSX BGL file will be generated for each KML input file.
* Change to the "Build" tab
* Set the following build options:-
** "FSX folder" - Input the folder where FSX is installed. By default this is "C:\Program Files\Microsoft Games\Microsoft Flight Simulator X"
** "Terrain SDK" - Input the location of the FSX terrain SDK
** "FW Tools" - Input the location where you installed FW Tools. FW Tools is required for scenery that uses the FSX SDK Resample tool, such as landclass and waterclass.
** "Run SDK tools" - If you select this option FSX KML will automatically run the SDK tools to turn your Shape Files into a FSX BGL
** "Copy generated scenery to FSX Addon Scenery Folder" - If you select this option FSX KML will copy the generated BGLS to the FSX addon scenery directory
* Click the "Build" button. FSX KML will now build your scenery. The progress of the build will be displayed in the build log window. The following actions will occur during the build:-
** For each KML file in your project
*** For vector based scenery an appropriate set of Shape files is generated depending on the features that have been tagged in the KML
*** For resample based scenery an appropriate Tiff file is created.
*** An XML config file is created for use by Shp2Vec, BGLComp and Resample
** A batch file called "Run_SDK_Tools.bat" will be created. This batch file contains the appropriate commands to call the FSX SDK tools (Shp2Vec, BGLComp and Resample)
** If you have selected the "Run SDK Tools" option then the Run_SDK_Tools.bat file will be executed. This will create various scenery .BGL files ready for use by FSX
** If you have selected the "Copy generated scenery..." option then the BGL files(s) will be copied to the FSX addon scenery directory. Please note: If FSX is running and using a previous version of your BGL file then the copy will not work because FSX will have the file "locked". The easiest way to ensure your file is copied to the addon scenery folder is to make sure FSX is not running.

=== Step 3 - Testing the scenery ===

* If you selected the "Copy generated files..." option then your scenery will have been copied to the FSX addon scenery folder. Simply run FSX and goto your scenery location to test the scenery

== Scenery Design Tutorial ==

The [http://www.fsdeveloper.com/wiki/index.php?title=FSX_KML_Tutorial FSX KML Tutorial] provides help with a variety of scenery design tasks.

== Editing a KML file using FSX_KML ==

Using FSX_KML you can easily edit your KML file. The following types of edits can be performed:-

=== Copy ===
To copy a KML item (folder or polygon/polyline) select the item to copy and click the copy button.
=== Delete ===
To delete a KML item select the item to copy and click the delete button.
=== Edit ===
To edit the Name and Description attributes of a KML item select either a single item or multiple items (hold the shift key to multi-select) and then press F2 to display the inline editor. Enter the new value and press enter. Your edit will be applied to the items you selected

=== Saving your changes ===
Click the save button to write your changes back to disk..
.

=== Open in Notepad ===
Click the "Open in Notepad" button to open the selected KML file in Notepad.
=== Open in Google Earth ===
Click the "Open in Google Earth" button to open the selected KML file in Google Earth.
=== Reload a KML file ===
If you have edited the selected KML file using an external program (eg Google Earth or Notepad) then you can reload those changes back into FSX_KML by clicking the reload button.

=== Properties Tab ===

This tab shows the properties for the selected polygon or polyline.

Freeways:
Use the "NumberOfLanes" and "Traffic Direction" attributes to define freeway related data.

Hydropolygons:
Use the "SlopeX" and "SlopeY" attributes to define slope characteristics of hydropolygons.

=== Vertices Tab ===

This tab shows the vertices (ie points) for the selected polygon or polyline.

Click the "Edit" button to display the vertice editor. This editor lets you edit the vertices in several ways:-

Reversing points:
The direction of a polygon or polyline can be reversed by using the REVERSE POINTS button. Click the "Reverse" button to change the direction of points in the polygon/polyline.

Setting elevation:
You can set the elevation for all vertices by clicking the "Set Elevation" button.

Manual editing:
You can manually edit vertices (longtitude, latitude and elevation) by editing data in the vertex grid.

=== XML Tab ===

This tab shows the XML for the selected polygon or polyline.

== FSX_KML_TAGS.XML ==

[[Image:Tags.jpg|thumb|right|150px|FSX_KML_TAGS tab]]

=== What is the FSX_KML_TAGS file? ===

This file holds the "tags" that are used in the KML file to describe FSX scenery features. You can customise this file to add more tags or change existing ones.

An easy way to browse this file is by clicking on the "FSX_KML_TAGS.XML" tab in FSX KML.

This XML contains the following attributes for each "tag":-

* Tag - The unique identifier for this scenery feature. This tag is what you use to "tag" the polygons/polylines in your Google Earth KML file
* Description - A description of the scenery feature. This description is displayed in FSX KML.
* Feature Type - The type of scenery feature and must be one of the following types:-
** WATERPOLY - Water polygons such as coastline, rivers, lakes, canals etc
** WATERPOLYGPS - Low resolution water polygons for use in the GPS
** LANDCLASSPOLY - irregular shaped landclass polygons for towns, forest, beaches, park etc
** AIRPORTBOUNDRY - define airport boundries and also flatten areas and AUTOGEN EXCLUSIONS
** EXCLUSION - exclude default vector scenery from the polygon
** STREAM - create streams
** SHORELINE - create animated shorelines
** ROAD - create roads (NOT road bridges)
** FREEWAY - create moving traffic
** RAILWAY - create railways (NOT rail bridges)
** UTILITY - power lines, telegraph lines, fences etc
** SCENERYOBJECT - place scenery objects
** EXCLUSIONRECTANGLE - excludes scenery objects
** EXTRUSIONBRIDGE - creates extrusion bridges
** LANDCLASS - create land class
** WATERCLASS - create water class
* GUID - The FSX GUID for the scenery feature.

Please refer to the FSX "terrain.cfg" file and terrain SDK documentation for futher information on feature types and GUIDs

=== Editing FSX_KML_TAGS.XML using FSX KML ===

The FSX_KML_TAGS.XML file can be easily edited in FSX KML. To following edits can be performed:-

==== Copy ====
To copy an item select the item to copy and click the copy button.
==== Delete ====
To delete an item select the item to delete and click the delete button.
==== Edit ====
To edit the Tag, Description, FeatureType or GUID attributes of an item select either a single item or multiple items (hold the shift key to multi-select) and then press F2 to display the inline editor. Enter the new value and press enter. Your edit will be applied to the items you selected

==== Saving your changes ====
Click the save button to write your changes back to disk.
==== Open in Notepad ====
Click the "Open in Notepad" button to open the FSX_KML_TAGS.XML file in Notepad.
==== Reload ====
If you have edited the FSX_KML_TAGS.XML file using an external program (eg Notepad) you can reload those changes by clicking the reload button.

== Google Earth ==

=== Downloading Google Earth ===

The free version Google Earth may be downloaded from the [http://earth.google.com/ Google Earth home page]

=== Copyright of Google Earth Data ===

Scenery developers need to be aware that there may be copyright issues associated with the use of data obtained from Google Earth. Please see the [http://earth.google.com/support/ Google Earth support page] for more information on the Google Earth policy of using this data in your freeware or commercial products.

== Freeware scenery using FSX KML ==

The following freeware has used FSX KML during their development:-

* [http://library.avsim.net/esearch.php?DLID=&Name=Isle+of+Wight&FileName=&Author=Len+Hickman&CatID=fsxscen Isle of Wight (UK) reconstructed] by Len Hickman
* [http://library.avsim.net/esearch.php?DLID=&Name=Quebec+Scenery&FileName=&Author=Gilles+Gauthier&CatID=fsxscen Quebec Scenery - Lakes and Rivers] by Gilles Gauthier
* [http://library.avsim.net/esearch.php?DLID=&Name=Catalunya+Coast&FileName=&Author=Bodo+Hesse&CatID=fsxscen Catalunya Coast] by Bodo Hesse
* [http://library.avsim.net/esearch.php?DLID=&Name=Naval+air+station&FileName=&Author=Jim+Dhaenens&CatID=fsxscen Naval Air station Jacksonville (KNIP)] by Jim Dhaenens
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=103120 Naval Air Station Oceana (KNTU)] by Jim Dhaenens
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=102870 Coffs Harbour (YSCH)] by John Ross (also at www.virtualvfr.com)
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=103027 Kitimat/Terrace] by Douglas Keech
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=102995 Los Angeles "clean-up"] by Lance Tucker
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104609 Lord howe Island and Balls Pyramid] by Don Bush
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104853 Falklands 2007] by Brian Jamieson
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104000 Gloucestershire Airport] by Terry Shields
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=105386 Okanagan Valley Landclass and Rivers] by Alex Sievert
* [http://library.avsim.net/esearch.php?DLID=106386&CatID=fsxscen Gold Coast Airport (YBCG)] by John Ross
* [http://marcoh.gratisim.fr Photorealistic Town of Nantes in France] by Marc-henri Guitteny
* [http://library.avsim.net/esearch.php?DLID=109752&CatID=fsxscen Utah Complete v1.0] by James Udall
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=111154 Bushflight Northwest] by Bill Dick / Phil "Snowman" Cayton / Chris Brisland
* [http://library.avsim.net/esearch.php?DLID=114132&CatID=fsxscen Wake Island] by Tony Arnold
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=117501 SICILY VFR X - Lakes and Reservoirs] by Giovanni Miduri
*[http://library.avsim.net/download.php?DLID=121703 Chernobyl Exclusion Zone] by Mike Dalgleish
*[http://fly-wonderful-islands.com/page_89.html La gomera GCGM Spain] by Allen Cremeen
* [http://marcoh.gratisim.fr Photorealistic St Pierre & Miquelon archipelago near Newfoundland] by Marc-henri Guitteny
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=105600 Quebec city v1.0] by Jean St-Cyr and Gilles Boily
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=139471 Quebec city v2.0] by Jean St-Cyr, Gilles Boily, Gilles Gauthier and Jean-Pierre Fillion
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=144264 Angel Falls for FSX] by Jean St-Cyr
Freeware authors please list your freeware scenery here!

== Commercial scenery using FSX KML ==

The following commercial scenery has used FSX KML during their development:-

* [http://www.imaginesim.com/kcvg01.htm KCVG Cincinnati Northern Kentucky International Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/tjsj01.htm TJSJ San Juan Luis Munoz Marin Airport, Puerto Rico] by Imagine Simulation
* [http://www.imaginesim.com/kclt01.htm KCLT Charlotte Douglas Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/mynn01.htm MYNN Nassau International, Bahamas] by Imagine Simulation
* [http://www.imaginesim.com/klga01.htm KLGA New York La Guardia Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/kmci01.htm KMCI Kansas City International Airport, USA] by Imagine Simulation
* [http://www.aerosoft-shop2.com/products/helgolandx/helgolandx.html Helgoland X] by AeroSoft
* [http://www.aerosoft-shop2.com/products/monacox/monacox.html Monaco X] by AeroSoft
* [http://www.aerosoft-shop2.com/products/aspenx/aspenx.html Aspen X] by AeroSoft
* [http://secure.simmarket.com/product_info.php?products_id=2361 Pantanal - The Wetlands] by CenaReal
* [http://www.fly-wonderful-islands.com/Slide/gclp_v1.html GCLP Gran Canaria Airport Canary Islands Spain] by Fly Wonderful Islands
* [http://www.fly-wonderful-islands.com/FWI_GCRRv2/Slide_GCRR_V2/FWI_GCRR_V2.html Lanzarote GCRR Airport Canary Islands Spain] by Fly Wonderful Islands
Please list other commercial scenery here.

== End User Licence ==

Copyright Â© 2007 Innova Software ALL RIGHTS RESERVED

FSX KML ("Software") is distributed without charge to FSX add-on designers, redistribution of the original ZIP file is not allowed. You are NOT allowed to sell this software or ask money for its distribution.

FSX KML may be used free of charge for the production of both freeware and commercial add-ons (including sceneries,missions,aircraft) subject to the following terms and conditions:-
* You notify Innova Software of the use of FSX KML in your add-on
* You give Innova Software a free copy of your add-on (and any updates)
* In your readme file you say that FSX KML was used to help with the production of your add-on
* The copyright and any intellectual property relating to the FSX KML software shall remain the property of Innova Software
* LIMITED WARRANTY - INNOVA SOFTWARE SHALL NOT BE RESPONSIBLE IN TORT OR IN CONTRACT FOR ANY LOSS OR DAMAGE HOWSOEVER CAUSED TO THE PROPERTY OR PERSON OF YOURSELF OR ANY THIRD PARTY AS A RESULT OF ANY DEFECT IN THE SOFTWARE WHETHER PATENT OR LATENT OR AS A RESULT OF ANY FAULT, NEGLIGENCE, WRONGFUL ACT OR OMISSION OF INNOVA SOFTWARE OR ANY OF ITS SERVANTS, EMPLOYEES, CONTRACTS AND AGENTS, AND YOU INDEMNIFY INNOVA SOFTWARE AGAINST ANY CLAIMS MADE AGAINST IT BY ANY THIRD PARTY ARISING OUT OF ANY SUCH DEFAULT OR FAULT, NEGLIGENCE, WRONGFUL ACT OR OMISSION AND IN NO EVENT SHALL INNOVA SOFTWARE BE LIABLE FOR ANY CLAIMS OR DAMAGES INCLUDING, BUT NOT LIMITED TO CLAIMS OF FAULTY DESIGN, NEGLIGENT OR MISLEADING ADVICE, DAMAGES ARISING FROM LOSS OR USE OF THE SOFTWARE AND/OR SUPPLY OF SERVICES; AND ANY INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES OR INJURY TO ANY PERSON, CORPORATION OR OTHER ENTITY BY REASON OF THE PROVISION OF THE SOFTWARE AND/OR PROVISION OF SERVICES PURSUANT TO THESE TERMS AND CONDITIONS

Developers can email acceptance of these terms and conditions to fsx_kml@innovasoftware.com.

== Release History ==

=== v1.00 Beta - 19th 0ct 2006 ===

This is first beta release of FSX KML

=== v1.01 Beta - 19th 0ct 2006 ===

Issues resolved:-
* Fixed error with FSX_KML_TAGS.XML file not found

=== v1.02 Beta - 21st 0ct 2006 ===

Issues resolved:-
* Fixed error reading polygon/poylines. FSX KML could sometimes insert an erroneous point of 0,0

=== v1.03 Beta - 28th 0ct 2006 ===

New features and issues resolved:-
* Better handle tags in description field. Be less strict about "whitespace" and cr/lf
* Better handle international settings for decimals
* Add more excludes to fsx_kml_tags.xml (see tags starting with "exclude__")
* Add support for moving kml items up/down
* Add support for moving kml items via drag drop
* Add support for creating new kml folder
* Create shapes in order they appear in the KML
* Assign UUID (starting at 1) to each shape in the KML based on its order in the KML

Known issues (Features not implemented in this release):-
* Freeway tags (moving traffic) - in v1.03 you must manually edit the FW .DBF file to set traffic density and direction

=== v1.04 Beta - 20th Jan 2007 ===

New features and issues resolved:-

* Use INI file (FSX_KML.INI) to remember settings including list of KML files and FSX folder settings
* Allow multi select of KML files in Add KML file dialog
* Display points for selected polygon/polyline
* Add REVERSE POINTS button to allow direction of polygon/polyline to be reversed
* Add POLYGONHOLE tag to support "holes" in polygons, eg for making islands in rivers
* Add LEGACY_LANDWATERMASK_WATER_NOFLATTEN tag for water polygons that "cling" to mesh
* Default freeway traffic to one lane of traffic

=== v1.05 Beta - 21st Jan 2007 ===

New features and issues resolved:-

* Added "Automatically Reverse Points In Polygon Holes" build option. This option will auto reverse points for polygon holes when creating the shape file. Apparently Google Earth always writes polygons in a clockwise fashion to the KML file irrespective of which way they are actually drawn in Google Earth. This option simplifies the creation of polygon holes because you no longer need to manually reverse point order in FSX KML. Option is on by default.
* Added "Output Folder" build option. This lets you specify the folder where files are written during the build process
* Fixed error when loading the saved list of KML files and a KML file can longer be found.

=== v1.05.1 Beta - 21st Jan 2007 ===

Issues resolved:-

* Fixed bug where directory would not be changed prior to running the RUN_SDK_TOOLS batch file

=== v1.06 Beta - 14th Apr 2007 ===

New features:-

* Added grid to allow manual editing of polygon/polyline points (longitude,latitude,elevation)
* Added button for setting all points in polygon/polyline to a specific elevation
* Added support for tag parameters (eg freeway traffic data and hydro poly slopeX/Y)
* Added option to save backups to backup subdirectory (on by default).
* Added XML tab to show XML for highlighted node
* Remember window size and position

Issues resolved:-

* Changed tag name of "Park" to "LandClassPoly" since landclass polys can be used for more than just parks! Existing "Park" tags are automatically renamed to "LandClassPoly"
* Handle extra '.' in filenames

=== v1.07 Beta - 25th Apr 2007 ===

New features:-

* Added "Shape" tab with support for shape viewing. Select single (or multiple) polygon/polylines to see its shape. Selecting a folder will show all shapes in that folder and any sub folders.
* Added "Select All" function (Ctrl A) to select all polylines/polygons
* Added "New" button to Vertices form to insert vertice.
* Added "Copy" button to Vertices form to copy the selected vertice.
* Added "Delete" button to Vertices form to delete selected vertice.
* Added "Move Up" and "Move Down" button to Vertices form to move selected vertice up or down in list.
* Added Options menu to main form. Moved "Save Backups" to this menu
* Added "Remember Window Position and Size" to the options menu

Issues resolved:-

* Updated the "About" form to credit the 3rd party development libraries used (eg Shapelib)
* Fixed misplaced longitude and latitude labels on vertice grid

=== v1.08 Beta - 18th May 2007 ===

New features:-

* Add BGLCOMP support for placing of FSX library objects along polyline. The use of "Variance" parameters below helps create more naturalistic looking scenery by applying random variance to object positioning. Support the following parameters:-
** Altitude AGL or MSL
** Altitude variance - Random variance in meters applied to alitude (use 0 for no variance)
** Pitch (0 - 360)
** Pitch variance - Random variance in degrees (0 - 180) applied to pitch (use 0 for no variance)
** Bank (0 - 360)
** Bank variance - Random variance in degrees (0 - 180) applied to bank (use 0 for no variance)
** HeadingType
*** Track - Heading of each object follows the direction of each polyline segment
*** Fixed - Heading of all objects is specified by Heading parameter
*** Random - Heading is random for each object
*** Elevation - Heading for each object is specified by elevation of associated polyline vertice
** Heading (0 - 360) - Used when HeadingType = Fixed
** Heading variance - Random variance in degrees (0 - 180) applied to heading (use 0 for no variance)
** Scale - Scale multiply of object (defaults to 1.0)
** ScaleVariance - Random variance in scale to apply to objects. (use 0 for no variance)
** ImageComplexity - VerySparse, Sparse, Normal, Dense, VeryDense, ExtremelyDense
* FSX_KML_Tags tab - Add tags for all default FSX scenery library objects
* Build tab - Add button for setting BGLComp SDK path
* Build tab - Add "Open" button for output folder path to open Windows Explorer on that folder

Issues resolved:-

* Fixed issue with copy button

=== v1.09 Beta - 23rd June 2007 ===

New features:-

* Added BGLCOMP support for scenery exclusion rectangles ("ExclusionRectangle" tag). The exclusion rectangle will be defined by the "bounding" rectangle of the polyline/polygon. Supports the following parameters
** ExcludeAllObjects
** ExcludeBeaconObjects
** ExcludeEffectObjects
** ExcludeGenericBuildingObjects
** ExcludeLibraryObjects
** ExcludeTaxiwaySignObjects
** ExcludeTriggerObjects
** ExcludeWindsockObjects
** ImageComplexity - VerySparse, Sparse, Normal, Dense, VeryDense, ExtremelyDense
* Added BGLCOMP support for Extrusion Bridges ("ExtrusionBridge" tag). Draw a polyline and tag it with "ExclusionBridge", then use the vertice editor to set the height of each bridge segment.
* Added "Change to" button on the Vertice Editor to change shape type from polygon to polyline and vice versa
* Enhanced polygons holes so that if a polygon cannot be found in the same folder as polygon hole ("polygon folder") then the parent folder is searched for the first polygon preceding the polygon folder. This makes it possible to better organize a project by placing polygon holes (i.e islands) in a sub folder and still have them associated with a water polygon in a parent folder

=== v1.10 Beta - 19th August 2007 ===

New features:-

* Land class tiles
* Water class tiles

== Development Roadmap ==

The following features are planned for upcoming releases:-

=== Future releases ===
* Update this manual :)
* Add 10 minute autosave
* Add following params to BGLCOMP support:-
** Heading Type
*** FixedTrack - Heading of all objects is fixed to the direction of first polyline segment
** Divergence - Random divergence (in meters) from vertice. Applied in direction which is perpendicular to direction of polyline segment (use 0 for no variance)
* Add "AutoPolygonHole" to polygon properties sheet. This allows a polygon hole to be automatically created in the shape of the polygon, and removes the need manually create a hole (by copying and tagging as hole)
* Fix - Ensure lon/lat uses '.' and not ','
* FSX_KML_Tags tab - Add support for tag groups
* Add BGLCOMP support for Tag Groups. Tag grouping allows the scenery designer to group together similar scenery library objects into a single group. For example, when populating a car park the designer could use a tag group containing a variety of car models. This would result in car models being chosen at random from the tag group.
* Add shape viewer to Vertice Editor form and have it refresh as vertices are edited.
* Add "Fly to" button to Vertices Editor form to move FSX aircraft to the selected vertice
* Add "Paste Aircraft pos" button to Vertices Editor form to paste the current location of aircraft (longtitude, latitude, and optionally altitude) into the list of Vertices.
* Export - Ability to export selected polygons/polylines to a CSV file, with option for long/lat/elevation ordering
* Scenery Placer - Add support for dynamically previewing scenery objects while FSX is running. This allows very precise and interactive control over the objects placement and orientation without the need to build a BGL and reload FSX.
* Placing FSX library objects inside a polygon. Allow number of objects and elevation to be specified. Objects will be distributed randomly within the polygon. This can be used to populate livestock, wildlife, boats/ships in harbors, people on beaches, birds, hot air balloons etc
* FSX_KML_Tags tab - Texture preview for land class polygons and tiles tags
* FSX_KML_Tags tab - Scenery object preview for default FSX scenery objects
* Ability to inject a QMID 11 grid into the KML to aid with visualization of exclusion areas
* New, Open and Save project buttons to support multiple projects.
* "Check for Update" menu option to check online for updates.

* If possible conditional display of FSX scenery library objects based on various triggers such as date/time, weather conditions and probability factor. For example, this would allow harbors to be populated with pleasure craft on sunny warm days, but not at night or in cold weather. Would allow forest fires to be generated in hot, windy conditions.
* If possible ability to animate FSX scenery library objects along a polyline
* "Photo scenery" ground textures
* Flight plan generation along polyline


== Software by this author ==
[http://fsdeveloper.com/wiki/index.php?title=FSX_KML FSX_KML]

[http://fsdeveloper.com/wiki/index.php?title=FSX_Photoscene FSX_PhotoScene]

[http://fsdeveloper.com/wiki/index.php?title=SRTM_To_BGL SRTM_To_BGL]

[[Category:Manuals]]
[[Category:Tools]]
[[category:Scenery_Design]]

FSX KML

2012-12-29T14:33:57Z

GaryGB: /* Downloading FSX KML */

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
== Introduction ==

[[Image:before_and_after.jpg|thumb|right|150px|Before and after screenshot]]

FSX KML is a freeware scenery design tool for Microsoft Flight Simulator X (FSX).

It converts KML (Keyhole Markup Language) files generated by Google Earth into FSX scenery.

Using Google Earth to draw polygons and polylines you can accurately and easily create many types of scenery.

===Shp2Vec based scenery===
FSX KML uses the FSX SDK Shp2Vec tool to create the following types of vector scenery:-

* Water polygons including oceans, rivers, lakes and canals
* Islands inside water features
* Irregular shaped land class polygons for cities, parks, beaches, forest, golf courses etc
* Airport boundaries and flatten polygons and AUTOGEN EXCLUSIONS
* Shorelines
* Streams
* Roads
* Railways
* Freeways (ie Moving traffic)
* Utility lines (eg power and telephone lines)
* Exclusions polygons (for vector data)

===BGLComp based scenery===
FSX KML uses the FSX SDK BGLComp tool to create the following types of scenery:-

* Place scenery objects (from the FSX library) along a polyline using a wide variety of [http://www.fsdeveloper.com/wiki/index.php?title=FSX_KML#v1.08_Beta_-_18th_May_2007 placement options]
* Exclusion rectangles
* Extrusion bridges

===Resample based scenery===
FSX KML uses the FSX SDK Resample tool to create the following types of scenery:-

* Land class tiles
* Water class tiles

'''Make sure you also download and install [http://fsdeveloper.com/wiki/index.php?title=FSX_KML#Installing_FWTools FWTools] which is required for creating these types of scenery.'''

== Support Forum ==

You can discuss FSX KML at the fsdeveloper.com
[http://www.fsdeveloper.com/forum/forumdisplay.php?f=81 FSX KML forum]. This is the best place to ask support questions about FSX_KML since other FSX_KML users (as well as the author) can answer your questions.

== Downloading FSX KML ==

The latest version of FSX KML (1.10) can be downloaded from:-

* AVSIM - http://library.avsim.net/esearch.php?CatID=fsxsd&DLID=108495 < dead link >
* Flightsim.com - http://www.flightsim.com/vbfs/fslib.php?do=copyright&fid=115211 < updated Dec.ember 12, 2012 >
* The Scenery Hall of Fame - http://www.scenery.org/graphical_editors.htm < dead link >

== Installation ==

=== Installing FSX KML ===

FSX KML can be installed in a folder of your choice. Simply unzip the FSX KML installation zip file into the desired folder.

After unzipping the installation file you should have the following files:-

* FSX_KML.exe
* ShapeLib129.dll
* FreeImage.DLL
* FSX_KML_TAGS.XML


=== Installing the FSX Software Development Kit (SDK) ===

To generate FSX scenery you will need the FSX SDK, which is distributed with the FSX Deluxe version.
To install the SDK:

(1) Browse the FSX Deluxe Edition Disk 1

(2) Open the SDK sub-folder

(3) Double-click the setup.exe

(4) Tell it where to install. Default is C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK

If the SDK is not installed in the default SDK folder you must specify its location on the FSX_KML build tab.

For more info on the SDK installation and Service packs: [http://www.fsdeveloper.com/wiki/index.php?title=SDK_Installation_%28FSX%29 http://www.fsdeveloper.com/wiki/index.php?title=SDK_Installation_%28FSX%29]

=== Installing FWTools ===

FSX KML makes use of the freeware tool set called [http://fwtools.maptools.org/ FWTools]. FW Tools is required for scenery that uses the FSX SDK Resample tool, such as landclass and waterclass.

Download and install the latest version of FWTools.

Specify the location of FWTools on the FSX KML Build tab.

=== Installing Google Earth ===

If you notice some null values for vertices when importing KML files from Google Earth, pls consider to revert to an older version of GE. More information about this issue you can find [ http://www.fsdeveloper.com/forum/showthread.php?p=144034 here]

Google Earth, Vers 5.1 is available here: [http://www.google.com/earth/download/thanks.html#release=previous#os=win#single=yes Google Earth 5.1]

== Building Scenery ==

Building your own scenery with FSX KML is easy.

=== Step 1 - Creating a KML file with Google Earth ===

The first step in creating your FSX scenery is to create a KML file by using Google Earth to "trace" scenery features.

==== Creating polygons and polylines ====

Using Google Earth create a polygon using the "Add Poly" function or create a polyline using the "Add Path" function,
and then trace the scenery feature (for example a lake or road).

After you click the "Add Poly" or "Add Path button" you will be presented with a form as shown to the right

[[Image:GE-polygon-dialog.jpg|thumb|right|150px|Google Earth dialog for creating new polygon or polyline]]

* Name - Give your polygon or polyline a description or leave blank

* Description - This is where you "tag" your polygon or polyline. You may enter a tag from FSX_KML_TAGS.XML or leave blank and tag later using FSX_KML

* Style & Color - You may choose the border and fill color for polyline or polygon

* Altitude - You may enter an altitude for your polyline or polygon. This can be used to specify the elevation of lakes. You may also enter the elevation later using FSX_KML. All elevations must be entered in meters.

Begin tracing your polyline or polygon. You may either click the mouse or hold the mouse button down and drag the mouse to create vertices.

* Use your mouse wheel to zoom the view in and out vertically.

* Use the up, down, left, right arrow keys to move the view horizontally.

* Hold Shift and press left or right arrow to rotate the view.

* Hold Ctrl and press up or down arrow to tilt the view.

To make things easier; it is good to get into the habit of drawing polygon vertices in the same direction, perhaps always draw clockwise. That way if you decide to add new vertices to define details better, then you can simply click to the right of the currently selected vertex (blue) to add a new one in. Avoid adding vertices that make the polygon twisted.
While polygon "properties" is open, take the time to change the transparency (from the colour tab)- if you leave it opaque, then you end up covering important details and spotting mistakes is more difficult.

Once you have finished click OK to save your polygon or polyline.

To edit your polyline or polygon highlight it, right click the mouse and choose properties.

==== "Tagging" the scenery features ====

To describe what scenery feature your polygon or polyline represents it needs to be "tagged". The file FSX_KML_TAGS.XML contains a list of the tags you can use.

There are two ways to tag a polygon or polyline:-

* Place the name of the tag in the description field of the polygon or polyline.
* Place the name of the tag in the description field of the parent folder that contains the polygon or polyline. If a polygon/polyline has no tag then it will inherit its tag from the parent folder.

You can place these tags in GE using the properties dialog of the polygon or polyline, or you can use FSX_KML to place these tags.

To tag using FSX_KML click on a description "cell" and press F2. An arrow will be displayed so then click on the arrow to drop down a list of valid tags. Highlight the tag you want and press ENTER. If you had multi-selected several cells then all the selected cells will be tagged. To select multiple cells hold down the shift key while clicking cells.

==== Saving your work to a KML file ====

Once you're done drawing your polygon(s) or polyline(s), simply right-click on the top-most folder you created (or the polygon itself if you didn't create folders) under the "My Places" tab on the left side of your GE window. Select "Save As", makes sure that you choose .kml as the file type, and select your desired location in your file structure.

=== Step 2 - Processing the KML file with FSX KML ===

[[Image:project.jpg|thumb|right|150px|The Project tab]] [[Image:build.jpg|thumb||150px|The Build tab]]

* Run FSX_KML
* On the "Project" tab, click the "Add KML" button and choose a KML file. The contents of the selected KML file will be displayed. You may add multiple KML files. A FSX BGL file will be generated for each KML input file.
* Change to the "Build" tab
* Set the following build options:-
** "FSX folder" - Input the folder where FSX is installed. By default this is "C:\Program Files\Microsoft Games\Microsoft Flight Simulator X"
** "Terrain SDK" - Input the location of the FSX terrain SDK
** "FW Tools" - Input the location where you installed FW Tools. FW Tools is required for scenery that uses the FSX SDK Resample tool, such as landclass and waterclass.
** "Run SDK tools" - If you select this option FSX KML will automatically run the SDK tools to turn your Shape Files into a FSX BGL
** "Copy generated scenery to FSX Addon Scenery Folder" - If you select this option FSX KML will copy the generated BGLS to the FSX addon scenery directory
* Click the "Build" button. FSX KML will now build your scenery. The progress of the build will be displayed in the build log window. The following actions will occur during the build:-
** For each KML file in your project
*** For vector based scenery an appropriate set of Shape files is generated depending on the features that have been tagged in the KML
*** For resample based scenery an appropriate Tiff file is created.
*** An XML config file is created for use by Shp2Vec, BGLComp and Resample
** A batch file called "Run_SDK_Tools.bat" will be created. This batch file contains the appropriate commands to call the FSX SDK tools (Shp2Vec, BGLComp and Resample)
** If you have selected the "Run SDK Tools" option then the Run_SDK_Tools.bat file will be executed. This will create various scenery .BGL files ready for use by FSX
** If you have selected the "Copy generated scenery..." option then the BGL files(s) will be copied to the FSX addon scenery directory. Please note: If FSX is running and using a previous version of your BGL file then the copy will not work because FSX will have the file "locked". The easiest way to ensure your file is copied to the addon scenery folder is to make sure FSX is not running.

=== Step 3 - Testing the scenery ===

* If you selected the "Copy generated files..." option then your scenery will have been copied to the FSX addon scenery folder. Simply run FSX and goto your scenery location to test the scenery

== Scenery Design Tutorial ==

The [http://www.fsdeveloper.com/wiki/index.php?title=FSX_KML_Tutorial FSX KML Tutorial] provides help with a variety of scenery design tasks.

== Editing a KML file using FSX_KML ==

Using FSX_KML you can easily edit your KML file. The following types of edits can be performed:-

=== Copy ===
To copy a KML item (folder or polygon/polyline) select the item to copy and click the copy button.
=== Delete ===
To delete a KML item select the item to copy and click the delete button.
=== Edit ===
To edit the Name and Description attributes of a KML item select either a single item or multiple items (hold the shift key to multi-select) and then press F2 to display the inline editor. Enter the new value and press enter. Your edit will be applied to the items you selected

=== Saving your changes ===
Click the save button to write your changes back to disk..
.

=== Open in Notepad ===
Click the "Open in Notepad" button to open the selected KML file in Notepad.
=== Open in Google Earth ===
Click the "Open in Google Earth" button to open the selected KML file in Google Earth.
=== Reload a KML file ===
If you have edited the selected KML file using an external program (eg Google Earth or Notepad) then you can reload those changes back into FSX_KML by clicking the reload button.

=== Properties Tab ===

This tab shows the properties for the selected polygon or polyline.

Freeways:
Use the "NumberOfLanes" and "Traffic Direction" attributes to define freeway related data.

Hydropolygons:
Use the "SlopeX" and "SlopeY" attributes to define slope characteristics of hydropolygons.

=== Vertices Tab ===

This tab shows the vertices (ie points) for the selected polygon or polyline.

Click the "Edit" button to display the vertice editor. This editor lets you edit the vertices in several ways:-

Reversing points:
The direction of a polygon or polyline can be reversed by using the REVERSE POINTS button. Click the "Reverse" button to change the direction of points in the polygon/polyline.

Setting elevation:
You can set the elevation for all vertices by clicking the "Set Elevation" button.

Manual editing:
You can manually edit vertices (longtitude, latitude and elevation) by editing data in the vertex grid.

=== XML Tab ===

This tab shows the XML for the selected polygon or polyline.

== FSX_KML_TAGS.XML ==

[[Image:Tags.jpg|thumb|right|150px|FSX_KML_TAGS tab]]

=== What is the FSX_KML_TAGS file? ===

This file holds the "tags" that are used in the KML file to describe FSX scenery features. You can customise this file to add more tags or change existing ones.

An easy way to browse this file is by clicking on the "FSX_KML_TAGS.XML" tab in FSX KML.

This XML contains the following attributes for each "tag":-

* Tag - The unique identifier for this scenery feature. This tag is what you use to "tag" the polygons/polylines in your Google Earth KML file
* Description - A description of the scenery feature. This description is displayed in FSX KML.
* Feature Type - The type of scenery feature and must be one of the following types:-
** WATERPOLY - Water polygons such as coastline, rivers, lakes, canals etc
** WATERPOLYGPS - Low resolution water polygons for use in the GPS
** LANDCLASSPOLY - irregular shaped landclass polygons for towns, forest, beaches, park etc
** AIRPORTBOUNDRY - define airport boundries and also flatten areas and AUTOGEN EXCLUSIONS
** EXCLUSION - exclude default vector scenery from the polygon
** STREAM - create streams
** SHORELINE - create animated shorelines
** ROAD - create roads (NOT road bridges)
** FREEWAY - create moving traffic
** RAILWAY - create railways (NOT rail bridges)
** UTILITY - power lines, telegraph lines, fences etc
** SCENERYOBJECT - place scenery objects
** EXCLUSIONRECTANGLE - excludes scenery objects
** EXTRUSIONBRIDGE - creates extrusion bridges
** LANDCLASS - create land class
** WATERCLASS - create water class
* GUID - The FSX GUID for the scenery feature.

Please refer to the FSX "terrain.cfg" file and terrain SDK documentation for futher information on feature types and GUIDs

=== Editing FSX_KML_TAGS.XML using FSX KML ===

The FSX_KML_TAGS.XML file can be easily edited in FSX KML. To following edits can be performed:-

==== Copy ====
To copy an item select the item to copy and click the copy button.
==== Delete ====
To delete an item select the item to delete and click the delete button.
==== Edit ====
To edit the Tag, Description, FeatureType or GUID attributes of an item select either a single item or multiple items (hold the shift key to multi-select) and then press F2 to display the inline editor. Enter the new value and press enter. Your edit will be applied to the items you selected

==== Saving your changes ====
Click the save button to write your changes back to disk.
==== Open in Notepad ====
Click the "Open in Notepad" button to open the FSX_KML_TAGS.XML file in Notepad.
==== Reload ====
If you have edited the FSX_KML_TAGS.XML file using an external program (eg Notepad) you can reload those changes by clicking the reload button.

== Google Earth ==

=== Downloading Google Earth ===

The free version Google Earth may be downloaded from the [http://earth.google.com/ Google Earth home page]

=== Copyright of Google Earth Data ===

Scenery developers need to be aware that there may be copyright issues associated with the use of data obtained from Google Earth. Please see the [http://earth.google.com/support/ Google Earth support page] for more information on the Google Earth policy of using this data in your freeware or commercial products.

== Freeware scenery using FSX KML ==

The following freeware has used FSX KML during their development:-

* [http://library.avsim.net/esearch.php?DLID=&Name=Isle+of+Wight&FileName=&Author=Len+Hickman&CatID=fsxscen Isle of Wight (UK) reconstructed] by Len Hickman
* [http://library.avsim.net/esearch.php?DLID=&Name=Quebec+Scenery&FileName=&Author=Gilles+Gauthier&CatID=fsxscen Quebec Scenery - Lakes and Rivers] by Gilles Gauthier
* [http://library.avsim.net/esearch.php?DLID=&Name=Catalunya+Coast&FileName=&Author=Bodo+Hesse&CatID=fsxscen Catalunya Coast] by Bodo Hesse
* [http://library.avsim.net/esearch.php?DLID=&Name=Naval+air+station&FileName=&Author=Jim+Dhaenens&CatID=fsxscen Naval Air station Jacksonville (KNIP)] by Jim Dhaenens
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=103120 Naval Air Station Oceana (KNTU)] by Jim Dhaenens
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=102870 Coffs Harbour (YSCH)] by John Ross (also at www.virtualvfr.com)
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=103027 Kitimat/Terrace] by Douglas Keech
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=102995 Los Angeles "clean-up"] by Lance Tucker
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104609 Lord howe Island and Balls Pyramid] by Don Bush
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104853 Falklands 2007] by Brian Jamieson
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=104000 Gloucestershire Airport] by Terry Shields
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=105386 Okanagan Valley Landclass and Rivers] by Alex Sievert
* [http://library.avsim.net/esearch.php?DLID=106386&CatID=fsxscen Gold Coast Airport (YBCG)] by John Ross
* [http://marcoh.gratisim.fr Photorealistic Town of Nantes in France] by Marc-henri Guitteny
* [http://library.avsim.net/esearch.php?DLID=109752&CatID=fsxscen Utah Complete v1.0] by James Udall
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=111154 Bushflight Northwest] by Bill Dick / Phil "Snowman" Cayton / Chris Brisland
* [http://library.avsim.net/esearch.php?DLID=114132&CatID=fsxscen Wake Island] by Tony Arnold
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=117501 SICILY VFR X - Lakes and Reservoirs] by Giovanni Miduri
*[http://library.avsim.net/download.php?DLID=121703 Chernobyl Exclusion Zone] by Mike Dalgleish
*[http://fly-wonderful-islands.com/page_89.html La gomera GCGM Spain] by Allen Cremeen
* [http://marcoh.gratisim.fr Photorealistic St Pierre & Miquelon archipelago near Newfoundland] by Marc-henri Guitteny
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=105600 Quebec city v1.0] by Jean St-Cyr and Gilles Boily
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=139471 Quebec city v2.0] by Jean St-Cyr, Gilles Boily, Gilles Gauthier and Jean-Pierre Fillion
* [http://library.avsim.net/esearch.php?CatID=fsxscen&DLID=144264 Angel Falls for FSX] by Jean St-Cyr
Freeware authors please list your freeware scenery here!

== Commercial scenery using FSX KML ==

The following commercial scenery has used FSX KML during their development:-

* [http://www.imaginesim.com/kcvg01.htm KCVG Cincinnati Northern Kentucky International Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/tjsj01.htm TJSJ San Juan Luis Munoz Marin Airport, Puerto Rico] by Imagine Simulation
* [http://www.imaginesim.com/kclt01.htm KCLT Charlotte Douglas Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/mynn01.htm MYNN Nassau International, Bahamas] by Imagine Simulation
* [http://www.imaginesim.com/klga01.htm KLGA New York La Guardia Airport, USA] by Imagine Simulation
* [http://www.imaginesim.com/kmci01.htm KMCI Kansas City International Airport, USA] by Imagine Simulation
* [http://www.aerosoft-shop2.com/products/helgolandx/helgolandx.html Helgoland X] by AeroSoft
* [http://www.aerosoft-shop2.com/products/monacox/monacox.html Monaco X] by AeroSoft
* [http://www.aerosoft-shop2.com/products/aspenx/aspenx.html Aspen X] by AeroSoft
* [http://secure.simmarket.com/product_info.php?products_id=2361 Pantanal - The Wetlands] by CenaReal
* [http://www.fly-wonderful-islands.com/Slide/gclp_v1.html GCLP Gran Canaria Airport Canary Islands Spain] by Fly Wonderful Islands
* [http://www.fly-wonderful-islands.com/FWI_GCRRv2/Slide_GCRR_V2/FWI_GCRR_V2.html Lanzarote GCRR Airport Canary Islands Spain] by Fly Wonderful Islands
Please list other commercial scenery here.

== End User Licence ==

Copyright Â© 2007 Innova Software ALL RIGHTS RESERVED

FSX KML ("Software") is distributed without charge to FSX add-on designers, redistribution of the original ZIP file is not allowed. You are NOT allowed to sell this software or ask money for its distribution.

FSX KML may be used free of charge for the production of both freeware and commercial add-ons (including sceneries,missions,aircraft) subject to the following terms and conditions:-
* You notify Innova Software of the use of FSX KML in your add-on
* You give Innova Software a free copy of your add-on (and any updates)
* In your readme file you say that FSX KML was used to help with the production of your add-on
* The copyright and any intellectual property relating to the FSX KML software shall remain the property of Innova Software
* LIMITED WARRANTY - INNOVA SOFTWARE SHALL NOT BE RESPONSIBLE IN TORT OR IN CONTRACT FOR ANY LOSS OR DAMAGE HOWSOEVER CAUSED TO THE PROPERTY OR PERSON OF YOURSELF OR ANY THIRD PARTY AS A RESULT OF ANY DEFECT IN THE SOFTWARE WHETHER PATENT OR LATENT OR AS A RESULT OF ANY FAULT, NEGLIGENCE, WRONGFUL ACT OR OMISSION OF INNOVA SOFTWARE OR ANY OF ITS SERVANTS, EMPLOYEES, CONTRACTS AND AGENTS, AND YOU INDEMNIFY INNOVA SOFTWARE AGAINST ANY CLAIMS MADE AGAINST IT BY ANY THIRD PARTY ARISING OUT OF ANY SUCH DEFAULT OR FAULT, NEGLIGENCE, WRONGFUL ACT OR OMISSION AND IN NO EVENT SHALL INNOVA SOFTWARE BE LIABLE FOR ANY CLAIMS OR DAMAGES INCLUDING, BUT NOT LIMITED TO CLAIMS OF FAULTY DESIGN, NEGLIGENT OR MISLEADING ADVICE, DAMAGES ARISING FROM LOSS OR USE OF THE SOFTWARE AND/OR SUPPLY OF SERVICES; AND ANY INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES OR INJURY TO ANY PERSON, CORPORATION OR OTHER ENTITY BY REASON OF THE PROVISION OF THE SOFTWARE AND/OR PROVISION OF SERVICES PURSUANT TO THESE TERMS AND CONDITIONS

Developers can email acceptance of these terms and conditions to fsx_kml@innovasoftware.com.

== Release History ==

=== v1.00 Beta - 19th 0ct 2006 ===

This is first beta release of FSX KML

=== v1.01 Beta - 19th 0ct 2006 ===

Issues resolved:-
* Fixed error with FSX_KML_TAGS.XML file not found

=== v1.02 Beta - 21st 0ct 2006 ===

Issues resolved:-
* Fixed error reading polygon/poylines. FSX KML could sometimes insert an erroneous point of 0,0

=== v1.03 Beta - 28th 0ct 2006 ===

New features and issues resolved:-
* Better handle tags in description field. Be less strict about "whitespace" and cr/lf
* Better handle international settings for decimals
* Add more excludes to fsx_kml_tags.xml (see tags starting with "exclude__")
* Add support for moving kml items up/down
* Add support for moving kml items via drag drop
* Add support for creating new kml folder
* Create shapes in order they appear in the KML
* Assign UUID (starting at 1) to each shape in the KML based on its order in the KML

Known issues (Features not implemented in this release):-
* Freeway tags (moving traffic) - in v1.03 you must manually edit the FW .DBF file to set traffic density and direction

=== v1.04 Beta - 20th Jan 2007 ===

New features and issues resolved:-

* Use INI file (FSX_KML.INI) to remember settings including list of KML files and FSX folder settings
* Allow multi select of KML files in Add KML file dialog
* Display points for selected polygon/polyline
* Add REVERSE POINTS button to allow direction of polygon/polyline to be reversed
* Add POLYGONHOLE tag to support "holes" in polygons, eg for making islands in rivers
* Add LEGACY_LANDWATERMASK_WATER_NOFLATTEN tag for water polygons that "cling" to mesh
* Default freeway traffic to one lane of traffic

=== v1.05 Beta - 21st Jan 2007 ===

New features and issues resolved:-

* Added "Automatically Reverse Points In Polygon Holes" build option. This option will auto reverse points for polygon holes when creating the shape file. Apparently Google Earth always writes polygons in a clockwise fashion to the KML file irrespective of which way they are actually drawn in Google Earth. This option simplifies the creation of polygon holes because you no longer need to manually reverse point order in FSX KML. Option is on by default.
* Added "Output Folder" build option. This lets you specify the folder where files are written during the build process
* Fixed error when loading the saved list of KML files and a KML file can longer be found.

=== v1.05.1 Beta - 21st Jan 2007 ===

Issues resolved:-

* Fixed bug where directory would not be changed prior to running the RUN_SDK_TOOLS batch file

=== v1.06 Beta - 14th Apr 2007 ===

New features:-

* Added grid to allow manual editing of polygon/polyline points (longitude,latitude,elevation)
* Added button for setting all points in polygon/polyline to a specific elevation
* Added support for tag parameters (eg freeway traffic data and hydro poly slopeX/Y)
* Added option to save backups to backup subdirectory (on by default).
* Added XML tab to show XML for highlighted node
* Remember window size and position

Issues resolved:-

* Changed tag name of "Park" to "LandClassPoly" since landclass polys can be used for more than just parks! Existing "Park" tags are automatically renamed to "LandClassPoly"
* Handle extra '.' in filenames

=== v1.07 Beta - 25th Apr 2007 ===

New features:-

* Added "Shape" tab with support for shape viewing. Select single (or multiple) polygon/polylines to see its shape. Selecting a folder will show all shapes in that folder and any sub folders.
* Added "Select All" function (Ctrl A) to select all polylines/polygons
* Added "New" button to Vertices form to insert vertice.
* Added "Copy" button to Vertices form to copy the selected vertice.
* Added "Delete" button to Vertices form to delete selected vertice.
* Added "Move Up" and "Move Down" button to Vertices form to move selected vertice up or down in list.
* Added Options menu to main form. Moved "Save Backups" to this menu
* Added "Remember Window Position and Size" to the options menu

Issues resolved:-

* Updated the "About" form to credit the 3rd party development libraries used (eg Shapelib)
* Fixed misplaced longitude and latitude labels on vertice grid

=== v1.08 Beta - 18th May 2007 ===

New features:-

* Add BGLCOMP support for placing of FSX library objects along polyline. The use of "Variance" parameters below helps create more naturalistic looking scenery by applying random variance to object positioning. Support the following parameters:-
** Altitude AGL or MSL
** Altitude variance - Random variance in meters applied to alitude (use 0 for no variance)
** Pitch (0 - 360)
** Pitch variance - Random variance in degrees (0 - 180) applied to pitch (use 0 for no variance)
** Bank (0 - 360)
** Bank variance - Random variance in degrees (0 - 180) applied to bank (use 0 for no variance)
** HeadingType
*** Track - Heading of each object follows the direction of each polyline segment
*** Fixed - Heading of all objects is specified by Heading parameter
*** Random - Heading is random for each object
*** Elevation - Heading for each object is specified by elevation of associated polyline vertice
** Heading (0 - 360) - Used when HeadingType = Fixed
** Heading variance - Random variance in degrees (0 - 180) applied to heading (use 0 for no variance)
** Scale - Scale multiply of object (defaults to 1.0)
** ScaleVariance - Random variance in scale to apply to objects. (use 0 for no variance)
** ImageComplexity - VerySparse, Sparse, Normal, Dense, VeryDense, ExtremelyDense
* FSX_KML_Tags tab - Add tags for all default FSX scenery library objects
* Build tab - Add button for setting BGLComp SDK path
* Build tab - Add "Open" button for output folder path to open Windows Explorer on that folder

Issues resolved:-

* Fixed issue with copy button

=== v1.09 Beta - 23rd June 2007 ===

New features:-

* Added BGLCOMP support for scenery exclusion rectangles ("ExclusionRectangle" tag). The exclusion rectangle will be defined by the "bounding" rectangle of the polyline/polygon. Supports the following parameters
** ExcludeAllObjects
** ExcludeBeaconObjects
** ExcludeEffectObjects
** ExcludeGenericBuildingObjects
** ExcludeLibraryObjects
** ExcludeTaxiwaySignObjects
** ExcludeTriggerObjects
** ExcludeWindsockObjects
** ImageComplexity - VerySparse, Sparse, Normal, Dense, VeryDense, ExtremelyDense
* Added BGLCOMP support for Extrusion Bridges ("ExtrusionBridge" tag). Draw a polyline and tag it with "ExclusionBridge", then use the vertice editor to set the height of each bridge segment.
* Added "Change to" button on the Vertice Editor to change shape type from polygon to polyline and vice versa
* Enhanced polygons holes so that if a polygon cannot be found in the same folder as polygon hole ("polygon folder") then the parent folder is searched for the first polygon preceding the polygon folder. This makes it possible to better organize a project by placing polygon holes (i.e islands) in a sub folder and still have them associated with a water polygon in a parent folder

=== v1.10 Beta - 19th August 2007 ===

New features:-

* Land class tiles
* Water class tiles

== Development Roadmap ==

The following features are planned for upcoming releases:-

=== Future releases ===
* Update this manual :)
* Add 10 minute autosave
* Add following params to BGLCOMP support:-
** Heading Type
*** FixedTrack - Heading of all objects is fixed to the direction of first polyline segment
** Divergence - Random divergence (in meters) from vertice. Applied in direction which is perpendicular to direction of polyline segment (use 0 for no variance)
* Add "AutoPolygonHole" to polygon properties sheet. This allows a polygon hole to be automatically created in the shape of the polygon, and removes the need manually create a hole (by copying and tagging as hole)
* Fix - Ensure lon/lat uses '.' and not ','
* FSX_KML_Tags tab - Add support for tag groups
* Add BGLCOMP support for Tag Groups. Tag grouping allows the scenery designer to group together similar scenery library objects into a single group. For example, when populating a car park the designer could use a tag group containing a variety of car models. This would result in car models being chosen at random from the tag group.
* Add shape viewer to Vertice Editor form and have it refresh as vertices are edited.
* Add "Fly to" button to Vertices Editor form to move FSX aircraft to the selected vertice
* Add "Paste Aircraft pos" button to Vertices Editor form to paste the current location of aircraft (longtitude, latitude, and optionally altitude) into the list of Vertices.
* Export - Ability to export selected polygons/polylines to a CSV file, with option for long/lat/elevation ordering
* Scenery Placer - Add support for dynamically previewing scenery objects while FSX is running. This allows very precise and interactive control over the objects placement and orientation without the need to build a BGL and reload FSX.
* Placing FSX library objects inside a polygon. Allow number of objects and elevation to be specified. Objects will be distributed randomly within the polygon. This can be used to populate livestock, wildlife, boats/ships in harbors, people on beaches, birds, hot air balloons etc
* FSX_KML_Tags tab - Texture preview for land class polygons and tiles tags
* FSX_KML_Tags tab - Scenery object preview for default FSX scenery objects
* Ability to inject a QMID 11 grid into the KML to aid with visualization of exclusion areas
* New, Open and Save project buttons to support multiple projects.
* "Check for Update" menu option to check online for updates.

* If possible conditional display of FSX scenery library objects based on various triggers such as date/time, weather conditions and probability factor. For example, this would allow harbors to be populated with pleasure craft on sunny warm days, but not at night or in cold weather. Would allow forest fires to be generated in hot, windy conditions.
* If possible ability to animate FSX scenery library objects along a polyline
* "Photo scenery" ground textures
* Flight plan generation along polyline


== Software by this author ==
[http://fsdeveloper.com/wiki/index.php?title=FSX_KML FSX_KML]

[http://fsdeveloper.com/wiki/index.php?title=FSX_Photoscene FSX_PhotoScene]

[http://fsdeveloper.com/wiki/index.php?title=SRTM_To_BGL SRTM_To_BGL]

[[Category:Manuals]]
[[Category:Tools]]
[[category:Scenery_Design]]

ObPlacer XML

2012-11-29T22:14:45Z

GaryGB: /* Installation */

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = true
| FS2002 = false
| FS2000 = false
| FS98 = false
}}

This article is the user manual for ObPlacer XML. This tool allows you to place objects while you slew through FS. It provides you a graphical user interface to the creation of an XML scenery file. You can place library objects, effects, generic buildings or MDL objects (exported from GMax).

You might think the features of this tool sound very similar to the [http://www.rwy12.com Rwy12] Object Placer tool and that is true. After Rwy12 was released I have considered if I should continue developing ObPlacer XML. But because I think there are some difference between these tools I have continued the development (as you can see from this new version).

Rwy12 is a great tool if you are not really a scenery designer and want to place a few library objects around your favourite airport. But for a scenery designer who just wants to place an object he has made in GMax and which is unique for a certain airport I think Rwy12 is not really efficient, as you would have to make a special XML file for Rwy12 first, while ObPlacer XML is able to read your BGLComp library XML or add the MDL object directly.

If you feel you are more comfortable with placing objects from a predefined library, I advice you to take a look at Rwy12 instead. If you by now still think this could be the tool for you, please continue reading the rest of this manual.

== Download ==
[http://www.fsdeveloper.com/forum/downloads.php?do=file&id=13 Installer version]

[http://www.fsdeveloper.com/forum/downloads.php?do=file&id=12 Zipfile version]

== Installation ==

The installation procedure of ObPlacer XML depends on the version you have downloaded. If you have downloaded one of the installers, then you only need to run that installer and you are ready to go. If you have chosen to download the ZIP file version, you need to unzip the content of the file to a folder of your choice.

Before you can start using ObPlacer XML there are two things that you need to check. First you need to make sure that FSUIPC is installed on your computer. FSUIPC is the module that ObPlacer XML uses to communicate with Flight Simulator and to read or write the position of your aircraft. If you do not have FSUIPC installed yet, you can download it from the [http://www.schiratti.com/dowson.html FSUIPC homepage]

Without FSUIPC you can still use ObPlacer XML to place your objects, but you will have to type in the coordinates manually. So it is strongly adviced to use FSUIPC, as you can then just slew around in FS to get the correct coordinates.

To make use of the dynamic preview of the GenericBuilding objects, you will need to install the latest version of the graphical DLL files by Martin Wright as well. Without these files the dynamic preview will be disabled (but the rest of the tool is still working). You can get these DLL files from his [http://www.mwgfx.co.uk/ homepage].

The first time you start ObPlacer XML a configuration file will be made. If you are updating ObPlacer XML and you get crashes at startup, please remove your current ''config.xml'' file and let ObPlacer XML create a new one for you.

To get preview pictures with most default library objects, it is also adviced that you install the additional picture pack that is available from [http://www.fsdeveloper.com FsDeveloper.com]. Just unzip all these pictures to a subfolder called <code>pics</code> in your ObPlacer XML folder.

If you ever want to uninstall ObPlacer XML, you can run the uninstall program that is located in your ObPlacer XML folder. You can also start this uninstaller from the "Add or remove software" section of the control panel. If you used the ZIP file distribution you can just delete the folder you placed the files in.

== Interface ==

This section describes the components of the graphical user interface. As the interface is totally new compared to the previous versions of ObPlacer XML it is advised that every user reads this section.

The interface consists of the following main elements:

* A main form that contains a list of all objects placed in your XML file
* A form with a tree view of all object available for placement
* A form that shows the properties of the currently selected object
* A form that can show a preview of the selected object

Below you find an image of how the interface of ObPlacer XML can look. Besides the main elements, which will be described in more detail later, the interface also contains a menu bar and a status bar.

[[Image:obp_screen.jpg|700px]]

=== The dockable forms ===

One of the main features of the new interface is that the forms are dockable. So you can arrange them in a way that suits you. The object tree, the object properties and the preview form can all three be placed either at the top, bottom, left or right side of the screen. You can also change their width and height. All other space is filled with the list of placed XML objects. Your current layout of the forms is saved when you export ObPlacer XML, so it will have been remembered the next time you start again.

For example, when placing library object I prefer to have the object properties and the preview form on the right, as you need quite some space to display the tree of available objects. When placing GenericBuildings on the other hand, you need a lot of space for the properties (as I hate to have to scroll through them). So in that case I prefer to have the preview on the left, together with the available object tree.

You can also undock the forms and use them as floating forms. If you have a multi monitor setup you could even place the preview form full screen on your second monitor.

=== Menu bar ===

==== File ====

[[Image:obp_mfile.jpg]]

The file menu gives you access to the usual things you would expect there.

* '''New XML''' Create a new XML file. You are asked to provide a name for the new XML file. If the file already exists you will be ask if you want to overwrite it.
* '''Open XML''' Open an existing XML file.
* '''Save XML''' Save the currently loaded XML file.
* '''Save XML As''' Save the currently loaded XML file, where you get the chance to provide a new file name.
* '''Compile BGL''' Compile the currently loaded XML to a BGL file. You will be asked to provide the location for this BGL file (the default location is in the same folder as your XML file). Your selected location will be remembered and used as default the next time you compile. This is done for each XML file separately. During the compilation you will be shown a form that displays any messages from the compiler.
* '''Export as SHP file''' Save the current XML file as a shapefile((If you have no idea what I am talking about here, just skip this item, so will probably not need it in that case. This is more an advanced option if you want to export your XML data to another format.)). This option only works if you have installed the file ''shapelib.dll'' on your system (not provided with ObPlacer XML). In the database file belonging the to shape file, the GUID, name and the comment of the object are written.
* '''Last opened files''' At the bottom of the menu you will find a maximum of 8 XML files that you have recently used. This allows you to reopen them faster.

==== Edit ====

[[Image:obp_medit.jpg]]

The edit menu gives you the option to undo recent changes your made to the XML file. This can either be adding or removing an object, adding or removing a local MDL object or changing the parameters of an object.

Temporarily files are created in your ObPlacer XML folder for each undo state. So during runtime this could take a little harddisk space, but these files will be removed once your close ObPlacer XML.

The number of undo steps that you can perform is almost unlimited. The counter of the undo list has a maximum value of 32767, but I doubt someone will make that many changes to a single XML file.

Besides the undo functionality, the edit menu also gives you access to a Coordinate conversion tool and a SHP file import option. These two options only work correctly if you are using the Dutch RD coordinate system, so they are probably not of much use to most users.

==== Objects ====

The Object menu is also available as a right click menu in the available object tree, its functions will be described in more detail when that form is discussed.

==== View ====

[[Image:obp_mview.jpg]]

The view menu allows you to enable or disable the display of the three dockable forms. So if you don't need the preview at the moment for example, you can hide it to get more space for the other forms. Clicking the option again will bring back the form at its last location.

=== Statusbar ===

[[Image:obp_statusbar.jpg|700px]]

At the bottom of the screen you find a statusbar. In the left side messages can be displayed, for example when you add new objects. On the right you find two buttons, each with a special function.

* '''Dockable''' The dockable button indicates if the forms are dockable or not. If you click this button you will notice that the text becomes greyed out and now you can no longer dock or undock forms. This is to prevent trouble when you are moving a floating form and it keeps docking while you do not want it to do so. Or to make sure you do not undock a form by accident.

* '''FSUIPC''' The last button indicates the connection status with FS. If no connection could be made using FSUIPC the label will show "FSUIPC failed" and when a connection could be made the label will read "FSUIPC OK". Clicking this button has no effect, ObPlacer XML tries to make the connection automatically.

=== Placed objects ===

The center part (this depends a bit on how you arranged the dockable forms) of your screen is reserved for the list of the objects you have placed in your XML file. When you click on an object in this list, its properties will be displayed in the object properties form (this form is discussed in more detail later) and the tree view will move to this object as well.

[[Image:obp_mlist.jpg]]

If you right click on an object you will get the menu as shown above. This menu gives you access to the following functions:

* '''Remove object (R)''' This removes the currently selected object from the XML file.
* '''Move upwards (Z)''' This moved the currently selected object upwards in the list. This enables you to rearrange your objects in a logical way.
* '''Move downwards (A)''' This moved the currently selected object downwards in the list. This enables you to rearrange your objects in a logical way.

The letters between brackets behind the function name are the keyboard shortcuts that you can also use the perform that function. So if you press the Z key, your selected object will be moved downwards.

=== Available objects ===

[[Image:obp_objtree.jpg]]

The available objects tree gives an overview of all objects you can place in your XML file. This tree consists of the following categories:

* '''Default library objects''' This category contains objects that are available in the default library that come with Flight Simulator. This list is certainly not complete, so if you have found other useful objects please let me know so that I can add them. When you have installed the picture pack for ObPlacer XML as well, most of these objects will get a preview image.
* '''Effects''' This category contains all effect files you have installed in your Flight Simulator. They are read directly from the effects folder on your PC. Please remember that some of them are designed for aircraft and will not work in scenery.
* '''User library objects''' When you add the XML source of your own object library, a new entry will be made in this category. Under this entry you can then find all the objects of this user library. When using these objects, you need to make sure that you distribute the library BGL together with your placement BGL.
* '''MDL objects''' When you add a MDL object, created with GMax, to ObPlacer XML it will appear under this category. Please be aware that objects placed with this method are locked to a certain geographic location, so it is not advised to call them as library objects from another XML file.
* '''Generic building''' This category allows you to create XML style GenericBuildings. The dynamic preview will help you to see how the building is going to look in Flight Simulator.
* '''Misc''' This category contains miscelaneous XML object. At the moment only the Fuel Trigger object falls into this category (note: the Misc section is not shown in the screenshot).

[[Image:obp_mobjects.jpg]]

Once you have selected an object in the tree list, you can right click to get a menu with functions you can perform. If you want you can also access these functions using the File, Objects menu. If a function is not valid for the object you have currently selected, it will be greyed out. The available functions are:

* '''Add new object before selected (P)''' This will place the currently selected object from the tree list, before the currently selected object of your XML file. This allows you to group objects in a specific way. After you have added the object, you can adjust its properties if needed in the object properties form.
* '''Add new object at end of list (E)''' This will place the currently selected object from the tree list, at the end of your XML file. After you have added the object, you can adjust its properties if needed in the object properties form.
* '''Update selected object''' This will update the selected object in the XML list, to the object you have currently selected in the tree list. This allows you for example to replace one library object with another, without having to create a new one. All properties remain the same, only the object is changed. This option is only allowed if the objects you have selected are of the same type. So both must be effects or library objects.
* '''Add user library''' This gives you the option to load a new user library XML file into ObPlacer XML. This user library is then stored in your config and loaded again the next time you start ObPlacer XML.
* '''Add Rwy12 library''' Just like the option above this allows you to load a new library into ObPlacer XML. This option allows you to read Rwy12 XML files, while the preview one reads BGLComp source XML files.
* '''Add local MDL''' This gives you the option to add a MDL files to your current XML file. As this object is stored in your XML file, it is only available in this file.
* '''Remove local MDL''' This allows you to remove the currently selected local MDL file from your XML file. All placed instances of the object will then also be removed.
* '''Mass add MDL folder''' This allows you to add all MDL objects in a certain folder to your XML file at once.
* '''Rescan object tree''' This option rescans the object tree. This can be useful if you have installed a new effect or when you have updated a user library XML file. After rescanning these changes are also visible in ObPlacer XML.

The two placement functions also have a keyboard shortcut, which is indicated with the letter between brackets. And when you double click on an object in the tree view it will also be placed at the end of your object list.

=== Object properties ===

[[Image:obp_properties.jpg]]

The object properties form allows you to change all the parameters of your object. For example its location or heading. When you click on a value you will enter the editing mode where you can change the value. Once you click on the next grid cell the new value is stored in the XML file (you can undo your change with the undo function if needed).

Some parameters will get a textbox to change the value, while others will have a dropdown list or a spinbox. In all cases you are limited in the characters you can enter. For example only numbers or a dot are allowed when you enter a heading. This makes sure you can only added a valid value.

There is also a faster way to navigate through the grid and that is by using the keyboard. If you press the Enter key you will enter the editing mode for the selected parameter. And if you press Enter again the new value is stored. By using Tab and Shift-Tab you can move to the next or previous grid. If you move to another field while still in editing mode, you will remain in editing mode in the new field as well.

[[Image:obp_mprop.jpg]]

If you right click on either the latitude, longitude or the heading you will get the menu as shown above. This menu gives you some functions to read or write values from or to Flight Simulator using FSUIPC. So the connection with Flight Simulator should be active for these functions to work.

* '''Read position from FS (R)''' This will read the total position from Flight Simulator (so latitude, longitude and heading).
* '''Write position to FS (W)''' This will write the total position to Flight Simulator (so latitude, longitude and heading).
* '''Read latitude from FS''' This will only read the selected parameter from Flight Simulator (in the image this is the latitude, but it could also be the longitude or the heading).
* '''Write latitude to FS''' This will only write the selected parameter to Flight Simulator (in the image this is the latitude, but it could also be the longitude or the heading).

The functions to read and write the total position can also be access with a keyboard shortcut. The letters are given between brackets.

When you place a new object, ObPlacer XML will by default try to read the total position from Flight Simulator. If this is not the position you want, you can edit the values manually.

=== Preview ===

[[Image:obp_preview.jpg]]

The preview form can give you a preview of the selected object (as the name already suggests). If you click on a library object, ObPlacer XML will try to load a JPG or BMP file with the GUID of the object as name from the pics subfolder. If such an image is found the preview is shown, else the preview forms remains empty. When you select a GenericBuilding, you will get a rotating dynamic preview of how the object will look in Flight Simulator. When you change the parameteres of your object, this preview will also adapt.

If you right click on the preview, you will get a popup menu where you can stop the rotation of the object. Sometimes this might make it easier to enter the correct parameters for your building.

== Support ==

This last version of ObPlacer XML should be rather stable and it do no longer call it a beta version. But as the GUI has been totally reworked since the last version, there is always a chance that some problems are still there. That is the reason this version is (not yet) called v1.00. So if you found a problem, or if you have comments or suggestions on how to improve this tool, please let me know. You can reach me either by [mailto:arno@scenerydesign.org email] or through the forums of my website [http://www.fsdeveloper.com FsDeveloper.com].

== Thanks to ==

* Nick Whittome for his suggestions and ideas that helped in shaping the concept of ObPlacer XML
* Erwin Horjus for his suggestions to add new functionality to ObPlacer XML
* Jon Patch for encouraging me to add the GenericBuilding feature and helping a lot with debugging this new feature
* Pete Dowson for the FSUIPC module
* Marco Pipino for the DOSOutputs class I used to compile the BGL file from ObPlacer XML
* All other beta testers who helped to get as much bugs out of ObPlacer XML as possible
* Everybody who gave me feedback about previous versions

== Version history ==

'''v0.84''' 05/08/2007
* Added the option to place Fuel triggers
* If Fs2004 is not found on your system, ObPlacer XML will now also look for FsX
* FSUIPC4 is now recognised as a valid FSUIPC version

'''v0.83''' 29/08/2006
* Reversed texture mapping (X and Z axis) solved in the preview window
* Added ability to read library information from Rwy12 XML files
* When editing properties the spacebar is now also allowed, so that you can edit coordinates that are not in decimal form
* Rotation of the preview can be stopped

'''v0.82''' 01/03/2006
* Comma vs dot problem solved when reading heading with FSUIPC
* Four additional roof textures available for GenericBuildings
* Four colors available for the GenericBuildings to be used instead of textures
* Double clicking in the tree view will also place the object at the end of your list
* When opening new file you are asked if you want to save the current one
* Other small changes I have forgotten about

'''v0.81''' 03/08/2005
* Dynamic preview problems solved, should now work on each PC
* Option between single and double buffering removed, double buffering is now default
* Option add to change the object while keeping all other parameters (only allowed if new object is same type)
* Properties are now stored correct if you click somewhere else
* Object list can be exported as shapefile

'''v0.80''' 16/07/2005
* Ability to place GenericBuildings
* Dynamic preview of the GenericBuildings
* Totally new GUI
* Windows comma vs dot problem solved

'''0.14 beta''' 25/04/2005
* Now using FSUIPC instead of FSConnect for communication with FS
* Ability to write position to FS added
* Preview pictures added
* BGL path is remembered for each XML file
* Available objects tree can be rescanned

'''v0.13 beta''' 10/01/2005
* Now works with all decimal character settings of windows
* Scale no longer reset when selecting new object

'''v0.12 beta''' 08/01/2005
* Compilation problems solved
* Position can also be edited
* Position read from FS as option
* ''Generic.xml'' updated
* Other minor fixes

'''v0.11 beta''' 31/12/2004
* When errors occur during saving the XML file, the less readable but still valid XML file is restored
* Tabs in the XML file no longer give trouble
* Crash solved when adding MDL objects with an empty object list
* Compilation problems due to path in XML file solved
* When you quit you are asked if you want to save the current XML file
* Folder for the BGL file can be specified as well
* Option to add all MDL objects in a certain folder at once
* When adding/updating or deleting objects the focus of the object list works correct
* The focus colour of the object list now works with all Windows colour themes
* The produced XML file is more readable now
* Last used XML and MDL folder are remembered separately

'''v0.10 beta''' 29/12/2004
* First version available for testing.

== Users license ==

(c) 2004-2006 SceneryDesign.org / Arno Gerretsen

This software program is distributed without charge to other scenery designers, redistribution of the original installer EXE file is allowed. You are NOT allowed to sell this software program or ask money for its distribution. BGL files created with this software program can be used in commercial scenery projects if you wish.

The copyright and any intellectual property relating to this program remain the property of the author.

The software distributed in this way may represent work in progress, and bears no warranty, either expressed or implied.

[[category:Manuals]]
[[Category:FS9_(FS2004)]]
[[Category:Tools]]

MDL Tweaker II

2012-11-29T22:12:36Z

GaryGB: /* Installation */

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = false
| FSX = false
| FS2004 = true
| FS2002 = false
| FS2000 = false
| FS98 = false
}}

This is the manual of MDL Tweaker II. At the moment a beta version of this tool is available. So as the tool is still under development it might be that the manual is not always up to date. Still this manual should give you enough information to get started with MDL Tweaker II. Any additions or suggestions on how to improve this manual and which functionality needs to be explained in more detail are welcome.

MDL Tweaker II is a tool that allows you to alter MDL scenery objects, without having to edit the source code yourself. The tool can read the binary MDL file and alter it for you. For example to add additional conditions on the display of the object or to add seasonal textures to it. This manual will describe all the options.

== Installation ==

The installation procedure of MDL Tweaker II depends on the version you have downloaded. If you have downloaded one of the installers, then you only need to run that installer and you are ready to go. If you have chosen to download the ZIP file version, you need to unzip the content of the file to a folder of your choice.

If you have downloaded the ZIP version, please make sure that you register the AgSdLib.dll file correctly with windows. This can be done with the regsvr32 command, but you can also use the batch (BAT) files provided in the ZIP file you downloaded.

To make use of the object preview, you will need to install the latest version of the graphical DLL files by Martin Wright as well. You can get these DLL files from his [http://www.mwgfx.co.uk/ homepage].

If you ever want to uninstall MDL Tweaker II, you can run the uninstall program that is located in your MDL Tweaker II folder. You can also start this uninstaller from the "Add or remove software" section of the control panel. If you used the ZIP file distribution you can just delete the folder you placed the files in.

== The interface ==

The interface of MDL Tweaker II has been designed so that it is easy to use for a novice user who just wants to make a few basic tweaks, but on the other hand it also contains a lot more options for the experienced designer, once you dive a bit deeper into the different forms.

Below you see the main screen of MDL Tweaker II that you see once you have started the tool. Based on the MDL file you load, different options can be available.

[[Image:mt2_main.jpg]]

The buttons on the left give you easy access to some basic tweaks. For the moment these are:

* Remove the shadow (or add it back again)
* Fix the problem that BGL_LIGHT lights do not appear after exporting with the Fs2004 version of MakeMDL
* Add a condition to the display of the object
* Add seasonal textures to the object

The buttons on the right give you access to more detailed forms, that show you all kind of details about the MDL file. At the moment these buttons give you access to:

* The material list, shows all materials applied on the MDL object
* The texture list, shows all textures applied on the MDL object and allows you to add night or seasonal textures
* The vertex list, shows all vertices of the MDL object and allows you to alter them or their normals
* The BGL command list, shows you all the commands that actually draw your object
* Statistics, shows you some stats about your object

=== Object preview ===

Besides the main form, you will also see a preview form when you have started MDL Tweaker II. In this form a preview of your MDL object is shown. You can use the mouse to navigate in this preview, if you keep the left button pressed you can pan the object and if you keep the right button pressed you can rotate the object. To zoom in or out use the slider at the top, the values shown in the tooltip are a percentage. The default zoom value is 100 and that should show your entire object on screen properly.

If the textures do not show up in the preview, MDL Tweaker II can probably not find them. You can specify the search path for the textures in the options.

[[Image:mt2_preview.jpg]]

=== Condition manager ===

The condition manager allows you to add conditions to the display of the total object.

[[Image:mt2_condition.jpg]]

At the moment the following types of conditions are supported:

* Between: The value of the given variable is checked and if it is between the supplied values the object is shown
* Mask: The bitmask of the given variable is checked and if all bits of the supplied value are set the object is shown
* Rotate to user: This will rotate the object around its 0,0 point to the user
* Rotate with wind: This will rotate the object around its 0,0 point with the direction of the wind

[[Image:mt2_condition_type.jpg]]

To add a new condition you first need to press the "New condition" button. After that you can alter the properties of the condition. When you change the condition type, the visibility of the other choices will be updated as needed. If you select multiple Between or Mask conditions, you can choose how they determine the visiblity of the object. See the table below for the options:

* AND: All conditions must be true for the object to display
* OR: One condition must be true for the object to display
* NOT: All conditions must be false for the object to display
* NOR: One condition must be false for the object to display</pre>

You need to press the Apply to object button before the conditions are stored in the MDL object. The next time you load your tweaked MDL object, you will see the conditions in the list again.

[[Image:mt2_condition_added.jpg]]

=== Material list ===

The material list shows all the materials that are applied on your object. You can alter the attributes of these materials and once you press the update material button they are stored in the MDL object again.

[[Image:mt2_material.jpg]]

=== Texture list ===

The texture list shows you all textures that are applied to your object. It gives you the ability to add change their settings or add night or seasonal textures.

The Check texture sizes button makes sure that the texture size as stored in the texture list is updated based on the model. This can be used to correct this size, so that you do not get problems with blurry textures, because the wrong mipmap is displayed.

[[Image:mt2_texture.jpg]]

To add new variants to a texture, you need to select the checkbox next to the season you want. Make sure that you enter the correct days for this season. The values you enter must cover the entire year, there can not be any gaps in the days. To prevent you from keeping to type the values for your location all the time, you can enter the default values in the Options.

You need to press the Update texture button before any changes are stored in the MDL object. Once you do that the texture list will also update. If you click on a texture in the list, any seasonal variant of the same texture will be selected as well. If you want to alter some properties of that texture alone, you need to Alt-click on it.

[[Image:mt2_texture_seasonal.jpg]]

=== Vertex list ===

The vertex list shows all vertices that are being used in your model. This list allows you to tweak the coordinates of these vertices, their normals and their texture mappings. If you have selected different rows in the list (does not matter which column you select), you can use the "Unify normals" button to make sure that the normals of all these vertices are the same. This results in an uniform shading in FS (like the autogen trees have). You can specify the direction of the normal in the options.

[[Image:mt2_vertex.jpg]]

To make it a little easier to select all polygons that belong to a certain part of your object, you can also use the texture dropdown box at the bottom. Choose the texture you want to select there and then press the "Select by texture" button.

[[Image:mt2_vertex_select.jpg]]

To enter the edit mode you need to press Enter and the background color will change to indicate your are editing. After that you can enter the new values you want. Only the number 0 to 9 and the dot are valid characters you can enter.

[[Image:mt2_vertex_edit.jpg]]

=== BGL command list ===

The BGL command list shows all the BGL commands that are defined in the BGL section of your MDL file. Basically these define how your object is actually drawn. At this moment this list only has the purpose to show you these commands (a bit like looking in the ASM source code). In the future editing functionality will be added to this list as well.

[[Image:mt2_bgl.jpg]]

If you click on a command, its parameters are shown in the grid on the right. If the command performs a jump to a certain offset, the destination of that jump will be highlighted in the BGL command list as well.

[[Image:mt2_bgl_jump.jpg]]

=== Object statistics ===

The statistics window gives you an overview of some of the statistics of your object. For example how many vertices and triangles it uses. But also how many textures it has (and how many of these are seasonal and night variants). The number of state changes indicates how often a different material/texture combination is set as the active drawing state.

Besides this information, this form will also show you the bounding box of your object and some of the parameters contained in the header of the MDL object. You can change these, but be aware that this might make the MDL file invalid.

[[Image:mt2_statistics.jpg]]

=== Options ===

The options screen lets you specify a few preferences. These are:

* Seasonal suffixes, you can specify which texture name suffix is used for which season. This information is used when you create new seasonal textures, but also to determine which textures are seasonal variants when you load a MDL file.

* Seasonal days, you can specify at which day of the year the different seasons start for your geographical location. This ensures that you do not have to enter the same information over and over again on the texture list screen. Please make sure that the days of all seasons that you use fit together, there can not be a gap in the days.

* Unify normals direction, you can specify the direction of the normal that is used with the unify normals option on the vertex form. For GMax objects the default values should be correct, but if you are using FSDS3 you might need to change them.

* Texture searchpath, here you specify all folders that will be scanned for the textures of the object preview. The "a" button allows you to add a new path and the "x" button allows you to remove one. With the "r" option you can enter a relative path (relative to your MDL location that is).

* OpenFlight texture format, you can specify the prefered texture format when exporting an object to the OpenFlight format.

[[Image:mt2_options.jpg]]

=== Event log ===

The event log shows you want happened while you were working with your object. You can find messages here showing the tweaks you apply, but also warnings when a texture could not be found. So if you see something weird in the preview, checking the event log is a good thing to do first.

[[Image:mt2_log.jpg]]

=== Menus ===

This section describes all the options that you can find in the different menus.

==== File menu ====

* Open: Open a MDL file from disk.
* Save: Save the MDL file you tweaked to disk. You get the option to choose a name, so that the origional is not overwritten.
* Export:
** BGLC source: Export the MDL object as a BGLC source (ASM) file. This option is not functional yet and only serves debugging purposes at the moment.
** OpenFlight: Export the MDL object as an OpenFlight file, this is a file format often used in professional flight simulators.
* Exit: Closes MDL Tweaker.

==== Tools menu ====

* OpenFlight converter: Open a converter screen, that allows you to batch convert MDL objects to the OpenFlight format.
* BGL browser: Show/hide the BGL browser window. This window allows you to open a library BGL and load the MDL objects contained in there into MDL Tweaker. These objects are opened as read-only.
* Options: Shows the options dialog.

==== Window menu ====

* Object preview: Show/hide the object preview window.
* Material list: Show/hide the material list window.
* Texture list: Show/hide the texture list window.
* Vertex list: Show/hide the vertex list window.
* BGL command list: Show/hide the BGL command list window.
* Statistics: Show/hide the statistics window.
* Event log: Show/hide the event log window.

==== Help menu ====

* Manual: Show the manual (not yet active).
* About: Shows an about screen for MDL Tweaker.

== Support and feedback ==

This is still a beta version of MDL Tweaker II, so I am sure there will be faults and errors in it. So if you found a problem, or if you have comments or suggestions on how to improve this tool, please let me know. You can reach me either by [mailto:arno@scenerydesign.org email] or through the forums of my website [http://www.fsdeveloper.com FsDeveloper.com].

== Wishlist ==

This tool is not yet finished, but it has been released already because a the functionality it already contains will certainly be useful to you already. Here is an overview of some of the things that are on the wishlist for future updates:

* Read translation and animation tables correctly
* Read the crashbox information and display it in the object preview
* Allow interactive editing of the BGL command list
* Allow conditions to be inserted around parts of the object, not only the entire object

== Users license ==

When using MDL Tweaker II you agree to the following user license:

I do hereby agree that I will only use MDL Tweaker II to change objects I have created myself. I will no change the work of others, without their prior written permission. This does include any objects obtained by decompilation of BGL files.

(c) 2005-2006 SceneryDesign.org / Arno Gerretsen

This software program is distributed without charge to other scenery designers, redistribution of the original installer EXE file is allowed. You are NOT allowed to sell this software program or ask money for its distribution. BGL files created with this software program can be used in commercial scenery projects if you wish.

The copyright and any intellectual property relating to this program remain the property of the author.

The software distributed in this way may represent work in progress, and bears no warranty, either expressed or implied.

[[category:Manuals]]
[[Category:FS9_(FS2004)]]
[[Category:Tools]]

Catapult/Arrestor Operations (FSXA)

2010-11-24T04:50:54Z

GaryGB: /* aircraft.cfg - launch-bar */

{{:Ambox-Content-WIP}}
{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = false
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
The FSX Acceleration pack introduces native functionality to simulate aircraft operations for a large flat-decked aircraft carrier.

The catapult launch system is designed to simulate a modern catapult assisted takeoff.
 
IRL it consists of a track built into the flight deck, below which is a large piston or shuttle that is attached through the track to the nose gear of the aircraft.

The landing system is designed to simulate systems to aid the recovery of an aircraft.
 
IRL it consists of a series of cables strung across the landing area which the aircraft hooks on to.

The FSX Acceleration pack includes a preconfigured functioning aircraft carrier model, plus a carrier enabled F/A-18 aircraft.

Includes info missing from the published SDK.

== Configuring ==
To enable the Catapult/Arrestor operations functionality, two seperate aspects must be configured/functioning -
* Aircraft - The launch-bar, (for the catapult), and tailhook, (for the arrestor-cables), located on the aircraft.
* Vessel - The runway, catapult, and arrestor-cables, for the carrier you'll takeoff from, and recover to.

=== Prerequisite ===
The FSX Acceleration key-mapping must also be functioning correctly.
 
Please see [[http://www.fsdeveloper.com/wiki/index.php?title=Key_Mapping_(FSXA) Key Mapping (FSXA)]]

== Configuring (Aircraft) ==

=== fsx.CFG ===
In the '''[Realism]''' section.
 
Add/edit to enable -
* '''CatapultForceLimiter=1''' - Only fighter type aircraft can be catapulted.
* '''CatapultForceLimiter=0''' - Any type of aircraft can be catapulted.
TODO - Find/add info how FSX discriminates between fighter and non-fighter aircraft.

=== Catapult Assist (Aircraft) ===
To ''launch'' an aircraft, a '''launch bar''' is lowered to engage the catapult system.

Add a launch bar to an aircraft, by either -
* defining a '''[launch_assistance]''' entry in the aircraft configuration file.
* setting the '''attachpt_Launch_Bar_Pivot''' and '''attachpt_Launch_Bar_Lug''' attach points in the model,
'''An entry in the configuration file will override the model's attach points, if they exist.'''

==== aircraft.cfg - launch-bar ====
Works for any aircraft.

Add a section titled '''[launch_assistance]'''
 
with the following parameters and values -
 
'''launch_bar_pivot''' = Launch bar pivot point, relative to datum reference point.
 
'''launch_bar_lug''' = Launch bar lug point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[launch_assistance]
launch_bar_pivot = 5.0, 0.0, -1.0
launch_bar_lug = 5.0, 0.0, -4.5</pre>

'''Marker States''' - A tool to aid positioning, see:

[http://lc0277.gratisim.frAdapting_SX_aircrafts_to_acceleration_carriers.htmlAdapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - launch-bar ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

=== Arrestor Cables (Aircraft) ===
To ''trap'' an aircraft, a '''tailhook''' is lowered to catch an arrestor cable.

Add a tailhook to an aircraft, by either -
* defining a '''[tailhook]''' entry in the aircraft configuration file.
* setting the '''attachpt_tailhook_pivot''' and '''attachpt_tailhook_hook''' attach points in the model.
'''An entry in the configuration file will override the attach points, if they exist.'''

==== aircraft.cfg - Tailhook ====
Works for any aircraft.

Add a section titled '''[tailhook]'''
 
with the following parameters and values -
 
'''tailhook_length''' = Length of tailhook in feet.
 
'''tailhook_position''' = Tailhook pivot point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[tailhook]
tailhook_length = 4.5
tailhook_position = -49.0, 0, -2.5</pre>

'''Marker States''' - A tool to aid positioning, see:

[http://lc0277.gratisim.frAdapting_SX_aircrafts_to_acceleration_carriers.htmlAdapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - Tailhook ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

== Configuring (Vessel) ==
To specify that a ship has one or more catapults, runway, and arrestor cables,
 
'''the appropriate ''Attach Points'' need to be added to the vessel ''model'''''.

These features can only be implemented by editing the model's source code.

'''Note'''
 
The attach points for carrier operations are '''not included''' in the list of options in the attach point tool.
 
These need to be manually entered as an ''empty attach point''.

The actual code used can be checked in Object Properties/User Defined to ensure there have been no syntax errors.
 
See [http://www.fsdeveloper.com/forum/showpost.php?p=59688&postcount=7] for further details.

For pre-existing models, you'd have to use addon systems,
 e.g.

[http://www.flightsim.com/kdl.php?fid=84303Rob Barendregt's - FS2004 Carrier Operation Package V2.0]

[http://library.avsim.net/esearch.php?CatID=fsxgau&DLID=98408Rob Barendregt's - FSX Carrier Operation Package V3.0].

=== Takeoff Components ===

==== Catapult Assist (Vessel) ====
A maximum of four operational catapults and blast shields is supported.

For each catapult required, add an -
* attachpt_catapult_start_n
* attachpt_catapult_end_n
* attachpt_blast_shield_n
Where '''n''' is the index# between 1 and 4 identifying the catapult and matching blast shield.

The ''start position'' is the point where the aircraft should connect its ''launch bar''.
 
The ''blast shield point'' should be the center hinge of the shield.

=== Landing Components ===

==== Runway (Vessel) ====
The area where an aircraft lands.
 
'''A carrier can only have one runway'''.

Add the following -
* attachpt_runway_start
* attachpt_runway_end
* attachpt_runway_edge attach point
The '''attachpt_runway_edge''' point defines the half-width of the runway,
 
and should be to starboard of '''attachpt_runway_start'''.

This will activate the 'Meatball' glideslope indicator on the left hand side of the defined area.
 
It is not required for a working carrier if the US style 'Meatball' is inappropriate.

==== Arrestor Cables (Vessel) ====
A maximum of four operational arrestor cables is supported.

For each arrestor cable required, add a '''pair''' of -
* attachpt_cable_n_1
* attachpt_cable_n_2
Where '''n''' is the index# between 1 and 4 identifying the arrestor cable.

==== Optical Landing System (OLS) (Vessel) ====
The OLS indicates the glidepath information to pilots in the terminal phase of landing on an aircraft carrier.

The OLS is automatically placed on the left hand side of the area defined as the runway (see above).
 
It is not possible to configure the OLS for anything other than the default glideslope, or to alter the style and configuration of the lights.

== Operating ==
TODO - Add/edit/split instructions for testing & operating.

=== Takeoff ===
Use one of the KEY_TOGGLE_LAUNCH_BAR_SWITCH or KEY_SET_LAUNCHBAR_SWITCH key events to drop the launch bar from the nose of the aircraft.

This is an animated feature of the F-18, and the launch bar should be visible.

The aircraft should be moved into position on the catapult,
and then one of the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events should be used
to attach the launch bar to the bogie of the catapult, (not modeled/animated).

* If the aircraft is not in the correct location, the connection will not be made.
* If all goes well, the connection will be made, and the blast shield will be raised.

The KEY_TAKEOFF_ASSIST_FIRE event key is used to fire the catapult.
The user cannot control the position of the aircraft until the aircraft clears the deck.

If for any reason the assist arm is unset,
again using the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events,
then the blast shield will also be retracted.

The aircraft can then be moved away from the catapult.

=== Landing ===
Use one of the KEY_SET_TAIL_HOOK_HANDLE or KEY_TOGGLE_TAIL_HOOK_HANDLE key events, or the TAILHOOK POSITION simulation variable, to set the tail hook in position.

Land on the appropriate spot on the carrier.

There are typically four arrestor cables.
* If the aircraft does not land with excessive speed, it will be brought to a halt and pulled back a short distance.
* If it does land with excessive speed the cables will not prevent the aircraft going off the deck.
* Cable breaks are not simulated.
The aircraft can be parked on deck, perhaps using the KEY_TOGGLE_WING_FOLD or KEY_SET_WING_FOLD key events to fold the wings.

== Related ==
=== Internal ===
{{Template:Navbox-SDK (FSX)-Related}}

=== External ===
Credits -
* [http://paul-flightsimguy.spaces.live.com/blog/cns!D282374D24B565FB!264.entry Paul Lange's blog - Launch Bars and Carriers]
* [http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

[[Category:Aircraft Design]]
[[Category:Missions]]
[[Category:SimConnect]]

Catapult/Arrestor Operations (FSXA)

2010-11-24T04:50:12Z

GaryGB: /* aircraft.cfg - Tailhook */

{{:Ambox-Content-WIP}}
{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = false
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
The FSX Acceleration pack introduces native functionality to simulate aircraft operations for a large flat-decked aircraft carrier.

The catapult launch system is designed to simulate a modern catapult assisted takeoff.
 
IRL it consists of a track built into the flight deck, below which is a large piston or shuttle that is attached through the track to the nose gear of the aircraft.

The landing system is designed to simulate systems to aid the recovery of an aircraft.
 
IRL it consists of a series of cables strung across the landing area which the aircraft hooks on to.

The FSX Acceleration pack includes a preconfigured functioning aircraft carrier model, plus a carrier enabled F/A-18 aircraft.

Includes info missing from the published SDK.

== Configuring ==
To enable the Catapult/Arrestor operations functionality, two seperate aspects must be configured/functioning -
* Aircraft - The launch-bar, (for the catapult), and tailhook, (for the arrestor-cables), located on the aircraft.
* Vessel - The runway, catapult, and arrestor-cables, for the carrier you'll takeoff from, and recover to.

=== Prerequisite ===
The FSX Acceleration key-mapping must also be functioning correctly.
 
Please see [[http://www.fsdeveloper.com/wiki/index.php?title=Key_Mapping_(FSXA) Key Mapping (FSXA)]]

== Configuring (Aircraft) ==

=== fsx.CFG ===
In the '''[Realism]''' section.
 
Add/edit to enable -
* '''CatapultForceLimiter=1''' - Only fighter type aircraft can be catapulted.
* '''CatapultForceLimiter=0''' - Any type of aircraft can be catapulted.
TODO - Find/add info how FSX discriminates between fighter and non-fighter aircraft.

=== Catapult Assist (Aircraft) ===
To ''launch'' an aircraft, a '''launch bar''' is lowered to engage the catapult system.

Add a launch bar to an aircraft, by either -
* defining a '''[launch_assistance]''' entry in the aircraft configuration file.
* setting the '''attachpt_Launch_Bar_Pivot''' and '''attachpt_Launch_Bar_Lug''' attach points in the model,
'''An entry in the configuration file will override the model's attach points, if they exist.'''

==== aircraft.cfg - launch-bar ====
Works for any aircraft.

Add a section titled '''[launch_assistance]'''
 
with the following parameters and values -
 
'''launch_bar_pivot''' = Launch bar pivot point, relative to datum reference point.
 
'''launch_bar_lug''' = Launch bar lug point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[launch_assistance]
launch_bar_pivot = 5.0, 0.0, -1.0
launch_bar_lug = 5.0, 0.0, -4.5</pre>

'''Marker States''' - A tool to aid positioning, see:

[http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - launch-bar ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

=== Arrestor Cables (Aircraft) ===
To ''trap'' an aircraft, a '''tailhook''' is lowered to catch an arrestor cable.

Add a tailhook to an aircraft, by either -
* defining a '''[tailhook]''' entry in the aircraft configuration file.
* setting the '''attachpt_tailhook_pivot''' and '''attachpt_tailhook_hook''' attach points in the model.
'''An entry in the configuration file will override the attach points, if they exist.'''

==== aircraft.cfg - Tailhook ====
Works for any aircraft.

Add a section titled '''[tailhook]'''
 
with the following parameters and values -
 
'''tailhook_length''' = Length of tailhook in feet.
 
'''tailhook_position''' = Tailhook pivot point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[tailhook]
tailhook_length = 4.5
tailhook_position = -49.0, 0, -2.5</pre>

'''Marker States''' - A tool to aid positioning, see:

[http://lc0277.gratisim.frAdapting_SX_aircrafts_to_acceleration_carriers.htmlAdapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - Tailhook ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

== Configuring (Vessel) ==
To specify that a ship has one or more catapults, runway, and arrestor cables,
 
'''the appropriate ''Attach Points'' need to be added to the vessel ''model'''''.

These features can only be implemented by editing the model's source code.

'''Note'''
 
The attach points for carrier operations are '''not included''' in the list of options in the attach point tool.
 
These need to be manually entered as an ''empty attach point''.

The actual code used can be checked in Object Properties/User Defined to ensure there have been no syntax errors.
 
See [http://www.fsdeveloper.com/forum/showpost.php?p=59688&postcount=7] for further details.

For pre-existing models, you'd have to use addon systems,
 e.g.

[http://www.flightsim.com/kdl.php?fid=84303Rob Barendregt's - FS2004 Carrier Operation Package V2.0]

[http://library.avsim.net/esearch.php?CatID=fsxgau&DLID=98408Rob Barendregt's - FSX Carrier Operation Package V3.0].

=== Takeoff Components ===

==== Catapult Assist (Vessel) ====
A maximum of four operational catapults and blast shields is supported.

For each catapult required, add an -
* attachpt_catapult_start_n
* attachpt_catapult_end_n
* attachpt_blast_shield_n
Where '''n''' is the index# between 1 and 4 identifying the catapult and matching blast shield.

The ''start position'' is the point where the aircraft should connect its ''launch bar''.
 
The ''blast shield point'' should be the center hinge of the shield.

=== Landing Components ===

==== Runway (Vessel) ====
The area where an aircraft lands.
 
'''A carrier can only have one runway'''.

Add the following -
* attachpt_runway_start
* attachpt_runway_end
* attachpt_runway_edge attach point
The '''attachpt_runway_edge''' point defines the half-width of the runway,
 
and should be to starboard of '''attachpt_runway_start'''.

This will activate the 'Meatball' glideslope indicator on the left hand side of the defined area.
 
It is not required for a working carrier if the US style 'Meatball' is inappropriate.

==== Arrestor Cables (Vessel) ====
A maximum of four operational arrestor cables is supported.

For each arrestor cable required, add a '''pair''' of -
* attachpt_cable_n_1
* attachpt_cable_n_2
Where '''n''' is the index# between 1 and 4 identifying the arrestor cable.

==== Optical Landing System (OLS) (Vessel) ====
The OLS indicates the glidepath information to pilots in the terminal phase of landing on an aircraft carrier.

The OLS is automatically placed on the left hand side of the area defined as the runway (see above).
 
It is not possible to configure the OLS for anything other than the default glideslope, or to alter the style and configuration of the lights.

== Operating ==
TODO - Add/edit/split instructions for testing & operating.

=== Takeoff ===
Use one of the KEY_TOGGLE_LAUNCH_BAR_SWITCH or KEY_SET_LAUNCHBAR_SWITCH key events to drop the launch bar from the nose of the aircraft.

This is an animated feature of the F-18, and the launch bar should be visible.

The aircraft should be moved into position on the catapult,
and then one of the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events should be used
to attach the launch bar to the bogie of the catapult, (not modeled/animated).

* If the aircraft is not in the correct location, the connection will not be made.
* If all goes well, the connection will be made, and the blast shield will be raised.

The KEY_TAKEOFF_ASSIST_FIRE event key is used to fire the catapult.
The user cannot control the position of the aircraft until the aircraft clears the deck.

If for any reason the assist arm is unset,
again using the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events,
then the blast shield will also be retracted.

The aircraft can then be moved away from the catapult.

=== Landing ===
Use one of the KEY_SET_TAIL_HOOK_HANDLE or KEY_TOGGLE_TAIL_HOOK_HANDLE key events, or the TAILHOOK POSITION simulation variable, to set the tail hook in position.

Land on the appropriate spot on the carrier.

There are typically four arrestor cables.
* If the aircraft does not land with excessive speed, it will be brought to a halt and pulled back a short distance.
* If it does land with excessive speed the cables will not prevent the aircraft going off the deck.
* Cable breaks are not simulated.
The aircraft can be parked on deck, perhaps using the KEY_TOGGLE_WING_FOLD or KEY_SET_WING_FOLD key events to fold the wings.

== Related ==
=== Internal ===
{{Template:Navbox-SDK (FSX)-Related}}

=== External ===
Credits -
* [http://paul-flightsimguy.spaces.live.com/blog/cns!D282374D24B565FB!264.entry Paul Lange's blog - Launch Bars and Carriers]
* [http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

[[Category:Aircraft Design]]
[[Category:Missions]]
[[Category:SimConnect]]

Catapult/Arrestor Operations (FSXA)

2010-11-24T04:48:52Z

GaryGB: /* aircraft.cfg - launch-bar */

{{:Ambox-Content-WIP}}
{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = false
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
The FSX Acceleration pack introduces native functionality to simulate aircraft operations for a large flat-decked aircraft carrier.

The catapult launch system is designed to simulate a modern catapult assisted takeoff.
 
IRL it consists of a track built into the flight deck, below which is a large piston or shuttle that is attached through the track to the nose gear of the aircraft.

The landing system is designed to simulate systems to aid the recovery of an aircraft.
 
IRL it consists of a series of cables strung across the landing area which the aircraft hooks on to.

The FSX Acceleration pack includes a preconfigured functioning aircraft carrier model, plus a carrier enabled F/A-18 aircraft.

Includes info missing from the published SDK.

== Configuring ==
To enable the Catapult/Arrestor operations functionality, two seperate aspects must be configured/functioning -
* Aircraft - The launch-bar, (for the catapult), and tailhook, (for the arrestor-cables), located on the aircraft.
* Vessel - The runway, catapult, and arrestor-cables, for the carrier you'll takeoff from, and recover to.

=== Prerequisite ===
The FSX Acceleration key-mapping must also be functioning correctly.
 
Please see [[http://www.fsdeveloper.com/wiki/index.php?title=Key_Mapping_(FSXA) Key Mapping (FSXA)]]

== Configuring (Aircraft) ==

=== fsx.CFG ===
In the '''[Realism]''' section.
 
Add/edit to enable -
* '''CatapultForceLimiter=1''' - Only fighter type aircraft can be catapulted.
* '''CatapultForceLimiter=0''' - Any type of aircraft can be catapulted.
TODO - Find/add info how FSX discriminates between fighter and non-fighter aircraft.

=== Catapult Assist (Aircraft) ===
To ''launch'' an aircraft, a '''launch bar''' is lowered to engage the catapult system.

Add a launch bar to an aircraft, by either -
* defining a '''[launch_assistance]''' entry in the aircraft configuration file.
* setting the '''attachpt_Launch_Bar_Pivot''' and '''attachpt_Launch_Bar_Lug''' attach points in the model,
'''An entry in the configuration file will override the model's attach points, if they exist.'''

==== aircraft.cfg - launch-bar ====
Works for any aircraft.

Add a section titled '''[launch_assistance]'''
 
with the following parameters and values -
 
'''launch_bar_pivot''' = Launch bar pivot point, relative to datum reference point.
 
'''launch_bar_lug''' = Launch bar lug point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[launch_assistance]
launch_bar_pivot = 5.0, 0.0, -1.0
launch_bar_lug = 5.0, 0.0, -4.5</pre>

'''Marker States''' - A tool to aid positioning, see:

[http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - launch-bar ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

=== Arrestor Cables (Aircraft) ===
To ''trap'' an aircraft, a '''tailhook''' is lowered to catch an arrestor cable.

Add a tailhook to an aircraft, by either -
* defining a '''[tailhook]''' entry in the aircraft configuration file.
* setting the '''attachpt_tailhook_pivot''' and '''attachpt_tailhook_hook''' attach points in the model.
'''An entry in the configuration file will override the attach points, if they exist.'''

==== aircraft.cfg - Tailhook ====
Works for any aircraft.

Add a section titled '''[tailhook]'''
 
with the following parameters and values -
 
'''tailhook_length''' = Length of tailhook in feet.
 
'''tailhook_position''' = Tailhook pivot point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[tailhook]
tailhook_length = 4.5
tailhook_position = -49.0, 0, -2.5</pre>

'''Marker States''' - A tool to aid positioning, see [http://lc0277.gratisim.fr/Adapting_SX_aircrafts_to_acceleration_carriers.htmlAdapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - Tailhook ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

== Configuring (Vessel) ==
To specify that a ship has one or more catapults, runway, and arrestor cables,
 
'''the appropriate ''Attach Points'' need to be added to the vessel ''model'''''.

These features can only be implemented by editing the model's source code.

'''Note'''
 
The attach points for carrier operations are '''not included''' in the list of options in the attach point tool.
 
These need to be manually entered as an ''empty attach point''.

The actual code used can be checked in Object Properties/User Defined to ensure there have been no syntax errors.
 
See [http://www.fsdeveloper.com/forum/showpost.php?p=59688&postcount=7] for further details.

For pre-existing models, you'd have to use addon systems,
 e.g.

[http://www.flightsim.com/kdl.php?fid=84303Rob Barendregt's - FS2004 Carrier Operation Package V2.0]

[http://library.avsim.net/esearch.php?CatID=fsxgau&DLID=98408Rob Barendregt's - FSX Carrier Operation Package V3.0].

=== Takeoff Components ===

==== Catapult Assist (Vessel) ====
A maximum of four operational catapults and blast shields is supported.

For each catapult required, add an -
* attachpt_catapult_start_n
* attachpt_catapult_end_n
* attachpt_blast_shield_n
Where '''n''' is the index# between 1 and 4 identifying the catapult and matching blast shield.

The ''start position'' is the point where the aircraft should connect its ''launch bar''.
 
The ''blast shield point'' should be the center hinge of the shield.

=== Landing Components ===

==== Runway (Vessel) ====
The area where an aircraft lands.
 
'''A carrier can only have one runway'''.

Add the following -
* attachpt_runway_start
* attachpt_runway_end
* attachpt_runway_edge attach point
The '''attachpt_runway_edge''' point defines the half-width of the runway,
 
and should be to starboard of '''attachpt_runway_start'''.

This will activate the 'Meatball' glideslope indicator on the left hand side of the defined area.
 
It is not required for a working carrier if the US style 'Meatball' is inappropriate.

==== Arrestor Cables (Vessel) ====
A maximum of four operational arrestor cables is supported.

For each arrestor cable required, add a '''pair''' of -
* attachpt_cable_n_1
* attachpt_cable_n_2
Where '''n''' is the index# between 1 and 4 identifying the arrestor cable.

==== Optical Landing System (OLS) (Vessel) ====
The OLS indicates the glidepath information to pilots in the terminal phase of landing on an aircraft carrier.

The OLS is automatically placed on the left hand side of the area defined as the runway (see above).
 
It is not possible to configure the OLS for anything other than the default glideslope, or to alter the style and configuration of the lights.

== Operating ==
TODO - Add/edit/split instructions for testing & operating.

=== Takeoff ===
Use one of the KEY_TOGGLE_LAUNCH_BAR_SWITCH or KEY_SET_LAUNCHBAR_SWITCH key events to drop the launch bar from the nose of the aircraft.

This is an animated feature of the F-18, and the launch bar should be visible.

The aircraft should be moved into position on the catapult,
and then one of the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events should be used
to attach the launch bar to the bogie of the catapult, (not modeled/animated).

* If the aircraft is not in the correct location, the connection will not be made.
* If all goes well, the connection will be made, and the blast shield will be raised.

The KEY_TAKEOFF_ASSIST_FIRE event key is used to fire the catapult.
The user cannot control the position of the aircraft until the aircraft clears the deck.

If for any reason the assist arm is unset,
again using the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events,
then the blast shield will also be retracted.

The aircraft can then be moved away from the catapult.

=== Landing ===
Use one of the KEY_SET_TAIL_HOOK_HANDLE or KEY_TOGGLE_TAIL_HOOK_HANDLE key events, or the TAILHOOK POSITION simulation variable, to set the tail hook in position.

Land on the appropriate spot on the carrier.

There are typically four arrestor cables.
* If the aircraft does not land with excessive speed, it will be brought to a halt and pulled back a short distance.
* If it does land with excessive speed the cables will not prevent the aircraft going off the deck.
* Cable breaks are not simulated.
The aircraft can be parked on deck, perhaps using the KEY_TOGGLE_WING_FOLD or KEY_SET_WING_FOLD key events to fold the wings.

== Related ==
=== Internal ===
{{Template:Navbox-SDK (FSX)-Related}}

=== External ===
Credits -
* [http://paul-flightsimguy.spaces.live.com/blog/cns!D282374D24B565FB!264.entry Paul Lange's blog - Launch Bars and Carriers]
* [http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

[[Category:Aircraft Design]]
[[Category:Missions]]
[[Category:SimConnect]]

Catapult/Arrestor Operations (FSXA)

2010-11-24T04:48:06Z

GaryGB: /* Configuring (Vessel) */

{{:Ambox-Content-WIP}}
{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = false
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
The FSX Acceleration pack introduces native functionality to simulate aircraft operations for a large flat-decked aircraft carrier.

The catapult launch system is designed to simulate a modern catapult assisted takeoff.
 
IRL it consists of a track built into the flight deck, below which is a large piston or shuttle that is attached through the track to the nose gear of the aircraft.

The landing system is designed to simulate systems to aid the recovery of an aircraft.
 
IRL it consists of a series of cables strung across the landing area which the aircraft hooks on to.

The FSX Acceleration pack includes a preconfigured functioning aircraft carrier model, plus a carrier enabled F/A-18 aircraft.

Includes info missing from the published SDK.

== Configuring ==
To enable the Catapult/Arrestor operations functionality, two seperate aspects must be configured/functioning -
* Aircraft - The launch-bar, (for the catapult), and tailhook, (for the arrestor-cables), located on the aircraft.
* Vessel - The runway, catapult, and arrestor-cables, for the carrier you'll takeoff from, and recover to.

=== Prerequisite ===
The FSX Acceleration key-mapping must also be functioning correctly.
 
Please see [[http://www.fsdeveloper.com/wiki/index.php?title=Key_Mapping_(FSXA) Key Mapping (FSXA)]]

== Configuring (Aircraft) ==

=== fsx.CFG ===
In the '''[Realism]''' section.
 
Add/edit to enable -
* '''CatapultForceLimiter=1''' - Only fighter type aircraft can be catapulted.
* '''CatapultForceLimiter=0''' - Any type of aircraft can be catapulted.
TODO - Find/add info how FSX discriminates between fighter and non-fighter aircraft.

=== Catapult Assist (Aircraft) ===
To ''launch'' an aircraft, a '''launch bar''' is lowered to engage the catapult system.

Add a launch bar to an aircraft, by either -
* defining a '''[launch_assistance]''' entry in the aircraft configuration file.
* setting the '''attachpt_Launch_Bar_Pivot''' and '''attachpt_Launch_Bar_Lug''' attach points in the model,
'''An entry in the configuration file will override the model's attach points, if they exist.'''

==== aircraft.cfg - launch-bar ====
Works for any aircraft.

Add a section titled '''[launch_assistance]'''
 
with the following parameters and values -
 
'''launch_bar_pivot''' = Launch bar pivot point, relative to datum reference point.
 
'''launch_bar_lug''' = Launch bar lug point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[launch_assistance]
launch_bar_pivot = 5.0, 0.0, -1.0
launch_bar_lug = 5.0, 0.0, -4.5</pre>

'''Marker States''' - A tool to aid positioning, see [http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - launch-bar ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

=== Arrestor Cables (Aircraft) ===
To ''trap'' an aircraft, a '''tailhook''' is lowered to catch an arrestor cable.

Add a tailhook to an aircraft, by either -
* defining a '''[tailhook]''' entry in the aircraft configuration file.
* setting the '''attachpt_tailhook_pivot''' and '''attachpt_tailhook_hook''' attach points in the model.
'''An entry in the configuration file will override the attach points, if they exist.'''

==== aircraft.cfg - Tailhook ====
Works for any aircraft.

Add a section titled '''[tailhook]'''
 
with the following parameters and values -
 
'''tailhook_length''' = Length of tailhook in feet.
 
'''tailhook_position''' = Tailhook pivot point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[tailhook]
tailhook_length = 4.5
tailhook_position = -49.0, 0, -2.5</pre>

'''Marker States''' - A tool to aid positioning, see [http://lc0277.gratisim.fr/Adapting_SX_aircrafts_to_acceleration_carriers.htmlAdapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - Tailhook ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

== Configuring (Vessel) ==
To specify that a ship has one or more catapults, runway, and arrestor cables,
 
'''the appropriate ''Attach Points'' need to be added to the vessel ''model'''''.

These features can only be implemented by editing the model's source code.

'''Note'''
 
The attach points for carrier operations are '''not included''' in the list of options in the attach point tool.
 
These need to be manually entered as an ''empty attach point''.

The actual code used can be checked in Object Properties/User Defined to ensure there have been no syntax errors.
 
See [http://www.fsdeveloper.com/forum/showpost.php?p=59688&postcount=7] for further details.

For pre-existing models, you'd have to use addon systems,
 e.g.

[http://www.flightsim.com/kdl.php?fid=84303Rob Barendregt's - FS2004 Carrier Operation Package V2.0]

[http://library.avsim.net/esearch.php?CatID=fsxgau&DLID=98408Rob Barendregt's - FSX Carrier Operation Package V3.0].

=== Takeoff Components ===

==== Catapult Assist (Vessel) ====
A maximum of four operational catapults and blast shields is supported.

For each catapult required, add an -
* attachpt_catapult_start_n
* attachpt_catapult_end_n
* attachpt_blast_shield_n
Where '''n''' is the index# between 1 and 4 identifying the catapult and matching blast shield.

The ''start position'' is the point where the aircraft should connect its ''launch bar''.
 
The ''blast shield point'' should be the center hinge of the shield.

=== Landing Components ===

==== Runway (Vessel) ====
The area where an aircraft lands.
 
'''A carrier can only have one runway'''.

Add the following -
* attachpt_runway_start
* attachpt_runway_end
* attachpt_runway_edge attach point
The '''attachpt_runway_edge''' point defines the half-width of the runway,
 
and should be to starboard of '''attachpt_runway_start'''.

This will activate the 'Meatball' glideslope indicator on the left hand side of the defined area.
 
It is not required for a working carrier if the US style 'Meatball' is inappropriate.

==== Arrestor Cables (Vessel) ====
A maximum of four operational arrestor cables is supported.

For each arrestor cable required, add a '''pair''' of -
* attachpt_cable_n_1
* attachpt_cable_n_2
Where '''n''' is the index# between 1 and 4 identifying the arrestor cable.

==== Optical Landing System (OLS) (Vessel) ====
The OLS indicates the glidepath information to pilots in the terminal phase of landing on an aircraft carrier.

The OLS is automatically placed on the left hand side of the area defined as the runway (see above).
 
It is not possible to configure the OLS for anything other than the default glideslope, or to alter the style and configuration of the lights.

== Operating ==
TODO - Add/edit/split instructions for testing & operating.

=== Takeoff ===
Use one of the KEY_TOGGLE_LAUNCH_BAR_SWITCH or KEY_SET_LAUNCHBAR_SWITCH key events to drop the launch bar from the nose of the aircraft.

This is an animated feature of the F-18, and the launch bar should be visible.

The aircraft should be moved into position on the catapult,
and then one of the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events should be used
to attach the launch bar to the bogie of the catapult, (not modeled/animated).

* If the aircraft is not in the correct location, the connection will not be made.
* If all goes well, the connection will be made, and the blast shield will be raised.

The KEY_TAKEOFF_ASSIST_FIRE event key is used to fire the catapult.
The user cannot control the position of the aircraft until the aircraft clears the deck.

If for any reason the assist arm is unset,
again using the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events,
then the blast shield will also be retracted.

The aircraft can then be moved away from the catapult.

=== Landing ===
Use one of the KEY_SET_TAIL_HOOK_HANDLE or KEY_TOGGLE_TAIL_HOOK_HANDLE key events, or the TAILHOOK POSITION simulation variable, to set the tail hook in position.

Land on the appropriate spot on the carrier.

There are typically four arrestor cables.
* If the aircraft does not land with excessive speed, it will be brought to a halt and pulled back a short distance.
* If it does land with excessive speed the cables will not prevent the aircraft going off the deck.
* Cable breaks are not simulated.
The aircraft can be parked on deck, perhaps using the KEY_TOGGLE_WING_FOLD or KEY_SET_WING_FOLD key events to fold the wings.

== Related ==
=== Internal ===
{{Template:Navbox-SDK (FSX)-Related}}

=== External ===
Credits -
* [http://paul-flightsimguy.spaces.live.com/blog/cns!D282374D24B565FB!264.entry Paul Lange's blog - Launch Bars and Carriers]
* [http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

[[Category:Aircraft Design]]
[[Category:Missions]]
[[Category:SimConnect]]

Catapult/Arrestor Operations (FSXA)

2010-11-24T04:32:48Z

GaryGB: /* aircraft.cfg - Tailhook */

{{:Ambox-Content-WIP}}
{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = false
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
The FSX Acceleration pack introduces native functionality to simulate aircraft operations for a large flat-decked aircraft carrier.

The catapult launch system is designed to simulate a modern catapult assisted takeoff.
 
IRL it consists of a track built into the flight deck, below which is a large piston or shuttle that is attached through the track to the nose gear of the aircraft.

The landing system is designed to simulate systems to aid the recovery of an aircraft.
 
IRL it consists of a series of cables strung across the landing area which the aircraft hooks on to.

The FSX Acceleration pack includes a preconfigured functioning aircraft carrier model, plus a carrier enabled F/A-18 aircraft.

Includes info missing from the published SDK.

== Configuring ==
To enable the Catapult/Arrestor operations functionality, two seperate aspects must be configured/functioning -
* Aircraft - The launch-bar, (for the catapult), and tailhook, (for the arrestor-cables), located on the aircraft.
* Vessel - The runway, catapult, and arrestor-cables, for the carrier you'll takeoff from, and recover to.

=== Prerequisite ===
The FSX Acceleration key-mapping must also be functioning correctly.
 
Please see [[http://www.fsdeveloper.com/wiki/index.php?title=Key_Mapping_(FSXA) Key Mapping (FSXA)]]

== Configuring (Aircraft) ==

=== fsx.CFG ===
In the '''[Realism]''' section.
 
Add/edit to enable -
* '''CatapultForceLimiter=1''' - Only fighter type aircraft can be catapulted.
* '''CatapultForceLimiter=0''' - Any type of aircraft can be catapulted.
TODO - Find/add info how FSX discriminates between fighter and non-fighter aircraft.

=== Catapult Assist (Aircraft) ===
To ''launch'' an aircraft, a '''launch bar''' is lowered to engage the catapult system.

Add a launch bar to an aircraft, by either -
* defining a '''[launch_assistance]''' entry in the aircraft configuration file.
* setting the '''attachpt_Launch_Bar_Pivot''' and '''attachpt_Launch_Bar_Lug''' attach points in the model,
'''An entry in the configuration file will override the model's attach points, if they exist.'''

==== aircraft.cfg - launch-bar ====
Works for any aircraft.

Add a section titled '''[launch_assistance]'''
 
with the following parameters and values -
 
'''launch_bar_pivot''' = Launch bar pivot point, relative to datum reference point.
 
'''launch_bar_lug''' = Launch bar lug point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[launch_assistance]
launch_bar_pivot = 5.0, 0.0, -1.0
launch_bar_lug = 5.0, 0.0, -4.5</pre>

'''Marker States''' - A tool to aid positioning, see [http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - launch-bar ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

=== Arrestor Cables (Aircraft) ===
To ''trap'' an aircraft, a '''tailhook''' is lowered to catch an arrestor cable.

Add a tailhook to an aircraft, by either -
* defining a '''[tailhook]''' entry in the aircraft configuration file.
* setting the '''attachpt_tailhook_pivot''' and '''attachpt_tailhook_hook''' attach points in the model.
'''An entry in the configuration file will override the attach points, if they exist.'''

==== aircraft.cfg - Tailhook ====
Works for any aircraft.

Add a section titled '''[tailhook]'''
 
with the following parameters and values -
 
'''tailhook_length''' = Length of tailhook in feet.
 
'''tailhook_position''' = Tailhook pivot point, relative to datum reference point.

Example - Boeing F/A-18
<pre>[tailhook]
tailhook_length = 4.5
tailhook_position = -49.0, 0, -2.5</pre>

'''Marker States''' - A tool to aid positioning, see [http://lc0277.gratisim.fr/Adapting_SX_aircrafts_to_acceleration_carriers.htmlAdapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

==== Model - Tailhook ====
Requires the model's source code.

TODO - Add/edit/split instructions for implementation.

== Configuring (Vessel) ==
To specify that a ship has one or more catapults, runway, and arrestor cables,
 
'''the appropriate ''Attach Points'' need to be added to the vessel ''model'''''.

These features can only be implemented by editing the model's source code.

'''Note'''
 
The attach points for carrier operations are '''not included''' in the list of options in the attach point tool.
 
These need to be manually entered as an ''empty attach point''.

The actual code used can be checked in Object Properties/User Defined to ensure there have been no syntax errors.
 
See [http://www.fsdeveloper.com/forum/showpost.php?p=59688&postcount=7] for further details.

For pre-existing models, you'd have to use addon systems,
 
e.g. [http://www.fs-shipyards.org/index.php?ind=downloads&op=section_view&idev=17 Rob Barendregt's - Carrier Operation Package RCBCO].

=== Takeoff Components ===

==== Catapult Assist (Vessel) ====
A maximum of four operational catapults and blast shields is supported.

For each catapult required, add an -
* attachpt_catapult_start_n
* attachpt_catapult_end_n
* attachpt_blast_shield_n
Where '''n''' is the index# between 1 and 4 identifying the catapult and matching blast shield.

The ''start position'' is the point where the aircraft should connect its ''launch bar''.
 
The ''blast shield point'' should be the center hinge of the shield.

=== Landing Components ===

==== Runway (Vessel) ====
The area where an aircraft lands.
 
'''A carrier can only have one runway'''.

Add the following -
* attachpt_runway_start
* attachpt_runway_end
* attachpt_runway_edge attach point
The '''attachpt_runway_edge''' point defines the half-width of the runway,
 
and should be to starboard of '''attachpt_runway_start'''.

This will activate the 'Meatball' glideslope indicator on the left hand side of the defined area.
 
It is not required for a working carrier if the US style 'Meatball' is inappropriate.

==== Arrestor Cables (Vessel) ====
A maximum of four operational arrestor cables is supported.

For each arrestor cable required, add a '''pair''' of -
* attachpt_cable_n_1
* attachpt_cable_n_2
Where '''n''' is the index# between 1 and 4 identifying the arrestor cable.

==== Optical Landing System (OLS) (Vessel) ====
The OLS indicates the glidepath information to pilots in the terminal phase of landing on an aircraft carrier.

The OLS is automatically placed on the left hand side of the area defined as the runway (see above).
 
It is not possible to configure the OLS for anything other than the default glideslope, or to alter the style and configuration of the lights.

== Operating ==
TODO - Add/edit/split instructions for testing & operating.

=== Takeoff ===
Use one of the KEY_TOGGLE_LAUNCH_BAR_SWITCH or KEY_SET_LAUNCHBAR_SWITCH key events to drop the launch bar from the nose of the aircraft.

This is an animated feature of the F-18, and the launch bar should be visible.

The aircraft should be moved into position on the catapult,
and then one of the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events should be used
to attach the launch bar to the bogie of the catapult, (not modeled/animated).

* If the aircraft is not in the correct location, the connection will not be made.
* If all goes well, the connection will be made, and the blast shield will be raised.

The KEY_TAKEOFF_ASSIST_FIRE event key is used to fire the catapult.
The user cannot control the position of the aircraft until the aircraft clears the deck.

If for any reason the assist arm is unset,
again using the KEY_TAKEOFF_ASSIST_ARM_SET or KEY_TAKEOFF_ASSIST_ARM_TOGGLE key events,
then the blast shield will also be retracted.

The aircraft can then be moved away from the catapult.

=== Landing ===
Use one of the KEY_SET_TAIL_HOOK_HANDLE or KEY_TOGGLE_TAIL_HOOK_HANDLE key events, or the TAILHOOK POSITION simulation variable, to set the tail hook in position.

Land on the appropriate spot on the carrier.

There are typically four arrestor cables.
* If the aircraft does not land with excessive speed, it will be brought to a halt and pulled back a short distance.
* If it does land with excessive speed the cables will not prevent the aircraft going off the deck.
* Cable breaks are not simulated.
The aircraft can be parked on deck, perhaps using the KEY_TOGGLE_WING_FOLD or KEY_SET_WING_FOLD key events to fold the wings.

== Related ==
=== Internal ===
{{Template:Navbox-SDK (FSX)-Related}}

=== External ===
Credits -
* [http://paul-flightsimguy.spaces.live.com/blog/cns!D282374D24B565FB!264.entry Paul Lange's blog - Launch Bars and Carriers]
* [http://lc0277.nerim.net/wiki/index.php?Adapting%20FSX%20aircrafts%20to%20acceleration%20carriers Lamont Clarke's wiki - Adapting FSX aircrafts to acceleration carriers]

[[Category:Aircraft Design]]
[[Category:Missions]]
[[Category:SimConnect]]