LayeredDisplayOutput.java

/*******************************************************************************************************
 *
 * LayeredDisplayOutput.java, in msi.gama.core, is part of the source code of the GAMA modeling and simulation platform
 * (v.1.8.2).
 *
 * (c) 2007-2022 UMI 209 UMMISCO IRD/SU & Partners (IRIT, MIAT, TLU, CTU)
 *
 * Visit https://github.com/gama-platform/gama for license information and contacts.
 *
 ********************************************************************************************************/
package msi.gama.outputs;

import java.awt.image.BufferedImage;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import com.google.common.collect.Iterables;

import msi.gama.common.interfaces.IDisplaySurface;
import msi.gama.common.interfaces.IGamaView;
import msi.gama.common.interfaces.IGamaView.Display;
import msi.gama.common.interfaces.IGamlIssue;
import msi.gama.common.interfaces.IGui;
import msi.gama.common.interfaces.IKeyword;
import msi.gama.common.interfaces.IOverlayProvider;
import msi.gama.common.preferences.GamaPreferences;
import msi.gama.outputs.LayeredDisplayOutput.DisplaySerializer;
import msi.gama.outputs.LayeredDisplayOutput.DisplayValidator;
import msi.gama.outputs.layers.AbstractLayerStatement;
import msi.gama.outputs.layers.ILayerStatement;
import msi.gama.outputs.layers.OverlayStatement;
import msi.gama.outputs.layers.OverlayStatement.OverlayInfo;
import msi.gama.outputs.layers.properties.CameraStatement;
import msi.gama.outputs.layers.properties.LightStatement;
import msi.gama.outputs.layers.properties.RotationStatement;
import msi.gama.precompiler.GamlAnnotations.doc;
import msi.gama.precompiler.GamlAnnotations.example;
import msi.gama.precompiler.GamlAnnotations.facet;
import msi.gama.precompiler.GamlAnnotations.facets;
import msi.gama.precompiler.GamlAnnotations.inside;
import msi.gama.precompiler.GamlAnnotations.symbol;
import msi.gama.precompiler.GamlAnnotations.usage;
import msi.gama.precompiler.IConcept;
import msi.gama.precompiler.ISymbolKind;
import msi.gama.runtime.IScope;
import msi.gama.runtime.exceptions.GamaRuntimeException;
import msi.gaml.compilation.IDescriptionValidator;
import msi.gaml.compilation.ISymbol;
import msi.gaml.compilation.annotations.serializer;
import msi.gaml.compilation.annotations.validator;
import msi.gaml.descriptions.IDescription;
import msi.gaml.descriptions.IExpressionDescription;
import msi.gaml.descriptions.LabelExpressionDescription;
import msi.gaml.descriptions.SymbolDescription;
import msi.gaml.descriptions.SymbolSerializer;
import msi.gaml.expressions.IExpression;
import msi.gaml.expressions.IExpressionFactory;
import msi.gaml.factories.DescriptionFactory;
import msi.gaml.operators.Cast;
import msi.gaml.statements.Facets;
import msi.gaml.types.IType;

/**
 * The Class LayerDisplayOutput.
 *
 * @author drogoul
 */
@symbol (
		name = { IKeyword.DISPLAY },
		kind = ISymbolKind.OUTPUT,
		with_sequence = true,
		concept = { IConcept.DISPLAY })
@facets (
		value = { @facet (
				name = IKeyword.VIRTUAL,
				type = IType.BOOL,
				optional = true,
				doc = @doc ("Declaring a display as virtual makes it invisible on screen, and only usable for display inheritance")),
				@facet (
						name = IKeyword.PARENT,
						type = IType.ID,
						optional = true,
						doc = @doc ("Declares that this display inherits its layers and attributes from the parent display named as the argument. Expects the identifier of the parent display or a string if the name of the parent contains spaces")),
				@facet (
						name = IKeyword.BACKGROUND,
						type = IType.COLOR,
						optional = true,
						doc = @doc ("Allows to fill the background of the display with a specific color")),
				@facet (
						name = IKeyword.NAME,
						type = IType.LABEL,
						optional = false,
						doc = @doc ("the identifier of the display")),
				@facet (
						name = IKeyword.FOCUS,
						type = IType.GEOMETRY,
						optional = true,
						doc = @doc (
								deprecated = "Use 'camera default target: the_agent' to achieve the same effect. And please note that this possibility does not exist on Java2D anymore",
								value = "the geometry (or agent) on which the display will (dynamically) focus")),
				// WARNING VALIDER EN VERIFIANT LE TYPE DU DISPLAY
				@facet (
						name = IKeyword.TYPE,
						type = IType.LABEL,
						optional = true,
						doc = @doc ("Allows to use either Java2D (for planar models) or OpenGL (for 3D models) as the rendering subsystem")),
				@facet (
						name = IKeyword.REFRESH_EVERY,
						type = IType.INT,
						optional = true,
						doc = @doc (
								value = "Allows to refresh the display every n time steps (default is 1)",
								deprecated = "Use refresh: every(n) instead")),
				@facet (
						name = "synchronized",
						type = IType.BOOL,
						optional = true,
						doc = @doc ("Indicates whether the display should be directly synchronized with the simulation")),
				@facet (
						name = "antialias",
						type = IType.BOOL,
						optional = true,
						doc = @doc ("Indicates whether to use advanced antialiasing for the display or not. The default value is the one indicated in the preferences of GAMA ('false' is its factory default). Antialising produces smoother outputs, but comes with a cost in terms of speed and memory used. ")),

				@facet (
						name = IKeyword.REFRESH,
						type = IType.BOOL,
						optional = true,
						doc = @doc ("Indicates the condition under which this output should be refreshed (default is true)")),
				@facet (
						name = IKeyword.TOOLBAR,
						type = { IType.BOOL, IType.COLOR },
						optional = true,
						doc = @doc ("Indicates whether the top toolbar of the display view should be initially visible or not. If a color is passed, then the background of the toolbar takes this color")),
				@facet (
						name = IKeyword.FULLSCREEN,
						type = { IType.BOOL, IType.INT },
						optional = true,
						doc = @doc ("Indicates, when using a boolean value, whether or not the display should cover the whole screen (default is false). If an integer is passed, specifies also the screen to use: 0 for the primary monitor, 1 for the secondary one, and so on and so forth. If the monitor is not available, the first one is used")),

				// @facet (
				// name = IKeyword.ZFIGHTING,
				// internal = true,
				// type = IType.BOOL,
				// optional = true,
				// doc = @doc (
				// deprecated = "now done automatically by default",
				// value = "Allows to alleviate a problem where agents at the same z would overlap each other in random
				// ways")),
				@facet (
						name = IKeyword.SCALE,
						type = { IType.BOOL, IType.FLOAT },
						optional = true,
						doc = @doc (
								value = "Allows to display a scale bar in the overlay. Accepts true/false or an unit name",
								deprecated = "Not functional anymore. Scale is now displayed by default")),
				@facet (
						name = "show_fps",
						internal = true,
						type = IType.BOOL,
						optional = true,
						doc = @doc ("Allows to enable/disable the drawing of the number of frames per second")),
				@facet (
						name = "axes",
						type = IType.BOOL,
						optional = true,
						doc = @doc ("Allows to enable/disable the drawing of the world shape and the ordinate axes. Default can be configured in Preferences")),
				@facet (
						name = "draw_env",
						type = IType.BOOL,
						optional = true,
						doc = @doc (
								deprecated = "Use 'axes' instead",
								value = "Allows to enable/disable the drawing of the world shape and the ordinate axes. Default can be configured in Preferences")),
				@facet (
						name = IKeyword.ORTHOGRAPHIC_PROJECTION,
						internal = true,
						type = IType.BOOL,
						optional = true,
						doc = @doc ("Allows to enable/disable the orthographic projection. Default can be configured in Preferences")),

				/// LIGHT FACETS
				@facet (
						name = "ambient_light",
						type = { IType.INT, IType.COLOR },
						optional = true,
						doc = @doc (
								deprecated = "Define a statement 'light #ambient intensity: ...;' instead",
								value = "Allows to define the value of the ambient light either using an int (ambient_light:(125)) or a rgb color ((ambient_light:rgb(255,255,255)). default is rgb(127,127,127,255)")),
				@facet (
						name = "diffuse_light",
						type = { IType.INT, IType.COLOR },
						optional = true,
						doc = @doc (
								value = "Allows to define the value of the diffuse light either using an int (diffuse_light:(125)) or a rgb color ((diffuse_light:rgb(255,255,255)). default is (127,127,127,255)",
								deprecated = "Use statement \"light\" instead with a #point or #direction light, to define a new light and its intensity")),
				@facet (
						name = "diffuse_light_pos",
						type = IType.POINT,
						optional = true,
						doc = @doc (
								value = "Allows to define the position of the diffuse light either using an point (diffuse_light_pos:{x,y,z}). default is {world.shape.width/2,world.shape.height/2,world.shape.width`*`2}",
								deprecated = "Use statement \"light\" instead")),
				@facet (
						name = IKeyword.IS_LIGHT_ON,
						type = IType.BOOL,
						optional = true,
						doc = @doc ("Allows to enable/disable the light at once. Default is true")),
				@facet (
						name = "draw_diffuse_light",
						type = IType.BOOL,
						optional = true,
						doc = @doc (
								deprecated = "Define it in the various 'light' statements instead with 'show: true/false'",
								value = "Allows to show/hide a representation of the lights. Default is false.")),

				/// CAMERA FACETS
				@facet (
						name = IKeyword.CAMERA,
						type = IType.STRING,
						optional = true,
						doc = @doc ("Allows to define the name of the camera to use. Default value is 'default'. "
								+ "Accepted values are (1) the name of one of the cameras defined using the 'camera' statement or "
								+ "(2) one of the preset cameras, accessible using constants: #from_above, #from_left, #from_right, "
								+ "#from_up_left, #from_up_right, #from_front, #from_up_front, #isometric")),
				@facet (
						name = "camera_pos",
						type = { IType.POINT, IType.AGENT },
						optional = true,
						doc = @doc (
								deprecated = "Define a separate camera instead in the body of the display using the 'camera' statement and attach the 'location:' facet to it",
								value = "Allows to define the position of the camera")),
				@facet (
						name = "camera_location",
						type = { IType.POINT, IType.AGENT },
						optional = true,
						doc = @doc (
								deprecated = "Define a separate camera instead in the body of the display using the 'camera' statement and attach the 'location:' facet to it",
								value = "Allows to define the location of the camera, the origin being the center of the model")),
				@facet (
						name = "camera_target",
						type = IType.POINT,
						optional = true,
						doc = @doc (
								deprecated = "Define a separate camera instead in the body of the display using the 'camera' statement and attach the 'target:' facet to it",
								value = "Allows to define the target of the camera (what does it look at)")),
				@facet (
						name = "camera_look_pos",
						type = IType.POINT,
						optional = true,
						doc = @doc (
								deprecated = "Define a separate camera instead in the body of the display using the 'camera' statement and attach the 'target:' facet to it",
								value = "Allows to define the direction of the camera")),
				@facet (
						name = "camera_orientation",
						type = IType.POINT,
						optional = true,
						doc = @doc (
								deprecated = "This facet is not used anymore. The orientation of the camera is computed automatically by GAMA",
								value = "Allows to define the orientation of the 'up-vector' of the camera")),
				@facet (
						name = "camera_up_vector",
						type = IType.POINT,
						optional = true,
						doc = @doc (
								deprecated = "This facet is not used anymore. The orientation of the camera is computed automatically by GAMA",
								value = "Allows to define the orientation of the 'up-vector' of the camera")),
				@facet (
						name = "camera_lens",
						internal = true,
						type = IType.INT,
						optional = true,
						doc = @doc (
								deprecated = "Define a separate camera instead in the body of the display using the 'camera' statement and attach the 'lens:' facet to it",
								value = "Allows to define the lens of the camera")),
				@facet (
						name = "camera_interaction",
						type = IType.BOOL,
						optional = true,
						doc = @doc (
								deprecated = "Define a separate camera instead in the body of the display using the 'camera' statement and attach the 'locked:' facet to it",
								value = "If false, the user will not be able to modify the position and the orientation of the camera, and neither using the ROI. Default is true.")),

				/// END CAMERA FACETS
				// @facet (
				// name = "use_shader",
				// type = IType.BOOL,
				// optional = true,
				// doc = @doc (
				// value = "Used to invoke the new OpenGL architecture",
				// deprecated = "If the coresponding plugin has been installed, use 'display type: opengl2' instead")),
				@facet (
						name = IKeyword.KEYSTONE,
						type = IType.CONTAINER,
						optional = true,
						doc = @doc ("Set the position of the 4 corners of your screen ([topLeft,topRight,botLeft,botRight]), in (x,y) coordinate ( the (0,0) position is the top left corner, while the (1,1) position is the bottom right corner). The default value is : [{0,0},{1,0},{0,1},{1,1}]")),
				@facet (
						name = IKeyword.ROTATE,
						type = IType.FLOAT,
						optional = true,
						doc = @doc (
								deprecated = "use the 'rotation' statement instead and passe the value to 'angle:' to achieve the same effect",
								value = "Set the angle for the rotation around the Z axis in degrees")),
				@facet (
						name = "z_near",
						type = IType.FLOAT,
						optional = true,
						doc = @doc ("Set the distances to the near depth clipping planes. Must be positive.")),
				@facet (
						name = "z_far",
						type = IType.FLOAT,
						optional = true,
						doc = @doc ("Set the distances to the far depth clipping planes. Must be positive.")),
				@facet (
						name = IKeyword.AUTOSAVE,
						type = { IType.BOOL, IType.POINT, IType.STRING },
						optional = true,
						doc = @doc ("Allows to save this display on disk. This facet accepts bool, point or string values. "
								+ "If it is false or nil, nothing happens. 'true' will save it at a resolution of 500x500 with a standard name "
								+ "(containing the name of the model, display, resolution, cycle and time). A non-nil point will change that resolution. A non-nil string will keep 500x500 and change the filename "
								+ "(if it is not dynamically built, the previous file will be erased). Note that setting autosave to true in a display will synchronize all the displays defined in the experiment")), },
		omissible = IKeyword.NAME)
@inside (
		symbols = { IKeyword.OUTPUT, IKeyword.PERMANENT })
@validator (DisplayValidator.class)
@serializer (DisplaySerializer.class)
@doc (
		value = "A display refers to an independent and mobile part of the interface that can display species, images, texts or charts.",
		usages = { @usage (
				value = "The general syntax is:",
				examples = @example (
						value = "display my_display [additional options] { ... }",
						isExecutable = false)),
				@usage (
						value = "Each display can include different layers (like in a GIS).",
						examples = { @example (
								value = "display gridWithElevationTriangulated type: opengl ambient_light: 100 {",
								isExecutable = false),
								@example (
										value = "	grid cell elevation: true triangulation: true;",
										isExecutable = false),
								@example (
										value = "	species people aspect: base;",
										isExecutable = false),
								@example (
										value = "}",
										isExecutable = false) }) })
public class LayeredDisplayOutput extends AbstractDisplayOutput {

	/** The layers. */
	private final List<AbstractLayerStatement> layers;

	/** The cameras. */
	private final List<CameraStatement> cameras;

	/** The lights. */
	private final List<LightStatement> lights;

	/** The rotation. */
	private RotationStatement rotation;

	/** The surface. */
	protected IDisplaySurface surface;

	/** The index. */
	private int index;

	/** The data. */
	private final LayeredDisplayData data = new LayeredDisplayData();
	// private final ThreadLocal<LayeredDisplayData> data = ThreadLocal.withInitial(LayeredDisplayData::new);
	/** The overlay info. */
	// Specific to overlays
	OverlayStatement overlayInfo;

	/**
	 * The Class DisplaySerializer.
	 */
	public static class DisplaySerializer extends SymbolSerializer<SymbolDescription> {

		/**
		 * Method collectPluginsInFacetValue()
		 *
		 * @see msi.gaml.descriptions.SymbolSerializer#collectPluginsInFacetValue(msi.gaml.descriptions.SymbolDescription,
		 *      java.lang.String, java.util.Set)
		 */
		// @Override
		// protected void collectMetaInformationInFacetValue(final SymbolDescription desc, final String key,
		// final GamlProperties plugins) {
		// super.collectMetaInformationInFacetValue(desc, key, plugins);
		// if (key.equals(TYPE)) {
		// final IExpressionDescription exp = desc.getFacet(TYPE);
		// if (exp.getExpression() != null) {
		// final String type = exp.getExpression().literalValue();
		// final DisplayDescription dd = msi.gama.runtime.GAMA.getGui().getDisplayDescriptionFor(type);
		// if (dd != null) {
		// plugins.put(GamlProperties.PLUGINS, dd.getDefiningPlugin());
		// }
		// }
		// }
		// }

	}

	/**
	 * The Class InfoValidator.
	 */
	public static class DisplayValidator implements IDescriptionValidator<IDescription> {

		/**
		 * Method validate()
		 *
		 * @see msi.gaml.compilation.IDescriptionValidator#validate(msi.gaml.descriptions.IDescription)
		 */
		@Override
		public void validate(final IDescription d) {

			final IExpressionDescription parent = d.getFacet(PARENT);
			if (parent != null) { handleInheritance(d, parent.toString()); }

			final IExpressionDescription auto = d.getFacet(AUTOSAVE);
			if (auto != null && auto.getExpression().isConst() && TRUE.equals(auto.getExpression().literalValue())) {
				d.info("With autosave enabled, GAMA must remain the frontmost window and the display must not be covered or obscured by other windows",
						IGamlIssue.GENERAL, auto.getTarget(), AUTOSAVE);
			}
			// Are we in OpenGL world ?
			final IExpressionDescription type = d.getFacet(TYPE);
			final boolean isOpenGLDefault = !"Java2D".equals(GamaPreferences.Displays.CORE_DISPLAY.getValue());
			if (type != null) {
				// Addresses and fixes Issue 833.
				final String s = type.getExpression().literalValue();
				if (!IGui.DISPLAYS.containsKey(s) && !msi.gama.runtime.GAMA.isInHeadLessMode()) {
					// In headless mode, all displays should be accepted
					d.error(s + " is not a valid display type. Valid types are:" + IGui.DISPLAYS.keySet(),
							IGamlIssue.UNKNOWN_KEYWORD, TYPE);
					return;
				}
			} else {
				d.setFacet(TYPE, LabelExpressionDescription
						.create(isOpenGLDefault ? LayeredDisplayData.OPENGL : LayeredDisplayData.JAVA2D));
			}

			// final String camera = d.firstFacetFoundAmong(CAMERA_LOCATION, CAMERA_TARGET, CAMERA_ORIENTATION,
			// CAMERA_LENS, "z_near", "z_far", IKeyword.CAMERA);
			// if (!isOpenGLWanted && camera != null) {
			// d.warning(
			// "camera-related facets will have no effect on 2D displays. Use 'focus:' instead if you want to change the
			// default zoom and position.",
			// IGamlIssue.UNUSED, camera);
			// }

			// AD: addressing the deprecation of the "trace:" facet
			final IExpressionDescription trace = d.getFacet(TRACE);
			if (trace != null) {
				d.visitChildren(layer -> {
					if (!layer.hasFacet(TRACE)) { layer.setFacet(TRACE, trace); }
					return true;
				});

			}
			// AD: addressing the deprecation of camera_location, camera_target, camera_orientation, camera_up_vector,
			// camera_look_pos and camera_pos
			// IExpressionDescription up = d.getFacet("camera_up_vector");
			// if (target == null) { target = d.getFacet(CAMERA_ORIENTATION); }
			IExpressionDescription target = d.getFacet("camera_look_pos");
			if (target == null) { target = d.getFacet("camera_target"); }
			IExpressionDescription location = d.getFacet("camera_pos");
			if (location == null) { location = d.getFacet("camera_location"); }
			IExpressionDescription lens = d.getFacet("camera_lens");
			IExpressionDescription locked = d.getFacet("camera_interaction");
			String lockedString = locked == null ? "false" : locked.equalsString("true") ? "false" : "true";

			// d.removeFacets("camera_pos", "camera_look_pos", "camera_up_vector",CAMERA_LOCATION,
			// CAMERA_TARGET,CAMERA_ORIENTATION);
			// Creating a default camera
			if (target != null || location != null || lens != null) {
				for (IDescription c : d.getChildrenWithKeyword(CAMERA)) {
					if (DEFAULT.equals(c.getName())) {
						d.warning(
								"A camera named 'default' already exists. Rename it to enable GAMA to relocate the camera settings found here",
								IGamlIssue.SHADOWS_NAME);
						return;
					}
				}
				IDescription cam =
						DescriptionFactory.create(CAMERA, d, NAME, "\"" + DEFAULT + "\"", "locked", lockedString);
				cam.validate();
				d.replaceChildrenWith(Iterables.concat(d.getOwnChildren(), Collections.singleton(cam)));
				if (target != null) { cam.getFacets().put(TARGET, target); }
				if (location != null) { cam.getFacets().put(LOCATION, location); }
				if (lens != null) { cam.getFacets().put("lens", lens); }

			}

		}

		/**
		 * Handle inheritance.
		 *
		 * @param d
		 *            the d
		 * @param string
		 *            the string
		 */
		private void handleInheritance(final IDescription d, final String string) {
			final IDescription output = d.getEnclosingDescription();
			for (final IDescription display : output.getChildrenWithKeyword(DISPLAY)) {
				if (display.getName().equals(string)) {
					handleInheritance(d, display);
					return;
				}
			}
			d.error("No parent display named '" + string + "' found");
		}

		/**
		 * Handle inheritance.
		 *
		 * @param child
		 *            the child
		 * @param parent
		 *            the parent
		 */
		private void handleInheritance(final IDescription child, final IDescription parent) {
			final Facets childFacets = child.getFacets();
			final boolean hasVirtual = childFacets.containsKey(VIRTUAL);
			final Facets parentFacets = parent.getFacets();
			childFacets.complementWith(parentFacets);
			if (!hasVirtual) { childFacets.remove(VIRTUAL); }
			child.replaceChildrenWith(Iterables.concat(parent.getOwnChildren(), child.getOwnChildren()));

		}

	}

	/**
	 * Instantiates a new layered display output.
	 *
	 * @param desc
	 *            the desc
	 */
	public LayeredDisplayOutput(final IDescription desc) {
		super(desc);
		if (hasFacet(IKeyword.TYPE)) { getData().setDisplayType(getLiteral(IKeyword.TYPE)); }
		layers = new ArrayList<>();
		cameras = new ArrayList<>();
		lights = new ArrayList<>();
	}

	/**
	 * Gets the overlay provider.
	 *
	 * @return the overlay provider
	 */
	public IOverlayProvider<OverlayInfo> getOverlayProvider() { return overlayInfo; }

	@Override
	public boolean init(final IScope scope) throws GamaRuntimeException {
		final boolean result = super.init(scope);
		if (!result) return false;
		if (rotation != null) {
			getData().setRotation(rotation.getDefinition());
			rotation.init(scope);
		}
		for (CameraStatement s : cameras) {
			getData().addCameraDefinition(s.getDefinition());
			s.init(scope);
		}
		for (LightStatement s : lights) {
			getData().addLightDefinition(s.getDefinition());
			s.init(scope);
		}
		getData().initWith(getScope(), description);

		for (final ILayerStatement layer : getLayers()) {
			layer.setDisplayOutput(this);
			if (!getScope().init(layer).passed()) return false;
		}

		final IExpression sync = getFacet("synchronized");
		if (sync != null) { setSynchronized(Cast.asBool(getScope(), sync.value(getScope()))); }

		createSurface(getScope());
		return true;
	}

	@Override
	public boolean step(final IScope scope) throws GamaRuntimeException {
		for (final ILayerStatement layer : getLayers()) {
			getScope().setCurrentSymbol(layer);
			getScope().step(layer);
		}
		return true;
	}

	@Override
	public void update() throws GamaRuntimeException {
		if (surface == null) return;
		getData().update(getScope(), description.getFacets());

		if (overlayInfo != null) { getScope().step(overlayInfo); }

		super.update();

	}

	@Override
	public void dispose() {
		if (disposed) return;
		setSynchronized(false);
		super.dispose();
		if (surface != null) { surface.dispose(); }
		surface = null;
		getLayers().clear();
		getData().dispose();
	}

	/**
	 * Creates the surface.
	 *
	 * @param scope
	 *            the scope
	 */
	protected void createSurface(final IScope scope) {
		if (surface != null) {
			surface.outputReloaded();
			return;
		}
		if (scope.getExperiment().isHeadless()) {
			// If in headless mode, we need to get the 'image' surface
			getData().setDisplayType(IKeyword.IMAGE);
		} else if (getData().isOpenGL()) // The surface will be crezated later
			return;
		surface = scope.getGui().createDisplaySurfaceFor(this);
	}

	@Override
	public String getViewId() {
		if (getData().isWeb()) return IGui.GL_LAYER_VIEW_ID3;
		if (getData().isOpenGL2()) return IGui.GL_LAYER_VIEW_ID2;
		if (getData().isOpenGL()) return IGui.GL_LAYER_VIEW_ID;
		return IGui.LAYER_VIEW_ID;
	}

	/**
	 * Gets the surface.
	 *
	 * @return the surface
	 */
	public IDisplaySurface getSurface() { return surface; }

	@Override
	public List<? extends ISymbol> getChildren() { return getLayers(); }

	@Override
	public void setChildren(final Iterable<? extends ISymbol> commands) {
		final List<AbstractLayerStatement> list = new ArrayList<>();
		for (final ISymbol s : commands) {
			if (s instanceof CameraStatement cs) {
				cameras.add(cs);
			} else if (s instanceof RotationStatement rs) {
				rotation = rs;
			} else if (s instanceof LightStatement ls) {
				lights.add(ls);
			} else {
				if (s instanceof OverlayStatement os && os.hasInfo()) { overlayInfo = os; }
				list.add((AbstractLayerStatement) s);
			}

		}
		setLayers(list);

	}

	/**
	 * Sets the surface.
	 *
	 * @param surface
	 *            the new surface
	 */
	public void setSurface(final IDisplaySurface surface) {
		this.surface = surface;
		if (surface == null) { view = null; }
	}

	/**
	 * Gets the image.
	 *
	 * @return the image
	 */
	public BufferedImage getImage() {
		return surface == null ? null : surface.getImage(surface.getWidth(), surface.getHeight());
	}

	/**
	 * Gets the image.
	 *
	 * @param w
	 *            the w
	 * @param h
	 *            the h
	 * @return the image
	 */
	public BufferedImage getImage(final int w, final int h) {
		return surface == null ? null : surface.getImage(w, h);
	}

	/**
	 * Sets the layers.
	 *
	 * @param layers
	 *            the new layers
	 */
	public void setLayers(final List<AbstractLayerStatement> layers) {
		this.layers.clear();
		this.layers.addAll(layers);
	}

	/**
	 * Gets the layers.
	 *
	 * @return the layers
	 */
	public List<AbstractLayerStatement> getLayers() { return layers; }

	@Override
	public void setPaused(final boolean paused) {
		final boolean wasPaused = isPaused();
		super.setPaused(paused);
		if (surface == null) return;
		if (getData().isOpenGL()) { ((IDisplaySurface.OpenGL) surface).setPaused(paused); }
		if (wasPaused && !paused) { surface.updateDisplay(false); }
	}

	/**
	 * Gets the data.
	 *
	 * @return the data
	 */
	public LayeredDisplayData getData() {
		return data; // .get();
	}

	// Keeping in sync the two implementations of synchronized, so that OpenGL
	// objects can have an easy access to the value (and modify it). Also allows
	// modelers to declare this property directly in the model.

	@Override
	public void setSynchronized(final boolean sync) {
		getData().setSynchronized(sync);
		super.setSynchronized(sync);

	}

	@Override
	public boolean isSynchronized() { return super.isSynchronized() && getData().isSynchronized(); }

	/**
	 * Gets the index.
	 *
	 * @return the index
	 */
	public int getIndex() { return index; }

	/**
	 * Sets the index.
	 *
	 * @param index
	 *            the new index
	 */
	public void setIndex(final int index) { this.index = index; }

	@Override
	public boolean isAutoSave() {
		final IExpression e = getFacet(IKeyword.AUTOSAVE);
		if (e == null || e == IExpressionFactory.FALSE_EXPR) return false;
		return true;
	}

	/**
	 * Zoom.
	 *
	 * @param mode
	 *            the mode
	 */
	public void zoom(final int mode) {
		if (mode < 0) {
			surface.zoomOut();
		} else if (mode == 0) {
			surface.zoomFit();
		} else {
			surface.zoomIn();
		}
	}

	@Override
	public IGamaView.Display getView() { return (Display) super.getView(); }

	/**
	 * Release view.
	 */
	public void releaseView() {
		view = null;
	}

}