Site3dCircle Class
Класс окружности
Item Index
Methods
- getPosList
- getPosList
- getResizePosList
- load
- subtractModelBound
- getParentModels
- getAllItems
- isItem
- item
- addItem
- searchItems
- addEventItem
- addEventItems
- isCanTransform
- setLocalCenter
- setBoundCenter
- setVisualCenter
- saveGeometry
- loadGeometry
- setGeometry
- setGeometryFromModel
- updateGeometrySilent
- updateGeometry
- isLoaded
- show
- showSilent
- showCallEvent
- hide
- hideSilent
- hideCallEvent
- setVisibilitySilent
- remove
- removeSilent
- getLocalBoundCenter
- getWorldBoundCenter
- getPos
- getPrevPos
- getRelativePos
- getShiftedPos
- getProjectionPos
- pos
- posSilent
- getCenter
- move
- moveSilent
- movedPos
- getScale
- getWorldScale
- scale
- scaleSilent
- zoom
- zoomSilent
- getRot
- getRotBySides
- rot
- rotSilent
- getRotInit
- setRotInit
- rotInit
- rotInitSilent
- rotate
- rotateSilent
- rotateUp
- rotateUpSilent
- playRotate
- pauseRotate
- stopRotate
- copyRot
- copyRotSilent
- copyRotFromModel
- copyRotFromModelSilent
- afterTransform
- fill
- saveMaterialParams
- restoreMaterialParams
- cloneMaterial
- getColor
- setColor
- setColorSilent
- isOneMaterial
- worldToLocal
- localToWorld
- enableShadows
- disableShadows
- enableControls
- disableControls
- connect
- disconnect
- updateConnect
- link
- unlink
- intersect
- getBoundRadius
- getDistanceBetweenPositions
- getDistanceFromCamera
- updateSidesFromRotation
- getSize
- getScreenSize
- getScreenSquare
- correctByScreenSize
- disableCorrectionByScreenSize
- getSizeBySides
- getVolume
- calcSize
- getSidePos
- getMinViewDistance
- getViewDistance
- getPosFromTarget
- createBound
- createEdges
- updateEdges
- fillEdges
- showEdges
- hideEdges
- updateBound
- removeBound
- rebuildBound
- getBoundPosList
- getBoundPosListBottom
- setFrame
- showFrame
- hideFrame
- setOutline
- showOutline
- hideOutline
- addClipping
- label
- removeLabel
- enableLabels
- disableLabels
- addSizeInfo
- setSizeInfoVisibility
- setInitEventsActivityLabels
- disableEventsLabels
- updateLabels
- removeLabels
- render
- setRenderOrder
- exportToBlob
- download
- optimizePrepare
- optimize
- connectInside
Methods
getPosList
-
index
Метод возвращает локальную позицию вершины основания геометрии формы
Parameters:
-
indexNumberИндекс вершины
Returns:
Координаты позиции вершины
getPosList
()
Number[]
Метод возвращает глобальные позиции вершин основания геометрии формы
Returns:
Массив глобальных позиций вершин основания
getResizePosList
-
x -
y -
z
Метод возвращает позиции глобальные вершин основания геометрии формы в результате изменения её размеров вдоль осей координат (если передан null, то вдоль данной оси изменений нет)
Parameters:
-
xNumberРазмер вдоль оси X
-
yNumberРазмер вдоль оси Y
-
zNumberРазмер вдоль оси Z
Returns:
Массив позиций вершин основания
load
-
path -
options
Метод загрузки
Parameters:
-
pathStringПуть до файла модели
-
optionsObjectДополнительные параметры
subtractModelBound
-
model
Метод вычитает из модели геометрию границы другой модели
Parameters:
-
modelSite3dModelВычитаемая модель
getParentModels
()
Site3dModel[]
Метод возвращает массив родительских моделей для данной модели
Returns:
Результат
getAllItems
()
Site3dModel[]
Метод возвращает массив всех дочерних моделей
Returns:
Результат
isItem
-
model
Метод возвращает истину, если переданная модель является самой этой моделью или её частью
Parameters:
-
modelSite3dModelИмя модели
Returns:
Результат
item
-
name
Метод возвращает часть модели
Parameters:
-
nameStringИмя модели
Returns:
Модель
addItem
-
model -
options
Метод добавляет модель
Parameters:
-
modelSite3dModelМодель
-
optionsObjectДополнительные параметры
searchItems
-
values -
options
Метод ищет в модели его части
Parameters:
-
valuesString | stringИмена частей модели (можно указать только части имен)
-
optionsObjectДополнительные параметры
Returns:
Результат
addEventItem
-
model
Метод добавляет модель в список моделей, для которых обрабатываются события
Parameters:
-
modelSite3dModelМодель
addEventItems
-
models
Метод добавляет модели в список моделей, для которых обрабатываются события
Parameters:
-
modelsSite3dModel[]Модели
isCanTransform
()
Boolean
Метод возвращает истину, если можно применять внутренние трансформации к модели
Returns:
Результат
setLocalCenter
-
options
Метод корректирует позиции дочерних элементов модели, чтобы она оказалась в центре локальных координат
Parameters:
-
optionsObjectДополнительные параметры
setBoundCenter
-
options
Метод устанавливает центр геометрии модели
Parameters:
-
optionsObjectДополнительные параметры
setVisualCenter
()
Метод сохраняет визуальный центр модели
saveGeometry
()
Метод сохраняет геометрию модели
loadGeometry
()
Метод загружает геометрию модели
setGeometry
-
geometry -
options
Метод загружает геометрию
Parameters:
-
geometryBufferGeometryГеометрия
-
optionsObjectДополнительные параметры
setGeometryFromModel
-
model -
options
Метод загружает геометрию модели
Parameters:
-
modelSite3dModelМодель
-
optionsObjectДополнительные параметры
updateGeometrySilent
-
data
Метод обновляет геометрию модели без вызова отрисовки
Parameters:
-
dataObjectДанные для обновления геометрии
updateGeometry
-
data
Метод обновляет геометрию модели
Parameters:
-
dataObjectДанные для обновления геометрии
isLoaded
()
Boolean
Метод возвращает истину, если модель загружена
Returns:
Результат
show
-
options
Метод показывает модель
Parameters:
-
optionsObjectДополнительные параметры
showSilent
-
options
Метод показывает модель без вызова отрисовки
Parameters:
-
optionsObjectДополнительные параметры
showCallEvent
()
Метод вызывает событие перерисовки при показе модели
hide
-
options
Метод скрывает модель
Parameters:
-
optionsObjectДополнительные параметры
hideSilent
-
options
Метод скрывает модель без вызова отрисовки
Parameters:
-
optionsObjectДополнительные параметры
hideCallEvent
()
Метод вызывает событие перерисовки при скрытии модели
setVisibilitySilent
-
value -
options
Метод показывает или скрывает модель без вызова отрисовки
Parameters:
-
valueBooleanЗначение
-
optionsObjectДополнительные параметры
remove
()
Метод удаляет модель
removeSilent
()
Метод удаляет модель без вызова отрисовки
getLocalBoundCenter
()
Number
Метод возвращает локальный центр модели
Returns:
Позиция
getWorldBoundCenter
()
Number
Метод возвращает глобальный центр модели
Returns:
Позиция
getPos
()
Number
Метод возвращает позицию модели
Returns:
Позиция
getPrevPos
()
Number
Метод возвращает предыдущую позицию модели
Returns:
Позиция
getRelativePos
-
pos
Метод возвращает позицию, смещенную относительно центра модели
Parameters:
-
posNumberСмещение
Returns:
Позиция
getShiftedPos
-
pos
Метод возвращает позицию, смещенную относительно измененого центра модели
Parameters:
-
posNumberСмещение
Returns:
Позиция
getProjectionPos
-
models
Метод возвращает проекцию точки на модели
Parameters:
-
modelsSite3dModel[]Массив моделей
Returns:
Позиция проекции
pos
()
Метод изменяет позицию модели (передаются координаты в виде трех параметров или массив координат)
posSilent
()
Метод изменяет позицию модели без вызова отрисовки (смотрите описание параметров для метода pos)
getCenter
()
Number
Метод возвращает центр модели
Returns:
Позиция
move
()
Метод перемещает модель. Варианты параметров:
- step – движение в направлении взгляда вдоль плоскости xz
- step, pos – движение в направлении точки pos
- stepX, stepY, stepZ, options – движение по трем осям, где options:
- isLocal – истина, если локальное перемещение (по умолчанию истина)
moveSilent
()
Метод перемещает модель без вызова отрисовки (смотрите описание параметров для метода move)
movedPos
()
Number
Метод возвращает позицию точки, возникшей путем перемещения модели (смотрите описание параметров для метода move)
Returns:
Позиция
getScale
()
Number
Метод возвращает масштаб модели в виде массива значений по трем осям
Returns:
Масштаб
getWorldScale
()
Number
Метод возвращает глобальный масштаб модели в виде массива значений по трем осям
Returns:
Масштаб
scale
()
Метод изменяет масштаб модели (можно задать одно значение для установки одинакового значения по трем осям)
scaleSilent
()
Метод изменяет масштаб модели без вызова отрисовки (можно задать одно значение для установки одинакового значения по трем осям)
zoom
-
stepX -
stepY -
stepZ
Метод изменяет масштаб модели на определенный шаг (можно задать одно значение для равномерного масштабирования по трем осям)
Parameters:
-
stepXNumberШаг масштаба по оси X
-
stepYNumberШаг масштаба по оси Y
-
stepZNumberШаг масштаба по оси Z
zoomSilent
()
Метод изменяет масштаб модели на определенный шаг без вызова отрисовки (можно задать одно значение для равномерного масштабирования по трем осям)
getRot
()
Number
Метод возвращает состояние поворота модели
Returns:
Состояние поворота
getRotBySides
()
Number
Метод возвращает состояние поворота модели в соответствии со сторонами
Returns:
Массив размеров по трем осям
rot
()
Метод устанавливает состояние поворота модели (передаются углы поворота в виде трех параметров или массив углов)
rotSilent
()
Метод устанавливает состояние поворота модели без вызова отрисовки (передаются углы поворота в виде трех параметров или массив углов)
getRotInit
()
Number
Метод возвращает параметры начального состояния поворота модели
Returns:
Поворот
setRotInit
-
value
Метод устанавливает параметры начального состояния поворота модели
Parameters:
-
valueNumberПоворот
rotInit
()
Метод устанавливает начальное состояние поворота модели
rotInitSilent
()
Метод устанавливает начальное состояние поворота модели без вызова отрисовки
rotate
-
stepX -
stepY -
stepZ -
options
Метод поворачивает модель по трем локальным для модели или глобальным осям.
Parameters:
-
stepXNumberУгол поворота вдоль оси X
-
stepYNumberУгол поворота вдоль оси Y
-
stepZNumberУгол поворота вдоль оси Z
-
optionsObjectПараметры:
- isLocal – истина, если оси локальные (по умолчанию истина)
- duration – время анимации
rotateSilent
()
Метод поворачивает модель по трем локальным для модели или глобальным осям без вызова отрисовки (смотрите описание параметров для метода rotate)
rotateUp
()
Метод поворачивает модель вдоль вертикали
rotateUpSilent
()
Метод поворачивает модель вдоль вертикали без вызова отрисовки (смотрите описание параметров для метода rotateUp)
playRotate
()
Метод запускает вращение
pauseRotate
()
Метод ставит вращение на паузу
stopRotate
()
Метод останавливает вращение
copyRot
-
rot
Метод копирует состояние поворота
Parameters:
-
rotEulerСостояние поворота
copyRotSilent
-
rot
Метод копирует состояние поворота без вызова отрисовки
Parameters:
-
rotEulerСостояние поворота
copyRotFromModel
-
model
Метод копирует состояние поворота другой модели
Parameters:
-
modelSite3dModelДругая модель
copyRotFromModelSilent
-
model
Метод копирует состояние поворота другой модели без вызова отрисовки
Parameters:
-
modelSite3dModelДругая модель
afterTransform
()
Метод срабатывает после изменения положения, масштаба или поворота модели
fill
-
fill -
load -
progress
Метод редактирует наполнение (материал)
Parameters:
-
fillObjectНаполнение
-
loadFunctionФункция обработки окончания наполнения
-
progressFunctionФункция обработки процесса загрузки наполнения
saveMaterialParams
-
paramNames
Метод сохраняет параметры материала у модели
Parameters:
-
paramNamesStringНазвания сохраняемых параметров
restoreMaterialParams
-
paramNames
Метод восстанавливает параметры материала у модели
Parameters:
-
paramNamesStringНазвания сохраняемых параметров
cloneMaterial
()
Метод клонирует материал у модели
getColor
()
String
Метод возвращает цвет материала модели
Returns:
Цвет в HEX-формате
setColor
-
color
Метод устанавливает цвет материала модели
Parameters:
-
colorStringЦвет в HEX-формате
setColorSilent
-
color
Метод устанавливает цвет материала модели без вызова отрисовки
Parameters:
-
colorStringЦвет в HEX-формате
isOneMaterial
()
Boolean
Метод возвращает истину, если у модели один материал
Returns:
Результат
worldToLocal
-
pos
Метод переводит глобальные координаты позиции в локальные для данной модели
Parameters:
-
posNumberПозиция в глобальных координатах
Returns:
Позиция в локальных координатах
localToWorld
-
pos
Метод переводит локальные координаты позиции для данной модели в глобальные
Parameters:
-
posNumberПозиция в локальных координатах
Returns:
Позиция в глобальных координатах
enableShadows
-
actions
Метод включает тени от модели
Parameters:
-
actionsStringРежим (по умолчанию «castReceive»):
- «cast» – отбрасывать тени
- «receive» – принимать тени
- «castReceive» – отбрасывать и принимать тени
disableShadows
()
Метод отключает тени от модели
enableControls
-
options
Метод включает управление моделью
Parameters:
-
optionsObjectПараметры:
- 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
()
Метод отключает управление моделью
connect
-
options
Метод соединяет модель с камерой или другой моделью
Parameters:
-
optionsObjectПараметры:
- modelName – имя модели (если пустое значение, то соединение с камерой)
- moveLocal - смещение в рамках локальных осей модели
- rotateLocal – поворот относительно локальных осей
disconnect
()
Метод отключает соединение
updateConnect
()
Метод обновляет соединение (срабатывает при каждой отрисовке)
link
-
options
Метод включает свойства ссылки для модели
Parameters:
-
optionsObjectПараметры:
- click - функция обработки клика (в качестве аргументов возвращает модель (model) и стандартный объект результата клика (event)) или url адрес
- isNewWindow – открыть ссылку в новом окне (актуален, если в качестве параметра click передан url адрес)
- hover - функция обработки события при наведении мышки
- out - функция обработки события при отведении мышки
- move - функция обработки события при движении мышки
- dragStart - функция обработки события при начале перетаскивания модели
- dragMove - функция обработки события при перетаскивании модели
- dragDrop - функция обработки события при завершении перетаскивания модели
- dblclick - функция обработки двойного клика
- hint - строка идентификатора элемента HTML с подсказкой, которая появляется при наведении мышки и исчезает при её отведении
- hintTimeout - время задержки появления подсказки (по умолчанию 0.5 секунд)
- boundHover - истина, если наведение распространяется на область в виде параллелепипеда (по умолчанию false)
unlink
()
Метод отключает свойства ссылки для модели
intersect
-
fromModels -
options
Метод возвращает результат пересечения указателя мыши с текущей моделью
Parameters:
-
fromModelsSite3dModel[] | nullМассив моделей, среди которых искать пересечения (по-умолчанию null - перексечение будет искаться по всей сцене)
-
optionsObjectПараметры:
- isOnlyVisible - истина, если пересечение нужно искать только среди видимых моделей (по-умолчанию истина)
Returns:
Объект результата или null при отсутствии пересечения:
- model - модель, с которой нашлось пересечение
- pos - позиция пересечения
getBoundRadius
()
Number
Метод возвращает радиус сферы, описанной вокруг границы модели
Returns:
Результат
getDistanceBetweenPositions
-
model
Метод возвращает расстояние между позицией модели и позицией другой модели
Parameters:
-
modelSite3dModelМодель
Returns:
Результат
getDistanceFromCamera
()
Number
Метод возвращает расстояние между позицией модели и позицией камеры
Returns:
Результат
updateSidesFromRotation
()
Метод устанавливает соответствие сторон модели осям координат исходя из поворота
getSize
-
options
Метод возвращает размеры модели
Parameters:
-
optionsObjectДополнительные параметры
- isOnlyVisible - учитывать только видимые части модели
Returns:
Массив размеров по трем осям
getScreenSize
()
Number
Метод возвращает размеры модели на экране в пикселях
Returns:
Массив размеров (ширина и высота)
getScreenSquare
()
Number
Метод возвращает площадь модели на экране в пикселях
Returns:
Результат
correctByScreenSize
-
options
Метод скрывает части модели, которые занимают слишком мало места на экране
Parameters:
-
optionsObjectДополнительные параметры
Returns:
Результат
disableCorrectionByScreenSize
()
Object
Метод отключает скрытие частей модели, которые занимают слишком мало места на экране
Returns:
Результат
getSizeBySides
()
Number
Метод возвращает размеры модели в соответствии со сторонами
Returns:
Массив размеров по трем осям
getVolume
()
Number
Метод возвращает объем параллелепипеда, в который вписывается модель
Returns:
Объем
calcSize
-
options
Метод пересчитывает размеры модели
Parameters:
-
optionsObjectДополнительные параметры
- isOnlyVisible - учитывать только видимые части модели
getSidePos
-
value
Метод возвращает позицию относительно центра модели на её боковых границах
Parameters:
-
valueObject | stringСторона границ модели
Returns:
Позиция
getMinViewDistance
()
Number
Метод возвращает минимальное расстояние приближения к модели от её центра
Returns:
Расстояние
getViewDistance
-
distance -
options
Метод возвращает расстояние приближения к модели от её центра
Parameters:
-
distanceNumber | stringДистанция от границ модели (число или процент от минимального расстояния)
-
optionsObjectДополнительные параметры
Returns:
Расстояние
getPosFromTarget
-
posFromModel -
options
Метод возвращает позицию от центра модели из позиции с учетом минимального расстояния приближения до модели
Parameters:
-
posFromModelNumberПозиция относительно модели
-
optionsObjectДополнительные параметры
Returns:
Расстояние
createBound
()
Метод создает границу вокруг модели
createEdges
-
options
Метод создает сетку модели в виде граней
Parameters:
-
optionsObjectДополнительные параметры
updateEdges
()
Метод обновляет сетку модели в виде граней
fillEdges
-
options
Метод наполняет материал сетки модели в виде граней
Parameters:
-
optionsObjectДополнительные параметры
showEdges
-
options
Метод показывает сетку модели в виде граней
Parameters:
-
optionsObjectДополнительные параметры
hideEdges
-
options
Метод скрывает сетку модели в виде граней
Parameters:
-
optionsObjectДополнительные параметры
updateBound
()
Метод обновляет положение границы вокруг модели
removeBound
()
Метод удаляет границу вокруг модели
rebuildBound
()
Метод пересоздает границу вокруг модели
getBoundPosList
()
Number[]
Метод возвращает координаты вершин границы вокруг модели
Returns:
Вершины границы
getBoundPosListBottom
()
Number[]
Метод возвращает координаты нижних вершин границы вокруг модели
Returns:
Вершины границы
setFrame
-
options
Метод устанавливает свойства каркаса границы объекта
Parameters:
-
optionsObjectПараметры:
- color - цвет каркаса в HEX-формате
- thickness - толщина каркаса
showFrame
-
options
Метод показывает каркас границы объекта
Parameters:
-
optionsObjectПараметры:
- color - цвет каркаса в HEX-формате
hideFrame
()
Метод скрывает каркас границы объекта
setOutline
-
options
Метод устанавливает свечение вокруг модели
Parameters:
-
optionsObjectДополнительные параметры
showOutline
()
Метод показывает свечение вокруг модели
hideOutline
()
Метод скрывает свечение вокруг модели
addClipping
-
name -
options
Метод добавляет срез модели
Parameters:
-
nameStringИмя среза
-
optionsObjectДополнительные параметры
label
-
name -
options
Метод добавляет или редактирует метку
Parameters:
-
nameStringИмя метки
-
optionsObjectПараметры:
- content – идентификатор HTML-элемента
- pos – позиция относительно модели (по умолчанию [0, 0, 0])
- text - Текст метки
- isEnabled – истина, если метка видна (по умолчанию истина)
Returns:
Результат
removeLabel
-
name
Метод удаляет метку
Parameters:
-
nameStringИмя метки
enableLabels
()
Метод показывает все метки
disableLabels
()
Метод скрывает все метки
addSizeInfo
-
name -
options
Метод добавляет отображение размеров модели
Parameters:
-
nameStringИмя
-
optionsObjectДополнительные параметры
Returns:
Результат
setSizeInfoVisibility
-
name -
value
Метод устанавливает видимость отображения размеров модели
Parameters:
-
nameStringИмя
-
valueBooleanЗначение
setInitEventsActivityLabels
()
Метод включает события для всех меток
disableEventsLabels
()
Метод выключает события для всех меток
updateLabels
()
Метод обновляет метки (вызывается автоматически в процессе отрисовки)
removeLabels
-
names
Метод удаляет все метки
Parameters:
-
namesStringИмена меток для удаления
render
()
Метод вызываемый при рисовании сцены
setRenderOrder
-
order
Метод устанавливает порядковый номер при рисовании сцены
Parameters:
-
orderNumberПорядковый номер
exportToBlob
-
format -
options
Метод экспортирует модель в различные форматы (GLTF, USDZ)
Parameters:
-
formatStringФормат модели для экспорта
-
optionsObjectДополнительные параметры
Returns:
Результат
download
-
fileName -
format
Метод экспортирует модель в различные форматы (GLTF, USDZ) и вызывает загрузку в браузере
Parameters:
-
fileNameStringИмя файла при загрузке
-
formatStringФормат модели для экспорта
Returns:
Файл модели в формате Blob
optimizePrepare
-
options
Метод подготавливает модель для оптимизации
Parameters:
-
optionsObjectДополнительные параметры:
- sameIdParam - Название параметра в имени меша, по которому можно быстро определять одинаковые меши
optimize
-
options
Метод оптимизирует модель
Parameters:
-
optionsObjectДополнительные параметры
Returns:
Информация об оптимизации
connectInside
-
options
Метод соединяет части модели вдоль заданной оси
Parameters:
-
optionsObjectДополнительные параметры:
- axis - Ось, вдоль которой происходит соединение (по умолчанию Y)
Properties
format
String
Свойство возвращает формат модели
path
String
Свойство возвращает путь до модели
path
Unknown
Свойство устанавливает путь до модели
Sub-properties:
-
valueStringПуть до модели
isAnim
Boolean
Свойство возвращает истину, если есть анимация
anims
Array
Свойство возвращает массив анимаций
name
String
Свойство возвращает имя модели
mesh
Object3D
Свойство возвращает меш модели
sides
Number
Свойство возвращает соответствие сторон осям координат
size
Number
Свойство возвращает размеры модели
volume
Number
Свойство возвращает объем параллелепипеда, в который вписывается модель
items
Map
Свойство возвращает дочерние модели
eventItems
Map
Свойство возвращает дочерние модели, участвующие в обработке событий
edges
Edges
Свойство возвращает сетку модели в виде граней
labels
MapСвойство возвращает метки модели
content
HTMLElement
Свойство возвращает связанный с моделью HTML-элемент с контентом
info
Object
Свойство возвращает информацию о модели
controls
Object
Свойство возвращает объект управления моделью
rotateControls
Object
Свойство возвращает объект настроек вращения модели
connectControls
Object
Свойство возвращает объект настроек привязки модели к другим моделям
isVisible
Boolean
Свойство возвращает истину, если модель видима
isVisibleFrame
Boolean
Свойство возвращает истину, если граница вокруг модели в виде сетки видима
isVisibleEdges
Boolean
Свойство возвращает истину, если видна сетка модели в виде граней
isRotate
Boolean
Свойство возвращает истину, если модель вращается
log
Object
Метод возвращает объект с информацией о модели
