Map and video

Simulation Instrument Studio 1

map_add

Simulation Instrument Studio 1

Overloads

map_add(x,y,width,height,source,zoom)

A map node. It draws tiles for a lat, lon, and zoom.

Parameters

#	Name	Type	Description
1	x	Number	This is the most left point of the canvas where your map should be shown.
2	y	Number	This is the most top point of the canvas where your map should be shown.
3	width	Number	The map width in pixels.
4	height	Number	The map height in pixels.
5	base_layer	String	The openstreetmap base layer to use. See available base layers below. Use 'nil' if you don't want any base layer at all.
6	zoom	Number	The openstreemap zoom level. This value can normally range from 1 (whole earth) to 16 (closest to earth). This value is dependent on the base layer source type defined above.

Base layers

Tag	Name	Zoom
`OSM_STANDARD`	OpenStreetMap	1–17
`OSM_CYCLE`	Cycle map	1–17
`OSM_TRANSPORT`	Transport map	1–17
`OSM_HUMANITARIAN`	Humanitarian map	1–17

Example

-- Moving map, cycle layer, zoomed to a city
chart = map_add(0, 0, 400, 300, "OSM_CYCLE", 11)

map_add_nav_canvas_layer

Simulation Instrument Studio 1

Overloads

map_add_nav_canvas_layer(map_id, nav_type, x, y, width, height, draw_callback)

A map node. It draws tiles for a lat, lon, and zoom.

Parameters

#	Name	Type	Description
1	map_id	Number	The map_id to add the layer to. A map_id can be fetched by using function map_add.
2	nav_type	String	The NAV type to query, see the NAV types page.
3	x	Number	The x pixel offset of where the canvas should be shown.
4	y	Number	The y pixel offset of where the canvas should be shown.
5	width	Number	The desired width of the canvas.
6	height	Number	The desired height of the canvas.
7	draw_callback	String	This function will be called on a redraw of the canvas.

Example

-- Draw our own range ring on the map
rings = map_add_nav_canvas_layer(chart, function()
    _circle(200, 150, 60)
    _stroke("#7eb6ff", 2)
end)

Photo slot: shots/map_add_nav_canvas_layer.png

map_add_nav_img_layer

Simulation Instrument Studio 1

Overloads

map_add_nav_img_layer(map_id, nav_type, filename, x, y, width, height)

A map node. It draws tiles for a lat, lon, and zoom.

Parameters

#	Name	Type	Description
1	map_id	Number	The map_id to add the layer to. A map_id can be fetched by using function map_add.
2	nav_type	String	The NAV type to show in this layer, see the NAV types page.
3	filename	Number	The filename of the image to show at every NAV point.
4	x	Number	The x pixel offset of where the image should be shown. This is relative to the NAV point itself.
5	y	Number	The y pixel offset of where the image should be shown. This is relative to the NAV point itself.
6	width	Number	The desired width of the image.
7	height	Number	The desired height of the image.

Example

chart = map_add(0, 0, 400, 300, "OSM_STANDARD", 10)
map_goto(chart, 44.88, -93.22)

-- A mark on every airport
airports = map_add_nav_img_layer(chart, "AIRPORT", "airport.png", -8, -8, 16, 16)

Photo slot: shots/map_add_nav_img_layer.png

map_add_nav_txt_layer

Simulation Instrument Studio 1

Overloads

map_add_nav_txt_layer(map_id, nav_type, nav_param, style, x, y, width, height)

A map node. It draws tiles for a lat, lon, and zoom.

Parameters

#	Name	Type	Description
1	map_id	Number	The map_id to add the layer to. A map_id can be fetched by using function map_add.
2	nav_type	String	The NAV type to show in this layer, see the NAV types page.
3	nav_param	String	The NAV param to use. This can be NAME, LONGITUDE or LATITUDE.
4	style	String	The style to use for the text.
5	x	Number	The x pixel offset of where the text should be shown. This is relative to the NAV point itself.
6	y	Number	The y pixel offset of where the text should be shown. This is relative to the NAV point itself.
7	width	Number	The desired width of the textbox.
8	height	Number	The desired height of the textbox.

Example

-- ICAO under each airport mark
labels = map_add_nav_txt_layer(chart, "AIRPORT", "ICAO", "size:11; color:white; halign:center;", -20, 10, 40, 16)

Photo slot: shots/map_add_nav_txt_layer.png

map_baselayer

Simulation Instrument Studio 1

Overloads

map_baselayer(layer_id, source)

A map node. It draws tiles for a lat, lon, and zoom.

Parameters

#	Name	Type	Description
1	layer_id	Number	Map identifier. This number can be obtained by calling map_add.
2	source	String	The openstreetmap base layer to use. See map_add for available base layers.

Example

-- Night flight. Humanitarian is easier to read on a dark panel.
map_baselayer(chart, "OSM_HUMANITARIAN")

map_goto

Simulation Instrument Studio 1

Overloads

map_goto(map_id,lat,lon)

A map node. It draws tiles for a lat, lon, and zoom.

Parameters

#	Name	Type	Description
1	map_id	Number	Map identifier. This number can be obtained by calling map_add.
2	lat	Number	The latitude to move the map to.
3	lon	Number	The longitude to move the map to.

Example

chart = map_add(0, 0, 400, 300, "OSM_STANDARD", 11)

-- Minneapolis
map_goto(chart, 44.9778, -93.2650)

map_nav_canvas_layer_draw

Simulation Instrument Studio 1

Overloads

map_nav_canvas_layer_draw(layer_id)

A map node. It draws tiles for a lat, lon, and zoom.

Parameters

#	Name	Type	Description
1	layer_id	ID	Map nav canvas layer ID. This ID can be obtained by calling function map_add_nav_canvas_layer.

Example

-- Repaint the range ring after a zoom
map_nav_canvas_layer_draw(rings)

Photo slot: shots/map_nav_canvas_layer_draw.png

map_zoom

Simulation Instrument Studio 1

Overloads

map_zoom(map_id,zoom)

A map node. It draws tiles for a lat, lon, and zoom.

Parameters

#	Name	Type	Description
1	map_id	Number	Map identifier. This number can be obtained by calling map_add.
2	zoom	Number	The openstreemap zoom level. This value can normally range from 1 (whole earth) to 16 (closest to earth). This value is dependent on the base layer source type defined above.

Example

-- Close enough to read the runways at KMSP
map_zoom(chart, 13)

video_stream_add

Simulation Instrument Studio 1

Overloads

video_stream_add(key, x, y, width, height)
video_stream_add(key, x, y, width, height, tex_x, tex_y, tex_width, tex_height)

A video node. It shows a stream in the instrument rectangle.

Parameters

#	Name	Type	Description
1	key	String	Video stream key, this key is used to determine which video stream you wish to show. See stream keys below.
2	x	Number	Left point of the canvas where your video stream should be shown.
3	y	Number	Top point of the canvas where your video stream should be shown.
4	width	Number	The video stream width on the canvas.
5	height	Number	The video stream height on the canvas.
6	tex_x	Number	(Optional) Left point of texture viewport.
7	tex_y	Number	(Optional) Top point of texture viewport.
8	tex_width	Number	(Optional) Width of texture viewport.
9	tex_height	Number	(Optional) Height of texture viewport.

Stream keys

Key	Source
`xpl/panel`	X-Plane 12 panel texture.
`xpl/gauges[0]`	Gauges texture 0.
`xpl/gauges[1]`	Gauges texture 1.
`xpl/GNS430_1`	First GNS 430.
`xpl/GNS530_1`	First GNS 530.
`xpl/CDU739_1`	Captain CDU.
`xpl/G1000_PFD_1`	G1000 PFD.

Example

-- X-Plane G1000 PFD, in the bezel we drew
pfd = video_stream_add("xpl/G1000_PFD_1", 12, 12, 400, 300)

Example: a crop of the gauges texture

-- Full PFD
pfd = video_stream_add("xpl/G1000_PFD_1", 12, 12, 400, 300)

-- Only the attitude window inside the gauges texture
attitude = video_stream_add("xpl/gauges[0]", 12, 12, 200, 200, 80, 40, 240, 180)

video_stream_ext_add

Simulation Instrument Studio 1

Overloads

video_stream_ext_add(tag, key, x, y, width, height)
video_stream_ext_add(tag, key, x, y, width, height, tex_x, tex_y, tex_width, tex_height)

A video node. It shows a stream in the instrument rectangle.

Parameters

#	Name	Type	Description
1	tag	String	Video stream source tag. This is the name configured for the stream.
2	key	String	Video stream key, this key is used to determine which video stream you wish to show.
3	x	Number	Left point of the canvas where your video stream should be shown.
4	y	Number	Top point of the canvas where your video stream should be shown.
5	width	Number	The video stream width on the canvas.
6	height	Number	The video stream height on the canvas.
7	tex_x	Number	(Optional) Left point of texture viewport.
8	tex_y	Number	(Optional) Top point of texture viewport.
9	tex_width	Number	(Optional) Width of texture viewport.
10	tex_height	Number	(Optional) Height of texture viewport.

Example

-- A texture the aircraft published
mfd = video_stream_ext_add("G1000", "MFD", 0, 0, 512, 384)

Photo slot: shots/video_stream_ext_add.png

video_stream_set

Simulation Instrument Studio 1

Overloads

video_stream_set(video_stream_id, key)
video_stream_set(video_stream_id, key, tex_x, tex_y, tex_width, tex_height)

A video node. It shows a stream in the instrument rectangle.

Parameters

#	Name	Type	Description
1	key	String	Reference to the video stream. This can be created using video_stream_add function.
2	tex_x	Number	(Optional) Left point of texture viewport.
3	tex_y	Number	(Optional) Top point of texture viewport.
4	tex_width	Number	(Optional) Width of texture viewport.
5	tex_height	Number	(Optional) Height of texture viewport.

Example

-- Crop to the attitude tape, skip the bezel in the texture
video_stream_set(pfd, 40, 20, 320, 240)