├── hxformat.json
├── haxelib.json
├── README.md
├── parallaxlt
└── ParallaxSprite.hx
└── LICENSE
/hxformat.json:
--------------------------------------------------------------------------------
1 | {
2 | "lineEnds": {
3 | "leftCurly": "both",
4 | "rightCurly": "both",
5 | "emptyCurly": "break",
6 | "objectLiteralCurly": {
7 | "leftCurly": "after"
8 | }
9 | },
10 | "sameLine": {
11 | "ifElse": "next",
12 | "doWhile": "next",
13 | "tryBody": "next",
14 | "tryCatch": "next"
15 | }
16 | }
--------------------------------------------------------------------------------
/haxelib.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "parallaxlt",
3 | "url": "https://github.com/Itz-Miles/parallaxlt",
4 | "license": "Apache",
5 | "tags": [
6 | "haxeflixel",
7 | "3d",
8 | "2-5d",
9 | "2d",
10 | "parallax",
11 | "skew",
12 | "matrix"
13 | ],
14 | "description": "Transform Sprites to Mimic 3D Graphics in Haxeflixel",
15 | "version": "0.0.6",
16 | "releasenote": "package refactor, screenspace bugfixes",
17 | "contributors": [
18 | "Itz-Miles"
19 | ]
20 | }
21 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | # ParallaxLT - Transform Sprites to Mimic 3D Graphics in Haxeflixel
3 |
4 |   
5 |
6 | ParallaxLT is a Haxelib that distorts sprites via linear transaformations to mimic 3D graphics in [HaxeFlixel](https://haxeflixel.com).
7 |
8 | - Thourough Haxeflixel Support: Consists of a single version-independent ParallaxSprite class.
9 |
10 | - Simple Integration: Easily integrate ParallaxSprites into your project with minimal code changes.
11 |
12 | - Flexible Configuration: Adjust scroll factors, direction, and anchor points to fine-tune everything to your liking.
13 |
14 | ## Installation:
15 |
16 | To get started with ParallaxLT, simply install it however you like as a Haxelib:
17 | ### in the command line:
18 | `haxelib install parallaxlt`
19 | ### with the Maxe Module Manager:
20 | ```json
21 | {
22 | "name": "parallaxlt",
23 | "type": "haxelib",
24 | "version": null
25 | }
26 | ```
27 |
28 | Once that's said and done, declare it in your haxeflixel project:
29 |
30 | ``
31 |
32 | ## Licensing
33 |
34 | © 2023 It'z Miles - some rights rerserved.
35 |
36 | Licensed under the Apache License, Version 2.0 (the "License");
37 | you may not use this file except in compliance with the License.
38 |
39 | Unless required by applicable law or agreed to in writing, software
40 | distributed under the License is distributed on an "AS IS" BASIS,
41 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
42 | See the License for the specific language governing permissions and
43 | limitations under the License.
44 |
45 |
46 | ## Credits
47 | |  | [It'z Miles](https://twitter.com/Itz_MilesDev) | Creator of ParallaxLT |
48 | | ---------------------------------------------------------- | ---------------------------------------------- | --------------------- |
49 |
50 |
--------------------------------------------------------------------------------
/parallaxlt/ParallaxSprite.hx:
--------------------------------------------------------------------------------
1 | package parallaxlt;
2 |
3 | import flixel.math.FlxRect;
4 | import flixel.system.FlxAssets.FlxGraphicAsset;
5 | import openfl.geom.Matrix;
6 | import flixel.FlxCamera;
7 | import flixel.FlxG;
8 | import flixel.FlxSprite;
9 | import flixel.graphics.frames.FlxFrame.FlxFrameAngle;
10 | import flixel.FlxObject;
11 | import flixel.math.FlxPoint;
12 |
13 | /** An enum instance that determines what transformations are made to the sprite.
14 | * @param HORIZONTAL typically for ceilings and floors. Skews on the x axis, scales on the y axis.
15 | * @param VERTICAL typically for walls and backdrops. Scales on the x axis, skews on the y axis.
16 | * @param NULL unintallized value. Not to be confused with bools `scales` and `skews`
17 | */
18 | @enum
19 | enum Direction
20 | {
21 | HORIZONTAL;
22 | VERTICAL;
23 | NULL;
24 | }
25 |
26 | /**
27 | * The ParallaxSprite class is a FlxSprite extension that does linear transformations to mimic 3D graphics.
28 | * @author Itz-Miles
29 | */
30 | class ParallaxSprite extends FlxSprite
31 | {
32 | private var pointOne:FlxObject = new FlxObject();
33 | private var pointTwo:FlxObject = new FlxObject();
34 |
35 | private var _bufferOne:FlxPoint = FlxPoint.get();
36 | private var _bufferTwo:FlxPoint = FlxPoint.get();
37 |
38 | /** An enum that determines what transformations are made to the sprite.
39 | * @param HORIZONTAL typically for ceilings and floors. Skews on the x axis, scales on the y axis.
40 | * @param VERTICAL typically for walls and backdrops. Scales on the x axis, skews on the y axis.
41 | * @param NULL unintallized value. Not to be confused with bools `scales` and `skews`
42 | **/
43 | public var direction:Direction = Direction.NULL;
44 |
45 | /**
46 | * Creates a ParallaxSprite at specified position with a specified graphic.
47 | * @param X The ParallaxSprite's initial X position.
48 | * @param Y The ParllaxSprite's initial Y position.
49 | * @param graphic The graphic to load (uses haxeflixel's default if null)
50 | */
51 | public function new(X:Float = 0, Y:Float = 0, graphic:FlxGraphicAsset)
52 | {
53 | super(X, Y, graphic);
54 | origin.set(0, 0);
55 | }
56 |
57 | /**
58 | * Sets the sprites skew factors, direction.
59 | * These can be set independently but may lead to unexpected behaivor.
60 | * @param anchor the camera's scroll where the sprite appears unchanged.
61 | * @param scrollOne the scroll factors of the first point.
62 | * @param scrollTwo the scroll factors of the second point.
63 | * @param direction the sprite's direction, which determines the skew.
64 | * @param horizontal typically for ceilings and floors. Skews on the x axis, scales on the y axis.
65 | * @param vertical typically for walls and backdrops. Scales on the x axis, skews on the y axis.
66 | **/
67 | public function fixate(anchorX:Int = 0, anchorY:Int = 0, scrollOneX:Float = 1, scrollOneY:Float = 1, scrollTwoX:Float = 1.1, scrollTwoY:Float = 1.1,
68 | direct:String = 'horizontal'):ParallaxSprite
69 | {
70 | pointOne.scrollFactor.set(1, 1);
71 | pointTwo.scrollFactor.set(1, 1);
72 | pointOne.setPosition(anchorX + x, anchorY + y);
73 |
74 | switch (direct.toLowerCase())
75 | {
76 | case 'horizontal', 'orizzontale', 'horisontell':
77 | direction = HORIZONTAL;
78 | pointTwo.setPosition((x + anchorX), (y + anchorY + frameHeight));
79 | case 'vertical', 'vertikale', 'verticale', 'vertikal':
80 | direction = VERTICAL;
81 | pointTwo.setPosition((x + anchorX + frameWidth), (y + anchorY));
82 | }
83 | scrollFactor.set(scrollOneX, scrollOneY);
84 | pointOne.scrollFactor.set(scrollOneX, scrollOneY);
85 | pointTwo.scrollFactor.set(scrollTwoX, scrollTwoY);
86 | return this;
87 | }
88 |
89 | override public function getScreenBounds(?newRect:FlxRect, ?camera:FlxCamera):FlxRect
90 | {
91 | if (newRect == null)
92 | newRect = FlxRect.get();
93 |
94 | if (camera == null)
95 | camera = FlxG.camera;
96 | _bufferOne.copyFrom(pointOne.getScreenPosition(camera));
97 | _bufferTwo.copyFrom(pointTwo.getScreenPosition(camera));
98 |
99 | newRect.x = x - camera.scroll.x * scrollFactor.x;
100 | newRect.x += Math.min(_bufferTwo.x - _bufferOne.x, 0);
101 |
102 | newRect.y = y - camera.scroll.y * scrollFactor.y;
103 | newRect.y += Math.min(_bufferTwo.y - _bufferOne.y, 0);
104 |
105 | newRect.width = (frameWidth * Math.abs(scale.x)) + Math.abs(_bufferTwo.x - _bufferOne.x);
106 | newRect.height = (frameHeight * Math.abs(scale.y)) + Math.abs(_bufferTwo.y - _bufferOne.y);
107 |
108 | if (isPixelPerfectRender(camera))
109 | newRect.floor();
110 |
111 | return newRect.getRotatedBounds(angle, _scaledOrigin, newRect);
112 | }
113 |
114 | override public function destroy():Void
115 | {
116 | pointOne = null;
117 | pointTwo = null;
118 | _bufferOne.put();
119 | _bufferTwo.put();
120 | direction = null;
121 | super.destroy();
122 | }
123 |
124 | @:noCompletion
125 | override function drawComplex(camera:FlxCamera):Void
126 | {
127 | _frame.prepareMatrix(_matrix, FlxFrameAngle.ANGLE_0, checkFlipX(), checkFlipY());
128 |
129 | if (direction == HORIZONTAL)
130 | {
131 | _matrix.c = (_bufferTwo.x - _bufferOne.x) / frameHeight;
132 | _matrix.d = (_bufferTwo.y - _bufferOne.y) / frameHeight;
133 | }
134 | else if (direction == VERTICAL)
135 | {
136 | _matrix.b = (_bufferTwo.y - _bufferOne.y) / frameWidth;
137 | _matrix.a = (_bufferTwo.x - _bufferOne.x) / frameWidth;
138 | }
139 |
140 | if (bakedRotationAngle <= 0)
141 | {
142 | updateTrig();
143 |
144 | if (angle != 0)
145 | _matrix.rotateWithTrig(_cosAngle, _sinAngle);
146 | }
147 | #if (flixel <= "5.0.0")
148 | _point.addPoint(origin);
149 | #else
150 | getScreenPosition(_point, camera).subtractPoint(offset);
151 | #end
152 | if (isPixelPerfectRender(camera))
153 | _point.floor();
154 | _matrix.tx += _point.x;
155 | _matrix.ty += _point.y;
156 |
157 | _matrix.translate(-origin.x, -origin.y);
158 | _matrix.scale(scale.x, scale.y);
159 |
160 | camera.drawPixels(_frame, framePixels, _matrix, colorTransform, blend, antialiasing, shader);
161 | }
162 |
163 | override public function isSimpleRender(?camera:FlxCamera):Bool
164 | {
165 | if (!FlxG.renderBlit)
166 | return false;
167 | return super.isSimpleRender(camera) && _matrix.c == 0 && _matrix.b == 0;
168 | }
169 | }
170 |
171 | /*
172 | Project your visuals with linear transformations that seamlessly integrate with HaxeFlixel's scrollfactors!
173 | Classic ParallaxSprite class for ParallaxLT
174 | https://github.com/Itz-Miles/parallaxLT
175 |
176 | © 2022 It'z_Miles - some rights rerserved.
177 |
178 | Licensed under the Apache License, Version 2.0 (the "License");
179 | you may not use this file except in compliance with the License.
180 | You may obtain a copy of the License at
181 |
182 | http://www.apache.org/licenses/LICENSE-2.0
183 |
184 | Unless required by applicable law or agreed to in writing, software
185 | distributed under the License is distributed on an "AS IS" BASIS,
186 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
187 | See the License for the specific language governing permissions and
188 | limitations under the License.
189 | */
190 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------