API Docs for: 1.0.0
Show:

Site3dPlanner Class

Defined in: modules\planner\planner.js:1
Module: Site3dModal

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

Constructor

Site3dPlanner

(
  • s3d
  • options
)

Defined in modules\planner\planner.js:1

Parameters:

  • s3d Site3d

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

  • options Object

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

Methods

getEventRot

(
  • item
  • delta
)
Number static

Defined in modules\planner\planner.js:52

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

Parameters:

Returns:

Number:

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

projectOpen

(
  • data
)
async

Defined in modules\planner\planner.js:680

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

Parameters:

  • data Object

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

projectSave

() async

Defined in modules\planner\planner.js:696

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

getNextCabinIndex

() Number

Defined in modules\planner\planner.js:711

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

Returns:

Number:

Новый индекс

getNextRoomIndex

() Number

Defined in modules\planner\planner.js:721

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

Returns:

Number:

Новый индекс

getNextObjectIndex

() Number

Defined in modules\planner\planner.js:731

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

Returns:

Number:

Новый индекс

isCabinParent

(
  • cabin
)
Boolean

Defined in modules\planner\planner.js:741

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

Parameters:

  • cabin Object

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

Returns:

Boolean:

Результат

getCabinsSorted

(
  • sort
)
Object[]

Defined in modules\planner\planner.js:762

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

Parameters:

  • sort Function

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

Returns:

Object[]:

Результат

getCabinsCoresItems

(
  • options
)
Site3dPlannerCabinCore[]

Defined in modules\planner\planner.js:773

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

Parameters:

  • options Object

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

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

Returns:

Site3dPlannerCabinCore[]:

Результат

getCabinsCoresModels

(
  • options
)
Site3dModel[]

Defined in modules\planner\planner.js:798

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

Parameters:

  • options Object

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

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

Returns:

Site3dModel[]:

Результат

getCabinsBoundModels

(
  • options
)
Site3dModel[]

Defined in modules\planner\planner.js:811

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

Parameters:

  • options Object

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

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

Returns:

Site3dModel[]:

Результат

getCabinsItemCoreModels

(
  • options
)
Site3dModel[]

Defined in modules\planner\planner.js:824

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

Parameters:

  • options Object

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

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

Returns:

Site3dModel[]:

Результат

getCabin

(
  • index
)
Object

Defined in modules\planner\planner.js:837

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

Parameters:

  • index String

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

Returns:

Object:

Данные

getCabinByCoreItemIndex

(
  • index
)
Object

Defined in modules\planner\planner.js:848

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

Parameters:

  • index String

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

Returns:

Object:

Данные

getCabinsUp

(
  • cabin
)
Object[]

Defined in modules\planner\planner.js:859

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

Parameters:

  • cabin Object

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

Returns:

Object[]:

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

getCabinLastParent

(
  • cabin
)
Object | | boolean

Defined in modules\planner\planner.js:870

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

Parameters:

  • cabin Object

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

Returns:

Object | | boolean:

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

getCabinLevel

(
  • cabin
)
Number

Defined in modules\planner\planner.js:891

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

Parameters:

  • cabin Object

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

Returns:

Number:

Результат

getCabinHeight

(
  • cabin
)
Number

Defined in modules\planner\planner.js:912

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

Parameters:

  • cabin Object

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

Returns:

Number:

Результат

getRoomWallInners

(
  • cabin
)
Site3dPlannerCabinWallInner[]

Defined in modules\planner\planner.js:933

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

Parameters:

  • cabin Object

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

Returns:

Site3dPlannerCabinWallInner[]:

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

getCabinWallItems

(
  • cabin
)
Site3dPlannerWallItem[]

Defined in modules\planner\planner.js:944

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

Parameters:

  • cabin Object

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

Returns:

Site3dPlannerWallItem[]:

Результат

getCabinWall

(
  • cabin
  • wallType
  • index
)
Site3dPlannerCabinBlock

Defined in modules\planner\planner.js:955

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

Parameters:

Returns:

Site3dPlannerCabinBlock:

Результат

getCabinDoorsOut

(
  • cabin
)
Site3dPlannerDoorOut[]

Defined in modules\planner\planner.js:968

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

Parameters:

  • cabin Object

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

Returns:

Site3dPlannerDoorOut[]:

Результат

getCabinWallInnerDoors

(
  • wallInnerItem
)
Site3dPlannerWallItem[]

Defined in modules\planner\planner.js:979

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

Parameters:

Returns:

Site3dPlannerWallItem[]:

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

getCabinCloneInfo

(
  • cabin
  • prevCloneInfo
)
Object

Defined in modules\planner\planner.js:990

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

Parameters:

  • cabin Object

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

  • prevCloneInfo Object

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

Returns:

Object:

Результат

getCabinCloneSaveItems

(
  • cabin
  • cabinCloneInfo
  • parent
)
Object

Defined in modules\planner\planner.js:1011

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

Parameters:

  • cabin Object

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

  • cabinCloneInfo Object

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

  • parent String

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

Returns:

Object:

Результат

setCabinsUpMoveLocal

(
  • cabin
)

Defined in modules\planner\planner.js:1058

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

Parameters:

  • cabin Object

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

setCabinWallInnerMaterial

(
  • cabin
  • value
)
async

Defined in modules\planner\planner.js:1075

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

Parameters:

  • cabin Object

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

  • value String | object

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

getCabinWallInnerDistanceToEnd

(
  • cabin
)
Number

Defined in modules\planner\planner.js:1091

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

Parameters:

  • cabin Object

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

Returns:

Number:

Результат

getRoom

(
  • cabin
  • index
)
Object

Defined in modules\planner\planner.js:1102

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

Parameters:

  • cabin Object

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

  • index Number

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

Returns:

Object:

Данные

getRooms

(
  • cabin
)
Object[]

Defined in modules\planner\planner.js:1114

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

Parameters:

  • cabin Object

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

Returns:

Object[]:

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

getRoomsOut

(
  • cabin
)
Object[]

Defined in modules\planner\planner.js:1125

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

Parameters:

  • cabin Object

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

Returns:

Object[]:

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

getRoomHeight

(
  • cabin
)
Number

Defined in modules\planner\planner.js:1137

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

Parameters:

  • cabin Object

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

Returns:

Number:

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

getRoomIndexPrefix

(
  • index
)
String

Defined in modules\planner\planner.js:1148

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

Parameters:

  • index Number

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

Returns:

String:

Результат

getRoomFloorIndex

(
  • index
)
String

Defined in modules\planner\planner.js:1159

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

Parameters:

  • index Number

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

Returns:

String:

Результат

getRoomFloor

(
  • room
)
Site3dPlannerRoomFloor

Defined in modules\planner\planner.js:1170

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

Parameters:

  • room Object

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

Returns:

Site3dPlannerRoomFloor:

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

getRoomWallInnerIndexPrefix

(
  • index
)
String

Defined in modules\planner\planner.js:1181

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

Parameters:

  • index Number

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

Returns:

String:

Результат

getRoomWallInnerIndex

(
  • index
  • number
)
String

Defined in modules\planner\planner.js:1192

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

Parameters:

  • index Number

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

  • number Number

    Номер стены

Returns:

String:

Результат

getRoomWallInner

(
  • room
  • number
)
Site3dPlannerRoomWallInner

Defined in modules\planner\planner.js:1204

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

Parameters:

  • room Object

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

  • number Number

    Номер стены

Returns:

Site3dPlannerRoomWallInner:

Результат

getRoomWallInners

(
  • room
)
Site3dPlannerRoomWallInner[]

Defined in modules\planner\planner.js:1216

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

Parameters:

  • room Object

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

Returns:

Site3dPlannerRoomWallInner[]:

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

getRoomObjects

(
  • room
  • cabin
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1227

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

Parameters:

  • room Object

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

  • cabin Object

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

Returns:

Site3dPlannerObject[]:

Результат

getRoomObjectsOut

(
  • room
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1242

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

Parameters:

  • room Object

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

Returns:

Site3dPlannerObject[]:

Результат

getRoomItems

(
  • room
)
Site3dPlannerCabinItem[]

Defined in modules\planner\planner.js:1253

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

Parameters:

  • room Object

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

Returns:

Site3dPlannerCabinItem[]:

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

setRoomWallInnerMaterial

(
  • room
  • value
)
async

Defined in modules\planner\planner.js:1266

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

Parameters:

  • room Object

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

  • value String | object

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

getObject

(
  • cabin
  • index
)
Object

Defined in modules\planner\planner.js:1282

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

Parameters:

  • cabin Object

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

  • index Number

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

Returns:

Object:

Данные

getObjects

(
  • cabin
  • options
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1294

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

Parameters:

  • cabin Object

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

  • options Object

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

Returns:

Site3dPlannerObject[]:

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

getObjectsOut

(
  • cabin
  • options
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1313

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

Parameters:

  • cabin Object

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

  • options Object

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

Returns:

Site3dPlannerObject[]:

Результат

getObjectsByPlaceItem

(
  • cabin
  • placeItem
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1325

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

Parameters:

Returns:

Site3dPlannerObject[]:

Результат

getObjectsWithLevels

(
  • objects
)
Site3dPlannerObject[]

Defined in modules\planner\planner.js:1349

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

Parameters:

Returns:

Site3dPlannerObject[]:

Результат

removeObject

(
  • item
)
async

Defined in modules\planner\planner.js:1360

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

Parameters:

createEntityModel

(
  • type
  • name
  • options
)
Site3dModel async

Defined in modules\planner\planner.js:1384

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

Parameters:

  • type String

    Тип модели

  • name String

    Имя модели

  • options Object

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

Returns:

Site3dModel:

Модель

createEntityItem

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

Defined in modules\planner\planner.js:1403

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

Parameters:

  • entity Site3dPlannerCabinItem

    Класс стены

  • data Object

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

  • prefix String

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

  • connectModelName String

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

  • options Object

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

Returns:

Site3dPlannerItem:

Результат

createEntityItems

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

Defined in modules\planner\planner.js:1481

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

Parameters:

  • entity Site3dPlannerCabinItem

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

  • data Object

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

  • prefix String

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

  • connectModelName String

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

  • options Object

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

updatePlinthModels

(
  • item
)
async

Defined in modules\planner\planner.js:1528

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

Parameters:

addCabin

(
  • data
)
async

Defined in modules\planner\planner.js:1556

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

Parameters:

  • data Object

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

addRoom

(
  • cabin
  • data
)
async

Defined in modules\planner\planner.js:1677

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

Parameters:

  • cabin Object

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

  • data Object

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

addObject

(
  • cabin
  • data
)
async

Defined in modules\planner\planner.js:1764

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

Parameters:

  • cabin Object

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

  • data Object

    Данные

setCabinWallOutView

(
  • wallOutItem
  • value
  • options
)
async

Defined in modules\planner\planner.js:1816

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

Parameters:

  • wallOutItem Site3dPlannerCabinWallOut

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

  • value String

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

  • options Object

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

setCabinWallInnerView

(
  • wallInnerItem
  • value
)
async

Defined in modules\planner\planner.js:1844

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

Parameters:

  • wallInnerItem Site3dPlannerCabinWallInner

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

  • value String

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

setCabinCeilingVisibility

(
  • cabin
)

Defined in modules\planner\planner.js:1887

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

Parameters:

  • cabin Object

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

updateCabinsUpDoorStairs

(
  • cabin
)

Defined in modules\planner\planner.js:1927

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

Parameters:

  • cabin Object

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

getChangeValue

(
  • data
  • change
)
Any

Defined in modules\planner\planner.js:1945

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

Parameters:

  • data Object

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

  • change Object

    Изменение

Returns:

Any:

Значение

setChangeValue

(
  • data
  • change
)

Defined in modules\planner\planner.js:1962

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

Parameters:

  • data Object

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

  • change Object

    Изменение

removeObjectsByData

(
  • data
  • cabin
)

Defined in modules\planner\planner.js:1980

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

Parameters:

  • data Object[]

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

  • cabin Object

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

buildCabin

(
  • data
  • changes
  • options
)
async

Defined in modules\planner\planner.js:1998

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

Parameters:

  • data Object

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

  • changes Array

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

  • options Object

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

buildRoom

(
  • data
  • changes
  • options
)
async

Defined in modules\planner\planner.js:2538

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

Parameters:

  • data Object

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

  • changes Array

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

  • options Object

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

removeCabin

(
  • data
  • options
)
async

Defined in modules\planner\planner.js:2976

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

Parameters:

  • data Object

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

  • options Object

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

removeRoom

(
  • data
  • options
)
async

Defined in modules\planner\planner.js:3021

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

Parameters:

  • data Object

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

  • options Object

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

intersectCabin

(
  • checkItem
  • checkItemData
  • options
)
Site3dPlannerPlaceIntersect

Defined in modules\planner\planner.js:3054

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

Parameters:

  • checkItem Site3dPlannerCabinItem

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

  • checkItemData Object

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

  • options Object

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

Returns:

Site3dPlannerPlaceIntersect:

Результат

getGroundIntersect

(
  • options
)
Site3dPlannerPlace

Defined in modules\planner\planner.js:3080

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

Parameters:

  • options Object

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

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

Returns:

Site3dPlannerPlace:

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

startAddToHistory

(
  • index
  • caption
  • cancel
  • data
)

Defined in modules\planner\planner.js:3094

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

Parameters:

  • index String

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

  • caption String

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

  • cancel Function

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

  • data Object

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

stopAddToHistory

()

Defined in modules\planner\planner.js:3107

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

setDataToHistory

(
  • data
)

Defined in modules\planner\planner.js:3116

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

Parameters:

  • data Object

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

endAddToHistory

(
  • make
  • additionalData
  • options
)
async

Defined in modules\planner\planner.js:3126

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

Parameters:

  • make Function

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

  • additionalData Object

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

  • options Object

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

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

addToHistory

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

Defined in modules\planner\planner.js:3141

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

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:3159

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

Parameters:

  • changes Array

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

Returns:

Boolean:

Результат

setHistoryActions

()

Defined in modules\planner\planner.js:3180

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

updateRoof

() async

Defined in modules\planner\planner.js:3190

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

updateView

()

Defined in modules\planner\planner.js:3217

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

Properties

cabins

Unknown

Defined in modules\planner\planner.js:77

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