/*=============================================================================#
# Copyright (c) 2009-2016 Stephan Wahlbrink (WalWare.de) and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
#
# Contributors:
# Stephan Wahlbrink - initial API and implementation
#=============================================================================*/
package de.walware.rj.server.client;
import org.eclipse.core.runtime.IProgressMonitor;
import de.walware.rj.graphic.RCircle;
import de.walware.rj.graphic.RClipSetting;
import de.walware.rj.graphic.RColorSetting;
import de.walware.rj.graphic.RFillSetting;
import de.walware.rj.graphic.RFontSetting;
import de.walware.rj.graphic.RLine;
import de.walware.rj.graphic.RLineSetting;
import de.walware.rj.graphic.RPath;
import de.walware.rj.graphic.RPolygon;
import de.walware.rj.graphic.RPolyline;
import de.walware.rj.graphic.RRaster;
import de.walware.rj.graphic.RRect;
import de.walware.rj.graphic.RText;
import de.walware.rj.services.RService;
/**
* Interface for the R side of (RJ) graphics at client layer.
*
* The methods are called by the client protocol handler
* (e.g. {@link AbstractRJComClient}) and must not be called at
* another place.
*/
public interface RClientGraphic {
class InitConfig {
public int canvasColor;
}
/**
* Mask for fill rule
* <ul>
* <li>{@link #FILL_WIND_EVEN_ODD}</li>
* <li>{@link #FILL_WIND_NON_ZERO}</li>
* </ul>
*
* @since 2.0
*/
int MASK_FILL_RULE = 0x3;
/**
* Constant for "even-odd" winding rule for filling elements
*
* @since 2.0
*/
int FILL_WIND_EVEN_ODD = 0x0;
/**
* Constant for "non-zero" winding rule for filling elements
*
* @since 2.0
*/
int FILL_WIND_NON_ZERO = 0x1;
/**
* Returns the device id of R
*
* @return the id
*/
int getDevId();
/**
*
* @param w the width of the graphic
* @param h the height of the graphic
* @param config initialization configuration
*/
void reset(double w, double h, InitConfig config);
/**
* Sets if the graphic is the active device in R.
*
* @param active <code>true</code> if active, otherwise <code>false</code>
*/
void setActive(boolean active);
/**
* Returns if the graphic is the active device in R.
*
* @return <code>true</code> if active, otherwise <code>false</code>
*/
boolean isActive();
/**
* Sets the current mode signaled by R.
* <p>
* Values:
* 0 = R stopped drawing
* 1 = R started drawing
* 2 = graphical input exists
*
* @param mode the value constant
*/
void setMode(int mode);
double[] computeSize();
double[] computeFontMetric(int ch);
double[] computeStringWidth(String txt);
/**
* @see RClipSetting#RClipSetting(double, double, double, double)
*/
void addSetClip(double x0, double y0, double x1, double y1);
/**
* @see RColorSetting#RColorSetting(int)
*/
void addSetColor(int color);
/**
* @see RFillSetting#RFillSetting(int)
*/
void addSetFill(int color);
/**
* @see RLineSetting#RLineSetting(int, double, byte, byte, float)
*/
void addSetLine(int type, float width, byte cap, byte join, float joinMiterLimit);
/**
* @see RFontSetting#RFontSetting(String, int, double, double, double)
*/
void addSetFont(String family, int face, float pointSize, float lineHeight);
/**
* @see RLine#RLine(double, double, double, double)
*/
void addDrawLine(double x0, double y0, double x1, double y1);
/**
* @see RRect#RRect(double, double, double, double)
*/
void addDrawRect(double x0, double y0, double x1, double y1);
/**
* @see RPolyline
*/
void addDrawPolyline(double[] x, double[] y);
/**
* @see RPolygon
*/
void addDrawPolygon(double[] x, double[] y);
/**
* @see RPath
*/
void addDrawPath(int[] n, double[] x, double[] y, int winding);
/**
* @see RCircle#RCircle(double, double, double)
*/
void addDrawCircle(double x, double y, double r);
/**
* @see RText
*/
void addDrawText(String txt, double x, double y, double rDeg, double hAdj);
/**
* @see RRaster
*/
void addDrawRaster(byte[] imgData, boolean imgAlpha, int imgWidth, int imgHeight,
double x, double y, double w, double h, double rDeg, boolean interpolate);
byte[] capture(int width, int height);
double[] runRLocator(RService r, IProgressMonitor monitor);
}