@orillusion/core

---

Class: PropertyAnimation

Defined in: src/components/anim/curveAnim/PropertyAnimation.ts:11

Attribute Animation Component

Extends

• ComponentBase

Constructors

Constructor

new PropertyAnimation(): PropertyAnimation

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

Returns

PropertyAnimation

Overrides

ComponentBase.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

ComponentBase.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

ComponentBase.isDestroyed

---

defaultClip

defaultClip: string

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

name of default animation clip

---

autoPlay

autoPlay: boolean

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

is it play auto

Accessors

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

ComponentBase.visibleLayer

---

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

ComponentBase.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

ComponentBase.isStart

---

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

ComponentBase.transform

---

enable

Get Signature

get enable(): boolean

Defined in: src/components/ComponentBase.ts:113

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

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/ComponentBase.ts:96

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

Parameters

value

boolean

Returns

void

Inherited from

ComponentBase.enable

---

speed

Get Signature

get speed(): number

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

get playing speed

Returns

number

Set Signature

set speed(value): void

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

set playing speed

Parameters

value

number

Returns

void

---

currentClip

Get Signature

get currentClip(): PropertyAnimClip

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

get animation clip which is playing now

Returns

PropertyAnimClip

---

time

Get Signature

get time(): number

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

get time of current animator

Returns

number

Methods

onEnable()?

optional onEnable(view?): any

Defined in: src/components/ComponentBase.ts:164

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onEnable

---

onDisable()?

optional onDisable(view?): any

Defined in: src/components/ComponentBase.ts:165

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onDisable

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onBeforeUpdate

---

onCompute()?

optional onCompute(view?, command?): any

Defined in: src/components/ComponentBase.ts:169

Parameters

view?

View3D

command?

GPUCommandEncoder

Returns

any

Inherited from

ComponentBase.onCompute

---

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onGraphic

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

ComponentBase.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

ComponentBase.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

ComponentBase.onRemoveChild

---

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/ComponentBase.ts:249

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

Parameters

force?

boolean

Returns

void

Inherited from

ComponentBase.beforeDestroy

---

destroy()

destroy(force?): void

Defined in: src/components/ComponentBase.ts:256

release this component

Parameters

force?

boolean

Returns

void

Inherited from

ComponentBase.destroy

---

registerEventKeyFrame()

registerEventKeyFrame(frame): void

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

register a event to animator

Parameters

frame

AnimatorEventKeyframe

source AnimatorEventKeyframe

Returns

void

---

appendClip()

appendClip(clip): void

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

append a perperty animation clip

Parameters

clip

PropertyAnimClip

source PropertyAnimClip

Returns

void

---

stop()

stop(): void

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

stop playing

Returns

void

Overrides

ComponentBase.stop

---

toggle()

toggle(): void

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

stop or resume playing

Returns

void

---

getClip()

getClip(name): PropertyAnimClip

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

get animation clip by clip name

Parameters

name

string

Returns

PropertyAnimClip

---

seek()

seek(time): void

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

seek the animation to assign time

Parameters

time

number

assign time

Returns

void

---

play()

play(name, reset?): PropertyAnimClip

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

play animation by given name

Parameters

name

string

animation name

reset?

boolean = true

if true, play the animation from time 0

Returns

PropertyAnimClip

---

copyComponent()

copyComponent(from): this

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

Parameters

from

this

Returns

this

Overrides

ComponentBase.copyComponent

---

cloneTo()

cloneTo(obj): void

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

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

Parameters

obj

Object3D

target object3D

Returns

void

Overrides

ComponentBase.cloneTo