API Docs for:
Show:

Site3dConfigurator Class

Defined in: modules\configurator\configurator.js:8
Module: Site3dConfigurator

Класс конфигуратора

Основная логика инициализации:

  • Добавляем настройки и инициализируем их значениями по-умолчанию, а затем значениями из файла конфигуратора
  • Создаем элементы (модели)
  • Применяем все автозапускаемые настройки конфигуратора и его элементов (по-умолчанию все настройки автозапускаемые)

Основные понятия:

  • Настройки - параметры конфигуратора или его элементов, которые можно сохранить
  • Действия - инструменты управления состоянием конфигуратора или его элементов
  • Панели - области интерфейса, которые могут содержать в себе настройки, действия или произвольное содержимое
  • Панели управления - панели, которые содержат в себе настройки и действия
  • Окна - панели с произвольным содержимым

Как устроены панели:

  • Корневой HTML-элемент панели имеет свой идентификатор и к нему автоматически добавляется класс site3dConfiguratorPanel
  • По-умолчанию доступны панель управления конфигуратором (site3dConfiguratorPanelControlsMain) и его элементами (site3dConfiguratorPanelControlsItem)
  • Содержимое панели помещается в HTML-элемент с классом site3dConfiguratorPanelContent
  • Внутри корневого HTML-элемента может быть HTML-элемент с классом site3dConfiguratorPanelCloseButton (при клике для корневого HTML-элемента будет добавлятся и удалятся класс site3dConfiguratorPanel_show)

Как устроены настройки и действия:

  • Всегда объединяются в группы (по-умолчанию есть группа с идентификатором main)
  • Идентификатор группы задается в атрибуте data-group
  • Есть возможность отдельно выводить кнопки, которые показывают настройки или действия определенной группы
  • Группы настроек и действий можно перемешивать друг с другом (при этом становятся недоступны отдельные кнопки переключения между группами)

Описание шаблонов:

  • Все шаблоны находятся в папке templates и разбиты по папкам:
  • main - главный шаблон конфигуратора
  • panelControlsCaption - содержимое заголовков панелей управления настройками и действиями
  • panelControlsContent - содержимое панелей управления настройками и действиями
  • settingsContent - содержимое настроек
  • settingsGroupsButton - кнопки показа и скрытия группы настроек
  • settingsGroup - группы настроек
  • settingsItem - элемент настроек
  • actionsSimple - действия при клике
  • actionsPicker - наборы действий в виде списка для переноса объектов на сцену
  • actionsPickerItem - элементы наборов действий
  • mixContent - смешанное содержимое панелей управления из настроек и действий

Constructor

Site3dConfigurator

(
  • s3d
  • options
)

Defined in modules\configurator\configurator.js:8

Parameters:

  • s3d Site3d

    Объект 3D сцены

  • options Object

    Параметры конфигуратора:

    • name - Название конфигуратора
    • path - Путь до файлов конфигуратора
    • insertPlace - место содержимого конфигуратора (по умолчанию перед канвасом)
    • connectModelName - имя модели в сцене, к которой будет привязан конфигуратор
    • data - данные в формате json (путь к файлу или объект)
    • dataMobile - данные в формате json (путь к файлу или объект) для мобильных устройств
    • priceList - прайс-лист в формате json (путь к файлу или объект)
    • buildLogic - логика построения
    • orderInfo - логика формы заказа
    • load - обработчик завершения загрузки конфигуратора

Methods

create

(
  • s3d
  • options
)
Site3dConfigurator static async

Defined in modules\configurator\configurator.js:303

Метод создает объект конфигуратора

Parameters:

  • s3d Site3d

    Объект 3D сцены

  • options Object

    Параметры конфигуратора (смотрите описание конструктора конфигуратора)

Returns:

Site3dConfigurator:

Объект конфигуратора как результат промиса

treeForEach

(
  • parent
  • childAction
  • parentAction
  • level
)
static

Defined in modules\configurator\configurator.js:330

Метод прохода по дереву коллекций

Parameters:

  • parent Map

    Дерево коллекций

  • childAction Function

    Функция для обработки дочерних элементов

  • parentAction Function

    Функция для обработки родительских элементов

  • level Number

    Стартовый уровень вложенности

loadOptions

(
  • object
  • options
)
static

Defined in modules\configurator\configurator.js:373

Метод загрузки параметров объекта

Parameters:

  • object Object

    Объект

  • options Object

    Параметры

createTexture

(
  • options
)
Promise async

Defined in modules\configurator\configurator.js:385

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

Parameters:

  • options Object

    Параметры

Returns:

Promise:

Файл текстуры в base64

getServerData

(
  • filePath
  • data
  • format
)
Promise async

Defined in modules\configurator\configurator.js:777

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

Parameters:

  • filePath String

    Путь до файла скрипта с расширением

  • data Object

    Отправляемые на сервер данные (по-умолчанию null)

  • format String

    Формат возвращаемого результата (по-умолчанию json)

Returns:

Promise:

Результат

checkDevice

()

Defined in modules\configurator\configurator.js:819

Метод производит проверку типа устройства

start

(
  • options
)
async

Defined in modules\configurator\configurator.js:828

Метод запуска конфигуратора

Parameters:

  • options Object

    Параметры конфигуратора

init

() async

Defined in modules\configurator\configurator.js:1006

Метод инициализации конфигуратора. Используйте перегреженную версию для переопределения базовых параметров:

  • templatesPath - путь к HTML-шаблонам
  • actionsPath - путь к иконкам действий
  • texturesPath - путь к текстурам

getOrderItems

()

Defined in modules\configurator\configurator.js:1018

Метод возвращает родительский элемент дерева конфигуратора для отображения в заказе (для переопределения)

addBuildLogic

()

Defined in modules\configurator\configurator.js:1027

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

addOrderInfo

()

Defined in modules\configurator\configurator.js:1035

Метод формирования формы заказа конфигуратора (для переопределения)

addTemplates

()

Defined in modules\configurator\configurator.js:1043

Метод добавления описаний для загрузки HTML-шаблонов (для переопределения с целью добавления новых шаблонов в свойство templates)

beforeLoad

() async

Defined in modules\configurator\configurator.js:1051

Метод запускается перед началом загрузки данных конфигуратора (для переопределения)

addPanels

() async

Defined in modules\configurator\configurator.js:1060

Метод добавления панелей управления (для переопределения с целью добавления новых панелей в коллекцию panels)

loadDataCompleted

(
  • data
)
async

Defined in modules\configurator\configurator.js:1069

Метод запускается после завершения загрузки данных конфигуратора (для переопределения)

Parameters:

  • data Object

    Данные конфигуратора

load

(
  • options
)
async

Defined in modules\configurator\configurator.js:1079

Метод загрузки параметров конфигуратора (используется для загрузки сохраненных ранее проектов)

Parameters:

  • options Object

    Параметры конфигуратора

updateLoadScreenBackgroundColor

(
  • value
)

Defined in modules\configurator\configurator.js:1240

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

Parameters:

  • value String

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

updateShowPanelControlsButton

(
  • value
)

Defined in modules\configurator\configurator.js:1255

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

Parameters:

  • value Boolean

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

addSettings

() async

Defined in modules\configurator\configurator.js:1277

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

addActions

() async

Defined in modules\configurator\configurator.js:1365

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

addItems

() async

Defined in modules\configurator\configurator.js:1374

Метод добавления элементов конфигуратора (для переопределения)

addItem

(
  • model
  • options
)
Site3dConfiguratorItem async

Defined in modules\configurator\configurator.js:1383

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

Parameters:

  • model Site3dModel

    3D модель элемента

  • options Object

    Параметры элемента

Returns:

Site3dConfiguratorItem:

Новый элемент конфигуратора

loadItemsCompleted

() async

Defined in modules\configurator\configurator.js:1398

Метод завершения загрузки частей конфигуратора (для переопределения)

autoStartSettingsCompleted

() async

Defined in modules\configurator\configurator.js:1425

Метод завершения автозапуска настроек конфигуратора (для переопределения)

build

()

Defined in modules\configurator\configurator.js:1434

Метод сборки элементов конфигуратора (для переопределения)

loadCompleted

() async

Defined in modules\configurator\configurator.js:1442

Метод завершения загрузки конфигуратора (для переопределения)

addTemplate

(
  • name
  • options
)
async

Defined in modules\configurator\configurator.js:1451

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

Parameters:

  • name String

    Имя шаблона

  • options Object

    Параметры шаблона

getTemplate

(
  • name
  • params
  • subName
)
Promise async

Defined in modules\configurator\configurator.js:1486

Метод получения HTML-шаблона

Parameters:

  • name String

    Имя шаблона

  • params String

    Массив значений, подставляемых в шаблон

  • subName String

    Постфикс в названии шаблона

Returns:

Promise:

Содержимое шаблона

s

(
  • name
)
Any

Defined in modules\configurator\configurator.js:1535

Метод получения значения настройки

Parameters:

  • name String

    Имя настройки

Returns:

Any:

Значение настройки

setSettings

()

Defined in modules\configurator\configurator.js:1551

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

loadItems

(
  • promise
)
Promise

Defined in modules\configurator\configurator.js:1563

Метод регистрации результата добавления части конфигуратора (элемент или часть дерева элементов)

Parameters:

  • promise Promise

    Промис окончания загрузки части конфигуратора

Returns:

Promise:

Промис

itemsForEach

(
  • childAction
  • parentAction
)

Defined in modules\configurator\configurator.js:1575

Метод прохода по дереву элементов конфигуратора. В функциях обработки в качестве аргументов передается сам элемент дерева и объект из элементов:

  • index - идентификатор элемента
  • parent - родительский элемент
  • level - уровень вложенности

Parameters:

  • childAction Function

    Функция для обработки элементов конфигуратора

  • parentAction Function

    Функция для обработки родительских элементов дерева конфигуратора

getItemIntersectByModels

(
  • models
  • options
)
Object

Defined in modules\configurator\configurator.js:1589

Метод возвращает объект из элемента конфигуратора и его позиции, по которой кликнули мышкой

Parameters:

  • models Site3dModel[]

    Модели, среди которых нужно выбирать нужный элемент

  • options Object

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

Returns:

Object:

Результат

getItemIntersect

(
  • items
  • options
)
Object

Defined in modules\configurator\configurator.js:1622

Метод возвращает объект из элемента конфигуратора и его позиции, по которой кликнули мышкой

Parameters:

  • items Site3dConfiguratorItem[]

    Элементы конфигуратора, среди которых нужно выбирать нужный элемент

  • options Object

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

Returns:

Object:

Результат

getItems

(
  • check
  • options
)
Site3dConfiguratorItem[]

Defined in modules\configurator\configurator.js:1634

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

Parameters:

  • check Function

    Функция обработки условий

  • options Object

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

Returns:

Site3dConfiguratorItem[]:

Список элементов конфигуратора

getItemsByType

(
  • type
  • options
)
Site3dConfiguratorItem[]

Defined in modules\configurator\configurator.js:1664

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

Parameters:

  • type String

    Тип элемента конфигуратора

  • options Object

    Параметры

Returns:

Site3dConfiguratorItem[]:

Список элементов конфигуратора

getItemByIndex

(
  • index
  • options
)
Site3dConfiguratorItem

Defined in modules\configurator\configurator.js:1676

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

Parameters:

  • index String

    Индекс элемента конфигуратора

  • options Object

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

Returns:

Site3dConfiguratorItem:

Элемент конфигуратора

updatePriceInfo

(
  • value
  • options
)

Defined in modules\configurator\configurator.js:1688

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

Parameters:

  • value Object

    Значение

  • options Object

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

calcPrice

()

Defined in modules\configurator\configurator.js:1726

Метод расчета строимости (для переопределения)

getFormatPrice

() String

Defined in modules\configurator\configurator.js:1773

Метод возвращает форматированное значение стоимости

Returns:

String:

Результат

updatePrice

()

Defined in modules\configurator\configurator.js:1783

Метод считает и показывает стоимость (для возможного переопределения)

updateOrderWindow

()

Defined in modules\configurator\configurator.js:1805

Метод создает окно заказа

updateOrderInfo

(
  • value
  • options
)

Defined in modules\configurator\configurator.js:2029

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

Parameters:

  • value Object

    Значение

  • options Object

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

startLoading

()

Defined in modules\configurator\configurator.js:2066

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

setLoadingStatus

(
  • content
  • percent
)

Defined in modules\configurator\configurator.js:2090

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

Parameters:

  • content String

    Статус загрузки

  • percent Number

    Процент загрузки

endLoading

()

Defined in modules\configurator\configurator.js:2110

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

startLock

()

Defined in modules\configurator\configurator.js:2124

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

endLock

()

Defined in modules\configurator\configurator.js:2133

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

enableItems

()

Defined in modules\configurator\configurator.js:2142

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

disableItems

()

Defined in modules\configurator\configurator.js:2151

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

setItemsEnabledPrev

()

Defined in modules\configurator\configurator.js:2160

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

deselectActions

()

Defined in modules\configurator\configurator.js:2169

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

getActionPath

(
  • name
  • owner
)
String

Defined in modules\configurator\configurator.js:2203

Метод возвращает путь до действия с учетом вложенности групп

Parameters:

Returns:

String:

Путь

findActionPickerData

(
  • check
)
Object

Defined in modules\configurator\configurator.js:2234

Метод возвращает данные действия Site3dConfiguratorActionsPicker по условию

Parameters:

  • check Function

    Условие

Returns:

Object:

Результат

panel

(
  • name
)
Site3dConfiguratorPanel

Defined in modules\configurator\configurator.js:2265

Метод возвращает панель

Parameters:

  • name String

    Название панели

Returns:

Site3dConfiguratorPanel:

Панель

showPanel

(
  • name
  • data
  • eventData
)
async

Defined in modules\configurator\configurator.js:2276

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

Parameters:

  • name String

    Название панели

  • data Object

    Данные для наполнения панели

  • eventData Object

    Данные для передачи в событие показа панели

hide

(
  • name
)

Defined in modules\configurator\configurator.js:2290

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

Parameters:

  • name String

    Название панели

togglePanel

(
  • name
)
async

Defined in modules\configurator\configurator.js:2300

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

Parameters:

  • name String

    Название панели

callEvent

(
  • name
  • data
)

Defined in modules\configurator\configurator.js:2312

Метод вызывает событие конфигуратора

Parameters:

  • name String

    Имя событие

  • data Object

    Данные для передачи в событие

event

(
  • name
  • call
)

Defined in modules\configurator\configurator.js:2325

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

Parameters:

  • name String

    Имя события

  • call Function

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

removeEvent

(
  • name
  • call
)

Defined in modules\configurator\configurator.js:2336

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

Parameters:

  • name String

    Имя события

  • call Function

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

getSaveItems

(
  • root
)

Defined in modules\configurator\configurator.js:2347

Метод возвращает элементы дерева конфигуратора для сохранения в json формате

Parameters:

  • root Object

    Корневой элемент (по умолчанию все элементы)

getSaveData

()

Defined in modules\configurator\configurator.js:2393

Метод возвращает объект для сохранения конфигуратора в json формате

loadDataItems

(
  • items
  • loadItem
  • options
)
async

Defined in modules\configurator\configurator.js:2405

Метод загружает элементы конфигуратора из объекта в json формате

Parameters:

  • items Object

    Данные

  • loadItem Function

    Обработчик загрузки элементов конфигуратора

  • options Object

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

loadDataItemSettings

(
  • item
  • dataItemSettings
)
async

Defined in modules\configurator\configurator.js:2443

Метод загружает настройки конфигуратора или его элемента из объекта в json формате

Parameters:

loadDataSettings

(
  • settings
)

Defined in modules\configurator\configurator.js:2468

Метод загружает настройки конфигуратора из объекта в json формате

Parameters:

  • settings Object

    Данные

getItemsInfo

(
  • childAction
  • parentAction
)

Defined in modules\configurator\configurator.js:2481

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

Parameters:

  • childAction Function

    Функция для обработки элемента конфигуратора

  • parentAction Function

    Функция для обработки родительских элементов дерева конфигуратора

Properties

templatesPath

String

Defined in modules\configurator\configurator.js:244

Путь к HTML-шаблонам

actionsPath

String

Defined in modules\configurator\configurator.js:251

Путь к иконкам действий

texturesPath

String

Defined in modules\configurator\configurator.js:258

Путь к текстурам

modelsPath

String

Defined in modules\configurator\configurator.js:265

Путь к моделям

s3d

Site3d

Defined in modules\configurator\configurator.js:427

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

options

Object

Defined in modules\configurator\configurator.js:437

Свойство возвращает параметры конфигуратора

name

String

Defined in modules\configurator\configurator.js:447

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

path

String

Defined in modules\configurator\configurator.js:457

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

insertPlace

Object

Defined in modules\configurator\configurator.js:467

Свойство возвращает место содержимого конфигуратора ({domElement: HTMLElement, where: string})

connectModelName

String

Defined in modules\configurator\configurator.js:477

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

priceList

Object

Defined in modules\configurator\configurator.js:487

Свойство возвращает прайс-лист конфигуратора

priceList

Unknown

Defined in modules\configurator\configurator.js:497

Свойство устанавливает прайс-лист конфигуратора

buildLogic

Object

Defined in modules\configurator\configurator.js:506

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

buildLogic

Unknown

Defined in modules\configurator\configurator.js:516

Свойство устанавливает логику построения конфигуратора

priceInfo

Object

Defined in modules\configurator\configurator.js:525

Свойство возвращает информацию о стоимости

priceInfo

Unknown

Defined in modules\configurator\configurator.js:535

Свойство устанавливает информацию о стоимости

orderInfo

Object

Defined in modules\configurator\configurator.js:544

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

orderInfo

Unknown

Defined in modules\configurator\configurator.js:554

Свойство устанавливает логику построения конфигуратора

config

Object

Defined in modules\configurator\configurator.js:563

Свойство возвращает конфигурационные данные конфигуратора

data

Object

Defined in modules\configurator\configurator.js:573

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

isMobile

Boolean

Defined in modules\configurator\configurator.js:583

Свойство возвращает истину, если конфигуратор запущен на мобильном устройстве

settings

Site3dConfiguratorSettings

Defined in modules\configurator\configurator.js:593

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

settingsUpdated

Map

Defined in modules\configurator\configurator.js:603

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

actions

Site3dConfiguratorActions

Defined in modules\configurator\configurator.js:613

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

items

Map

Defined in modules\configurator\configurator.js:623

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

model

Site3dModel

Defined in modules\configurator\configurator.js:633

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

panels

Map

Defined in modules\configurator\configurator.js:643

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

panelControlsButton

HTMLElement

Defined in modules\configurator\configurator.js:653

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

history

Site3dConfiguratorHistory

Defined in modules\configurator\configurator.js:663

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

container

HTMLElement

Defined in modules\configurator\configurator.js:673

Контейнер конфигуратора

isLoadingData

Boolean

Defined in modules\configurator\configurator.js:683

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

isLoadDataCompleted

Boolean

Defined in modules\configurator\configurator.js:693

Свойство возвращает истину, если конфигуратор загружен

isVisible

Boolean

Defined in modules\configurator\configurator.js:703

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

isVisible

Unknown

Defined in modules\configurator\configurator.js:713

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

Sub-properties:

  • value Boolean

    Активность

isAnyItemOnChange

Boolean

Defined in modules\configurator\configurator.js:740

Свойство возвращает истину, если какая-то настройка была запущена через интерфейс пользователя

panelControlsButtonClick

Function

Defined in modules\configurator\configurator.js:1515

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

panelControlsButtonClick

Unknown

Defined in modules\configurator\configurator.js:1525

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

Sub-properties:

  • click Function

    Обработчик клика