move packages, add openfl sample

Author: loudoweb

.gitignore

@@ -1,2 +1,2 @@
-assets
 bin
+assets_gs

README.md

@@ -1,11 +1,12 @@
 # parallax
-WIP parallax. Openfl for now. Could be agnostic later.
+This can be used in a constrained parallax background. This could be used for 2d side-scrolling parallax but I haven't tested it yet.
+Openfl for now. Could be agnostic later.
 
 # TODO
 ✅ simple bg scrolling
 ✅ make it configurable
 ✅ use xml config
 ✅ add parallax layer
+✅ sample (openfl)
 - [ ] zoom
-- [ ] sample
 - [ ] agnostic

assets/data/parallax.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<data id="test" camX="1000" camY="250" width="4000" height="1500">
+	<layers>
+		<layer id="sky" depth="0">
+			<sprite img="_11_background" />
+			<sprite img="_11_background" x="2048" />
+		</layer>
+		<layer id="distant-clouds" depth="0.1">
+			<sprite img="_09_distant_clouds1" />
+			<sprite img="_09_distant_clouds1"  x="2048" />
+			<sprite img="_10_distant_clouds" x="300" />
+		</layer>
+		<layer id="clouds" depth="0.2">
+			<sprite img="_08_clouds" x="400" />
+		</layer>
+		<layer id="big-clouds" depth="0.28">
+			<sprite img="_07_huge_clouds" />
+			<sprite img="_07_huge_clouds" x="2048" />
+		</layer>
+		<layer id="hills" depth="0.45">
+			<sprite img="_06_hill2" />
+			<sprite img="_06_hill2" x="2048" />
+		</layer>
+		<layer id="hills2" depth="0.5">
+			<sprite img="_05_hill1" />
+			<sprite img="_05_hill1"  x="2048" />
+		</layer>
+		<layer id="brushes" depth="0.7">
+			<sprite img="_04_bushes" />
+			<sprite img="_04_bushes" x="2048" />
+		</layer>
+		<layer id="distant-trees" depth="0.75">
+			<sprite img="_03_distant_trees" />
+			<sprite img="_03_distant_trees" x="2048" />
+		</layer>
+		<layer id="trees" depth="0.95">
+			<sprite img="_02_trees and bushes" />
+			<sprite img="_02_trees and bushes" x="2048" />
+		</layer>
+		<layer id="ground" depth="1">
+			<sprite img="_01_ground" />
+			<sprite img="_01_ground" x="2048" />
+		</layer>
+	</layers>
+</data>

assets/img/_01_ground.png

@@ -0,0 +1 @@
+CC0 game assets from Liz Molnar - RavenTale Studio: https://raventale.itch.io/parallax-background

assets/img/_02_trees and bushes.png

@@ -19,12 +19,12 @@
     <class path="C:\HaxeToolkit\haxe\lib\openfl\9,1,0\src" />
     <class path="C:\HaxeToolkit\haxe\lib\lime\7,9,0\src" />
     <class path="C:\HaxeToolkit\haxe\lib\actuate\1,8,9\src" />
-    <class path="src" />
+    <class path="sample" />
     <class path="bin\html5\haxe" />
   </classpaths>
   <!-- Build options -->
   <build>
-    <option directives="openfl=9.1.0&#xA;lime=7.9.0&#xA;actuate=1.8.9&#xA;ANDROID_SETUP=true&#xA;ANDROID_NDK_ROOT=C:\Development\Android\NDK\android-ndk-r15c&#xA;howlerjs&#xA;lime-webgl&#xA;lime-dom&#xA;lime-howlerjs&#xA;lime-html5&#xA;openfl-disable-handle-error&#xA;HL_PATH=C:\Development\hl-1.10.0-win&#xA;tools=7.9.0&#xA;ANDROID_SDK=C:\Development\Android\SDK\platforms\android-26&#xA;lime-canvas&#xA;no-compilation&#xA;openfl-html5&#xA;JAVA_HOME=C:\Program Files (x86)\java\jdk1.8.0&#xA;HXCPP_COMPILE_CACHE=E:\hxcpp\cache&#xA;fdb&#xA;html5&#xA;web&#xA;html5" />
+    <option directives="openfl=9.1.0&#xA;lime=7.9.0&#xA;actuate=1.8.9&#xA;ANDROID_SETUP=true&#xA;ANDROID_NDK_ROOT=C:\Development\Android\NDK\android-ndk-r15c&#xA;howlerjs&#xA;lime-webgl&#xA;lime-dom&#xA;lime-howlerjs&#xA;lime-html5&#xA;openfl-disable-handle-error&#xA;HL_PATH=C:\Development\hl-1.10.0-win&#xA;gs&#xA;tools=7.9.0&#xA;ANDROID_SDK=C:\Development\Android\SDK\platforms\android-26&#xA;lime-canvas&#xA;no-compilation&#xA;openfl-html5&#xA;JAVA_HOME=C:\Program Files (x86)\java\jdk1.8.0&#xA;HXCPP_COMPILE_CACHE=E:\hxcpp\cache&#xA;fdb&#xA;html5&#xA;web&#xA;html5" />
     <option flashStrict="False" />
     <option noInlineOnDebug="False" />
     <option mainClass="ApplicationMain" />

assets/img/_03_distant_trees.png

@@ -19,14 +19,17 @@ class Parallax
 	public var id:String;
 	/**
 	 * Main layer that allows to retrieve the bounds (width and height) of the parallax world
+	 * optional
 	 */
 	public var world:String;
 	/**
 	 * Set manually the width of the parallax world or use variable `world`
+	 * optional
 	 */
 	public var width:Float;
 	/**
 	 * Set manually the height of the parallax world or use variable `world`
+	 * optional
 	 */
 	public var height:Float;
 	/**
@@ -37,7 +40,7 @@ class Parallax
 	public var camera:ParallaxCamera;
 
 	public var speed:Int;
-
+	
 	public function new(id:String, world:String, cameraX:Float, cameraY:Float, speed:Int = 1 ) 
 	{
 		this.id = id;
@@ -146,7 +149,7 @@ class Parallax
 			world.width = Std.parseFloat(_xml.att.width);
 		if (_xml.has.height)
 			world.height = Std.parseFloat(_xml.att.height);
-		
+					
 		if (world.layers == null)
 			world.layers = [];
 

assets/img/_04_bushes.png

@@ -24,6 +24,14 @@ class ParallaxCamera
 	public var maxZoom:Float;
 	public var deltaZoom:Float;
 
+	/**
+	 * 
+	 * @param	x starting position of the camera
+	 * @param	y starting position of the camera
+	 * @param	width
+	 * @param	height
+	 * @param	zoom
+	 */
 	public function new(x:Float, y:Float, width:Float = 1920, height:Float = 1080, zoom:Float = 1) 
 	{
 		this.originX = x;

assets/img/_05_hill1.png

@@ -4,7 +4,7 @@ using parallax.ParallaxHelper;
 
 /**
  * ...
- * @author Ludovic Bas - www.loudoweb.fr
+ * @author Ludovic Bas - www.lugludum.com
  */
 class ParallaxLayer
 {

assets/img/_06_hill2.png

@@ -4,7 +4,7 @@ using parallax.ParallaxHelper;
 
 /**
  * ...
- * @author Ludovic Bas - www.loudoweb.fr
+ * @author Ludovic Bas - www.lugludum.com
  */
 class ParallaxSprite 
 {

assets/img/_07_huge_clouds.png

@@ -0,0 +1,22 @@
+package parallax.engines;
+import openfl.display.DisplayObject;
+import parallax.Parallax;
+import parallax.ParallaxLayer;
+
+/**
+ * ...
+ * @author Ludovic Bas - www.lugludum.com
+ * TODO could use typedef of whatever to be used with any engines and not just openfl
+ */
+class OpenflHelper
+{
+	inline public static function setWorldBounds(parallax:Parallax, layer:ParallaxLayer, container:DisplayObject ):Void
+	{
+		if (parallax.world != "" && layer.id == parallax.world)
+		{
+			parallax.width = container.width;
+			parallax.height = container.height;
+			parallax.world = "";//reset to avoid setting again with other image
+		}
+	}
+}

assets/img/_08_clouds.png

@@ -6,20 +6,23 @@
 	<meta title="parallax" package="parallax" version="0.0.1" company="loudoweb" />
 
 	<!-- output -->
-	<app main="Main" file="parallax" path="bin" />
+	<app main="sample.OpenflSample" file="parallax" path="bin" />
 
 	<window background="#000000" fps="30" />
 	<window width="0" height="0" unless="mobile" />
 	<window orientation="landscape" vsync="false" antialiasing="0" if="cpp" />
 
 	<!-- classpath, haxe libs -->
-	<source path="src" />
+	<source path="sample" />
 	<haxelib name="openfl" />
 	<haxelib name="actuate" />
 
 	<!-- assets -->
-	<assets path="assets/img" rename="img" />
-	<assets path="assets/data" rename="" />
+	<assets path="assets/img" rename="img" unless="gs" />
+	<assets path="assets/data" rename=""  unless="gs" />
+	
+	<assets path="assets_gs/img" rename="img" if="gs" />
+	<assets path="assets_gs/data" rename=""  if="gs" />
 
 	<!-- optimize output
 	<haxeflag name="-dce full" /> -->

assets/img/_09_distant_clouds1.png

@@ -1,4 +1,4 @@
-package;
+package sample;
 
 import haxe.xml.Access;
 import motion.Actuate;
@@ -12,12 +12,13 @@ import openfl.events.MouseEvent;
 import openfl.geom.Point;
 import parallax.Parallax;
 import parallax.ParallaxLayer;
+import parallax.engines.OpenflHelper;
 
 /**
  * ...
- * @author Ludovic Bas - www.loudoweb.fr
+ * @author Ludovic Bas - www.lugludum.com
  */
-class Main extends Sprite 
+class OpenflSample extends Sprite 
 {
 	var bgPos:Point;
 	var imagePivot:Point;
@@ -58,12 +59,7 @@ class Main extends Sprite
 				spr.x = sprite.originX;
 				spr.y = sprite.originY;
 				container.addChild(spr);
-				if (parallax.world != "" && layer.id == parallax.world)
-				{
-					parallax.width = container.width;
-					parallax.height = container.height;
-					parallax.world = "";//reset to avoid setting again with other image
-				}
+				OpenflHelper.setWorldBounds(parallax, layer, spr);
 			}
 		}