@shapediver/viewer.viewport
Version:
This is the npm package for the ShapeDiver Viewer Viewport API. For more information on ShapeDiver, please visit our [homepage](https://shapediver.com/).
69 lines • 2.89 kB
TypeScript
import { type ILightScene } from "@shapediver/viewer.rendering-engine.light-engine";
import { type ITreeNode } from "@shapediver/viewer.shared.node-tree";
import { type Color } from "@shapediver/viewer.shared.types";
import { vec3 } from "gl-matrix";
import { type IViewportApi } from "../../interfaces/IViewportApi";
import { type ILightApi } from "../../interfaces/lights/ILightApi";
import { type ILightSceneApi } from "../../interfaces/lights/ILightSceneApi";
import { type IAmbientLightApi } from "../../interfaces/lights/types/IAmbientLightApi";
import { type IDirectionalLightApi } from "../../interfaces/lights/types/IDirectionalLightApi";
import { type IHemisphereLightApi } from "../../interfaces/lights/types/IHemisphereLightApi";
import { type IPointLightApi } from "../../interfaces/lights/types/IPointLightApi";
import { type ISpotLightApi } from "../../interfaces/lights/types/ISpotLightApi";
export declare class LightSceneApi implements ILightSceneApi {
#private;
constructor(viewportApi: IViewportApi, lightScene: ILightScene);
get id(): string;
get lights(): {
[key: string]: ILightApi;
};
get name(): string | undefined;
set name(value: string | undefined);
get node(): ITreeNode;
addAmbientLight(properties: {
color?: Color | undefined;
intensity?: number | undefined;
id?: string | undefined;
name?: string | undefined;
}): IAmbientLightApi;
addDirectionalLight(properties: {
color?: Color | undefined;
intensity?: number | undefined;
direction?: vec3 | undefined;
castShadow?: boolean | undefined;
shadowMapResolution?: number | undefined;
shadowMapBias?: number | undefined;
id?: string | undefined;
name?: string | undefined;
}): IDirectionalLightApi;
addHemisphereLight(properties: {
color?: Color | undefined;
intensity?: number | undefined;
groundColor?: Color | undefined;
id?: string | undefined;
name?: string | undefined;
}): IHemisphereLightApi;
addPointLight(properties: {
color?: Color | undefined;
intensity?: number | undefined;
position?: vec3 | undefined;
distance?: number | undefined;
decay?: number | undefined;
id?: string | undefined;
name?: string | undefined;
}): IPointLightApi;
addSpotLight(properties: {
color?: Color | undefined;
intensity?: number | undefined;
position?: vec3 | undefined;
target?: vec3 | undefined;
distance?: number | undefined;
decay?: number | undefined;
angle?: number | undefined;
penumbra?: number | undefined;
id?: string | undefined;
name?: string | undefined;
}): ISpotLightApi;
removeLight(id: string): boolean;
}
//# sourceMappingURL=LightSceneApi.d.ts.map