API Docs for: 1.0.0
Show:

Site3dGLTFAnimControl Class

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

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

Constructor

Site3dGLTFAnimControl

(
  • model
  • speed
)

Defined in modules\anim.js:260

Parameters:

  • model Site3dModel

    Модель

  • speed Number

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

Item Index

Methods

Methods

isNotPlay

(
  • number
)
Boolean

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

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

Parameters:

  • number Number[] | string

    Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

Returns:

Boolean:

Результат

playAnim

(
  • options
)

Defined in modules\anim.js:462

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

Parameters:

  • options Object

    Параметры:

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

pauseAnim

(
  • options
)

Defined in modules\anim.js:479

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

Parameters:

  • options Object

    Параметры:

    • number - Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

pauseAnim

(
  • options
)

Defined in modules\anim.js:493

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

Parameters:

  • options Object

    Параметры:

    • number - Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

toggleAnim

(
  • options
)

Defined in modules\anim.js:508

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

Parameters:

  • options Object

    Параметры:

    • number - Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

getAnimPos

(
  • number
)
Number

Defined in modules\anim.js:522

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

Parameters:

  • number Number

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

Returns:

Number:

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

setAnimPos

(
  • pos
  • number
)

Defined in modules\anim.js:533

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

Parameters:

  • pos Number

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

  • number Number[] | string

    Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

incrementAnimPos

(
  • step
  • number
)

Defined in modules\anim.js:547

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

Parameters:

  • step Number

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

  • number Number[] | string

    Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

clearAnim

()

Defined in modules\anim.js:561

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

clearAnim

() static

Defined in modules\anim.js:606

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

preloadShow

(
  • info
)

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

Parameters:

  • info Object

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

preloadHide

()

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

preloadSetStatus

(
  • info
)

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

Parameters:

  • info Object

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

setRender

(
  • renderType
)

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

Parameters:

  • renderType String

    Тип рендера

navButtonUpdate

(
  • name
  • isOn
)

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

Parameters:

  • name String

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

  • isOn Boolean

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

navPanelsShow

()

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

navPanelsHide

()

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

navPanelsToggle

()

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

navSkyboxChange

(
  • value
)
async

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

Parameters:

  • value String

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

fullOn

()

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

fullOff

()

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

fullToggle

()

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

fullButtonKeyEvent

()

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

helpWindowShow

()

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

helpWindowHide

()

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

helpWindowToggle

()

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

getRotateModel

() Site3dModel

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

Returns:

Site3dModel:

Результат

rotateOn

()

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

rotateOff

()

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

rotateStop

()

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

rotateToggle

()

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

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

()

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

animShowMark

(
  • options
)

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

Parameters:

  • options Object

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

animRemoveMarks

(
  • marks
)

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

Parameters:

animClearMarksTimer

()

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

skyboxShow

() async

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

skyboxHide

() async

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

skyboxToggle

() async

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

sizeOn

()

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

sizeOff

()

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

sizeToggle

()

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

labelOn

()

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

labelOff

()

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

labelToggle

()

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

vrOn

()

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

vrOff

()

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

vrToggle

()

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

arOn

() async

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

arOff

()

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

arToggle

() async

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

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

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

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

Returns:

Promise:

Результат

share

(
  • path
)
async

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

Parameters:

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:

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

()

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

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

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

updatePreloadPoster

(
  • value
)

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

Parameters:

  • value String

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

updateWatermark

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateNavButtons

(
  • value
)
async

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

Parameters:

  • value Arraystring

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

updateFullButton

()

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

updateRotateButton

()

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

updateAnimButton

()

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

updateSkyboxButton

()

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

updateHelp

(
  • value
)

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

Parameters:

  • value Object

    Значение

updateLabelButton

()

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

updateSizeButton

()

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

updateRotateCorrection

(
  • value
)
async

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

Parameters:

  • value Object

    Параметры

updateStartHelp

()

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

updateNavPanel

(
  • name
  • content
)

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

Parameters:

selectNavPanel

(
  • name
)

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

Parameters:

  • name String

    Имя панели

enableNavPanel

(
  • name
)

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

Parameters:

  • name String

    Имя панели

disableNavPanel

(
  • name
)

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

Parameters:

  • name String

    Имя панели

updateNavPanels

()

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

updateNavStart

(
  • value
)

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

Parameters:

  • value Object

    Значение

updateScaleControl

(
  • value
)

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

Parameters:

  • value Object

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

updateScaleFading

(
  • value
)

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

Parameters:

  • value Number

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

updateRotateControl

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateAutoRotate

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateRotateFading

(
  • value
)

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

Parameters:

  • value Number

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

updateTargetControl

(
  • value
)

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

Parameters:

updateAnimControl

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateCamera

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateFloor

(
  • value
  • options
)
async

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

Parameters:

  • value Object

    Параметры

  • options Object

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

updateSkyboxModel

() async

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

updateSkybox

(
  • value
)
async

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

Parameters:

  • value Array

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

updateSizeInfo

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateSizeControl

(
  • value
)

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

Parameters:

  • value Object

    Параметры

updateAmbientLight

(
  • value
)

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

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

Parameters:

  • value Arrayobject

    Данные меток

updateDirectionalLight

(
  • value
  • options
)

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

Parameters:

  • value Object

    Параметры

  • options Object

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

updateGraphics

(
  • value
)

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

Parameters:

  • value Object

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

updateScreenSizeCorrection

(
  • options
)

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

Parameters:

  • options Object

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

updateConfigurator

(
  • value
)
async

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

Parameters:

  • value Object

    Параметры

updateConfiguratorInLabels

() async

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

updateAr

(
  • value
)

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

Parameters:

  • value Object

    Данные AR

updatePriceInfo

(
  • value
)

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

Parameters:

  • value Object

    Значение

updateOrderInfo

(
  • value
)

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

Parameters:

  • value Object

    Значение

updateNavShare

(
  • value
)

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

Parameters:

  • value Object

    Значение

moveToInitView

()

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

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

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

clear

()

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

updateLod

() async

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

saveConfiguratorStat

() async

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

getConfiguratorInfo

() Object

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

Returns:

Object:

Результат

getNumbers

(
  • number
)
Number[]

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

Parameters:

  • number Number[] | string

    Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

Returns:

Number[]:

Результат

play

(
  • options
)

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

Parameters:

  • options Object

    Параметры

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

pause

(
  • options
)

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

Parameters:

  • options Object

    Параметры

    • number - Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

toggle

(
  • options
)

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

Parameters:

  • options Object

    Параметры

    • number - Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

getPos

(
  • number
)
Number

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

Parameters:

  • number Number

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

Returns:

Number:

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

setPos

(
  • pos
  • number
)

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

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

Parameters:

  • pos Number

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

  • number Number[] | string

    Массив номеров анимации или строки all или none (по умолчанию all - все анимации)

update

()

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

Properties

animControl

Site3dAnimControl

Defined in modules\anim.js:436

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

speedAnim

Number

Defined in modules\anim.js:575

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

lastPlayAnimNumbers

Number[]

Defined in modules\anim.js:594

Свойство возвращает последние проигранные номера анимаций модели

isLod

Boolean

Свойство возвращает истину, если действует LOD

isConfiguratorData

Boolean

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

isConfigurator

Boolean

Свойство возвращает истину, если подключен конфигуратор

itemsInfo

Object[]

Свойство возвращает информацию по элементам конфигуратора

isPlay

Boolean

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

speed

Number

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

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

lastPlayNumbers

Number[]

Свойство возвращает последние проигранные номера анимаций

stepUpdate

Function

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

stepUpdateModel

Function

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