@shapediver/viewer/dist/index.d.ts

This is the npm package for the ShapeDiver Viewer. For more information on ShapeDiver, please visit our [homepage](https://shapediver.com/).

import { ResExport as ShapeDiverResponseExport, ResExportContent as ShapeDiverResponseExportContent, ResExportDefinitionGroup as ShapeDiverResponseExportDefinitionGroup, ResExportDefinitionType as EXPORT_TYPE, ResExportResult as ShapeDiverResponseExportResult, ResModelComputationStats as ShapeDiverResponseModelComputationStatus, ResOutput as ShapeDiverResponseOutput, ResOutputChunk as ShapeDiverResponseOutputChunkBackend, ResOutputContent as ShapeDiverResponseOutputContentBackend, ResParameter as ShapeDiverResponseParameter } from "@shapediver/sdk.geometry-api-sdk-v2";
import { addListener, generalOptions, IGeneralOptions, removeListener, sceneTree, version } from "@shapediver/viewer.api.general";
import { DataEngine } from "@shapediver/viewer.data-engine.data-engine";
import { GeometryEngine } from "@shapediver/viewer.data-engine.geometry-engine";
import { MaterialEngine } from "@shapediver/viewer.data-engine.material-engine";
import { IMaterialContentDataV1, IMaterialContentDataV2, IMaterialContentDataV3, ITag2D, ITag3D, ITexture, TAG3D_JUSTIFICATION } from "@shapediver/viewer.data-engine.shared-types";
import { CAMERA_TYPE, ICameraOptions, ORTHOGRAPHIC_CAMERA_DIRECTION } from "@shapediver/viewer.rendering-engine.camera-engine";
import { LIGHT_TYPE } from "@shapediver/viewer.rendering-engine.light-engine";
import { ANTI_ALIASING_TECHNIQUE, BlendFunction, BloomEffect, ChromaticAberrationEffect, DepthOfFieldEffect, DotScreenEffect, Effect, EffectComposer, ENVIRONMENT_MAP, ENVIRONMENT_MAP_CUBE, ENVIRONMENT_MAP_EMPTY, GodRaysEffect, GridEffect, HueSaturationEffect, IBloomEffectDefinition, IChromaticAberrationEffectDefinition, IDepthOfFieldEffectDefinition, IDotScreenEffectDefinition, IGodRaysEffectDefinition, IGridEffectDefinition, IHBAOEffectDefinition, IHueSaturationEffectDefinition, INoiseEffectDefinition, IOutlineEffectDefinition, IPixelationEffectDefinition, IPostProcessingEffectDefinition, IScanlineEffectDefinition, ISelectiveBloomEffectDefinition, ISepiaEffectDefinition, ISSAOEffectDefinition, IThreejsData, ITiltShiftEffectDefinition, IVignetteEffectDefinition, KernelSize, NoiseEffect, OutlineEffect, PixelationEffect, POST_PROCESSING_EFFECT_TYPE, Resolution, ScanlineEffect, SelectiveBloomEffect, SepiaEffect, SSAOEffect, ThreejsData, TiltShiftEffect, VignetteEffect, VignetteTechnique } from "@shapediver/viewer.rendering-engine.rendering-engine-threejs";
import { createSession, IDraggingParameterApi, IDrawingParameterApi, IExportApi, IFileParameterApi, IGumballParameterApi, IOutputApi, IOutputApiData, IParameterApi, isDraggingParameterApi, isDrawingParameterApi, ISelectionParameterApi, ISessionApi, ISessionApiData, isExportApi, isFileParameterApi, isGumballParameterApi, isOutputApi, isParameterApi, isSelectionParameterApi, isSessionApi, OutputApiData, SessionApiData, sessions } from "@shapediver/viewer.session";
import { ISessionData, ISessionOutputData, ResOutputChunk as ShapeDiverResponseOutputChunk, ResOutputContent as ShapeDiverResponseOutputContent, SessionData, SessionOutputData } from "@shapediver/viewer.session-engine.session-engine";
import { Box, IBox, IGeometry, ISphere, Sphere } from "@shapediver/viewer.shared.math";
import { ITransformation, ITree, ITreeNode, ITreeNodeData, Tree, TreeNode } from "@shapediver/viewer.shared.node-tree";
import { Converter, defaultSettings, EVENTTYPE, EVENTTYPE_CAMERA, EVENTTYPE_DRAWING_TOOLS, EVENTTYPE_GUMBALL, EVENTTYPE_INTERACTION, EVENTTYPE_OUTPUT, EVENTTYPE_PARAMETER, EVENTTYPE_RENDERING, EVENTTYPE_SCENE, EVENTTYPE_SESSION, EVENTTYPE_TASK, EVENTTYPE_VIEWPORT, IDomEventListener, IEvent, isARError, isValid, isViewerCameraError, isViewerCustomizationError, isViewerDataProcessingError, isViewerDrawingToolsError, isViewerEnvironmentMapError, isViewerError, isViewerGeometryBackendError, isViewerGeometryBackendGenericError, isViewerGeometryBackendRequestError, isViewerGeometryBackendResponseError, isViewerInteractionError, isViewerLightError, isViewerSessionError, isViewerSettingsError, isViewerUnknownError, isViewerValidationError, isViewerViewportError, isViewerWebGLError, LOGGING_LEVEL, MainEventTypes, SESSION_SETTINGS_MODE, ShapeDiverGeometryBackendError, ShapeDiverGeometryBackendRequestError, ShapeDiverGeometryBackendResponseError, ShapeDiverGeometryBackendResponseErrorType, ShapeDiverViewerArError, ShapeDiverViewerCameraError, ShapeDiverViewerCustomizationError, ShapeDiverViewerDataProcessingError, ShapeDiverViewerDrawingToolsError, ShapeDiverViewerEnvironmentMapError, ShapeDiverViewerError, ShapeDiverViewerErrorType, ShapeDiverViewerInteractionError, ShapeDiverViewerLightError, ShapeDiverViewerSessionError, ShapeDiverViewerSettingsError, ShapeDiverViewerUnknownError, ShapeDiverViewerValidationError, ShapeDiverViewerViewportError, ShapeDiverViewerWebGLError, stringify, SystemInfo } from "@shapediver/viewer.shared.services";
import { AnimationData, AttributeData, BUSY_MODE_DISPLAY, ChunkData, CustomData, DraggingParameterValue, DrawingParameterValue, EventResponseMapping, FLAG_TYPE, GeometryData, GumballParameterValue, HTMLElementAnchorCustomData, HTMLElementAnchorData, HTMLElementAnchorImageData, HTMLElementAnchorTextData, IAnchorDataImage, IAnchorDataText, IAnimationData, IAnimationTrack, IAttributeData, ICameraEvent, IChunkData, ICustomData, IDraggingParameterJsonSchema, IDraggingParameterProps, IDrawingParameterJsonSchema, IDrawingParameterSettings, IGeometryData, IGumballParameterJsonSchema, IGumballParameterProps, IHTMLElementAnchorData, IHTMLElementAnchorUpdateProperties, IInstanceData, IInteractionParameterJsonSchema, IInteractionParameterProps, IInteractionParameterSettings, IMapData, IMapDataProperties, IMapDataPropertiesDefinition, IMaterialAbstractData, IMaterialAbstractDataProperties, IMaterialAbstractDataPropertiesDefinition, IMaterialBasicLineData, IMaterialBasicLineDataProperties, IMaterialBasicLineDataPropertiesDefinition, IMaterialGemData, IMaterialGemDataProperties, IMaterialGemDataPropertiesDefinition, IMaterialLambertData, IMaterialLambertDataProperties, IMaterialLambertDataPropertiesDefinition, IMaterialMultiPointData, IMaterialMultiPointDataProperties, IMaterialMultiPointDataPropertiesDefinition, IMaterialPhongData, IMaterialPhongDataProperties, IMaterialPhongDataPropertiesDefinition, IMaterialPointData, IMaterialPointDataProperties, IMaterialPointDataPropertiesDefinition, IMaterialShadowData, IMaterialShadowDataProperties, IMaterialShadowDataPropertiesDefinition, IMaterialSpecularGlossinessData, IMaterialSpecularGlossinessDataProperties, IMaterialSpecularGlossinessDataPropertiesDefinition, IMaterialStandardData, IMaterialStandardDataProperties, IMaterialStandardDataPropertiesDefinition, IMaterialUnlitData, IMaterialUnlitDataProperties, IMaterialUnlitDataPropertiesDefinition, IMaterialVariantsData, InstanceData, InteractionParameterSettingsType, IOutputEvent, IParameterEvent, IPrimitiveData, IRenderingEvent, ISceneEvent, ISDTFAttributeData, ISDTFAttributesData, ISDTFAttributeVisualizationData, ISDTFItemData, ISDTFOverview, ISDTFOverviewData, ISelectionParameterJsonSchema, ISelectionParameterProps, ISessionEvent, ISessionSettingsSections, ISettingsSections, ITaskEvent, IViewportEvent, IViewportSettingsSections, MapData, MaterialBasicLineData, MaterialGemData, MaterialLambertData, MaterialMultiPointData, MaterialPhongData, MaterialPointData, MaterialShadowData, MaterialSpecularGlossinessData, MaterialStandardData, MaterialUnlitData, MaterialVariantsData, MATERIAL_ALPHA, MATERIAL_SHADING, MATERIAL_SIDE, MATERIAL_TYPE, PARAMETER_TYPE, PARAMETER_VISUALIZATION, PrimitiveData, PRIMITIVE_MODE, RENDERER_TYPE, SDTFAttributeData, SDTFAttributesData, SDTFItemData, SDTFOverviewData, SdtfPrimitiveTypeGuard, SDTF_TYPEHINT, SelectionParameterValue, SessionCreationDefinition, SPINNER_POSITIONING, TASK_TYPE, TEXTURE_ENCODING, TEXTURE_FILTERING, TEXTURE_WRAPPING, TONE_MAPPING, validateDraggingParameterSettings, validateDrawingParameterSettings, validateGumballParameterSettings, validateInteractionParameterSettings, validateSelectionParameterSettings, ViewportCreationDefinition, VISIBILITY_MODE } from "@shapediver/viewer.shared.types";
import { createViewport, IAmbientLightApi, ICameraApi, IDirectionalLightApi, IHemisphereLightApi, ILightApi, ILightSceneApi, IOrthographicCameraApi, IPerspectiveCameraApi, IPointLightApi, ISpotLightApi, IViewportApi, viewports } from "@shapediver/viewer.viewport";
export { createViewport, viewports };
export { createSession, sessions };
export { addListener, removeListener, sceneTree, generalOptions, version, IGeneralOptions, defaultSettings, };
export { SessionCreationDefinition, ViewportCreationDefinition };
export { ITree, Tree, ITreeNode, TreeNode, ITreeNodeData };
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, };
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, };
export { IBox, Box, ISphere, Sphere, IGeometry, ITransformation, ShapeDiverResponseOutput, ShapeDiverResponseOutputContentBackend, ShapeDiverResponseOutputChunkBackend, ShapeDiverResponseOutputContent, ShapeDiverResponseOutputChunk, IDomEventListener, IEvent, IThreejsData, ThreejsData, };
export { ShapeDiverResponseExport, ShapeDiverResponseExportContent, ShapeDiverResponseExportResult, ShapeDiverResponseModelComputationStatus, ShapeDiverResponseExportDefinitionGroup, ShapeDiverResponseParameter, };
export { EventResponseMapping, IViewportEvent, ISessionEvent, IOutputEvent, ICameraEvent, ISceneEvent, ITaskEvent, IRenderingEvent, IParameterEvent, ISettingsSections, IViewportSettingsSections, ISessionSettingsSections, };
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, IMaterialPhongData, MaterialPhongData, IMaterialPhongDataProperties, IMaterialPhongDataPropertiesDefinition, IMaterialLambertData, MaterialLambertData, IMaterialLambertDataProperties, IMaterialLambertDataPropertiesDefinition, IMapData, IMapDataProperties, IMapDataPropertiesDefinition, MapData, };
export { IAnimationData, AnimationData, IAnimationTrack, IGeometryData, IAttributeData, IPrimitiveData, IMaterialVariantsData, IInstanceData, InstanceData, GeometryData, AttributeData, PrimitiveData, MaterialVariantsData, };
export { IAnchorDataImage, IAnchorDataText, ITag2D, ITag3D, IHTMLElementAnchorData, IHTMLElementAnchorUpdateProperties, HTMLElementAnchorCustomData, HTMLElementAnchorTextData, HTMLElementAnchorImageData, HTMLElementAnchorData, IMaterialContentDataV1, IMaterialContentDataV2, IMaterialContentDataV3, ITexture, };
export { ICustomData, CustomData, ICameraOptions };
export { ISDTFOverviewData, SDTFOverviewData, ISDTFOverview, SDTFAttributesData, ISDTFAttributesData, ISDTFAttributeData, SDTFAttributeData, SDTFItemData, ISDTFItemData, ISDTFAttributeVisualizationData, SdtfPrimitiveTypeGuard, };
export { Converter, DataEngine, GeometryEngine, MaterialEngine, SystemInfo };
export { ISessionData, SessionData, ISessionOutputData, SessionOutputData };
export { ShapeDiverViewerErrorType, ShapeDiverViewerError, ShapeDiverViewerDataProcessingError, ShapeDiverViewerEnvironmentMapError, ShapeDiverViewerWebGLError, ShapeDiverViewerSettingsError, ShapeDiverViewerSessionError, ShapeDiverViewerCustomizationError, ShapeDiverViewerViewportError, ShapeDiverViewerUnknownError, ShapeDiverViewerArError, ShapeDiverViewerLightError, ShapeDiverViewerCameraError, ShapeDiverViewerValidationError, ShapeDiverViewerInteractionError, ShapeDiverViewerDrawingToolsError, ShapeDiverGeometryBackendError, ShapeDiverGeometryBackendRequestError, ShapeDiverGeometryBackendResponseError, ShapeDiverGeometryBackendResponseErrorType, };
export { isViewerError, isViewerUnknownError, isViewerDataProcessingError, isViewerEnvironmentMapError, isViewerWebGLError, isViewerSettingsError, isViewerSessionError, isViewerCustomizationError, isViewerViewportError, isViewerLightError, isViewerCameraError, isARError, isViewerValidationError, isViewerInteractionError, isViewerDrawingToolsError, isViewerGeometryBackendError, isViewerGeometryBackendGenericError, isViewerGeometryBackendRequestError, isViewerGeometryBackendResponseError, };
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, };
export { IExportApi, IFileParameterApi, IOutputApi, IParameterApi, ISessionApi, ISelectionParameterApi, IGumballParameterApi, IDraggingParameterApi, IDrawingParameterApi, };
export { isSessionApi, isExportApi, isFileParameterApi, isOutputApi, isParameterApi, isSelectionParameterApi, isGumballParameterApi, isDrawingParameterApi, isDraggingParameterApi, };
export { InteractionParameterSettingsType, IInteractionParameterProps, IInteractionParameterSettings, IInteractionParameterJsonSchema, ISelectionParameterProps, SelectionParameterValue, ISelectionParameterJsonSchema, IGumballParameterProps, GumballParameterValue, IGumballParameterJsonSchema, IDraggingParameterProps, DraggingParameterValue, IDraggingParameterJsonSchema, IDrawingParameterSettings, DrawingParameterValue, IDrawingParameterJsonSchema, validateInteractionParameterSettings, validateSelectionParameterSettings, validateGumballParameterSettings, validateDraggingParameterSettings, validateDrawingParameterSettings, };
export { ISessionApiData, SessionApiData, IOutputApiData, OutputApiData, IChunkData, ChunkData, };
export { ICameraApi, IOrthographicCameraApi, IPerspectiveCameraApi, IAmbientLightApi, IDirectionalLightApi, IHemisphereLightApi, IPointLightApi, ISpotLightApi, ILightApi, ILightSceneApi, IViewportApi, };
export { isValid, stringify };
//# sourceMappingURL=index.d.ts.map