API Docs for: 1.0.0
Show:

Site3dGLTFAnimControl Class

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

Класс управления анимациями в моделях формата GLTF

Constructor

Site3dGLTFAnimControl

(
  • model
  • speed
)

Defined in modules\anim.js:221

Parameters:

  • model Site3dModel

    Модель

  • speed Number

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

Methods

playAnim

(
  • options
)

Defined in modules\anim.js:372

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

Parameters:

  • options Object

    Параметры

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

pauseAnim

(
  • options
)

Defined in modules\anim.js:389

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

Parameters:

  • options Object

    Параметры

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

toggleAnim

(
  • options
)

Defined in modules\anim.js:403

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

Parameters:

  • options Object

    Параметры

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

getAnimPos

(
  • key
)
Number

Defined in modules\anim.js:417

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

Parameters:

  • key Number

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

Returns:

Number:

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

setAnimPos

(
  • pos
  • keys
)

Defined in modules\anim.js:428

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

Parameters:

  • pos Number

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

  • keys Number[]

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

incrementAnimPos

(
  • step
  • keys
)

Defined in modules\anim.js:442

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

Parameters:

  • step Number

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

  • keys Number[]

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

clearAnim

()

Defined in modules\anim.js:456

Метод очищает анимации модели

clearAnim

() static

Defined in modules\anim.js:489

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

preloadShow

(
  • status
)

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

Parameters:

preloadHide

()

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

preloadSetStatus

(
  • status
)

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

Parameters:

setRender

(
  • renderType
)

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

Parameters:

  • renderType String

    Тип рендера

navButtonUpdate

(
  • name
  • isOn
)

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

Parameters:

  • name String

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

  • isOn Boolean

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

fullOn

()

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

fullOff

()

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

fullToggle

()

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

fullButtonKeyEvent

()

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

getRotateModel

() Site3dModel

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

Returns:

Site3dModel:

Результат

rotateOn

()

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

rotateOff

()

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

rotateToggle

()

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

isCanAnim

() Boolean

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

Returns:

Boolean:

Результат

animOn

()

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

animOff

()

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

animToggle

()

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

navSkyboxShow

()

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

navSkyboxHide

()

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

navSkyboxToggle

()

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

sizeOn

()

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

sizeOff

()

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

sizeToggle

()

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

labelOn

()

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

labelOff

()

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

labelToggle

()

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

vrOn

()

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

vrOff

()

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

vrToggle

()

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

arOn

()

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

arOff

()

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

arToggle

()

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

getShareImageAsHTML

() Promise async

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

Returns:

Promise:

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

getShareDataAsHTML

() Promise async

Inherited from Site3dAnimControl but overwritten in modules\widget\widget.js:921

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

Returns:

Promise:

Результат

shareWindowShow

()

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

shareWindowHide

()

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

share

() async

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

helpWindowShow

()

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

helpWindowHide

()

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

appendNav

(
  • domElement
)

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

Parameters:

loadStyle

(
  • elem
  • category
  • value
)
async

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

Parameters:

  • elem HTMLElement

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

  • category String

    Категоиря

  • value String

    Значение

updateTheme

(
  • value
)
async

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

Parameters:

  • value String

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

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

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

updateConfigurator

(
  • value
)
async

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

Parameters:

  • value Object

    Параметры

updateScaleControl

(
  • value
)

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

Parameters:

  • value Object

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

updateRotateButton

()

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

updateRotateControl

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateAutoRotate

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateAnimButton

()

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

updateAnimControl

(
  • value
)

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

Parameters:

  • value Object

    Параметры

animScroll

(
  • delta
)

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

Parameters:

  • delta Object

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

updateSizeButton

()

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

updateSizeControl

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateCamera

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateFloor

(
  • value
)
async

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

Parameters:

  • value Object

    Параметры

updateSkyboxModel

() async

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

updateSkybox

(
  • value
)
async

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

Parameters:

  • value Array

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

updateLabelButton

()

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

updateAmbientLight

(
  • value
)

Inherited from Site3dAnimControl but overwritten in modules\widget\widget.js:1525

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

Parameters:

  • value Arrayobject

    Данные меток

updateDirectionalLight

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateNavButtons

(
  • value
)

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

Parameters:

  • value Arraystring

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

updateHelp

(
  • value
)

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

Parameters:

  • value Object

    Значение

toURL

(
  • url
)

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

Parameters:

event

(
  • name
  • call
)

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

Parameters:

  • name String

    Имя события

  • call Function

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

removeEvent

(
  • name
  • call
)

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

Parameters:

  • name String

    Имя события

  • call Function

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

clear

()

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

play

(
  • options
)

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

Parameters:

  • options Object

    Параметры

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

pause

(
  • options
)

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

Parameters:

  • options Object

    Параметры

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

toggle

(
  • options
)

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

Parameters:

  • options Object

    Параметры

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

getPos

(
  • key
)
Number

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

Parameters:

  • key Number

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

Returns:

Number:

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

setPos

(
  • pos
  • keys
)

Inherited from Site3dAnimControl but overwritten in modules\anim.js:153

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

Parameters:

  • pos Number

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

  • keys Number[]

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

update

()

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

Properties

animControl

Site3dAnimControl

Defined in modules\anim.js:360

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

speedAnim

Number

Defined in modules\anim.js:470

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

widget

Site3dWidget

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

isPlay

Boolean

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

speed

Number

Inherited from Site3dAnimControl but overwritten in modules\anim.js:72

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

stepUpdate

Function

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

stepUpdateModel

Function

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