API Docs for:
Show:

Site3dModel Class

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

Базовая 3D-модель в сцене: меш, иерархия, трансформы, экспорт, метки и т.д. Загрузка из файла / blob — см. {@link Site3dImportModel}.

Item Index

Methods

Properties

Methods

getParentModels

() Site3dModel[]

Defined in base\site3d.js:6181

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

Returns:

Site3dModel[]:

Результат

getAllItems

() Site3dModel[]

Defined in base\site3d.js:6210

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

Returns:

Site3dModel[]:

Результат

isItem

(
  • model
)
Boolean

Defined in base\site3d.js:6239

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

Parameters:

Returns:

Boolean:

Результат

isItem

(
  • name
)
Boolean

Defined in base\site3d.js:6250

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

Parameters:

  • name String

    Имя модели

Returns:

Boolean:

Результат

item

(
  • name
)
Site3dModel | null

Defined in base\site3d.js:6261

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

Parameters:

  • name String

    Имя модели

Returns:

Site3dModel | null:

Модель

isModelUnderParent

(
  • modelRoot
)
Boolean

Defined in base\site3d.js:6277

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

Parameters:

  • modelRoot Site3dModel

    Родительская модель

Returns:

Boolean:

Результат

addItem

(
  • model
  • options
)

Defined in base\site3d.js:6305

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

Parameters:

  • model Site3dModel

    Модель

  • options Site3dModelAddItemOptions

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

searchItems

(
  • values
  • options
)
Site3dModel[]

Defined in base\site3d.js:6373

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

Parameters:

  • values String | string

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

  • options Site3dModelSearchItemsOptions

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

Returns:

Site3dModel[]:

Результат

addEventItem

(
  • model
)

Defined in base\site3d.js:6414

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

Parameters:

addEventItems

(
  • models
)

Defined in base\site3d.js:6424

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

Parameters:

isCanTransform

() Boolean

Defined in base\site3d.js:6434

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

Returns:

Boolean:

Результат

setLocalCenter

()

Defined in base\site3d.js:6444

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

setBoundCenter

(
  • options
)

Defined in base\site3d.js:6457

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

Parameters:

  • options Site3dMeshToBoundCenterOptions

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

setVisualCenter

()

Defined in base\site3d.js:6471

Метод сохраняет визуальный центр модели

saveGeometry

()

Defined in base\site3d.js:6485

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

loadGeometry

()

Defined in base\site3d.js:6494

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

setGeometry

(
  • geometry
  • options
)

Defined in base\site3d.js:6503

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

Parameters:

  • geometry BufferGeometry

    Геометрия

  • options Site3dModelSetGeometryOptions

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

setGeometryFromModel

(
  • model
  • options
)

Defined in base\site3d.js:6524

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

Parameters:

  • model Site3dModel

    Модель

  • options Site3dModelSetGeometryOptions

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

updateGeometrySilent

(
  • data
)

Defined in base\site3d.js:6542

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

Parameters:

  • data Site3dModelUpdateGeometryData

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

updateGeometry

(
  • data
)

Defined in base\site3d.js:6560

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

Parameters:

  • data Site3dModelUpdateGeometryData

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

subtractModelBound

(
  • model
)

Defined in base\site3d.js:6575

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

Parameters:

isLoaded

() Boolean

Defined in base\site3d.js:6598

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

Returns:

Boolean:

Результат

show

(
  • options
)

Defined in base\site3d.js:6608

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

Parameters:

  • options Site3dModelVisibilityOptions

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

showSilent

(
  • options
)

Defined in base\site3d.js:6619

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

Parameters:

  • options Site3dModelVisibilityOptions

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

showCallEvent

()

Defined in base\site3d.js:6651

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

hide

(
  • options
)

Defined in base\site3d.js:6660

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

Parameters:

  • options Site3dModelVisibilityOptions

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

hideSilent

(
  • options
)

Defined in base\site3d.js:6671

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

Parameters:

  • options Site3dModelVisibilityOptions

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

hideCallEvent

()

Defined in base\site3d.js:6718

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

setVisibilitySilent

(
  • value
  • options
)

Defined in base\site3d.js:6727

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

Parameters:

  • value Boolean

    Значение

  • options Site3dModelVisibilityOptions

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

remove

()

Defined in base\site3d.js:6745

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

removeSilent

()

Defined in base\site3d.js:6755

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

getLocalBoundCenter

() Site3dPoint3D

Defined in base\site3d.js:6827

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

Returns:

Site3dPoint3D:

Позиция

getWorldBoundCenter

() Site3dPoint3D

Defined in base\site3d.js:6837

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

Returns:

Site3dPoint3D:

Позиция

getPos

() Site3dPoint3D

Defined in base\site3d.js:6847

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

Returns:

Site3dPoint3D:

Позиция

getPrevPos

() Site3dPoint3D

Defined in base\site3d.js:6862

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

Returns:

Site3dPoint3D:

Позиция

getRelativePos

(
  • pos
)
Site3dPoint3D

Defined in base\site3d.js:6877

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

Parameters:

  • pos Site3dPoint3D

    Смещение

Returns:

Site3dPoint3D:

Позиция

getShiftedPos

(
  • pos
)
Site3dPoint3D

Defined in base\site3d.js:6893

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

Parameters:

  • pos Site3dPoint3D

    Смещение

Returns:

Site3dPoint3D:

Позиция

getProjectionPos

(
  • models
)
Site3dPoint3D | undefined

Defined in base\site3d.js:6909

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

Parameters:

Returns:

Site3dPoint3D | undefined:

Позиция проекции

pos

()

Defined in base\site3d.js:6927

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

posSilent

()

Defined in base\site3d.js:6943

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

getCenter

() Site3dPoint3D

Defined in base\site3d.js:6972

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

Returns:

Site3dPoint3D:

Позиция

move

()

Defined in base\site3d.js:6989

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

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

moveSilent

(
  • p1
  • p2
  • p3
  • p4
)
Void

Defined in base\site3d.js:7003

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

Parameters:

  • p1 Site3dPoint3D | number
  • p2 Site3dModelMoveOptions | number=
  • p3 Number=
  • p4 Site3dModelMoveOptions=

Returns:

Void:

movedPos

(
  • p1
  • p2
  • p3
  • p4
)
Site3dPoint3D

Defined in base\site3d.js:7062

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

Parameters:

  • p1 Site3dPoint3D | number
  • p2 Site3dModelMoveOptions | number=
  • p3 Number=
  • p4 Site3dModelMoveOptions=

Returns:

Site3dPoint3D:

getScale

() Site3dPoint3D

Defined in base\site3d.js:7080

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

Returns:

Site3dPoint3D:

Масштаб

getWorldScale

() Site3dPoint3D

Defined in base\site3d.js:7095

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

Returns:

Site3dPoint3D:

Масштаб

scale

()

Defined in base\site3d.js:7110

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

scaleSilent

()

Defined in base\site3d.js:7120

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

zoom

(
  • stepX
  • stepY
  • stepZ
)

Defined in base\site3d.js:7172

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

Parameters:

  • stepX Number

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

  • stepY Number

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

  • stepZ Number

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

zoomSilent

()

Defined in base\site3d.js:7185

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

getRot

() Site3dPoint3D

Defined in base\site3d.js:7205

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

Returns:

Site3dPoint3D:

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

getRotBySides

() Site3dPoint3D

Defined in base\site3d.js:7215

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

Returns:

Site3dPoint3D:

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

rot

()

Defined in base\site3d.js:7225

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

rotSilent

()

Defined in base\site3d.js:7235

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

getRotInit

() Site3dPoint3D

Defined in base\site3d.js:7279

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

Returns:

Site3dPoint3D:

Поворот

setRotInit

(
  • value
)

Defined in base\site3d.js:7296

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

Parameters:

  • value Site3dPoint3D

    Поворот

rotInit

()

Defined in base\site3d.js:7311

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

rotInitSilent

()

Defined in base\site3d.js:7321

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

rotate

(
  • stepX
  • stepY
  • stepZ
  • options
)

Defined in base\site3d.js:7335

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

Parameters:

  • stepX Number

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

  • stepY Number

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

  • stepZ Number

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

  • options Site3dModelRotateOptions

    Параметры:

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

rotateSilent

()

Defined in base\site3d.js:7351

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

rotateUp

()

Defined in base\site3d.js:7365

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

rotateUpSilent

()

Defined in base\site3d.js:7375

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

playRotate

()

Defined in base\site3d.js:7401

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

pauseRotate

()

Defined in base\site3d.js:7410

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

stopRotate

()

Defined in base\site3d.js:7419

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

copyRot

(
  • rot
)

Defined in base\site3d.js:7428

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

Parameters:

  • rot Euler

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

copyRotSilent

(
  • rot
)

Defined in base\site3d.js:7439

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

Parameters:

  • rot Euler

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

copyRotFromModel

(
  • model
)

Defined in base\site3d.js:7449

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

Parameters:

copyRotFromModelSilent

(
  • model
)

Defined in base\site3d.js:7460

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

Parameters:

afterTransform

()

Defined in base\site3d.js:7470

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

fill

(
  • fill
  • load
  • progress
)
async

Defined in base\site3d.js:7478

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

Parameters:

  • fill Site3dFillData

    Наполнение

  • load (() => void)=

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

  • progress ((event: Site3dProgressInfo) => void)=

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

saveMaterialParams

(
  • paramNames
)

Defined in base\site3d.js:7538

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

Parameters:

  • paramNames String

    Названия сохраняемых параметров

restoreMaterialParams

(
  • paramNames
)

Defined in base\site3d.js:7589

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

Parameters:

  • paramNames String

    Названия сохраняемых параметров

cloneMaterial

()

Defined in base\site3d.js:7677

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

getColor

() String

Defined in base\site3d.js:7691

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

Returns:

String:

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

setColor

(
  • color
)

Defined in base\site3d.js:7701

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

Parameters:

  • color String

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

setColorSilent

(
  • color
)

Defined in base\site3d.js:7712

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

Parameters:

  • color String

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

isOneMaterial

() Boolean

Defined in base\site3d.js:7722

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

Returns:

Boolean:

Результат

worldToLocal

(
  • pos
)
Site3dPoint3D

Defined in base\site3d.js:7732

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

Parameters:

  • pos Site3dPoint3D

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

Returns:

Site3dPoint3D:

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

localToWorld

(
  • pos
)
Site3dPoint3D

Defined in base\site3d.js:7746

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

Parameters:

  • pos Site3dPoint3D

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

Returns:

Site3dPoint3D:

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

enableShadows

(
  • actions
)

Defined in base\site3d.js:7760

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

Parameters:

  • actions String

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

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

disableShadows

()

Defined in base\site3d.js:7786

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

enableControls

(
  • options
)

Defined in base\site3d.js:7810

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

Parameters:

  • options Site3dModelControlsOptions

    Параметры:

    • 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:7865

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

connect

(
  • options
)

Defined in base\site3d.js:7876

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

Parameters:

  • options Site3dModelConnectOptions

    Параметры:

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

disconnect

()

Defined in base\site3d.js:7904

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

updateConnect

()

Defined in base\site3d.js:7913

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

intersect

(
  • fromModels
  • options
)
Site3dModelIntersectResult | null

Defined in base\site3d.js:8031

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

Parameters:

  • fromModels Site3dModel[] | null

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

  • options Site3dIntersectModelOptions | null

    Параметры поиска пересечения

Returns:

Site3dModelIntersectResult | null:

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

getHorizontalPlaneIntersectPos

() Site3dPoint3D | null

Defined in base\site3d.js:8043

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

Returns:

Site3dPoint3D | null:

Точка пересечения или null при отсутствии пересечения

getBoundRadius

() Number

Defined in base\site3d.js:8055

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

Returns:

Number:

Результат

getDistanceBetweenPositions

(
  • model
)
Number

Defined in base\site3d.js:8065

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

Parameters:

Returns:

Number:

Результат

getDistanceBetweenPositions

(
  • model
)
Number

Defined in base\site3d.js:8076

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

Parameters:

Returns:

Number:

Результат

getDistanceFromPos

(
  • pos
)
Number

Defined in base\site3d.js:8087

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

Parameters:

  • pos Site3dPoint3D

    Позиция

Returns:

Number:

Результат

getBoundDistanceFromPos

(
  • pos
)
Number

Defined in base\site3d.js:8098

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

Parameters:

  • pos Site3dPoint3D

    Позиция

Returns:

Number:

Результат

getDistanceFromCamera

() Number

Defined in base\site3d.js:8109

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

Returns:

Number:

Результат

getBoundDistanceFromCamera

() Number

Defined in base\site3d.js:8119

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

Returns:

Number:

Результат

updateSidesFromRotation

()

Defined in base\site3d.js:8131

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

getSize

(
  • options
)
Site3dPoint3D

Defined in base\site3d.js:8158

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

Parameters:

  • options Site3dObject3dBoxOptions

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

    • isOnlyVisible - учитывать только видимые части модели

Returns:

Site3dPoint3D:

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

getScreenSize

() Number

Defined in base\site3d.js:8170

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

Returns:

Number:

Массив размеров (ширина и высота)

getScreenSquare

() Number

Defined in base\site3d.js:8180

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

Returns:

Number:

Результат

correctByScreenSize

(
  • options
)
Site3dObject3dScreenCorrectionResult

Defined in base\site3d.js:8190

Метод скрывает части модели, которые занимают слишком мало места на экране

Parameters:

  • options Site3dObject3dScreenCorrectionOptions

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

Returns:

Site3dObject3dScreenCorrectionResult:

Результат

disableCorrectionByScreenSize

() Void

Defined in base\site3d.js:8204

Метод отключает скрытие частей модели, которые занимают слишком мало места на экране

Returns:

Void:

Результат

getSizeBySides

() Site3dPoint3D

Defined in base\site3d.js:8215

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

Returns:

Site3dPoint3D:

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

getVolume

() Number

Defined in base\site3d.js:8225

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

Returns:

Number:

Объем

calcSize

(
  • options
)

Defined in base\site3d.js:8235

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

Parameters:

  • options Site3dObject3dBoxOptions

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

    • isOnlyVisible - учитывать только видимые части модели

getSidePos

(
  • value
)
Site3dPoint3D

Defined in base\site3d.js:8247

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

Parameters:

  • value VectorData | Vector3 | string

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

Returns:

Site3dPoint3D:

Позиция

getMinViewDistance

() Number

Defined in base\site3d.js:8273

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

Returns:

Number:

Расстояние

getViewDistance

(
  • distance
  • options
)
Number

Defined in base\site3d.js:8283

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

Parameters:

  • distance Number | string

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

  • options Site3dModelViewDistanceOptions

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

Returns:

Number:

Расстояние

getPosFromTarget

(
  • posFromModel
  • options
)
Site3dPoint3D

Defined in base\site3d.js:8302

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

Parameters:

  • posFromModel Site3dPosFromTarget

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

  • options Site3dModelViewDistanceOptions

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

Returns:

Site3dPoint3D:

Расстояние

createBound

()

Defined in base\site3d.js:8323

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

createEdges

(
  • options
)

Defined in base\site3d.js:8332

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

Parameters:

  • options Site3dModelEdgesOptions

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

updateEdges

()

Defined in base\site3d.js:8372

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

fillEdges

(
  • options
)

Defined in base\site3d.js:8404

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

Parameters:

  • options Site3dModelEdgesFillInput

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

showEdges

(
  • options
)

Defined in base\site3d.js:8449

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

Parameters:

  • options Site3dModelEdgesOptions

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

hideEdges

(
  • options
)

Defined in base\site3d.js:8480

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

Parameters:

  • options Site3dModelEdgesOptions

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

updateBound

()

Defined in base\site3d.js:8511

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

removeBound

()

Defined in base\site3d.js:8520

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

rebuildBound

()

Defined in base\site3d.js:8534

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

getBoundPosList

() Number[]

Defined in base\site3d.js:8543

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

Returns:

Number[]:

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

getBoundPosListBottom

() Number[]

Defined in base\site3d.js:8558

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

Returns:

Number[]:

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

setFrame

(
  • options
)

Defined in base\site3d.js:8568

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

Parameters:

  • options Site3dModelFrameOptions

    Параметры:

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

showFrame

(
  • options
)

Defined in base\site3d.js:8593

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

Parameters:

  • options Site3dModelFrameOptions

    Параметры:

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

hideFrame

()

Defined in base\site3d.js:8612

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

setOutline

(
  • options
)

Defined in base\site3d.js:8627

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

Parameters:

  • options Site3dModelOutlineOptions

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

showOutline

()

Defined in base\site3d.js:8637

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

hideOutline

()

Defined in base\site3d.js:8646

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

addClipping

(
  • name
  • options
)

Defined in base\site3d.js:8655

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

Parameters:

  • name String

    Имя среза

  • options Site3dObject3dClippingOptions

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

label

(
  • name
  • options
)
Site3dModelLabel

Defined in base\site3d.js:8668

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

Parameters:

  • name String

    Имя метки

  • options Site3dModelLabelOptions

    Параметры:

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

Returns:

Site3dModelLabel:

Результат

removeLabel

(
  • name
)

Defined in base\site3d.js:8700

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

Parameters:

  • name String

    Имя метки

enableLabels

()

Defined in base\site3d.js:8720

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

disableLabels

()

Defined in base\site3d.js:8730

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

addSizeInfo

(
  • name
  • options
)
Site3dModelSizeInfo

Defined in base\site3d.js:8740

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

Parameters:

  • name String

    Имя

  • options Site3dModelSizeInfoOptions

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

Returns:

Site3dModelSizeInfo:

Результат

setSizeInfoVisibility

(
  • name
  • value
)

Defined in base\site3d.js:8758

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

Parameters:

  • name String

    Имя

  • value Boolean

    Значение

setInitEventsActivityLabels

()

Defined in base\site3d.js:8784

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

disableEventsLabels

()

Defined in base\site3d.js:8793

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

updateLabels

()

Defined in base\site3d.js:8802

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

removeLabels

(
  • names
  • isExcept
)

Defined in base\site3d.js:8831

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

Parameters:

  • names String

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

  • isExcept Boolean

    Истина, если удалять все кроме указанных в names

render

()

Defined in base\site3d.js:8873

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

setRenderOrder

(
  • order
)

Defined in base\site3d.js:8890

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

Parameters:

  • order Number

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

exportToBlob

(
  • format
  • options
)
Promise async

Defined in base\site3d.js:8904

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

Parameters:

  • format String

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

  • options Site3dExportToBlobOptions

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

Returns:

Promise:

Результат

download

(
  • fileName
  • format
)
Promise async

Defined in base\site3d.js:8917

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

Parameters:

  • fileName String

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

  • format String

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

Returns:

Promise:

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

optimizePrepare

(
  • options
)
async

Defined in base\site3d.js:8932

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

Parameters:

  • options Site3dObject3dOptimizePrepareOptions

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

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

optimize

(
  • options
)
Site3dObject3dOptimizeInfo async

Defined in base\site3d.js:8944

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

Parameters:

  • options Site3dObject3dOptimizeOptions

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

Returns:

Site3dObject3dOptimizeInfo:

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

connectInside

(
  • options
)

Defined in base\site3d.js:8973

Метод соединяет части модели вдоль заданной оси

Parameters:

  • options Site3dObject3dConnectInsideOptions

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

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

_getValueBySides

(
  • value
)
Number private

Defined in base\site3d.js:9037

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

Parameters:

  • value Number

    Массив значений

Returns:

Number:

Результат

_setGeometry

(
  • geometry
)
protected

Defined in base\site3d.js:9049

Заменяет геометрию меша модели с освобождением старой.

Parameters:

  • geometry BufferGeometry

    Новая геометрия

_rotateLocalRad

(
  • stepX
  • stepY
  • stepZ
)
private

Defined in base\site3d.js:9061

Поворачивает модель в локальных координатах (радианы).

Parameters:

  • stepX Number

    Поворот по X

  • stepY Number

    Поворот по Y

  • stepZ Number

    Поворот по Z

_rotateWorldRad

(
  • stepX
  • stepY
  • stepZ
)
private

Defined in base\site3d.js:9076

Поворачивает модель вокруг мировых осей (радианы).

Parameters:

  • stepX Number

    Поворот по X

  • stepY Number

    Поворот по Y

  • stepZ Number

    Поворот по Z

_isActiveControls

(
  • e
  • events
)
Boolean private

Defined in base\site3d.js:9091

Проверяет, активен ли один из управляющих триггеров модели.

Parameters:

  • e MouseEvent | TouchEvent | WheelEvent

    Событие указателя / тача / колеса

  • events String

    Список условий активности

Returns:

Boolean:

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

_handleEventConditions

(
  • e
)
private

Defined in base\site3d.js:9112

Обрабатывает внутренние состояния взаимодействия модели.

Parameters:

  • e MouseEvent | TouchEvent | WheelEvent

    Событие указателя/тача/колеса

Properties

s3d

Site3d

Defined in base\site3d.js:5894

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

name

String

Defined in base\site3d.js:5904

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

mesh

Site3dModelMesh | null

Defined in base\site3d.js:5914

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

parentModel

Site3dModel | null

Defined in base\site3d.js:5924

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

parentModel

Unknown

Defined in base\site3d.js:5934

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

Sub-properties:

parentModels

Site3dModel[]

Defined in base\site3d.js:5945

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

sides

Site3dPoint3D

Defined in base\site3d.js:5955

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

size

Site3dPoint3D

Defined in base\site3d.js:5965

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

volume

Number

Defined in base\site3d.js:5980

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

items

Map

Defined in base\site3d.js:5990

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

eventItems

Map

Defined in base\site3d.js:6000

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

bound

Site3dModelBound

Defined in base\site3d.js:6010

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

edges

Edges

Defined in base\site3d.js:6020

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

labels

Map

Defined in base\site3d.js:6030

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

content

HTMLElement

Defined in base\site3d.js:6040

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

info

Site3dModelInfo

Defined in base\site3d.js:6050

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

controls

Site3dModelControlsOptions

Defined in base\site3d.js:6060

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

rotateControls

Site3dModelAutoRotateControls

Defined in base\site3d.js:6070

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

connectControls

Site3dModelConnectControls

Defined in base\site3d.js:6080

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

linkControls

Site3dModelLinkControls

Defined in base\site3d.js:6090

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

isVisible

Boolean

Defined in base\site3d.js:6100

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

isVisible

Unknown

Defined in base\site3d.js:6110

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

Sub-properties:

  • value Boolean

    Видимость

isVisibleFrame

Boolean

Defined in base\site3d.js:6127

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

isVisibleFrame

Unknown

Defined in base\site3d.js:6137

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

Sub-properties:

  • value Boolean

    Видимость

isVisibleEdges

Boolean

Defined in base\site3d.js:6154

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

isVisibleEdges

Unknown

Defined in base\site3d.js:6164

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

Sub-properties:

  • value Boolean

    Видимость

isRotate

Boolean

Defined in base\site3d.js:7391

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

log

Site3dModelLog

Defined in base\site3d.js:9018

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