API Docs for: 1.0.0
Show:

Site3dModel Class

Defined in: base\site3d.js:3692
Module: Site3d

Класс модели

Item Index

Methods

Methods

isItem

(
  • model
)
Boolean

Defined in base\site3d.js:4072

Метод возвращает истину, если переданная модель является самой этой моделью или её частью

Parameters:

Returns:

Boolean:

Результат

isItem

(
  • name
)
Boolean

Defined in base\site3d.js:4083

Метод возвращает истину, если есть часть модели

Parameters:

  • name String

    Имя модели

Returns:

Boolean:

Результат

item

(
  • name
)
Site3dModel

Defined in base\site3d.js:4094

Метод возвращает часть модели

Parameters:

  • name String

    Имя модели

Returns:

Site3dModel:

Модель

addItem

(
  • model
  • parentGroupName
)

Defined in base\site3d.js:4111

Метод добавляет модель

Parameters:

  • model Site3dModel

    Модель

  • parentGroupName String

    Имя родительской группы

searchItems

(
  • values
  • options
)
Site3dModel[]

Defined in base\site3d.js:4139

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

Parameters:

  • values String[] | string

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

  • options Object

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

Returns:

Site3dModel[]:

Результат

addEventItem

(
  • model
)

Defined in base\site3d.js:4177

Метод добавляет модель в список моделей, для которых обрабатываются события

Parameters:

addEventItems

(
  • models
)

Defined in base\site3d.js:4187

Метод добавляет модели в список моделей, для которых обрабатываются события

Parameters:

setBoundCenter

()

Defined in base\site3d.js:4197

Метод устанавливает центр геометрии модели

saveGeometry

()

Defined in base\site3d.js:4206

Метод сохраняет геометрию модели

loadGeometry

()

Defined in base\site3d.js:4215

Метод загружает геометрию модели

setGeometry

(
  • geometry
  • options
)

Defined in base\site3d.js:4224

Метод загружает геометрию

Parameters:

  • geometry BufferGeometry

    Геометрия

  • options Object

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

setGeometryFromModel

(
  • model
  • options
)

Defined in base\site3d.js:4245

Метод загружает геометрию модели

Parameters:

  • model Site3dModel

    Модель

  • options Object

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

updateGeometrySilent

(
  • data
)

Defined in base\site3d.js:4263

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

Parameters:

  • data Object

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

updateGeometry

(
  • data
)

Defined in base\site3d.js:4282

Метод обновляет геометрию модели

Parameters:

  • data Object

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

subtractModelBound

(
  • model
)

Defined in base\site3d.js:4293

Метод вычитает из модели геометрию границы другой модели

Parameters:

isLoaded

() Boolean

Defined in base\site3d.js:4316

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

Returns:

Boolean:

Результат

show

(
  • options
)

Defined in base\site3d.js:4326

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

Parameters:

  • options Object

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

showSilent

(
  • options
)

Defined in base\site3d.js:4337

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

Parameters:

  • options Object

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

showCallEvent

()

Defined in base\site3d.js:4359

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

hide

(
  • options
)

Defined in base\site3d.js:4368

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

Parameters:

  • options Object

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

hideSilent

(
  • options
)

Defined in base\site3d.js:4379

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

Parameters:

  • options Object

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

hideCallEvent

()

Defined in base\site3d.js:4415

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

setVisibilitySilent

(
  • value
  • options
)

Defined in base\site3d.js:4424

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

Parameters:

  • value Boolean

    Значение

  • options Object

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

remove

()

Defined in base\site3d.js:4442

Метод удаляет модель

removeSilent

()

Defined in base\site3d.js:4452

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

getLocalBoundCenter

() Number[]

Defined in base\site3d.js:4489

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

Returns:

Number[]:

Позиция

getWorldBoundCenter

() Number[]

Defined in base\site3d.js:4499

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

Returns:

Number[]:

Позиция

getPos

() Number[]

Defined in base\site3d.js:4509

Метод возвращает позицию модели

Returns:

Number[]:

Позиция

getPrevPos

() Number[]

Defined in base\site3d.js:4523

Метод возвращает предыдущую позицию модели

Returns:

Number[]:

Позиция

getRelativePos

(
  • pos
)
Number[]

Defined in base\site3d.js:4533

Метод возвращает позицию, смещенную относительно центра модели

Parameters:

Returns:

Number[]:

Позиция

getRelativePos

(
  • pos
)
Number[]

Defined in base\site3d.js:4544

Метод возвращает позицию, смещенную относительно измененого центра модели

Parameters:

Returns:

Number[]:

Позиция

pos

()

Defined in base\site3d.js:4560

Метод изменяет позицию модели (передаются координаты в виде трех параметров или массив координат)

posSilent

()

Defined in base\site3d.js:4571

Метод изменяет позицию модели без вызова отрисовки (смотрите описание параметров для метода pos)

move

()

Defined in base\site3d.js:4600

Метод перемещает модель. Варианты параметров:

  • step – движение в направлении взгляда вдоль плоскости xz
  • step, pos – движение в направлении точки pos
  • stepX, stepY, stepZ, options – движение по трем осям, где options:
  • isLocal – истина, если локальное перемещение (по умолчанию истина)

moveSilent

()

Defined in base\site3d.js:4614

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

movedPos

() Array

Defined in base\site3d.js:4668

Метод возвращает позицию точки, возникшей путем перемещения модели (смотрите описание параметров для метода move)

Returns:

Array:

Позиция

getScale

() Array

Defined in base\site3d.js:4682

Метод возвращает масштаб модели в виде массива значений по трем осям

Returns:

Array:

Масштаб

getWorldScale

() Array

Defined in base\site3d.js:4692

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

Returns:

Array:

Масштаб

scale

()

Defined in base\site3d.js:4702

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

scaleSilent

()

Defined in base\site3d.js:4712

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

zoom

(
  • stepX
  • stepY
  • stepZ
)

Defined in base\site3d.js:4764

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

Parameters:

  • stepX Number

    Шаг масштаба по оси X

  • stepY Number

    Шаг масштаба по оси Y

  • stepZ Number

    Шаг масштаба по оси Z

zoomSilent

()

Defined in base\site3d.js:4777

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

getRot

() Array

Defined in base\site3d.js:4797

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

Returns:

Array:

Состояние поворота

getSizeBySides

() Number[]

Defined in base\site3d.js:4807

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

Returns:

Number[]:

Массив размеров по трем осям

rot

()

Defined in base\site3d.js:4817

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

rotSilent

()

Defined in base\site3d.js:4827

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

getRotInit

() Number[]

Defined in base\site3d.js:4850

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

Returns:

Number[]:

Поворот

setRotInit

(
  • value
)

Defined in base\site3d.js:4867

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

Parameters:

rotInit

()

Defined in base\site3d.js:4882

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

rotInitSilent

()

Defined in base\site3d.js:4892

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

rotate

(
  • stepX
  • stepY
  • stepZ
  • options
)

Defined in base\site3d.js:4906

Метод поворачивает модель по трем локальным для модели или глобальным осям.

Parameters:

  • stepX Number

    Угол поворота вдоль оси X

  • stepY Number

    Угол поворота вдоль оси Y

  • stepZ Number

    Угол поворота вдоль оси Z

  • options Object

    Параметры:

    • isLocal – истина, если оси локальные (по умолчанию истина)
    • duration – время анимации

rotateSilent

()

Defined in base\site3d.js:4922

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

rotateUp

()

Defined in base\site3d.js:5019

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

rotateUpSilent

()

Defined in base\site3d.js:5029

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

playRotate

()

Defined in base\site3d.js:5055

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

pauseRotate

()

Defined in base\site3d.js:5064

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

stopRotate

()

Defined in base\site3d.js:5073

Метод останавливает вращение

copyRot

(
  • rot
)

Defined in base\site3d.js:5082

Метод копирует состояние поворота

Parameters:

  • rot Euler

    Состояние поворота

copyRotSilent

(
  • rot
)

Defined in base\site3d.js:5093

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

Parameters:

  • rot Euler

    Состояние поворота

copyRotFromModel

(
  • model
)

Defined in base\site3d.js:5103

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

Parameters:

copyRotFromModelSilent

(
  • model
)

Defined in base\site3d.js:5114

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

Parameters:

afterTransform

()

Defined in base\site3d.js:5124

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

fill

(
  • fill
  • load
  • progress
)
async

Defined in base\site3d.js:5132

Метод редактирует наполнение (материал)

Parameters:

  • fill Object

    Наполнение

  • load Function

    Функция обработки окончания наполнения

  • progress Function

    Функция обработки процесса загрузки наполнения

getColor

() String

Defined in base\site3d.js:5176

Метод возвращает цвет материала модели

Returns:

String:

Цвет в HEX-формате

setColor

(
  • color
)

Defined in base\site3d.js:5186

Метод устанавливает цвет материала модели

Parameters:

  • color String

    Цвет в HEX-формате

setColorSilent

(
  • color
)

Defined in base\site3d.js:5197

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

Parameters:

  • color String

    Цвет в HEX-формате

isOneMaterial

() Boolean

Defined in base\site3d.js:5207

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

Returns:

Boolean:

Результат

worldToLocal

(
  • pos
)
Number[]

Defined in base\site3d.js:5217

Метод переводит глобальные координаты позиции в локальные для данной модели

Parameters:

  • pos Number[]

    Позиция в глобальных координатах

Returns:

Number[]:

Позиция в локальных координатах

localToWorld

(
  • pos
)
Number[]

Defined in base\site3d.js:5231

Метод переводит локальные координаты позиции для данной модели в глобальные

Parameters:

  • pos Number[]

    Позиция в локальных координатах

Returns:

Number[]:

Позиция в глобальных координатах

enableShadows

(
  • actions
)

Defined in base\site3d.js:5245

Метод включает тени от модели

Parameters:

  • actions String

    Режим (по умолчанию «castReceive»):

    • «cast» – отбрасывать тени
    • «receive» – принимать тени
    • «castReceive» – отбрасывать и принимать тени

disableShadows

()

Defined in base\site3d.js:5271

Метод отключает тени от модели

enableControls

(
  • options
)

Defined in base\site3d.js:5295

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

Parameters:

  • options Object

    Параметры:

    • scale – масштабирование колесом прокрутки:
    • isEnabled – истина, если масштабирование включено (по умолчанию включено, если передать параметр scale)
    • min – минимальный масштаб (по умолчанию: 0.5)
    • max – максимальный масштаб (по умолчанию: 2)
    • speed – скорость (по умолчанию: 1)
    • rotate – вращение:
    • isEnabled – истина, если вращение включено (по умолчанию включено, если передать параметр rotate)
    • events – массив строк органов управления (возможные значения: «mouse_left» – левая кнопка мыши, «mouse_right» – правая кнопка мыши, «touch_move» – перемещение пальцем (по умолчанию: [«mouse_left», «touch_move»]))
    • axes – оси вращения (x, y или x и y одновременно (по умолчанию: «xy»))
    • speed – скорость (по умолчанию: 1)

disableControls

()

Defined in base\site3d.js:5350

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

connect

(
  • options
)

Defined in base\site3d.js:5361

Метод соединяет модель с камерой или другой моделью

Parameters:

  • options Object

    Параметры:

    • modelName – имя модели (если пустое значение, то соединение с камерой)
    • moveLocal - смещение в рамках локальных осей модели
    • rotateLocal – поворот относительно локальных осей

disconnect

()

Defined in base\site3d.js:5387

Метод отключает соединение

updateConnect

()

Defined in base\site3d.js:5396

Метод обновляет соединение (срабатывает при каждой отрисовке)

intersect

(
  • fromModels
  • options
)
Object | null

Defined in base\site3d.js:5505

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

Parameters:

  • fromModels Array

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

  • options Object

    Параметры:

    • isOnlyVisible - истина, если пересечение нужно искать только среди видимых моделей (по-умолчанию истина)

Returns:

Object | null:

Объект результата или null при отсутствии пересечения:

  • model - модель, с которой нашлось пересечение
  • pos - позиция пересечения

getBoundRadius

(
  • model
)
Number

Defined in base\site3d.js:5522

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

Parameters:

Returns:

Number:

Результат

getDistanceBetweenPositions

(
  • model
)
Number

Defined in base\site3d.js:5533

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

Parameters:

Returns:

Number:

Результат

getDistanceBetweenPositions

(
  • model
)
Number

Defined in base\site3d.js:5544

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

Parameters:

Returns:

Number:

Результат

updateSidesFromRotation

()

Defined in base\site3d.js:5557

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

getSize

() Number[]

Defined in base\site3d.js:5584

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

Returns:

Number[]:

Массив размеров по трем осям

getSizeBySides

() Number[]

Defined in base\site3d.js:5594

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

Returns:

Number[]:

Массив размеров по трем осям

getVolume

() Number

Defined in base\site3d.js:5604

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

Returns:

Number:

Объем

calcSize

()

Defined in base\site3d.js:5614

Метод пересчитывает размеры модели

getSidePos

(
  • value
)
Number[]

Defined in base\site3d.js:5624

Метод возвращает позицию относительно центра модели на её боковых границах

Parameters:

  • value Object | string

    Сторона границ модели

Returns:

Number[]:

Позиция

getMinViewDistance

() Number

Defined in base\site3d.js:5650

Метод возвращает минимальное расстояние приближения к модели от её центра

Returns:

Number:

Расстояние

getViewDistance

(
  • distance
  • options
)
Number

Defined in base\site3d.js:5660

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

Parameters:

  • distance Number | string

    Дистанция от границ модели (число или процент от минимального расстояния)

  • options Object

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

Returns:

Number:

Расстояние

getPosFromTarget

(
  • posFromModel
  • options
)
Number[]

Defined in base\site3d.js:5682

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

Parameters:

  • posFromModel Array

    Позиция относительно модели

  • options Object

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

Returns:

Number[]:

Расстояние

createBound

()

Defined in base\site3d.js:5704

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

createEdges

()

Defined in base\site3d.js:5713

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

updateEdges

()

Defined in base\site3d.js:5741

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

fillEdges

()

Defined in base\site3d.js:5781

Метод наполняет материал сетки модели в виде граней

showEdges

()

Defined in base\site3d.js:5814

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

hideEdges

()

Defined in base\site3d.js:5843

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

updateBound

()

Defined in base\site3d.js:5872

Метод обновляет положение границы вокруг модели

removeBound

()

Defined in base\site3d.js:5881

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

rebuildBound

()

Defined in base\site3d.js:5895

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

getBoundPosList

() Number[]

Defined in base\site3d.js:5904

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

Returns:

Number[]:

Вершины границы

getBoundPosListBottom

() Number[]

Defined in base\site3d.js:5919

Метод возвращает координаты нижних вершин границы вокруг модели

Returns:

Number[]:

Вершины границы

setFrame

(
  • options
)

Defined in base\site3d.js:5929

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

Parameters:

  • options Object

    Параметры:

    • color - цвет каркаса в HEX-формате
    • thickness - толщина каркаса

showFrame

(
  • options
)

Defined in base\site3d.js:5947

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

Parameters:

  • options Object

    Параметры:

    • color - цвет каркаса в HEX-формате

hideFrame

()

Defined in base\site3d.js:5966

Метод скрывает каркас границы объекта

setOutline

(
  • options
)

Defined in base\site3d.js:5981

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

Parameters:

  • options Object

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

showOutline

()

Defined in base\site3d.js:5991

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

hideOutline

()

Defined in base\site3d.js:6000

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

addClipping

(
  • name
  • options
)

Defined in base\site3d.js:6009

Метод добавляет срез модели

Parameters:

  • name String

    Имя среза

  • options Object

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

label

(
  • name
  • options
)

Defined in base\site3d.js:6022

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

Parameters:

  • name String

    Имя метки

  • options Object

    Параметры:

    • content – идентификатор HTML-элемента
    • pos – позиция относительно модели (по умолчанию [0, 0, 0])
    • text - Текст метки
    • isEnabled – истина, если метка видна (по умолчанию истина)

removeLabel

(
  • name
)

Defined in base\site3d.js:6052

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

Parameters:

  • name String

    Имя метки

enableLabels

()

Defined in base\site3d.js:6069

Метод показывает все метки

disableLabels

()

Defined in base\site3d.js:6079

Метод скрывает все метки

addSizeInfo

(
  • name
  • options
)
Site3dModelSizeInfo

Defined in base\site3d.js:6089

Метод добавляет отображение размеров модели

Parameters:

  • name String

    Имя

  • options Object

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

Returns:

Site3dModelSizeInfo:

Результат

setSizeInfoVisibility

(
  • name
  • value
)

Defined in base\site3d.js:6107

Метод устанавливает видимость отображения размеров модели

Parameters:

setInitEventsActivityLabels

()

Defined in base\site3d.js:6133

Метод включает события для всех меток

disableEventsLabels

()

Defined in base\site3d.js:6142

Метод выключает события для всех меток

updateLabels

()

Defined in base\site3d.js:6151

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

removeLabels

(
  • names
)

Defined in base\site3d.js:6179

Метод удаляет все метки

Parameters:

  • names String[]

    Имена меток для удаления

render

()

Defined in base\site3d.js:6211

Метод вызываемый при рисовании сцены

setRenderOrder

(
  • order
)

Defined in base\site3d.js:6228

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

Parameters:

  • order Number

    Порядковый номер

exportToBlob

(
  • format
)
Blob async

Defined in base\site3d.js:6242

Метод экспортирует модель в различные форматы (GLTF, USDZ)

Parameters:

  • format String

    Формат модели для экспорта

Returns:

Blob:

Результат

download

(
  • fileName
  • format
)
Blob async

Defined in base\site3d.js:6254

Метод экспортирует модель в различные форматы (GLTF, USDZ) и вызывает загрузку в браузере

Parameters:

  • fileName String

    Имя файла при загрузке

  • format String

    Формат модели для экспорта

Returns:

Blob:

Файл модели в формате Blob

optimizePrepare

(
  • options
)
async

Defined in base\site3d.js:6269

Метод подготавливает модель для оптимизации

Parameters:

  • options Object

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

    • sameIdParam - Название параметра в имени меша, по которому можно быстро определять одинаковые меши

optimize

(
  • options
)
Object async

Defined in base\site3d.js:6281

Метод оптимизирует модель

Parameters:

  • options Object

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

Returns:

Object:

Информация об оптимизации

Properties

s3d

Site3d

Defined in base\site3d.js:3846

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

name

String

Defined in base\site3d.js:3856

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

mesh

Mesh

Defined in base\site3d.js:3866

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

parentModel

Site3dModel

Defined in base\site3d.js:3876

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

sides

Number[]

Defined in base\site3d.js:3886

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

size

Number[]

Defined in base\site3d.js:3896

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

volume

Number

Defined in base\site3d.js:3911

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

items

Map

Defined in base\site3d.js:3921

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

eventItems

Map

Defined in base\site3d.js:3931

Свойство возвращает дочерние модели, участвующие в обработке событий

bound

Site3dModelBound

Defined in base\site3d.js:3941

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

edges

Edges

Defined in base\site3d.js:3951

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

labels

Map

Defined in base\site3d.js:3961

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

content

HTMLElement

Defined in base\site3d.js:3971

Свойство возвращает связанный с моделью HTML-элемент с контентом

info

Object

Defined in base\site3d.js:3981

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

isVisible

Boolean

Defined in base\site3d.js:3991

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

isVisible

Unknown

Defined in base\site3d.js:4001

Свойство устанавливает видимость модели

Sub-properties:

isVisibleFrame

Boolean

Defined in base\site3d.js:4018

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

isVisibleFrame

Unknown

Defined in base\site3d.js:4028

Свойство устанавливает видимость границы вокруг модели в виде сетки

Sub-properties:

isVisibleEdges

Boolean

Defined in base\site3d.js:4045

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

isVisibleEdges

Unknown

Defined in base\site3d.js:4055

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

Sub-properties:

isRotate

Boolean

Defined in base\site3d.js:5045

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

log

Object

Defined in base\site3d.js:6307

Метод возвращает объект с информацией о модели