IGraphics.java

/*******************************************************************************************************
 *
 * msi.gama.common.interfaces.IGraphics.java, in plugin msi.gama.core, is part of the source code of the GAMA modeling
 * and simulation platform (v. 1.8.1)
 *
 * (c) 2007-2020 UMI 209 UMMISCO IRD/SU & Partners
 *
 * Visit https://github.com/gama-platform/gama for license information and contacts.
 *
 ********************************************************************************************************/
package msi.gama.common.interfaces;

import java.awt.Color;
import java.awt.RenderingHints;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;

import org.locationtech.jts.geom.Envelope;
import org.locationtech.jts.geom.Geometry;

import msi.gama.metamodel.shape.ILocation;
import msi.gama.outputs.layers.OverlayLayer;
import msi.gama.outputs.layers.charts.ChartOutput;
import msi.gama.util.file.GamaFile;
import msi.gama.util.matrix.IField;
import msi.gaml.statements.draw.DrawingAttributes;
import msi.gaml.statements.draw.MeshDrawingAttributes;
import msi.gaml.statements.draw.TextDrawingAttributes;

/**
 * Written by drogoul Modified on 22 janv. 2011
 *
 * @todo Description
 *
 */
public interface IGraphics {

	public interface ThreeD extends IGraphics {

		@Override
		default boolean is2D() {
			return false;
		}

		ILocation getCameraPos();

		ILocation getCameraTarget();

		ILocation getCameraOrientation();
	}

	RenderingHints QUALITY_RENDERING = new RenderingHints(null);
	RenderingHints SPEED_RENDERING = new RenderingHints(null);
	RenderingHints MEDIUM_RENDERING = new RenderingHints(null);

	void setDisplaySurface(final IDisplaySurface surface);

	int getDisplayWidth();

	int getDisplayHeight();

	Rectangle2D drawFile(GamaFile<?, ?> file, DrawingAttributes attributes);

	Rectangle2D drawField(final IField values, final MeshDrawingAttributes attributes);

	Rectangle2D drawImage(final BufferedImage img, final DrawingAttributes attributes);

	Rectangle2D drawChart(ChartOutput chart);

	Rectangle2D drawString(final String string, final TextDrawingAttributes attributes);

	Rectangle2D drawShape(final Geometry shape, final DrawingAttributes attributes);

	void setOpacity(double i);

	void fillBackground(Color bgColor, double opacity);

	boolean beginDrawingLayers();

	void beginDrawingLayer(ILayer layer);

	void beginOverlay(OverlayLayer layer);

	void endOverlay();

	double getyRatioBetweenPixelsAndModelUnits();

	double getxRatioBetweenPixelsAndModelUnits();

	/*
	 * Returns the region of the current layer (in model units) that is visible on screen
	 */
	Envelope getVisibleRegion();

	void endDrawingLayer(ILayer layer);

	void endDrawingLayers();

	void beginHighlight();

	void endHighlight();

	double getXOffsetInPixels();

	double getYOffsetInPixels();

	Double getZoomLevel();

	default boolean is2D() {
		return true;
	}

	int getViewWidth();

	int getViewHeight();

	IDisplaySurface getSurface();

	default double getMaxEnvDim() {
		return getSurface().getData().getMaxEnvDim();
	}

	default double getEnvWidth() {
		return getSurface().getData().getEnvWidth();
	}

	default double getEnvHeight() {
		return getSurface().getData().getEnvHeight();
	}

	void dispose();

	boolean cannotDraw();

	boolean isNotReadyToUpdate();

	/**
	 * Ask the IGraphics instance to accumulate temporary envelopes
	 *
	 * @param env
	 */
	default void accumulateTemporaryEnvelope(final Rectangle2D env) {}

	default Rectangle2D getAndWipeTemporaryEnvelope() {
		return null;
	}

}