Class ClippingControl

Hierarchy

Control
- ClippingControl
  - ClippingControl

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ClippingControl(viewer: Viewer, center: Vector3, dimensions: Vector3, clippingType?: CESIUM_3D_TILE | TERRAIN | BOTH): ClippingControl

Overrides Control.constructor

Parameters
- viewer: Viewer
- center: Vector3
- dimensions: Vector3
- Optional clippingType: CESIUM_3D_TILE | TERRAIN | BOTH
Returns ClippingControl

Properties

clippingEditor

clippingEditor: ClippingPlaneEditor

dragEnd

dragEnd: Event

dragStart

dragStart: Event

inputMap

inputMap: undefined | InputMap

moveRate

moveRate: number

viewer

viewer: Viewer

Accessors

center

get center(): Vector3
set center(value: Vector3): void

Returns Vector3
Parameters
- value: Vector3
Returns void

dimensions

get dimensions(): Vector3
set dimensions(value: Vector3): void

Returns Vector3
Parameters
- value: Vector3
Returns void

isReverse

get isReverse(): boolean
set isReverse(value: boolean): void

Returns boolean
Parameters
- value: boolean
Returns void

isShowClippingPlane

get isShowClippingPlane(): boolean
set isShowClippingPlane(value: boolean): void

Returns boolean
Parameters
- value: boolean
Returns void

outlineColor

get outlineColor(): Color
set outlineColor(color: Color): void

Returns Color
Parameters
- color: Color
Returns void

planeColor

get planeColor(): Color
set planeColor(color: Color): void

Returns Color
Parameters
- color: Color
Returns void

selectColor

get selectColor(): Color
set selectColor(color: Color): void

Returns Color
Parameters
- color: Color
Returns void

Methods

addClippingPlane

addClippingPlane(type: ClippingPlaneType, center?: Vector3, dimensions?: Vector3): void

Parameters
- type: ClippingPlaneType
- Optional center: Vector3
- Optional dimensions: Vector3
Returns void

addClippingPlaneByPlane

addClippingPlaneByPlane(normal: Vector3, point: Vector3): void

Parameters
- normal: Vector3
- point: Vector3
Returns void

addUpdateCallback

addUpdateCallback(callback: (planeType: string, curDistance: number) => void): void

Parameters
- callback: (planeType: string, curDistance: number) => void
  - - (planeType: string, curDistance: number): void
    - Parameters
      - planeType: string
      - curDistance: number
      Returns void
Returns void

destroy

destroy(): undefined

Inherited from Control.destroy

Returns undefined

forceUpdate

forceUpdate(): void

Returns void

getCurrentPlaneInfo

getCurrentPlaneInfo(): { curDistance: number; planeType: string }[]

Returns { curDistance: number; planeType: string }[]

isDestroyed

isDestroyed(): boolean

Inherited from Control.isDestroyed

Returns boolean

keyDownCallback

keyDownCallback(evt: KeyboardEvent): void

Inherited from Control.keyDownCallback

Parameters
- evt: KeyboardEvent
Returns void

keyUpCallback

keyUpCallback(evt: KeyboardEvent): void

Inherited from Control.keyUpCallback

Parameters
- evt: KeyboardEvent
Returns void

onLeftDown

onLeftDown(movement: Vector2): void

Parameters
- movement: Vector2
Returns void

onLeftUp

onLeftUp(movement: Vector2): void

Parameters
- movement: Vector2
Returns void

onMouseMove

onMouseMove(movement: Vector2): void

Parameters
- movement: Vector2
Returns void

register

register(): void

Inherited from Control.register

Returns void

removeApplyType

removeApplyType(apply: ControlApplyType): void

Inherited from Control.removeApplyType

Parameters
- apply: ControlApplyType
Returns void

reset

reset(): void

Returns void

resetManipulatorParams

resetManipulatorParams(options: ManipulatorControlOptions): void

Parameters
- options: ManipulatorControlOptions
Returns void

setApplyType

setApplyType(apply: ControlApplyType, downAction: (windowPosition: undefined | number | Vector2 | PitchPosition) => void, upAction: (windowPosition: undefined | number | Vector2 | PitchPosition) => void): void

Inherited from Control.setApplyType

Parameters
- apply: ControlApplyType
- downAction: (windowPosition: undefined | number | Vector2 | PitchPosition) => void
  - - (windowPosition: undefined | number | Vector2 | PitchPosition): void
    - Parameters
      - windowPosition: undefined | number | Vector2 | PitchPosition
      Returns void
- upAction: (windowPosition: undefined | number | Vector2 | PitchPosition) => void
  - - (windowPosition: undefined | number | Vector2 | PitchPosition): void
    - Parameters
      - windowPosition: undefined | number | Vector2 | PitchPosition
      Returns void
Returns void

setPlaneDistance

setPlaneDistance(planeType: string, distance: number): void

Parameters
- planeType: string
- distance: number
Returns void

setPlaneOffset

setPlaneOffset(planeType: string, distanceOffset: number): void

Parameters
- planeType: string
- distanceOffset: number
Returns void

setPlaneVisibility

setPlaneVisibility(planeType: ClippingPlaneTypes, value: boolean): void

Parameters
- planeType: ClippingPlaneTypes
- value: boolean
Returns void

setPlanesVisibility

setPlanesVisibility(value: boolean): void

Parameters
- value: boolean
Returns void