Class: PropertyAnimation

Attribute Animation Component

Hierarchy

• ComponentBase

  ↳ PropertyAnimation

Constructors

• constructor

Properties

• object3D
• isDestroyed
• defaultClip
• autoPlay

Accessors

• eventDispatcher
• isStart
• transform
• enable
• speed
• currentClip
• time

Methods

• onEnable
• onDisable
• onLateUpdate
• onBeforeUpdate
• onCompute
• onGraphic
• onParentChange
• onAddChild
• onRemoveChild
• beforeDestroy
• destroy
• registerEventKeyFrame
• appendClip
• stop
• toggle
• getClip
• seek
• play
• copyComponent
• cloneTo

Constructors

constructor

• new PropertyAnimation(): PropertyAnimation

Returns

PropertyAnimation

Overrides

ComponentBase.constructor

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:27

Properties

object3D

• object3D: Object3D = null

owner object3D

Inherited from

ComponentBase.object3D

Defined in

src/components/ComponentBase.ts:17

---

isDestroyed

• Optional isDestroyed: boolean

Inherited from

ComponentBase.isDestroyed

Defined in

src/components/ComponentBase.ts:38

---

defaultClip

• defaultClip: string

name of default animation clip

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:17

---

autoPlay

• autoPlay: boolean

is it play auto

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:21

Accessors

eventDispatcher

• get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

ComponentBase.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters

Name	Type
value	CEventDispatcher

Returns

void

Inherited from

ComponentBase.eventDispatcher

Defined in

src/components/ComponentBase.ts:28

---

isStart

• get isStart(): boolean

Returns

boolean

Inherited from

ComponentBase.isStart

Defined in

src/components/ComponentBase.ts:40

---

transform

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

ComponentBase.transform

Defined in

src/components/ComponentBase.ts:47

---

enable

• get enable(): boolean

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Inherited from

ComponentBase.enable

Defined in

src/components/ComponentBase.ts:68

• set enable(value): void

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

ComponentBase.enable

Defined in

src/components/ComponentBase.ts:54

---

speed

• get speed(): number

get playing speed

Returns

number

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:98

• set speed(value): void

set playing speed

Parameters

Name	Type
value	number

Returns

void

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:91

---

currentClip

• get currentClip(): PropertyAnimClip

get animation clip which is playing now

Returns

PropertyAnimClip

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:135

---

time

• get time(): number

get time of current animator

Returns

number

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:142

Methods

onEnable

▸ onEnable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onEnable

Defined in

src/components/ComponentBase.ts:115

---

onDisable

▸ onDisable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onDisable

Defined in

src/components/ComponentBase.ts:116

---

onLateUpdate

▸ onLateUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onLateUpdate

Defined in

src/components/ComponentBase.ts:118

---

onBeforeUpdate

▸ onBeforeUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119

---

onCompute

▸ onCompute(view?, command?): any

Parameters

Name	Type
view?	View3D
command?	GPUCommandEncoder

Returns

any

Inherited from

ComponentBase.onCompute

Defined in

src/components/ComponentBase.ts:120

---

onGraphic

▸ onGraphic(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

ComponentBase.onGraphic

Defined in

src/components/ComponentBase.ts:121

---

onParentChange

▸ onParentChange(lastParent?, currentParent?): any

Parameters

Name	Type
lastParent?	Object3D
currentParent?	Object3D

Returns

any

Inherited from

ComponentBase.onParentChange

Defined in

src/components/ComponentBase.ts:122

---

onAddChild

▸ onAddChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

ComponentBase.onAddChild

Defined in

src/components/ComponentBase.ts:123

---

onRemoveChild

▸ onRemoveChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

ComponentBase.onRemoveChild

Defined in

src/components/ComponentBase.ts:124

---

beforeDestroy

▸ beforeDestroy(force?): void

before release this component, object refrences are not be set null now.

Parameters

Name	Type
force?	boolean

Returns

void

Inherited from

ComponentBase.beforeDestroy

Defined in

src/components/ComponentBase.ts:200

---

destroy

▸ destroy(force?): void

release this component

Parameters

Name	Type
force?	boolean

Returns

void

Inherited from

ComponentBase.destroy

Defined in

src/components/ComponentBase.ts:207

---

registerEventKeyFrame

▸ registerEventKeyFrame(frame): void

register a event to animator

Parameters

Name	Type	Description
frame	AnimatorEventKeyframe	source AnimatorEventKeyframe

Returns

void

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:38

---

appendClip

▸ appendClip(clip): void

append a perperty animation clip

Parameters

Name	Type	Description
clip	PropertyAnimClip	source PropertyAnimClip

Returns

void

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:65

---

stop

▸ stop(): void

stop playing

Returns

void

Overrides

ComponentBase.stop

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:105

---

toggle

▸ toggle(): void

stop or resume playing

Returns

void

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:112

---

getClip

▸ getClip(name): PropertyAnimClip

get animation clip by clip name

Parameters

Name	Type
name	string

Returns

PropertyAnimClip

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:121

---

seek

▸ seek(time): void

seek the animation to assign time

Parameters

Name	Type	Description
time	number	assign time

Returns

void

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:150

---

play

▸ play(name, reset?): PropertyAnimClip

play animation by given name

Parameters

Name	Type	Default value	Description
name	string	undefined	animation name
reset	boolean	true	if true, play the animation from time 0

Returns

PropertyAnimClip

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:160

---

copyComponent

▸ copyComponent(from): this

Parameters

Name	Type
from	this

Returns

this

Overrides

ComponentBase.copyComponent

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:179

---

cloneTo

▸ cloneTo(obj): void

Create a new PropertyAnimation component, copy the properties of the current component, and add them to the target object.

Parameters

Name	Type	Description
obj	Object3D	target object3D

Returns

void

Overrides

ComponentBase.cloneTo

Defined in

src/components/anim/curveAnim/PropertyAnimation.ts:194