Class: DisplayObject

PIXI~DisplayObject

屏幕上渲染的所有对象的基类。

这是一个抽象类,不应单独使用。 而是应该扩展。

new DisplayObject ()

Extends

Members

_accessibleActive boolean

TODO
  • Needs docs.

_accessibleDiv boolean

TODO
  • Needs docs.

_bounds PIXI.Bounds

bounds对象,用于计算和存储displayObject的边界。

_boundsID number protected

TODO

_boundsRect PIXI.Bounds protected

TODO

_destroyed boolean protected

如果对象已通过destroy()销毁, 则为true,此属性不应被使用。

_enabledFilters Array.<PIXI.Filter> protected

当前启用的滤镜

_lastSortedIndex number protected

显示组件在子数组中的哪个索引在上一个zIndex排序之前。 由容器使用,通过使用前一个数组索引作为决策器,帮助对具有相同zIndex的对象进行排序。

_localBoundsRect PIXI.Bounds protected

TODO

_mask PIXI.Graphics | PIXI.Sprite | null protected

对象的原始缓存掩罩。

_tempDisplayObjectParent PIXI.Container protected

_zIndex number protected

displayObject的zIndex。 较高的值意味着它将呈现在同一容器中其他显示对象的顶部。

accessible boolean

标记对象是否可访问。 如果为true,AccessibilityManager将使用属性集覆盖阴影div

accessibleChildren boolean

设置为false将阻止访问此容器中的所有子级。 默认为true。

Default Value:
  • true

accessibleHint string

设置阴影div的aria-label属性

accessiblePointerEvents string

指定可访问的div将使用的指针事件 默认为'auto'

Default Value:
  • 'auto'

accessibleTitle string nullable

设置阴影div的title属性。如果尚未设置accessibleTitle和accessibleHint,则默认为 'displayObject [tabIndex]'

accessibleType string

指定可访问层的div的类型。 屏幕阅读器会根据此类型对元素进行不同的处理。 默认为 button.

Default Value:
  • 'button'

alpha number

对象的不透明度。

angle number

物体的角度,以度为单位。 'rotation' 和 'angle' 对显示对象具有相同的效果; 旋转单位为弧度,角度单位为度。

buttonMode boolean

如果启用,则鼠标光标悬停在displayObject上时,如果它是交互式的,则使用指针行为 设置此项会将'cursor'属性更改为''pointer'`。

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

cacheAsBitmap boolean

如果希望将此显示对象缓存为位图,请将其设置为true。 这基本上是对显示对象的快照。它可以为复杂的静态displayObjects提供性能优势。 要删除,只需将此属性设置为false即可。

重要提示-在将此属性设置为true之前,请确保已预加载所有纹理,因为它将获取当前纹理的快照。 如果尚未加载纹理,则它们将不会显示。

cursor string

定义鼠标光标时使用的光标模式悬停在displayObject上。

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

filterArea PIXI.Rectangle nullable

设置滤镜的区域。这更多的是用作优化,而不是计算可以设置此矩形的每个帧的displayObject的尺寸。

也可用作交互掩罩。

filters Array.<PIXI.Filter> nullable

设置displayObject的滤镜。

  • 重要提示:这是一个WebGL独有的功能,将被画布渲染器忽略。 若要删除滤镜,只需将此属性设置为'null'

hitArea PIXI.IHitArea

元素可点击范围 互动形状。首先将命中子集,然后再检查此形状。 设置此项将导致在命中测试中将使用此范围,而不是显示对象的边界范围。

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

interactive boolean

启用DisplayObject的交互事件。如果不将interactive设置为true,则不会触发触摸,指针和鼠标事件。

Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //处理事件
});

isMask boolean

是否还有其他displayObject将此对象用作遮罩?

isSprite boolean

用于快速检查精灵是否是.. 一个精灵!

localTransform PIXI.Matrix readonly

基于局部因素的当前对象变换:位置、比例、其他内容。

设置displayObject的遮罩。遮罩是将对象的可见性限制为应用于其的遮罩形状的对象。 在PixiJS中,常规遮罩必须是PIXI.GraphicsPIXI.Sprite对象。 PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it 这样可以在画布中更快地进行遮罩,因为它实用程序形状剪辑。若要删除掩码,请将此属性设置为null

对于精灵遮罩,使用alpha和red通道。黑色遮罩与透明遮罩相同。

TODO
  • 目前,PIXI.CanvasRenderer不支持PIXI.Sprite作为遮罩。
Example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
graphics.drawRect(50, 250, 100, 100);
graphics.endFill();

const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;

name string

The instance name of the object.

包含此显示对象的显示对象容器。

显示对象绕其旋转的轴心点。 pixi-v4开始按值传递。

对象相对于父对象的局部坐标的坐标。 pixi-v4开始按值传递。

renderable boolean

是否可以渲染此对象,如果为false,则不会绘制对象,但仍将调用updateTransform方法。

仅影响来自父级的递归调用。 您可以手动请求边界。

rotation number

物体的弧度旋转。 'rotation' 和 'angle' 对显示对象具有相同的效果; 旋转单位为弧度,角度单位为度。

对象的比例因子。 pixi-v4开始按值传递。

对象的歪斜因子,以弧度为单位。 pixi-v4开始按值传递。

transform PIXI.Transform

该对象的世界变换和局部变换。 稍后它将变为只读,除非您知道自己在做什么,否则请不要在其中分配任何内容。

visible boolean

对象的可见性。 如果为false,则不会绘制对象,并且不会调用updateTransform函数。

仅影响来自父级的递归调用。 您可以请求边界或手动调用updateTransform。

worldAlpha number readonly

displayObject的相乘alpha。

worldTransform PIXI.Matrix readonly

基于世界(父)因素的对象的当前变换。

worldVisible boolean readonly

指示对象是否世界可见。

x number

displayObject在x轴上相对于父级本地坐标的位置。 position.x的别名

y number

displayObject在y轴上相对于父级本地坐标的位置 position.y的别名

zIndex number

displayObject的zIndex。 如果容器的sortableChildren属性设置为true,则子容器将按zIndex值自动排序;值越大,则表示它将移向数组的末尾, 并以此渲染在同一容器中的其他displayObjects之上。

Methods

PIXI.DisplayObject.mixin (source) static

将所有可枚举属性和方法从源对象混合到DisplayObject。

Name Type Description
source object

属性来源和可混用的方法。

_recursivePostUpdateTransform ()

递归地将所有对象的转换从根更新为此toLocal()的一个内部函数

通用显示对象的基础销毁方法。这将自动从其父容器中删除显示对象,并删除所有当前事件侦听器和内部引用。 调用destroy()之后请勿使用DisplayObject。

displayObjectUpdateTransform ()

DisplayObject默认为updateTransform,不更新容器的子级。 如果没有父元素,则会崩溃。

getBounds (skipUpdate, rect)PIXI.Rectangle

以矩形对象的形式获取displayObject的边界。

Name Type Description
skipUpdate boolean optional

设置为true将阻止场景图的变换被更新。这意味着返回的计算可能已经过时, 但会给您带来很好的性能提升。

rect PIXI.Rectangle optional

可选的矩形,用于存储边界计算的结果。

Returns:
Type Description
PIXI.Rectangle 矩形边界区域

getGlobalPosition (point, skipUpdate)PIXI.Point

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

Name Type Default Description
point PIXI.Point new PIXI.Point() optional

The point to write the global value to.

skipUpdate boolean false optional

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
PIXI.Point The updated point.

getLocalBounds (rect)PIXI.Rectangle

以矩形对象的形式获取displayObject的局部范围。

Name Type Description
rect PIXI.Rectangle optional

可选的矩形,用于存储边界计算的结果。

Returns:
Type Description
PIXI.Rectangle 矩形边界区域

renderWebGL (renderer) Deprecated : since 5.0.0

Name Type Description
renderer PIXI.Renderer

Instance of renderer

See:
  • PIXI.DisplayObject#render

setParent (container)PIXI.Container

设置此DisplayObject的父容器。

Name Type Description
container PIXI.Container

要将此DisplayObject添加到的容器。

Returns:
Type Description
PIXI.Container 此DisplayObject添加到的容器。

setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)PIXI.DisplayObject

便捷方法,可同时设置位置,比例,倾斜和枢轴。

Name Type Default Description
x number 0 optional

X位置

y number 0 optional

Y位置

scaleX number 1 optional

X标度值

scaleY number 1 optional

Y标度值

rotation number 0 optional

旋转

skewX number 0 optional

X偏斜值

skewY number 0 optional

Y偏斜值

pivotX number 0 optional

X轴值

pivotY number 0 optional

Y轴值

Returns:
Type Description
PIXI.DisplayObject DisplayObject实例

toGlobal (position, point, skipUpdate)PIXI.Point

计算显示对象的世界位置。

Name Type Default Description
position PIXI.IPoint

要计算的世界原点。

point PIXI.Point optional

存储值的Point对象,可选 (为空时,会创建一个新的Point).

skipUpdate boolean false optional

是否跳过更新转换

Returns:
Type Description
PIXI.Point 表示此对象位置的Point对象。

toLocal (position, from, point, skipUpdate)PIXI.Point

计算显示对象相对于另一点的局部位置。

Name Type Default Description
position PIXI.IPoint

要计算的世界原点。

from PIXI.DisplayObject optional

从中计算世界位置的DisplayObject。

point PIXI.Point optional

存储值的Point对象,可选 (为空时,会创建一个新的Point).

skipUpdate boolean false optional

是否跳过更新转换

Returns:
Type Description
PIXI.Point 表示此对象位置的Point对象

updateTransform ()

更新要渲染的对象变换。

TODO - 优化通过!

Events

将此DisplayObject添加到容器时触发。

Name Type Description
container PIXI.Container

添加到的容器。

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 PIXI.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 PIXI.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 PIXI.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 PIXI.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 PIXI.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 PIXI.interaction.InteractionEvent

Interaction event

mouseupoutside

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 PIXI.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 PIXI.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 PIXI.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 PIXI.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 PIXI.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 PIXI.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 PIXI.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 PIXI.interaction.InteractionEvent

Interaction event

pointerupoutside

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 PIXI.interaction.InteractionEvent

Interaction event

从容器中移除此DisplayObject时触发。

Name Type Description
container PIXI.Container

从中移除的容器。

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 PIXI.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 PIXI.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 PIXI.interaction.InteractionEvent

Interaction event

rightupoutside

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 PIXI.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 PIXI.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 PIXI.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 PIXI.interaction.InteractionEvent

Interaction event

touchendoutside

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 PIXI.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 PIXI.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 PIXI.interaction.InteractionEvent

Interaction event