Class: DisplayObject

Tiny. DisplayObject

The base class for all objects that are rendered on the screen.
This is an abstract class and should not be used on its own rather it should be extended.

new Tiny.DisplayObject()

Extends

  • EventEmitter

Members

alphanumber

The opacity of the object.

buttonModeboolean

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive
Setting this changes the 'cursor' property to 'pointer'.

Example
const sprite = new Tiny.Sprite(texture);
sprite.interactive = true;
sprite.buttonMode = true;

cursorstring

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

See:
Example
const sprite = new Tiny.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

filterAreaTiny.Rectangle

The area the filter is applied to. This is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Also works as an interaction mask

filtersarray.<Tiny.Filter>

Sets the filters for the displayObject.

  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
    To remove filters simply set this property to 'null'

Interaction shape. Children will be hit first, then this shape will be checked.
Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.

Example
const sprite = new Tiny.Sprite(texture);
sprite.interactive = true;
sprite.hitArea = new Tiny.Rectangle(0, 0, 100, 100);

interactiveboolean

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

Example
const sprite = new Tiny.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

readonlylocalTransformTiny.Matrix

Current transform of the object based on local factors: position, scale, other stuff

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In Tiny a regular mask must be a Tiny.Graphics or a Tiny.Sprite object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

namestring

The instance name of the object.

readonlyparentTiny.Container

The display object container that contains this display object.

The pivot point of the displayObject that it rotates around

The coordinate of the object relative to the local coordinates of the parent.

renderableboolean

Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually

rotationnumber

The rotation of the object in radians.

The scale factor of the object.

The skew factor for the object in radians.

World transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing

visibleboolean

The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformTiny.Matrix

Current transform of the object based on world (parent) factors

readonlyworldVisibleboolean

Indicates if the object is globally visible.

xnumber

The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x

ynumber

The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y

Methods

Base destroy method for generic display objects. This will automatically remove the display object from its parent Container as well as remove all current event listeners and internal references. Do not use a DisplayObject after calling destroy.

getBounds(skipUpdate, rect){Tiny.Rectangle}

Retrieves the bounds of the displayObject as a rectangle object.

Name Type Description
skipUpdate boolean

setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you nice performance boost

rect Tiny.Rectangle

Optional rectangle to store the result of the bounds calculation

Returns:
Type Description
Tiny.Rectangle the rectangular bounding area

Returns the display object in the container

Name Type Description
name string

instance name

Returns:
Type Description
Tiny.DisplayObject The child with the specified name.

getGlobalPosition(point, skipUpdate){Tiny.Point}

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Name Type Default Description
point Tiny.Point

the point to write the global value to. If null a new point will be returned

skipUpdate boolean false

setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost

Returns:
Type Description
Tiny.Point The updated point

Retrieves the local bounds of the displayObject as a rectangle object

Name Type Description
rect Tiny.Rectangle optional

Optional rectangle to store the result of the bounds calculation

Returns:
Type Description
Tiny.Rectangle the rectangular bounding area

getNature(){object}

获取对象的属性:x, y, angle, rotation, visible, alpha, scaleX, scaleY, skewX, skewY, colorR, colorG, colorB

Returns:
Type Description
object

getOpacity(){number}

Returns:
Type Description
number

getPivot(){number}

Returns:
Type Description
number

getPosition(){object}

Returns:
Type Description
object

getPositionX(){number}

Returns:
Type Description
number

getPositionY(){number}

Returns:
Type Description
number

getRotation(){number}

Returns:
Type Description
number

getScale(){object}

Returns:
Type Description
object
Version:
  • 1.1.0
Returns:
Type Description
object

getVisible(){boolean}

Returns:
Type Description
boolean

Renders the object using the Canvas renderer

Name Type Description
renderer Tiny.CanvasRenderer

The renderer

Renders the object using the WebGL renderer

Name Type Description
renderer Tiny.WebGLRenderer

The renderer

设置是否可交互

Name Type Description
b boolean
Name Type Description
alpha number

Set the parent Container of this DisplayObject

Name Type Description
container Tiny.Container

The Container to add this DisplayObject to

Returns:
Type Description
Tiny.Container The Container that this DisplayObject was added to
Name Type Description
x number
y number
Name Type Description
x number
y number
Name Type Description
x number
Name Type Description
y number
Name Type Description
rotation number
Name Type Description
x number
y number
Name Type Description
x number
y number
Version:
  • 1.1.0

setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){Tiny.DisplayObject}

Convenience function to set the position, scale, skew and pivot at once.

Name Type Default Description
x number 0 optional

The X position

y number 0 optional

The Y position

scaleX number 1 optional

The X scale value

scaleY number 1 optional

The Y scale value

rotation number 0 optional

The rotation

skewX number 0 optional

The X skew value

skewY number 0 optional

The Y skew value

pivotX number 0 optional

The X pivot value

pivotY number 0 optional

The Y pivot value

Returns:
Type Description
Tiny.DisplayObject The DisplayObject instance
Name Type Description
visible boolean

toGlobal(position, point, skipUpdate){Tiny.Point}

Calculates the global position of the display object

Name Type Default Description
position Tiny.Point

The world origin to calculate from

point Tiny.Point optional

A Point object in which to store the value, optional (otherwise will create a new Point)

skipUpdate boolean false optional

Should we skip the update transform.

Returns:
Type Description
Tiny.Point A point object representing the position of this object

toLocal(position, from, point, skipUpdate){Tiny.Point}

Calculates the local position of the display object relative to another point

Name Type Default Description
position Tiny.Point

The world origin to calculate from

from Tiny.DisplayObject optional

The DisplayObject to calculate the global position from

point Tiny.Point optional

A Point object in which to store the value, optional (otherwise will create a new Point)

skipUpdate boolean false optional

Should we skip the update transform

Returns:
Type Description
Tiny.Point A point object representing the position of this object

Updates the object transform for rendering

Events

Fired when this DisplayObject is added to a Container.

Name Type Description
container Tiny.Container

The container added to.

Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved while over the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved off the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved onto the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when the operating system cancels a pointer event.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is pressed on the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved while over the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved off the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved onto the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is pressed and released on the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is released over the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is released outside the display object that initially registered a pointerdown.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when this DisplayObject is removed from a Container.

Name Type Description
container Tiny.Container

The container removed from.

Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a touch point is placed and removed from the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when the operating system cancels a touch.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a touch point is removed from the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a touch point is removed outside of the display object that initially registered a touchstart.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a touch point is moved along the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Fired when a touch point is placed on the display object.
DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event Tiny.interaction.InteractionEvent

Interaction event

Documentation generated by JSDoc 3.4.3 on Mon Dec 03 2018 17:48:51 GMT+0800 (CST)