Class: VideoShadow

视频投影对象

Table of contents

Constructors

• constructor

Properties

• id
• params

Accessors

• isOutputTexture
• cameraFrustumPosition
• yaw
• pitch
• opacity
• aspectRatio
• isShowDebugFrustum
• far
• fov
• cameraPosition
• position
• videoPlay
• show
• reflectionImageData

Methods

• destroy
• locate
• changeRotation
• updateVideo

Constructors

constructor

• new VideoShadow(viewer, options): VideoShadow

视频投影对象

Parameters

Name	Type	Description
viewer	Viewer	视图对象
options	VideoShadowOptions	初始化参数

Returns

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:210

Properties

id

• id: string

唯一标识符

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:167

---

params

• params: VideoShadowOptions

初始化参数

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:174

Accessors

isOutputTexture

• get isOutputTexture(): boolean

是否输出相机可视范围图像

Returns

boolean

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1122

• set isOutputTexture(isOutPut): void

Parameters

Name	Type
isOutPut	boolean

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1126

---

cameraFrustumPosition

• get cameraFrustumPosition(): Cartesian3[]

获取 camera 计算出四顶点范围顶点

Returns

Cartesian3[]

Defined in

src/extensions/VideoShadow/index.ts:1133

---

yaw

• get yaw(): number

视频投影偏航角

Returns

number

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1142

• set yaw(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1146

---

pitch

• get pitch(): number

视频投影俯仰角

Returns

number

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1156

• set pitch(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1160

---

opacity

• get opacity(): number

视频投影透明度

Returns

number

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1170

• set opacity(e): void

Parameters

Name	Type
e	number

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1174

---

aspectRatio

• get aspectRatio(): number

视锥的纵横比

Returns

number

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1184

• set aspectRatio(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1188

---

isShowDebugFrustum

• get isShowDebugFrustum(): boolean

是否显示视锥线

Returns

boolean

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1198

• set isShowDebugFrustum(e): void

Parameters

Name	Type
e	boolean

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1202

---

far

• get far(): number

视频参数中的 far

Returns

number

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1212

• set far(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1216

---

fov

• get fov(): number

视频参数中的 fov

Returns

number

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1226

• set fov(e): void

Parameters

Name	Type
e	number

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1230

---

cameraPosition

• get cameraPosition(): Cartesian3

视频标签中的视频的相机位置

Returns

Cartesian3

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1240

• set cameraPosition(e): void

Parameters

Name	Type
e	Cartesian3

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1243

---

position

• get position(): number[]

视频标签中的视频的中心点位置

Returns

number[]

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1255

• set position(e): void

Parameters

Name	Type
e	number[]

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1259

---

videoPlay

• get videoPlay(): boolean

设置视频是否播放

Returns

boolean

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1271

• set videoPlay(e): void

Parameters

Name	Type
e	boolean

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1275

---

show

• get show(): boolean

视频投影是否显示

Returns

boolean

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1287

• set show(e): void

Parameters

Name	Type
e	boolean

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1291

---

reflectionImageData

• get reflectionImageData(): ImageData

当前相机可视范围图像

Returns

ImageData

Memberof

VideoShadow

Defined in

src/extensions/VideoShadow/index.ts:1304

Methods

destroy

▸ destroy(): void

销毁实体

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:967

---

locate

▸ locate(): void

定位到视频投影对象

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:989

---

changeRotation

▸ changeRotation(e): void

旋转视频投影

Parameters

Name	Type	Description
e	Object	旋转参数
e.yaw	number	偏航角
e.pitch	number	俯仰角

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1011

---

updateVideo

▸ updateVideo(e): void

更新视频投影 -> 相当于重置

Parameters

Name	Type	Description
e	VideoShadowOptions	更新相关参数

Returns

void

Defined in

src/extensions/VideoShadow/index.ts:1050