Class XgSuperGifFX

Hierarchy

default<XgSuperGifFxStyleOptions>
- XgSuperGifFX

Constructors

constructor

new XgSuperGifFX(__namedParameters): XgSuperGifFX
Parameters
- __namedParameters: FxOptions<XgSuperGifFxStyleOptions>
Returns XgSuperGifFX
Overrides AbstractSceneFx<XgSuperGifFxStyleOptions>.constructor
- Defined in packages/engine/dist/FX/Effects/XgSuperGifFX.d.ts:7

Properties

`Protected` _suppressModelMatrixUpdate

_suppressModelMatrixUpdate: boolean

`Readonly` id

id: string

`Readonly` ready

ready: Promise<XgSuperGifFX>

show

show: boolean

Accessors

availability

get availability(): TimeIntervalCollection
Returns TimeIntervalCollection
Inherited from AbstractSceneFx.availability
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:21
set availability(val): void
Parameters
- val: TimeIntervalCollection
Returns void
Inherited from AbstractSceneFx.availability
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:20

disposed

get disposed(): boolean
Returns boolean
Inherited from AbstractSceneFx.disposed
- Defined in packages/engine/dist/FX/Core/AbstractFx.d.ts:27

`Protected` geometryInstanceIdType

get geometryInstanceIdType(): {
    2d: "2d";
    3d-fill: "3d-fill";
    3d-outline: "3d-outline";
}
Returns {
    2d: "2d";
    3d-fill: "3d-fill";
    3d-outline: "3d-outline";
}
- 2d: "2d"
- 3d-fill: "3d-fill"
- 3d-outline: "3d-outline"
Inherited from AbstractSceneFx.geometryInstanceIdType
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:34

graphics

get graphics(): FxGraphicOptions<T>
Returns FxGraphicOptions<T>
Inherited from AbstractSceneFx.graphics
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:23

name

get name(): string
Returns string
Inherited from AbstractSceneFx.name
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:19
set name(val): void
Parameters
- val: string
Returns void
Inherited from AbstractSceneFx.name
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:18

position

get position(): Cartesian3 | PositionProperty
Returns Cartesian3 | PositionProperty
Inherited from AbstractSceneFx.position
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:25
set position(val): void
Parameters
- val: Cartesian3 | PositionProperty
Returns void
Inherited from AbstractSceneFx.position
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:24

Methods

_getGraphics

_getGraphics(): FxGraphicOptions<XgSuperGifFxStyleOptions>
Returns FxGraphicOptions<XgSuperGifFxStyleOptions>
Inherited from AbstractSceneFx._getGraphics
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:22

_getPrimitives

_getPrimitives(): PrimitiveCollection
Returns PrimitiveCollection
Inherited from AbstractSceneFx._getPrimitives
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:28

`Protected` _initPosition

_initPosition(): Cartesian3
Returns Cartesian3
- Defined in packages/engine/dist/FX/Effects/XgSuperGifFX.d.ts:8

_updateModelMatrix

_updateModelMatrix(): void
Returns void
Inherited from AbstractSceneFx._updateModelMatrix
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:42

`Protected` _updateOrientation

_updateOrientation(_orientation?): void
Parameters
- Optional _orientation: Quaternion
Returns void
Inherited from AbstractSceneFx._updateOrientation
- Defined in packages/engine/dist/FX/Core/AbstractFx.d.ts:16

_updatePosition

_updatePosition(val?): void
Parameters
- Optional val: Cartesian3
Returns void
Overrides AbstractSceneFx._updatePosition
- Defined in packages/engine/dist/FX/Effects/XgSuperGifFX.d.ts:9

computeModelMatrix

computeModelMatrix(): Matrix4
Returns Matrix4
Overrides AbstractSceneFx.computeModelMatrix
- Defined in packages/engine/dist/FX/Effects/XgSuperGifFX.d.ts:12

dispose

dispose(): void
Returns void
Inherited from AbstractSceneFx.dispose
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:33

getPrimitives

getPrimitives(): PrimitiveCollection
Returns PrimitiveCollection
Inherited from AbstractSceneFx.getPrimitives
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:29

`Protected` init

init(): Promise<XgSuperGifFX>
Returns Promise<XgSuperGifFX>
Overrides AbstractSceneFx.init
- Defined in packages/engine/dist/FX/Effects/XgSuperGifFX.d.ts:10

`Protected` initAvailability

initAvailability(val?): TimeIntervalCollection
Parameters
- Optional val: string | string[] | TimeIntervalCollection
Returns TimeIntervalCollection
Inherited from AbstractSceneFx.initAvailability
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:43

onAttach

onAttach(): void
Returns void
Inherited from AbstractSceneFx.onAttach
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:31

onDetach

onDetach(): void
Returns void
Inherited from AbstractSceneFx.onDetach
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:32

play

play(): void
Returns void
- Defined in packages/engine/dist/FX/Effects/XgSuperGifFX.d.ts:11

setOrientation

setOrientation(orientation?): void
Parameters
- Optional orientation: Quaternion
Returns void
Inherited from AbstractSceneFx.setOrientation
- Defined in packages/engine/dist/FX/Core/AbstractFx.d.ts:19

setPose

setPose(position?, orientation?): void
Parameters
- Optional position: Cartesian3
- Optional orientation: Quaternion
Returns void
Inherited from AbstractSceneFx.setPose
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:41

setPosition

setPosition(val?): void
Parameters
- Optional val: Cartesian3
Returns void
Inherited from AbstractSceneFx.setPosition
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:26

setVisible

setVisible(show): void
Parameters
- show: boolean
Returns void
Inherited from AbstractSceneFx.setVisible
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:30

updateMaterial

updateMaterial(_material): void
Parameters
- _material: any
Returns void
Inherited from AbstractSceneFx.updateMaterial
- Defined in packages/engine/dist/FX/Core/AbstractFx.d.ts:22