Merge pull request #950 from AlmasB/dev

Release 11.13

Author: AlmasB

.github/.ci/RELEASE.md

@@ -1,6 +1,7 @@
 To release:
 
 1. release-fxgl.sh
-2. Merge dev branch into release (currently called master)
+2. Update README.md -> next version
+3. Merge dev branch into release (currently called master)
 
-Continue developing in dev
+Continue developing on the dev branch

.github/workflows/latest_jdk.yml

@@ -0,0 +1,39 @@
+name: Test FXGL on Mac/Win/Linux using latest stable jdk
+
+on:
+  push:
+    branches: [ dev ]
+  pull_request:
+    branches: [ dev ]
+
+jobs:
+  build:
+    name: "Build (JDK-${{ matrix.java }}, ${{ matrix.os }})"
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, macOS-latest, windows-latest ]
+        java: [ 15 ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v2
+
+      - name: 'Set up JDK'
+        uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java }}
+
+      - name: Cache maven deps
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: Build and test with Maven using xvfb
+        uses: GabrielBB/xvfb-action@v1
+        with:
+          run: |
+            mvn test -B -Dgpg.skip=true -Dmaven.javadoc.skip=true

.travis.yml

@@ -11,8 +11,6 @@ services:
   - xvfb
 jdk:
 - openjdk11
-- openjdk15
-- openjdk-ea
 
 before_install:
 - echo "before_install NOOP"

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ![link](https://img.shields.io/badge/email-almaslvl%40gmail.com-blue). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 Almas Baimagambetov (AlmasB) ([email protected])
+Copyright (c) 2015-2021 Almas Baimagambetov (AlmasB) ([email protected])
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -13,19 +13,20 @@ JavaFX Game Development Framework
 ### Why FXGL?
 
 * No installation or setup required
-* "Out of the box": Java 8-15, Win/Mac/Linux/Android 5.0+/iOS 11.0+/Web
+* "Out of the box": Java 8-15, Win/Mac/Linux/Android 8+/iOS 11.0+/Web
 * Simple and clean API, higher level than other engines
 * Superset of JavaFX: no need to learn new UI API
 * Real-world game development techniques: Entity-Component, interpolated animations, particles, and [many more](https://github.com/AlmasB/FXGL/wiki/Core-Features)
 * Games are easily packaged into a single executable .jar or native images
 
 ### Good for:
 
-* Any 2D genre (side-scroller / platformer / arcade / RPG)
-* Complex UI controls
+* Any 2D game (side-scroller / platformer / arcade / RPG)
+* Any business applications with complex UI controls / animations
+* Experimental 3D
 * Hobby / academic / commercial projects
 * Teaching / learning / improving game development skills
-* Fast prototyping of game ideas
+* Fast prototyping of app ideas
 
 ### Minimal Example
 
@@ -69,7 +70,7 @@ Already have `pom.xml`? Then add: (use `0.5.4` for Java 8-10). **Note:** make su
 <dependency>
     <groupId>com.github.almasb</groupId>
     <artifactId>fxgl</artifactId>
-    <version>11.11</version>
+    <version>11.13</version>
 </dependency>
 ```
 
@@ -85,7 +86,7 @@ repositories {
 }
 
 dependencies {
-    compile 'com.github.almasb:fxgl:11.11'
+    compile 'com.github.almasb:fxgl:11.13'
 }
 ```
 
@@ -122,15 +123,23 @@ If you'd like your project featured here, just add a note in the [Chat](https://
 If you want to build FXGL from sources or want to contribute,
 please see the [Contribution Guide](CONTRIBUTING.md) (including non-code).
 FXGL is fully modular, so new contributors do not need to understand the entire codebase, only the module to which the contribution is made.
+Contributions will be reviewed in accordance with the [Code of Conduct](CODE_OF_CONDUCT.md).
 
 You can support the FXGL development / show interest by simply starring the repo or becoming a [sponsor](https://github.com/sponsors/AlmasB).
 
 ### Sponsors
 
+Users:
+
 * @Marsl10
 * @SergeMerzliakov
 * @mbains
 * @sabit86
+* @hendrikebbers
+
+Companies:
+
+* @karakun
 
 ### Contact
 

fxgl-ai/src/main/java/com/almasb/fxgl/pathfinding/Grid.java

@@ -187,7 +187,7 @@ public final Optional<T> getDown(int x, int y) {
         return getOptional(x, y + 1);
     }
 
-    private Optional<T> getOptional(int x, int y) {
+    public final Optional<T> getOptional(int x, int y) {
         if (isWithin(x, y))
             return Optional.of(get(x, y));
 

fxgl-ai/src/main/java/com/almasb/fxgl/pathfinding/astar/AStarMoveComponent.java

@@ -16,6 +16,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.Random;
 
 /**
@@ -81,6 +82,20 @@ public AStarGrid getGrid() {
         return pathfinder.get().getGrid();
     }
 
+    /**
+     * Note: entity's anchored position is used to compute this.
+     * Note: return type is Optional since it is possible to have
+     * the entity placed at a non-grid position.
+     *
+     * @return cell where this entity is located
+     */
+    public Optional<AStarCell> getCurrentCell() {
+        var cellX = moveComponent.getCellX();
+        var cellY = moveComponent.getCellY();
+
+        return getGrid().getOptional(cellX, cellY);
+    }
+
     public void stopMovementAt(int cellX, int cellY) {
         path.clear();
         moveComponent.setPositionToCell(cellX, cellY);

fxgl-ai/src/test/java/com/almasb/fxgl/pathfinding/GridTest.java

@@ -19,10 +19,7 @@
 import static org.hamcrest.Matchers.greaterThanOrEqualTo;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.lessThan;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertNotNull;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 @SuppressWarnings("java:S5786")
 public class GridTest {
@@ -53,6 +50,17 @@ public void testConstructorWithCellSize() {
         assertEquals(CELL_HEIGHT, grid.getCellHeight());
     }
 
+    @Test
+    public void testConstructorWithNegativeCellSize() {
+        assertThrows(IllegalArgumentException.class, () -> {
+            new Grid<>(MockCell.class, 5, 5, -1, CELL_HEIGHT, new MockCellGenerator());
+        });
+
+        assertThrows(IllegalArgumentException.class, () -> {
+            new Grid<>(MockCell.class, 5, 5, CELL_WIDTH, -1, new MockCellGenerator());
+        });
+    }
+
     @Test
     public void testIsWithin() {
         for (int y = 0; y < GRID_SIZE; y++) {

fxgl-ai/src/test/kotlin/com/almasb/fxgl/pathfinding/astar/AStarMoveComponentTest.kt

@@ -49,6 +49,12 @@ class AStarMoveComponentTest {
         assertThat(cellMoveComponent.cellX, `is`(0))
         assertThat(cellMoveComponent.cellY, `is`(1))
 
+        var currentCell = aStarMoveComponent.currentCell
+
+        assertTrue(currentCell.isPresent)
+        assertThat(currentCell.get().x, `is`(0))
+        assertThat(currentCell.get().y, `is`(1))
+
         // right
         aStarMoveComponent.moveToRightCell()
 
@@ -80,6 +86,12 @@ class AStarMoveComponentTest {
 
         assertThat(cellMoveComponent.cellX, `is`(3))
         assertThat(cellMoveComponent.cellY, `is`(5))
+
+        currentCell = aStarMoveComponent.currentCell
+
+        assertTrue(currentCell.isPresent)
+        assertThat(currentCell.get().x, `is`(3))
+        assertThat(currentCell.get().y, `is`(5))
     }
 
     @Test

fxgl-animation/src/main/kotlin/com/almasb/fxgl/animation/Animatable.kt

@@ -18,11 +18,15 @@ interface Animatable {
 
     fun xProperty(): DoubleProperty
     fun yProperty(): DoubleProperty
+    fun zProperty(): DoubleProperty
 
     fun scaleXProperty(): DoubleProperty
     fun scaleYProperty(): DoubleProperty
+    fun scaleZProperty(): DoubleProperty
 
-    fun rotationProperty(): DoubleProperty
+    fun rotationXProperty(): DoubleProperty
+    fun rotationYProperty(): DoubleProperty
+    fun rotationZProperty(): DoubleProperty
 
     fun opacityProperty(): DoubleProperty