Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NgxEffectComponent

The Effect component.

See the ngx3js docs page for details. See the ngx effect page for a live demo.

Three Type Type Key Acceptable Input
AsciiEffect AsciiEffect, Ascii resolution, scale, color, alpha, block, invert
PeppersGhostEffect PeppersGhostEffect, PeppersGhost cameraDistance, reflectFromAbove
OutlineEffect OutlineEffect, Outline
ParallaxBarrierEffect ParallaxBarrierEffect, ParallaxBarrier
EffectComposer EffectComposer, Effect renderToScreen 
<ngx3js-effect>
    <ngx3js-pass [type]="'RenderPass'"></ngx3js-pass>
</ngx3js-effect>
<ngx3js-effect [scene]="scene" [camera]="camera">
    <ngx3js-pass [type]="'RenderPass'"></ngx3js-pass>
</ngx3js-effect>

Hierarchy

Implements

  • OnInit

Index

Constructors

Properties

Accessors

Methods

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

alpha

alpha: boolean = null

The alpha of effect component

block

block: boolean = null

The block of effect component

camera

camera: I3JS.Camera | NgxCameraComponent = null

The camera of effect

cameraDistance

cameraDistance: number = null

The cameraDistance of effect component

charSet

charSet: string = null

AsciiEffect

see

AsciiEffect AsciiEffect

clear

clear: boolean = false

The clear of effect component

color

color: boolean = null

The color of effect component

debug

debug: boolean = false

Debug this Object

enabled

enabled: boolean = true

Enabled or Not

height

height: string | number = '100%'

The size of height

  • type number fixed size
  • type string with include % relative size from renderer size for example in case renderer = 1024 '100%' = 1024, '50%' = 512, '50%-10' = 502, '50%+30' = 542

Protected id

id: string = ''

The Id of abstract subscribe component

invert

invert: boolean = null

The invert of effect component

onDestory

onDestory: EventEmitter<NgxEffectComponent> = ...

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

onLoad

onLoad: EventEmitter<NgxEffectComponent> = ...

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

reflectFromAbove

reflectFromAbove: boolean = null

The reflectFromAbove of effect component

renderToScreen

renderToScreen: boolean = null

The renderToScreen of effect component

resolution

resolution: number = null

The resolution of effect component

scale

scale: number = null

The scale of effect component

scene

scene: I3JS.Scene | NgxSceneComponent = null

The scene of effect

scissorHeight

scissorHeight: string | number = '100%'

The scissor of height

  • type number fixed size
  • type string with include % relative size from renderer size for example in case renderer = 1024 '100%' = 1024, '50%' = 512, '50%-10' = 502, '50%+30' = 542

scissorTest

scissorTest: boolean = false

The scissorTest of effect component

scissorWidth

scissorWidth: string | number = '100%'

The scissor of width

  • type number fixed size
  • type string with include % relative size from renderer size for example in case renderer = 1024 '100%' = 1024, '50%' = 512, '50%-10' = 502, '50%+30' = 542

scissorX

scissorX: string | number = 0

The scissor position of left

  • type number fixed position
  • type string with include % relative position from renderer size for example in case renderer = 1024 '100%' = 1024, '50%' = 512, '50%-10' = 502, '50%+30' = 542

scissorY

scissorY: string | number = 0

The scissor position of top

  • type number fixed position
  • type string with include % relative position from renderer size for example in case renderer = 1024 '100%' = 1024, '50%' = 512, '50%-10' = 502, '50%+30' = 542

Protected selfAny

selfAny: any = ...

Protected subscribeType

subscribeType: string = null

Subscribe type of abstract subscribe component

tween

tween: {} = null

Tween animation params

Type declaration

  • [key: string]: any

type

type: string = 'effect'

The type of effect

Notice - case insensitive.

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.

viewport

viewport: boolean = false

The viewport of effect component

viewportAspect

viewportAspect: boolean = false

The viewportAspect of effect component

width

width: string | number = '100%'

The size of width

  • type number fixed size
  • type string with include % relative size from renderer size for example in case renderer = 1024 '100%' = 1024, '50%' = 512, '50%-10' = 502, '50%+30' = 542

windowExport

windowExport: string = null

Export this Object to window global variables

x

x: string | number = 0

The x of effect component

y

y: string | number = 0

The y of effect component

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

Protected destroyLocalComponent

  • destroyLocalComponent(key: string): void

dispose

  • dispose(): void

Protected getChanges

  • getChanges(): string[]

getEffect

  • getEffect(): any

getId

  • getId(): string

getObject

  • getObject<T>(): T

getReadBuffer

getRenderTarget1

getRenderTarget2

getSubscribe

  • getSubscribe(): Observable<string[]>

Protected getTimeout

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

getUserData

  • getUserData(): {}

getWriteBuffer

Protected initLocalComponent

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

Protected isIdEuals

  • isIdEuals(id: string): 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

render

resetTween

  • resetTween(): void

runSubscribeNext

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

Protected setObject

  • setObject(obj: any): void

setParent

  • setParent(parent: any): boolean

setRenderer

setRendererSize

  • setRendererSize(width: number, height: number, pixelRatio: number): void

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

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