@jdultra/ultra-globe

---

@jdultra/ultra-globe / PerspectiveProjectedVideoLayer

Class: PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:13

Perspective-projected video layer.

This layer extends the projected imagery pipeline with media-playback and telemetry-driven projector pose updates so a projected video can later be coordinated by a shared timeline controller.

The projection renderer itself is inherited from the imagery layer; this class only adds playback, telemetry synchronization, visibility state, and cleanup.

Extends

• PerspectiveProjectedImageryLayer

Extended by

• MuxPerspectiveProjectedVideoLayer

Constructors

Constructor

new PerspectiveProjectedVideoLayer(properties?): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:24

Parameters

properties?

Object

Returns

PerspectiveProjectedVideoLayer

Overrides

PerspectiveProjectedImageryLayer.constructor

Properties

attribution

attribution: string | null

Defined in: layers/Layer.d.ts:29

Inherited from

PerspectiveProjectedImageryLayer.attribution

---

bounds

bounds: any

Defined in: layers/Layer.d.ts:26

Inherited from

PerspectiveProjectedImageryLayer.bounds

---

drapeOnMesh

drapeOnMesh: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:11

Inherited from

PerspectiveProjectedImageryLayer.drapeOnMesh

---

drapeOnSplats

drapeOnSplats: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:12

Inherited from

PerspectiveProjectedImageryLayer.drapeOnSplats

---

drapeOnTerrain

drapeOnTerrain: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:13

Inherited from

PerspectiveProjectedImageryLayer.drapeOnTerrain

---

featherScale

featherScale: number

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:5

Inherited from

PerspectiveProjectedImageryLayer.featherScale

---

flipY

flipY: boolean

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:4

Inherited from

PerspectiveProjectedImageryLayer.flipY

---

id

id: string | number

Defined in: layers/Layer.d.ts:24

Inherited from

PerspectiveProjectedImageryLayer.id

---

isBaseProjectedTextureLayer

isBaseProjectedTextureLayer: boolean

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:3

Inherited from

PerspectiveProjectedImageryLayer.isBaseProjectedTextureLayer

---

isLayer

isLayer: boolean

Defined in: layers/Layer.d.ts:22

Inherited from

PerspectiveProjectedImageryLayer.isLayer

---

isPerspectiveProjectedImageryLayer

isPerspectiveProjectedImageryLayer: boolean

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:120

Inherited from

PerspectiveProjectedImageryLayer.isPerspectiveProjectedImageryLayer

---

isPerspectiveProjectedVideoLayer

isPerspectiveProjectedVideoLayer: boolean | undefined

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:33

---

isProjectedImageryLayer

isProjectedImageryLayer: boolean

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:10

Inherited from

PerspectiveProjectedImageryLayer.isProjectedImageryLayer

---

isProjectedLayer

isProjectedLayer: boolean

Defined in: layers/ProjectedLayer.d.ts:15

Inherited from

PerspectiveProjectedImageryLayer.isProjectedLayer

---

isRasterLayer

isRasterLayer: boolean

Defined in: layers/RasterLayer.d.ts:21

Inherited from

PerspectiveProjectedImageryLayer.isRasterLayer

---

isSelectable

isSelectable: boolean

Defined in: layers/Layer.d.ts:23

Inherited from

PerspectiveProjectedImageryLayer.isSelectable

---

listeners

listeners: Object

Defined in: layers/Layer.d.ts:28

Inherited from

PerspectiveProjectedImageryLayer.listeners

---

localBounds

localBounds: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:9

Inherited from

PerspectiveProjectedImageryLayer.localBounds

---

map

map: any

Defined in: layers/Layer.d.ts:92

Inherited from

PerspectiveProjectedImageryLayer.map

---

material

material: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:26

Inherited from

PerspectiveProjectedImageryLayer.material

---

name

name: string

Defined in: layers/Layer.d.ts:25

Inherited from

PerspectiveProjectedImageryLayer.name

---

occlusionAware

occlusionAware: boolean

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:8

Inherited from

PerspectiveProjectedImageryLayer.occlusionAware

---

occlusionBias

occlusionBias: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:10

Inherited from

PerspectiveProjectedImageryLayer.occlusionBias

---

occlusionDepthBiasFactor

occlusionDepthBiasFactor: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:11

Inherited from

PerspectiveProjectedImageryLayer.occlusionDepthBiasFactor

---

occlusionDepthMapSize

occlusionDepthMapSize: number

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:9

Inherited from

PerspectiveProjectedImageryLayer.occlusionDepthMapSize

---

occlusionSlopeBias

occlusionSlopeBias: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:12

Inherited from

PerspectiveProjectedImageryLayer.occlusionSlopeBias

---

paused

paused: boolean | undefined

Defined in: layers/Layer.d.ts:82

Inherited from

PerspectiveProjectedImageryLayer.paused

---

projectorModel

projectorModel: PerspectiveProjectorModel

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:13

Inherited from

PerspectiveProjectedImageryLayer.projectorModel

---

queryEngine

queryEngine: PerspectiveProjectionQueryEngine

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:14

Inherited from

PerspectiveProjectedImageryLayer.queryEngine

---

queryResolution

queryResolution: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:6

Inherited from

PerspectiveProjectedImageryLayer.queryResolution

---

reference

reference: number

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:15

Inherited from

PerspectiveProjectedImageryLayer.reference

---

refreshQueryCacheEveryFrame

refreshQueryCacheEveryFrame: boolean

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:7

Inherited from

PerspectiveProjectedImageryLayer.refreshQueryCacheEveryFrame

---

showHelpers

showHelpers: boolean

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:121

Inherited from

PerspectiveProjectedImageryLayer.showHelpers

---

telemetryProvider

telemetryProvider: TelemetryProvider | null | undefined

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:34

---

texture

texture: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:15

Inherited from

PerspectiveProjectedImageryLayer.texture

---

transform

transform: Converter | undefined

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:8

Inherited from

PerspectiveProjectedImageryLayer.transform

---

transparency

transparency: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:14

Inherited from

PerspectiveProjectedImageryLayer.transparency

---

uAllowMesh

uAllowMesh: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:36

Inherited from

PerspectiveProjectedImageryLayer.uAllowMesh

---

uAllowSplats

uAllowSplats: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:37

Inherited from

PerspectiveProjectedImageryLayer.uAllowSplats

---

uAllowTerrain

uAllowTerrain: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:35

Inherited from

PerspectiveProjectedImageryLayer.uAllowTerrain

---

uCameraWorldMatrix

uCameraWorldMatrix: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:29

Inherited from

PerspectiveProjectedImageryLayer.uCameraWorldMatrix

---

uFeatherScale

uFeatherScale: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:38

Inherited from

PerspectiveProjectedImageryLayer.uFeatherScale

---

uFlipY

uFlipY: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:34

Inherited from

PerspectiveProjectedImageryLayer.uFlipY

---

uOpacity

uOpacity: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:28

Inherited from

PerspectiveProjectedImageryLayer.uOpacity

---

uProjectorNearFar

uProjectorNearFar: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:33

Inherited from

PerspectiveProjectedImageryLayer.uProjectorNearFar

---

uProjectorOcclusionBias

uProjectorOcclusionBias: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:40

Inherited from

PerspectiveProjectedImageryLayer.uProjectorOcclusionBias

---

uProjectorOcclusionDepthBiasFactor

uProjectorOcclusionDepthBiasFactor: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:41

Inherited from

PerspectiveProjectedImageryLayer.uProjectorOcclusionDepthBiasFactor

---

uProjectorOcclusionEnabled

uProjectorOcclusionEnabled: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:39

Inherited from

PerspectiveProjectedImageryLayer.uProjectorOcclusionEnabled

---

uProjectorOcclusionSlopeBias

uProjectorOcclusionSlopeBias: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:42

Inherited from

PerspectiveProjectedImageryLayer.uProjectorOcclusionSlopeBias

---

uProjectorPosition

uProjectorPosition: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:30

Inherited from

PerspectiveProjectedImageryLayer.uProjectorPosition

---

uProjectorView

uProjectorView: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:31

Inherited from

PerspectiveProjectedImageryLayer.uProjectorView

---

uProjectorViewProjection

uProjectorViewProjection: any

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:32

Inherited from

PerspectiveProjectedImageryLayer.uProjectorViewProjection

---

videoName

videoName: string

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:31

---

visible

visible: boolean

Defined in: layers/Layer.d.ts:27

Inherited from

PerspectiveProjectedImageryLayer.visible

Accessors

currentTime

Get Signature

get currentTime(): number

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:129

Returns

number

---

duration

Get Signature

get duration(): number

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:125

Returns

number

Methods

addListener()

addListener(key, listener): void

Defined in: layers/Layer.d.ts:74

Adds a listener for layer events

Parameters

key

any

can be anything but should be unique

listener

Function

a function : (layer, eventType)=>{}

Returns

void

Inherited from

PerspectiveProjectedImageryLayer.addListener

---

clearTimelineBinding()

clearTimelineBinding(): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:195

Returns

PerspectiveProjectedVideoLayer

---

deriveTimelineBindingFromTelemetry()

deriveTimelineBindingFromTelemetry(): Object | null

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:203

Returns

Object | null

---

dispose()

dispose(): void

Defined in: layers/Layer.d.ts:87

disposes of any resources used by this layer

Returns

void

Inherited from

PerspectiveProjectedImageryLayer.dispose

---

getBounds()

getBounds(): Box2

Defined in: layers/Layer.d.ts:62

Returns

Box2

bounds in longitude latitude (degrees)

Inherited from

PerspectiveProjectedImageryLayer.getBounds

---

getCenter()

getCenter(sfct): Vector3

Defined in: layers/Layer.d.ts:37

Moves a given point to this layer's center in degree longitude/latitude

Parameters

sfct

Vector3

a point to move

Returns

Vector3

the input point

Inherited from

PerspectiveProjectedImageryLayer.getCenter

---

getCurrentProjectorPose()

getCurrentProjectorPose(): Object

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:287

Returns current projector pose data useful for future camera jump and timeline integrations.

Returns

Object

---

getCurrentTelemetrySample()

getCurrentTelemetrySample(): TelemetrySample | null

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:242

Returns

TelemetrySample | null

---

getCurrentTime()

getCurrentTime(): number

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:117

Returns

number

---

getDisplayState()

getDisplayState(): Object

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:238

Returns

Object

---

getDuration()

getDuration(): number

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:121

Returns

number

---

getID()

getID(): string | number

Defined in: layers/Layer.d.ts:42

Returns

string | number

layer id

Inherited from

PerspectiveProjectedImageryLayer.getID

---

getName()

getName(): string

Defined in: layers/Layer.d.ts:47

Returns

string

layer name

Inherited from

PerspectiveProjectedImageryLayer.getName

---

getPlaybackRate()

getPlaybackRate(): number

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:141

Returns

number

---

getPlaybackState()

getPlaybackState(): Object

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:258

Returns current timeline-friendly playback state.

Returns

Object

---

getProjectorFrustumBoundingSphere()

getProjectorFrustumBoundingSphere(target?): Sphere

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:312

Parameters

target?

any

Returns

Sphere

---

getProjectorFrustumCorners()

getProjectorFrustumCorners(options?): Object

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:301

Parameters

options?

Object

Returns

Object

---

getTelemetryProvider()

getTelemetryProvider(): TelemetryProvider | null

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:108

Returns

TelemetryProvider | null

---

getTimelineBinding()

getTimelineBinding(): Object | null

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:191

Returns

Object | null

---

getTimelineSynchronizationState()

getTimelineSynchronizationState(): Object

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:234

Returns

Object

---

getTimeRange()

getTimeRange(): Object

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:175

Returns

Object

---

getVideoElement()

getVideoElement(): HTMLVideoElement | null

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:112

Returns

HTMLVideoElement | null

---

getVideoName()

getVideoName(): string

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:99

Returns

string

---

getWallClockRange()

getWallClockRange(): { startTime: number; endTime: number; duration: number; } | null

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:207

Returns

{ startTime: number; endTime: number; duration: number; } | null

---

hasTimelineBinding()

hasTimelineBinding(): boolean

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:199

Returns

boolean

---

invalidateQueryCache()

invalidateQueryCache(): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:355

Invalidates cached UV-to-world query results.

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.invalidateQueryCache

---

isEnded()

isEnded(): boolean

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:137

Returns

boolean

---

isPaused()

isPaused(): boolean

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:133

Returns

boolean

---

isProjectionFrustumVisible()

isProjectionFrustumVisible(camera?): boolean

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:317

Parameters

camera?

any

Returns

boolean

---

pause()

pause(): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:154

Returns

PerspectiveProjectedVideoLayer

---

play()

play(): void | Promise<void>

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:150

Returns

void | Promise<void>

---

projectWorldToUV()

projectWorldToUV(worldPosition): Object

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:339

Projects a world Cartesian position into projector UV space.

Parameters

worldPosition

any

World Cartesian position in EPSG:4978 meters.

Returns

Object

Inherited from

PerspectiveProjectedImageryLayer.projectWorldToUV

---

queryUVToTerrain()

queryUVToTerrain(uv, options?): Promise<{ position: any; type: number | null; valid: boolean; distance?: number; uv: any; }>

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:403

Resolves a projector UV back to a terrain hit.

Parameters

uv

any

Projector UV coordinate.

options?

Object

Returns

Promise<{ position: any; type: number | null; valid: boolean; distance?: number; uv: any; }>

Async

Inherited from

PerspectiveProjectedImageryLayer.queryUVToTerrain

---

queryUVToWorld()

queryUVToWorld(uv, options?): Promise<{ position: any; type: number | null; valid: boolean; distance?: number; uv: any; }>

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:376

Resolves a projector UV back to a world hit.

Terrain is supported now. Mesh and splat targets are intentionally left as future extensions behind the same public method.

Parameters

uv

any

Projector UV coordinate.

options?

Object

Returns

Promise<{ position: any; type: number | null; valid: boolean; distance?: number; uv: any; }>

Async

Inherited from

PerspectiveProjectedImageryLayer.queryUVToWorld

---

raycast()

raycast(raycaster): any[]

Defined in: layers/Layer.d.ts:80

raycasts through objects from this layer if the layer is selectable and if the objects are raycastable

Parameters

raycaster

Object

a three.js Raycaster

Returns

any[]

an array of selected objects

Inherited from

PerspectiveProjectedImageryLayer.raycast

---

removeListener()

removeListener(key): void

Defined in: layers/Layer.d.ts:68

Removes the listener associated to the given key

Parameters

key

any

can be anything but should be unique

Returns

void

Inherited from

PerspectiveProjectedImageryLayer.removeListener

---

render()

render(colorTexture, normalTexture, emissiveTexture, metalnessRoughnessTexture, positionTexture, renderTarget): boolean

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:69

Render imagery into a render target using the provided position texture. Subclasses must implement this method.

Parameters

colorTexture

any

normalTexture

any

emissiveTexture

any

metalnessRoughnessTexture

any

positionTexture

any

renderTarget

any

Returns

boolean

Inherited from

PerspectiveProjectedImageryLayer.render

---

resolveMediaTimeForWallClockTime()

resolveMediaTimeForWallClockTime(wallClockTime, options?): number | null

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:217

Parameters

wallClockTime

number

options?

Object

Returns

number | null

---

seek()

seek(timeSeconds): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:159

Parameters

timeSeconds

number

Returns

PerspectiveProjectedVideoLayer

---

setCurrentTime()

setCurrentTime(timeSeconds): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:164

Parameters

timeSeconds

number

Returns

PerspectiveProjectedVideoLayer

---

setFeatherScale()

setFeatherScale(featherScale): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:284

Updates the optional UV border feather width.

A value of 0 disables feathering. Positive values apply a smooth alpha fade near projector UV borders.

Parameters

featherScale

number

Feather width in normalized UV units.

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setFeatherScale

---

setFlipY()

setFlipY(flipY): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:274

Updates the projected V orientation.

Parameters

flipY

boolean

Whether projected V should be flipped.

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setFlipY

---

setIntrinsics()

setIntrinsics(intrinsics?): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:213

Updates projector intrinsics.

Parameters

intrinsics?

Object

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setIntrinsics

---

setName()

setName(name): void

Defined in: layers/Layer.d.ts:52

change the layer name

Parameters

name

string

Returns

void

Inherited from

PerspectiveProjectedImageryLayer.setName

---

setOcclusionAware()

setOcclusionAware(occlusionAware?): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:294

Enables or disables projector-view occlusion masking.

When enabled, the layer renders a depth map from the projector camera each frame and suppresses projected texels on receivers that sit behind nearer geometry.

Parameters

occlusionAware?

boolean

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setOcclusionAware

---

setOcclusionBias()

setOcclusionBias(options?): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:301

Updates occlusion-bias parameters.

Parameters

options?

Object

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setOcclusionBias

---

setOcclusionDepthMapSize()

setOcclusionDepthMapSize(size?): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:312

Updates the projector depth-map resolution used for occlusion masking.

Parameters

size?

number

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setOcclusionDepthMapSize

---

setPlaybackRate()

setPlaybackRate(playbackRate): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:146

Parameters

playbackRate

number

Returns

PerspectiveProjectedVideoLayer

---

setProjectorPose()

setProjectorPose(pose?): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:145

Updates the projector pose.

Two forms are supported:

• world-space pose with positionWorld and quaternion
• geodetic pose with projectorLLH (or one of its aliases) plus yaw / pitch / roll

Any successful pose update invalidates cached UV queries and refreshes the helper frustum.

Parameters

pose?

Object

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setProjectorPose

---

setProjectorPoseFromLLHYawPitchRoll()

setProjectorPoseFromLLHYawPitchRoll(llh, yaw, pitch, roll): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:185

Sets the projector pose from geodetic coordinates and yaw / pitch / roll.

Parameters

llh

any

Projector longitude, latitude, height.

yaw

number

Projector yaw in degrees.

pitch

number

Projector pitch in degrees.

roll

number

Projector roll in degrees.

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setProjectorPoseFromLLHYawPitchRoll

---

setProjectorPoseFromWorldQuaternion()

setProjectorPoseFromWorldQuaternion(positionWorld, quaternion): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:197

Sets the projector pose from a world Cartesian position and quaternion.

Parameters

positionWorld

any

Projector world Cartesian position.

quaternion

any

Projector world orientation.

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setProjectorPoseFromWorldQuaternion

---

setShowHelpers()

setShowHelpers(showHelpers?): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:319

Enables or disables the white frustum helper lines.

Parameters

showHelpers?

boolean

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setShowHelpers

---

setTargetMask()

setTargetMask(targetMask?): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:263

Sets which drape target classes may receive the projection.

Parameters

targetMask?

Object

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setTargetMask

---

setTelemetryProvider()

setTelemetryProvider(telemetryProvider): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:104

Parameters

telemetryProvider

TelemetryProvider | null

Returns

PerspectiveProjectedVideoLayer

---

setTexture()

setTexture(texture, options?): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:323

Parameters

texture

Texture

options?

Object

Returns

PerspectiveProjectedVideoLayer

Overrides

PerspectiveProjectedImageryLayer.setTexture

---

setTimelineBinding()

setTimelineBinding(binding): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:187

Parameters

binding

Object | null

Returns

PerspectiveProjectedVideoLayer

---

setVideo()

setVideo(video, options?): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:343

Parameters

video

HTMLVideoElement

options?

Object

Returns

PerspectiveProjectedVideoLayer

Overrides

PerspectiveProjectedImageryLayer.setVideo

---

setVideoName()

setVideoName(videoName): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:95

Parameters

videoName

string

Returns

PerspectiveProjectedVideoLayer

---

setVideoTexture()

setVideoTexture(videoTexture, options?): PerspectiveProjectedVideoLayer

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:333

Parameters

videoTexture

VideoTexture

options?

Object

Returns

PerspectiveProjectedVideoLayer

Overrides

PerspectiveProjectedImageryLayer.setVideoTexture

---

setVisible()

setVisible(visible): PerspectiveProjectedImageryLayer

Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:326

Shows or hides the layer and its helper geometry.

Parameters

visible

boolean

Whether the layer should be visible.

Returns

PerspectiveProjectedImageryLayer

Inherited from

PerspectiveProjectedImageryLayer.setVisible

---

synchronizeToTimeline()

synchronizeToTimeline(timelineState): Object

Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:224

Parameters

timelineState

Object

Returns

Object

---

updateMaterialTexture()

updateMaterialTexture(): void

Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:50

Returns

void

Inherited from

PerspectiveProjectedImageryLayer.updateMaterialTexture