plugin-atmosphere

大气环境。

样例

安装

npm install @soonspacejs/plugin-atmosphere
# or
yarn add @soonspacejs/plugin-atmosphere

使用方法

import SoonSpace from 'soonspacejs';
import AtmospherePlugin from '@soonspacejs/plugin-atmosphere';

const ssp = new SoonSpace({
  el: '#view',
  options: {},
  events: {},
});

const atmospherePlugin = ssp.registerPlugin(AtmospherePlugin, 'atmospherePlugin');

属性

date

当前时间对象

• 类型：Date
• 默认值：当前时间，时刻为 10 点

longitude

当前经度

• 类型：number
• 默认值：120

latitude

当前纬度

• 类型：number
• 默认值：30

altitude

当前高度

• 类型：number
• 默认值：20

distance

光源与 target 的距离

• 类型：number
• 默认值：300

target

光照点

• 类型：THREE.Vector3
• 默认值：new THREE.Vector3(0, 0, 0)

groundAlbedo

地面颜色

• 类型：IColor
• 默认值：0x666666

castShadow

是否开启阴影

• 类型：boolean
• 默认值：true

方法

start

开启大气环境。

定义

start(texturesUrl: string): void

用法

atmospherePlugin.start('../xx/atmosphere/assets');

提示

assets 目录在 node_modules/@soonspacejs/plugin-atmosphere/dist 中

然后将 assets 目录拷贝至所在项目的静态资源目录中，一般是 public 目录

提示

调用 start 方法后，内部将会重置环境效果，并且重置色调。

ssp.setToneMapping({ type: 'AGX', exposure: 10 });

stop

结束大气效果。

定义

function stop(): void;

用法

atmospherePlugin.stop();

提示

调用 stop 方法后，内部将会还原环境与色调。

ssp.setEnvironment();
ssp.setToneMapping({ type: 'ACESFilmic', exposure: 0.8 });

dispose

结束并销毁大气效果。

定义

function dispose(): void;

用法

atmospherePlugin.dispose();

提示

dispose 方法会释放显存，可以在组件销毁时调用。