API Docs for: 1.0.0
Show:

Site3dPlannerDoorInner Class

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

Constructor

Site3dPlannerDoorInner

(
  • configurator
  • model
  • options
)

Parameters:

  • configurator Site3dPlanner

    Объект планировщика

  • model Site3dModel

    3D модель в сцене данного элемента

  • options Object

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

Methods

replaceCabin

(
  • cabinPrev
  • cabinCur
)

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

Parameters:

  • cabinPrev Object

    Объект предыдущей бытовки

  • cabinCur Object

    Объект текущей бытовки

placeItemChange

() async

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

updateSize

()

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

setPlace

(
  • options
)
async

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

Parameters:

  • options Object

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

updatePlace

(
  • options
)
async

Метод обновляет местоположение объекта бытовки

Parameters:

  • options Object

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

updatePlaceLevel

()

Метод обновляет уровень этажности объекта (объекты могу стоять друг на друге)

getCheckNearGroups

(
  • placeItem
)
String[]

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

Parameters:

Returns:

String[]:

Результат

getCheckCollisionGroups

(
  • placeItem
)
String[]

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

Parameters:

Returns:

String[]:

Результат

setDragPointShift

()

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

getAutoSizeExtra

(
  • index
  • options
)
Number

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

Parameters:

  • index Number

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

  • options Object

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

Returns:

Number:

Результат

getAutoSize

(
  • size
  • autoSize
  • options
)
Number[]

Метод возвращает размеры, полученные путем адаптации переданных размеров и корректировок к размерам и корректировкам данного элемента бытовки

Parameters:

  • size Number[]

    Размеры другого объекта

  • autoSize Number[]

    Корректировки для результирующего размера

  • options Object

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

Returns:

Number[]:

Результат

getAutoSizeByPlaceItem

() Number[]

Метод возвращает размеры элемента бытовки, на котором размещен данный элемент бытовки (по размеру и корректировкам данного элемента бытовки)

Returns:

Number[]:

Результат

getMoveLocal

(
  • placePoint
  • placeItem
  • typeData
  • options
)
Number[]

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

Parameters:

  • placePoint Number[]

    Координаты элемента

  • placeItem Site3dPlannerCabinItem

    Элемент размещения

  • typeData Object

    Данные элемента, характерные для его типа

  • options Object

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

Returns:

Number[]:

Результат

setFill

(
  • setting
  • value
  • options
)
async

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

Parameters:

setFillDepend

(
  • setting
  • value
  • options
)
async

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

Parameters:

runSetting

(
  • setting
  • value
  • options
)
async

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

Parameters:

getServerData

(
  • fileName
  • data
  • format
)
Promise async

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

Parameters:

  • fileName Object

    Имя файла скрипта с расширением

  • data Object

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

  • format String

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

Returns:

Promise:

Результат

init

() async

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

addSettings

() async

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

settingsSetupCompleted

() async

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

setSettings

()

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

s

(
  • name
)
Any

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

Parameters:

  • name String

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

Returns:

Any:

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

getActionPath

(
  • name
)
String[]

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

Parameters:

  • name String

    Имя действия

Returns:

String[]:

Путь

addActions

() async

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

getPanelCaption

() String

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

Returns:

String:

Результат

getLocalPos

(
  • pos
)
Number[]

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

Parameters:

Returns:

Number[]:

Результат

getIntersectPos

(
  • intersect
)
Number[]

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

Parameters:

  • intersect Object

    Объект пересечения

Returns:

Number[]:

Позиция

getLocalIntersectPos

(
  • intersect
)
Number[]

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

Parameters:

  • intersect Object

    Объект пересечения

Returns:

Number[]:

Позиция

isItem

(
  • model
)
Boolean

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

Parameters:

Returns:

Boolean:

Результат

searchModelParts

(
  • values
)
Site3dModel[]

Метод ищет в модели его части

Parameters:

  • values String[] | string

    Имена частей модели (можно указать только части имен)

Returns:

Site3dModel[]:

Результат

showPanel

() async

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

hidePanel

()

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

togglePanel

()

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

hover

()

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

out

()

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

show

(
  • options
)

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

Parameters:

  • options Object

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

showSilent

(
  • options
)

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

Parameters:

  • options Object

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

hide

()

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

hideSilent

(
  • options
)

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

Parameters:

  • options Object

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

setVisibilitySilent

(
  • value
  • options
)

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

Parameters:

  • value Boolean

    Значение

  • options Object

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

select

()

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

deselect

()

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

showSelection

()

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

getPos

() Array

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

Returns:

Array:

Позиция

getSaveData

() Object

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

Returns:

Object:

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

loadSettingsData

(
  • settings
)
async

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

Parameters:

  • settings Object

    Данные настроек

updateGeometry

(
  • data
)

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

Parameters:

  • data Object

    Данные для обновления геометрии

enable

()

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

disable

()

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

setEnabledPrev

()

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

deselectActions

()

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

checkIntersect

(
  • item
  • options
)
Object | boolean

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

Parameters:

Returns:

Object | boolean:

Объект результата {minDistance, minPos1, minPos2} или false:

  • minDistance - минимальное расстояние между гранями границ двух моделей (если пересекаются, то -1, если совпадают, то 0)
  • minPos1 - позиция линии минимального расстояния на грани первой границы
  • minPos2 - позиция линии минимального расстояния на грани второй границы

isBoundLayOnItem

(
  • item
)
Boolean

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

Parameters:

Returns:

Boolean:

Результат

render

()

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

remove

()

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

Properties

typeData

Object

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

cabin

Object

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

place

Site3dPlannerPlace

Свойство возвращает местоположение элемента

placeItem

Site3dPlannerCabinItem

Свойство возвращает местоположение элемента

placeItemTags

String[]

Свойство возвращает элемент бытовки, к которой привязан элемент комнаты

configurator

Site3dPlanner

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

path

String

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

model

Site3dModel

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

options

Object

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

caption

String

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

connectModelName

String

Свойство возвращает имя модели для соединения

factoryCategory

String

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

factoryType

String

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

category

String

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

type

String

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

parent

Object

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

index

String

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

code

String

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

level

Number

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

price

Number

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

frameColor

String

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

frameColorHover

String

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

mirroredX

Boolean

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

createComplete

Function

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

settings

Site3dConfiguratorSettings

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

actions

Site3dConfiguratorActions

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

selected

Boolean

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

isVisible

Boolean

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

isEnabled

Boolean

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

isShowPanel

Boolean

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

s3d

Site3d

Получить объект сцены конфигуратора

data

Object

Получить данные по конфигуратору

size

Array

Получить размеры элемента конфигуратора