API Docs for:
Show:

Site3dWidget Class

Класс виджета Site3d

Constructor

Site3dWidget

(
  • containerId
  • name
  • path
  • options
)

Parameters:

  • containerId String

    Идентификатор корневого элемента виджета

  • name String

    Имя базовой модели виджета

  • path String

    Путь до базовой модели виджета

  • options Object

    Параметры виджета

Item Index

Methods

Methods

initShow

()

Метод показывает дополнительный слой начальной загрузки

initHide

()

Метод скрывает дополнительный слой начальной загрузки

loadShow

(
  • info
)

Метод показывает загрузку

Parameters:

  • info Object

    Объект статуса

loadHide

()

Метод скрывает загрузку

loadSetStatus

(
  • info
)

Метод устанавливает статус загрузки

Parameters:

  • info Object

    Объект статуса

setRender

(
  • renderType
)

Метод устанавливает тип рендера

Parameters:

  • renderType String

    Тип рендера

updateIsRender

(
  • value
  • options
)

Метод обновляет включение или отключение рисования сцены виджета

Parameters:

  • value Boolean

    Истина, если нужно включить рисование сцены виджета\

  • options Object

    Дополнительные параметры

renderOn

()

Метод включает рисование сцены виджета

renderOff

()

Метод выключает рисование сцены виджета

navButtonUpdate

(
  • name
  • isOn
)

Метод обновляет кнопку навигации

Parameters:

  • name String

    Кодовое обозначение кнопки

  • isOn Boolean

    Истина, если состояние активности

navPanelsShow

()

Метод показывает панели инструментов

navPanelsHide

()

Метод скрывает панели инструментов

navPanelsToggle

()

Метод переключает видимость панелей инструментов

navSkyboxChange

(
  • value
)
async

Метод обрабатывает смену панорамы

Parameters:

  • value String

    Значение списка панорам

fullOn

()

Метод включает полноэкранный режим

fullOff

()

Метод выключает полноэкранный режим

updateFullButton

()

Метод обновляет кнопку управления полноэкранным просмотром

fullToggle

()

Метод переключает полноэкранный режим

fullScreenExit

()

Метод обрабатывает выход из полноэкранного режима

helpWindowShow

()

Метод показывает окно помощи

helpWindowHide

()

Метод скрывает окно помощи

helpWindowToggle

()

Метод показывает и скрывает окно помощи

rotateOn

()

Метод включает вращение модели

rotateOff

()

Метод выключает вращение модели

rotateStop

()

Метод выключает вращение модели и сбрасывает поворот в первоначальное состояние

rotateToggle

()

Метод переключает вращение модели

updateRotateButton

()

Метод обновляет кнопку управления вращением камеры

lightToggle

()

Метод переключает свечение

updateLightButton

()

Метод обновляет кнопку управления свечением

isCanAnim

() Boolean

Метод возвращает истину, если анимацию можно запускать

Returns:

Boolean:

Результат

getAnimOptions

() Object

Метод возвращает параметры анимации

Returns:

Object:

Результат

getAnimNumber

(
  • number
)
Number

Метод возвращает номер анимации

Parameters:

  • number Number

    Номера анимации

Returns:

Number:

Результат

animOn

()

Метод включает анимацию

animOff

()

Метод выключает анимацию

animToggle

()

Метод переключает анимацию

animScroll

(
  • delta
  • options
)

Метод осуществляет ручную анимацию

Parameters:

  • delta Number

    Шаг изменения анимации

  • options Object

    Параметры анимации

animByEventOn

(
  • eventName
)

Метод включает анимацию по событию

Parameters:

  • eventName String

    Имя события

animByEventOff

(
  • eventName
)

Метод выключает анимацию по событию

Parameters:

  • eventName String

    Имя события

animStop

()

Метод останавливает все анимации

animReset

()

Метод выключает все анимации с начала

animManualOn

()

Метод включает режим ручной анимации

animManualOff

()

Метод выключает режим ручной анимации

animManualToggle

()

Метод переключает ручной режим анимации

animShowMark

(
  • options
)

Метод показывает текущую метку анимации

Parameters:

  • options Object

    Параметры анимации

animRemoveMarks

(
  • marks
)

Метод удаляет метки анимации

Parameters:

  • marks Object

    Метки

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:

Object:

Результат

arOff

()

Метод выключает режим дополненной реальности

arToggle

() async

Метод переключает режим дополненной реальности

updateArButton

()

Метод обновляет кнопку управления AR

saveFile

(
  • category
  • blob
  • options
)
Promise async

Метод сохраняет файл и возвращает полный путь к файлу

Parameters:

  • category String

    Категория

  • blob Blob

    Данные файла

  • options Object

    Параметры

Returns:

Promise:

Результат

saveTextureFromObjectURL

(
  • texture
)
Promise async

Метод сохраняет файл текстуры из ссылки на объект и возвращает полный путь к файлу

Parameters:

  • texture String

    Ссылка на текстуру

Returns:

Promise:

Результат

saveSettingTexture

(
  • setting
)
async

Метод сохраняет файл текстуры в сохраненных данных настройки

Parameters:

  • setting Object

    Сохраненные данные настройки

getShareImageAsHTML

(
  • options
)
Promise async

Метод возвращает html скриншота виджета

Parameters:

  • options Object

    Параметры

Returns:

Promise:

Результат

getShareDataAsHTML

() Promise async

Метод возвращает html описания виджета

Returns:

Promise:

Результат

getShareDataAsHTML

() Promise async

Метод возвращает описание виджета в виде документа

Returns:

Promise:

Результат в виде Blob

share

(
  • path
)
async

Метод показывает окно, где можно поделиться PDF или ссылкой

Parameters:

  • path String

    Ссылка

download

()

Метод скачивания файла модели

exportImage

(
  • options
)
Blob | null async

Метод создает скриншот сцены

Parameters:

  • options Object

    Параметры создания видео

Returns:

Blob | null:

Итоговый файл изображения

exportVideo

(
  • options
)
Blob | null async

Метод создает видео

Parameters:

  • options Object

    Параметры создания видео

Returns:

Blob | null:

Итоговый файл видео

appendNav

(
  • domElement
)

Метод переносит навигацию в другой контейнер

Parameters:

  • domElement HTMLElement

    Контейнер

loadStyleString

(
  • elem
  • styleString
)
async

Метод вставляет строку стилей

Parameters:

  • elem HTMLElement

    DOM-элемент стилей

  • styleString String

    Строка стилей

loadStyleFile

(
  • elem
  • path
  • fileName
)
async

Метод вставляет файл стилей

Parameters:

  • elem HTMLElement

    DOM-элемент стилей

  • path String

    Путь до файла стилей

  • fileName String

    Имя файла стилей

loadStyle

(
  • elem
  • category
  • value
)
async

Метод вставляет файл стилей

Parameters:

  • elem HTMLElement

    DOM-элемент стилей

  • category String

    Категория

  • value String

    Значение

showNav

()

Метод показывает навигацию

hideNav

()

Метод скрывает навигацию

showModel

()

Метод показывает модель

hideModel

()

Метод скрывает модель

updateTheme

(
  • value
)
async

Метод обновляет тему оформления

Parameters:

  • value String

    Кодовое обозначение

updateAppearance

(
  • value
)
async

Метод обновляет внешний вид виджета

Parameters:

  • value Object

    Значение

updateFontFamily

(
  • value
)
async

Метод обновляет шрифт виджета

Parameters:

  • value String

    Название шрифта

updateBorderRadius

(
  • value
)

Метод обновляет радиус закругления виджета

Parameters:

  • value Number

    Радиус закругления

updateBackgroundColor

(
  • value
)

Метод обновляет цвет фона

Parameters:

  • value String

    Цвет фона в HEX формате с альфа каналом

updatePreloadBackgroundColor

(
  • value
)

Метод обновляет цвет фона окна загрузки

Parameters:

  • value String

    Цвет фона в HEX формате с альфа каналом

updatePreloadBackgroundImage

(
  • value
)

Метод обновляет изображение фона окна загрузки

Parameters:

  • value String

    Путь до изображения

updatePreloadPoster

(
  • value
)

Метод обновляет изображение кнопки загрузки

Parameters:

  • value String

    Путь до изображения

updatePreloadButton

(
  • value
)

Метод обновляет стандартную кнопку загрузки

Parameters:

  • value String

    Путь до изображения

updateScaleFading

(
  • value
)

Метод обновляет затухание при масштабировании

Parameters:

  • value Number

    Значение от 0 до 10

updateRotateFading

(
  • value
)

Метод обновляет затухание при вращении

Parameters:

  • value Number

    Значение от 0 до 10

updatePosCorrection

(
  • value
)
async

Метод обновляет коррекцию смещения

Parameters:

  • value Object

    Параметры

updateSizeCorrection

(
  • value
)
async

Метод обновляет коррекцию размера

Parameters:

  • value Number

    Значение

updateRotateCorrection

(
  • value
)
async

Метод обновляет коррекцию вращения

Parameters:

  • value Object

    Параметры

updateMoveControl

(
  • value
)
async

Метод обновляет управление перемещением камеры

Parameters:

  • value Object

    Параметры

updateScaleControl

(
  • value
)

Метод обновляет максимальный масштаб относительно модели

Parameters:

  • value Object

    Параметры

updateRotateControl

(
  • value
)

Метод обновляет управление вращением камеры

Parameters:

  • value Object

    Параметры

updateSizeControl

(
  • value
)

Метод обновляет управление показом размеров модели

Parameters:

  • value Object

    Параметры

updateAmbientLight

(
  • value
)

Метод обновляет общее освещение

Parameters:

  • value Object

    Параметры

updateDirectionalLight

(
  • value
  • options
)

Метод обновляет направленное освещение

Parameters:

  • value Object

    Параметры

  • options Object

    Дополнительные параметры

updateDirectionalLights

()

Метод обновляет все направленное освещение

restoreMaterialParams

(
  • paramNames
)

Метод восстанавливает параметры материала у модели конфигуратора

Parameters:

  • paramNames String

    Названия сохраняемых параметров

updateGraphics

(
  • value
)
async

Метод обновляет настройки графики

Parameters:

  • value Object

    Настройки графики

updatePainter

(
  • value
  • options
)

Метод обновляет раскраску

Parameters:

  • value Object

    Данные раскраски

  • options Object

    Дополнительные параметры

updateModelPainter

() Boolean

Метод устанавливает клики у модели и её элементов для раскраски

Returns:

Boolean:

Результат

updateModelClicks

()

Метод устанавливает клики у модели и её элементов

updateLod

() async

Метод обновляет уровень детализации модели

updateFloor

(
  • value
  • options
)
async

Метод обновляет пол

Parameters:

  • value Object

    Параметры

  • options Object

    Дополнительные параметры

updateSkyboxModel

() async

Метод обновляет модель панорамы

updateSkybox

(
  • value
  • options
)
async

Метод обновляет варианты панорамы

Parameters:

  • value Object

    Варианты панорамы

  • options Object

    Дополнительные параметры

updateLabels

(
  • value
)
async

Метод обновляет метки

Parameters:

  • value Arrayobject

    Данные меток

updateConfigurator

(
  • value
  • options
)
async

Метод обновляет настройки конфигуратора

Parameters:

  • value Object

    Параметры

  • options Object

    Дополнительные параметры

updateConfiguratorInLabels

() async

Метод обновляет информацию от конфигуратора в метках

updateScreenSizeCorrection

(
  • options
)

Метод обновляет настройки коррекции графики в зависимости от размеров отображаемых частей модели

Parameters:

  • options Object

    Дополнительные параметры

updateAr

(
  • value
)

Метод обновляет AR

Parameters:

  • value Object

    Данные AR

updateNavButtons

(
  • value
)
async

Метод обновляет кнопки навигации

Parameters:

  • value Arraystring

    Кодовые обозначения кнопок

updateAnimControl

(
  • value
)

Метод обновляет управление анимацией

Parameters:

  • value Object

    Параметры

updateModelAnimControl

() Boolean

Метод устанавливает события у модели для управления анимацией

Returns:

Boolean:

Результат

updateAnimButton

()

Метод обновляет кнопку управления анимацией

updateHelp

(
  • value
)

Метод обновляет панель помощи

Parameters:

  • value Object

    Значение

updateNavPanel

(
  • name
  • content
)

Метод обновляет дополнительную панель

Parameters:

  • name String

    Имя панели

  • content String | HTMLElement

    Содержимое панели

selectNavPanel

(
  • name
)

Метод выбирает дополнительную панель

Parameters:

  • name String

    Имя панели

enableNavPanel

(
  • name
)

Метод активирует дополнительную панель

Parameters:

  • name String

    Имя панели

disableNavPanel

(
  • name
)

Метод деактивирует дополнительную панель

Parameters:

  • name String

    Имя панели

updateNavPanels

()

Метод обновляет показ дополнительных панелей

updateNavStart

(
  • value
)

Метод обновляет состояние навигации при старте

Parameters:

  • value Object

    Значение

updateWatermark

(
  • value
)

Метод обновляет водяной знак

Parameters:

  • value Object

    Параметры

updateStartRotate

(
  • value
)

Метод обновляет вращение камеры вокруг модели после старта сцены

Parameters:

  • value Object

    Параметры

stopStartRotate

()

Метод останавливает вращение камеры вокруг модели после старта сцены

updateStartHelp

(
  • value
)

Метод обновляет показ анимационных иконок после старта сцены

Parameters:

  • value Object

    Параметры

stopStartHelp

()

Метод останавливает показ анимационных иконок после старта сцены

updateAutoRotate

(
  • value
)

Метод обновляет автовращение

Parameters:

  • value Object

    Параметры

updateTargetControl

(
  • value
)

Метод обновляет центр вращения и масштабирования

Parameters:

  • value Object

    Позиция

updateCamera

(
  • value
)
async

Метод обновляет параметры камеры

Parameters:

  • value Object

    Параметры

updateSizeInfo

()

Метод обновляет показ размеров модели

updateNavShare

(
  • value
)

Метод обновляет информацию о возможностях поделиться

Parameters:

  • value Object

    Значение

moveToInitView

() async

Метод перемещает камеру к первоначальному виду

moveToLabel

(
  • index
)

Метод перемещает камеру к метке или первоначальному виду

Parameters:

  • index Number

    Индекс метки (начиная с 1) или 0 для первоначального вида

moveToModelPart

(
  • name
  • options
)

Метод перемещает камеру к части модели

Parameters:

  • name String

    Имя части модели

  • options Object

    Дополнительные параметры

setStyles

(
  • name
  • styles
  • domElement
)

Метод устанавливает стили

Parameters:

  • name String

    Имя

  • styles Object

    Стили

  • domElement HTMLElement

    DOM элемент, определяющий область видимости стилей

event

(
  • name
  • call
)

Метод подписывает на события виджета

Parameters:

  • name String

    Имя события

  • call Function

    Функция обработки события

removeEvent

(
  • name
  • call
)

Метод удаляет подписку на события виджета

Parameters:

  • name String

    Имя события

  • call Function

    Функция обработки события

load

() async

Метод загружает виджет

saveConfiguratorStat

() async

Метод сохраняет статистику

getConfiguratorInfo

() Object

Метод возвращает информацию о выборе пользователя в конфигураторе

Returns:

Object:

Результат

clear

()

Метод очистки виджета

widget

(
  • containerId
  • name
  • path
  • options
)
Site3dWidget static

Метод создания 3D виджета

Parameters:

  • containerId String

    Идентификатор HTML-контейнера

  • name String

    Имя модели

  • path String

    Путь до модели

  • options Object

    Дополнительные параметры

Returns:

Site3dWidget:

Объект виджета

widgetAsync

(
  • containerId
  • name
  • path
  • options
)
Site3dWidget static

Метод асинхронного создания 3D виджета

Parameters:

  • containerId String

    Идентификатор HTML-контейнера

  • name String

    Имя модели

  • path String

    Путь до модели

  • options Object

    Дополнительные параметры

Returns:

Site3dWidget:

Объект виджета как результат промиса

Properties

container

HTMLElement

Свойство возвращает корневой элемент виджета

name

String

Свойство возвращает имя базовой модели виджета

guid

String

Свойство возвращает уникальное имя виджета

path

String

Свойство возвращает путь до базовой модели виджета

options

Object

Свойство возвращает параметры виджета

s3d

Site3d

Свойство возвращает объект сцены

model

Site3dModel

Свойство возвращает базовую модель виджета

configurator

Site3dConfigurator

Свойство возвращает объект конфигуратора

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

Свойство устанавливает свечение