API Docs for: 1.0.0
Show:

Site3dAnimControl Class

Defined in: modules\anim.js:6
Module: Site3dAnim

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

Constructor

Site3dAnimControl

(
  • model
  • speed
)

Defined in modules\anim.js:6

Parameters:

  • model Site3dModel

    Модель

  • speed Number

    Скорость анимации (по умолчанию 1 единица в секунду)

Methods

preloadShow

(
  • status
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:384

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

Parameters:

preloadHide

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:397

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

preloadSetStatus

(
  • status
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:406

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

Parameters:

setRender

(
  • renderType
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:416

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

Parameters:

  • renderType String

    Тип рендера

navButtonUpdate

(
  • name
  • isOn
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:444

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

Parameters:

  • name String

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

  • isOn Boolean

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

fullOn

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:476

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

fullOff

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:499

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

fullToggle

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:516

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

fullButtonKeyEvent

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:528

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

getRotateModel

() Site3dModel

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:538

Метод возвращает модель для вращения

Returns:

Site3dModel:

Результат

rotateOn

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:548

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

rotateOff

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:562

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

rotateToggle

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:573

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

isCanAnim

() Boolean

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:597

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

Returns:

Boolean:

Результат

animOn

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:607

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

animOff

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:661

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

animToggle

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:681

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

navSkyboxShow

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:693

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

navSkyboxHide

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:703

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

navSkyboxToggle

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:713

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

sizeOn

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:725

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

sizeOff

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:745

Метод выключает показ размеров модели

sizeToggle

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:759

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

labelOn

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:771

Метод включает показ меток модели

labelOff

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:785

Метод выключает показ меток модели

labelToggle

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:799

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

vrOn

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:811

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

vrOff

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:824

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

vrToggle

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:833

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

arOn

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:853

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

arOff

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:866

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

arToggle

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:875

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

getShareImageAsHTML

() Promise async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:895

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

Returns:

Promise:

Результат в виде строки

getShareDataAsHTML

() Promise async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:921

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

Returns:

Promise:

Результат

getShareDataAsHTML

() Promise async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:952

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

Returns:

Promise:

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

shareWindowShow

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:976

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

shareWindowHide

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:986

Метод скрывает окно поделиться

share

() async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:996

Метод поделиться

helpWindowShow

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1055

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

helpWindowHide

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1065

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

appendNav

(
  • domElement
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1075

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

Parameters:

loadStyle

(
  • elem
  • category
  • value
)
async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1085

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

Parameters:

  • elem HTMLElement

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

  • category String

    Категоиря

  • value String

    Значение

updateTheme

(
  • value
)
async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1110

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

Parameters:

  • value String

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

updateFontFamily

(
  • value
)
async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1124

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

Parameters:

  • value String

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

updateBorderRadius

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1139

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

Parameters:

  • value Number

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

updateBackgroundColor

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1152

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

Parameters:

  • value String

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

updatePreloadBackgroundColor

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1165

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

Parameters:

  • value String

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

updatePreloadBackgroundImage

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1178

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

Parameters:

  • value String

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

updateConfigurator

(
  • value
)
async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1192

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

Parameters:

  • value Object

    Параметры

updateScaleControl

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1249

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

Parameters:

  • value Object

    Число или процент

updateRotateButton

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1271

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

updateRotateControl

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1280

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

Parameters:

  • value Object

    Параметры

updateAutoRotate

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1296

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

Parameters:

  • value Object

    Параметры

updateAnimButton

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1310

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

updateAnimControl

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1319

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

Parameters:

  • value Object

    Параметры

animScroll

(
  • delta
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1354

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

Parameters:

  • delta Object

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

updateSizeButton

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1367

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

updateSizeControl

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1376

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

Parameters:

  • value Object

    Параметры

updateCamera

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1397

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

Parameters:

  • value Object

    Параметры

updateFloor

(
  • value
)
async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1423

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

Parameters:

  • value Object

    Параметры

updateSkyboxModel

() async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1464

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

updateSkybox

(
  • value
)
async

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1486

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

Parameters:

  • value Array

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

updateLabelButton

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1516

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

updateAmbientLight

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1525

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

Parameters:

  • value Arrayobject

    Данные меток

updateAmbientLight

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1688

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

Parameters:

  • value Object

    Параметры

updateDirectionalLight

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1704

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

Parameters:

  • value Object

    Параметры

updateNavButtons

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1731

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

Parameters:

  • value Arraystring

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

updateHelp

(
  • value
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1832

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

Parameters:

  • value Object

    Значение

toURL

(
  • url
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1861

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

Parameters:

event

(
  • name
  • call
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1871

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

Parameters:

  • name String

    Имя события

  • call Function

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

removeEvent

(
  • name
  • call
)

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1882

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

Parameters:

  • name String

    Имя события

  • call Function

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

clear

()

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1893

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

widget

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

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1928

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

Parameters:

  • containerId String

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

  • name String

    Имя модели

  • path String

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

  • options Object

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

Returns:

Site3dWidget:

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

widgetAsync

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

Provided by the Site3dWidget module.

Defined in modules\widget\widget.js:1943

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

Parameters:

  • containerId String

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

  • name String

    Имя модели

  • path String

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

  • options Object

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

Returns:

Site3dWidget:

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

updateTimer

() static

Defined in modules\anim.js:38

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

play

(
  • options
)

Defined in modules\anim.js:92

Метод запускает анимации

Parameters:

  • options Object

    Параметры

    • keys - Массив номеров анимации (по умолчанию все анимации)
    • speed - скорость анимации
    • repeat - Повторение анимации (once - один раз, loop - многократно, forwardAndBack - многократно туда и обратно, по умолчанию loop)
    • direction - Направление (forward - вперед, back - назад, по умолчанию forward)

pause

(
  • options
)

Defined in modules\anim.js:117

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

Parameters:

  • options Object

    Параметры

    • keys - Массив номеров анимации (по умолчанию все анимации)

toggle

(
  • options
)

Defined in modules\anim.js:129

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

Parameters:

  • options Object

    Параметры

    • keys - Массив номеров анимации (по умолчанию все анимации)

getPos

(
  • key
)
Number

Defined in modules\anim.js:143

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

Parameters:

  • key Number

    Номер анимации (по умолчанию 0)

Returns:

Number:

Позиция от 0 до 1

setPos

(
  • pos
  • keys
)

Defined in modules\anim.js:153

Метод устанавливает позицию анимации

Parameters:

  • pos Number

    Позиция анимации от 0 до 1 (по умолчанию 0)

  • keys Number[]

    Массив номеров анимации (по умолчанию все анимации)

setPos

(
  • step
  • keys
)

Defined in modules\anim.js:163

Метод устанавливает позицию анимации

Parameters:

  • step Number

    Шаг изменения позиции анимации от 0 до 1 (по умолчанию 0.01)

  • keys Number[]

    Массив номеров анимации (по умолчанию все анимации)

update

()

Defined in modules\anim.js:173

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

Properties

widget

Site3dWidget

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

controls

Map static

Defined in modules\anim.js:27

Свойство возвращает объекты управления анимациями моделей

isPlay

Boolean

Defined in modules\anim.js:62

Свойство возвращает истину, если анимация запущена

speed

Number

Defined in modules\anim.js:72

Свойство возвращает скорость анимации

speed

Unknown

Defined in modules\anim.js:82

Свойство устанавливает скорость анимации

stepUpdate

Function

Defined in modules\anim.js:189

Свойство возвращает и устанавливает функцию, выполняемую на каждом шаге анимации

stepUpdateModel

Function

Defined in modules\anim.js:205

Свойство возвращает и устанавливает модель, которая генерирует событие обновления всех анимаций