@shapediver/viewer.viewport 3.3.3 → 3.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/package.json +21 -22
  2. package/src/implementation/PostProcessingApi.ts +0 -184
  3. package/src/implementation/ViewportApi.ts +0 -1071
  4. package/src/implementation/camera/AbstractCameraApi.ts +0 -560
  5. package/src/implementation/camera/OrthographicCameraApi.ts +0 -43
  6. package/src/implementation/camera/PerspectiveCameraApi.ts +0 -43
  7. package/src/implementation/lights/AbstractLightApi.ts +0 -87
  8. package/src/implementation/lights/LightSceneApi.ts +0 -198
  9. package/src/implementation/lights/types/AmbientLightApi.ts +0 -24
  10. package/src/implementation/lights/types/DirectionalLightApi.ts +0 -80
  11. package/src/implementation/lights/types/HemisphereLightApi.ts +0 -44
  12. package/src/implementation/lights/types/PointLightApi.ts +0 -68
  13. package/src/implementation/lights/types/SpotLightApi.ts +0 -104
  14. package/src/index.ts +0 -312
  15. package/src/interfaces/IPostProcessingApi.ts +0 -269
  16. package/src/interfaces/IViewportApi.ts +0 -640
  17. package/src/interfaces/camera/ICameraApi.ts +0 -237
  18. package/src/interfaces/camera/IOrthographicCameraApi.ts +0 -18
  19. package/src/interfaces/camera/IPerspectiveCameraApi.ts +0 -17
  20. package/src/interfaces/lights/ILightApi.ts +0 -41
  21. package/src/interfaces/lights/ILightSceneApi.ts +0 -147
  22. package/src/interfaces/lights/types/IAmbientLightApi.ts +0 -7
  23. package/src/interfaces/lights/types/IDirectionalLightApi.ts +0 -29
  24. package/src/interfaces/lights/types/IHemisphereLightApi.ts +0 -17
  25. package/src/interfaces/lights/types/IPointLightApi.ts +0 -25
  26. package/src/interfaces/lights/types/ISpotLightApi.ts +0 -37
  27. package/src/main.ts +0 -89
  28. package/tsconfig.json +0 -17
package/src/index.ts DELETED
@@ -1,312 +0,0 @@
1
- import {
2
- addListener,
3
- generalOptions,
4
- IGeneralOptions,
5
- removeListener,
6
- sceneTree,
7
- version
8
- } from '@shapediver/viewer.api.general';
9
- import {
10
- AnimationData,
11
- AttributeData,
12
- CustomData,
13
- EventResponseMapping,
14
- GeometryData,
15
- HTMLElementAnchorCustomData,
16
- HTMLElementAnchorData,
17
- HTMLElementAnchorImageData,
18
- HTMLElementAnchorTextData,
19
- IAnchorDataImage,
20
- IAnchorDataText,
21
- IAnimationData,
22
- IAnimationTrack,
23
- IAttributeData,
24
- ICameraEvent,
25
- ICustomData,
26
- IGeometryData,
27
- IHTMLElementAnchorData,
28
- IMapData,
29
- IMapDataProperties,
30
- IMapDataPropertiesDefinition,
31
- IMaterialAbstractData,
32
- IMaterialAbstractDataProperties,
33
- IMaterialAbstractDataPropertiesDefinition,
34
- IMaterialBasicLineData,
35
- IMaterialBasicLineDataProperties,
36
- IMaterialBasicLineDataPropertiesDefinition,
37
- IMaterialGemData,
38
- IMaterialGemDataProperties,
39
- IMaterialGemDataPropertiesDefinition,
40
- IMaterialMultiPointData,
41
- IMaterialMultiPointDataProperties,
42
- IMaterialMultiPointDataPropertiesDefinition,
43
- IMaterialPointData,
44
- IMaterialPointDataProperties,
45
- IMaterialPointDataPropertiesDefinition,
46
- IMaterialShadowData,
47
- IMaterialShadowDataProperties,
48
- IMaterialShadowDataPropertiesDefinition,
49
- IMaterialSpecularGlossinessData,
50
- IMaterialSpecularGlossinessDataProperties,
51
- IMaterialSpecularGlossinessDataPropertiesDefinition,
52
- IMaterialStandardData,
53
- IMaterialStandardDataProperties,
54
- IMaterialStandardDataPropertiesDefinition,
55
- IMaterialUnlitData,
56
- IMaterialUnlitDataProperties,
57
- IMaterialUnlitDataPropertiesDefinition,
58
- IMaterialVariantsData,
59
- IOutputEvent,
60
- IParameterEvent,
61
- IPrimitiveData,
62
- IRenderingEvent,
63
- ISceneEvent,
64
- ISDTFAttributeData,
65
- ISDTFAttributesData,
66
- ISDTFAttributeVisualizationData,
67
- ISDTFItemData,
68
- ISDTFOverview,
69
- ISDTFOverviewData,
70
- ISessionEvent,
71
- ISessionSettingsSections,
72
- ISettingsSections,
73
- ITaskEvent,
74
- IViewportEvent,
75
- IViewportSettingsSections,
76
- MapData,
77
- MATERIAL_ALPHA,
78
- MATERIAL_SHADING,
79
- MATERIAL_SIDE,
80
- MATERIAL_TYPE,
81
- MaterialBasicLineData,
82
- MaterialGemData,
83
- MaterialMultiPointData,
84
- MaterialPointData,
85
- MaterialShadowData,
86
- MaterialSpecularGlossinessData,
87
- MaterialStandardData,
88
- MaterialUnlitData,
89
- MaterialVariantsData,
90
- PARAMETER_TYPE,
91
- PARAMETER_VISUALIZATION,
92
- PRIMITIVE_MODE,
93
- PrimitiveData,
94
- SDTF_TYPEHINT,
95
- SDTFAttributeData,
96
- SDTFAttributesData,
97
- SDTFItemData,
98
- SDTFOverviewData,
99
- SdtfPrimitiveTypeGuard,
100
- TASK_TYPE,
101
- TEXTURE_FILTERING,
102
- TEXTURE_WRAPPING
103
- } from '@shapediver/viewer.shared.types';
104
- import {
105
- ANTI_ALIASING_TECHNIQUE,
106
- BlendFunction,
107
- BloomEffect,
108
- ChromaticAberrationEffect,
109
- DepthOfFieldEffect,
110
- DotScreenEffect,
111
- Effect,
112
- EffectComposer,
113
- ENVIRONMENT_MAP,
114
- ENVIRONMENT_MAP_CUBE,
115
- ENVIRONMENT_MAP_EMPTY,
116
- GodRaysEffect,
117
- GridEffect,
118
- HueSaturationEffect,
119
- IBloomEffectDefinition,
120
- IChromaticAberrationEffectDefinition,
121
- IDepthOfFieldEffectDefinition,
122
- IDotScreenEffectDefinition,
123
- IGodRaysEffectDefinition,
124
- IGridEffectDefinition,
125
- IHBAOEffectDefinition,
126
- IHueSaturationEffectDefinition,
127
- INoiseEffectDefinition,
128
- IOutlineEffectDefinition,
129
- IPixelationEffectDefinition,
130
- IPostProcessingEffectDefinition,
131
- IScanlineEffectDefinition,
132
- ISelectiveBloomEffectDefinition,
133
- ISepiaEffectDefinition,
134
- ISSAOEffectDefinition,
135
- IThreejsData,
136
- ITiltShiftEffectDefinition,
137
- IVignetteEffectDefinition,
138
- KernelSize,
139
- NoiseEffect,
140
- OutlineEffect,
141
- PixelationEffect,
142
- POST_PROCESSING_EFFECT_TYPE,
143
- Resolution,
144
- ScanlineEffect,
145
- SelectiveBloomEffect,
146
- SepiaEffect,
147
- SSAOEffect,
148
- ThreejsData,
149
- TiltShiftEffect,
150
- VignetteEffect,
151
- VignetteTechnique
152
- } from '@shapediver/viewer.rendering-engine.rendering-engine-threejs';
153
- import {
154
- Box,
155
- IBox,
156
- IGeometry,
157
- ISphere,
158
- Sphere
159
- } from '@shapediver/viewer.shared.math';
160
- import {
161
- BUSY_MODE_DISPLAY,
162
- FLAG_TYPE,
163
- RENDERER_TYPE,
164
- SPINNER_POSITIONING,
165
- TEXTURE_ENCODING,
166
- TONE_MAPPING,
167
- VISIBILITY_MODE
168
- } from '@shapediver/viewer.rendering-engine.rendering-engine';
169
- import { CAMERA_TYPE, ICameraOptions, ORTHOGRAPHIC_CAMERA_DIRECTION } from '@shapediver/viewer.rendering-engine.camera-engine';
170
- import { createViewport, viewports } from './main';
171
- import { DataEngine } from '@shapediver/viewer.data-engine.data-engine';
172
- import {
173
- EVENTTYPE,
174
- EVENTTYPE_CAMERA,
175
- EVENTTYPE_DRAWING_TOOLS,
176
- EVENTTYPE_GUMBALL,
177
- EVENTTYPE_INTERACTION,
178
- EVENTTYPE_OUTPUT,
179
- EVENTTYPE_PARAMETER,
180
- EVENTTYPE_RENDERING,
181
- EVENTTYPE_SCENE,
182
- EVENTTYPE_SESSION,
183
- EVENTTYPE_TASK,
184
- EVENTTYPE_VIEWPORT,
185
- IDomEventListener,
186
- IEvent,
187
- isARError,
188
- isViewerCameraError,
189
- isViewerDataProcessingError,
190
- isViewerDrawingToolsError,
191
- isViewerEnvironmentMapError,
192
- isViewerError,
193
- isViewerGeometryBackendError,
194
- isViewerGeometryBackendGenericError,
195
- isViewerGeometryBackendRequestError,
196
- isViewerGeometryBackendResponseError,
197
- isViewerInteractionError,
198
- isViewerLightError,
199
- isViewerSessionError,
200
- isViewerSettingsError,
201
- isViewerUnknownError,
202
- isViewerValidationError,
203
- isViewerViewportError,
204
- isViewerWebGLError,
205
- LOGGING_LEVEL,
206
- MainEventTypes,
207
- SESSION_SETTINGS_MODE,
208
- ShapeDiverGeometryBackendError,
209
- ShapeDiverGeometryBackendRequestError,
210
- ShapeDiverGeometryBackendResponseError,
211
- ShapeDiverGeometryBackendResponseErrorType,
212
- ShapeDiverViewerArError,
213
- ShapeDiverViewerCameraError,
214
- ShapeDiverViewerDataProcessingError,
215
- ShapeDiverViewerDrawingToolsError,
216
- ShapeDiverViewerEnvironmentMapError,
217
- ShapeDiverViewerError,
218
- ShapeDiverViewerErrorType,
219
- ShapeDiverViewerInteractionError,
220
- ShapeDiverViewerLightError,
221
- ShapeDiverViewerSessionError,
222
- ShapeDiverViewerSettingsError,
223
- ShapeDiverViewerUnknownError,
224
- ShapeDiverViewerValidationError,
225
- ShapeDiverViewerViewportError,
226
- ShapeDiverViewerWebGLError
227
- } from '@shapediver/viewer.shared.services';
228
- import { GeometryEngine } from '@shapediver/viewer.data-engine.geometry-engine';
229
- import { IAmbientLightApi } from './interfaces/lights/types/IAmbientLightApi';
230
- import {
231
- IAnchor,
232
- IMaterialContentData,
233
- IMaterialContentDataV1,
234
- IMaterialContentDataV2,
235
- IMaterialContentDataV3,
236
- ITag2D,
237
- ITag3D,
238
- ITexture,
239
- TAG3D_JUSTIFICATION
240
- } from '@shapediver/viewer.data-engine.shared-types';
241
- import { ICameraApi } from './interfaces/camera/ICameraApi';
242
- import { IDirectionalLightApi } from './interfaces/lights/types/IDirectionalLightApi';
243
- import { IHemisphereLightApi } from './interfaces/lights/types/IHemisphereLightApi';
244
- import { ILightApi } from './interfaces/lights/ILightApi';
245
- import { ILightSceneApi } from './interfaces/lights/ILightSceneApi';
246
- import { IOrthographicCameraApi } from './interfaces/camera/IOrthographicCameraApi';
247
- import { IPerspectiveCameraApi } from './interfaces/camera/IPerspectiveCameraApi';
248
- import { IPointLightApi } from './interfaces/lights/types/IPointLightApi';
249
- import { ISpotLightApi } from './interfaces/lights/types/ISpotLightApi';
250
- import {
251
- ITransformation,
252
- ITree,
253
- ITreeNode,
254
- ITreeNodeData,
255
- Tree,
256
- TreeNode
257
- } from '@shapediver/viewer.shared.node-tree';
258
- import { IViewportApi } from './interfaces/IViewportApi';
259
- import { LIGHT_TYPE } from '@shapediver/viewer.rendering-engine.light-engine';
260
- import { MaterialEngine } from '@shapediver/viewer.data-engine.material-engine';
261
- import { ViewportCreationDefinition } from '@shapediver/viewer.creation-control-center.viewport';
262
- import {
263
- ShapeDiverResponseExportDefinitionType as EXPORT_TYPE,
264
- ShapeDiverResponseOutput,
265
- ShapeDiverResponseOutputChunk as ShapeDiverResponseOutputChunkBackend,
266
- ShapeDiverResponseOutputContent as ShapeDiverResponseOutputContentBackend,
267
- ShapeDiverResponseExport,
268
- ShapeDiverResponseExportContent,
269
- ShapeDiverResponseExportDefinitionGroup,
270
- ShapeDiverResponseExportResult,
271
- ShapeDiverResponseModelComputationStatus,
272
- ShapeDiverResponseParameter,
273
- } from '@shapediver/sdk.geometry-api-sdk-v2';
274
-
275
- export { ICameraApi, IOrthographicCameraApi, IPerspectiveCameraApi, IAmbientLightApi, IDirectionalLightApi, IHemisphereLightApi, IPointLightApi, ISpotLightApi, ILightApi, ILightSceneApi, IViewportApi };
276
-
277
- export { createViewport, viewports };
278
-
279
- export { addListener, removeListener, sceneTree, generalOptions, version, IGeneralOptions };
280
-
281
- export { ViewportCreationDefinition };
282
- export { ITree, Tree, ITreeNode, TreeNode, ITreeNodeData };
283
- export { FLAG_TYPE, PARAMETER_TYPE, EXPORT_TYPE, PARAMETER_VISUALIZATION, TAG3D_JUSTIFICATION, CAMERA_TYPE, LIGHT_TYPE, RENDERER_TYPE, VISIBILITY_MODE, ORTHOGRAPHIC_CAMERA_DIRECTION, TEXTURE_ENCODING, TONE_MAPPING, ENVIRONMENT_MAP, ENVIRONMENT_MAP_CUBE, ENVIRONMENT_MAP_EMPTY, LOGGING_LEVEL, PRIMITIVE_MODE, MATERIAL_SIDE, MATERIAL_ALPHA, MATERIAL_SHADING, MATERIAL_TYPE, TEXTURE_WRAPPING, TEXTURE_FILTERING, SDTF_TYPEHINT, BUSY_MODE_DISPLAY, SESSION_SETTINGS_MODE, SPINNER_POSITIONING };
284
- export { TASK_TYPE, MainEventTypes, EVENTTYPE, EVENTTYPE_CAMERA, EVENTTYPE_OUTPUT, EVENTTYPE_PARAMETER, EVENTTYPE_RENDERING, EVENTTYPE_SCENE, EVENTTYPE_SESSION, EVENTTYPE_VIEWPORT, EVENTTYPE_INTERACTION, EVENTTYPE_GUMBALL, EVENTTYPE_DRAWING_TOOLS, EVENTTYPE_TASK };
285
- export { IBox, Box, ISphere, Sphere, IGeometry, ITransformation, ShapeDiverResponseOutput, ShapeDiverResponseOutputContentBackend, ShapeDiverResponseOutputChunkBackend, IDomEventListener, IEvent, IThreejsData, ThreejsData };
286
- export { ShapeDiverResponseExport, ShapeDiverResponseExportContent, ShapeDiverResponseExportResult, ShapeDiverResponseModelComputationStatus, ShapeDiverResponseExportDefinitionGroup, ShapeDiverResponseParameter };
287
-
288
- export { EventResponseMapping, IViewportEvent, ISessionEvent, IOutputEvent, ICameraEvent, ISceneEvent, ITaskEvent, IRenderingEvent, IParameterEvent, ISettingsSections, IViewportSettingsSections, ISessionSettingsSections };
289
- export { IMaterialStandardData, MaterialStandardData, IMaterialStandardDataProperties, IMaterialStandardDataPropertiesDefinition, IMaterialAbstractData, IMaterialAbstractDataProperties, IMaterialAbstractDataPropertiesDefinition, IMaterialUnlitData, MaterialUnlitData, IMaterialUnlitDataProperties, IMaterialUnlitDataPropertiesDefinition, IMaterialShadowData, MaterialShadowData, IMaterialShadowDataProperties, IMaterialShadowDataPropertiesDefinition, IMaterialSpecularGlossinessData, MaterialSpecularGlossinessData, IMaterialSpecularGlossinessDataProperties, IMaterialSpecularGlossinessDataPropertiesDefinition, IMaterialGemData, MaterialGemData, IMaterialGemDataProperties, IMaterialGemDataPropertiesDefinition, IMaterialPointData, MaterialPointData, IMaterialPointDataProperties, IMaterialPointDataPropertiesDefinition, IMaterialMultiPointData, MaterialMultiPointData, IMaterialMultiPointDataProperties, IMaterialMultiPointDataPropertiesDefinition, IMaterialBasicLineData, MaterialBasicLineData, IMaterialBasicLineDataProperties, IMaterialBasicLineDataPropertiesDefinition, IMapData, IMapDataProperties, IMapDataPropertiesDefinition, MapData };
290
- export { IAnimationData, AnimationData, IAnimationTrack, IGeometryData, IAttributeData, IPrimitiveData, IMaterialVariantsData, GeometryData, AttributeData, PrimitiveData, MaterialVariantsData };
291
- export { IAnchorDataImage, IAnchorDataText, ITag2D, ITag3D, ITexture, IHTMLElementAnchorData, HTMLElementAnchorCustomData, HTMLElementAnchorTextData, HTMLElementAnchorImageData, HTMLElementAnchorData };
292
- export { ICustomData, CustomData, ICameraOptions };
293
- export { ISDTFOverviewData, SDTFOverviewData, ISDTFOverview, SDTFAttributesData, ISDTFAttributesData, ISDTFAttributeData, SDTFAttributeData, SDTFItemData, ISDTFItemData, ISDTFAttributeVisualizationData, SdtfPrimitiveTypeGuard };
294
- export { DataEngine, GeometryEngine, MaterialEngine };
295
- export { ShapeDiverViewerErrorType, ShapeDiverViewerError, ShapeDiverViewerDataProcessingError, ShapeDiverViewerEnvironmentMapError, ShapeDiverViewerWebGLError, ShapeDiverViewerSettingsError, ShapeDiverViewerSessionError, ShapeDiverViewerViewportError, ShapeDiverViewerUnknownError, ShapeDiverViewerArError, ShapeDiverViewerLightError, ShapeDiverViewerCameraError, ShapeDiverViewerValidationError, ShapeDiverViewerInteractionError, ShapeDiverViewerDrawingToolsError, ShapeDiverGeometryBackendError, ShapeDiverGeometryBackendRequestError, ShapeDiverGeometryBackendResponseError, ShapeDiverGeometryBackendResponseErrorType };
296
- export { isViewerError, isViewerUnknownError, isViewerDataProcessingError, isViewerEnvironmentMapError, isViewerWebGLError, isViewerSettingsError, isViewerSessionError, isViewerViewportError, isViewerLightError, isViewerCameraError, isARError, isViewerValidationError, isViewerInteractionError, isViewerDrawingToolsError, isViewerGeometryBackendError, isViewerGeometryBackendGenericError, isViewerGeometryBackendRequestError, isViewerGeometryBackendResponseError };
297
- export { ANTI_ALIASING_TECHNIQUE, POST_PROCESSING_EFFECT_TYPE, IPostProcessingEffectDefinition, IBloomEffectDefinition, IChromaticAberrationEffectDefinition, IDepthOfFieldEffectDefinition, IDotScreenEffectDefinition, IGodRaysEffectDefinition, IGridEffectDefinition, IHBAOEffectDefinition, IHueSaturationEffectDefinition, INoiseEffectDefinition, IOutlineEffectDefinition, IPixelationEffectDefinition, ISSAOEffectDefinition, IScanlineEffectDefinition, ISelectiveBloomEffectDefinition, ISepiaEffectDefinition, ITiltShiftEffectDefinition, IVignetteEffectDefinition, BloomEffect, ChromaticAberrationEffect, DepthOfFieldEffect, DotScreenEffect, GodRaysEffect, GridEffect, HueSaturationEffect, NoiseEffect, OutlineEffect, PixelationEffect, SSAOEffect, ScanlineEffect, SelectiveBloomEffect, SepiaEffect, TiltShiftEffect, VignetteEffect, Effect, EffectComposer, BlendFunction, VignetteTechnique, KernelSize, Resolution };
298
-
299
- export interface ShapeDiverResponseOutputContent extends ShapeDiverResponseOutputContentBackend {
300
- // #region Properties (1)
301
-
302
- data?: ITag2D[] | ITag3D[] | IAnchor[] | IMaterialContentData | IMaterialContentDataV1 | IMaterialContentDataV2 | IMaterialContentDataV3 | unknown;
303
-
304
- // #endregion Properties (1)
305
- }
306
- export interface ShapeDiverResponseOutputChunk extends ShapeDiverResponseOutputChunkBackend {
307
- // #region Properties (1)
308
-
309
- node?: ITreeNode;
310
-
311
- // #endregion Properties (1)
312
- }
@@ -1,269 +0,0 @@
1
- import {
2
- ANTI_ALIASING_TECHNIQUE,
3
- Effect,
4
- EffectComposer,
5
- IBloomEffectDefinition,
6
- IChromaticAberrationEffectDefinition,
7
- IDepthOfFieldEffectDefinition,
8
- IDotScreenEffectDefinition,
9
- IGodRaysEffectDefinition,
10
- IGridEffectDefinition,
11
- IHBAOEffectDefinition,
12
- IHueSaturationEffectDefinition,
13
- INoiseEffectDefinition,
14
- IOutlineEffectDefinition,
15
- IPixelationEffectDefinition,
16
- IPostProcessingEffectDefinition,
17
- IPostProcessingEffectsArray,
18
- IScanlineEffectDefinition,
19
- ISelectiveBloomEffectDefinition,
20
- ISepiaEffectDefinition,
21
- ISSAOEffectDefinition,
22
- ITiltShiftEffectDefinition,
23
- IVignetteEffectDefinition,
24
- POST_PROCESSING_EFFECT_TYPE
25
- } from '@shapediver/viewer.rendering-engine.rendering-engine-threejs';
26
- import { ITreeNode } from '@shapediver/viewer.shared.node-tree';
27
-
28
- export interface IPostProcessingApi {
29
- // #region Properties (9)
30
-
31
- /**
32
- * The effect composer that is used internally for the rendering of the postprocessing effects.
33
- * In combination with {@link manualPostProcessing} you can adjust the effects and passes yourself.
34
- *
35
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
36
- */
37
- readonly effectComposer: EffectComposer | undefined;
38
-
39
- /**
40
- * Defines the anti-aliasing technique that is used when the post-processing is active. (default: ANTI_ALIASING_TECHNIQUE.SSAA)
41
- *
42
- * The various anti-aliasing technique have an impact on the performance and the rendering quality.
43
- * The order is as follows: NONE -> FXAA -> SMAA -> SSAA
44
- * (lowest to highest quality, fastest to slowest performance)
45
- *
46
- * For the SSAA approach please see {@link ssaaSampleLevel}.
47
- *
48
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
49
- */
50
- antiAliasingTechnique: ANTI_ALIASING_TECHNIQUE;
51
- /**
52
- * Defines the anti-aliasing technique that is used when the post-processing is active on mobile. (default: ANTI_ALIASING_TECHNIQUE.FXAA)
53
- *
54
- * The various anti-aliasing technique have an impact on the performance and the rendering quality.
55
- * The order is as follows: NONE -> FXAA -> SMAA -> SSAA
56
- * (lowest to highest quality, fastest to slowest performance)
57
- *
58
- * For the SSAA approach please see {@link ssaaSampleLevel}.
59
- *
60
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
61
- */
62
- antiAliasingTechniqueMobile: ANTI_ALIASING_TECHNIQUE;
63
- /**
64
- * If the post-processing effects should be enabled on mobile. (default: true)
65
- *
66
- * As some post-processing effects greatly effect the rendering performance it might make sense to not use post-processing on mobile device.
67
- * This will ensure that the rendering on mobile devices is still fluid, while providing the best results on desktop.
68
- *
69
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
70
- */
71
- enablePostProcessingOnMobile: boolean;
72
- /**
73
- * Access to all currently added god ray effects via token.
74
- *
75
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
76
- *
77
- * @see addEffect
78
- * @see updateEffect
79
- * @see removeEffect
80
- */
81
- godRaysEffects: {
82
- [key: string]: {
83
- /**
84
- * Set the light source for the god ray effect.
85
- * This light source is the geometry on which the god ray effect is applied.
86
- *
87
- * @param node
88
- */
89
- setLightSource(node: ITreeNode): void;
90
-
91
- /**
92
- * Remove the currently set light source.
93
- */
94
- removeLightSource(): void;
95
- }
96
- }
97
-
98
- /**
99
- * By setting this option to `true` you can manually work on the postprocessing pipeline.
100
- * All current effects and passes are removed from the EffectComposer and you can start from scratch.
101
- *
102
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
103
- *
104
- * @see effectComposer
105
- */
106
- manualPostProcessing: boolean;
107
- /**
108
- * Access to all currently added outline effects via token.
109
- *
110
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
111
- *
112
- * @see addEffect
113
- * @see updateEffect
114
- * @see removeEffect
115
- */
116
- outlineEffects: {
117
- [key: string]: {
118
- /**
119
- * Add a node to the selection for the outline effect.
120
- *
121
- * @param node
122
- */
123
- addSelection(node: ITreeNode): void;
124
-
125
- /**
126
- * Remove a node from the selection for the outline effect.
127
- *
128
- * @param node
129
- */
130
- removeSelection(node: ITreeNode): boolean;
131
-
132
- /**
133
- * Clear all currently selected nodes.
134
- */
135
- clearSelection(): void;
136
- }
137
- }
138
-
139
- /**
140
- * Access to all currently added selective bloom effects via token.
141
- *
142
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
143
- *
144
- * @see addEffect
145
- * @see updateEffect
146
- * @see removeEffect
147
- */
148
- selectiveBloomEffects: {
149
- [key: string]: {
150
- /**
151
- * Add a node to the selection for the selective bloom effect.
152
- *
153
- * @param node
154
- */
155
- addSelection(node: ITreeNode): void;
156
-
157
- /**
158
- * Remove a node from the selection for the selective bloom effect.
159
- *
160
- * @param node
161
- */
162
- removeSelection(node: ITreeNode): boolean;
163
-
164
- /**
165
- * Clear all currently selected nodes.
166
- */
167
- clearSelection(): void;
168
- }
169
- }
170
-
171
- /**
172
- * The number of samples that are taken in the Supersample Anti-Aliasing Render Pass.
173
- * Specified as n, where the number of samples is 2^n, so sampleLevel = 4, is 2^4 samples, 16. (default: 4)
174
- *
175
- * Only works with {@link ANTI_ALIASING_TECHNIQUE.SSAA}.
176
- *
177
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
178
- */
179
- ssaaSampleLevel: number;
180
-
181
- // #endregion Properties (9)
182
-
183
- // #region Public Methods (24)
184
-
185
- addEffect(definition: IBloomEffectDefinition): string;
186
- addEffect(definition: IChromaticAberrationEffectDefinition): string;
187
- addEffect(definition: IDepthOfFieldEffectDefinition): string;
188
- addEffect(definition: IDotScreenEffectDefinition): string;
189
- addEffect(definition: IGodRaysEffectDefinition): string;
190
- addEffect(definition: IGridEffectDefinition): string;
191
- addEffect(definition: IHBAOEffectDefinition): string;
192
- addEffect(definition: IHueSaturationEffectDefinition): string;
193
- addEffect(definition: INoiseEffectDefinition): string;
194
- addEffect(definition: IOutlineEffectDefinition): string;
195
- addEffect(definition: IPixelationEffectDefinition): string;
196
- addEffect(definition: ISSAOEffectDefinition): string;
197
- addEffect(definition: IScanlineEffectDefinition): string;
198
- addEffect(definition: ISelectiveBloomEffectDefinition): string;
199
- addEffect(definition: ISepiaEffectDefinition): string;
200
- addEffect(definition: ITiltShiftEffectDefinition): string;
201
- addEffect(definition: IVignetteEffectDefinition): string;
202
- /**
203
- * Add an effect to the postprocessing pipeline.
204
- * A token is return which identifies this effect when using other API functions.
205
- *
206
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
207
- *
208
- * @param definition
209
- *
210
- * @see updateEffect
211
- * @see removeEffect
212
- */
213
- addEffect(definition: IPostProcessingEffectDefinition): string;
214
- /**
215
- * Get the default settings of an effect by their type.
216
- *
217
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
218
- *
219
- * @param type
220
- */
221
- getDefaultEffectProperties(type: POST_PROCESSING_EFFECT_TYPE): unknown;
222
- /**
223
- * Get the effect that was created with the specified token.
224
- * This functions returns the Effect-Classes as used by the postprocessing package.
225
- *
226
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
227
- *
228
- * @param token
229
- */
230
- getEffect(token: string): Effect;
231
- /**
232
- * Get all currently specified effects in a dictionary with the token as a key and
233
- * the type as a value.
234
- */
235
- getEffectTokens(): { [key: string]: POST_PROCESSING_EFFECT_TYPE };
236
- /**
237
- * Get a description of the post-processing effects that are current applied.
238
- *
239
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
240
- */
241
- getPostProcessingEffectsArray(): IPostProcessingEffectsArray
242
- /**
243
- * Remove an effect of the postprocessing pipeline.
244
- * Use the token that was generated by the {@link addEffect}-function.
245
- *
246
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
247
- *
248
- * @param token
249
- *
250
- * @see addEffect
251
- * @see updateEffect
252
- */
253
- removeEffect(token: string): boolean;
254
- /**
255
- * Update an effect of the postprocessing pipeline with the specified token and definition.
256
- * Use the token that was generated by the {@link addEffect}-function.
257
- *
258
- * Note: The post-processing API is still WIP. Breaking changes are to be expected.
259
- *
260
- * @param token
261
- * @param definition
262
- *
263
- * @see addEffect
264
- * @see removeEffect
265
- */
266
- updateEffect(token: string, definition: IPostProcessingEffectDefinition): void;
267
-
268
- // #endregion Public Methods (24)
269
- }