-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdisplay_Graphics.js.html
380 lines (334 loc) · 18.7 KB
/
display_Graphics.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: display/Graphics.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: display/Graphics.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>//------------------------------------------------------------------------------
// Constructor scope
//------------------------------------------------------------------------------
/**
* Creates a new instance of the Graphics class.
*
* @constructor
*
* @param {rune.display.DisplayObject} obj The display object to which the class is linked.
*
* @class
* @classdesc
*
* The Graphics class represents a programmable interface (API) for drawing
* raster graphics to a display object. The class includes a set of methods for
* drawing raster shapes and copying pixels from bitmaps. Note that drawing
* commands addressed to the Graphics class must be made from the application's
* update loop, as drawing commands are queued and executed automatically via
* the rendering loop.
*/
rune.display.Graphics = function(obj) {
//--------------------------------------------------------------------------
// Public properties
//--------------------------------------------------------------------------
/**
* Whether the object should clear its rendering queue after it has
* completed its rendering of the current queue. By default, the queue is
* preserved, which results in drawn graphics remaining until it is
* manually cleared, or changed via new drawing commands.
*
* @type {boolean}
* @default false
*/
this.autoClear = false;
//--------------------------------------------------------------------------
// Private properties
//--------------------------------------------------------------------------
/**
* The display object that the drawing API is connected to, ie where
* graphics are drawn when drawing commands are called.
*
* @type {rune.display.DisplayObject}
* @private
*/
this.m_displayObject = obj;
/**
* Queue list for drawing commands.
*
* @type {rune.util.Stack}
* @private
*/
this.m_queue = null;
//--------------------------------------------------------------------------
// Constructor call
//--------------------------------------------------------------------------
/**
* Invokes secondary class constructor.
*/
this.m_construct();
};
//------------------------------------------------------------------------------
// Public prototype getter and setter methods
//------------------------------------------------------------------------------
/**
* Returns the number of drawing calls queued in the Graphics object. If the
* result is 0, no graphics are drawn by the API.
*
* @member {number} numOperations
* @memberof rune.display.Graphics
* @instance
* @readonly
*/
Object.defineProperty(rune.display.Graphics.prototype, "numOperations", {
/**
* @this rune.display.Graphics
* @ignore
*/
get: function() {
return this.m_queue['length'];
}
});
//------------------------------------------------------------------------------
// Public prototype methods (API)
//------------------------------------------------------------------------------
/**
* Clears the graphics that were drawn with this Graphics object.
*
* @returns {undefined}
*/
rune.display.Graphics.prototype.clear = function() {
this.m_queue.clear();
};
/**
* Draws a circular arc centered at (x, y) with a radius of r. The path starts
* at sa, ends at ea, and travels in the direction given by counterclockwise
* (defaulting to clockwise).
*
* @param {number} x The horizontal coordinate of the arc's center.
* @param {number} y The vertical coordinate of the arc's center.
* @param {number} r The arc's radius. Must be positive.
* @param {number} sa The angle at which the arc starts in radians, measured from the positive x-axis.
* @param {number} ea The angle at which the arc ends in radians, measured from the positive x-axis.
* @param {string} c The color of the line.
* @param {number} s The thickness (size) of the line.
* @param {number} [a] An optional boolean value. If true, draws the arc counter-clockwise between the start and end angles. The default is false (clockwise).
*
* @returns {undefined}
*/
rune.display.Graphics.prototype.drawArc = function(x, y, r, sa, ea, c, s, a) {
if (this.m_displayObject != null) {
this.m_displayObject.breakCache();
var scope = this.m_displayObject["canvas"];
this.m_queue.add(scope.drawArc, scope, [x, y, r, sa, ea, c, s, a]);
}
};
/**
* Draw fill color.
*
* @param {string} c Fill color, specified as a DOMString.
*
* @returns {undefined}
*/
rune.display.Graphics.prototype.drawFill = function(c) {
if (this.m_displayObject != null) {
this.m_displayObject.breakCache();
var scope = this.m_displayObject["canvas"];
this.m_queue.add(scope.drawFill, scope, [c]);
}
};
/**
* Draw a (32-bit) bitmap image.
*
* @param {HTMLImageElement} img Image to draw.
* @param {number} ox Image x position.
* @param {number} oy Image y position.
* @param {number} ow Image width.
* @param {number} oh Image height.
* @param {number} [cx] Crop x position.
* @param {number} [cy] Crop y position.
* @param {number} [cw] Crop width.
* @param {number} [ch] Crop height.
*
* @returns {undefined}
*/
rune.display.Graphics.prototype.drawImage = function(img, ox, oy, ow, oh, cx, cy, cw, ch) {
if (this.m_displayObject != null) {
this.m_displayObject.breakCache();
var scope = this.m_displayObject["canvas"];
this.m_queue.add(scope.drawImage, scope, [img, ox, oy, ow, oh, cx, cy, cw, ch]);
}
};
/**
* Draw with a picture as a flood filling.
*
* @param {HTMLImageElement} img Image to draw.
* @param {number} x Image x position.
* @param {number} y Image y position.
* @param {number} w Image width.
* @param {number} h Image height.
*
* @returns {undefined}
*/
rune.display.Graphics.prototype.drawImageFill = function(img, x, y, w, h) {
if (this.m_displayObject != null) {
this.m_displayObject.breakCache();
var scope = this.m_displayObject["canvas"];
this.m_queue.add(scope.drawImageFill, scope, [img, x, y, w, h]);
}
};
/**
* Draw a line.
*
* @param {number} x1 Start x position.
* @param {number} y1 Start y position.
* @param {number} x2 End x position.
* @param {number} y2 End y position.
* @param {string} c Line color.
* @param {number} s Line thickness.
*
* @returns {undefined}
*/
rune.display.Graphics.prototype.drawLine = function(x1, y1, x2, y2, c, s) {
if (this.m_displayObject != null) {
this.m_displayObject.breakCache();
var scope = this.m_displayObject["canvas"];
this.m_queue.add(scope.drawLine, scope, [x1, y1, x2, y2, c, s]);
}
};
/**
* Draw a rectangle.
*
* @param {number} x The x position of the upper left corner of the rectangle.
* @param {number} y The y position of the upper left corner of the rectangle.
* @param {number} w The width of the rectangle.
* @param {number} h The height of the rectangle.
* @param {string} c Line color.
* @param {number} s Line thickness.
*
* @returns {undefined}
*/
rune.display.Graphics.prototype.drawRect = function(x, y, w, h, c, s) {
if (this.m_displayObject != null) {
this.m_displayObject.breakCache();
var scope = this.m_displayObject["canvas"];
this.m_queue.add(scope.drawRect, scope, [x, y, w, h, c, s]);
}
};
/**
* Draw a filled rectangle.
*
* @param {number} x The x position of the upper left corner of the rectangle.
* @param {number} y The y position of the upper left corner of the rectangle.
* @param {number} w The width of the rectangle.
* @param {number} h The height of the rectangle.
* @param {string} c Fill color.
*
* @returns {undefined}
*/
rune.display.Graphics.prototype.drawRectFill = function(x, y, w, h, c) {
if (this.m_displayObject != null) {
this.m_displayObject.breakCache();
var scope = this.m_displayObject["canvas"];
this.m_queue.add(scope.drawRectFill, scope, [x, y, w, h, c]);
}
};
//------------------------------------------------------------------------------
// Internal prototype methods (ENGINE)
//------------------------------------------------------------------------------
/**
* Free up resources allocated by the object.
*
* @returns {undefined}
* @package
* @ignore
*/
rune.display.Graphics.prototype.dispose = function() {
this.m_disposeQueue();
};
/**
* Renders graphics.
*
* @returns {undefined}
* @package
* @ignore
*/
rune.display.Graphics.prototype.render = function() {
this.m_renderQueue();
if (this.autoClear == true) {
this.clear();
}
};
//------------------------------------------------------------------------------
// Protected prototype methods
//------------------------------------------------------------------------------
/**
* The class constructor.
*
* @returns {undefined}
* @protected
* @ignore
*/
rune.display.Graphics.prototype.m_construct = function() {
this.m_constructQueue();
};
//------------------------------------------------------------------------------
// Private prototype methods
//------------------------------------------------------------------------------
/**
* Creates the object that represents the queue of draw commands.
*
* @returns {undefined}
* @private
*/
rune.display.Graphics.prototype.m_constructQueue = function() {
this.m_disposeQueue();
if (this.m_queue == null) {
this.m_queue = new rune.util.Stack();
}
};
/**
* Renders the drawing commands added to the object's queue list.
*
* @returns {undefined}
* @private
*/
rune.display.Graphics.prototype.m_renderQueue = function() {
if (this.m_queue != null) {
this.m_queue.execute();
}
};
/**
* Removes and frees memory allocated by the queue list.
*
* @returns {undefined}
* @private
*/
rune.display.Graphics.prototype.m_disposeQueue = function() {
if (this.m_queue instanceof rune.util.Stack) {
this.m_queue.dispose();
this.m_queue = null;
}
};</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="rune.html">rune</a></li><li><a href="rune.animation.html">animation</a></li><li><a href="rune.camera.html">camera</a></li><li><a href="rune.color.html">color</a></li><li><a href="rune.console.html">console</a></li><li><a href="rune.data.html">data</a></li><li><a href="rune.debug.html">debug</a></li><li><a href="rune.display.html">display</a></li><li><a href="rune.geom.html">geom</a></li><li><a href="rune.input.html">input</a></li><li><a href="rune.media.html">media</a></li><li><a href="rune.net.html">net</a></li><li><a href="rune.particle.html">particle</a></li><li><a href="rune.physics.html">physics</a></li><li><a href="rune.resource.html">resource</a></li><li><a href="rune.scene.html">scene</a></li><li><a href="rune.state.html">state</a></li><li><a href="rune.system.html">system</a></li><li><a href="rune.text.html">text</a></li><li><a href="rune.tilemap.html">tilemap</a></li><li><a href="rune.timer.html">timer</a></li><li><a href="rune.tween.html">tween</a></li><li><a href="rune.ui.html">ui</a></li><li><a href="rune.util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="rune.animation.Animation.html">Animation</a></li><li><a href="rune.animation.Animations.html">Animations</a></li><li><a href="rune.animation.AnimationScripts.html">AnimationScripts</a></li><li><a href="rune.camera.Camera.html">Camera</a></li><li><a href="rune.camera.CameraFade.html">CameraFade</a></li><li><a href="rune.camera.CameraFlash.html">CameraFlash</a></li><li><a href="rune.camera.Cameras.html">Cameras</a></li><li><a href="rune.camera.CameraShake.html">CameraShake</a></li><li><a href="rune.camera.CameraTargets.html">CameraTargets</a></li><li><a href="rune.camera.CameraTint.html">CameraTint</a></li><li><a href="rune.camera.CameraTintTween.html">CameraTintTween</a></li><li><a href="rune.camera.CameraViewport.html">CameraViewport</a></li><li><a href="rune.color.Color24.html">Color24</a></li><li><a href="rune.color.Color32.html">Color32</a></li><li><a href="rune.color.ColorComponent.html">ColorComponent</a></li><li><a href="rune.console.Console.html">Console</a></li><li><a href="rune.console.ConsoleCommand.html">ConsoleCommand</a></li><li><a href="rune.console.ConsoleCommands.html">ConsoleCommands</a></li><li><a href="rune.console.ConsoleCursor.html">ConsoleCursor</a></li><li><a href="rune.console.ConsoleHistory.html">ConsoleHistory</a></li><li><a href="rune.console.ConsoleInput.html">ConsoleInput</a></li><li><a href="rune.console.ConsoleManager.html">ConsoleManager</a></li><li><a href="rune.console.ConsoleOutput.html">ConsoleOutput</a></li><li><a href="rune.data.Highscores.html">Highscores</a></li><li><a href="rune.data.Loader.html">Loader</a></li><li><a href="rune.data.LoaderDebug.html">LoaderDebug</a></li><li><a href="rune.data.Logo.html">Logo</a></li><li><a href="rune.data.Requests.html">Requests</a></li><li><a href="rune.debug.Debugger.html">Debugger</a></li><li><a href="rune.debug.Framerate.html">Framerate</a></li><li><a href="rune.debug.Histogram.html">Histogram</a></li><li><a href="rune.debug.Master.html">Master</a></li><li><a href="rune.debug.Memory.html">Memory</a></li><li><a href="rune.debug.Music.html">Music</a></li><li><a href="rune.debug.Render.html">Render</a></li><li><a href="rune.debug.Sound.html">Sound</a></li><li><a href="rune.debug.Update.html">Update</a></li><li><a href="rune.display.Artboard.html">Artboard</a></li><li><a href="rune.display.Canvas.html">Canvas</a></li><li><a href="rune.display.DisplayGroup.html">DisplayGroup</a></li><li><a href="rune.display.DisplayGroups.html">DisplayGroups</a></li><li><a href="rune.display.DisplayObject.html">DisplayObject</a></li><li><a href="rune.display.DisplayObjectContainer.html">DisplayObjectContainer</a></li><li><a href="rune.display.Flicker.html">Flicker</a></li><li><a href="rune.display.Frame.html">Frame</a></li><li><a href="rune.display.Graphic.html">Graphic</a></li><li><a href="rune.display.Graphics.html">Graphics</a></li><li><a href="rune.display.Hitbox.html">Hitbox</a></li><li><a href="rune.display.InteractiveObject.html">InteractiveObject</a></li><li><a href="rune.display.Quadtree.html">Quadtree</a></li><li><a href="rune.display.RepeatedGraphic.html">RepeatedGraphic</a></li><li><a href="rune.display.Screen.html">Screen</a></li><li><a href="rune.display.Sprite.html">Sprite</a></li><li><a href="rune.display.Stage.html">Stage</a></li><li><a href="rune.display.Texture.html">Texture</a></li><li><a href="rune.geom.Point.html">Point</a></li><li><a href="rune.geom.Rectangle.html">Rectangle</a></li><li><a href="rune.geom.Vector2D.html">Vector2D</a></li><li><a href="rune.input.Gamepad.html">Gamepad</a></li><li><a href="rune.input.Gamepads.html">Gamepads</a></li><li><a href="rune.input.GamepadsOptions.html">GamepadsOptions</a></li><li><a href="rune.input.Inputs.html">Inputs</a></li><li><a href="rune.input.Keyboard.html">Keyboard</a></li><li><a href="rune.input.KeyboardKey.html">KeyboardKey</a></li><li><a href="rune.input.KeyboardOptions.html">KeyboardOptions</a></li><li><a href="rune.media.Sound.html">Sound</a></li><li><a href="rune.media.SoundChannel.html">SoundChannel</a></li><li><a href="rune.media.Sounds.html">Sounds</a></li><li><a href="rune.net.URLLoader.html">URLLoader</a></li><li><a href="rune.net.URLRequest.html">URLRequest</a></li><li><a href="rune.net.URLResponse.html">URLResponse</a></li><li><a href="rune.particle.Emitter.html">Emitter</a></li><li><a href="rune.particle.EmitterOptions.html">EmitterOptions</a></li><li><a href="rune.particle.Particle.html">Particle</a></li><li><a href="rune.physics.Space.html">Space</a></li><li><a href="rune.physics.Velocity.html">Velocity</a></li><li><a href="rune.resource.Request.html">Request</a></li><li><a href="rune.resource.Requester.html">Requester</a></li><li><a href="rune.resource.RequesterOptions.html">RequesterOptions</a></li><li><a href="rune.resource.Requests.html">Requests</a></li><li><a href="rune.resource.Resource.html">Resource</a></li><li><a href="rune.resource.Resources.html">Resources</a></li><li><a href="rune.scene.Scene.html">Scene</a></li><li><a href="rune.scene.Scenes.html">Scenes</a></li><li><a href="rune.state.State.html">State</a></li><li><a href="rune.state.States.html">States</a></li><li><a href="rune.system.Application.html">Application</a></li><li><a href="rune.system.Config.html">Config</a></li><li><a href="rune.system.Time.html">Time</a></li><li><a href="rune.text.BitmapField.html">BitmapField</a></li><li><a href="rune.text.BitmapFormat.html">BitmapFormat</a></li><li><a href="rune.tilemap.Block.html">Block</a></li><li><a href="rune.tilemap.Tile.html">Tile</a></li><li><a href="rune.tilemap.Tilemap.html">Tilemap</a></li><li><a href="rune.tilemap.TilemapLayer.html">TilemapLayer</a></li><li><a href="rune.timer.Timer.html">Timer</a></li><li><a href="rune.timer.TimerOptions.html">TimerOptions</a></li><li><a href="rune.timer.Timers.html">Timers</a></li><li><a href="rune.tween.Circular.html">Circular</a></li><li><a href="rune.tween.Cubic.html">Cubic</a></li><li><a href="rune.tween.Expo.html">Expo</a></li><li><a href="rune.tween.Linear.html">Linear</a></li><li><a href="rune.tween.Quad.html">Quad</a></li><li><a href="rune.tween.Quart.html">Quart</a></li><li><a href="rune.tween.Quint.html">Quint</a></li><li><a href="rune.tween.Sine.html">Sine</a></li><li><a href="rune.tween.Tween.html">Tween</a></li><li><a href="rune.tween.Tweens.html">Tweens</a></li><li><a href="rune.tween.TweenValue.html">TweenValue</a></li><li><a href="rune.ui.Counter.html">Counter</a></li><li><a href="rune.ui.CounterDigit.html">CounterDigit</a></li><li><a href="rune.ui.Progressbar.html">Progressbar</a></li><li><a href="rune.ui.VTList.html">VTList</a></li><li><a href="rune.ui.VTListElement.html">VTListElement</a></li><li><a href="rune.ui.VTMenu.html">VTMenu</a></li><li><a href="rune.ui.VTMenuPointer.html">VTMenuPointer</a></li><li><a href="rune.util.Executable.html">Executable</a></li><li><a href="rune.util.Filter.html">Filter</a></li><li><a href="rune.util.Math.html">Math</a></li><li><a href="rune.util.Palette.html">Palette</a></li><li><a href="rune.util.Path.html">Path</a></li><li><a href="rune.util.Paths.html">Paths</a></li><li><a href="rune.util.Stack.html">Stack</a></li><li><a href="rune.util.URL.html">URL</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue May 21 2024 09:43:50 GMT+0200 (Central European Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>