API Docs for:
Show:

Site3dPlannerCabinCeilingInner Class

Extends Site3dPlannerCabinBlock
Defined in: modules\planner\planner.js:5236
Module: Site3dModal

Класс внутреннего потолка бытовки

Constructor

Site3dPlannerCabinCeilingInner

(
  • configurator
  • model
  • options
)

Defined in modules\planner\planner.js:5236

Parameters:

  • configurator Site3dPlanner

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

  • model Site3dModel

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

  • options Site3dPlannerItemOptions

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

Methods

setPlace

(
  • options
)
Promise async

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:3991

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

Parameters:

  • options Object

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

Returns:

Promise:

getCheckNearGroups

(
  • placeItem
)
String

Inherited from Site3dPlannerCabinItem but overwritten in modules\planner\planner.js:4045

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

Parameters:

Returns:

String:

Результат

getCheckCollisionGroups

(
  • placeItem
)
String

Inherited from Site3dPlannerCabinItem but overwritten in modules\planner\planner.js:4056

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

Parameters:

Returns:

String:

Результат

setDragPointShift

()

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:4141

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

getAutoSizeExtra

(
  • index
  • options
)
Number

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:4157

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

Parameters:

  • index Number

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

  • options Object

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

Returns:

Number:

Результат

getAutoSize

(
  • size
  • autoSize
  • options
)
Number

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:4169

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

Parameters:

  • size Number

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

  • autoSize Number

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

  • options Object

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

Returns:

Number:

Результат

getAutoSizeByPlaceItem

() Number

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:4190

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

Returns:

Number:

Результат

getMoveLocal

(
  • placePoint
  • placeItem
  • typeData
  • options
)
Number

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:4200

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

Parameters:

  • placePoint Number

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

  • placeItem Site3dPlannerCabinItem

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

  • typeData Object

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

  • options Object

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

Returns:

Number:

Результат

setFill

(
  • setting
  • value
  • options
)
async

Inherited from Site3dPlannerItem: modules\planner\planner.js:3672

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

Parameters:

  • setting Site3dConfiguratorSettingsMaterial

    Настройка материала

  • value Any

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

  • options Object

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

setFillDepend

(
  • setting
  • value
  • options
)
async

Inherited from Site3dPlannerItem: modules\planner\planner.js:3685

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

Parameters:

  • setting Site3dConfiguratorSettingsItem

    Настройка

  • value Any

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

  • options Object

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

runSetting

(
  • setting
  • value
  • options
)
async

Inherited from Site3dPlannerItem: modules\planner\planner.js:3722

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

Parameters:

  • setting Site3dConfiguratorSettingsItem

    Настройка

  • value Any

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

  • options Object

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

getServerData

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

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4152

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

Parameters:

  • fileName String

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

  • [data=null] Site3dConfiguratorServerRequestData | null optional

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

  • [format='json'] Site3dConfiguratorServerDataFormat optional

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

Returns:

Promise:

Результат

init

() async

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4175

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

addSettings

() async

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4275

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

settingsSetupCompleted

() async

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4370

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

setSettings

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4379

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

s

(
  • name
)
String | number | object

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4391

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

Parameters:

  • name String

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

Returns:

String | number | object:

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

getActionPath

(
  • name
)
String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4402

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

Parameters:

  • name String

    Имя действия

Returns:

String:

Путь

addActions

() async

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4413

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

getPanelCaption

() String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4433

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

Returns:

String:

Результат

getLocalPos

(
  • pos
)
Number

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4443

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

Parameters:

  • pos Number

    Позиция

Returns:

Number:

Результат

getIntersectPos

(
  • intersect
)
Number | null

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4454

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

Parameters:

  • intersect Site3dModelIntersectResult | null

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

Returns:

Number | null:

Позиция

getLocalIntersectPos

(
  • intersect
)
Number | null

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4472

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

Parameters:

  • intersect Site3dModelIntersectResult | null

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

Returns:

Number | null:

Позиция

isItem

(
  • model
)
Boolean

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4490

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

Parameters:

Returns:

Boolean:

Результат

searchModelParts

(
  • values
  • [options]
)
Site3dModel[]

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4501

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

Parameters:

  • values String | string

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

  • [options] Site3dConfiguratorSearchModelPartsOptions optional

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

Returns:

Site3dModel[]:

Результат

showPanel

() async

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4525

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

hidePanel

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4541

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

togglePanel

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4550

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

hover

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4566

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

out

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4578

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

show

(
  • options
)

Inherited from Site3dConfiguratorItem but overwritten in modules\configurator\configurator.js:4594

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

Parameters:

  • options Site3dModelVisibilityOptions

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

showSilent

(
  • options
)

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4605

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

Parameters:

  • options Site3dModelVisibilityOptions

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

hide

(
  • options
)

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4615

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

Parameters:

  • options Site3dModelVisibilityOptions

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

hideSilent

(
  • options
)

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4626

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

Parameters:

  • options Site3dModelVisibilityOptions

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

setVisibilitySilent

(
  • value
  • options
)

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4636

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

Parameters:

  • value Boolean

    Значение

  • options Site3dModelVisibilityOptions

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

select

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4654

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

deselect

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4671

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

showSelection

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4688

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

getPos

() Site3dPoint3D

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4697

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

Returns:

Site3dPoint3D:

Позиция

getDataItemsTyped

(
  • name
)
Site3dConfiguratorDataItemsMapTName | undefined

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4732

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

Parameters:

  • name TName

    Имя данных

Returns:

Site3dConfiguratorDataItemsMapTName | undefined:

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

getSaveData

() Site3dConfiguratorItemSaveData

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4744

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

Returns:

Site3dConfiguratorItemSaveData:

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

loadSettingsData

(
  • settings
)
async

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4772

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

Parameters:

  • settings Site3dConfiguratorItemSettings

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

updateGeometry

(
  • data
)

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4786

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

Parameters:

  • data Object.

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

enable

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4796

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

disable

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4805

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

setEnabledPrev

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4815

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

deselectActions

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4824

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

checkIntersect

(
  • model
  • [options]
)
Site3dModelCheckIntersectResult

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4839

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

Parameters:

  • model Site3dModel

    Другая модель

  • [options] Site3dModelCheckIntersectOptions optional

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

Returns:

Site3dModelCheckIntersectResult:

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

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

isBoundLayOnItem

(
  • item
)
Boolean

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4854

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

Parameters:

Returns:

Boolean:

Результат

render

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4865

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

remove

()

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4874

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

Properties

typeData

Site3dPlannerItemOptions'typeData'

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:4067

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

cabin

Site3dPlannerCabin

Inherited from Site3dPlannerCabinItem but overwritten in modules\planner\planner.js:4077

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

place

Site3dPlannerPlace

Inherited from Site3dPlannerCabinItem but overwritten in modules\planner\planner.js:4097

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

placeItem

Site3dPlannerCabinItem | null

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:4116

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

placeItemTags

String

Inherited from Site3dPlannerCabinItem: modules\planner\planner.js:4131

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

configurator

Site3dPlanner

Inherited from Site3dConfiguratorItem but overwritten in modules\planner\planner.js:3642

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

options

Site3dPlannerItemOptions

Inherited from Site3dConfiguratorItem but overwritten in modules\planner\planner.js:3652

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

path

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3848

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

model

Site3dModel

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3858

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

caption

String

Inherited from Site3dConfiguratorItem but overwritten in modules\configurator\configurator.js:3878

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

connectModelName

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3897

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

factoryCategory

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3907

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

factoryType

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3917

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

category

String

Inherited from Site3dConfiguratorItem but overwritten in modules\configurator\configurator.js:3927

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

type

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3947

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

parent

Site3dConfiguratorItem | undefined

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3957

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

parentSettingName

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3967

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

index

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3977

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

code

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3987

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

level

Number

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:3997

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

price

Number

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4007

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

frameColor

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4017

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

frameColorHover

String

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4027

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

mirroredX

Boolean

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4037

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

createComplete

Function

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4047

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

settings

Site3dConfiguratorSettings

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4057

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

actions

Site3dConfiguratorActions

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4067

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

selected

Boolean

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4077

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

isVisible

Boolean

Inherited from Site3dConfiguratorItem but overwritten in modules\configurator\configurator.js:4087

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

isEnabled

Boolean

Inherited from Site3dConfiguratorItem but overwritten in modules\configurator\configurator.js:4114

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

isShowPanel

Boolean

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4141

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

s3d

Site3d

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4245

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

data

Site3dConfiguratorData | null

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4255

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

size

Array

Inherited from Site3dConfiguratorItem: modules\configurator\configurator.js:4265

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