html5白鹭引擎,egret

最新推荐文章于 2021-12-05 00:22:29 发布

科技守望者

最新推荐文章于 2021-12-05 00:22:29 发布

阅读量151

点赞数

文章标签： html5白鹭引擎

属性详细信息

alpha

属性

alpha : number

= 1

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示指定对象的 Alpha 透明度值。有效值为 0(完全透明)到 1(完全不透明)。alpha 设置为 0 的显示对象是可触摸的，即使它们不可见。

实现

public get alpha():number

public set alpha(value:number)anchorOffsetX

属性

anchorOffsetX : number

= 0

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示从对象绝对锚点X。

实现

public get anchorOffsetX():number

public set anchorOffsetX(value:number)anchorOffsetY

属性

anchorOffsetY : number

= 0

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示从对象绝对锚点Y。

实现

public get anchorOffsetY():number

public set anchorOffsetY(value:number)blendMode

属性

blendMode : string

= egret.BlendMode.NORMAL

语言版本:

Egret 2.4

运行时版本:

Web,Native

BlendMode 枚举中的一个值，用于指定要使用的混合模式，确定如何将一个源(新的)图像绘制到目标(已有)的图像上

如果尝试将此属性设置为无效值，则运行时会将此值设置为 BlendMode.NORMAL。

实现

public get blendMode():string

public set blendMode(value:string)

了解更多cacheAsBitmap

属性

cacheAsBitmap : boolean

= false

语言版本:

Egret 2.4

运行时版本:

Web,Native

如果设置为 true，则 Egret 运行时将缓存显示对象的内部位图表示形式。此缓存可以提高包含复杂矢量内容的显示对象的性能。将 cacheAsBitmap 属性设置为 true 后，呈现并不更改，但是，显示对象将自动执行像素贴紧。执行速度可能会大大加快，具体取决于显示对象内容的复杂性。最好将 cacheAsBitmap 属性与主要具有静态内容且不频繁缩放或旋转的显示对象一起使用。

注意：在内存超过上限的情况下，即使将 cacheAsBitmap 属性设置为 true，显示对象也不使用位图缓存。

实现

public get cacheAsBitmap():boolean

public set cacheAsBitmap(value:boolean)filters

属性

filters : Array

语言版本:

Egret 3.1.0

运行时版本:

Web

包含当前与显示对象关联的每个滤镜对象的索引数组。

实现

public get filters():Array

public set filters(value:Array) hashCode

属性

hashCode : number

语言版本:

Egret 2.4

运行时版本:

Web,Native

返回此对象唯一的哈希值,用于唯一确定一个对象。hashCode为大于等于1的整数。

实现

public get hashCode():numberheight

属性

height : number

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示显示对象的高度，以像素为单位。高度是根据显示对象内容的范围来计算的。

实现

public get height():number

public set height(value:number)mask

属性

mask : egret.DisplayObject|egret.Rectangle

语言版本:

Egret 2.4

运行时版本:

Web,Native

调用显示对象被指定的 mask 对象遮罩。要确保当舞台缩放时蒙版仍然有效，mask 显示对象必须处于显示列表的活动部分。但不绘制 mask 对象本身。将 mask 设置为 null 可删除蒙版。要能够缩放遮罩对象，它必须在显示列表中。要能够拖动蒙版对象，它必须在显示列表中。

注意：单个 mask 对象不能用于遮罩多个执行调用的显示对象。在将 mask 分配给第二个显示对象时，会撤消其作为第一个对象的遮罩，该对象的 mask 属性将变为 null。下面例子为 mask 为 Rectangle 类型对象，这种情况下，修改 mask 的值后，一定要对 myDisplayObject 重新赋值 mask，不然会出问题。

实现

public get mask():egret.DisplayObject|egret.Rectangle

public set mask(value:egret.DisplayObject|egret.Rectangle)

以下代码改变了显示对象 mask 的 x 属性值：let myMask:Rectangle = myDisplayObject.mask;

myMask.x += 10;

myDisplayObject.mask = myMask;//设置完 mask 的x、y、width、height值之后，一定要对myDisplayObject重新赋值 mask，不然会出问题。matrix

属性

matrix : egret.Matrix

语言版本:

Egret 2.4

运行时版本:

Web,Native

一个 Matrix 对象，其中包含更改显示对象的缩放、旋转和平移的值。

注意：要改变一个显示对象矩阵的值，您必引用整个矩阵对象，然后将它重新赋值给显示对象的 matrix 属性。

实现

public get matrix():egret.Matrix

public set matrix(value:egret.Matrix)

以下代码改变了显示对象矩阵的tx属性值：let myMatrix:Matrix = myDisplayObject.matrix;

myMatrix.tx += 10;

myDisplayObject.matrix = myMatrix;measuredHeight

属性

measuredHeight : number

语言版本:

Egret 2.4

运行时版本:

Web,Native

测量高度

实现

public get measuredHeight():numbermeasuredWidth

属性

measuredWidth : number

语言版本:

Egret 2.4

运行时版本:

Web,Native

测量宽度

实现

public get measuredWidth():numbername

属性

name : string

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示 DisplayObject 的实例名称。通过调用父显示对象容器的 getChildByName() 方法，可以在父显示对象容器的子列表中标识该对象。

实现

public get name():string

public set name(value:string)parent

属性

parent : egret.DisplayObjectContainer

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示包含此显示对象的 DisplayObjectContainer 对象。使用 parent 属性可以指定高于显示列表层次结构中当前显示对象的显示对象的相对路径。

实现

public get parent():egret.DisplayObjectContainerrotation

属性

rotation : number

= 0

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示 DisplayObject 实例距其原始方向的旋转程度，以度为单位。从 0 到 180 的值表示顺时针方向旋转；从 0 到 -180 的值表示逆时针方向旋转。对于此范围之外的值，可以通过加上或减去 360 获得该范围内的值。例如，myDisplayObject.rotation = 450语句与 myDisplayObject.rotation = 90 是相同的。

实现

public get rotation():number

public set rotation(value:number)scaleX

属性

scaleX : number

= 1

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示从注册点开始应用的对象的水平缩放比例(百分比)。

1.0 等于 100% 缩放。

实现

public get scaleX():number

public set scaleX(value:number)scaleY

属性

scaleY : number

= 1

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示从对象注册点开始应用的对象的垂直缩放比例(百分比)。1.0 是 100% 缩放。

实现

public get scaleY():number

public set scaleY(value:number)scrollRect

属性

scrollRect : egret.Rectangle

语言版本:

Egret 2.4

运行时版本:

Web,Native

显示对象的滚动矩形范围。显示对象被裁切为矩形定义的大小，当您更改 scrollRect 对象的 x 和 y 属性时，它会在矩形内滚动。滚动的显示对象始终以整像素为增量进行滚动。您可以通过设置 scrollRect Rectangle 对象的 x 属性来左右滚动对象，还可以通过设置scrollRect 对象的 y 属性来上下滚动对象。如果显示对象旋转了 90 度，并且您左右滚动它，则实际上显示对象会上下滚动。

注意：要改变一个显示对象 scrollRect 属性的值，您必引用整个 scrollRect 对象，然后将它重新赋值给显示对象的 scrollRect 属性。

实现

public get scrollRect():egret.Rectangle

public set scrollRect(value:egret.Rectangle)

以下代码改变了显示对象 scrollRect 的 x 属性值：let myRectangle:Rectangle = myDisplayObject.scrollRect;

myRectangle.x += 10;

myDisplayObject.scrollRect = myRectangle;//设置完scrollRect的x、y、width、height值之后，一定要对myDisplayObject重新赋值scrollRect，不然会出问题。skewX

属性

skewX : number

= 0

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示DisplayObject的x方向斜切

实现

public get skewX():number

public set skewX(value:number)skewY

属性

skewY : number

= 0

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示DisplayObject的y方向斜切

实现

public get skewY():number

public set skewY(value:number)stage

属性

stage : egret.Stage

语言版本:

Egret 2.4

运行时版本:

Web,Native

显示对象的舞台。例如，您可以创建多个显示对象并加载到显示列表中，每个显示对象的 stage 属性是指向相同的 Stage 对象。

如果显示对象未添加到显示列表，则其 stage 属性会设置为 null。

实现

public get stage():egret.StagetouchEnabled

属性

touchEnabled : boolean

= false

语言版本:

Egret 2.4

运行时版本:

Web,Native

指定此对象是否接收触摸或其他用户输入。默认值为 false，这表示默认情况下，显示列表上的任何 DisplayObject 实例都不会接收触摸事件或其他用户输入事件。如果将 touchEnabled 设置为 false，则实例将不接收任何触摸事件(或其他用户输入事件)。显示列表上的该实例的任何子级都不会受到影响。要更改显示列表上对象的所有子级的 touchEnabled 行为，请使用 DisplayObjectContainer.touchChildren。

实现

public get touchEnabled():boolean

public set touchEnabled(value:boolean)

了解更多visible

属性

visible : boolean

= true

语言版本:

Egret 2.4

运行时版本:

Web,Native

显示对象是否可见。不可见的显示对象将被禁用。例如，如果实例的 visible 为 false，则无法接受触摸或用户交互操作。

实现

public get visible():boolean

public set visible(value:boolean)width

属性

width : number

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示显示对象的宽度，以像素为单位。宽度是根据显示对象内容的范围来计算的。

实现

public get width():number

public set width(value:number)x

属性

x : number

= 0

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。

如果该对象位于具有变形的 DisplayObjectContainer 内，则它也位于包含 DisplayObjectContainer 的本地坐标系中。因此，对于逆时针旋转 90 度的 DisplayObjectContainer，该 DisplayObjectContainer 的子级将继承逆时针旋转 90 度的坐标系。

实现

public get x():number

public set x(value:number)y

属性

y : number

= 0

语言版本:

Egret 2.4

运行时版本:

Web,Native

表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。

实现

public get y():number

public set y(value:number)

方法详细信息

DisplayObject

()

方法

public DisplayObject(

)

语言版本:

Egret 2.4

运行时版本:

Web,Native

创建一个显示对象 addEventListener

()

方法

public addEventListener(

type:string,listener:Function ,thisObject:any ,useCapture:boolean ,priority:number ):void

语言版本:

Egret 2.4

运行时版本:

Web,Native

了解更多

使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。可以为特定类型的事件、阶段和优先级在显示列表的所有节点上注册事件侦听器。成功注册一个事件侦听器后，无法通过额外调用 on() 来更改其优先级。要更改侦听器的优先级，必须先调用 removeEventListener()。然后，可以使用新的优先级再次注册该侦听器。注册该侦听器后，如果继续调用具有不同 type 或 useCapture值的 on()，则会创建单独的侦听器注册。

如果不再需要某个事件侦听器，可调用 EventDispatcher.removeEventListener()删除它；否则会产生内存问题。由于垃圾回收器不会删除仍包含引用的对象，因此不会从内存中自动删除使用已注册事件侦听器的对象。复制EventDispatcher 实例时并不复制其中附加的事件侦听器。(如果新近创建的节点需要一个事件侦听器，必须在创建该节点后附加该侦听器。)但是，如果移动 EventDispatcher 实例，则其中附加的事件侦听器也会随之移动。如果在正在处理事件的节点上注册事件侦听器，则不会在当前阶段触发事件侦听器，但会在事件流的稍后阶段触发，如冒泡阶段。如果从正在处理事件的节点中删除事件侦听器，则该事件侦听器仍由当前操作触发。删除事件侦听器后，决不会再次调用该事件侦听器(除非再次注册以备将来处理)。

参数

type:string — 事件的类型。

listener:Function — 处理事件的侦听器函数。此函数必须接受 Event 对象作为其唯一的参数，并且不能返回任何结果，如下面的示例所示： function(evt:Event):void 函数可以有任何名称。

thisObject:any — 侦听函数绑定的this对象

useCapture:boolean — 确定侦听器是运行于捕获阶段还是运行于冒泡阶段。如果将 useCapture 设置为 true，则侦听器只在捕获阶段处理事件，而不在冒泡阶段处理事件。如果 useCapture 为 false，则侦听器只在冒泡阶段处理事件。要在两个阶段都侦听事件，请调用 on() 两次：一次将 useCapture 设置为 true，一次将 useCapture 设置为 false。

priority:number — 事件侦听器的优先级。优先级由一个带符号的整数指定。数字越大，优先级越高。优先级为 n 的所有侦听器会在优先级为 n -1 的侦听器之前得到处理。如果两个或更多个侦听器共享相同的优先级，则按照它们的添加顺序进行处理。默认优先级为 0。dispatchEvent

()

方法

public dispatchEvent(

event:egret.Event ):boolean

语言版本:

Egret 2.4

运行时版本:

Web,Native

将事件分派到事件流中。事件目标是对其调用 dispatchEvent() 方法的 EventDispatcher 对象。

参数

event:egret.Event — 调度到事件流中的 Event 对象。

如果成功调度了事件，则值为 true。值 false 表示失败或对事件调用了 preventDefault()。 dispatchEventWith

()

方法

public dispatchEventWith(

type:string,bubbles:boolean ,data:any ,cancelable:boolean ):boolean

语言版本:

Egret 2.4

运行时版本:

Web,Native

派发一个指定参数的事件。

参数

type:string — 事件类型

bubbles:boolean — 确定 Event 对象是否参与事件流的冒泡阶段。默认值为 false。

data:any — 事件data

cancelable:boolean — 确定是否可以取消 Event 对象。默认值为 false。getBounds

()

方法

public getBounds(

resultRect:egret.Rectangle,calculateAnchor:boolean ):egret.Rectangle

语言版本:

Egret 2.4

运行时版本:

Web,Native

获取显示对象的测量边界

参数

resultRect:egret.Rectangle — 可选参数，传入用于保存结果的Rectangle对象，避免重复创建对象。

calculateAnchor:boolean — 可选参数，是否会计算锚点。getTransformedBounds

()

方法

public getTransformedBounds(

targetCoordinateSpace:egret.DisplayObject,resultRect:egret.Rectangle ):egret.Rectangle

语言版本:

Egret 2.4

运行时版本:

Web,Native

返回一个矩形，该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。

参数

targetCoordinateSpace:egret.DisplayObject — 定义要使用的坐标系的显示对象。

resultRect:egret.Rectangle — 一个用于存储结果的可复用Rectangle实例，传入此参数能够减少内部创建对象的次数，从而获得更高的运行性能。

定义与 targetCoordinateSpace 对象坐标系统相关的显示对象面积的矩形。globalToLocal

()

方法

public globalToLocal(

stageX:number,stageY:number ,resultPoint:egret.Point ):egret.Point

语言版本:

Egret 2.4

运行时版本:

Web,Native

将从舞台(全局)坐标转换为显示对象的(本地)坐标。

参数

stageX:number — 舞台坐标x

stageY:number — 舞台坐标y

resultPoint:egret.Point — 一个用于存储结果的可复用 Point 实例，传入此参数能够减少内部创建对象的次数，从而获得更高的运行性能。

具有相对于显示对象的坐标的 Point 对象。 hasEventListener

()

方法

public hasEventListener(

type:string ):boolean

语言版本:

Egret 2.4

运行时版本:

Web,Native

了解更多

检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。这样，您就可以确定 EventDispatcher 对象在事件流层次结构中的哪个位置改变了对事件类型的处理。要确定特定事件类型是否确实会触发事件侦听器，请使用 IEventDispatcher.willTrigger()。hasEventListener()与 willTrigger() 的区别是：hasEventListener() 只检查它所属的对象，而 willTrigger() 检查整个事件流以查找由 type 参数指定的事件。

参数

type:string — 事件的类型。

如果指定类型的侦听器已注册，则值为 true；否则，值为 false。hitTestPoint

()

方法

public hitTestPoint(

x:number,y:number ,shapeFlag:boolean ):boolean

语言版本:

Egret 2.4

运行时版本:

Web,Native

计算显示对象，以确定它是否与 x 和 y 参数指定的点重叠或相交。x 和 y 参数指定舞台的坐标空间中的点，而不是包含显示对象的显示对象容器中的点(除非显示对象容器是舞台)。注意，不要在大量物体中使用精确碰撞像素检测，这回带来巨大的性能开销

参数

x:number — 要测试的此对象的 x 坐标。

y:number — 要测试的此对象的 y 坐标。

shapeFlag:boolean — 是检查对象 (true) 的实际像素，还是检查边框 (false) 的实际像素。

如果显示对象与指定的点重叠或相交，则为 true；否则为 false。localToGlobal

()

方法

public localToGlobal(

localX:number,localY:number ,resultPoint:egret.Point ):egret.Point

语言版本:

Egret 2.4

运行时版本:

Web,Native

将显示对象的(本地)坐标转换为舞台(全局)坐标。

参数

localX:number — 本地坐标 x

localY:number — 本地坐标 y

resultPoint:egret.Point — 一个用于存储结果的可复用 Point 实例，传入此参数能够减少内部创建对象的次数，从而获得更高的运行性能。

一个具有相对于舞台坐标的 Point 对象。 once

()

方法

public once(

type:string,listener:Function ,thisObject:any ,useCapture:boolean ,priority:number ):void

语言版本:

Egret 2.4

运行时版本:

Web,Native

了解更多

添加仅回调一次的事件侦听器，此方法与on()方法不同，on()方法会持续产生回调，而此方法在第一次回调时就会自动移除监听。

参数

type:string — 事件的类型。

thisObject:any — 侦听函数绑定的this对象

useCapture:boolean — 确定侦听器是运行于捕获阶段还是运行于冒泡阶段。如果将 useCapture 设置为 true，则侦听器只在捕获阶段处理事件，而不在冒泡阶段处理事件。如果 useCapture 为 false，则侦听器只在冒泡阶段处理事件。要在两个阶段都侦听事件，请调用 once() 两次：一次将 useCapture 设置为 true，一次将 useCapture 设置为 false。

priority:number — 事件侦听器的优先级。优先级由一个带符号整数指定。数字越大，优先级越高。优先级为 n 的所有侦听器会在优先级为 n -1 的侦听器之前得到处理。如果两个或更多个侦听器共享相同的优先级，则按照它们的添加顺序进行处理。默认优先级为 0。removeEventListener

()

方法

public removeEventListener(

type:string,listener:Function ,thisObject:any ,useCapture:boolean ):void

语言版本:

Egret 2.4

运行时版本:

Web,Native

从 EventDispatcher 对象中删除侦听器。如果没有向 EventDispatcher 对象注册任何匹配的侦听器，则对此方法的调用没有任何效果。

参数

type:string — 事件的类型。

listener:Function — 要删除的侦听器对象

thisObject:any — 侦听函数绑定的this对象

useCapture:boolean — 指出是为捕获阶段还是为冒泡阶段注册了侦听器。如果为捕获阶段以及冒泡阶段注册了侦听器，则需要对removeEventListener() 进行两次调用才能将这两个侦听器删除：一次调用将 useCapture 设置为 true，另一次调用将 useCapture 设置为 false。。willTrigger

()

方法

public willTrigger(

type:string ):boolean

语言版本:

Egret 2.4

运行时版本:

Web,Native

了解更多

检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。将指定类型的事件调度给此EventDispatcher 对象或其任一后代时，如果在事件流的任何阶段触发了事件侦听器，则此方法返回 true。hasEventListener() 与 willTrigger() 方法的区别是：hasEventListener() 只检查它所属的对象，而 willTrigger() 方法检查整个事件流以查找由 type 参数指定的事件。

参数

type:string — 事件类型

是否注册过监听器，如果注册过返回true，反之返回false

/**

* 以下示例演示了 DisplayObject 的各个事件。

class DisplayObjectExample extends egret.Sprite {

public constructor() {

super();

this.touchEnabled = true;

this.draw();

this.addEventListener(egret.Event.ADDED, this.onAdded, this);

this.addEventListener(egret.Event.ENTER_FRAME, this.onEnterFrame, this);