Why there is no method draw() in KineticJS documentation?

I've spent hours googling about Kinetic.Layer.draw() method. All that I've found is use-cases - no documentation about how, when and why to use it. Maybe it's deprecated already?

These are primary links which I use while learning and playing with this wonderful framework:

http://kineticjs.com/docs/index.html

http://www.html5canvastutorials.com/kineticjs/html5-canvas-events-tutorials-introduction-with-kineticjs/

It will be really helpful if somebody explains to me such misunderstanding.

Answers:

Answer

Actually draw() and drawHit() are in the docs, but they are poorly documented:

draw()

draw layer scene graphs

drawHit()

draw layer hit graphs

Surprisingly I was unable to find the 3rd and last draw method: drawScene() in the Kinetic Docs. Also to my surprise, these 3 functions were not found to be extended from the parent class of Kinetic.Stage: Kinetic.Container

Anyways, I think this SO question explains the differences of the methods perfectly: What is the difference between KineticJS draw methods?

And definitely, there's no avoiding using these functions, you'll need to use one of them eventually unless your canvas/stage is static during your entire application. (*There may be an exception, see below)

To answer your questions:

How:

Call .draw() on any Kinetic.Container which includes: stage layer and group, or any Kinetic.Node which includes all the Kinetic.Shape

Examples:

stage.draw(); //Updates the scene renderer and hit graph for the stage
layer.drawHit(); //Updates the hit graph for layer
rect.drawScene(); //Updates the scene renderer for this Kinetic.Rect

Why:

I would think it's a performance thing to not have everything redraw on the Kinetic.Stage every single time there is a change. The use of the draw methods this way we can control programatically when we want the stage to be updated and rendered. As you might imagine, it is quite expensive to have to draw the stage all the time if we have say 10000 nodes in the scene.

When:

drawScene()

Anytime you need to update either the scene renderer (for example using .setFill() to change the fill of a shape)

drawHit()

To update the hit graph if you're binding events to your shapes so that the hit area for any events will be updated to the node changes.

draw()

Whenever you need to do both of the above.

Finally, perhaps an example/lab will be the most beneficial learning tool here, so I've prepared a JSFIDDLE for you to test out the differences. Follow the instructions and read my comments inside to get a better understanding of what's going on.

*NOTE: I mentioned above there was an exception to having to use the draw methods. That is because whenever you add a layer to the stage, everything in the layer is automatically drawn. There is small example of this described at the bottom of the fiddle.

Answer

The draw() method is basically used for drawing all the (visible) elements associated with the container you call the method on. It is therefore not just limited to Kinetic.Layer but can also be used on Kinetic.Group, Kinetic.Container and so on...

When & Why to use: Whenever you make any change to the canvas, you call the appropriate container's Draw() method. KineticJS does not refresh the canvas unless you explicitly say it using Draw(). In general, try to call the smallest container affected by your changes to make use of the efficient caching and redrawing only a part of canvas that was affected.

Take for instance: You have 2 layers in your application. Layer1 is used for a static background and some other static items that need not be redrawn everytime. And Layer2 contains your moving elements, or active objects. Then you can simply make a call to Layer2.draw()

To add the complexity, you have a group of objects, lets say all menu items. When a user presses any menu btn, its better to call menuGroup.draw() rather than the draw function of the its parent layer.

Tags

Recent Questions

Top Questions

Home Tags Terms of Service Privacy Policy DMCA Contact Us

©2020 All rights reserved.