Show:

annie.Sprite Class

Defined in: libs/Sprite.js:11
Module: annie

Available since 1.0.0

显示对象的容器类,可以将其他显示对象放入其中,是annie引擎的核心容器类. Sprite 类是基本显示列表构造块:一个可显示图形并且也可包含子项的显示列表节点。 Sprite 对象与影片剪辑类似,但没有时间轴。Sprite 是不需要时间轴的对象的相应基类。 例如,Sprite 将是通常不使用时间轴的用户界面 (UI) 组件的逻辑基类

Methods

addChild

(
  • child
)
Void public

Defined in libs/Sprite.js:101

Available since 1.0.0

添加一个显示对象到Sprite

Parameters:

Returns:

Void:

addChildAt

(
  • child
  • index
)
Void public

Defined in libs/Sprite.js:191

Available since 1.0.0

添加一个child到Sprite中并指定添加到哪个层级

Parameters:

Returns:

Void:

addEventListener

(
  • type
  • listener
  • useCapture
)
Void public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:102

Available since 1.0.0

给对象添加一个侦听

Parameters:

  • type String

    侦听类型

  • listener Function

    侦听后的回调方法,如果这个方法是类实例的方法,为了this引用的正确性,请在方法参数后加上.bind(this);

  • useCapture Boolean

    true 捕获阶段 false 冒泡阶段 默认 true

Returns:

Void:

Example:

 this.addEventListener(annie.Event.ADD_TO_STAGE,function(e){console.log(this);}.bind(this));

addSound

(
  • sound
)
Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:816

Available since 2.0.0

返回一个id,这个id你要留着作为删除他时使用。 这个声音会根据这个显示对象添加到舞台时播放,移出舞台而关闭

Parameters:

Returns:

Void:

destroy

() Void public

Inherited from annie.AObject: libs/EventDispatcher.js:55

Available since 2.0.0

销毁一个对象 销毁之前一定要做完其他善后工作,否则有可能会出错

Returns:

Void:

dispatchEvent

(
  • event
  • data
  • useCapture
)
Boolean public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:149

Available since 1.0.0

广播侦听

Parameters:

  • event annie.Event | String

    广播所带的事件对象,如果传的是字符串则自动生成一个annie.Event对象,事件类型就是传入进来的字符串的值

  • data Object

    广播后跟着事件一起传过去的其他任信息,默认值为null

  • useCapture Boolean

    true 捕获阶段 false 冒泡阶段 默认 true

Returns:

Boolean:

如果有收听者则返回true

Example:

 var mySprite=new annie.Sprite(),
 yourEvent=new annie.Event("yourCustomerEvent");
 yourEvent.data={a:1,b:2,c:"hello",d:{aa:1,bb:2}};
 mySprite.addEventListener("yourCustomerEvent",function(e){
     console.log(e.data);
 })
 mySprite.dispatchEvent(yourEvent);

DisplayObject

() public

Inherited from annie.DisplayObject: libs/DisplayObject.js:70

Available since 1.0.0

getBounds

() annie.Rectangle public

Inherited from annie.DisplayObject: libs/DisplayObject.js:551

Available since 1.0.0

获取对象的自身的没有任何形变的原始姿态下的原点坐标及宽高,抽象方法

Returns:

getChildAt

(
  • index
)
annie.DisplayObject public

Defined in libs/Sprite.js:251

Available since 1.0.0

获取Sprite中指定层级一个child

Parameters:

getChildByName

(
  • name
  • isOnlyOne
  • isRecursive
)
String | Array public

Defined in libs/Sprite.js:155

Available since 1.0.0

通过给displayObject设置的名字来获取一个child,可以使用正则匹配查找

Parameters:

  • name String

    对象的具体名字或是一个正则表达式

  • isOnlyOne Boolean

    默认为true,如果为true,只返回最先找到的对象,如果为false则会找到所有匹配的对象数组

  • isRecursive Boolean

    false,如果为true,则会递归查找下去,而不只是查找当前对象中的child,child里的child也会找,依此类推

Returns:

String | Array:

返回一个对象,或者一个对象数组,没有找到则返回空

getChildIndex

(
  • child
)
Number public

Defined in libs/Sprite.js:267

Available since 1.0.2

获取Sprite中一个child所在的层级索引,找到则返回索引数,未找到则返回-1

Parameters:

Returns:

getDrawRect

() annie.Rectangle public

Inherited from annie.DisplayObject: libs/DisplayObject.js:562

Available since 1.0.0

获取对象形变后外切矩形。 可以从这个方法中读取到此显示对象变形后x方向上的宽和y方向上的高

Returns:

getSound

(
  • id
)
Array

Inherited from annie.DisplayObject: libs/DisplayObject.js:791

Available since 2.0.0

Parameters:

Returns:

Array:

这个对象里所有叫这个名字的声音引用数组

getWH

() Width: number, height: number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:743

Available since 1.0.9

如果需要同时获取宽和高的值,建议使用此方法更有效率

Returns:

Width: number, height: number:

}

globalToLocal

(
  • point
)
annie.Point public

Inherited from annie.DisplayObject: libs/DisplayObject.js:445

Available since 1.0.0

将全局坐标转换到本地坐标值

Parameters:

Returns:

hasEventListener

(
  • type
  • useCapture
)
Boolean public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:208

Available since 1.0.0

是否有添加过此类型的侦听

Parameters:

  • type String

    侦听类型

  • useCapture Boolean

    true 捕获阶段 false 冒泡阶段 默认 true

Returns:

Boolean:

如果有则返回true

hitTestPoint

(
  • hitPoint
  • isGlobalPoint
  • isMustMouseEnable
)
annie.DisplayObject public

Inherited from annie.DisplayObject: libs/DisplayObject.js:523

Available since 1.0.0

点击碰撞测试,就是舞台上的一个point是否在显示对象内,在则返回该对象,不在则返回null

Parameters:

  • hitPoint annie.Point

    要检测碰撞的点

  • isGlobalPoint Boolean

    是不是全局坐标的点,默认false是本地坐标

  • isMustMouseEnable Boolean

    是不是一定要MouseEnable为true的显示对象才接受点击测试,默认为不需要 false

localToGlobal

(
  • point
)
annie.Point public

Inherited from annie.DisplayObject: libs/DisplayObject.js:457

Available since 1.0.0

将本地坐标转换到全局坐标值

Parameters:

Returns:

removeAllChildren

() Void public

Defined in libs/Sprite.js:345

Available since 1.0.0

移除Sprite上的所有child

Returns:

Void:

removeAllEventListener

() Void public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:261

Available since 1.0.0

移除对象中所有的侦听

Returns:

Void:

removeChild

(
  • child
)
Void public

Defined in libs/Sprite.js:112

Available since 1.0.0

从Sprite中移除一个child

Parameters:

Returns:

Void:

removeChildAt

(
  • index
)
Void public

Defined in libs/Sprite.js:320

Available since 1.0.0

移除指定层级上的孩子

Parameters:

Returns:

Void:

removeEventListener

(
  • type
  • listener
  • useCapture
)
Void public

Inherited from annie.EventDispatcher: libs/EventDispatcher.js:232

Available since 1.0.0

移除对应类型的侦听

Parameters:

  • type String

    要移除的侦听类型

  • listener Function

    侦听时绑定的回调方法

  • useCapture Boolean

    true 捕获阶段 false 冒泡阶段 默认 true

Returns:

Void:

removeSound

(
  • id
)
Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:833

Available since 2.0.0

删除一个已经添加进来的声音

Parameters:

Returns:

Void:

render

(
  • renderObj
)
Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:656

Available since 1.0.0

调用此方法将显示对象渲染到屏幕

Parameters:

  • renderObj annie.IRender

Returns:

Void:

Sprite

() public

Defined in libs/Sprite.js:23

Available since 1.0.0

构造函数

startDrag

(
  • isCenter
  • bounds
)
Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:477

Available since 1.1.2

启动鼠标或者触摸拖动

Parameters:

  • isCenter Boolean

    指定将可拖动的对象锁定到指针位置中心 (true),还是锁定到用户第一次单击该对象的位置 (false) 默认false

  • bounds annie.Rectangle

    相对于显示对象父级的坐标的值,用于指定 Sprite 约束矩形

Returns:

Void:

stopAllSounds

() Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:776

Available since 2.0.0

停止这个显示对象上的所有声音

Returns:

Void:

stopDrag

() Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:511

Available since 1.1.2

停止鼠标或者触摸拖动

Returns:

Void:

swapChild

(
  • child1
  • child2
)
Boolean

Defined in libs/Sprite.js:285

Available since 2.0.0

交换两个显示对象的层级

Parameters:

  • child1 Object

    显示对象,或者显示对象的索引

  • child2 Object

    显示对象,或者显示对象的索引

Returns:

update

() Void public

Inherited from annie.DisplayObject: libs/DisplayObject.js:595

Available since 1.0.0

更新函数

Returns:

Void:

Properties

alpha

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:259

Available since 1.0.0

显示对象透明度

Default: 1

anchorX

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:313

Available since 1.0.0

显示对象上x方向的缩放或旋转点

Default: 0

anchorY

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:331

Available since 1.0.0

显示对象上y方向的缩放或旋转点

Default: 0

blendMode

String public

Inherited from annie.DisplayObject: libs/DisplayObject.js:372

Available since 1.0.0

显示对象的混合模式 支持的混合模式大概有

Default: 0

cacheAsBitmap

Boolean public

Defined in libs/Sprite.js:70

Available since 1.1.2

小游戏不支持 小程序不支持

是否缓存为位图,注意一但缓存为位图,它的所有子级对象上的事件侦听都将无效

Default: false

children

Array public

Defined in libs/Sprite.js:41

Available since 1.0.0

显示对象的child列表

Default: []

filters

Array public

Inherited from annie.DisplayObject: libs/DisplayObject.js:427

Available since 1.0.0

小游戏不支持 小程序不支持

显示对象的滤镜数组

Default: null

height

Unknown public

Inherited from annie.DisplayObject: libs/DisplayObject.js:721

Available since 1.0.3

获取或者设置显示对象在父级里的y方向的高,不到必要不要用此属性获取高 如果你要同时获取宽高,建议使用getWH()方法获取宽和高

instanceId

Number public

Inherited from annie.AObject: libs/EventDispatcher.js:23

Available since 1.0.0

每一个annie引擎对象都会有一个唯一的id码。

Example:

 //获取 annie引擎类对象唯一码
 console.log(this.instanceId);

instanceType

String public

Inherited from annie.AObject: libs/EventDispatcher.js:41

Available since 1.0.3

每一个annie类都有一个实例类型字符串,通过这个字符串,你能知道这个实例是从哪个类实例而来

mask

annie.DisplayObject public

Inherited from annie.DisplayObject: libs/DisplayObject.js:398

Available since 1.0.0

显示对象的遮罩, 是一个Shape显示对象或是一个只包含shape显示对象的MovieClip

Default: null

matrix

annie.Matrix public

Inherited from annie.DisplayObject: libs/DisplayObject.js:382

Available since 1.0.0

显示对象的变形矩阵

Default: null

mouseChildren

Boolean public

Defined in libs/Sprite.js:31

Available since 1.0.0

是否可以让children接收鼠标事件 鼠标事件将不会往下冒泡

Default: true

mouseEnable

Boolean public

Inherited from annie.DisplayObject: libs/DisplayObject.js:108

Available since 1.0.0

是否可以接受点击事件,如果设置为false,此显示对象将无法接收到点击事件

Default: false

name

String public

Inherited from annie.DisplayObject: libs/DisplayObject.js:119

Available since 1.0.0

每一个显示对象都可以给他命一个名字,这样我们在查找子级的时候就可以直接用this.getChildrndByName("name")获取到这个对象的引用

Default: ""

parent

annie.Sprite public

Inherited from annie.DisplayObject: libs/DisplayObject.js:94

Available since 1.0.0

显示对象的父级

Default: null

rotation

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:241

Available since 1.0.0

显示对象旋转角度

Default: 0

scaleX

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:205

Available since 1.0.0

显示对象x方向的缩放值

Default: 1

scaleY

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:223

Available since 1.0.0

显示对象y方向的缩放值

Default: 1

skewX

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:277

Available since 1.0.0

显示对象x方向的斜切值

Default: 0

skewY

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:295

Available since 1.0.0

显示对象y方向的斜切值

Default: 0

soundList

Array public

Inherited from annie.DisplayObject: libs/DisplayObject.js:154

Available since 2.0.0

当前对象包含的声音列表

Default: []

stage

Stage public

Inherited from annie.DisplayObject: libs/DisplayObject.js:84

Available since 1.0.0

此显示对象所在的舞台对象,如果此对象没有被添加到显示对象列表中,此对象为空。

Default: null;

visible

Boolean public

Inherited from annie.DisplayObject: libs/DisplayObject.js:349

Available since 1.0.0

显未对象是否可见

Default: 0

width

Unknown public

Inherited from annie.DisplayObject: libs/DisplayObject.js:698

Available since 1.0.3

获取或者设置显示对象在父级里的x方向的宽,不到必要不要用此属性获取高 如果你要同时获取宽高,建议使用getWH()方法获取宽和高

x

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:168

Available since 1.0.0

显示对象位置x

Default: 0

y

Number public

Inherited from annie.DisplayObject: libs/DisplayObject.js:186

Available since 1.0.0

显示对象位置y

Default: 0

Events

ADD_TO_STAGE

Inherited from annie.DisplayObject: libs/DisplayObject.js:23

Available since 1.0.0

annie.DisplayObject显示对象加入到舞台事件

CLICK

String

annie.DisplayObject鼠标或者手指单击

ENTER_FRAME

Inherited from annie.DisplayObject: libs/DisplayObject.js:33

Available since 1.0.0

annie.DisplayObject显示对象 循环帧事件

MOUSE_DOWN

Inherited from annie.DisplayObject: libs/DisplayObject.js:39

Available since 1.0.0

annie.DisplayObject鼠标或者手指按下事件

MOUSE_MOVE

Inherited from annie.DisplayObject: libs/DisplayObject.js:54

Available since 1.0.0

annie.DisplayObject鼠标或者手指移动事件

MOUSE_OUT

Inherited from annie.DisplayObject: libs/DisplayObject.js:64

Available since 1.0.0

annie.DisplayObject鼠标或者手指移出显示对象边界触发的事件

MOUSE_OVER

Inherited from annie.DisplayObject: libs/DisplayObject.js:59

Available since 1.0.0

annie.DisplayObject鼠标或者手指移入到显示对象上里触发的事件

MOUSE_UP

Inherited from annie.DisplayObject: libs/DisplayObject.js:44

Available since 1.0.0

annie.DisplayObject鼠标或者手指抬起事件

REMOVE_TO_STAGE

Inherited from annie.DisplayObject: libs/DisplayObject.js:28

Available since 1.0.0

annie.DisplayObject显示对象从舞台移出事件