import Picture from 'newton-lib/src/elements/Picture.js'

public class | source

Picture

Extends:

WorldElement → Picture

The Picture class is used to draw images on the screen. Extra attention must be made when waiting for the image to load.

Constructor Summary

Public Constructor
public	constructor(path: string, opts: object)

Member Summary

Public Members
public	height: number Height of the scaled image in units.
public	img: object Image object where picture will be loaded.
public	isDraggable: boolean Flag for allowing the picture to be dragged around.
public	loaded: boolean Flag for when the image has fully loaded.
public	pivot: object Sets the pivot point around which the picture is drawn.
public	width: number Width of the scaled image in units.

Method Summary

Public Methods
public	isLoaded(): boolean Tests if the image is fully loaded.

Private Methods
private	draw() Main draw function for the picture called by the World automatically.
private	isMouseOver(): boolean Tests if the mouse is over the picture.

Inherited Summary

From class WorldElement
public	color: string Sets the color in HEX format of the element.
public	cursor: string Sets the cursor style when the mouse is over the element.
public	display: boolean Flag for enabling or diabling this element.
public	dragging: boolean Flag set when the element is being dragged around.
public	font: Font Sets the font of the element.
public	height: number Sets the current height of the element.
public	isDraggable: boolean Flag for allowing the element to be dragged around.
public	mouseMoveStyle: string Sets the move style of the element.
public	mouseOver: boolean Flag set when the mouse is over the element.
public	onMouseMove: function Sets a callback function for when the element is dragged around.
public	position: object Sets the position of the element.
public	renderer: Renderer Sets the renderer used for the element.
public	rotation: number Sets the rotation of the element.
public	savedZIndex: number A copy of the z-index value is stored here.
public	scale: number Sets the drawing scale of the element.
public	topmostOnDrag: boolean Flag for determining if the element will be a top-most element when dragged around.
public	valid: boolean Flag used to determine if an object is a child of WorldElement.
public	width: number Sets the current width of the element.
public	world: World Sets the world where this element is found.
public	zIndex: number Sets the z-index of the element.
public	addPosition(x: number, y: number) Adds the provided coordinates to the position.
public	draggable(s: boolean) Sets if the element is draggable.
public	isMouseOver(): boolean Function called when the mouse moves to check if the pointer is over the element.
public	setColor(c: string) Sets the color in HEX format of the element.
public	setPosition(x: number, y: number) Sets the position of the element.
public	setScale(s: number) Sets the scale of the element.
public	setZ(z: number) Sets the z-index of the element.
private	resize() Function called when the canvas gets resized.
private	setWorld(world: World) Sets the world object where element will be drawn.
private	topmost(state: boolean) Sets the element as a topmost element.

Public Constructors

public constructor(path: string, opts: object) source

Override:

WorldElement#constructor

Params:

Name	Type	Attribute	Description
path	string		Path for the image.
opts	object	optional	Object that contains valid Picture properties with values. Their values will be assigned at the end of the constructor. If an invalid property is passed then the value will be ignored.