Site3dConfigurator Class
Класс конфигуратора
Основная логика инициализации:
- Добавляем настройки и инициализируем их значениями по-умолчанию, а затем значениями из файла конфигуратора
- Создаем элементы (модели)
- Применяем все автозапускаемые настройки конфигуратора и его элементов (по-умолчанию все настройки автозапускаемые)
Основные понятия:
- Настройки - параметры конфигуратора или его элементов, которые можно сохранить
- Действия - инструменты управления состоянием конфигуратора или его элементов
- Панели - области интерфейса, которые могут содержать в себе настройки, действия или произвольное содержимое
- Панели управления - панели, которые содержат в себе настройки и действия
- Окна - панели с произвольным содержимым
Как устроены панели:
- Корневой 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
Parameters:
-
s3dSite3dОбъект 3D сцены
-
optionsSite3dConfiguratorOptionsПараметры конфигуратора:
- name - Название конфигуратора
- path - Путь до файлов конфигуратора
- insertPlace - место содержимого конфигуратора (по умолчанию перед канвасом)
- connectModelName - имя модели в сцене, к которой будет привязан конфигуратор
- data - данные в формате json (путь к файлу или объект)
- dataMobile - данные в формате json (путь к файлу или объект) для мобильных устройств
- priceList - прайс-лист в формате json (путь к файлу или объект)
- buildLogic - логика построения
- orderInfo - логика формы заказа
- load - обработчик завершения загрузки конфигуратора
Item Index
Methods
- create static
- treeForEach static
- createTexture
- getServerData
- checkDevice
- start
- init
- getOrderItems
- addBuildLogic
- addOrderInfo
- addTemplates
- beforeLoad
- addPanels
- loadDataCompleted
- load
- updateLoadScreenBackgroundColor
- updateShowPanelControlsButton
- addSettings
- addActions
- addItems
- addItem
- loadItemsCompleted
- autoStartSettingsCompleted
- build
- loadCompleted
- addTemplate
- getTemplate
- s
- setSettings
- loadItems
- itemsForEach
- getItemIntersectByModels
- getItemIntersect
- getItems
- getItemsByType
- getItemByIndex
- updatePriceInfo
- calcPrice
- getFormatPrice
- updatePrice
- updateOrderWindow
- updateOrderInfo
- startLoading
- setLoadingStatus
- endLoading
- startLock
- endLock
- enableItems
- disableItems
- setItemsEnabledPrev
- deselectActions
- getActionPath
- findActionPickerData
- panel
- panelControls
- showPanel
- hide
- togglePanel
- callEvent
- event
- removeEvent
- getSaveItems
- getSaveData
- loadDataItems
- loadDataItemSettings
- loadDataSettings
- getItemsInfo
Properties
- {boolean} loaded - Завершена ли загрузка
- [texture] - Путь/ключ текстуры во входных данных презентации
- {number} price - Цена из {@link Site3dConfiguratorSettingsItem#getCurrentPrice}.
- {Site3dConfiguratorPlaceOptions|null} [options] - Дополнительные параметры
- {'beforebegin' | 'afterbegin' | 'beforeend' | 'afterend' | 'beforeBegin' | 'afterBegin' | 'beforeEnd' | 'afterEnd'} where - Позиция вставки (поддерживаются и legacy-значения в camelCase)
- {string} [currency] - Валюта (например '₽')
- {(params: { comment: string, isOrder: boolean }) => (Promise<string> | string)} [getLink] - Генератор ссылки для заказа/шаринга
- {number} multiplier - Множитель для перевода в базовые единицы
- {boolean} [isEnabled] - Доступность элемента
- {'none' | 'all' | 'onlyTexture'} [repeatType] - Область применения repeat (тайл/материал)
- {number} [opacity] - Непрозрачность материала
- {string[]} [tabs] - Вкладки интерфейса выбора цвета
- {'none' | 'all' | 'onlyTexture'} [repeatType] - Область применения repeat
- {{repeat?: {x: number, y: number}}} [initValue] - Исходные значения value (например repeat текстуры)
- {number | string} [heightAboveMax] - Максимальная высота
- {number} connectDistance - Радиус стыковки по XZ (м), 0 — без стыковки
- {number} step - Шаг изменения
- {Site3dConfiguratorSizeAxeOptions} z - Ось Z
- {Site3dConfiguratorItemSettings} [settings] - Сохранённые настройки: при сохранении берётся из item.getSaveData().settings (getSaveValue), при загрузке передаётся в item.loadSettingsData() и затем удаляется
- {Site3dModel | null} model - Модель элемента.
- {Site3dConfiguratorItemInfo[]} [itemsInfo] - Элементы виджет-конфигуратора (Site3dWidgetConfigurator)
- [itemCandidates] - Ограничить поиск этими элементами конфигуратора
- {Site3dPoint3D} [pos] - Точка пересечения
- {Object.<string, string>} [parts] - Дополнительные подшаблоны в виде "имя -> HTML"
- {string[]} [ownTemplates] - Имена собственных шаблонов
- mesh - Имя модели/части для выборки mesh-объектов
- {number} [radius] - Радиус SSAO
- {number} [opacity] - Прозрачность отражений
- {number} [radius] - Радиус размытия
- {number} [b] - Множитель синего канала
- {boolean} [canPlaceOnObject] - Разрешить установку объектов на другие объекты
- {Site3dConfiguratorParamsData} [params] - Дополнительные параметры загрузки (напр. слияние в Site3dPlanner.params)
- {boolean} [show=false] - Показывать панель после загрузки конфигуратора
- {boolean} [show=false] - Показывать панель сразу после загрузки/инициализации
- {string[]} [tabs] - Вкладки панели выбора цвета
- {Function | null} [createComplete=null] - Обработчик завершения создания
- {Site3dConfiguratorItemSettings} settings - Сохранённые значения настроек
- {boolean} [isVisible=true] - Видимость группы
- {Site3dConfiguratorSettingsMaterialWrapType} [wrap] - Режим тайлинга
- {Site3dConfiguratorMoveItem[]} [moveItems] - Список добавленных/перемещённых элементов
- {boolean} [isLastModelSetting] - Последняя настройка в цепочке для модели
- [needRadioChange] - Принудительно обработать смену radio-группы
- {boolean} [calcSize] - Пересчитать габариты/размеры после setValue
- {Function | null} [change=null] - Обработчик редактирования настройки
- {string} [width] - Ширина контрола в CSS
- {Function | null} [getRangeValue] - Кастомное отображение значения диапазона
- {string} [radio] - Имя radio-группы для взаимоисключения
- {boolean} [isInsideMode] - Режим встраивания панели цвета
- {number} step - Шаг диапазона
- isEnabled - Включено ли отображение селектора wrap
- {string} unit - Единица измерения
- {string} color - Цвет текста
- {Site3dConfiguratorSettingsMaterialCreateTextOptions} text - Параметры текстовой генерации
- {boolean} [edited] - Материал был отредактирован пользователем
- {boolean} [setGeometry] - После выбора вызывать setGeometry
- {boolean} [isRepeatTexture] - Повторять текстуру при масштабе
- {Function | null} [getContentInside] - Фабрика DOM/HTML внутри панели настройки
- [additional=false] - Признак дополнительного режима рендера
- [notClone=false] - Вернуть ссылку на исходный объект без клонирования
- {boolean} [mirroredX] - Отражать fill по оси X
- {Site3dConfiguratorActionData | null} [data] - Дополнительные данные picker-действия
- {string} [backgroundImage]
- [parent]
- [updatePrice]
- [isLoadSettings]
- {boolean} [isAllItems]
- [isNotCancel]
- {Object.<string, Site3dConfiguratorActionsItemOptions> | undefined} [items]
- {Object.<string, Site3dConfiguratorActionsItemOptions>} [itemsActions]
- [isAutoStart]
- {string} [fileName] - Имя файла
- templatesPath
- actionsPath
- texturesPath
- modelsPath
- s3d
- options
- name
- path
- insertPlace
- connectModelName
- priceList
- priceList
- buildLogic
- buildLogic
- priceInfo
- priceInfo
- orderInfo
- orderInfo
- itemsInfo
- config
- data
- isMobile
- isPortrait
- settings
- settingsUpdated
- actions
- items
- model
- panels
- panelControlsButton
- history
- container
- isLoadingData
- isLoadDataCompleted
- isVisible
- isVisible
- isAnyItemOnChange
- panelControlsButtonClick
- panelControlsButtonClick
Methods
create
-
s3d -
options
Метод создает объект конфигуратора
Parameters:
-
s3dSite3dОбъект 3D сцены
-
optionsSite3dConfiguratorOptionsПараметры конфигуратора (смотрите описание конструктора конфигуратора)
Returns:
Объект конфигуратора как результат промиса
treeForEach
-
parent -
childAction -
parentAction -
level
Метод прохода по дереву коллекций
Parameters:
-
parentMapДерево коллекций
-
childActionFunctionФункция для обработки дочерних элементов
-
parentActionFunctionФункция для обработки родительских элементов
-
levelNumberСтартовый уровень вложенности
createTexture
-
[options]
Метод создания текстуры
Parameters:
-
[options]Site3dConfiguratorCreateTextureOptions optionalПараметры
Returns:
Файл текстуры в base64
getServerData
-
filePath -
[data=null] -
[format='json']
Метод вызывает серверный скрипт и возвращает результат через промис
Parameters:
-
filePathStringПуть до файла скрипта с расширением
-
[data=null]Site3dConfiguratorServerRequestData | null optionalОтправляемые на сервер данные
-
[format='json']Site3dConfiguratorServerDataFormat optionalФормат возвращаемого результата
Returns:
Результат
checkDevice
()
Метод производит проверку типа устройства
start
-
options
Метод запуска конфигуратора
Parameters:
-
optionsSite3dConfiguratorOptionsПараметры конфигуратора
init
()
async
Метод инициализации конфигуратора. Используйте перегреженную версию для переопределения базовых параметров:
- templatesPath - путь к HTML-шаблонам
- actionsPath - путь к иконкам действий
- texturesPath - путь к текстурам
getOrderItems
()
Метод возвращает родительский элемент дерева конфигуратора для отображения в заказе (для переопределения)
addBuildLogic
()
Метод формирования логики построения конфигуратора (для переопределения)
addOrderInfo
()
Метод формирования формы заказа конфигуратора (для переопределения)
addTemplates
()
Метод добавления описаний для загрузки HTML-шаблонов (для переопределения с целью добавления новых шаблонов в свойство templates)
beforeLoad
()
async
Метод запускается перед началом загрузки данных конфигуратора (для переопределения)
addPanels
()
async
Метод добавления панелей управления (для переопределения с целью добавления новых панелей в коллекцию panels)
loadDataCompleted
-
data
Метод запускается после завершения загрузки данных конфигуратора (для переопределения)
Parameters:
-
dataSite3dConfiguratorDataДанные конфигуратора
load
-
options
Метод загрузки параметров конфигуратора (используется для загрузки сохраненных ранее проектов)
Parameters:
-
optionsSite3dConfiguratorOptionsПараметры конфигуратора
updateLoadScreenBackgroundColor
-
value
Метод обновляет цвет фона окна загрузки
Parameters:
-
valueStringЦвет фона в HEX формате с альфа каналом
updateShowPanelControlsButton
-
value
Метод обновляет показ кнопки вызова панелей управления
Parameters:
-
valueBooleanИстина, если кнопка активна
addSettings
()
async
Метод добавления настроек конфигуратора (для переопределения)
addActions
()
async
Метод добавления действий для конфигуратора (для переопределения)
addItems
()
async
Метод добавления элементов конфигуратора (для переопределения)
addItem
-
model -
options
Метод добавления элемента конфигуратора
Parameters:
-
modelSite3dModel3D модель элемента
-
optionsSite3dConfiguratorItemOptionsПараметры элемента
Returns:
Новый элемент конфигуратора или null
loadItemsCompleted
()
async
Метод завершения загрузки частей конфигуратора (для переопределения)
autoStartSettingsCompleted
()
async
Метод завершения автозапуска настроек конфигуратора (для переопределения)
build
()
Метод сборки элементов конфигуратора (для переопределения)
loadCompleted
()
async
Метод завершения загрузки конфигуратора (для переопределения)
addTemplate
-
name -
options
Метод загружает и добавляет содержимое шаблона в список templates
Parameters:
-
nameStringИмя шаблона
-
optionsSite3dConfiguratorTemplateOptionsПараметры шаблона
getTemplate
-
name -
params -
subName
Метод получения HTML-шаблона
Parameters:
-
nameStringИмя шаблона
-
paramsStringМассив значений, подставляемых в шаблон
-
subNameStringПостфикс в названии шаблона
Returns:
Содержимое шаблона
s
-
name
Метод получения значения настройки
Parameters:
-
nameStringИмя настройки
Returns:
Значение настройки
setSettings
()
Метод для массового изменения значений настроек конфигуратора
loadItems
-
promise
Метод регистрации результата добавления части конфигуратора (элемент или часть дерева элементов)
Parameters:
-
promisePromiseПромис окончания загрузки части конфигуратора
Returns:
Промис
itemsForEach
-
childAction -
parentAction
Метод прохода по дереву элементов конфигуратора. В функциях обработки в качестве аргументов передается сам элемент дерева и объект из элементов:
- index - идентификатор элемента
- parent - родительский элемент
- level - уровень вложенности
Parameters:
-
childActionFunctionФункция для обработки элементов конфигуратора
-
parentActionFunctionФункция для обработки родительских элементов дерева конфигуратора
getItemIntersectByModels
-
models -
options
Метод возвращает объект из элемента конфигуратора и его позиции, по которой кликнули мышкой
Parameters:
-
modelsSite3dModel[]Модели, среди которых нужно выбирать нужный элемент
-
optionsSite3dConfiguratorIntersectModelOptionsДополнительные параметры:
- itemCandidates — если задан массив элементов, владелец intersect ищется только среди них (а не по всему дереву конфигуратора)
Returns:
Результат
getItemIntersect
-
items -
options
Метод возвращает объект из элемента конфигуратора и его позиции, по которой кликнули мышкой
Parameters:
-
itemsSite3dConfiguratorItem[]Элементы конфигуратора, среди которых нужно выбирать нужный элемент
-
optionsSite3dConfiguratorIntersectModelOptionsДополнительные параметры
Returns:
Результат
getItems
-
check -
[options]
Метод возвращает список элементов конфигуратора по условию через функцию
Parameters:
-
checkFunctionФункция обработки условий
-
[options]Site3dConfiguratorGetItemsOptions optionalДополнительные параметры
Returns:
Список элементов конфигуратора
getItemsByType
-
type -
[options]
Метод возвращает список элементов конфигуратора по типу
Parameters:
-
typeStringТип элемента конфигуратора
-
[options]Site3dConfiguratorGetItemsOptions optionalПараметры
Returns:
Список элементов конфигуратора
getItemByIndex
-
index -
[options]
Метод возвращает элемент конфигуратора по индексу
Parameters:
-
indexStringИндекс элемента конфигуратора
-
[options]Site3dConfiguratorGetItemsOptions optionalДополнительные параметры
Returns:
Элемент конфигуратора
updatePriceInfo
-
value -
[options]
Метод обновляет информацию о стоимости
Parameters:
-
valueSite3dConfiguratorSettingValueЗначение
-
[options]Site3dConfiguratorUpdatePriceInfoOptions optionalДополнительные параметры
calcPrice
()
Метод расчета строимости (для переопределения)
getFormatPrice
()
String
Метод возвращает форматированное значение стоимости
Returns:
Результат
updatePrice
()
Метод считает и показывает стоимость (для возможного переопределения)
updateOrderWindow
()
Метод создает окно заказа
updateOrderInfo
-
[value]
Метод обновляет информацию о заказе
Parameters:
-
[value]Partialoptional Значение
startLoading
-
[type='main'] -
[content='']
Метод показывает статус загрузки
Parameters:
-
[type='main']'init' | 'main' optionalТип экрана загрузки
-
[content='']String optionalТекст статуса загрузки
setLoadingStatus
-
content -
percent
Метод устанавливает статус загрузки
Parameters:
-
contentStringСтатус загрузки
-
percentNumberПроцент загрузки
endLoading
()
Метод скрывает статус загрузки
startLock
()
Метод запускает блокировку интерфейса
endLock
()
Метод скрывает блокировку интерфейса
enableItems
()
Метод активирует элементы конфигуратора
disableItems
()
Метод деактивирует элементы конфигуратора
setItemsEnabledPrev
()
Метод устанавливает предыдущую активность элементов конфигуратора
deselectActions
()
Метод снимает выделения у всех действий конфигуратора
getActionPath
-
name -
owner
Метод возвращает путь до действия с учетом вложенности групп
Parameters:
-
nameStringИмя действия
-
ownerSite3dConfigurator | Site3dConfiguratorItemКонфигуратор или его элемент
Returns:
Путь
findActionPickerData
-
check
Метод возвращает данные действия Site3dConfiguratorActionsPicker по условию
Parameters:
-
checkFunctionУсловие
Returns:
| undefined} Результат
panel
-
name
Метод возвращает панель
Parameters:
-
nameStringНазвание панели
Returns:
Панель
panelControls
-
name
Метод возвращает панель
Parameters:
-
nameStringНазвание панели
Returns:
Панель настроек
showPanel
-
name -
data -
[eventData]
Метод показывает панель
Parameters:
-
nameStringНазвание панели
-
dataSite3dConfiguratorPanelData | nullДанные для наполнения панели
-
[eventData]Site3dConfiguratorSettingValue optionalДанные для передачи в событие показа панели
hide
-
name
Метод скрывает панель
Parameters:
-
nameStringНазвание панели
togglePanel
-
name
Метод переключает видимость панели
Parameters:
-
nameStringНазвание панели
callEvent
-
name -
data
Метод вызывает событие конфигуратора
Parameters:
-
nameStringИмя событие
-
dataSite3dConfiguratorSettingValue | undefinedДанные для передачи в событие
event
-
name -
call
Метод подписывает на события конфигуратора
Parameters:
-
nameStringИмя события
-
callFunctionФункция обработки события
removeEvent
-
name -
call
Метод удаляет подписку на событие конфигуратора
Parameters:
-
nameStringИмя события
-
callFunctionФункция обработки события
getSaveItems
-
root
Метод возвращает элементы дерева конфигуратора для сохранения в json формате
Parameters:
-
rootSite3dConfiguratorItem | HTMLElementКорневой элемент (по умолчанию все элементы)
Returns:
Данные для сохранения
getSaveData
()
Метод возвращает объект для сохранения конфигуратора в json формате
loadDataItems
-
items -
loadItem -
[options]
Метод загружает элементы конфигуратора из объекта в json формате
Parameters:
-
itemsSite3dConfiguratorItemSaveDataДанные
-
loadItemFunctionОбработчик загрузки элементов конфигуратора
-
[options]Site3dConfiguratorLoadDataItemsOptions optionalДополнительные параметры
loadDataItemSettings
-
item -
dataItemSettings
Метод загружает настройки конфигуратора или его элемента из объекта в json формате
Parameters:
-
itemSite3dConfigurator | Site3dConfiguratorItemКонфигуратор или его элемент
-
dataItemSettingsSite3dConfiguratorItemSettingsДанные настроек в json формате
loadDataSettings
-
settings
Метод загружает настройки конфигуратора из объекта в json формате
Parameters:
-
settingsSite3dConfiguratorItemSettingsДанные
getItemsInfo
-
childAction -
parentAction
Метод возвращает информацию об элементах дерева конфигуратора:
Parameters:
-
childActionFunctionФункция для обработки элемента конфигуратора
-
parentActionFunctionФункция для обработки родительских элементов дерева конфигуратора
Properties
{boolean} loaded - Завершена ли загрузка
Site3dWidget
Аргумент колбэка window.site3dConfiguratorLoadStatus (хост страницы, вне конфигуратора).
[texture] - Путь/ключ текстуры во входных данных презентации
String
Дополнительные параметры презентации значения настройки для {@link Site3dConfiguratorSettingsMaterial#getPresentValue}, {@link Site3dConfiguratorSettingsMaterial#getPresentValueData}.
{number} price - Цена из {@link Site3dConfiguratorSettingsItem#getCurrentPrice}.
String | Site3dConfiguratorSettingValue
Результат {@link Site3dConfiguratorSettingsItem#getPresentValueData}.
{Site3dConfiguratorPlaceOptions|null} [options] - Дополнительные параметры
String | Null
Данные местоположения для сериализации/десериализации Site3dConfiguratorPlace.
{'beforebegin' | 'afterbegin' | 'beforeend' | 'afterend' | 'beforeBegin' | 'afterBegin' | 'beforeEnd' | 'afterEnd'} where - Позиция вставки (поддерживаются и legacy-значения в camelCase)
HTMLElement
Место вставки контента конфигуратора в DOM
{string} [currency] - Валюта (например '₽')
Boolean
Параметры отображения цены конфигуратора
{(params: { comment: string, isOrder: boolean }) => (Promise<string> | string)} [getLink] - Генератор ссылки для заказа/шаринга
Boolean
Параметры формы заказа конфигуратора
{number} multiplier - Множитель для перевода в базовые единицы
String
Данные единицы измерения настройки
{boolean} [isEnabled] - Доступность элемента
Number
Элемент списка значений настройки (radio, enum, color и т.д.)
{'none' | 'all' | 'onlyTexture'} [repeatType] - Область применения repeat (тайл/материал)
String | Blob | MediaSource
Базовый элемент списка значений для настроек, наследованных от Site3dConfiguratorSettingsEnum.
{number} [opacity] - Непрозрачность материала
Boolean
Элемент списка значений для Site3dConfiguratorSettingsMaterial.
{string[]} [tabs] - Вкладки интерфейса выбора цвета
Site3dConfiguratorSettingValue
Данные цвета для элемента значения настройки материала.
{'none' | 'all' | 'onlyTexture'} [repeatType] - Область применения repeat
Site3dFillData
Элемент списка значений для Site3dConfiguratorSettingsMaterial.
{{repeat?: {x: number, y: number}}} [initValue] - Исходные значения value (например repeat текстуры)
Clone: function(): getHexString: function(): string
Runtime-дополнения, которые конфигуратор записывает в material.
{number | string} [heightAboveMax] - Максимальная высота
String | Blob | MediaSource
Элемент списка значений для Site3dConfiguratorSettingsModel.
{number} connectDistance - Радиус стыковки по XZ (м), 0 — без стыковки
Boolean
Параметры перемещения моделей (элемент конфигуратора)
{number} step - Шаг изменения
Boolean
Параметры осей изменения размеров настройки
{Site3dConfiguratorSizeAxeOptions} z - Ось Z
Site3dConfiguratorSizeAxeOptions
Параметры осей размеров (x, y, z)
{Site3dConfiguratorItemSettings} [settings] - Сохранённые настройки: при сохранении берётся из item.getSaveData().settings (getSaveValue), при загрузке передаётся в item.loadSettingsData() и затем удаляется
Number
Элемент списка перемещаемых моделей настройки (добавленная для перемещения модель)
{Site3dModel | null} model - Модель элемента.
String
Элемент списка моделей для опции itemsInfo (виджет-конфигуратор и др.).
{Site3dConfiguratorItemInfo[]} [itemsInfo] - Элементы виджет-конфигуратора (Site3dWidgetConfigurator)
String
Параметры конфигуратора (options). Структура по умолчанию в конструкторе Site3dConfigurator.
[itemCandidates] - Ограничить поиск этими элементами конфигуратора
Site3dConfiguratorItem[]
Параметры поиска элемента конфигуратора по пересечению.
{Site3dPoint3D} [pos] - Точка пересечения
Site3dConfiguratorItem
Параметры поиска элемента конфигуратора по пересечению.
{Object.<string, string>} [parts] - Дополнительные подшаблоны в виде "имя -> HTML"
String
Параметры HTML-шаблона конфигуратора.
{string[]} [ownTemplates] - Имена собственных шаблонов
Site3dConfiguratorTemplates
Конфигурационные данные конфигуратора (из JSON конфига). Загружаются при инициализации.
mesh - Имя модели/части для выборки mesh-объектов
String
Модель для SSR-фильтра.
{number} [radius] - Радиус SSAO
Boolean
Параметры SSAO.
{number} [opacity] - Прозрачность отражений
Boolean
Параметры SSR.
{number} [radius] - Радиус размытия
Boolean
Параметры Bloom.
{number} [b] - Множитель синего канала
Number
Параметры цветокоррекции RGB.
{boolean} [canPlaceOnObject] - Разрешить установку объектов на другие объекты
Boolean
Дополнительные параметры загрузки конфигуратора. Используются, в том числе, при слиянии в Site3dPlanner.params.
{Site3dConfiguratorParamsData} [params] - Дополнительные параметры загрузки (напр. слияние в Site3dPlanner.params)
Object.Данные конфигуратора из JSON/options.
{boolean} [show=false] - Показывать панель после загрузки конфигуратора
String
Данные панелей при загрузке конфигуратора.
{boolean} [show=false] - Показывать панель сразу после загрузки/инициализации
Boolean
Общие данные, передаваемые в панель.
{string[]} [tabs] - Вкладки панели выбора цвета
Site3dConfiguratorSettingValue | null
Данные для панели выбора цвета.
{Function | null} [createComplete=null] - Обработчик завершения создания
String
Параметры элемента конфигуратора. Структура по умолчанию в конструкторе Site3dConfiguratorItem.
{Site3dConfiguratorItemSettings} settings - Сохранённые значения настроек
String
Сохраняемые данные элемента конфигуратора.
{boolean} [isVisible=true] - Видимость группы
String
Параметры группы настроек или группы действий. Структура в Site3dConfiguratorSettingsGroup / ActionsGroup.
{Site3dConfiguratorSettingsMaterialWrapType} [wrap] - Режим тайлинга
Site3dConfiguratorSettingsEnumValue
Тип значения настройки материала.
{Site3dConfiguratorMoveItem[]} [moveItems] - Список добавленных/перемещённых элементов
Site3dConfiguratorSettingsEnumValue
Тип значения настройки модели.
{boolean} [isLastModelSetting] - Последняя настройка в цепочке для модели
Boolean
Базовые runtime-параметры методов настройки (setValue/onChange/update/run).
[needRadioChange] - Принудительно обработать смену radio-группы
Boolean
Runtime-параметры для checkbox/toggle.
{boolean} [calcSize] - Пересчитать габариты/размеры после setValue
Number
Runtime-параметры для size.
{Function | null} [change=null] - Обработчик редактирования настройки
String
Базовые параметры настройки конфигуратора. Структура по умолчанию в Site3dConfiguratorSettingsItem.
{string} [width] - Ширина контрола в CSS
'number' | 'input' | 'inputNumber'
Параметры настроек с полем ввода (input/inputNumber/number).
{Function | null} [getRangeValue] - Кастомное отображение значения диапазона
'range'
Параметры настроек диапазона.
{string} [radio] - Имя radio-группы для взаимоисключения
'list' | 'tile' | 'radio' | 'checkBox' | 'toggle'
Параметры перечисляемых настроек (list/tile/radio/checkBox/toggle).
{boolean} [isInsideMode] - Режим встраивания панели цвета
'color'
Параметры цветовой настройки.
{number} step - Шаг диапазона
Boolean
Параметры настройки материала.
isEnabled - Включено ли отображение селектора wrap
Boolean
Параметры редактирования wrap у материала.
{string} unit - Единица измерения
Number
Параметры размера шрифта при генерации текстуры.
{string} color - Цвет текста
String
Параметры текста при генерации текстуры.
{Site3dConfiguratorSettingsMaterialCreateTextOptions} text - Параметры текстовой генерации
Boolean
Параметры генерации текстуры в настройке материала.
{boolean} [edited] - Материал был отредактирован пользователем
'material'
Параметры настройки материала.
{boolean} [setGeometry] - После выбора вызывать setGeometry
'model'
Параметры настройки модели.
{boolean} [isRepeatTexture] - Повторять текстуру при масштабе
'size'
Параметры размерной настройки.
{Function | null} [getContentInside] - Фабрика DOM/HTML внутри панели настройки
'custom'
Параметры кастомной настройки.
[additional=false] - Признак дополнительного режима рендера
Boolean
Дополнительные параметры рендера содержимого настройки.
[notClone=false] - Вернуть ссылку на исходный объект без клонирования
Boolean
Дополнительные параметры получения данных элемента списка настройки.
{boolean} [mirroredX] - Отражать fill по оси X
Number
Дополнительные параметры формирования fill-данных материала.
{Site3dConfiguratorActionData | null} [data] - Дополнительные данные picker-действия
String
Параметры действия конфигуратора. Структура по умолчанию в Site3dConfiguratorActionsItem.
{string} [backgroundImage]
String
Параметры создания текстуры.
[parent]
MapПараметры выборки элементов конфигуратора.
[updatePrice]
Boolean
Параметры обновления блока стоимости.
[isLoadSettings]
Boolean
Данные загрузки элементов из сохранения.
{boolean} [isAllItems]
Boolean
Параметры поиска частей модели.
[isNotCancel]
Boolean
Параметры скрытия панели.
{Object.<string, Site3dConfiguratorActionsItemOptions> | undefined} [items]
Object.Данные загрузки групп/элементов действий.
{Object.<string, Site3dConfiguratorActionsItemOptions>} [itemsActions]
Object.Типы данных для getDataItems по имени секции.
[isAutoStart]
Boolean
Параметры добавления элемента в историю.
{string} [fileName] - Имя файла
Blob
Данные файла для отправки на сервер через FormData.
templatesPath
String
Путь к HTML-шаблонам
actionsPath
String
Путь к иконкам действий
texturesPath
String
Путь к текстурам
modelsPath
String
Путь к моделям
options
Site3dConfiguratorOptions
Свойство возвращает параметры конфигуратора
name
String
Свойство возвращает название конфигуратора
path
String
Свойство возвращает путь до файлов конфигуратора
insertPlace
Site3dConfiguratorInsertPlace
Свойство возвращает место содержимого конфигуратора ({domElement: HTMLElement, where: string})
connectModelName
String
Свойство возвращает имя модели в сцене, к которой присоединяются элементы конфигуратора
priceList
MapСвойство возвращает прайс-лист конфигуратора
priceList
Unknown
Свойство устанавливает прайс-лист конфигуратора
buildLogic
Site3dConfiguratorBuildLogic
Свойство возвращает логику построения конфигуратора
buildLogic
Unknown
Свойство устанавливает логику построения конфигуратора
priceInfo
Site3dConfiguratorPriceInfo
Свойство возвращает информацию о стоимости
priceInfo
Unknown
Свойство устанавливает информацию о стоимости
orderInfo
Site3dConfiguratorOrderInfo
Свойство возвращает информацию для формы заказа конфигуратора
orderInfo
Unknown
Свойство устанавливает логику построения конфигуратора
itemsInfo
Site3dConfiguratorItemInfo | Undefined
Свойство возвращает информацию по элементам конфигуратора (опция itemsInfo)
config
Site3dConfiguratorConfig | null
Свойство возвращает конфигурационные данные конфигуратора
data
Site3dConfiguratorData | null
Свойство возвращает данные конфигуратора
isMobile
Boolean
Свойство возвращает истину, если конфигуратор запущен на мобильном устройстве
isPortrait
Boolean
Свойство возвращает истину, если устройство находится в вертикальной ориентации
settingsUpdated
Map
Свойство возвращает обновленные настройки во время обновления конфигуратора
items
MapСвойство возвращает элементы конфигуратора
panels
MapСвойство возвращает панели конфигуратора
panelControlsButton
HTMLElement
Свойство возвращает кнопку вызова панели управления конфигуратором
container
HTMLElement
Контейнер конфигуратора
isLoadingData
Boolean
Свойство возвращает истину, если конфигуратор загружается
isLoadDataCompleted
Boolean
Свойство возвращает истину, если конфигуратор загружен
isVisible
Boolean
Свойство возвращает видимость конфигуратора
isVisible
Unknown
Свойство устанавливает видимость конфигуратора
Sub-properties:
-
valueBooleanАктивность
isAnyItemOnChange
Boolean
Свойство возвращает истину, если какая-то настройка была запущена через интерфейс пользователя
panelControlsButtonClick
Site3dConfiguratorPanelControlsButtonClick | null
Свойство возвращает событие клика для кнопки показа и скрытия главных панелей управления
panelControlsButtonClick
Unknown
Свойство устанавливает события клика для кнопки показа и скрытия главных панелей управления
Sub-properties:
-
clickSite3dConfiguratorPanelControlsButtonClick | nullОбработчик клика (по умолчанию isOnChange = true)
