Appearance
@jdultra/ultra-globe / MuxPerspectiveProjectedVideoLayer
Class: MuxPerspectiveProjectedVideoLayer
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:11
Mux-backed perspective projected video layer.
This layer creates an HLS playback pipeline for a Mux playback ID, projects the resulting video through the existing perspective-projection renderer, and conservatively reduces stream activity when the projection frustum is outside the main render camera view.
Extends
Constructors
Constructor
new MuxPerspectiveProjectedVideoLayer(
properties?):MuxPerspectiveProjectedVideoLayer
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:24
Parameters
properties?
Object
Returns
MuxPerspectiveProjectedVideoLayer
Overrides
PerspectiveProjectedVideoLayer.constructor
Properties
attribution
attribution:
string|null
Defined in: layers/Layer.d.ts:29
Inherited from
PerspectiveProjectedVideoLayer.attribution
bounds
bounds:
any
Defined in: layers/Layer.d.ts:26
Inherited from
PerspectiveProjectedVideoLayer.bounds
desiredVideoQuality
desiredVideoQuality: {
mode:string;maxHeight:number;label:any; } | {mode:string;maxHeight:null;label:any; }
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:50
drapeOnMesh
drapeOnMesh:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:11
Inherited from
PerspectiveProjectedVideoLayer.drapeOnMesh
drapeOnSplats
drapeOnSplats:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:12
Inherited from
PerspectiveProjectedVideoLayer.drapeOnSplats
drapeOnTerrain
drapeOnTerrain:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:13
Inherited from
PerspectiveProjectedVideoLayer.drapeOnTerrain
featherScale
featherScale:
number
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:5
Inherited from
PerspectiveProjectedVideoLayer.featherScale
flipY
flipY:
boolean
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:4
Inherited from
PerspectiveProjectedVideoLayer.flipY
hlsConfig
hlsConfig:
Object
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:41
id
id:
string|number
Defined in: layers/Layer.d.ts:24
Inherited from
PerspectiveProjectedVideoLayer.id
isBaseProjectedTextureLayer
isBaseProjectedTextureLayer:
boolean
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:3
Inherited from
PerspectiveProjectedVideoLayer.isBaseProjectedTextureLayer
isLayer
isLayer:
boolean
Defined in: layers/Layer.d.ts:22
Inherited from
PerspectiveProjectedVideoLayer.isLayer
isMuxPerspectiveProjectedVideoLayer
isMuxPerspectiveProjectedVideoLayer:
boolean
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:37
isPerspectiveProjectedImageryLayer
isPerspectiveProjectedImageryLayer:
boolean
Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:120
Inherited from
PerspectiveProjectedVideoLayer.isPerspectiveProjectedImageryLayer
isPerspectiveProjectedVideoLayer
isPerspectiveProjectedVideoLayer:
boolean|undefined
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:33
Inherited from
PerspectiveProjectedVideoLayer.isPerspectiveProjectedVideoLayer
isProjectedImageryLayer
isProjectedImageryLayer:
boolean
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:10
Inherited from
PerspectiveProjectedVideoLayer.isProjectedImageryLayer
isProjectedLayer
isProjectedLayer:
boolean
Defined in: layers/ProjectedLayer.d.ts:15
Inherited from
PerspectiveProjectedVideoLayer.isProjectedLayer
isRasterLayer
isRasterLayer:
boolean
Defined in: layers/RasterLayer.d.ts:21
Inherited from
PerspectiveProjectedVideoLayer.isRasterLayer
isSelectable
isSelectable:
boolean
Defined in: layers/Layer.d.ts:23
Inherited from
PerspectiveProjectedVideoLayer.isSelectable
listeners
listeners:
Object
Defined in: layers/Layer.d.ts:28
Inherited from
PerspectiveProjectedVideoLayer.listeners
localBounds
localBounds:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:9
Inherited from
PerspectiveProjectedVideoLayer.localBounds
map
map:
any
Defined in: layers/Layer.d.ts:92
Inherited from
PerspectiveProjectedVideoLayer.map
material
material:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:26
Inherited from
PerspectiveProjectedVideoLayer.material
muxPlaybackId
muxPlaybackId:
string
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:38
muxStreamBaseUrl
muxStreamBaseUrl:
string
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:39
name
name:
string
Defined in: layers/Layer.d.ts:25
Inherited from
PerspectiveProjectedVideoLayer.name
occlusionAware
occlusionAware:
boolean
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:8
Inherited from
PerspectiveProjectedVideoLayer.occlusionAware
occlusionBias
occlusionBias:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:10
Inherited from
PerspectiveProjectedVideoLayer.occlusionBias
occlusionDepthBiasFactor
occlusionDepthBiasFactor:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:11
Inherited from
PerspectiveProjectedVideoLayer.occlusionDepthBiasFactor
occlusionDepthMapSize
occlusionDepthMapSize:
number
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:9
Inherited from
PerspectiveProjectedVideoLayer.occlusionDepthMapSize
occlusionSlopeBias
occlusionSlopeBias:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:12
Inherited from
PerspectiveProjectedVideoLayer.occlusionSlopeBias
paused
paused:
boolean|undefined
Defined in: layers/Layer.d.ts:82
Inherited from
PerspectiveProjectedVideoLayer.paused
preferNativeHls
preferNativeHls:
boolean
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:40
projectorModel
projectorModel:
PerspectiveProjectorModel
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:13
Inherited from
PerspectiveProjectedVideoLayer.projectorModel
queryEngine
queryEngine:
PerspectiveProjectionQueryEngine
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:14
Inherited from
PerspectiveProjectedVideoLayer.queryEngine
queryResolution
queryResolution:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:6
Inherited from
PerspectiveProjectedVideoLayer.queryResolution
reference
reference:
number
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:15
Inherited from
PerspectiveProjectedVideoLayer.reference
refreshQueryCacheEveryFrame
refreshQueryCacheEveryFrame:
boolean
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:7
Inherited from
PerspectiveProjectedVideoLayer.refreshQueryCacheEveryFrame
showHelpers
showHelpers:
boolean
Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:121
Inherited from
PerspectiveProjectedVideoLayer.showHelpers
telemetryProvider
telemetryProvider:
TelemetryProvider|null|undefined
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:34
Inherited from
PerspectiveProjectedVideoLayer.telemetryProvider
texture
texture:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:15
Inherited from
PerspectiveProjectedVideoLayer.texture
transform
transform:
Converter|undefined
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:8
Inherited from
PerspectiveProjectedVideoLayer.transform
transparency
transparency:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:14
Inherited from
PerspectiveProjectedVideoLayer.transparency
uAllowMesh
uAllowMesh:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:36
Inherited from
PerspectiveProjectedVideoLayer.uAllowMesh
uAllowSplats
uAllowSplats:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:37
Inherited from
PerspectiveProjectedVideoLayer.uAllowSplats
uAllowTerrain
uAllowTerrain:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:35
Inherited from
PerspectiveProjectedVideoLayer.uAllowTerrain
uCameraWorldMatrix
uCameraWorldMatrix:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:29
Inherited from
PerspectiveProjectedVideoLayer.uCameraWorldMatrix
uFeatherScale
uFeatherScale:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:38
Inherited from
PerspectiveProjectedVideoLayer.uFeatherScale
uFlipY
uFlipY:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:34
Inherited from
PerspectiveProjectedVideoLayer.uFlipY
uOpacity
uOpacity:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:28
Inherited from
PerspectiveProjectedVideoLayer.uOpacity
uProjectorNearFar
uProjectorNearFar:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:33
Inherited from
PerspectiveProjectedVideoLayer.uProjectorNearFar
uProjectorOcclusionBias
uProjectorOcclusionBias:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:40
Inherited from
PerspectiveProjectedVideoLayer.uProjectorOcclusionBias
uProjectorOcclusionDepthBiasFactor
uProjectorOcclusionDepthBiasFactor:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:41
Inherited from
PerspectiveProjectedVideoLayer.uProjectorOcclusionDepthBiasFactor
uProjectorOcclusionEnabled
uProjectorOcclusionEnabled:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:39
Inherited from
PerspectiveProjectedVideoLayer.uProjectorOcclusionEnabled
uProjectorOcclusionSlopeBias
uProjectorOcclusionSlopeBias:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:42
Inherited from
PerspectiveProjectedVideoLayer.uProjectorOcclusionSlopeBias
uProjectorPosition
uProjectorPosition:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:30
Inherited from
PerspectiveProjectedVideoLayer.uProjectorPosition
uProjectorView
uProjectorView:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:31
Inherited from
PerspectiveProjectedVideoLayer.uProjectorView
uProjectorViewProjection
uProjectorViewProjection:
any
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:32
Inherited from
PerspectiveProjectedVideoLayer.uProjectorViewProjection
videoName
videoName:
string
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:31
Inherited from
PerspectiveProjectedVideoLayer.videoName
visible
visible:
boolean
Defined in: layers/Layer.d.ts:27
Inherited from
PerspectiveProjectedVideoLayer.visible
Accessors
currentTime
Get Signature
get currentTime():
number
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:129
Returns
number
Inherited from
PerspectiveProjectedVideoLayer.currentTime
duration
Get Signature
get duration():
number
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:125
Returns
number
Inherited from
PerspectiveProjectedVideoLayer.duration
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
PerspectiveProjectedVideoLayer.addListener
clearTimelineBinding()
clearTimelineBinding():
PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:195
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.clearTimelineBinding
deriveTimelineBindingFromTelemetry()
deriveTimelineBindingFromTelemetry():
Object|null
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:203
Returns
Object | null
Inherited from
PerspectiveProjectedVideoLayer.deriveTimelineBindingFromTelemetry
dispose()
dispose():
void
Defined in: layers/Layer.d.ts:87
disposes of any resources used by this layer
Returns
void
Inherited from
PerspectiveProjectedVideoLayer.dispose
getBounds()
getBounds():
Box2
Defined in: layers/Layer.d.ts:62
Returns
Box2
bounds in longitude latitude (degrees)
Inherited from
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.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
Inherited from
PerspectiveProjectedVideoLayer.getCurrentProjectorPose
getCurrentTelemetrySample()
getCurrentTelemetrySample():
TelemetrySample|null
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:242
Returns
TelemetrySample | null
Inherited from
PerspectiveProjectedVideoLayer.getCurrentTelemetrySample
getCurrentTime()
getCurrentTime():
number
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:117
Returns
number
Inherited from
PerspectiveProjectedVideoLayer.getCurrentTime
getDesiredVideoQuality()
getDesiredVideoQuality():
Object
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:94
Returns
Object
getDisplayState()
getDisplayState():
Object
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:238
Returns
Object
Inherited from
PerspectiveProjectedVideoLayer.getDisplayState
getDuration()
getDuration():
number
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:121
Returns
number
Inherited from
PerspectiveProjectedVideoLayer.getDuration
getID()
getID():
string|number
Defined in: layers/Layer.d.ts:42
Returns
string | number
layer id
Inherited from
PerspectiveProjectedVideoLayer.getID
getMuxAssetId()
getMuxAssetId():
string
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:83
Returns
string
Deprecated
Use getPlaybackId instead.
getMuxStreamUrl()
getMuxStreamUrl(
playbackId?):string
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:103
Parameters
playbackId?
string
Returns
string
getName()
getName():
string
Defined in: layers/Layer.d.ts:47
Returns
string
layer name
Inherited from
PerspectiveProjectedVideoLayer.getName
getPlaybackId()
getPlaybackId():
string
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:72
Returns
string
getPlaybackRate()
getPlaybackRate():
number
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:141
Returns
number
Inherited from
PerspectiveProjectedVideoLayer.getPlaybackRate
getPlaybackState()
getPlaybackState():
Object
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:258
Returns current timeline-friendly playback state.
Returns
Object
Inherited from
PerspectiveProjectedVideoLayer.getPlaybackState
getProjectorFrustumBoundingSphere()
getProjectorFrustumBoundingSphere(
target?):Sphere
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:312
Parameters
target?
any
Returns
Sphere
Inherited from
PerspectiveProjectedVideoLayer.getProjectorFrustumBoundingSphere
getProjectorFrustumCorners()
getProjectorFrustumCorners(
options?):Object
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:301
Parameters
options?
Object
Returns
Object
Inherited from
PerspectiveProjectedVideoLayer.getProjectorFrustumCorners
getTelemetryProvider()
getTelemetryProvider():
TelemetryProvider|null
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:108
Returns
TelemetryProvider | null
Inherited from
PerspectiveProjectedVideoLayer.getTelemetryProvider
getTimelineBinding()
getTimelineBinding():
Object|null
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:191
Returns
Object | null
Inherited from
PerspectiveProjectedVideoLayer.getTimelineBinding
getTimelineSynchronizationState()
getTimelineSynchronizationState():
Object
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:234
Returns
Object
Inherited from
PerspectiveProjectedVideoLayer.getTimelineSynchronizationState
getTimeRange()
getTimeRange():
Object
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:175
Returns
Object
Inherited from
PerspectiveProjectedVideoLayer.getTimeRange
getVideoElement()
getVideoElement():
HTMLVideoElement|null
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:112
Returns
HTMLVideoElement | null
Inherited from
PerspectiveProjectedVideoLayer.getVideoElement
getVideoName()
getVideoName():
string
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:99
Returns
string
Inherited from
PerspectiveProjectedVideoLayer.getVideoName
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
Inherited from
PerspectiveProjectedVideoLayer.getWallClockRange
hasTimelineBinding()
hasTimelineBinding():
boolean
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:199
Returns
boolean
Inherited from
PerspectiveProjectedVideoLayer.hasTimelineBinding
invalidateQueryCache()
invalidateQueryCache():
PerspectiveProjectedImageryLayer
Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:355
Invalidates cached UV-to-world query results.
Returns
PerspectiveProjectedImageryLayer
Inherited from
PerspectiveProjectedVideoLayer.invalidateQueryCache
isEnded()
isEnded():
boolean
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:137
Returns
boolean
Inherited from
PerspectiveProjectedVideoLayer.isEnded
isPaused()
isPaused():
boolean
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:133
Returns
boolean
Inherited from
PerspectiveProjectedVideoLayer.isPaused
isProjectionFrustumVisible()
isProjectionFrustumVisible(
camera?):boolean
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:317
Parameters
camera?
any
Returns
boolean
Inherited from
PerspectiveProjectedVideoLayer.isProjectionFrustumVisible
pause()
pause():
PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:154
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.pause
play()
play():
void|Promise<void>
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:150
Returns
void | Promise<void>
Inherited from
PerspectiveProjectedVideoLayer.play
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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.render
resolveMediaTimeForWallClockTime()
resolveMediaTimeForWallClockTime(
wallClockTime,options?):number|null
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:217
Parameters
wallClockTime
number
options?
Object
Returns
number | null
Inherited from
PerspectiveProjectedVideoLayer.resolveMediaTimeForWallClockTime
seek()
seek(
timeSeconds):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:159
Parameters
timeSeconds
number
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.seek
setCurrentTime()
setCurrentTime(
timeSeconds):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:164
Parameters
timeSeconds
number
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.setCurrentTime
setDesiredVideoQuality()
setDesiredVideoQuality(
quality):MuxPerspectiveProjectedVideoLayer
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:88
Parameters
quality
number | "auto" | "high" | "low" | "medium" | "highest" | { maxHeight?: number | null; }
Returns
MuxPerspectiveProjectedVideoLayer
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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.setFlipY
setIntrinsics()
setIntrinsics(
intrinsics?):PerspectiveProjectedImageryLayer
Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:213
Updates projector intrinsics.
Parameters
intrinsics?
Object
Returns
PerspectiveProjectedImageryLayer
Inherited from
PerspectiveProjectedVideoLayer.setIntrinsics
setMuxAssetId()
setMuxAssetId(
playbackId):MuxPerspectiveProjectedVideoLayer
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:78
Parameters
playbackId
string
Returns
MuxPerspectiveProjectedVideoLayer
Deprecated
Use setPlaybackId instead.
setName()
setName(
name):void
Defined in: layers/Layer.d.ts:52
change the layer name
Parameters
name
string
Returns
void
Inherited from
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.setOcclusionAware
setOcclusionBias()
setOcclusionBias(
options?):PerspectiveProjectedImageryLayer
Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:301
Updates occlusion-bias parameters.
Parameters
options?
Object
Returns
PerspectiveProjectedImageryLayer
Inherited from
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.setOcclusionDepthMapSize
setPlaybackId()
setPlaybackId(
playbackId):MuxPerspectiveProjectedVideoLayer
Defined in: layers/projections/MuxPerspectiveProjectedVideoLayer.d.ts:68
Parameters
playbackId
string
Returns
MuxPerspectiveProjectedVideoLayer
setPlaybackRate()
setPlaybackRate(
playbackRate):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:146
Parameters
playbackRate
number
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.setPlaybackRate
setProjectorPose()
setProjectorPose(
pose?):PerspectiveProjectedImageryLayer
Defined in: layers/projections/PerspectiveProjectedImageryLayer.d.ts:145
Updates the projector pose.
Two forms are supported:
- world-space pose with
positionWorldandquaternion - 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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.setTargetMask
setTelemetryProvider()
setTelemetryProvider(
telemetryProvider):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:104
Parameters
telemetryProvider
TelemetryProvider | null
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.setTelemetryProvider
setTexture()
setTexture(
texture,options?):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:323
Parameters
texture
Texture
options?
Object
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.setTexture
setTimelineBinding()
setTimelineBinding(
binding):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:187
Parameters
binding
Object | null
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.setTimelineBinding
setVideo()
setVideo(
video,options?):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:343
Parameters
video
HTMLVideoElement
options?
Object
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.setVideo
setVideoName()
setVideoName(
videoName):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:95
Parameters
videoName
string
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.setVideoName
setVideoTexture()
setVideoTexture(
videoTexture,options?):PerspectiveProjectedVideoLayer
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:333
Parameters
videoTexture
VideoTexture
options?
Object
Returns
PerspectiveProjectedVideoLayer
Inherited from
PerspectiveProjectedVideoLayer.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
PerspectiveProjectedVideoLayer.setVisible
synchronizeToTimeline()
synchronizeToTimeline(
timelineState):Object
Defined in: layers/projections/PerspectiveProjectedVideoLayer.d.ts:224
Parameters
timelineState
Object
Returns
Object
Inherited from
PerspectiveProjectedVideoLayer.synchronizeToTimeline
updateMaterialTexture()
updateMaterialTexture():
void
Defined in: layers/projections/BaseProjectedTextureLayer.d.ts:50
Returns
void