Class AlphaAnim

Hierarchy

Animation<THREE.Object3D, { opacity: number }>
- AlphaAnim

Index

Constructors

constructor

Properties

Accessors

group

Methods

Constructors

constructor

new AlphaAnim(option: { duraiton: number; from: { opacity: number }; interpolator?: AnimInterpolator; tgt: Object3D<Event>; to: { opacity: number }; traverse?: boolean }): AlphaAnim

Overrides Animation.constructor
- Defined in src/animations/animation.ts:213
Parameters
- option: { duraiton: number; from: { opacity: number }; interpolator?: AnimInterpolator; tgt: Object3D<Event>; to: { opacity: number }; traverse?: boolean }
  - duraiton: number
  - from: { opacity: number }
    - opacity: number
  - Optional interpolator?: AnimInterpolator
  - tgt: Object3D<Event>
  - to: { opacity: number }
    - opacity: number
  - Optional traverse?: boolean
Returns AlphaAnim

Properties

Protected _duration

_duration: number

Protected Readonly _interpolator

_interpolator: AnimInterpolator

Protected _tgt

_tgt: Object3D<Event>

Protected Optional _tween

_tween?: Tween<{ opacity: number }>

Protected Optional _updateCallback

_updateCallback?: (tgt: Object3D<Event>, prop: { opacity: number }, elapsed: number) => void

Type declaration

- (tgt: Object3D<Event>, prop: { opacity: number }, elapsed: number): void
- Parameters
  - tgt: Object3D<Event>
  - prop: { opacity: number }
    - opacity: number
  - elapsed: number
  Returns void

Accessors

Protected group

get group(): undefined | Group

Inherited from Animation.group
- Defined in src/animations/animation.ts:34
Returns undefined | Group

Methods

chain

chain<T2, P2>(next: Animation<T2, P2>): AlphaAnim

Inherited from Animation.chain
- Defined in src/animations/animation.ts:116
Type parameters
- T2: Partial<AnimationTarget>
- P2: PropType
Parameters
- next: Animation<T2, P2>
Returns AlphaAnim

Protected easeFunc

easeFunc(): (amount: number) => number

Inherited from Animation.easeFunc
- Defined in src/animations/animation.ts:59
Returns (amount: number) => number
- - (amount: number): number
  - Parameters
    - amount: number
    Returns number

Protected getGroup

getGroup(t?: null | Partial<AnimationTarget>): undefined | Group

Inherited from Animation.getGroup
- Defined in src/animations/animation.ts:44
Parameters
- Optional t: null | Partial<AnimationTarget>
Returns undefined | Group

Protected initialize

initialize(from: { opacity: number }, to: { opacity: number }): Tween<{ opacity: number }>

Inherited from Animation.initialize
- Defined in src/animations/animation.ts:48
Parameters
- from: { opacity: number }
  - opacity: number
- to: { opacity: number }
  - opacity: number
Returns Tween<{ opacity: number }>

onComplete

onComplete(callback: (tgt: Object3D<Event>, prop: { opacity: number }) => void): AlphaAnim

Inherited from Animation.onComplete
- Defined in src/animations/animation.ts:110
Parameters
- callback: (tgt: Object3D<Event>, prop: { opacity: number }) => void
  - - (tgt: Object3D<Event>, prop: { opacity: number }): void
    - Parameters
      - tgt: Object3D<Event>
      - prop: { opacity: number }
        opacity: number
      Returns void
Returns AlphaAnim

onStart

onStart(callback: (tgt: Object3D<Event>, prop: { opacity: number }) => void): AlphaAnim

Inherited from Animation.onStart
- Defined in src/animations/animation.ts:98
Parameters
- callback: (tgt: Object3D<Event>, prop: { opacity: number }) => void
  - - (tgt: Object3D<Event>, prop: { opacity: number }): void
    - Parameters
      - tgt: Object3D<Event>
      - prop: { opacity: number }
        opacity: number
      Returns void
Returns AlphaAnim

onStop

onStop(callback: (tgt: Object3D<Event>, prop: { opacity: number }) => void): AlphaAnim

Inherited from Animation.onStop
- Defined in src/animations/animation.ts:104
Parameters
- callback: (tgt: Object3D<Event>, prop: { opacity: number }) => void
  - - (tgt: Object3D<Event>, prop: { opacity: number }): void
    - Parameters
      - tgt: Object3D<Event>
      - prop: { opacity: number }
        opacity: number
      Returns void
Returns AlphaAnim

onUpdate

onUpdate(callback: (tgt: Object3D<Event>, prop: { opacity: number }, elapsed: number) => void): AlphaAnim

Inherited from Animation.onUpdate
- Defined in src/animations/animation.ts:94
Parameters
- callback: (tgt: Object3D<Event>, prop: { opacity: number }, elapsed: number) => void
  - - (tgt: Object3D<Event>, prop: { opacity: number }, elapsed: number): void
    - Parameters
      - tgt: Object3D<Event>
      - prop: { opacity: number }
        opacity: number
      - elapsed: number
      Returns void
Returns AlphaAnim

repeat

repeat(times: number, reverse?: boolean): AlphaAnim

Inherited from Animation.repeat
- Defined in src/animations/animation.ts:90
Parameters
- times: number
- reverse: boolean = true
Returns AlphaAnim

start

start(time?: number): AlphaAnim

Inherited from Animation.start
- Defined in src/animations/animation.ts:74
Parameters
- Optional time: number
Returns AlphaAnim

stop

stop(): AlphaAnim

Inherited from Animation.stop
- Defined in src/animations/animation.ts:78
Returns AlphaAnim

Protected update

update(prop: { opacity: number }, elapsed: number): void

Overrides Animation.update
- Defined in src/animations/animation.ts:225
Parameters
- prop: { opacity: number }
  - opacity: number
- elapsed: number
Returns void

Generated using TypeDoc