API Docs for: 1.0.0
Show:

Site3dThree Class

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

Класс операций над объектами three.js

Constructor

Site3dThree

(
  • scene
)

Defined in base\site3d.js:10605

Parameters:

  • scene Scene

    Объект сцены

Methods

getCameraFrustum

() Frustum

Defined in base\site3d.js:10648

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

Returns:

Frustum:

Результат

getCameraTarget

(
  • distance
)
Vector3

Defined in base\site3d.js:10661

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

Parameters:

  • distance Number

    Дистанция

Returns:

Vector3:

Результат

getVectorProjectionOnSegment

(
  • vector
  • segment
)
Vector3

Defined in base\site3d.js:10675

Метод возвращает проекцию точки на прямую, образованную отрезком

Parameters:

  • vector Vector3

    Проецируемая точка

  • segment Vector3

    Отрезок

Returns:

Vector3:

Спроецированная точка

getObject3dParents

(
  • object3d
)
Object3D

Defined in base\site3d.js:10704

Метод возвращает массив родительских объектов для данного объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object3D:

Массив объектов three.js

getObject3dLastParent

(
  • object3d
)
Object3D

Defined in base\site3d.js:10734

Метод возвращает последний родительский объект для данного объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object3D:

Объект three.js

getObject3dBox

(
  • object3d
)
Box3

Defined in base\site3d.js:10746

Метод возвращает Box3 объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Box3:

Результат

getObject3dSize

(
  • object3d
)
Number[]

Defined in base\site3d.js:10757

Метод возвращает размеры объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Number[]:

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

getObject3dRelativeVector

(
  • object3d
  • vector
)
Vector3

Defined in base\site3d.js:10793

Метод возвращает вектор, смещенный относительно центра объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • vector Vector3

    Смещение

Returns:

Vector3:

Результат

isVectorInCamera

(
  • vector3
)
Boolean

Defined in base\site3d.js:10811

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

Parameters:

  • vector3 Vector3

    Вектор three.js

Returns:

Boolean:

Результат

getVectorScreenInfo

(
  • vector
  • options
)
Object

Defined in base\site3d.js:10822

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

Parameters:

  • vector Vector3

    Вектор three.js

  • options Object

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

Returns:

Object:

Результат

getBoxVectors

(
  • box3
)
Vector3

Defined in base\site3d.js:10847

Метод возвращает массив векторов бокса

Parameters:

  • box3 Box3

    Бокс three.js

Returns:

Vector3:

Результат

getBoxMinDistance

(
  • vectors
  • vectorFrom
)
Object

Defined in base\site3d.js:10870

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

Parameters:

  • vectors Vector3

    Массив векторов бокса

  • vectorFrom Vector3

    Объект Vector3

Returns:

Object:

Результат {vector, distance}

isBoxInCamera

(
  • box
)
Boolean

Defined in base\site3d.js:10892

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

Parameters:

  • box Box3

    Бокс three.js

Returns:

Boolean:

Результат

isBoxVectorsInCamera

(
  • vectors
)
Boolean

Defined in base\site3d.js:10903

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

Parameters:

  • vectors Vector3

    Векторы боксов three.js

Returns:

Boolean:

Результат

getObject3dScreenInfo

(
  • object3d
)
Object

Defined in base\site3d.js:10915

Метод возвращает информацию об объекте three.js по отношению к экрану

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object:

Результат в формате {size, square, distance}

getObject3dScreenSize

(
  • object3d
)
Number[]

Defined in base\site3d.js:10975

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Number[]:

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

getObject3dScreenSquare

(
  • object3d
)
Number

Defined in base\site3d.js:10986

Метод возвращает площадь объекта three.js на экране в пикселях

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Number:

Результат

correctObject3dByScreenSize

(
  • object3d
  • options
)
Object

Defined in base\site3d.js:10997

Метод скрывает меши объекта three.js, которые занимают слишком мало места на экране

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

Returns:

Object:

Результат

disableObject3dCorrectionByScreenSize

(
  • object3d
)

Defined in base\site3d.js:11043

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

Parameters:

  • object3d Object3D

    Объект three.js

getObject3dVolume

(
  • object3d
)
Number

Defined in base\site3d.js:11062

Метод возвращает объем параллелепипеда объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Number:

Результат

getObject3dWorldCenter

(
  • object3d
)
Vector3

Defined in base\site3d.js:11074

Метод возвращает глобальную позицию объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Vector3:

Центр

getObject3dLocalCenter

(
  • object3d
)
Vector3

Defined in base\site3d.js:11085

Метод возвращает локальную позицию объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Vector3:

Центр

getObject3dWorldInfo

(
  • object3d
)
Object

Defined in base\site3d.js:11096

Метод возвращает мировую информацию об объекте three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object:

Результат

object3dCenter

(
  • object3d
)

Defined in base\site3d.js:11117

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

Parameters:

  • object3d Object3D

    Объект three.js

object3dAsOtherGlobal

(
  • object3dResult
  • object3dSource
  • options
)

Defined in base\site3d.js:11127

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

Parameters:

  • object3dResult Object3D

    Текущий объект three.js

  • object3dSource Object3D

    Другой объект three.js

  • options Object

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

getObject3dMeshes

(
  • object3d
  • options
)
Mesh

Defined in base\site3d.js:11161

Метод возвращает массив мешей объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

    • exceptions - массив имен мешей для исключения

Returns:

Mesh:

Массив мешей

object3dClone

(
  • object3d
)
Object3D

Defined in base\site3d.js:11191

Метод клонирует объект three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object3D:

Новый объект

object3dGeometriesMerge

(
  • object3d
)
BufferGeometry

Defined in base\site3d.js:11218

Метод возвращает геометрию объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

BufferGeometry:

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

isCanObject3dToBoundCenter

(
  • object3d
)
Boolean

Defined in base\site3d.js:11243

Метод возвращает истину, если возможно устанавливать позицию объекта three.js в его геометрическом центре

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Boolean:

Результат

object3dToBoundCenter

(
  • object3d
  • options
)

Defined in base\site3d.js:11259

Метод устанавливает позицию объекта three.js в его геометрическом центре

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

setObject3dColor

(
  • object3d
  • color
  • options
)

Defined in base\site3d.js:11289

Метод устанавливает цвет объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • color String

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

  • options Object

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

getObject3dSameMeshes

(
  • object3d
  • options
)
Promise async

Defined in base\site3d.js:11302

Метод возвращает одинаковые меши объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

Returns:

Promise:

Массив мешей

getObject3dOptimizeParamValue

(
  • object3d
  • param
)
String

Defined in base\site3d.js:11391

Метод возвращает значение параметра оптимизации объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • param String

    Имя параметра

Returns:

String:

Значение параметра

setObject3dOptimizeParamValue

(
  • object3d
  • param
  • value
)

Defined in base\site3d.js:11403

Метод устанавливает значение параметра оптимизации объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • param String

    Имя параметра

  • value String

    Значение параметра

getObject3dOptimizeParam

(
  • object3d
  • param
)
String

Defined in base\site3d.js:11415

Метод возвращает параметр оптимизации объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • param String

    Имя параметра

Returns:

String:

Параметр

object3dOptimizePrepare

(
  • object3d
  • options
)
async

Defined in base\site3d.js:11427

Метод подготавливает объект three.js для оптимизации

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

object3dOptimize

(
  • object3d
  • options
)
Object async

Defined in base\site3d.js:11483

Метод оптимизирует объект three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

Returns:

Object:

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

getObject3dClipping

(
  • object3d
  • options
)

Defined in base\site3d.js:11714

Метод возвращает объект среза объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

updateObject3dClipping

(
  • object3d
)

Defined in base\site3d.js:11788

Метод обновляет объект среза объекта three.js

Parameters:

  • object3d Object3D

    Объект среза

getGroupMeshes

(
  • group
)
Mesh

Defined in base\site3d.js:11805

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

Parameters:

  • group Group

    Группа

Returns:

Mesh:

Массив мешей

getChildGroupByName

(
  • parentGroup
  • childGroupName
)
Group

Defined in base\site3d.js:11816

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

Parameters:

  • parentGroup Group

    Родительская группа

  • childGroupName String

    Имя подгруппы

Returns:

Group:

Группа

meshInitParams

(
  • mesh
)

Defined in base\site3d.js:11838

Метод инициализирует начальные параметры меша

Parameters:

  • mesh Mesh

    Клонируемый еши

getMeshMaterials

(
  • mesh
)
Material

Defined in base\site3d.js:11852

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

Parameters:

  • mesh Mesh

    Меш

Returns:

Material:

Материалы

setMeshColor

(
  • mesh
  • color
  • options
)

Defined in base\site3d.js:11863

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

Parameters:

  • mesh Mesh | InstancedMesh

    Меш

  • color String

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

  • options Object

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

meshClone

(
  • mesh
)
Mesh

Defined in base\site3d.js:11893

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

Parameters:

  • mesh Mesh

    Клонируемый меш

Returns:

Mesh:

Новый меш

meshesMerge

(
  • meshes
  • options
)
Mesh

Defined in base\site3d.js:11919

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

Parameters:

  • meshes Mesh

    Массив мешей

  • options Object

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

Returns:

Mesh:

Меш

meshSimplify

(
  • mesh
  • percent
)

Defined in base\site3d.js:11962

Метод упрощает геометрию меша

Parameters:

  • mesh Mesh

    Меш

  • percent Number

    Процент оставшейся геометрии

meshToBoundCenter

(
  • mesh
  • options
)
Vector3

Defined in base\site3d.js:11979

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

Parameters:

  • mesh Mesh

    Меш

  • options Object

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

Returns:

Vector3:

Новая позиция меша

meshAsTriangle

(
  • mesh
  • triangleGeometry
)

Defined in base\site3d.js:12029

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

Parameters:

  • mesh Mesh

    Меш

  • triangleGeometry BufferGeometry

    Геометрия треугольника

compareMeshes

(
  • meshes
  • options
)
Boolean

Defined in base\site3d.js:12046

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

Parameters:

  • meshes Mesh

    Меши

  • options Object

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

Returns:

Boolean:

Результат

geometriesMerge

(
  • geometries
  • useGroups
)
BufferGeometry

Defined in base\site3d.js:12127

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

Parameters:

  • geometries BufferGeometry

    Соединяющиеся геометрии

  • useGroups Boolean

    Использовать ли группы

Returns:

BufferGeometry:

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

geometriesAttributesMerge

(
  • attributes
)
BufferAttribute

Defined in base\site3d.js:12333

Метод возвращает атрибут геометрии из соединения других атрибутов

Parameters:

  • attributes BufferAttribute

    Соединяющиеся атрибуты

Returns:

BufferAttribute:

Новый атрибут

geometrySimplify

(
  • geometry
  • percent
)
BufferGeometry

Defined in base\site3d.js:12400

Метод возвращает упрощенную геометрию

Parameters:

  • geometry BufferGeometry

    Геометрия

  • percent Number

    Процент оставшейся геометрии

Returns:

BufferGeometry:

Упрощенная геометрия

getTriangleGeometry

(
  • v1
  • v2
  • v3
)
BufferGeometry

Defined in base\site3d.js:12427

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

Parameters:

  • v1 Vector3

    Вершина 1

  • v2 Vector3

    Вершина 2

  • v3 Vector3

    Вершина 3

Returns:

BufferGeometry:

Геометрия

getTriangleMesh

(
  • v1
  • v2
  • v3
  • material
)
Mesh

Defined in base\site3d.js:12444

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

Parameters:

  • v1 Vector3

    Вершина 1

  • v2 Vector3

    Вершина 2

  • v3 Vector3

    Вершина 3

  • material Material

    Материал

Returns:

Mesh:

Меш

getTriangleNormal

(
  • geometry
)
Vector3

Defined in base\site3d.js:12468

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

Parameters:

  • geometry BufferGeometry

    Геометрия

Returns:

Vector3:

Нормаль

getTriangleVertices

(
  • geometry
)
Vector3

Defined in base\site3d.js:12480

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

Parameters:

  • geometry BufferGeometry

    Геометрия

Returns:

Vector3:

Вершины

getTriangleCenter

(
  • geometry
)
Vector3

Defined in base\site3d.js:12499

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

Parameters:

  • geometry BufferGeometry

    Геометрия

Returns:

Vector3:

Центр

getQuaternionBetweenTriangles

(
  • geometry1
  • geometry2
)
Quaternion

Defined in base\site3d.js:12512

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

Parameters:

  • geometry1 BufferGeometry

    Геометрия первого треугольника

  • geometry2 BufferGeometry

    Геометрия второго треугольника

Returns:

Quaternion:

Поворот

getPlaneFromPoints

(
  • width
  • height
  • v1
  • v2
  • v3
  • material
)
Mesh

Defined in base\site3d.js:12526

Метод возвращает плоскость на основе трех точек

Parameters:

  • width Number

    Ширина

  • height Number

    Высота

  • v1 Vector3

    Вершина 1

  • v2 Vector3

    Вершина 2

  • v3 Vector3

    Вершина 3

  • material Material

    Материал

Returns:

Mesh:

Меш

getPointProjectionOnTriangle

(
  • point
  • mesh
)
Vector3 | undefined

Defined in base\site3d.js:12552

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

Parameters:

  • point Vector3

    Точка

  • mesh Mesh

    Меш треугольника

Returns:

Vector3 | undefined:

Точка

exportToBlob

(
  • object3d
  • format
  • options
)
Blob | null async

Defined in base\site3d.js:12577

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

Parameters:

  • object3d Object3D

    Объект three.js

  • format String

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

  • options Object

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

Returns:

Blob | null:

Результат

addBoxHelper

(
  • object3d
  • options
)
BoxHelper

Defined in base\site3d.js:12648

Метод добавляет BoxHelper на сцену и возвращает его

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

Returns:

BoxHelper:

Объект BoxHelper

getBoundBox

(
  • object3d
  • options
)
Mesh

Defined in base\site3d.js:12671

Метод возвращает меш по границам объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

Returns:

Mesh:

Меш

addBoundBox

(
  • object3d
  • options
)
Mesh

Defined in base\site3d.js:12697

Метод добавляет меш по границам объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

Returns:

Mesh:

Меш

updateTexture

(
  • texture
  • options
)
Texture | CanvasTexture

Defined in base\site3d.js:12716

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

Parameters:

  • texture Texture | CanvasTexture

    Текстура

  • options Object

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

Returns:

Texture | CanvasTexture:

Результат

disposeMaterial

(
  • material
)

Defined in base\site3d.js:12776

Метод уничтожения материала

Parameters:

  • material Material

    Материал

disposeObject3d

(
  • object3d
)

Defined in base\site3d.js:12809

Метод уничтожения объекта three.js

Parameters:

  • object3d Object3D

    Объект three.js

setOptions

(
  • optionsCur
  • options
)
Object

Defined in base\site3d.js:12839

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

Parameters:

  • optionsCur Object

    Параметры по умолчанию

  • options Object

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

Returns:

Object:

Результат

Properties

simplifyModifier

Object

Defined in base\site3d.js:10624

Свойство возвращает объект SimplifyModifier