Class XgFrustumFX

Hierarchy

default<FrustumStyleOptions>
- XgFrustumFX

Constructors

constructor

new XgFrustumFX(__namedParameters): XgFrustumFX
Parameters
- __namedParameters: FxOptions<XgFrustumFxStyleOptions>
Returns XgFrustumFX
Overrides AbstractStereoSceneFx<FrustumStyleOptions>.constructor
- Defined in packages/engine/dist/FX/Effects/XgFrustumFX.d.ts:6

Properties

`Protected` _suppressModelMatrixUpdate

_suppressModelMatrixUpdate: boolean

`Readonly` id

id: string

show

show: boolean

Accessors

availability

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

disposed

get disposed(): boolean
Returns boolean
Inherited from AbstractStereoSceneFx.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 AbstractStereoSceneFx.geometryInstanceIdType
- Defined in packages/engine/dist/FX/Core/AbstractSceneFx.d.ts:34

graphics

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

name

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

orientation

get orientation(): Quaternion | VelocityOrientationProperty | Property
Returns Quaternion | VelocityOrientationProperty | Property
Inherited from AbstractStereoSceneFx.orientation
- Defined in packages/engine/dist/FX/Core/AbstractStereoSceneFx.d.ts:18
set orientation(val): void
Parameters
- val: Quaternion | VelocityOrientationProperty | Property
Returns void
Inherited from AbstractStereoSceneFx.orientation
- Defined in packages/engine/dist/FX/Core/AbstractStereoSceneFx.d.ts:17

position

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

Methods

_getGraphics

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

_getPrimitives

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

_updateModelMatrix

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

_updateOrientation

_updateOrientation(val?): void
Parameters
- Optional val: Quaternion
Returns void
Inherited from AbstractStereoSceneFx._updateOrientation
- Defined in packages/engine/dist/FX/Core/AbstractStereoSceneFx.d.ts:19

_updatePosition

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

`Protected` composePlacementModelMatrix

composePlacementModelMatrix(position?, orientation?): Matrix4
将 position + orientation 与放置策略旋转组合为基础的模型矩阵。子类可以调用该方法作为起点，再叠加局部偏移与样式旋转。
Parameters
- Optional position: Cartesian3
- Optional orientation: Quaternion
Returns Matrix4
Inherited from AbstractStereoSceneFx.composePlacementModelMatrix
- Defined in packages/engine/dist/FX/Core/AbstractStereoSceneFx.d.ts:30

`Protected` composePlacementModelMatrixWithLocalOffset

composePlacementModelMatrixWithLocalOffset(position?, orientation?, localOffset?): Matrix4
在放置策略的基础上，应用一个局部坐标系下的平移偏移（例如沿局部 Z 轴移动半径/长度）。
- 先组合 orientation 与放置策略旋转得到最终旋转
- 再将局部偏移向量通过最终旋转变换到世界系，并叠加到位置
Parameters
- Optional position: Cartesian3
- Optional orientation: Quaternion
- Optional localOffset: Cartesian3
Returns Matrix4
Inherited from AbstractStereoSceneFx.composePlacementModelMatrixWithLocalOffset
- Defined in packages/engine/dist/FX/Core/AbstractStereoSceneFx.d.ts:36

computeModelMatrix

computeModelMatrix(): Matrix4
Returns Matrix4
Overrides AbstractStereoSceneFx.computeModelMatrix
- Defined in packages/engine/dist/FX/Effects/XgFrustumFX.d.ts:8

dispose

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

`Protected` getPlacementRotation

getPlacementRotation(): Matrix3
Returns Matrix3
Overrides AbstractStereoSceneFx.getPlacementRotation
- Defined in packages/engine/dist/FX/Effects/XgFrustumFX.d.ts:5

getPrimitives

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

`Protected` init

init(): void
Returns void
Overrides AbstractStereoSceneFx.init
- Defined in packages/engine/dist/FX/Effects/XgFrustumFX.d.ts:7

`Protected` initAvailability

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

onAttach

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

onDetach

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

setOrientation

setOrientation(val?): void
Parameters
- Optional val: Quaternion
Returns void
Inherited from AbstractStereoSceneFx.setOrientation
- Defined in packages/engine/dist/FX/Core/AbstractStereoSceneFx.d.ts:20

setPose

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

setPosition

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

setVisible

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

updateMaterial

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

Class XgFrustumFX

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns XgFrustumFX

Properties

Protected _suppressModelMatrixUpdate

Readonly id

show

Accessors

availability

Returns TimeIntervalCollection

Parameters

Returns void

disposed

Returns boolean

Protected geometryInstanceIdType

Returns { 2d: "2d"; 3d-fill: "3d-fill"; 3d-outline: "3d-outline"; }

2d: "2d"

3d-fill: "3d-fill"

3d-outline: "3d-outline"

graphics

Returns FxGraphicOptions<T>

name

Returns string

Parameters

Returns void

orientation

Returns Quaternion | VelocityOrientationProperty | Property

Parameters

Returns void

position

Returns Cartesian3 | PositionProperty

Parameters

Returns void

Methods

_getGraphics

Returns FxGraphicOptions<FxStereoStyleOptions<FrustumStyleOptions>>

_getPrimitives

Returns PrimitiveCollection

_updateModelMatrix

Returns void

_updateOrientation

Parameters

Returns void

_updatePosition

Parameters

Returns void

Protected composePlacementModelMatrix

Parameters

Returns Matrix4

Protected composePlacementModelMatrixWithLocalOffset

Parameters

Returns Matrix4

computeModelMatrix

Returns Matrix4

dispose

Returns void

Protected getPlacementRotation

Returns Matrix3

getPrimitives

Returns PrimitiveCollection

Protected init

Returns void

Protected initAvailability

Parameters

Returns TimeIntervalCollection

onAttach

Returns void

onDetach

Returns void

setOrientation

Parameters

Returns void

`Protected` _suppressModelMatrixUpdate

`Readonly` id

`Protected` geometryInstanceIdType

Returns {
2d: "2d";
3d-fill: "3d-fill";
3d-outline: "3d-outline";
}

`Protected` composePlacementModelMatrix

`Protected` composePlacementModelMatrixWithLocalOffset

`Protected` getPlacementRotation

`Protected` init

`Protected` initAvailability