/** * @author Richard Davey * @copyright 2020 Photon Storm Ltd. * @license {@link https://opensource.org/licenses/MIT|MIT License} */ var Class = require('../../utils/Class'); var Components = require('./components'); var GameObject = require('../../gameobjects/GameObject'); var GetFastValue = require('../../utils/object/GetFastValue'); var Image = require('../../gameobjects/image/Image'); var Pipeline = require('../../gameobjects/components/Pipeline'); var Vector2 = require('../../math/Vector2'); /** * @classdesc * A Matter Physics Image Game Object. * * An Image is a light-weight Game Object useful for the display of static images in your game, * such as logos, backgrounds, scenery or other non-animated elements. Images can have input * events and physics bodies, or be tweened, tinted or scrolled. The main difference between an * Image and a Sprite is that you cannot animate an Image as they do not have the Animation component. * * @class Image * @extends Phaser.GameObjects.Image * @memberof Phaser.Physics.Matter * @constructor * @since 3.0.0 * * @extends Phaser.Physics.Matter.Components.Bounce * @extends Phaser.Physics.Matter.Components.Collision * @extends Phaser.Physics.Matter.Components.Force * @extends Phaser.Physics.Matter.Components.Friction * @extends Phaser.Physics.Matter.Components.Gravity * @extends Phaser.Physics.Matter.Components.Mass * @extends Phaser.Physics.Matter.Components.Sensor * @extends Phaser.Physics.Matter.Components.SetBody * @extends Phaser.Physics.Matter.Components.Sleep * @extends Phaser.Physics.Matter.Components.Static * @extends Phaser.Physics.Matter.Components.Transform * @extends Phaser.Physics.Matter.Components.Velocity * @extends Phaser.GameObjects.Components.Alpha * @extends Phaser.GameObjects.Components.BlendMode * @extends Phaser.GameObjects.Components.Depth * @extends Phaser.GameObjects.Components.Flip * @extends Phaser.GameObjects.Components.GetBounds * @extends Phaser.GameObjects.Components.Origin * @extends Phaser.GameObjects.Components.Pipeline * @extends Phaser.GameObjects.Components.ScrollFactor * @extends Phaser.GameObjects.Components.Size * @extends Phaser.GameObjects.Components.Texture * @extends Phaser.GameObjects.Components.Tint * @extends Phaser.GameObjects.Components.Transform * @extends Phaser.GameObjects.Components.Visible * * @param {Phaser.Physics.Matter.World} world - A reference to the Matter.World instance that this body belongs to. * @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|number)} [frame] - An optional frame from the Texture this Game Object is rendering with. * @param {Phaser.Types.Physics.Matter.MatterBodyConfig} [options] - An optional Body configuration object that is used to set initial Body properties on creation. */ var MatterImage = new Class({ Extends: Image, Mixins: [ Components.Bounce, Components.Collision, Components.Force, Components.Friction, Components.Gravity, Components.Mass, Components.Sensor, Components.SetBody, Components.Sleep, Components.Static, Components.Transform, Components.Velocity, Pipeline ], initialize: function MatterImage (world, x, y, texture, frame, options) { GameObject.call(this, world.scene, 'Image'); /** * The internal crop data object, as used by `setCrop` and passed to the `Frame.setCropUVs` method. * * @name Phaser.Physics.Matter.Image#_crop * @type {object} * @private * @since 3.24.0 */ this._crop = this.resetCropObject(); this.setTexture(texture, frame); this.setSizeToFrame(); this.setOrigin(); /** * A reference to the Matter.World instance that this body belongs to. * * @name Phaser.Physics.Matter.Image#world * @type {Phaser.Physics.Matter.World} * @since 3.0.0 */ this.world = world; /** * An internal temp vector used for velocity and force calculations. * * @name Phaser.Physics.Matter.Image#_tempVec2 * @type {Phaser.Math.Vector2} * @private * @since 3.0.0 */ this._tempVec2 = new Vector2(x, y); var shape = GetFastValue(options, 'shape', null); if (shape) { this.setBody(shape, options); } else { this.setRectangle(this.width, this.height, options); } this.setPosition(x, y); this.initPipeline(); } }); module.exports = MatterImage;