Updated H2D sections - Objects, ObjectTrees, Scenes, Layers #102

hristo-kanchev · 2024-10-22T15:39:18Z

Description:

Updated the documentation for the following h2d sections:

H2D-Introduction
Objects
Object trees
Scenes
Layers

The changes contain typo fixes, renaming of class names, fixing broken links and also updating deprecated code.

PS: All code samples have been tested locally to see that they compile and run correctly

hristo-kanchev · 2024-10-22T16:55:32Z

Layers.md

@@ -6,7 +6,7 @@ When using any `h2d.Scene` (`s2d` when inside `hxd.App`) you have all features o

 Basically you have two features here:

-1. The first is you can place `h2d.Object`s at specific layers by `s2d.addChildAt( myobj, MY_LAYER )`. `0` will be the layer the most in the background, while each higher layer is rendered over/above the precedent layer. Usually you predefine your layer indices in some way for instance by `final MY_LAYER_NAME : Int = 23;` (see in the sample below) so you know what each integer (`Int` value) stands for.
+1. The first is you can place `h2d.Object`s at specific layers by `s2d.add( myobj, MY_LAYER )`. `0` will be the layer the most in the background, while each higher layer is rendered over/above the precedent layer. Usually you predefine your layer indices in some way for instance by `final MY_LAYER_NAME : Int = 23;` (see in the sample below) so you know what each integer (`Int` value) stands for.


There is a warning if you use addChildAt which is the following:
"Warning: Previous behavior of Layers.addChildAt is no longer applicable and Layers.add should be used instead."

We have now updated the documentation and code sample bellow to reflect the better way of adding child objects to layers.

hristo-kanchev · 2024-10-22T16:56:26Z

Layers.md

@@ -18,13 +18,16 @@ Note that the clouds are on top of all other objects. The green soil stains (mea

 ```haxe

-class LayersDemo extends hxd.App {
+class Main extends hxd.App {


Rename to Main so we don't force the reader to always update their compile.hxml. It's much easier now to copy and paste code samples and run them.

hristo-kanchev · 2024-10-22T16:56:42Z

Layers.md

    var clouds : Array<h2d.Object> = [];
    var LAYER_FOR_SOIL : Int = 0;
    var LAYER_FOR_BUILDINGS : Int = 1;
    var LAYER_FOR_SKY : Int = 2;
-    static function main() {new LayersDemo();}
-    function new() {super();}


new is not needed here.

hristo-kanchev · 2024-10-22T16:56:53Z

Object-trees.md

@@ -12,10 +12,14 @@ The child objects will inherit the transformations of the parent object they hav
 ### Code

 ```haxe
-class ObjectTrees extends hxd.App { // ObjectTrees
+class Main extends hxd.App { // ObjectTrees


Rename to Main so we don't force the reader to always update their compile.hxml. It's much easier now to copy and paste code samples and run them.

hristo-kanchev · 2024-10-22T16:57:32Z

Scenes.md

-class ABC extends hxd.App {
-    public static var app : ABC;                // just will represent this app as an individual object at runtime (so as an instance of this class)
-    static function main() { app = new ABC(); } // "save" the reference for access from outside later
+class Main extends hxd.App {


Rename to Main so we don't force the reader to always update their compile.hxml. It's much easier now to copy and paste code samples and run them.

hristo-kanchev · 2024-10-22T16:57:55Z

Scenes.md

    public var myUpdateFunction : Dynamic;      // this will allow us to define the update function from other classes (see Level01)
-    public function new() {super();}


new is not needed here.

hristo-kanchev · 2024-10-22T17:00:56Z

Scenes.md

-```
-
-## Scenes and camera
-
-Scenes and camera is explained here.
-
-### Sizing
-
-Scenes sizing is explained here.
-
-### Zoom
-
-Camera zoom is explained here.


Removing these leftover "todos". We can always add information regarding zoom, sizing, etc. later.

hristo-kanchev · 2024-10-23T17:43:15Z

H2D-Introduction.md

@@ -54,6 +54,6 @@ The underlying `h2d.Object` (from which `h2d.Bitmap` inherits) provides the bitm

 ![h2d_introduction_helloworld2](https://user-images.githubusercontent.com/88530062/174428357-45f857ed-30bf-450d-99b6-72051f5b0b83.png)

-The [next section](Objects) will discuss `h2d.Object` a bit closer.
+The [next section](https://heaps.io/documentation/objects.html) will discuss `h2d.Object` a bit closer.


Fixed broken link.

hristo-kanchev · 2024-10-23T17:43:35Z

Objects.md

@@ -11,7 +11,7 @@ Like shown previously in the introduction to give our Heaps application visual (
 (See more on [[Drawable]])

 ## Creating and adding Objects
-Objects can be added to a [scene](Scenes) directly (a `h2d.Scene`, for instance `s2d` when inside `hxd.App`) or be added to another `h2d.Object` creating an *object tree*. Object trees are regarded in the next section about [[Object trees]].
+Objects can be added to a [scene](https://heaps.io/documentation/scenes.html) directly (a `h2d.Scene`, for instance `s2d` when inside `hxd.App`) or be added to another `h2d.Object` creating an *object tree*. Object trees are regarded in the next section about [[Object trees]].


Fixed broken link

yuxiaomao · 2024-10-24T06:27:34Z

Thank you!
As a side note, please avoid force push on reviewed commit, it can be confusing - in your case, simply merge the branch master and push is sufficient. Squash and merge will be used when merging PRs, so the commit history can still remain clean.

hristo-kanchev · 2024-10-24T07:11:31Z

Thank you! As a side note, please avoid force push on reviewed commit, it can be confusing - in your case, simply merge the branch master and push is sufficient. Squash and merge will be used when merging PRs, so the commit history can still remain clean.

@yuxiaomao Ahh yeah sorry about that. I’ll keep that in mind for next time. Thanks!

hristo-kanchev force-pushed the h2d-updates branch from 5d3dee4 to e8d4678 Compare October 22, 2024 16:52

hristo-kanchev changed the title ~~Updated H2D documentation~~ Updated H2D Docs - Objects, ObjectTrees, Scenes, Layers Oct 22, 2024

hristo-kanchev marked this pull request as ready for review October 22, 2024 17:01

hristo-kanchev changed the title ~~Updated H2D Docs - Objects, ObjectTrees, Scenes, Layers~~ Updated H2D sections - Objects, ObjectTrees, Scenes, Layers Oct 22, 2024

hristo-kanchev commented Oct 22, 2024

View reviewed changes

hristo-kanchev added 2 commits October 23, 2024 20:39

Updated H2D - Objects, Scenes and Layers documentation.

de1b462

Fixed broken links

74c87d0

hristo-kanchev force-pushed the h2d-updates branch from e8d4678 to 74c87d0 Compare October 23, 2024 17:42

hristo-kanchev commented Oct 23, 2024

View reviewed changes

hristo-kanchev mentioned this pull request Oct 23, 2024

Updated Animation, Drawable, Events & Interactivity. #103

Merged

yuxiaomao merged commit df8f822 into HeapsIO:master Oct 24, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated H2D sections - Objects, ObjectTrees, Scenes, Layers #102

Updated H2D sections - Objects, ObjectTrees, Scenes, Layers #102

hristo-kanchev commented Oct 22, 2024 •

edited

Loading

hristo-kanchev Oct 22, 2024

hristo-kanchev Oct 22, 2024

hristo-kanchev Oct 22, 2024

hristo-kanchev Oct 22, 2024

hristo-kanchev Oct 22, 2024

hristo-kanchev Oct 22, 2024

hristo-kanchev Oct 22, 2024

hristo-kanchev Oct 23, 2024

hristo-kanchev Oct 23, 2024

yuxiaomao commented Oct 24, 2024

hristo-kanchev commented Oct 24, 2024

		public var myUpdateFunction : Dynamic; // this will allow us to define the update function from other classes (see Level01)
		public function new() {super();}

Updated H2D sections - Objects, ObjectTrees, Scenes, Layers #102

Updated H2D sections - Objects, ObjectTrees, Scenes, Layers #102

Conversation

hristo-kanchev commented Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yuxiaomao commented Oct 24, 2024

hristo-kanchev commented Oct 24, 2024

hristo-kanchev commented Oct 22, 2024 •

edited

Loading