API Docs for:
Show:

Site3dPlanner Class

Extends Site3dConfigurator
Defined in: modules\planner\planner.js:237
Module: Site3dModal

Класс планировщика

Constructor

Site3dPlanner

(
  • s3d
  • options
)

Defined in modules\planner\planner.js:237

Parameters:

  • s3d Site3d

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

  • options Site3dConfiguratorOptions

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

Item Index

Methods

Properties

Methods

getSaveItems

(
  • root
)
Site3dConfiguratorItemSaveData | Site3dConfiguratorItemSaveData

Inherited from Site3dConfigurator but overwritten in modules\planner\planner.js:284

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

Parameters:

Returns:

Site3dConfiguratorItemSaveData | Site3dConfiguratorItemSaveData:

Данные для сохранения

getFloat

(
  • value
)
Number | number static

Defined in modules\planner\planner.js:297

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

Parameters:

  • value Number | string | number | string

    Входное значение (может быть числом или строкой)

Returns:

Number | number:

Округленное значение с дробной частью

getEventRot

(
  • item
  • delta
)
Number static

Defined in modules\planner\planner.js:309

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

Parameters:

  • item Site3dPlannerCabinItem

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

  • delta Number

    Изменение угла поворота

Returns:

Number:

Угол поворота

projectOpen

(
  • data
)
async

Defined in modules\planner\planner.js:961

Метод открывает проект

Parameters:

  • data Object

    Сохраненные в JSON формате данные

projectSave

() async

Defined in modules\planner\planner.js:977

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

getNextCabinIndex

() Number

Defined in modules\planner\planner.js:992

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

Returns:

Number:

Новый индекс

getNextRoomIndex

() Number

Defined in modules\planner\planner.js:1002

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

Returns:

Number:

Новый индекс

getNextObjectIndex

() Number

Defined in modules\planner\planner.js:1012

Метод возвращает следующий индекс для нового объекта

Returns:

Number:

Новый индекс

isCabinParent

(
  • cabin
)
Boolean

Defined in modules\planner\planner.js:1022

Метод возвращает истину, если на бытовке есть другие бытовки

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Boolean:

Результат

getCabinsSorted

(
  • sort
)
Object

Defined in modules\planner\planner.js:1043

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

Parameters:

  • sort Function

    Функуия сортировки

Returns:

Object:

Результат

getCabinsCoresItems

(
  • options
)
Site3dPlannerCabinCore[]

Defined in modules\planner\planner.js:1054

Метод возвращает каркасы бытовок

Parameters:

  • options Object

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

    • cabins - Объекты бытовок для обработки (включая дочерние бытовки)
    • exceptCabins - Объекты бытовок для исключения (включая дочерние бытовки)

Returns:

Site3dPlannerCabinCore[]:

Результат

getCabinsCoresModels

(
  • options
)
Site3dModel[]

Defined in modules\planner\planner.js:1079

Метод возвращает модели каркасов бытовок

Parameters:

  • options Object

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

    • cabins - Объекты бытовок для обработки (включая дочерние бытовки)
    • exceptCabins - Объекты бытовок для исключения (включая дочерние бытовки)

Returns:

Site3dModel[]:

Результат

getCabinsBoundModels

(
  • options
)
Site3dModel[]

Defined in modules\planner\planner.js:1092

Метод возвращает модели границ бытовок

Parameters:

  • options Object

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

    • cabins - Объекты бытовок для обработки (включая дочерние бытовки)
    • exceptCabins - Объекты бытовок для исключения (включая дочерние бытовки)

Returns:

Site3dModel[]:

Результат

getCabinsItemCoreModels

(
  • options
)
Site3dModel[]

Defined in modules\planner\planner.js:1105

Метод возвращает модели частей каркасов бытовок

Parameters:

  • options Object

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

    • cabins - Объекты бытовок для обработки (включая дочерние бытовки)
    • exceptCabins - Объекты бытовок для исключения (включая дочерние бытовки)

Returns:

Site3dModel[]:

Результат

getCabin

(
  • index
)
Site3dPlannerCabin | undefined

Defined in modules\planner\planner.js:1118

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

Parameters:

  • index String

    Индекс бытовки

Returns:

Site3dPlannerCabin | undefined:

Данные

getCabinByCoreItemIndex

(
  • index
)
Site3dPlannerCabin | undefined

Defined in modules\planner\planner.js:1135

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

Parameters:

  • index String

    Индекс каркаса бытовки

Returns:

Site3dPlannerCabin | undefined:

Данные

getCabinsUp

(
  • cabin
)
Object

Defined in modules\planner\planner.js:1152

Метод возвращает бытовки, расположенные на данной бытовке

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Object:

Данные бытовки или false

getCabinLastParent

(
  • cabin
)
Site3dPlannerCabin | false

Defined in modules\planner\planner.js:1163

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Site3dPlannerCabin | false:

Данные бытовки или false

getCabinLevel

(
  • cabin
)
Number

Defined in modules\planner\planner.js:1193

Метод возвращает этажность бытовки

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Number:

Результат

getCabinHeight

(
  • cabin
)
Number

Defined in modules\planner\planner.js:1214

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Number:

Результат

getRoomWallInners

(
  • cabin
)
Site3dPlannerCabinWallInner[]

Defined in modules\planner\planner.js:1235

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

Parameters:

  • cabin Object

    Объект бытовки

Returns:

Site3dPlannerCabinWallInner[]:

Массив элементов

getCabinWallItems

(
  • cabin
)
Site3dPlannerWallItem[]

Defined in modules\planner\planner.js:1246

Метод возвращает объекты стен бытовки

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Site3dPlannerWallItem[]:

Результат

getCabinWall

(
  • cabin
  • wallType
  • index
)
Site3dPlannerCabinBlock

Defined in modules\planner\planner.js:1261

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • wallType Site3dPlannerCabinBlockClass

    Класс стены

  • index Number

    Индекс стены

Returns:

Site3dPlannerCabinBlock:

Результат

getCabinDoorsOut

(
  • cabin
)
Site3dPlannerDoorOut[]

Defined in modules\planner\planner.js:1274

Метод возвращает внешние двери бытовки

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Site3dPlannerDoorOut[]:

Результат

getCabinWallInnerDoors

(
  • wallInnerItem
)
Site3dPlannerWallItem[]

Defined in modules\planner\planner.js:1285

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

Parameters:

Returns:

Site3dPlannerWallItem[]:

Массив объектов

getCabinCloneInfo

(
  • cabin
  • prevCloneInfo
)
Object

Defined in modules\planner\planner.js:1296

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • prevCloneInfo Object

    Предыдущая информация о клонировании бытовки

Returns:

Object:

Результат

getCabinCloneSaveItems

(
  • cabin
  • }
  • parent
)
Site3dPlannerCabinCloneSaveData

Defined in modules\planner\planner.js:1317

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • } RoomsIndexes: Map, objectsIndexes: Map

    cabinCloneInfo Информация о клонировании бытовки

  • parent String

    Индекс элемента, на который клонируется бытовка

Returns:

Site3dPlannerCabinCloneSaveData:

Результат

setCabinsUpMoveLocal

(
  • cabin
)

Defined in modules\planner\planner.js:1364

Метод устанавливает местоположение бытовок, находящихся над данной бытовкой

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

setCabinWallInnerMaterial

(
  • cabin
  • value
)
async

Defined in modules\planner\planner.js:1381

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • value String | object

    Значение материала

getCabinWallInnerDistanceToEnd

(
  • cabin
)
Number

Defined in modules\planner\planner.js:1397

Метод возвращает дистанцию от любой внутренней стены до ближайшего края бытовки

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Number:

Результат

getRoom

(
  • cabin
  • index
)
Site3dPlannerRoom

Defined in modules\planner\planner.js:1408

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • index Number

    Индекс комнаты

Returns:

Site3dPlannerRoom:

Данные

getRooms

(
  • cabin
)
Site3dPlannerRoom

Defined in modules\planner\planner.js:1420

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Site3dPlannerRoom:

Комнаты бытовки

getRoomsOut

(
  • cabin
)
Site3dPlannerRoom

Defined in modules\planner\planner.js:1431

Метод возвращает комнаты бытовки, оказавшиеся за её пределами

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Site3dPlannerRoom:

Комнаты вне бытовки

getRoomHeight

(
  • cabin
)
Number

Defined in modules\planner\planner.js:1443

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

Returns:

Number:

Высота комнаты

getRoomIndexPrefix

(
  • index
)
String

Defined in modules\planner\planner.js:1454

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

Parameters:

  • index Number

    Номер комнаты

Returns:

String:

Результат

getRoomFloorIndex

(
  • index
)
String

Defined in modules\planner\planner.js:1465

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

Parameters:

  • index Number

    Номер комнаты

Returns:

String:

Результат

getRoomFloor

(
  • room
)
Site3dPlannerRoomFloor

Defined in modules\planner\planner.js:1476

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

Parameters:

  • room Site3dPlannerRoom

    Объект комнаты

Returns:

Site3dPlannerRoomFloor:

Элемент пола комнаты

getRoomWallInnerIndexPrefix

(
  • index
)
String

Defined in modules\planner\planner.js:1487

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

Parameters:

  • index Number

    Номер комнаты

Returns:

String:

Результат

getRoomWallInnerIndex

(
  • index
  • number
)
String

Defined in modules\planner\planner.js:1498

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

Parameters:

  • index Number

    Номер комнаты

  • number Number

    Номер стены

Returns:

String:

Результат

getRoomWallInner

(
  • room
  • number
)
Site3dPlannerRoomWallInner

Defined in modules\planner\planner.js:1510

Метод возвращает внутреннюю стену комнаты

Parameters:

  • room Site3dPlannerRoom

    Объект комнаты

  • number Number

    Номер стены

Returns:

Site3dPlannerRoomWallInner:

Результат

getRoomWallInners

(
  • room
)
Site3dPlannerRoomWallInner[]

Defined in modules\planner\planner.js:1522

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

Parameters:

  • room Site3dPlannerRoom

    Объект комнаты

Returns:

Site3dPlannerRoomWallInner[]:

Массив элементов

getRoomObjects

(
  • room
  • cabin
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1533

Метод возвращает объекты комнаты

Parameters:

  • room Site3dPlannerRoom

    Объект комнаты

  • cabin Site3dPlannerCabin

    Объект бытовки (если объекты находятся временно вне комнаты)

Returns:

Site3dPlannerObject[]:

Результат

getRoomObjectsOut

(
  • room
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1548

Метод возвращает обеъекты комнаты, оказавшиеся за её пределами

Parameters:

  • room Site3dPlannerRoom

    Объект комнаты

Returns:

Site3dPlannerObject[]:

Результат

getRoomItems

(
  • room
)
Site3dPlannerCabinItem[]

Defined in modules\planner\planner.js:1559

Метод возвращает все элементы комнаты

Parameters:

  • room Site3dPlannerRoom

    Объект комнаты

Returns:

Site3dPlannerCabinItem[]:

Массив элементов

setRoomWallInnerMaterial

(
  • room
  • value
)
async

Defined in modules\planner\planner.js:1572

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

Parameters:

  • room Site3dPlannerRoom

    Объект комнаты

  • value String | object

    Значение материала

getObject

(
  • cabin
  • index
)
Object

Defined in modules\planner\planner.js:1588

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • index Number

    Индекс комнаты

Returns:

Object:

Данные

getObjects

(
  • cabin
  • options
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1600

Метод возвращает объекты бытовки

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • options Object

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

Returns:

Site3dPlannerObject[]:

Объекты бытовки

getObjectsOut

(
  • cabin
  • options
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1619

Метод возвращает объекты бытовки, оказавшиеся за её пределами

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • options Object

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

Returns:

Site3dPlannerObject[]:

Результат

getObjectsByPlaceItem

(
  • cabin
  • placeItem
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1631

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • placeItem Site3dPlannerCabinItem

    Индекс комнаты

Returns:

Site3dPlannerObject[]:

Результат

getObjectsWithLevels

(
  • objects
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1655

Метод возвращает объекты бытовки с учетом расположенных на них объектов

Parameters:

Returns:

Site3dPlannerObject[]:

Результат

removeObject

(
  • item
)
async

Defined in modules\planner\planner.js:1666

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

Parameters:

createEntityModel

(
  • type
  • name
  • options
)
Site3dModel async

Defined in modules\planner\planner.js:1690

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

Parameters:

  • type String

    Тип модели

  • name String

    Имя модели

  • options Object

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

Returns:

Site3dModel:

Модель

createEntityItem

(
  • entity
  • data
  • prefix
  • connectModelName
  • options
)
Site3dPlannerItem async

Defined in modules\planner\planner.js:1709

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

Parameters:

  • entity Site3dPlannerCabinEntityClass

    Конструктор элемента бытовки (класс)

  • data Object

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

  • prefix String

    Префикс к имени модели, создаваемого элемента

  • connectModelName String

    Имя модели для присоединения

  • options Object

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

Returns:

Site3dPlannerItem:

Результат

createEntityItems

(
  • entity
  • data
  • prefix
  • connectModelName
  • options
)
async

Defined in modules\planner\planner.js:1787

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

Parameters:

  • entity Site3dPlannerCabinEntityClass

    Класс элементов

  • data Object

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

  • prefix String

    Префикс к имени моделям, создаваемых элементов

  • connectModelName String

    Имя модели для присоединения

  • options Object

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

updatePlinthModels

(
  • item
)
async

Defined in modules\planner\planner.js:1834

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

Parameters:

  • item Site3dPlannerWallInner

    Внутренняя стена

addCabin

(
  • data
)
async

Defined in modules\planner\planner.js:1862

Метод добавляет бытовку

Parameters:

  • data Site3dPlannerCabinData

    Данные бытовки

addRoom

(
  • cabin
  • data
)
async

Defined in modules\planner\planner.js:1988

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • data Site3dPlannerRoomData

    Данные комнаты

addObject

(
  • cabin
  • data
)
async

Defined in modules\planner\planner.js:2075

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

  • data Site3dPlannerObjectData

    Данные объекта внутри бытовки

setCabinWallOutView

(
  • wallOutItem
  • value
  • options
)
async

Defined in modules\planner\planner.js:2127

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

Parameters:

  • wallOutItem Site3dPlannerCabinWallOut

    Элемент внешней стены бытовки

  • value String

    Значение видимости стены

  • options Object

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

setCabinWallInnerView

(
  • wallInnerItem
  • value
)
async

Defined in modules\planner\planner.js:2155

Метод изменяет видимость внутренней стены бытовки

Parameters:

  • wallInnerItem Site3dPlannerCabinWallInner

    Элемент внутренней стены бытовки

  • value String

    Значение видимости стены

setCabinCeilingVisibility

(
  • cabin
)

Defined in modules\planner\planner.js:2198

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

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

updateCabinsUpDoorStairs

(
  • cabin
)

Defined in modules\planner\planner.js:2238

Метод обновляет лестницы дверей у вышестоящих бытовок

Parameters:

  • cabin Site3dPlannerCabin

    Объект бытовки

getChangeValue

(
  • data
  • change
)
Any

Defined in modules\planner\planner.js:2256

Метод возвращает значение объекта изменений

Parameters:

  • data Object

    Объект изменений

  • change Object

    Изменение

Returns:

Any:

Значение

setChangeValue

(
  • data
  • change
)

Defined in modules\planner\planner.js:2273

Метод устанавливает значение объекта изменений

Parameters:

  • data Object

    Объект изменений

  • change Object

    Изменение

removeObjectsByData

(
  • data
  • cabin
)

Defined in modules\planner\planner.js:2291

Метод удаляет объекты из данных в виде сохраненных объектов

Parameters:

  • data Object

    Объекты данных

  • cabin Site3dPlannerCabin

    Объект бытовки

buildCabin

(
  • data
  • changes
  • options
)
async

Defined in modules\planner\planner.js:2309

Метод строит бытовку

Parameters:

  • data Object

    Данные бытовки

  • changes Array

    Изменения в бытовке

  • options Object

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

buildRoom

(
  • data
  • changes
  • options
)
async

Defined in modules\planner\planner.js:2863

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

Parameters:

  • data Object

    Данные комнаты

  • changes Array

    Изменения в комнате

  • options Object

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

removeCabin

(
  • data
  • options
)
async

Defined in modules\planner\planner.js:3301

Метод удаляет бытовку

Parameters:

  • data Object

    Данные бытовки

  • options Object

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

removeRoom

(
  • data
  • options
)
async

Defined in modules\planner\planner.js:3346

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

Parameters:

  • data Object

    Данные комнаты

  • options Object

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

intersectCabin

(
  • checkItem
  • checkItemData
  • options
)
Site3dPlannerPlaceIntersect

Defined in modules\planner\planner.js:3379

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

Parameters:

  • checkItem Site3dPlannerCabinItem

    Элемент бытовки (объект или класс)

  • checkItemData Object

    Данные элемента бытовки

  • options Object

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

Returns:

Site3dPlannerPlaceIntersect:

Результат

getGroundIntersect

(
  • options
)
Site3dPlannerPlace

Defined in modules\planner\planner.js:3405

Метод возвращает местоположение для объектов конфигуратора по пересечению указателя с землей

Parameters:

  • options Object

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

    • cabins - Объекты бытовок для обработки (включая дочерние бытовки)
    • exceptCabins - Объекты бытовок для исключения (включая дочерние бытовки)
    • posShift - Смещение итоговой позиции

Returns:

Site3dPlannerPlace:

Местоположение

startAddToHistory

(
  • index
  • caption
  • cancel
  • data
)

Defined in modules\planner\planner.js:3419

Метод начинает добавление действия в историю

Parameters:

  • index String

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

  • caption String

    Название действия

  • cancel Function

    Функция отмены действия

  • data Object

    Данные для обработки функциями отмены и совершения действия

stopAddToHistory

()

Defined in modules\planner\planner.js:3432

Метод останавливает добавление действия в историю

setDataToHistory

(
  • data
)

Defined in modules\planner\planner.js:3441

Метод устанавливает дополнительные данные для обработки функциями отмены и совершения действия

Parameters:

  • data Object

    Дополнительные данные

endAddToHistory

(
  • make
  • additionalData
  • options
)
async

Defined in modules\planner\planner.js:3451

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

Parameters:

  • make Function

    Функция совершения действия

  • additionalData Object

    Дополнительные данные для обработки функциями отмены и совершения действия

  • options Object

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

    • isAutoStart - истина, если make исполняется (по умолчанию истина)

addToHistory

(
  • index
  • caption
  • cancel
  • make
  • data
  • options
)
async

Defined in modules\planner\planner.js:3466

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

Parameters:

  • index String

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

  • caption String

    Название действия

  • cancel Function

    Функция отмены действия

  • make Function

    Функция совершения действия

  • data Object

    Данные для обработки функциями отмены и совершения действия

  • options Object

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

    • isAutoStart - истина, если make исполняется (по умолчанию истина)

isHistoryChanges

(
  • changes
)
Boolean async

Defined in modules\planner\planner.js:3484

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

Parameters:

  • changes Array

    Изменения в комнате

Returns:

Boolean:

Результат

setHistoryActions

()

Defined in modules\planner\planner.js:3505

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

updateRoof

() async

Defined in modules\planner\planner.js:3515

Метод обновляет крышу

updateView

()

Defined in modules\planner\planner.js:3542

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

createTexture

(
  • [options]
)
Promise async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1369

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

Parameters:

  • [options] Site3dConfiguratorCreateTextureOptions optional

    Параметры

Returns:

Promise:

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

getServerData

(
  • filePath
  • [data=null]
  • [format='json']
)
Promise async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1786

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

Parameters:

  • filePath String

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

  • [data=null] Site3dConfiguratorServerRequestData | null optional

    Отправляемые на сервер данные

  • [format='json'] Site3dConfiguratorServerDataFormat optional

    Формат возвращаемого результата

Returns:

Promise:

Результат

checkDevice

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1833

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

start

(
  • options
)
async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1842

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

Parameters:

  • options Site3dConfiguratorOptions

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

init

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2031

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

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

getOrderItems

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2043

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

addBuildLogic

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2052

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

addOrderInfo

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2060

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

addTemplates

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2068

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

beforeLoad

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2076

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

addPanels

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2085

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

loadDataCompleted

(
  • data
)
async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2094

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

Parameters:

  • data Site3dConfiguratorData

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

load

(
  • options
)
async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2104

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

Parameters:

  • options Site3dConfiguratorOptions

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

updateLoadScreenBackgroundColor

(
  • value
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2264

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

Parameters:

  • value String

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

updateShowPanelControlsButton

(
  • value
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2279

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

Parameters:

  • value Boolean

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

addSettings

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2301

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

addActions

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2389

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

addItems

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2398

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

addItem

(
  • model
  • options
)
Promise async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2407

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

Parameters:

  • model Site3dModel

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

  • options Site3dConfiguratorItemOptions

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

Returns:

Promise:

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

loadItemsCompleted

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2423

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

autoStartSettingsCompleted

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2450

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

build

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2459

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

loadCompleted

() async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2467

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

addTemplate

(
  • name
  • options
)
async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2476

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

Parameters:

  • name String

    Имя шаблона

  • options Site3dConfiguratorTemplateOptions

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

getTemplate

(
  • name
  • params
  • subName
)
Promise async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2511

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

Parameters:

  • name String

    Имя шаблона

  • params String

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

  • subName String

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

Returns:

Promise:

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

s

(
  • name
)
String | number | object

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2560

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

Parameters:

  • name String

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

Returns:

String | number | object:

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

setSettings

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2576

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

loadItems

(
  • promise
)
Promise

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2588

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

Parameters:

  • promise Promise

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

Returns:

Promise:

Промис

itemsForEach

(
  • childAction
  • parentAction
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2600

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

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

Parameters:

  • childAction Function

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

  • parentAction Function

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

getItemIntersectByModels

(
  • models
  • options
)
Site3dConfiguratorIntersectModelResult | null

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2614

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

Parameters:

  • models Site3dModel[]

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

  • options Site3dConfiguratorIntersectModelOptions

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

    • itemCandidates — если задан массив элементов, владелец intersect ищется только среди них (а не по всему дереву конфигуратора)

Returns:

Site3dConfiguratorIntersectModelResult | null:

Результат

getItemIntersect

(
  • items
  • options
)
Site3dConfiguratorIntersectModelResult | null

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2666

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

Parameters:

  • items Site3dConfiguratorItem[]

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

  • options Site3dConfiguratorIntersectModelOptions

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

Returns:

Site3dConfiguratorIntersectModelResult | null:

Результат

getItems

(
  • check
  • [options]
)
Site3dConfiguratorItem[]

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2688

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

Parameters:

  • check Function

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

  • [options] Site3dConfiguratorGetItemsOptions optional

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

Returns:

Site3dConfiguratorItem[]:

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

getItemsByType

(
  • type
  • [options]
)
Site3dConfiguratorItem[]

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2718

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

Parameters:

  • type String

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

  • [options] Site3dConfiguratorGetItemsOptions optional

    Параметры

Returns:

Site3dConfiguratorItem[]:

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

getItemByIndex

(
  • index
  • [options]
)
Site3dConfiguratorItem

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2730

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

Parameters:

  • index String

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

  • [options] Site3dConfiguratorGetItemsOptions optional

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

Returns:

Site3dConfiguratorItem:

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

updatePriceInfo

(
  • value
  • [options]
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2742

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

Parameters:

  • value Site3dConfiguratorSettingValue

    Значение

  • [options] Site3dConfiguratorUpdatePriceInfoOptions optional

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

calcPrice

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2780

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

getFormatPrice

() String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2827

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

Returns:

String:

Результат

updatePrice

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2837

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

updateOrderWindow

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:2859

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

updateOrderInfo

(
  • [value]
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3166

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

Parameters:

  • [value] Partial optional

    Значение

startLoading

(
  • [type='main']
  • [content='']
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3202

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

Parameters:

  • [type='main'] 'init' | 'main' optional

    Тип экрана загрузки

  • [content=''] String optional

    Текст статуса загрузки

setLoadingStatus

(
  • content
  • percent
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3228

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

Parameters:

  • content String

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

  • percent Number

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

endLoading

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3248

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

startLock

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3262

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

endLock

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3271

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

enableItems

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3280

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

disableItems

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3289

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

setItemsEnabledPrev

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3298

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

deselectActions

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3307

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

getActionPath

(
  • name
  • owner
)
String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3348

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

Parameters:

Returns:

String:

Путь

findActionPickerData

(
  • check
)
Index: string, factoryType: string, typeData: Site3dConfiguratorSettingValueItem

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3379

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

Parameters:

  • check Function

    Условие

Returns:

Index: string, factoryType: string, typeData: Site3dConfiguratorSettingValueItem:

| undefined} Результат

panel

(
  • name
)
Site3dConfiguratorPanel | undefined

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3410

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

Parameters:

  • name String

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

Returns:

Site3dConfiguratorPanel | undefined:

Панель

panelControls

(
  • name
)
Site3dConfiguratorPanelControls | undefined

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3421

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

Parameters:

  • name String

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

Returns:

Site3dConfiguratorPanelControls | undefined:

Панель настроек

showPanel

(
  • name
  • data
  • [eventData]
)
async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3433

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

Parameters:

  • name String

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

  • data Site3dConfiguratorPanelData | null

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

  • [eventData] Site3dConfiguratorSettingValue optional

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

hide

(
  • name
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3447

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

Parameters:

  • name String

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

togglePanel

(
  • name
)
async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3457

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

Parameters:

  • name String

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

callEvent

(
  • name
  • data
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3469

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

Parameters:

  • name String

    Имя событие

  • data Site3dConfiguratorSettingValue | undefined

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

event

(
  • name
  • call
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3482

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

Parameters:

  • name String

    Имя события

  • call Function

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

removeEvent

(
  • name
  • call
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3493

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

Parameters:

  • name String

    Имя события

  • call Function

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

getSaveData

()

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3551

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

loadDataItems

(
  • items
  • loadItem
  • [options]
)
async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3563

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

Parameters:

  • items Site3dConfiguratorItemSaveData

    Данные

  • loadItem Function

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

  • [options] Site3dConfiguratorLoadDataItemsOptions optional

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

loadDataItemSettings

(
  • item
  • dataItemSettings
)
async

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3601

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

Parameters:

  • item Site3dConfigurator | Site3dConfiguratorItem

    Конфигуратор или его элемент

  • dataItemSettings Site3dConfiguratorItemSettings

    Данные настроек в json формате

loadDataSettings

(
  • settings
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3626

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

Parameters:

  • settings Site3dConfiguratorItemSettings

    Данные

getItemsInfo

(
  • childAction
  • parentAction
)

Inherited from Site3dConfigurator: modules\configurator\configurator.js:3639

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

Parameters:

  • childAction Function

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

  • parentAction Function

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

Properties

cabins

Unknown

Defined in modules\planner\planner.js:334

Свойство возвращает список с полной информацией о бытовках

{boolean} loaded - Завершена ли загрузка

Site3dWidget

Inherited from Site3dConfigurator: modules\configurator\configurator.js:10

Аргумент колбэка window.site3dConfiguratorLoadStatus (хост страницы, вне конфигуратора).

[texture] - Путь/ключ текстуры во входных данных презентации

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:57

Дополнительные параметры презентации значения настройки для {@link Site3dConfiguratorSettingsMaterial#getPresentValue}, {@link Site3dConfiguratorSettingsMaterial#getPresentValueData}.

{number} price - Цена из {@link Site3dConfiguratorSettingsItem#getCurrentPrice}.

String | Site3dConfiguratorSettingValue

Inherited from Site3dConfigurator: modules\configurator\configurator.js:73

Результат {@link Site3dConfiguratorSettingsItem#getPresentValueData}.

{Site3dConfiguratorPlaceOptions|null} [options] - Дополнительные параметры

String | Null

Inherited from Site3dConfigurator: modules\configurator\configurator.js:95

Данные местоположения для сериализации/десериализации Site3dConfiguratorPlace.

{'beforebegin' | 'afterbegin' | 'beforeend' | 'afterend' | 'beforeBegin' | 'afterBegin' | 'beforeEnd' | 'afterEnd'} where - Позиция вставки (поддерживаются и legacy-значения в camelCase)

HTMLElement

Inherited from Site3dConfigurator: modules\configurator\configurator.js:103

Место вставки контента конфигуратора в DOM

{string} [currency] - Валюта (например '₽')

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:110

Параметры отображения цены конфигуратора

{(params: { comment: string, isOrder: boolean }) => (Promise<string> | string)} [getLink] - Генератор ссылки для заказа/шаринга

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:119

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

{number} multiplier - Множитель для перевода в базовые единицы

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:134

Данные единицы измерения настройки

{boolean} [isEnabled] - Доступность элемента

Number

Inherited from Site3dConfigurator: modules\configurator\configurator.js:141

Элемент списка значений настройки (radio, enum, color и т.д.)

{'none' | 'all' | 'onlyTexture'} [repeatType] - Область применения repeat (тайл/материал)

String | Blob | MediaSource

Inherited from Site3dConfigurator: modules\configurator\configurator.js:151

Базовый элемент списка значений для настроек, наследованных от Site3dConfiguratorSettingsEnum.

{number} [opacity] - Непрозрачность материала

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:168

Элемент списка значений для Site3dConfiguratorSettingsMaterial.

{string[]} [tabs] - Вкладки интерфейса выбора цвета

Site3dConfiguratorSettingValue

Inherited from Site3dConfigurator: modules\configurator\configurator.js:185

Данные цвета для элемента значения настройки материала.

{'none' | 'all' | 'onlyTexture'} [repeatType] - Область применения repeat

Site3dFillData

Inherited from Site3dConfigurator: modules\configurator\configurator.js:194

Элемент списка значений для Site3dConfiguratorSettingsMaterial.

{{repeat?: {x: number, y: number}}} [initValue] - Исходные значения value (например repeat текстуры)

Clone: function(): getHexString: function(): string

Inherited from Site3dConfigurator: modules\configurator\configurator.js:212

Runtime-дополнения, которые конфигуратор записывает в material.

{number | string} [heightAboveMax] - Максимальная высота

String | Blob | MediaSource

Inherited from Site3dConfigurator: modules\configurator\configurator.js:231

Элемент списка значений для Site3dConfiguratorSettingsModel.

{number} connectDistance - Радиус стыковки по XZ (м), 0 — без стыковки

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:249

Параметры перемещения моделей (элемент конфигуратора)

{number} step - Шаг изменения

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:256

Параметры осей изменения размеров настройки

{Site3dConfiguratorSizeAxeOptions} z - Ось Z

Site3dConfiguratorSizeAxeOptions

Inherited from Site3dConfigurator: modules\configurator\configurator.js:265

Параметры осей размеров (x, y, z)

{Site3dConfiguratorItemSettings} [settings] - Сохранённые настройки: при сохранении берётся из item.getSaveData().settings (getSaveValue), при загрузке передаётся в item.loadSettingsData() и затем удаляется

Number

Inherited from Site3dConfigurator: modules\configurator\configurator.js:273

Элемент списка перемещаемых моделей настройки (добавленная для перемещения модель)

{Site3dModel | null} model - Модель элемента.

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:283

Элемент списка моделей для опции itemsInfo (виджет-конфигуратор и др.).

{Site3dConfiguratorItemInfo[]} [itemsInfo] - Элементы виджет-конфигуратора (Site3dWidgetConfigurator)

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:292

Параметры конфигуратора (options). Структура по умолчанию в конструкторе Site3dConfigurator.

[itemCandidates] - Ограничить поиск этими элементами конфигуратора

Site3dConfiguratorItem[]

Inherited from Site3dConfigurator: modules\configurator\configurator.js:321

Параметры поиска элемента конфигуратора по пересечению.

{Site3dPoint3D} [pos] - Точка пересечения

Site3dConfiguratorItem

Inherited from Site3dConfigurator: modules\configurator\configurator.js:327

Параметры поиска элемента конфигуратора по пересечению.

{Object.<string, string>} [parts] - Дополнительные подшаблоны в виде "имя -> HTML"

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:334

Параметры HTML-шаблона конфигуратора.

{string[]} [ownTemplates] - Имена собственных шаблонов

Site3dConfiguratorTemplates

Inherited from Site3dConfigurator: modules\configurator\configurator.js:349

Конфигурационные данные конфигуратора (из JSON конфига). Загружаются при инициализации.

mesh - Имя модели/части для выборки mesh-объектов

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:356

Модель для SSR-фильтра.

{number} [radius] - Радиус SSAO

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:362

Параметры SSAO.

{number} [opacity] - Прозрачность отражений

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:369

Параметры SSR.

{number} [radius] - Радиус размытия

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:379

Параметры Bloom.

{number} [b] - Множитель синего канала

Number

Inherited from Site3dConfigurator: modules\configurator\configurator.js:388

Параметры цветокоррекции RGB.

{boolean} [canPlaceOnObject] - Разрешить установку объектов на другие объекты

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:396

Дополнительные параметры загрузки конфигуратора. Используются, в том числе, при слиянии в Site3dPlanner.params.

{Site3dConfiguratorParamsData} [params] - Дополнительные параметры загрузки (напр. слияние в Site3dPlanner.params)

Object.

Inherited from Site3dConfigurator: modules\configurator\configurator.js:404

Данные конфигуратора из JSON/options.

{boolean} [show=false] - Показывать панель после загрузки конфигуратора

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:419

Данные панелей при загрузке конфигуратора.

{boolean} [show=false] - Показывать панель сразу после загрузки/инициализации

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:427

Общие данные, передаваемые в панель.

{string[]} [tabs] - Вкладки панели выбора цвета

Site3dConfiguratorSettingValue | null

Inherited from Site3dConfigurator: modules\configurator\configurator.js:439

Данные для панели выбора цвета.

{Function | null} [createComplete=null] - Обработчик завершения создания

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:455

Параметры элемента конфигуратора. Структура по умолчанию в конструкторе Site3dConfiguratorItem.

{Site3dConfiguratorItemSettings} settings - Сохранённые значения настроек

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:477

Сохраняемые данные элемента конфигуратора.

{boolean} [isVisible=true] - Видимость группы

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:488

Параметры группы настроек или группы действий. Структура в Site3dConfiguratorSettingsGroup / ActionsGroup.

{Site3dConfiguratorSettingsMaterialWrapType} [wrap] - Режим тайлинга

Site3dConfiguratorSettingsEnumValue

Inherited from Site3dConfigurator: modules\configurator\configurator.js:523

Тип значения настройки материала.

{Site3dConfiguratorMoveItem[]} [moveItems] - Список добавленных/перемещённых элементов

Site3dConfiguratorSettingsEnumValue

Inherited from Site3dConfigurator: modules\configurator\configurator.js:537

Тип значения настройки модели.

{boolean} [isLastModelSetting] - Последняя настройка в цепочке для модели

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:554

Базовые runtime-параметры методов настройки (setValue/onChange/update/run).

[needRadioChange] - Принудительно обработать смену radio-группы

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:563

Runtime-параметры для checkbox/toggle.

{boolean} [calcSize] - Пересчитать габариты/размеры после setValue

Number

Inherited from Site3dConfigurator: modules\configurator\configurator.js:569

Runtime-параметры для size.

{Function | null} [change=null] - Обработчик редактирования настройки

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:645

Базовые параметры настройки конфигуратора. Структура по умолчанию в Site3dConfiguratorSettingsItem.

{string} [width] - Ширина контрола в CSS

'number' | 'input' | 'inputNumber'

Inherited from Site3dConfigurator: modules\configurator\configurator.js:679

Параметры настроек с полем ввода (input/inputNumber/number).

{Function | null} [getRangeValue] - Кастомное отображение значения диапазона

'range'

Inherited from Site3dConfigurator: modules\configurator\configurator.js:688

Параметры настроек диапазона.

{string} [radio] - Имя radio-группы для взаимоисключения

'list' | 'tile' | 'radio' | 'checkBox' | 'toggle'

Inherited from Site3dConfigurator: modules\configurator\configurator.js:699

Параметры перечисляемых настроек (list/tile/radio/checkBox/toggle).

{boolean} [isInsideMode] - Режим встраивания панели цвета

'color'

Inherited from Site3dConfigurator: modules\configurator\configurator.js:712

Параметры цветовой настройки.

{number} step - Шаг диапазона

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:727

Параметры настройки материала.

isEnabled - Включено ли отображение селектора wrap

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:736

Параметры редактирования wrap у материала.

{string} unit - Единица измерения

Number

Inherited from Site3dConfigurator: modules\configurator\configurator.js:742

Параметры размера шрифта при генерации текстуры.

{string} color - Цвет текста

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:752

Параметры текста при генерации текстуры.

{Site3dConfiguratorSettingsMaterialCreateTextOptions} text - Параметры текстовой генерации

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:761

Параметры генерации текстуры в настройке материала.

{boolean} [edited] - Материал был отредактирован пользователем

'material'

Inherited from Site3dConfigurator: modules\configurator\configurator.js:768

Параметры настройки материала.

{boolean} [setGeometry] - После выбора вызывать setGeometry

'model'

Inherited from Site3dConfigurator: modules\configurator\configurator.js:799

Параметры настройки модели.

{boolean} [isRepeatTexture] - Повторять текстуру при масштабе

'size'

Inherited from Site3dConfigurator: modules\configurator\configurator.js:808

Параметры размерной настройки.

{Function | null} [getContentInside] - Фабрика DOM/HTML внутри панели настройки

'custom'

Inherited from Site3dConfigurator: modules\configurator\configurator.js:820

Параметры кастомной настройки.

[additional=false] - Признак дополнительного режима рендера

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:840

Дополнительные параметры рендера содержимого настройки.

[notClone=false] - Вернуть ссылку на исходный объект без клонирования

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:846

Дополнительные параметры получения данных элемента списка настройки.

{boolean} [mirroredX] - Отражать fill по оси X

Number

Inherited from Site3dConfigurator: modules\configurator\configurator.js:852

Дополнительные параметры формирования fill-данных материала.

{Site3dConfiguratorActionData | null} [data] - Дополнительные данные picker-действия

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:859

Параметры действия конфигуратора. Структура по умолчанию в Site3dConfiguratorActionsItem.

{string} [backgroundImage]

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:896

Параметры создания текстуры.

[parent]

Map

Inherited from Site3dConfigurator: modules\configurator\configurator.js:911

Параметры выборки элементов конфигуратора.

[updatePrice]

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:917

Параметры обновления блока стоимости.

[isLoadSettings]

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:923

Данные загрузки элементов из сохранения.

{boolean} [isAllItems]

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:929

Параметры поиска частей модели.

[isNotCancel]

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:936

Параметры скрытия панели.

{Object.<string, Site3dConfiguratorActionsItemOptions> | undefined} [items]

Object. | undefined

Inherited from Site3dConfigurator: modules\configurator\configurator.js:942

Данные загрузки групп/элементов действий.

{Object.<string, Site3dConfiguratorActionsItemOptions>} [itemsActions]

Object.

Inherited from Site3dConfigurator: modules\configurator\configurator.js:949

Типы данных для getDataItems по имени секции.

[isAutoStart]

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:958

Параметры добавления элемента в историю.

{string} [fileName] - Имя файла

Blob

Inherited from Site3dConfigurator: modules\configurator\configurator.js:964

Данные файла для отправки на сервер через FormData.

templatesPath

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1239

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

actionsPath

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1246

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

texturesPath

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1253

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

modelsPath

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1260

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

s3d

Site3d

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1411

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

options

Site3dConfiguratorOptions

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1421

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

name

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1431

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

path

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1441

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

insertPlace

Site3dConfiguratorInsertPlace

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1451

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

connectModelName

String

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1461

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

priceList

Map

Inherited from Site3dConfigurator but overwritten in modules\configurator\configurator.js:1471

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

buildLogic

Site3dConfiguratorBuildLogic

Inherited from Site3dConfigurator but overwritten in modules\configurator\configurator.js:1490

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

priceInfo

Site3dConfiguratorPriceInfo

Inherited from Site3dConfigurator but overwritten in modules\configurator\configurator.js:1509

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

orderInfo

Site3dConfiguratorOrderInfo

Inherited from Site3dConfigurator but overwritten in modules\configurator\configurator.js:1528

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

itemsInfo

Site3dConfiguratorItemInfo | Undefined

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1547

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

config

Site3dConfiguratorConfig | null

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1557

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

data

Site3dConfiguratorData | null

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1567

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

isMobile

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1577

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

isPortrait

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1587

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

settings

Site3dConfiguratorSettings

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1602

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

settingsUpdated

Map

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1612

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

actions

Site3dConfiguratorActions

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1622

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

items

Map

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1632

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

model

Site3dModel

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1642

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

panels

Map

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1652

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

panelControlsButton

HTMLElement

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1662

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

history

Site3dConfiguratorHistory

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1672

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

container

HTMLElement

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1682

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

isLoadingData

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1692

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

isLoadDataCompleted

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1702

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

isVisible

Boolean

Inherited from Site3dConfigurator but overwritten in modules\configurator\configurator.js:1712

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

isAnyItemOnChange

Boolean

Inherited from Site3dConfigurator: modules\configurator\configurator.js:1749

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

panelControlsButtonClick

Site3dConfiguratorPanelControlsButtonClick | null

Inherited from Site3dConfigurator but overwritten in modules\configurator\configurator.js:2540

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