jme.script.ctx2d

Interface AbstractPrimitivas2D

All Known Implementing Classes:

JMEPrimitivas2DParaSwing, Primitivas2DAdapter

public interface AbstractPrimitivas2D

Primitivas gráficas a implementar en cada sistema gráfico

Since:

0.6.2.0, JMEScript 0.2.0

Version:

0.6.2.1, JMEScript 0.2.0

Author:

Miguel Alejandro Moreno Barrientos, (C)2020-2021

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AbstractPrimitivas2D.AbstractColor Implementa de forma abstracta un color ARGB, dado por sus canales
static interface	AbstractPrimitivas2D.AbstractKeyStroke Intefaz para la representación de pulsaciones de teclas
static interface	AbstractPrimitivas2D.AbstractRatonEvent Interfaz para la representación de eventos de ratón o toques táctiles
static class	AbstractPrimitivas2D.AccionPuntos Holder para la primitiva ruta(AccionPuntos[], RUTA, boolean, boolean)
static class	AbstractPrimitivas2D.CAP Estilo de redondeo de línea
static class	AbstractPrimitivas2D.CICLO Estilo de gradiente
static class	AbstractPrimitivas2D.CIERRE Tipos de cierre de arco
static class	AbstractPrimitivas2D.ENTRADA tipos de entrada de datos por parte del usuario
static class	AbstractPrimitivas2D.ESTILO Estilo de texto
static class	AbstractPrimitivas2D.JOIN Estilo de unión de líneas
static class	AbstractPrimitivas2D.MSJ Tipos de mensajes
static class	AbstractPrimitivas2D.PUNTO Tipos de puntos
static class	AbstractPrimitivas2D.RECT3D Estilo de resaltado 3D
static class	AbstractPrimitivas2D.RUTA Tipos de segmentos en una ruta

Method Summary

Modifier and Type	Method and Description
void	circunferencia(double cx, double cy, double radio, double ang, double arco, AbstractPrimitivas2D.CIERRE tipo, boolean relleno, boolean borde) Dibuja circunferencias, círculos y arcos
void	elipse(double x1, double y1, double x2, double y2, boolean relleno, boolean borde) Dibuja elipses
void	entradaUsuario(Script script, AbstractPrimitivas2D.ENTRADA entrada, java.lang.String varname, java.lang.String msj, java.lang.String[] opciones) Lectura de entradas de usuario.
boolean	esContextoIniciado() Comprobar si se ha iniciado el lienzo
void	finalizarContexto() Cerrar lienzo
int	getAlto() Alto del lienzo
int	getAltoPantalla() Alto del dispositivo
int	getAncho() Ancho del lienzo
int	getAnchoPantalla() Ancho del dispositivo
AbstractPrimitivas2D.AbstractColor	getColor() Color de línea del lienzo
AbstractPrimitivas2D.AbstractColor	getColorFactory() Obtiene una factoría (definida a partir de un AbstractColor) para obtener nuevos colores
AbstractPrimitivas2D.AbstractColor	getFondo() Color de fondo del lienzo
double[]	getMatriz(double[] storeMatrizTransformacion) Matriz de transformación del lienzo [[sx,shx,tx],[shy,sy,ty],[0,0,1]]
java.lang.Object	getPadre() Obtiene el componente padre del lienzo
java.lang.String	getPrim2DName() Nombre de esta implementación
java.lang.String	getPrim2DVersion() Versión de esta implementación
java.lang.String	getPrim2DVersionName() Nombre de versión de esta implementación
java.util.Map<java.lang.Object,java.lang.Object>	getPropiedadesEntorno() Obtiene un mapa de propiedades del sistema definidas por el desarrollador
java.util.List<AbstractPrimitivas2D.AbstractRatonEvent>	getRatonEventList() Lista de toques en pantalla o clicks de ratón a consumir
AbstractPrimitivas2D.AbstractColor	getRelleno() Color de relleno del lienzo
java.util.List<AbstractPrimitivas2D.AbstractKeyStroke>	getStrokeList() Lista de pulsaciones de teclas a consumir
java.lang.String	getUIName() Nombre de entorno gráfico en el que ejecutará JMEScript (ej: Swing, AWT, JavaFx, Android,...)
java.lang.String	getUIVersion() Versión del entorno gráfico (ej: 0.2.0, v3.7)
java.lang.String	getUIVersionName() Nombre de versión del entorno gráfico (si existe)
void	iniciarContexto(int indice, int ancho, int alto, int posX, int posY, java.lang.String titulo) Inicia un lienzo (canvas) para dibujar y le asigna un índice único
void	limpiar(int x, int y, int ancho, int alto, AbstractPrimitivas2D.AbstractColor cfondo) Borra una parte del lienzo, con el color de fondo especificado
int[]	medirTexto(java.lang.String texto, int tama, int sombraX, int sombraY, java.lang.String familia, AbstractPrimitivas2D.ESTILO estilo) Devuelve la dimensión del texto a graficar
void	mostrarMensaje(java.lang.String msj, AbstractPrimitivas2D.MSJ tipo, java.lang.Integer posX, java.lang.Integer posY, java.lang.Integer tiempo) Muestra un mensaje al usuario mediante diálogo o tostada
void	poligono(double[] x, double[] y, boolean cerrar, boolean relleno, boolean borde) Dibuja un polígono o polilínea
void	punto(double x, double y, AbstractPrimitivas2D.PUNTO tipo) Dibuja un punto del tipo especificado, con el grosor establecido con 'trazo' y color de línea establecido
void	rectangulo(double x1, double y1, double x2, double y2, double anchoArco, double altoArco, boolean relleno, boolean borde, AbstractPrimitivas2D.RECT3D rect3d) Dibuja un rectángulo recto, redondeado o 3D.
void	repintar(int indice) Repintar el lienzo especificado (generalmente éste)
void	ruta(AbstractPrimitivas2D.AccionPuntos[] accionPuntos, AbstractPrimitivas2D.RUTA regla, boolean relleno, boolean borde) Dibuja una figura en base a una ruta especificada por diferentes acciones
void	segmento(double x1, double y1, double x2, double y2) Traza segmento entre dos puntos con el color de línea establecido
java.io.File[]	seleccionarArchivos(java.lang.String path, java.lang.String titulo) Permite seleccionar uno o varios archivos del sistema
void	setColor(AbstractPrimitivas2D.AbstractColor color) Establecer color de línea del lienzo
void	setFondo(AbstractPrimitivas2D.AbstractColor color) Establecer color de fondo del lienzo
void	setGradiente(double x1, double y1, double x2, double y2, java.lang.Double radio, float[] fracciones, AbstractPrimitivas2D.AbstractColor[] colores, AbstractPrimitivas2D.CICLO ciclo, java.lang.Object transform) Gradiente aplicado a relleno y línea
void	setMatriz(double[] matrizTransformacion) Establece la matriz del lienzo [[sx,shx,tx],[shy,sy,ty],[0,0,1]]
void	setRelleno(AbstractPrimitivas2D.AbstractColor color) Establecer color de relleno del lienzo
void	setTrazo(float grosor)
void	setTrazo(float grosor, AbstractPrimitivas2D.CAP extremo, AbstractPrimitivas2D.JOIN union, java.lang.Float inglete, float[] raya, java.lang.Float faseRaya)
void	texto(java.lang.String texto, int posX, int posY, int tama, int sombraX, int sombraY, java.lang.String familia, AbstractPrimitivas2D.ESTILO estilo) Dibuja un texto.

Method Detail

getUIName

java.lang.String getUIName()

Nombre de entorno gráfico en el que ejecutará JMEScript (ej: Swing, AWT, JavaFx, Android,...)

Returns:

nombre del UI

Since:

0.6.2.0, JMEScript 0.2.0

getUIVersionName

java.lang.String getUIVersionName()

Nombre de versión del entorno gráfico (si existe)

Returns:

nombre de la versión del UI

Since:

0.6.2.0, JMEScript 0.2.0

getUIVersion

java.lang.String getUIVersion()

Versión del entorno gráfico (ej: 0.2.0, v3.7)

Returns:

versión numérica del UI

Since:

0.6.2.0, JMEScript 0.2.0

getPrim2DName

java.lang.String getPrim2DName()

Nombre de esta implementación

Returns:

nombre

getPrim2DVersionName

java.lang.String getPrim2DVersionName()

Nombre de versión de esta implementación

Returns:

nombre de versión

getPrim2DVersion

java.lang.String getPrim2DVersion()

Versión de esta implementación

Returns:

versión numérica de la versión

getPadre

java.lang.Object getPadre()

Obtiene el componente padre del lienzo

Returns:

componente padre o null

iniciarContexto

void iniciarContexto(int indice,
                     int ancho,
                     int alto,
                     int posX,
                     int posY,
                     java.lang.String titulo)

Inicia un lienzo (canvas) para dibujar y le asigna un índice único

Parameters:

indice - índice del contexto idx>0

ancho - ancho del lienzo

alto - alto del lienzo

posX - posición inicial x

posY - posición inicial y

titulo - título del lienzo (o null)

finalizarContexto

void finalizarContexto()

Cerrar lienzo

esContextoIniciado

boolean esContextoIniciado()

Comprobar si se ha iniciado el lienzo

Returns:

true si está iniciado

repintar

void repintar(int indice)

Repintar el lienzo especificado (generalmente éste)

Parameters:

indice - índice del lienzo

getAncho

int getAncho()

Ancho del lienzo

Returns:

ancho en pixels del lienzo

getAlto

int getAlto()

Alto del lienzo

Returns:

alto en pixels del lienzo

getAnchoPantalla

int getAnchoPantalla()

Ancho del dispositivo

Returns:

ancho del dispositivo en pixels

getAltoPantalla

int getAltoPantalla()

Alto del dispositivo

Returns:

alto del dispositivo en pixels

getPropiedadesEntorno

java.util.Map<java.lang.Object,java.lang.Object> getPropiedadesEntorno()

Obtiene un mapa de propiedades del sistema definidas por el desarrollador

Returns:

mapa de propiedades del sistema

mostrarMensaje

void mostrarMensaje(java.lang.String msj,
                    AbstractPrimitivas2D.MSJ tipo,
                    java.lang.Integer posX,
                    java.lang.Integer posY,
                    java.lang.Integer tiempo)

Muestra un mensaje al usuario mediante diálogo o tostada

Parameters:

msj - mensaje

tipo - AbstractPrimitivas2D.MSJ

posX - coordenada X del mensaje. Puede ser null

posY - coordenada Y del mensaje. Puede ser null

tiempo - tiempo a mostrar el mensaje. Puede ser null

entradaUsuario

void entradaUsuario(Script script,
                    AbstractPrimitivas2D.ENTRADA entrada,
                    java.lang.String varname,
                    java.lang.String msj,
                    java.lang.String[] opciones)

Lectura de entradas de usuario.
El valor almacenado deberá ser Expresion.ERROR#__error1__ si se cancela la entrada.
Si se evalúa un expresión y se obtiene un error, el valor almacenado deberá ser Expresion.ERROR#__error2__

Parameters:

script - script actual

entrada - tipo de entrada de usuario; AbstractPrimitivas2D.ENTRADA

varname - variable para almacenar el valor

msj - mensaje de petición de datos al usuario

opciones - opciones para el tipo AbstractPrimitivas2D.ENTRADA.OPCIONES. Puede ser null

getStrokeList

java.util.List<AbstractPrimitivas2D.AbstractKeyStroke> getStrokeList()

Lista de pulsaciones de teclas a consumir

Returns:

lista de pulsaciones

getRatonEventList

java.util.List<AbstractPrimitivas2D.AbstractRatonEvent> getRatonEventList()

Lista de toques en pantalla o clicks de ratón a consumir

Returns:

lista de eventos de ratón/toque

seleccionarArchivos

java.io.File[] seleccionarArchivos(java.lang.String path,
                                   java.lang.String titulo)

Permite seleccionar uno o varios archivos del sistema

Parameters:

path - ruta actual (ruta vacía mantiene el directorio actual, ruta errónea establece la ruta por defecto)

titulo - título de un posible diálogo de selección o null para valor por defecto

Returns:

array de archivos seleccionados con la ruta completa. Si no se selecciona ninguno devuelve array vacío y null si hay un error

getColorFactory

AbstractPrimitivas2D.AbstractColor getColorFactory()

Obtiene una factoría (definida a partir de un AbstractColor) para obtener nuevos colores

Returns:

factoría de color

setColor

void setColor(AbstractPrimitivas2D.AbstractColor color)

Establecer color de línea del lienzo

Parameters:

color - color de línea

setRelleno

void setRelleno(AbstractPrimitivas2D.AbstractColor color)

Establecer color de relleno del lienzo

Parameters:

color - color de relleno

setFondo

void setFondo(AbstractPrimitivas2D.AbstractColor color)

Establecer color de fondo del lienzo

Parameters:

color - color de fondo

getColor

AbstractPrimitivas2D.AbstractColor getColor()

Color de línea del lienzo

Returns:

color de línea

getRelleno

AbstractPrimitivas2D.AbstractColor getRelleno()

Color de relleno del lienzo

Returns:

color de relleno

getFondo

AbstractPrimitivas2D.AbstractColor getFondo()

Color de fondo del lienzo

Returns:

color de fondo

setTrazo

void setTrazo(float grosor)

setTrazo

void setTrazo(float grosor,
              AbstractPrimitivas2D.CAP extremo,
              AbstractPrimitivas2D.JOIN union,
              java.lang.Float inglete,
              float[] raya,
              java.lang.Float faseRaya)

setGradiente

void setGradiente(double x1,
                  double y1,
                  double x2,
                  double y2,
                  java.lang.Double radio,
                  float[] fracciones,
                  AbstractPrimitivas2D.AbstractColor[] colores,
                  AbstractPrimitivas2D.CICLO ciclo,
                  java.lang.Object transform)

Gradiente aplicado a relleno y línea

Parameters:

x1 - inicio x del primer color o centro x

y1 - inicio y del primer color o centro y

x2 - final x del último color o foco X

y2 - final y del último color o foco y

radio - radio del gradiente radial

fracciones - división ponderada del patrón de color

colores - color asociado a cada fracción

ciclo - AbstractPrimitivas2D.CICLO.CICLO, AbstractPrimitivas2D.CICLO.REFLEJO, AbstractPrimitivas2D.CICLO.NO_CICLO

transform - matriz de transformación (puede ser AffineTransform en escritorio o Matrix en Android)

getMatriz

double[] getMatriz(double[] storeMatrizTransformacion)

Matriz de transformación del lienzo [[sx,shx,tx],[shy,sy,ty],[0,0,1]]

Parameters:

storeMatrizTransformacion - matriz 3x3 inicializada donde se almacenará la matriz

Returns:

la propia matriz storeMatrizTransformacion actualizada

setMatriz

void setMatriz(double[] matrizTransformacion)

Establece la matriz del lienzo [[sx,shx,tx],[shy,sy,ty],[0,0,1]]

Parameters:

matrizTransformacion - matriz 3x3

limpiar

void limpiar(int x,
             int y,
             int ancho,
             int alto,
             AbstractPrimitivas2D.AbstractColor cfondo)

Borra una parte del lienzo, con el color de fondo especificado

Parameters:

x - extremo superior izquierda x

y - extremo superior izquierda y

ancho - ancho del rectángulo de borrado

alto - alto del rectángulo de borrado

cfondo - color de fondo

punto

void punto(double x,
           double y,
           AbstractPrimitivas2D.PUNTO tipo)

Dibuja un punto del tipo especificado, con el grosor establecido con 'trazo' y color de línea establecido

Parameters:

x - coordenada X del punto

y - coordenada Y del punto

tipo - AbstractPrimitivas2D.PUNTO

segmento

void segmento(double x1,
              double y1,
              double x2,
              double y2)

Traza segmento entre dos puntos con el color de línea establecido

Parameters:

x1 - coordenada X del extremo inicial

y1 - coordenada Y del extremo inicial

x2 - coordenada X del extremo final

y2 - coordenada Y del extremo final

circunferencia

void circunferencia(double cx,
                    double cy,
                    double radio,
                    double ang,
                    double arco,
                    AbstractPrimitivas2D.CIERRE tipo,
                    boolean relleno,
                    boolean borde)

Dibuja circunferencias, círculos y arcos

Parameters:

cx - coordenada X del centro

cy - coordenada Y del centro

radio - radio

ang - ángulo inicial (grados)

arco - longitud del arco (grados)

tipo - AbstractPrimitivas2D.CIERRE.ABIERTO, AbstractPrimitivas2D.CIERRE.CUERDA, AbstractPrimitivas2D.CIERRE.TARTA

relleno - verdadero para dibujar el interior (círculo) con color de relleno

borde - verdadero para dibujar la circunferencia o arco. Si relleno es falso, debe dibujarse aunque borde sea falso

elipse

void elipse(double x1,
            double y1,
            double x2,
            double y2,
            boolean relleno,
            boolean borde)

Dibuja elipses

Parameters:

x1 - extremo superior izquierda x

y1 - extremo superior izquierda y

x2 - extremo inferior derecha x

y2 - extremo inferior derecha y

relleno - true para dibujar el interior con color de relleno

borde - verdadero para dibujar el borde. Si relleno es falso, debe dibujarse aunque borde sea falso

rectangulo

void rectangulo(double x1,
                double y1,
                double x2,
                double y2,
                double anchoArco,
                double altoArco,
                boolean relleno,
                boolean borde,
                AbstractPrimitivas2D.RECT3D rect3d)

Dibuja un rectángulo recto, redondeado o 3D. Con relleno y/o borde.

Parameters:

x1 - x extremo superior izquierda

y1 - y extremo superior izquierda

x2 - x extremo inferior derecha

y2 - y extremo inferior derecha

anchoArco - ancho esquinas redondeadas

altoArco - alto esquinas redondeadas

relleno - true para dibujar el interior con color de relleno

borde - verdadero para dibujar el borde. Si relleno es falso, debe dibujarse aunque borde sea falso

rect3d - AbstractPrimitivas2D.RECT3D.GRABADO, AbstractPrimitivas2D.RECT3D.RESALTADO, AbstractPrimitivas2D.RECT3D.NINGUNO

poligono

void poligono(double[] x,
              double[] y,
              boolean cerrar,
              boolean relleno,
              boolean borde)

Dibuja un polígono o polilínea

Parameters:

x - array de coordenadas x

y - array de coordenadas y (mismo tamaño y punto correspondiente)

cerrar - verdadero para cerrar primer y último punto

relleno - true para dibujar el interior con color de relleno

borde - verdadero para dibujar el borde. Si relleno es falso, debe dibujarse aunque borde sea falso

texto

void texto(java.lang.String texto,
           int posX,
           int posY,
           int tama,
           int sombraX,
           int sombraY,
           java.lang.String familia,
           AbstractPrimitivas2D.ESTILO estilo)

Dibuja un texto.
Puede incluir sombreado si sombraX o sombraY no son iguales a 0. El color del sombreado será el color de relleno

Parameters:

texto - texto a graficar

posX - coordenada X del texto

posY - coordenada Y del texto

tama - tamaño del texto

sombraX - desplazamiento de la sombra en X

sombraY - desplazamiento de la sombra en Y

familia - familia del texto

estilo - estilo del texto; AbstractPrimitivas2D.ESTILO

medirTexto

int[] medirTexto(java.lang.String texto,
                 int tama,
                 int sombraX,
                 int sombraY,
                 java.lang.String familia,
                 AbstractPrimitivas2D.ESTILO estilo)

Devuelve la dimensión del texto a graficar

Parameters:

texto - texto a graficar

tama - tamaño del texto

sombraX - desplazamiento de la sombra en X

sombraY - desplazamiento de la sombra en Y

familia - familia del texto

estilo - estilo del texto; AbstractPrimitivas2D.ESTILO

Returns:

array [ancho,alto]

ruta

void ruta(AbstractPrimitivas2D.AccionPuntos[] accionPuntos,
          AbstractPrimitivas2D.RUTA regla,
          boolean relleno,
          boolean borde)

Dibuja una figura en base a una ruta especificada por diferentes acciones

Parameters:

accionPuntos -

regla - regla de relleno del interior: AbstractPrimitivas2D.RUTA.PAR_IMPAR, AbstractPrimitivas2D.RUTA.NO_CERO

relleno - true para dibujar el interior con color de relleno

borde - verdadero para dibujar el borde. Si relleno es falso, debe dibujarse aunque borde sea falso