mirror of
https://github.com/jneug/zeichenmaschine.git
synced 2026-04-14 14:43:33 +02:00
Javadocs angepasst und Fehler behoben
This commit is contained in:
@@ -3,12 +3,12 @@ package schule.ngb.zm;
|
|||||||
/**
|
/**
|
||||||
* Repräsentiert eine Farbe in der Zeichenmaschine.
|
* Repräsentiert eine Farbe in der Zeichenmaschine.
|
||||||
* <p>
|
* <p>
|
||||||
* Farben bestehen entweder aus einem Grauwert (zwischen <code>0</code> und
|
* Farben bestehen entweder aus einem Grauwert (zwischen 0 und
|
||||||
* <code>255</code>) oder einem Rot-, Grün- und Blauanteil (jeweils zwischen
|
* 255) oder einem Rot-, Grün- und Blauanteil (jeweils zwischen
|
||||||
* <code>0</code> und <code>255</code>).
|
* 0 und 255).
|
||||||
* <p>
|
* <p>
|
||||||
* Eine Farbe hat außerdem einen Transparenzwert zwischen <code>0</code>
|
* Eine Farbe hat außerdem einen Transparenzwert zwischen 0
|
||||||
* (unsichtbar) und <code>255</code> (deckend).
|
* (unsichtbar) und 255 (deckend).
|
||||||
*/
|
*/
|
||||||
public class Color {
|
public class Color {
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ public class Color {
|
|||||||
/**
|
/**
|
||||||
* Erstellt eine graue Farbe entsprechend des Grauwertes <var>gray</var>.
|
* Erstellt eine graue Farbe entsprechend des Grauwertes <var>gray</var>.
|
||||||
*
|
*
|
||||||
* @param gray Ein Grauwert zwischen <code>0</code> und <code>255</code>.
|
* @param gray Ein Grauwert zwischen 0 und 255.
|
||||||
*/
|
*/
|
||||||
public Color( int gray ) {
|
public Color( int gray ) {
|
||||||
this(gray, gray, gray, 255);
|
this(gray, gray, gray, 255);
|
||||||
@@ -116,7 +116,7 @@ public class Color {
|
|||||||
* Erstellt eine graue Farbe entsprechend des Grauwertes <var>gray</var> und
|
* Erstellt eine graue Farbe entsprechend des Grauwertes <var>gray</var> und
|
||||||
* des Transparentwertes <var>alpha</var>.
|
* des Transparentwertes <var>alpha</var>.
|
||||||
*
|
*
|
||||||
* @param gray Ein Grauwert zwischen <code>0</code> und <code>255</code>.
|
* @param gray Ein Grauwert zwischen 0 und 255.
|
||||||
*/
|
*/
|
||||||
public Color( int gray, int alpha ) {
|
public Color( int gray, int alpha ) {
|
||||||
this(gray, gray, gray, alpha);
|
this(gray, gray, gray, alpha);
|
||||||
@@ -125,12 +125,11 @@ public class Color {
|
|||||||
/**
|
/**
|
||||||
* Erstellt eine Farbe. Die Parameter <var>red</var>, <var>green</var> und
|
* Erstellt eine Farbe. Die Parameter <var>red</var>, <var>green</var> und
|
||||||
* <var>blue</var> geben die Rot-, Grün- und Blauanteile der Farbe. Die Werte
|
* <var>blue</var> geben die Rot-, Grün- und Blauanteile der Farbe. Die Werte
|
||||||
* liegen zwischen <code>0</code> und <code>255</code>.
|
* liegen zwischen 0 und 255.
|
||||||
*
|
*
|
||||||
* @param red Rotwert zwischen <code>0</code> und <code>255</code>.
|
* @param red Rotwert zwischen 0 und 255.
|
||||||
* @param green Grünwert zwischen <code>0</code> und <code>255</code>.
|
* @param green Grünwert zwischen 0 und 255.
|
||||||
* @param blue Blauwert zwischen <code>0</code> und <code>255</code>.
|
* @param blue Blauwert zwischen 0 und 255.
|
||||||
* @return Ein passendes Farbobjekt.
|
|
||||||
*/
|
*/
|
||||||
public Color( int red, int green, int blue ) {
|
public Color( int red, int green, int blue ) {
|
||||||
this(red, green, blue, 255);
|
this(red, green, blue, 255);
|
||||||
@@ -139,17 +138,16 @@ public class Color {
|
|||||||
/**
|
/**
|
||||||
* Erstellt eine Farbe. Die Parameter <var>red</var>, <var>green</var> und
|
* Erstellt eine Farbe. Die Parameter <var>red</var>, <var>green</var> und
|
||||||
* <var>blue</var> geben die Rot-, Grün- und Blauanteile der Farbe. Die Werte
|
* <var>blue</var> geben die Rot-, Grün- und Blauanteile der Farbe. Die Werte
|
||||||
* liegen zwischen <code>0</code> und <code>255</code>.
|
* liegen zwischen 0 und 255.
|
||||||
* <var>alpha</var> gibt den den Transparentwert an (auch zwischen
|
* <var>alpha</var> gibt den den Transparentwert an (auch zwischen
|
||||||
* code>0</code> und <code>255</code>), wobei
|
* 0 und 255), wobei
|
||||||
* <code>0</code> komplett durchsichtig ist und <code>255</code> komplett
|
* 0 komplett durchsichtig ist und 255 komplett
|
||||||
* deckend.
|
* deckend.
|
||||||
*
|
*
|
||||||
* @param red Rotwert zwischen <code>0</code> und <code>255</code>.
|
* @param red Rotwert zwischen 0 und 255.
|
||||||
* @param green Grünwert zwischen <code>0</code> und <code>255</code>.
|
* @param green Grünwert zwischen 0 und 255.
|
||||||
* @param blue Blauwert zwischen <code>0</code> und <code>255</code>.
|
* @param blue Blauwert zwischen 0 und 255.
|
||||||
* @param alpha Transparentwert zwischen <code>0</code> und <code>255</code>.
|
* @param alpha Transparentwert zwischen 0 und 255.
|
||||||
* @return Ein passendes Farbobjekt.
|
|
||||||
*/
|
*/
|
||||||
public Color( int red, int green, int blue, int alpha ) {
|
public Color( int red, int green, int blue, int alpha ) {
|
||||||
rgba = (alpha << 24) | (red << 16) | (green << 8) | blue;
|
rgba = (alpha << 24) | (red << 16) | (green << 8) | blue;
|
||||||
@@ -239,7 +237,7 @@ public class Color {
|
|||||||
/**
|
/**
|
||||||
* Erzeugt eine Farbe aus einem hexadezimalen Code. Der Hexcode kann
|
* Erzeugt eine Farbe aus einem hexadezimalen Code. Der Hexcode kann
|
||||||
* sechs- oder achtstellig sein (wenn ein Transparentwert vorhanden ist).
|
* sechs- oder achtstellig sein (wenn ein Transparentwert vorhanden ist).
|
||||||
* Dem Code kann ein <code>#</code> Zeichen vorangestellt sein.
|
* Dem Code kann ein {@code #} Zeichen vorangestellt sein.
|
||||||
*
|
*
|
||||||
* @param hexcode
|
* @param hexcode
|
||||||
* @return
|
* @return
|
||||||
|
|||||||
@@ -387,10 +387,10 @@ public class Constants {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Erstellt eine graue Farbe. Der Parameter {@code gray} gibt einen Grauwert
|
* Erstellt eine graue Farbe. Der Parameter {@code gray} gibt einen Grauwert
|
||||||
* zwischen <code>0</code> und <code>255</code> an, wobei
|
* zwischen 0 und 255 an, wobei
|
||||||
* <code>0</code> schwarz und <code>255</code> weiß ist.
|
* 0 schwarz und 255 weiß ist.
|
||||||
*
|
*
|
||||||
* @param gray Grauwert zwischen <code>0</code> und <code>255</code>.
|
* @param gray Grauwert zwischen 0 und 255.
|
||||||
* @return Ein passendes Farbobjekt.
|
* @return Ein passendes Farbobjekt.
|
||||||
*/
|
*/
|
||||||
public static final Color color( int gray ) {
|
public static final Color color( int gray ) {
|
||||||
@@ -399,16 +399,16 @@ public class Constants {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Erstellt eine graue Farbe. Der Parameter {@code gray} gibt einen Grauwert
|
* Erstellt eine graue Farbe. Der Parameter {@code gray} gibt einen Grauwert
|
||||||
* zwischen <code>0</code> und <code>255</code> an, wobei
|
* zwischen 0 und 255 an, wobei
|
||||||
* <code>0</code> schwarz und <code>255</code> weiß ist.
|
* 0 schwarz und 255 weiß ist.
|
||||||
* {@code alpha} gibt den den Transparentwert an (auch zwischen
|
* {@code alpha} gibt den den Transparentwert an (auch zwischen
|
||||||
* <code>0</code> und <code>255</code>), wobei
|
* 0 und 255), wobei
|
||||||
* <code>0</code> komplett durchsichtig ist und <code>255</code> komplett
|
* 0 komplett durchsichtig ist und 255 komplett
|
||||||
* deckend.
|
* deckend.
|
||||||
*
|
*
|
||||||
* @param gray Grauwert zwischen <code>0</code> und <code>255</code>.
|
* @param gray Grauwert zwischen 0 und 255.
|
||||||
* @param alpha Transparentwert zwischen <code>0</code> und
|
* @param alpha Transparentwert zwischen 0 und
|
||||||
* <code>255</code>.
|
* 255.
|
||||||
* @return Ein passendes Farbobjekt.
|
* @return Ein passendes Farbobjekt.
|
||||||
*/
|
*/
|
||||||
public static final Color color( int gray, int alpha ) {
|
public static final Color color( int gray, int alpha ) {
|
||||||
@@ -418,11 +418,11 @@ public class Constants {
|
|||||||
/**
|
/**
|
||||||
* Erstellt eine Farbe. Die Parameter {@code red}, {@code green} und
|
* Erstellt eine Farbe. Die Parameter {@code red}, {@code green} und
|
||||||
* {@code blue} geben die Rot-, Grün- und Blauanteile der Farbe. Die Werte
|
* {@code blue} geben die Rot-, Grün- und Blauanteile der Farbe. Die Werte
|
||||||
* liegen zwischen <code>0</code> und <code>255</code>.
|
* liegen zwischen 0 und 255.
|
||||||
*
|
*
|
||||||
* @param red Rotwert zwischen <code>0</code> und <code>255</code>.
|
* @param red Rotwert zwischen 0 und 255.
|
||||||
* @param green Grünwert zwischen <code>0</code> und <code>255</code>.
|
* @param green Grünwert zwischen 0 und 255.
|
||||||
* @param blue Blauwert zwischen <code>0</code> und <code>255</code>.
|
* @param blue Blauwert zwischen 0 und 255.
|
||||||
* @return Ein passendes Farbobjekt.
|
* @return Ein passendes Farbobjekt.
|
||||||
*/
|
*/
|
||||||
public static final Color color( int red, int green, int blue ) {
|
public static final Color color( int red, int green, int blue ) {
|
||||||
@@ -432,17 +432,17 @@ public class Constants {
|
|||||||
/**
|
/**
|
||||||
* Erstellt eine Farbe. Die Parameter {@code red}, {@code green} und
|
* Erstellt eine Farbe. Die Parameter {@code red}, {@code green} und
|
||||||
* {@code blue} geben die Rot-, Grün- und Blauanteile der Farbe. Die Werte
|
* {@code blue} geben die Rot-, Grün- und Blauanteile der Farbe. Die Werte
|
||||||
* liegen zwischen <code>0</code> und <code>255</code>. {@code alpha} gibt
|
* liegen zwischen 0 und 255. {@code alpha} gibt
|
||||||
* den den Transparentwert an (auch zwischen code>0</code> und
|
* den den Transparentwert an (auch zwischen 0 und
|
||||||
* <code>255</code>), wobei
|
* 255), wobei
|
||||||
* <code>0</code> komplett durchsichtig ist und <code>255</code> komplett
|
* 0 komplett durchsichtig ist und 255 komplett
|
||||||
* deckend.
|
* deckend.
|
||||||
*
|
*
|
||||||
* @param red Rotwert zwischen <code>0</code> und <code>255</code>.
|
* @param red Rotwert zwischen 0 und 255.
|
||||||
* @param green Grünwert zwischen <code>0</code> und <code>255</code>.
|
* @param green Grünwert zwischen 0 und 255.
|
||||||
* @param blue Blauwert zwischen <code>0</code> und <code>255</code>.
|
* @param blue Blauwert zwischen 0 und 255.
|
||||||
* @param alpha Transparenzwert zwischen <code>0</code> und
|
* @param alpha Transparenzwert zwischen 0 und
|
||||||
* <code>255</code>.
|
* 255.
|
||||||
* @return Ein passendes Farbobjekt.
|
* @return Ein passendes Farbobjekt.
|
||||||
*/
|
*/
|
||||||
public static final Color color( int red, int green, int blue, int alpha ) {
|
public static final Color color( int red, int green, int blue, int alpha ) {
|
||||||
@@ -589,7 +589,7 @@ public class Constants {
|
|||||||
* Ermittelt das Vorzeichen der Zahl {@code x}.
|
* Ermittelt das Vorzeichen der Zahl {@code x}.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @return <code>-1</code>, <code>1</code> oder <code>0</code>.
|
* @return -1, 1 oder 0.
|
||||||
*/
|
*/
|
||||||
public static final double sign( double x ) {
|
public static final double sign( double x ) {
|
||||||
return Math.signum(x);
|
return Math.signum(x);
|
||||||
@@ -670,7 +670,7 @@ public class Constants {
|
|||||||
* Ermittelt den Sinus der Zahl {@code x}.
|
* Ermittelt den Sinus der Zahl {@code x}.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @return <code>sin(x)</code>.
|
* @return {@code sin(x)}.
|
||||||
*/
|
*/
|
||||||
public static final double sin( double x ) {
|
public static final double sin( double x ) {
|
||||||
return Math.sin(x);
|
return Math.sin(x);
|
||||||
@@ -680,7 +680,7 @@ public class Constants {
|
|||||||
* Ermittelt den Kosinus der Zahl {@code x}.
|
* Ermittelt den Kosinus der Zahl {@code x}.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @return <code>cos(x)</code>.
|
* @return {@code cos(x)}.
|
||||||
*/
|
*/
|
||||||
public static final double cos( double x ) {
|
public static final double cos( double x ) {
|
||||||
return Math.cos(x);
|
return Math.cos(x);
|
||||||
@@ -690,7 +690,7 @@ public class Constants {
|
|||||||
* Ermittelt den Tangens der Zahl {@code x}.
|
* Ermittelt den Tangens der Zahl {@code x}.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @return <code>tan(x)</code>.
|
* @return {@code tan(x)}.
|
||||||
*/
|
*/
|
||||||
public static final double tan( double x ) {
|
public static final double tan( double x ) {
|
||||||
return Math.tan(x);
|
return Math.tan(x);
|
||||||
@@ -700,7 +700,7 @@ public class Constants {
|
|||||||
* Ermittelt den Arkussinus der Zahl {@code x}.
|
* Ermittelt den Arkussinus der Zahl {@code x}.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @return <code>asin(x)</code>.
|
* @return {@code asin(x)}.
|
||||||
*/
|
*/
|
||||||
public static final double arcsin( double x ) {
|
public static final double arcsin( double x ) {
|
||||||
return Math.asin(x);
|
return Math.asin(x);
|
||||||
@@ -710,7 +710,7 @@ public class Constants {
|
|||||||
* Ermittelt den Arkuskosinus der Zahl {@code x}.
|
* Ermittelt den Arkuskosinus der Zahl {@code x}.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @return <code>acos(x)</code>.
|
* @return {@code acos(x)}.
|
||||||
*/
|
*/
|
||||||
public static final double arccos( double x ) {
|
public static final double arccos( double x ) {
|
||||||
return Math.acos(x);
|
return Math.acos(x);
|
||||||
@@ -720,20 +720,20 @@ public class Constants {
|
|||||||
* Ermittelt den Arkusktangens der Zahl {@code x}.
|
* Ermittelt den Arkusktangens der Zahl {@code x}.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @return <code>atan(x)</code>.
|
* @return {@code atan(x)}.
|
||||||
*/
|
*/
|
||||||
public static final double arctan( double x ) {
|
public static final double arctan( double x ) {
|
||||||
return Math.atan(x);
|
return Math.atan(x);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Beschränkt die Zahl {@code x} auf das Intervall <code>[min, max]</code>.
|
* Beschränkt die Zahl {@code x} auf das Intervall {@code [min, max]}.
|
||||||
* Liegt {@code x} außerhalb des Intervalls, wird eine der Grenzen
|
* Liegt {@code x} außerhalb des Intervalls, wird eine der Grenzen
|
||||||
* zurückgegeben.
|
* zurückgegeben.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @param max Das Maximum des Intervalls.
|
* @param max Das Maximum des Intervalls.
|
||||||
* @return Eine Zahl im Intervall <code>[min, max]</code>.
|
* @return Eine Zahl im Intervall {@code [min, max]}.
|
||||||
*/
|
*/
|
||||||
public static final double limit( double x, double min, double max ) {
|
public static final double limit( double x, double min, double max ) {
|
||||||
if( x > max ) {
|
if( x > max ) {
|
||||||
@@ -746,13 +746,13 @@ public class Constants {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Beschränkt die Zahl {@code x} auf das Intervall <code>[min, max]</code>.
|
* Beschränkt die Zahl {@code x} auf das Intervall {@code [min, max]}.
|
||||||
* Liegt {@code x} außerhalb des Intervalls, wird eine der Grenzen
|
* Liegt {@code x} außerhalb des Intervalls, wird eine der Grenzen
|
||||||
* zurückgegeben.
|
* zurückgegeben.
|
||||||
*
|
*
|
||||||
* @param x Eine Zahl.
|
* @param x Eine Zahl.
|
||||||
* @param max Das Maximum des Intervalls.
|
* @param max Das Maximum des Intervalls.
|
||||||
* @return Eine Zahl im Intervall <code>[min, max]</code>.
|
* @return Eine Zahl im Intervall {@code [min, max]}.
|
||||||
*/
|
*/
|
||||||
public static final int limit( int x, int min, int max ) {
|
public static final int limit( int x, int min, int max ) {
|
||||||
if( x > max ) {
|
if( x > max ) {
|
||||||
@@ -774,7 +774,7 @@ public class Constants {
|
|||||||
*
|
*
|
||||||
* @param from Startwert
|
* @param from Startwert
|
||||||
* @param to Zielwert
|
* @param to Zielwert
|
||||||
* @param t Wert zwischen <code>0</code> und <code>1</code>.
|
* @param t Wert zwischen 0 und 1.
|
||||||
* @return Das Ergebnis der linearen Interpolation.
|
* @return Das Ergebnis der linearen Interpolation.
|
||||||
*/
|
*/
|
||||||
public static final double interpolate( double from, double to, double t ) {
|
public static final double interpolate( double from, double to, double t ) {
|
||||||
@@ -885,8 +885,8 @@ public class Constants {
|
|||||||
* Erzeugt einen zufälligen Wahrheitswert. {@code true} wird mit der
|
* Erzeugt einen zufälligen Wahrheitswert. {@code true} wird mit der
|
||||||
* Wahrscheinlichkeit {@code percent} Prozent erzeugt.
|
* Wahrscheinlichkeit {@code percent} Prozent erzeugt.
|
||||||
*
|
*
|
||||||
* @param percent Eine Prozentzahl zwischen <code>0</code> und
|
* @param percent Eine Prozentzahl zwischen 0 und
|
||||||
* <code>100</code>.
|
* 100.
|
||||||
* @return Ein Wahrheitswert.
|
* @return Ein Wahrheitswert.
|
||||||
*/
|
*/
|
||||||
public static final boolean randomBool( int percent ) {
|
public static final boolean randomBool( int percent ) {
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ public interface Audio {
|
|||||||
* {@code isLooping() == true}, dann muss auch immer
|
* {@code isLooping() == true}, dann muss auch immer
|
||||||
* {@code isPlaying() == true} gelten.
|
* {@code isPlaying() == true} gelten.
|
||||||
*
|
*
|
||||||
* @return @return {@code true}, wenn das Medium in einer Schleife
|
* @return {@code true}, wenn das Medium in einer Schleife
|
||||||
* abgespielt wird, {@code false} sonst.
|
* abgespielt wird, {@code false} sonst.
|
||||||
*/
|
*/
|
||||||
boolean isLooping();
|
boolean isLooping();
|
||||||
|
|||||||
@@ -222,7 +222,7 @@ public abstract class Shape extends FilledShape {
|
|||||||
* {@code buff} nach oben verschoben.
|
* {@code buff} nach oben verschoben.
|
||||||
*
|
*
|
||||||
* @param shape
|
* @param shape
|
||||||
* @param anchor
|
* @param dir
|
||||||
* @param buff
|
* @param buff
|
||||||
*/
|
*/
|
||||||
public void moveTo( Shape shape, Options.Direction dir, double buff ) {
|
public void moveTo( Shape shape, Options.Direction dir, double buff ) {
|
||||||
|
|||||||
Reference in New Issue
Block a user