Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NgxClipComponent

The Clip component.

See the ngx3js docs page for details.

An AnimationClip is a reusable set of keyframe tracks which represent an animation.

For an overview of the different elements of the three.js animation system see the "Animation System" article in the "Next Steps" section of the manual.

<ngx3js-mixer [action]="'base'">
<ngx3js-clip [name]="'base'" [index]="0"></ngx3js-clip>
</ngx3js-mixer>
<ngx3js-mixer [action]="'Run'">
<ngx3js-clip [name]="'Run'"></ngx3js-clip>
</ngx3js-mixer>

Hierarchy

Implements

  • OnInit

Index

Constructors

constructor

Properties

Protected OBJECT_ATTR

OBJECT_ATTR: string[] = ...

Object attr of abstract subscribe component

Protected _changeList

_changeList: string[] = null

Change list of abstract subscribe component

Protected _needUpdate

_needUpdate: boolean = true

Need update of abstract subscribe component

action

action: AnimationAction = null

The Action of clip component

additive

additive: boolean = false

makeClipAdditive

see

THREE.AnimationUtils.makeClipAdditive

blendMode

blendMode: string = ''

The blendMode of clip component

Three Type Value String(case insensitive)
THREE.NormalAnimationBlendMode NormalAnimationBlendMode, NormalAnimation, Normal
THREE.AdditiveAnimationBlendMode AdditiveAnimationBlendMode, AdditiveAnimation, Additive

clampWhenFinished

clampWhenFinished: boolean = false

If clampWhenFinished is set to true the animation will automatically be AnimationClip.paused on its last frame. If clampWhenFinished is set to false, AnimationClip.enabled will automatically be switched to false when the last loop of the action has finished, so that this action has no further impact. Default is false. Note: clampWhenFinished has no impact if the action is interrupted (it has only an effect if its last loop has really finished).

debug

debug: boolean = false

Debug this Object

duration

duration: number = 3

The duration of this clip (in seconds). This can be calculated from the AnimationClip.tracks array via AnimationClip.resetDuration.

enabled

enabled: boolean = true

Enabled or Not

endFrame

endFrame: number = 3

Creates a new clip, containing only the segment of the original clip between the given frames.

fps

fps: number = null

Creates a new clip, containing only the segment of the original clip between the given frames.

Protected id

id: string = ''

The Id of abstract subscribe component

index

index: number = -1

The index of clip component

loop

loop: string = null

The looping mode (can be changed with AnimationClip.setLoop). Default is THREE.LoopRepeat (with an infinite number of AnimationClip.repetitions)

Three Type Value String(case insensitive)
THREE.LoopOnce LoopOnce, Once
THREE.LoopRepeat LoopRepeat, Repeat
THREE.LoopPingPong LoopPingPong, PingPong

name

name: string = ''

A name for this clip. A certain clip can be searched via AnimationClip.findByName.

onDestory

onDestory: EventEmitter<NgxClipComponent> = ...

Will be called when before destory. The argument will be the loaded self

onLoad

onLoad: EventEmitter<NgxClipComponent> = ...

Will be called when load completes. The argument will be the loaded self

overrideParams

overrideParams: {} = null

The override params

Type declaration

  • [key: string]: any

Protected parent

parent: any = null

The Parent of abstract subscribe component

Protected selfAny

selfAny: any = ...

startFrame

startFrame: number = 2

Creates a new clip, containing only the segment of the original clip between the given frames.

subclip

subclip: boolean = false

subclip

see

THREE.AnimationUtils.subclip

Protected subscribeType

subscribeType: string = null

Subscribe type of abstract subscribe component

timeScale

timeScale: number = 1

Scaling factor for the AnimationClip.time. A value of 0 causes the animation to pause. Negative values cause the animation to play backwards. Default is 1.

tween

tween: {} = null

Tween animation params

Type declaration

  • [key: string]: any

userData

userData: any = null

An object that can be used to store custom data about the Object3D. It should not hold references to functions as these will not be cloned.

weight

weight: number = 1

The degree of influence of this action (in the interval [0, 1]). Values between 0 (no impact) and 1 (full impact) can be used to blend between several actions. Default is 1. Properties/methods concerning weight are:

windowExport

windowExport: string = null

Export this Object to window global variables

Accessors

needUpdate

  • set needUpdate(value: boolean): void
  • Sets need update

    Parameters

    • value: boolean

    Returns void

Methods

addChanges

  • addChanges(key: string | string[] | SimpleChanges): void

applyChanges

  • applyChanges(changes: string[]): void

Protected callOnLoad

  • callOnLoad(): void

Protected checkChanges

  • checkChanges(changes: SimpleChanges): SimpleChanges

Protected clearChanges

  • clearChanges(): void

Protected consoleLog

  • consoleLog(key: string, object: any, level?: string): void

Protected consoleLogTime

  • consoleLogTime(key: string, object: any, repeat?: number): void

crossFadeTo

Protected destroyLocalComponent

  • destroyLocalComponent(key: string): void

dispose

  • dispose(): void

fadeIn

  • fadeIn(duration?: number): void

fadeOut

  • fadeOut(duration?: number): void

Protected getChanges

  • getChanges(): string[]

getClip

getId

  • getId(): string

getObject

  • getObject<T>(): T

getSubscribe

  • getSubscribe(): Observable<string[]>

Protected getTimeout

  • getTimeout(timeDelay?: number): Promise<void>

getUserData

  • getUserData(): {}

Protected initLocalComponent

  • initLocalComponent<T>(key: string, component: T): T

Protected isIdEuals

  • isIdEuals(id: string): boolean

isPlayable

  • isPlayable(): boolean

ngAfterContentInit

  • ngAfterContentInit(): void

ngOnChanges

  • ngOnChanges(changes: SimpleChanges): void
  • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated. default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

    Parameters

    • changes: SimpleChanges

      The changed properties.

    Returns void

ngOnDestroy

  • ngOnDestroy(): void

ngOnInit

  • ngOnInit(): void
  • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

    Returns void

play

  • play(): void

resetAction

  • resetAction(): void

resetTween

  • resetTween(): void

runSubscribeNext

  • runSubscribeNext(key: string | string[]): void

setFps

  • setFps(fps: number): void

setMixer

Protected setObject

  • setObject(obj: any): void

setParent

  • setParent(parent: any): boolean

setSubscribeNext

  • setSubscribeNext(key: string | string[]): void

setSubscribeType

  • setSubscribeType(subscribeType: string): void

setTween

  • setTween(tweenData: {}): void

setTweenTarget

  • setTweenTarget(tweenTarget: any): void

setUserData

  • setUserData(key: string, value: any): void

stop

  • stop(): void

Protected subscribeListQuery

  • subscribeListQuery(queryList: QueryList<any>, subscribeKey: string, changeKey: string): void

Protected subscribeListQueryChange

  • subscribeListQueryChange(queryList: QueryList<any>, subscribeKey: string, changeKey: string): void

Protected subscribeRefer

  • subscribeRefer(key: string, subscription: Subscription): void

Protected subscribeReferList

  • subscribeReferList(key: string, subscription: Subscription): void

Protected unSubscribeRefer

  • unSubscribeRefer(key: string): void

Protected unSubscribeReferList

  • unSubscribeReferList(key: string): void

Protected unSubscription

  • unSubscription(subscriptions: Subscription[]): Subscription[]

updateInputParams

  • updateInputParams(params: {}, firstChange?: boolean, changes?: SimpleChanges, type?: string): void

Generated using TypeDoc