Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-16 14:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Removed the Quad Game Object. Mesh can do it better now.

Browse source
This commit is contained in:
Richard Davey 2020-10-06 10:16:46 +01:00
parent 975d25265b
commit 816c45937d
3 changed files with 0 additions and 739 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

655
src/gameobjects/quad/Quad.js
View file

@ -1,655 +0,0 @@
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var Class = require('../../utils/Class');
var Layer3D = require('../layer3d/Layer3D');
/**
* @classdesc
* A Quad Game Object.
*
* A Quad is a Mesh Game Object pre-configured with two triangles arranged into a rectangle, with a single
* texture spread across them.
*
* You can manipulate the corner points of the quad via the getters and setters such as `topLeftX`, and also
* change their alpha and color values. The quad itself can be moved by adjusting the `x` and `y` properties.
*
* @class Quad
* @extends Phaser.GameObjects.Layer3D
* @memberof Phaser.GameObjects
* @constructor
* @webglOnly
* @since 3.0.0
*
* @param {Phaser.Scene} scene - The Scene to which this Quad belongs.
* @param {number} x - The horizontal position of this Game Object in the world.
* @param {number} y - The vertical position of this Game Object in the world.
* @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
*/
var Quad = new Class({
Extends: Layer3D,
initialize:
function Quad (scene, x, y, texture, frame)
{
// 0----3
// |\ B|
// | \ |
// | \ |
// | A \|
// | \
// 1----2
var vertices = [
0, 0, // tl
0, 0, // bl
0, 0, // br
0, 0, // tl
0, 0, // br
0, 0 // tr
];
var uv = [
0, 0, // tl
0, 1, // bl
1, 1, // br
0, 0, // tl
1, 1, // br
1, 0 // tr
];
var colors = [
0xffffff, // tl
0xffffff, // bl
0xffffff, // br
0xffffff, // tl
0xffffff, // br
0xffffff // tr
];
var alphas = [
1, // tl
1, // bl
1, // br
1, // tl
1, // br
1 // tr
];
Layer3D.call(this, scene, x, y, vertices, uv, colors, alphas, texture, frame);
this.resetPosition();
},
/**
* Sets the frame this Game Object will use to render with.
*
* The Frame has to belong to the current Texture being used.
*
* It can be either a string or an index.
*
* Calling `setFrame` will modify the `width` and `height` properties of your Game Object.
* It will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.
*
* @method Phaser.GameObjects.Quad#setFrame
* @since 3.11.0
*
* @param {(string|integer)} frame - The name or index of the frame within the Texture.
*
* @return {this} This Game Object instance.
*/
setFrame: function (frame)
{
this.frame = this.texture.get(frame);
if (!this.frame.cutWidth || !this.frame.cutHeight)
{
this.renderFlags &= ~8;
}
else
{
this.renderFlags |= 8;
}
frame = this.frame;
// TL
this.uv[0] = frame.u0;
this.uv[1] = frame.v0;
// BL
this.uv[2] = frame.u0;
this.uv[3] = frame.v1;
// BR
this.uv[4] = frame.u1;
this.uv[5] = frame.v1;
// TL
this.uv[6] = frame.u0;
this.uv[7] = frame.v0;
// BR
this.uv[8] = frame.u1;
this.uv[9] = frame.v1;
// TR
this.uv[10] = frame.u1;
this.uv[11] = frame.v0;
return this;
},
/**
* The top-left x vertex of this Quad.
*
* @name Phaser.GameObjects.Quad#topLeftX
* @type {number}
* @since 3.0.0
*/
topLeftX: {
get: function ()
{
return this.x + this.vertices[0];
},
set: function (value)
{
this.vertices[0] = value - this.x;
this.vertices[6] = value - this.x;
}
},
/**
* The top-left y vertex of this Quad.
*
* @name Phaser.GameObjects.Quad#topLeftY
* @type {number}
* @since 3.0.0
*/
topLeftY: {
get: function ()
{
return this.y + this.vertices[1];
},
set: function (value)
{
this.vertices[1] = value - this.y;
this.vertices[7] = value - this.y;
}
},
/**
* The top-right x vertex of this Quad.
*
* @name Phaser.GameObjects.Quad#topRightX
* @type {number}
* @since 3.0.0
*/
topRightX: {
get: function ()
{
return this.x + this.vertices[10];
},
set: function (value)
{
this.vertices[10] = value - this.x;
}
},
/**
* The top-right y vertex of this Quad.
*
* @name Phaser.GameObjects.Quad#topRightY
* @type {number}
* @since 3.0.0
*/
topRightY: {
get: function ()
{
return this.y + this.vertices[11];
},
set: function (value)
{
this.vertices[11] = value - this.y;
}
},
/**
* The bottom-left x vertex of this Quad.
*
* @name Phaser.GameObjects.Quad#bottomLeftX
* @type {number}
* @since 3.0.0
*/
bottomLeftX: {
get: function ()
{
return this.x + this.vertices[2];
},
set: function (value)
{
this.vertices[2] = value - this.x;
}
},
/**
* The bottom-left y vertex of this Quad.
*
* @name Phaser.GameObjects.Quad#bottomLeftY
* @type {number}
* @since 3.0.0
*/
bottomLeftY: {
get: function ()
{
return this.y + this.vertices[3];
},
set: function (value)
{
this.vertices[3] = value - this.y;
}
},
/**
* The bottom-right x vertex of this Quad.
*
* @name Phaser.GameObjects.Quad#bottomRightX
* @type {number}
* @since 3.0.0
*/
bottomRightX: {
get: function ()
{
return this.x + this.vertices[4];
},
set: function (value)
{
this.vertices[4] = value - this.x;
this.vertices[8] = value - this.x;
}
},
/**
* The bottom-right y vertex of this Quad.
*
* @name Phaser.GameObjects.Quad#bottomRightY
* @type {number}
* @since 3.0.0
*/
bottomRightY: {
get: function ()
{
return this.y + this.vertices[5];
},
set: function (value)
{
this.vertices[5] = value - this.y;
this.vertices[9] = value - this.y;
}
},
/**
* The top-left alpha value of this Quad.
*
* @name Phaser.GameObjects.Quad#topLeftAlpha
* @type {number}
* @since 3.0.0
*/
topLeftAlpha: {
get: function ()
{
return this.alphas[0];
},
set: function (value)
{
this.alphas[0] = value;
this.alphas[3] = value;
}
},
/**
* The top-right alpha value of this Quad.
*
* @name Phaser.GameObjects.Quad#topRightAlpha
* @type {number}
* @since 3.0.0
*/
topRightAlpha: {
get: function ()
{
return this.alphas[5];
},
set: function (value)
{
this.alphas[5] = value;
}
},
/**
* The bottom-left alpha value of this Quad.
*
* @name Phaser.GameObjects.Quad#bottomLeftAlpha
* @type {number}
* @since 3.0.0
*/
bottomLeftAlpha: {
get: function ()
{
return this.alphas[1];
},
set: function (value)
{
this.alphas[1] = value;
}
},
/**
* The bottom-right alpha value of this Quad.
*
* @name Phaser.GameObjects.Quad#bottomRightAlpha
* @type {number}
* @since 3.0.0
*/
bottomRightAlpha: {
get: function ()
{
return this.alphas[2];
},
set: function (value)
{
this.alphas[2] = value;
this.alphas[4] = value;
}
},
/**
* The top-left color value of this Quad.
*
* @name Phaser.GameObjects.Quad#topLeftColor
* @type {number}
* @since 3.0.0
*/
topLeftColor: {
get: function ()
{
return this.colors[0];
},
set: function (value)
{
this.colors[0] = value;
this.colors[3] = value;
}
},
/**
* The top-right color value of this Quad.
*
* @name Phaser.GameObjects.Quad#topRightColor
* @type {number}
* @since 3.0.0
*/
topRightColor: {
get: function ()
{
return this.colors[5];
},
set: function (value)
{
this.colors[5] = value;
}
},
/**
* The bottom-left color value of this Quad.
*
* @name Phaser.GameObjects.Quad#bottomLeftColor
* @type {number}
* @since 3.0.0
*/
bottomLeftColor: {
get: function ()
{
return this.colors[1];
},
set: function (value)
{
this.colors[1] = value;
}
},
/**
* The bottom-right color value of this Quad.
*
* @name Phaser.GameObjects.Quad#bottomRightColor
* @type {number}
* @since 3.0.0
*/
bottomRightColor: {
get: function ()
{
return this.colors[2];
},
set: function (value)
{
this.colors[2] = value;
this.colors[4] = value;
}
},
/**
* Sets the top-left vertex position of this Quad.
*
* @method Phaser.GameObjects.Quad#setTopLeft
* @since 3.0.0
*
* @param {number} x - The horizontal coordinate of the vertex.
* @param {number} y - The vertical coordinate of the vertex.
*
* @return {this} This Game Object.
*/
setTopLeft: function (x, y)
{
this.topLeftX = x;
this.topLeftY = y;
return this;
},
/**
* Sets the top-right vertex position of this Quad.
*
* @method Phaser.GameObjects.Quad#setTopRight
* @since 3.0.0
*
* @param {number} x - The horizontal coordinate of the vertex.
* @param {number} y - The vertical coordinate of the vertex.
*
* @return {this} This Game Object.
*/
setTopRight: function (x, y)
{
this.topRightX = x;
this.topRightY = y;
return this;
},
/**
* Sets the bottom-left vertex position of this Quad.
*
* @method Phaser.GameObjects.Quad#setBottomLeft
* @since 3.0.0
*
* @param {number} x - The horizontal coordinate of the vertex.
* @param {number} y - The vertical coordinate of the vertex.
*
* @return {this} This Game Object.
*/
setBottomLeft: function (x, y)
{
this.bottomLeftX = x;
this.bottomLeftY = y;
return this;
},
/**
* Sets the bottom-right vertex position of this Quad.
*
* @method Phaser.GameObjects.Quad#setBottomRight
* @since 3.0.0
*
* @param {number} x - The horizontal coordinate of the vertex.
* @param {number} y - The vertical coordinate of the vertex.
*
* @return {this} This Game Object.
*/
setBottomRight: function (x, y)
{
this.bottomRightX = x;
this.bottomRightY = y;
return this;
},
/**
* Resets the positions of the four corner vertices of this Quad.
*
* @method Phaser.GameObjects.Quad#resetPosition
* @since 3.0.0
*
* @return {this} This Game Object.
*/
resetPosition: function ()
{
var x = this.x;
var y = this.y;
var halfWidth = Math.floor(this.width / 2);
var halfHeight = Math.floor(this.height / 2);
this.setTopLeft(x - halfWidth, y - halfHeight);
this.setTopRight(x + halfWidth, y - halfHeight);
this.setBottomLeft(x - halfWidth, y + halfHeight);
this.setBottomRight(x + halfWidth, y + halfHeight);
return this;
},
/**
* Resets the alpha values used by this Quad back to 1.
*
* @method Phaser.GameObjects.Quad#resetAlpha
* @since 3.0.0
*
* @return {this} This Game Object.
*/
resetAlpha: function ()
{
var alphas = this.alphas;
alphas[0] = 1;
alphas[1] = 1;
alphas[2] = 1;
alphas[3] = 1;
alphas[4] = 1;
alphas[5] = 1;
return this;
},
/**
* Resets the color values used by this Quad back to 0xffffff.
*
* @method Phaser.GameObjects.Quad#resetColors
* @since 3.0.0
*
* @return {this} This Game Object.
*/
resetColors: function ()
{
var colors = this.colors;
colors[0] = 0xffffff;
colors[1] = 0xffffff;
colors[2] = 0xffffff;
colors[3] = 0xffffff;
colors[4] = 0xffffff;
colors[5] = 0xffffff;
return this;
},
/**
* Resets the position, alpha and color values used by this Quad.
*
* @method Phaser.GameObjects.Quad#reset
* @since 3.0.0
*
* @return {this} This Game Object.
*/
reset: function ()
{
this.resetPosition();
this.resetAlpha();
return this.resetColors();
}
});
module.exports = Quad;

44
src/gameobjects/quad/QuadCreator.js
View file

@ -1,44 +0,0 @@
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var BuildGameObject = require('../BuildGameObject');
var GameObjectCreator = require('../GameObjectCreator');
var GetAdvancedValue = require('../../utils/object/GetAdvancedValue');
var Quad = require('./Quad');
/**
* Creates a new Quad Game Object and returns it.
*
* Note: This method will only be available if the Quad Game Object and WebGL support have been built into Phaser.
*
* @method Phaser.GameObjects.GameObjectCreator#quad
* @since 3.0.0
*
* @param {object} config - The configuration object this Game Object will use to create itself.
* @param {boolean} [addToScene] - Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.
*
* @return {Phaser.GameObjects.Quad} The Game Object that was created.
*/
GameObjectCreator.register('quad', function (config, addToScene)
{
if (config === undefined) { config = {}; }
var x = GetAdvancedValue(config, 'x', 0);
var y = GetAdvancedValue(config, 'y', 0);
var key = GetAdvancedValue(config, 'key', null);
var frame = GetAdvancedValue(config, 'frame', null);
var quad = new Quad(this.scene, x, y, key, frame);
if (addToScene !== undefined)
{
config.add = addToScene;
}
BuildGameObject(this.scene, quad, config);
return quad;
});

40
src/gameobjects/quad/QuadFactory.js
View file

@ -1,40 +0,0 @@
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2020 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var Quad = require('./Quad');
var GameObjectFactory = require('../GameObjectFactory');
/**
* Creates a new Quad Game Object and adds it to the Scene.
*
* Note: This method will only be available if the Quad Game Object and WebGL support have been built into Phaser.
*
* @method Phaser.GameObjects.GameObjectFactory#quad
* @webglOnly
* @since 3.0.0
*
* @param {number} x - The horizontal position of this Game Object in the world.
* @param {number} y - The vertical position of this Game Object in the world.
* @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
*
* @return {Phaser.GameObjects.Quad} The Game Object that was created.
*/
if (typeof WEBGL_RENDERER)
{
GameObjectFactory.register('quad', function (x, y, key, frame)
{
return this.displayList.add(new Quad(this.scene, x, y, key, frame));
});
}
// When registering a factory function 'this' refers to the GameObjectFactory context.
//
// There are several properties available to use:
//
// this.scene - a reference to the Scene that owns the GameObjectFactory
// this.displayList - a reference to the Display List the Scene owns
// this.updateList - a reference to the Update List the Scene owns