Class type C-PIXI.displayObject

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Setting to false will prevent any children inside this container to be accessible. Defaults to true

Setting to false will prevent any children inside this container to be accessible. Defaults to true

Sets the aria-label attribute of the shadow div

Sets the aria-label attribute of the shadow div

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'displayObject tabIndex'

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'displayObject tabIndex'

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

The opacity of the object.

The opacity of the object.

The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees

The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees

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'.

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'.

Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to false

IMPORTANT GOTCHA - Make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to false

IMPORTANT GOTCHA - Make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

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

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

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

Also works as an interaction mask.

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

Also works as an interaction mask.

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'.

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.

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.

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

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

Does any other displayObject use this object as a mask?

used to fast check if a sprite is.. a sprite!

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 PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities shape clipping. To remove a mask, set this property to null.

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

deprecated

consider using PIXI.DisplayObject.getMask for PIXI.Graphics | PIXI.Sprite | null support

see /bs-pixi/PIXI/DisplayObject-PIXI/#val-getMask

DisplayObject.getMask

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 PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities shape clipping. To remove a mask, set this property to null.

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

deprecated

consider using PIXI.DisplayObject.getMask for PIXI.Graphics | PIXI.Sprite | null support

see /bs-pixi/PIXI/DisplayObject-PIXI/#val-getMask

DisplayObject.getMask

The instance name of the object.

The instance name of the object.

The display object container that contains this display object.

The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.

The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.

The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.

The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.

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.

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.

The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

The scale factor of the object. Assignment by value since pixi-v4.

The scale factor of the object. Assignment by value since pixi-v4.

The skew factor for the object in radians. Assignment by value since pixi-v4.

The skew factor for the object in radians. Assignment by value since pixi-v4.

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.

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.

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.

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.

The multiplied alpha of the displayObject.

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

Indicates if the object is globally visible.

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

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

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

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

The zIndex of the displayObject. If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other displayObjects within the same container.

The zIndex of the displayObject. If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other displayObjects within the same container.

Recursively updates transform of all objects from the root to this one internal function for toLocal()

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().

Retrieves the bounds of the displayObject as a rectangle object.

parameter skipUpdate

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.

parameter rect

Optional rectangle to store the result of the bounds calculation.

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

Retrieves the local bounds of the displayObject as a rectangle object

Set the parent Container of this DisplayObject.

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

parameter x

Position on the x axis

parameter y

Position on the y axis

parameter pivotX

Pivot on the x axis

parameter pivotY

Pivot on the y axis

parameter scaleX

Scale on the x axis

parameter scaleY

Scale on the y axis

parameter rotation

rotation in radians

parameter skewX

Skew on the x axis

parameter skewY

Skew on the y axis

parameter pivotX

The X pivot value

parameter pivotY

The Y pivot value

returns

This display object

Calculates the global position of the display object

parameter position

The world origin to calculate from

parameter from

(optional) The DisplayObject to calculate the global position from

parameter point

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

parameter skipUpdate

Should we skip the update transform

returns

A point object representing the position of this object

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

parameter position

The world origin to calculate from

parameter from

(optional) The DisplayObject to calculate the global position from

parameter point

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

parameter skipUpdate

Should we skip the update transform

returns

A point object representing the position of this object

Updates the object transform for rendering