SunLighting

AMD: require(["geoscene/webscene/SunLighting"], (SunLighting) => { /* code goes here */ });
ESM: import SunLighting from "@geoscene/core/webscene/SunLighting";
类: geoscene/webscene/SunLighting
继承于:SunLighting Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.24

日光对象是 webscene/Environment 的一部分,包含与 SceneView 如何被太阳照亮有关的信息。此类包含可在 WebScene 中持久化的所有属性。

另请参阅

构造函数

new SunLighting(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
Date

模拟太阳的当前日期和时间。

更多详情
SunLighting
String

类的名称。

更多详情
Accessor
Boolean

指示是否显示太阳投射的阴影。

更多详情
SunLighting
Number

应在 UI 中显示以表示日期的 UTC 时区偏移量 (以小时为单位)。

更多详情
SunLighting
String

指示光源是模拟太阳的位置。

更多详情
SunLighting

属性详细信息

date Date

模拟太阳的当前日期和时间。设置日期时,指定时区很重要,否则会使用浏览器的时区。这可能会导致不同时区的用户使用不同的照明。

默认值:null
declaredClass Stringreadonly inherited

类的名称。声明的类名称格式化为 geoscene.folder.className

directShadowsEnabled Boolean

指示是否显示太阳投射的阴影。阴影仅针对真实世界的 3D 对象显示。地形不会投射阴影。在小缩放级别的局部场景中,不显示阴影。要更好地控制哪些 3D 对象投射阴影,请使用 ObjectSymbol3DLayerFillSymbol3DLayerExtrudeSymbol3DLayerPathSymbol3DLayer 上可用的 castShadows 属性。

默认值:false
displayUTCOffset Number

应在 UI 中显示以表示日期的 UTC 时区偏移量 (以小时为单位)。该值对场景的实际照明没有影响。

默认值:null
type Stringreadonly

指示光源是模拟太阳的位置。

对于 SunLighting,类型总是 "sun"

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
SunLighting

创建此对象的深度克隆。

更多详情
SunLighting
Boolean

如果存在指定的句柄组,则返回 true。

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor

方法详细说明

addHandles(handleOrHandles, groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时,将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
参数
handleOrHandles WatchHandle|WatchHandle[]

对象销毁后,标记为要移除的句柄。

groupKey *
optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键,则句柄将被添加到默认组。

clone(){SunLighting}

创建此对象的深度克隆。

返回
类型 描述
SunLighting 新建调用此方法的实例的克隆。
hasHandles(groupKey){Boolean}inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组,则返回 true。

参数
groupKey *
optional

组键。

返回
类型 描述
Boolean 如果存在指定的句柄组,则返回 true
示例
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数
groupKey *
optional

要移除的组键或组键的数组或集合。

示例
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息