Site3dWidget Class
Класс виджета Site3d
Constructor
Site3dWidget
-
containerId -
name -
path -
options
Parameters:
-
containerIdStringИдентификатор корневого элемента виджета
-
nameStringИмя базовой модели виджета
-
pathStringПуть до базовой модели виджета
-
optionsObjectПараметры виджета
Item Index
Methods
- initShow
- initHide
- loadShow
- loadHide
- loadSetStatus
- setRender
- updateIsRender
- renderOn
- renderOff
- navButtonUpdate
- navPanelsShow
- navPanelsHide
- navPanelsToggle
- navSkyboxChange
- fullOn
- fullOff
- updateFullButton
- fullToggle
- fullScreenExit
- helpWindowShow
- helpWindowHide
- helpWindowToggle
- rotateOn
- rotateOff
- rotateStop
- rotateToggle
- updateRotateButton
- lightToggle
- updateLightButton
- isCanAnim
- getAnimOptions
- getAnimNumber
- animOn
- animOff
- animToggle
- animScroll
- animByEventOn
- animByEventOff
- animStop
- animReset
- animManualOn
- animManualOff
- animManualToggle
- animShowMark
- animRemoveMarks
- animClearMarksTimer
- skyboxShow
- skyboxHide
- skyboxToggle
- updateSkyboxButton
- sizeOn
- sizeOff
- sizeToggle
- updateSizeButton
- labelOn
- labelOff
- labelToggle
- updateLabelButton
- painterOn
- painterOff
- painterToggle
- updatePainterButton
- vrOn
- vrOff
- vrToggle
- updateVrButton
- arOn
- arOff
- arToggle
- updateArButton
- saveFile
- saveTextureFromObjectURL
- saveSettingTexture
- getLink
- getShareImageAsHTML
- getShareDataAsHTML
- getShareDataAsHTML
- share
- link
- download
- exportImage
- exportVideo
- appendNav
- loadStyleString
- loadStyleFile
- loadStyle
- showNav
- hideNav
- showLogo
- hideLogo
- showModel
- hideModel
- updateTheme
- updateAppearance
- updateFontFamily
- updateBorderRadius
- updateBackgroundColor
- updatePreloadBackgroundColor
- updatePreloadBackgroundImage
- updatePreloadPoster
- updatePreloadButton
- updateScaleFading
- updateRotateFading
- updatePosCorrection
- updateSizeCorrection
- updateRotateCorrection
- updateMoveControl
- updateScaleControl
- updateRotateControl
- updateSizeControl
- updateAmbientLight
- updateDirectionalLight
- updateDirectionalLights
- restoreMaterialParams
- updateGraphics
- updatePainter
- updateModelPainter
- updateModelClicks
- updateLod
- updateFloor
- updateSkyboxModel
- updateSkybox
- updateLabels
- updateConfigurator
- updateConfiguratorInLabels
- updateScreenSizeCorrection
- updateLinks
- updateModelLinks
- updateAr
- updateNavButtons
- updateAnimControl
- updateModelAnimControl
- updateAnimButton
- updateNavLink
- updateHelp
- updateNavPanel
- selectNavPanel
- enableNavPanel
- disableNavPanel
- updateNavPanels
- updateNavStart
- updateLogo
- updateWatermark
- updateStartRotate
- stopStartRotate
- updateStartHelp
- stopStartHelp
- updateAutoRotate
- updateTargetControl
- updateCamera
- updateSizeInfo
- updateLink
- updateNavShare
- moveToInitView
- moveToLabel
- moveToModelPart
- setStyles
- event
- removeEvent
- load
- saveConfiguratorStat
- getConfiguratorInfo
- clear
- widget static
- widgetAsync static
Methods
initShow
()
Метод показывает дополнительный слой начальной загрузки
initHide
()
Метод скрывает дополнительный слой начальной загрузки
loadShow
-
info
Метод показывает загрузку
Parameters:
-
infoObjectОбъект статуса
loadHide
()
Метод скрывает загрузку
loadSetStatus
-
info
Метод устанавливает статус загрузки
Parameters:
-
infoObjectОбъект статуса
setRender
-
renderType
Метод устанавливает тип рендера
Parameters:
-
renderTypeStringТип рендера
updateIsRender
-
value -
options
Метод обновляет включение или отключение рисования сцены виджета
Parameters:
-
valueBooleanИстина, если нужно включить рисование сцены виджета\
-
optionsObjectДополнительные параметры
renderOn
()
Метод включает рисование сцены виджета
renderOff
()
Метод выключает рисование сцены виджета
fullOn
()
Метод включает полноэкранный режим
fullOff
()
Метод выключает полноэкранный режим
updateFullButton
()
Метод обновляет кнопку управления полноэкранным просмотром
fullToggle
()
Метод переключает полноэкранный режим
fullScreenExit
()
Метод обрабатывает выход из полноэкранного режима
helpWindowShow
()
Метод показывает окно помощи
helpWindowHide
()
Метод скрывает окно помощи
helpWindowToggle
()
Метод показывает и скрывает окно помощи
rotateOn
()
Метод включает вращение модели
rotateOff
()
Метод выключает вращение модели
rotateStop
()
Метод выключает вращение модели и сбрасывает поворот в первоначальное состояние
rotateToggle
()
Метод переключает вращение модели
updateRotateButton
()
Метод обновляет кнопку управления вращением камеры
lightToggle
()
Метод переключает свечение
updateLightButton
()
Метод обновляет кнопку управления свечением
isCanAnim
()
Boolean
Метод возвращает истину, если анимацию можно запускать
Returns:
Результат
getAnimOptions
()
Object
Метод возвращает параметры анимации
Returns:
Результат
getAnimNumber
-
number
Метод возвращает номер анимации
Parameters:
-
numberNumberНомера анимации
Returns:
Результат
animOn
()
Метод включает анимацию
animOff
()
Метод выключает анимацию
animToggle
()
Метод переключает анимацию
animScroll
-
delta -
options
Метод осуществляет ручную анимацию
Parameters:
-
deltaNumberШаг изменения анимации
-
optionsObjectПараметры анимации
animByEventOn
-
eventName
Метод включает анимацию по событию
Parameters:
-
eventNameStringИмя события
animByEventOff
-
eventName
Метод выключает анимацию по событию
Parameters:
-
eventNameStringИмя события
animStop
()
Метод останавливает все анимации
animReset
()
Метод выключает все анимации с начала
animManualOn
()
Метод включает режим ручной анимации
animManualOff
()
Метод выключает режим ручной анимации
animManualToggle
()
Метод переключает ручной режим анимации
animShowMark
-
options
Метод показывает текущую метку анимации
Parameters:
-
optionsObjectПараметры анимации
animRemoveMarks
-
marks
Метод удаляет метки анимации
Parameters:
-
marksObjectМетки
animClearMarksTimer
()
Метод удаляет таймер анимации
skyboxShow
()
async
Метод показывает панораму
skyboxHide
()
async
Метод скрывает панораму
skyboxToggle
()
async
Метод переключает видимость панорамы
updateSkyboxButton
()
Метод обновляет кнопку управления показом панорамы
sizeOn
()
Метод включает показ размеров модели
sizeOff
()
Метод выключает показ размеров модели
sizeToggle
()
Метод переключает показ размеров модели
updateSizeButton
()
Метод обновляет кнопку управления показом размеров модели
labelOn
()
Метод включает показ меток модели
labelOff
()
Метод выключает показ меток модели
labelToggle
()
Метод переключает показ меток модели
updateLabelButton
()
Метод обновляет кнопку управления показом меток модели
painterOn
()
Метод включает раскраску по клику
painterOff
()
Метод выключает раскраску по клику
painterToggle
()
Метод переключает раскраску по клику
updatePainterButton
()
Метод обновляет кнопку управления раскраской по клику
vrOn
()
async
Метод включает режим виратуальной реальности
vrOff
()
Метод выключает режим виратуальной реальности
vrToggle
()
async
Метод переключает режим виратуальной реальности
updateVrButton
()
Метод обновляет кнопку управления VR
arOn
()
Object
async
Метод включает режим дополненной реальности
Returns:
Результат
arOff
()
Метод выключает режим дополненной реальности
arToggle
()
async
Метод переключает режим дополненной реальности
updateArButton
()
Метод обновляет кнопку управления AR
saveFile
-
category -
blob -
options
Метод сохраняет файл и возвращает полный путь к файлу
Parameters:
-
categoryStringКатегория
-
blobBlobДанные файла
-
optionsObjectПараметры
Returns:
Результат
saveTextureFromObjectURL
-
texture
Метод сохраняет файл текстуры из ссылки на объект и возвращает полный путь к файлу
Parameters:
-
textureStringСсылка на текстуру
Returns:
Результат
saveSettingTexture
-
setting
Метод сохраняет файл текстуры в сохраненных данных настройки
Parameters:
-
settingObjectСохраненные данные настройки
getLink
-
options
Метод возвращает ссылку на просмотр виджета
Parameters:
-
optionsObjectПараметры
Returns:
Результат
link
()
async
Метод вызова окна, где можно поделиться ссылкой на виджет
download
()
Метод скачивания файла модели
exportImage
-
options
Метод создает скриншот сцены
Parameters:
-
optionsObjectПараметры создания видео
Returns:
Итоговый файл изображения
exportVideo
-
options
Метод создает видео
Parameters:
-
optionsObjectПараметры создания видео
Returns:
Итоговый файл видео
loadStyleString
-
elem -
styleString
Метод вставляет строку стилей
Parameters:
-
elemHTMLElementDOM-элемент стилей
-
styleStringStringСтрока стилей
loadStyleFile
-
elem -
path -
fileName
Метод вставляет файл стилей
Parameters:
-
elemHTMLElementDOM-элемент стилей
-
pathStringПуть до файла стилей
-
fileNameStringИмя файла стилей
loadStyle
-
elem -
category -
value
Метод вставляет файл стилей
Parameters:
-
elemHTMLElementDOM-элемент стилей
-
categoryStringКатегория
-
valueStringЗначение
showLogo
()
Метод показывает логотип
hideLogo
()
Метод скрывает логотип
showModel
()
Метод показывает модель
hideModel
()
Метод скрывает модель
updateTheme
-
value
Метод обновляет тему оформления
Parameters:
-
valueStringКодовое обозначение
updateAppearance
-
value
Метод обновляет внешний вид виджета
Parameters:
-
valueObjectЗначение
updateFontFamily
-
value
Метод обновляет шрифт виджета
Parameters:
-
valueStringНазвание шрифта
updateBorderRadius
-
value
Метод обновляет радиус закругления виджета
Parameters:
-
valueNumberРадиус закругления
updateBackgroundColor
-
value
Метод обновляет цвет фона
Parameters:
-
valueStringЦвет фона в HEX формате с альфа каналом
updatePreloadBackgroundColor
-
value
Метод обновляет цвет фона окна загрузки
Parameters:
-
valueStringЦвет фона в HEX формате с альфа каналом
updatePreloadBackgroundImage
-
value
Метод обновляет изображение фона окна загрузки
Parameters:
-
valueStringПуть до изображения
updatePreloadPoster
-
value
Метод обновляет изображение кнопки загрузки
Parameters:
-
valueStringПуть до изображения
updatePreloadButton
-
value
Метод обновляет стандартную кнопку загрузки
Parameters:
-
valueStringПуть до изображения
updateScaleFading
-
value
Метод обновляет затухание при масштабировании
Parameters:
-
valueNumberЗначение от 0 до 10
updateRotateFading
-
value
Метод обновляет затухание при вращении
Parameters:
-
valueNumberЗначение от 0 до 10
updatePosCorrection
-
value
Метод обновляет коррекцию смещения
Parameters:
-
valueObjectПараметры
updateSizeCorrection
-
value
Метод обновляет коррекцию размера
Parameters:
-
valueNumberЗначение
updateRotateCorrection
-
value
Метод обновляет коррекцию вращения
Parameters:
-
valueObjectПараметры
updateMoveControl
-
value
Метод обновляет управление перемещением камеры
Parameters:
-
valueObjectПараметры
updateScaleControl
-
value
Метод обновляет максимальный масштаб относительно модели
Parameters:
-
valueObjectПараметры
updateRotateControl
-
value
Метод обновляет управление вращением камеры
Parameters:
-
valueObjectПараметры
updateSizeControl
-
value
Метод обновляет управление показом размеров модели
Parameters:
-
valueObjectПараметры
updateAmbientLight
-
value
Метод обновляет общее освещение
Parameters:
-
valueObjectПараметры
updateDirectionalLight
-
value -
options
Метод обновляет направленное освещение
Parameters:
-
valueObjectПараметры
-
optionsObjectДополнительные параметры
updateDirectionalLights
()
Метод обновляет все направленное освещение
restoreMaterialParams
-
paramNames
Метод восстанавливает параметры материала у модели конфигуратора
Parameters:
-
paramNamesStringНазвания сохраняемых параметров
updateGraphics
-
value
Метод обновляет настройки графики
Parameters:
-
valueObjectНастройки графики
updatePainter
-
value -
options
Метод обновляет раскраску
Parameters:
-
valueObjectДанные раскраски
-
optionsObjectДополнительные параметры
updateModelPainter
()
Boolean
Метод устанавливает клики у модели и её элементов для раскраски
Returns:
Результат
updateModelClicks
()
Метод устанавливает клики у модели и её элементов
updateLod
()
async
Метод обновляет уровень детализации модели
updateFloor
-
value -
options
Метод обновляет пол
Parameters:
-
valueObjectПараметры
-
optionsObjectДополнительные параметры
updateSkyboxModel
()
async
Метод обновляет модель панорамы
updateSkybox
-
value -
options
Метод обновляет варианты панорамы
Parameters:
-
valueObjectВарианты панорамы
-
optionsObjectДополнительные параметры
updateLabels
-
value
Метод обновляет метки
Parameters:
-
valueArrayobjectДанные меток
updateConfigurator
-
value -
options
Метод обновляет настройки конфигуратора
Parameters:
-
valueObjectПараметры
-
optionsObjectДополнительные параметры
updateConfiguratorInLabels
()
async
Метод обновляет информацию от конфигуратора в метках
updateScreenSizeCorrection
-
options
Метод обновляет настройки коррекции графики в зависимости от размеров отображаемых частей модели
Parameters:
-
optionsObjectДополнительные параметры
updateLinks
-
value -
options
Метод обновляет ссылки
Parameters:
-
valueArrayobjectДанные ссылок
-
optionsObjectДополнительные параметры
updateModelLinks
()
Boolean
Метод устанавливает ссылки у модели и её элементов
Returns:
Результат
updateAr
-
value
Метод обновляет AR
Parameters:
-
valueObjectДанные AR
updateAnimControl
-
value
Метод обновляет управление анимацией
Parameters:
-
valueObjectПараметры
updateModelAnimControl
()
Boolean
Метод устанавливает события у модели для управления анимацией
Returns:
Результат
updateAnimButton
()
Метод обновляет кнопку управления анимацией
updateHelp
-
value
Метод обновляет панель помощи
Parameters:
-
valueObjectЗначение
updateLogo
-
value
Метод обновляет показ логотипа
Parameters:
-
valueObjectЗначение
updateWatermark
-
value
Метод обновляет водяной знак
Parameters:
-
valueObjectПараметры
updateStartRotate
-
value
Метод обновляет вращение камеры вокруг модели после старта сцены
Parameters:
-
valueObjectПараметры
stopStartRotate
()
Метод останавливает вращение камеры вокруг модели после старта сцены
updateStartHelp
-
value
Метод обновляет показ анимационных иконок после старта сцены
Parameters:
-
valueObjectПараметры
stopStartHelp
()
Метод останавливает показ анимационных иконок после старта сцены
updateAutoRotate
-
value
Метод обновляет автовращение
Parameters:
-
valueObjectПараметры
updateTargetControl
-
value
Метод обновляет центр вращения и масштабирования
Parameters:
-
valueObjectПозиция
updateCamera
-
value
Метод обновляет параметры камеры
Parameters:
-
valueObjectПараметры
updateSizeInfo
()
Метод обновляет показ размеров модели
updateLink
-
value
Метод обновляет ссылку для кнопки поделиться ссылкой
Parameters:
-
valueObjectПараметры
moveToInitView
()
async
Метод перемещает камеру к первоначальному виду
moveToLabel
-
index
Метод перемещает камеру к метке или первоначальному виду
Parameters:
-
indexNumberИндекс метки (начиная с 1) или 0 для первоначального вида
moveToModelPart
-
name -
options
Метод перемещает камеру к части модели
Parameters:
-
nameStringИмя части модели
-
optionsObjectДополнительные параметры
setStyles
-
name -
styles -
domElement
Метод устанавливает стили
Parameters:
-
nameStringИмя
-
stylesObjectСтили
-
domElementHTMLElementDOM элемент, определяющий область видимости стилей
event
-
name -
call
Метод подписывает на события виджета
Parameters:
-
nameStringИмя события
-
callFunctionФункция обработки события
removeEvent
-
name -
call
Метод удаляет подписку на события виджета
Parameters:
-
nameStringИмя события
-
callFunctionФункция обработки события
load
()
async
Метод загружает виджет
saveConfiguratorStat
()
async
Метод сохраняет статистику
getConfiguratorInfo
()
Object
Метод возвращает информацию о выборе пользователя в конфигураторе
Returns:
Результат
clear
()
Метод очистки виджета
widget
-
containerId -
name -
path -
options
Метод создания 3D виджета
Parameters:
-
containerIdStringИдентификатор HTML-контейнера
-
nameStringИмя модели
-
pathStringПуть до модели
-
optionsObjectДополнительные параметры
Returns:
Объект виджета
widgetAsync
-
containerId -
name -
path -
options
Метод асинхронного создания 3D виджета
Parameters:
-
containerIdStringИдентификатор HTML-контейнера
-
nameStringИмя модели
-
pathStringПуть до модели
-
optionsObjectДополнительные параметры
Returns:
Объект виджета как результат промиса
Properties
container
HTMLElement
Свойство возвращает корневой элемент виджета
name
String
Свойство возвращает имя базовой модели виджета
guid
String
Свойство возвращает уникальное имя виджета
path
String
Свойство возвращает путь до базовой модели виджета
options
Object
Свойство возвращает параметры виджета
isFull
Boolean
Свойство возвращает истину, если запущен полноэкранный режим
isRotate
Boolean
Свойство возвращает истину, если запущен режим вращения
isAnim
Boolean
Свойство возвращает истину, если запущена анимация
isVR
Boolean
Свойство возвращает истину, если запущен режим VR
isAR
Boolean
Свойство возвращает истину, если запущен режим AR
isLod
Boolean
Свойство возвращает истину, если действует LOD
isConfiguratorData
Boolean
Свойство возвращает истину, если переданы данные для создания конфигуратора
isConfigurator
Boolean
Свойство возвращает истину, если подключен конфигуратор
isLoad
Boolean
Свойство возвращает истину, если виджет загружен
isLight
Boolean
Свойство возвращает истину, если включено свечение
isLight
Unknown
Свойство устанавливает свечение
