README (#14)

Added README

.gitignore

@@ -1,4 +1,3 @@
-# Project exclude paths
-/.gradle/
-/build/
-/build/classes/java/main/
+.gradle/
+build/
+.idea/

README.md

@@ -0,0 +1,130 @@
+# Point Quadtree visualizer
+
+An application which offers a **Point Quadtree** implementation within a flexible **visualizer**.
+
+You can learn more about the Quadtrees at [Wikipedia](https://en.wikipedia.org/wiki/Quadtree).
+
+> This application was made for an assessment during a **data structures and algorithms** college course.
+
+Have a look,
+
+![Application screenshot](pictures/screenshot.png)
+
+## Ingredients
+
+Built on top of [Java](https://en.wikipedia.org/wiki/Java_(programming_language)) language with help of the following awesome tools,
+
+- [JavaFX](https://openjfx.io/)
+
+	> The desktop application platform.
+
+- [Kotlin](https://kotlinlang.org/)
+
+	> To eliminate the boilerplate codes.
+
+- [RxJava](https://github.com/ReactiveX/RxJava)
+
+	> To handle user input events.
+
+- [Gradle](https://gradle.org/)
+
+	> The build automation tool, handles the compilation and dependencies.
+
+- :heart:
+
+## Getting started
+
+To get a local copy **up and running** follow these simple steps,
+
+1. Make sure **Java 11** or higher is installed.
+
+2. Clone the repository.
+
+	> You can do this either by using the `git` command,
+	>
+	> ```sh
+	> git clone https://github.com/agcom/quad-tree.git
+	> ```
+	>
+	> or downloading and extracting the [project `zip` artifact](https://github.com/agcom/quad-tree/archive/master.zip).
+
+3. Run the application.
+
+	> You need to invoke the gradle `run` task to get the application running.
+	>
+	> You can use the pre-made **gradle scripts** even if you don't have the required gradle bundle installed.
+	>
+	> - On Linux,
+	>
+	> 	```sh
+	> 	./gradlew run
+	> 	```
+	>
+	> - On Windows,
+	>
+	> 	```powershell
+	> 	./gradlew.bat run
+	> 	```
+	>
+	> 	For more information on running batch files on Windows visit this [tutorial](https://www.wikihow.com/Run-a-Batch-File-from-the-Command-Line-on-Windows).
+
+## Usage
+
+Let's review the application's interesting features,
+
+- Cursor interactions
+
+	> Click and drag on the quadtree, eventually finding yourself drawing a home!
+
+- Change the quadtree specifications,
+
+	> You can change the tree dimensions, *width* and *height*.
+	>
+	> Also, adjust the *capacity*; The amount of points each tree will hold before dividing.
+
+- Spray *random points*
+
+	> Your tree feeling lonely? Give him some babies for god's sake!
+	>
+	> Either drag your cursor on top of the tree, or let us add some *random points*.
+
+- Change query area
+
+	> The quadtree implementation uses abstractions for areas. Currently, two shapes are implemented, *circle* and *rectangle*.
+
+- Erase!
+
+	> This may seem strange, but trust me, it's a cool feature!
+	>
+	> Check the *eraser* box and click/drag the cursor on top of some points. This is where the magic happens! Division redo!
+
+- Adjust the input processing delays
+
+	> Being eager isn't always the best option.
+	>
+	> Delays are necessary to guarantee a lag free experience!
+	>
+	> If you're feeling **lags**, try increasing the delays, most importantly the *draw delay*.
+
+- Some cool statistics about your query efficiency!
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire and create.
+
+Any contributions you make are **greatly appreciated**.
+
+### Bug? Feature?
+
+Create an **issue**, we'll investigate it ASAP.
+
+If you've gone far, share your code with us. **Pull requests** are appreciated.
+
+> Unfamiliar with pull requests? Checkout this [tutorial](https://guides.github.com/activities/forking/).
+
+## Contact us
+
+Got questions? Two ways just for you.
+
+- Create an issue with the ![question-lable](https://img.shields.io/github/labels/agcom/quad-tree/question?style=flat-square) label.
+- Directly contact the [project owner](https://github.com/agcom).

build.gradle

@@ -1,10 +1,8 @@
 plugins {
-
     id 'application'
     id 'java'
     id 'org.jetbrains.kotlin.jvm' version '1.3.61'
     id 'org.openjfx.javafxplugin' version '0.0.8'
-
 }
 
 group 'ir.agcom'
@@ -14,34 +12,24 @@ mainClassName = 'Launcher'
 sourceCompatibility = 11
 
 repositories {
-
     mavenCentral()
-    maven {
-
-        url "https://plugins.gradle.org/m2/"
-
-    }
-
 }
 
 dependencies {
-
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
+    implementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8'
     implementation 'io.reactivex.rxjava2:rxjavafx:2.2.2'
     implementation 'io.reactivex.rxjava2:rxjava:2.2.17'
     implementation 'com.jfoenix:jfoenix:9.0.8'
-
-}
-
-compileKotlin {
-
-    kotlinOptions.jvmTarget = "11"
-
 }
 
 javafx {
-
     version = '11'
     modules = ['javafx.controls', 'javafx.fxml', 'javafx.base', 'javafx.graphics', 'javafx.swing']
+}
 
+compileKotlin {
+    kotlinOptions.jvmTarget = '11'
+}
+compileTestKotlin {
+    kotlinOptions.jvmTarget = '11'
 }

gradlew

@@ -0,0 +1,183 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=`expr $i + 1`
+    done
+    case $i in
+        0) set -- ;;
+        1) set -- "$args0" ;;
+        2) set -- "$args0" "$args1" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=`save "$@"`
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+exec "$JAVACMD" "$@"