API Docs for:
Show:

Site3dThree Class

Defined in: base\site3d_dev.js:1
Module: Site3d

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

Constructor

Site3dThree

(
  • scene
)

Defined in base\site3d_dev.js:1

Parameters:

  • scene Scene

    Объект сцены

Item Index

Methods

Properties

Methods

getCameraFrustum

() Frustum

Defined in base\site3d.js:12254

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

Returns:

Frustum:

Результат

getCameraTarget

(
  • distance
)
Vector3

Defined in base\site3d.js:12267

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

Parameters:

  • distance Number

    Дистанция

Returns:

Vector3:

Результат

getVectorProjectionOnSegment

(
  • vector
  • segment
)
Vector3

Defined in base\site3d.js:12281

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

Parameters:

  • vector Vector3

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

  • segment Vector3

    Отрезок

Returns:

Vector3:

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

getObject3dParents

(
  • object3d
)
Object3D

Defined in base\site3d.js:12310

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object3D:

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

getObject3dLastParent

(
  • object3d
)
Object3D

Defined in base\site3d.js:12340

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object3D:

Объект three.js

getObject3dBox

(
  • object3d
  • options
)
Box3

Defined in base\site3d.js:12352

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

Returns:

Box3:

Результат

getObject3dSize

(
  • object3d
  • options
)
Number

Defined in base\site3d.js:12398

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

Returns:

Number:

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

getObject3dRelativeVector

(
  • object3d
  • vector
)
Vector3

Defined in base\site3d.js:12436

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

Parameters:

  • object3d Object3D

    Объект three.js

  • vector Vector3

    Смещение

Returns:

Vector3:

Результат

isVectorInCamera

(
  • vector3
)
Boolean

Defined in base\site3d.js:12454

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

Parameters:

  • vector3 Vector3

    Вектор three.js

Returns:

Boolean:

Результат

getVectorScreenInfo

(
  • vector
  • options
)
Object

Defined in base\site3d.js:12465

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

Parameters:

  • vector Vector3

    Вектор three.js

  • options Object

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

Returns:

Object:

Результат

getVectorsScreenInfo

(
  • vectors
  • options
)
Object

Defined in base\site3d.js:12490

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

Parameters:

  • vectors Vector3

    Векторы three.js

  • options Object

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

Returns:

Object:

Результат

getBoxVectors

(
  • box3
)
Vector3

Defined in base\site3d.js:12546

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

Parameters:

  • box3 Box3

    Бокс three.js

Returns:

Vector3:

Результат

getBoxMinDistance

(
  • vectors
  • vectorFrom
)
Object

Defined in base\site3d.js:12569

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

Parameters:

  • vectors Vector3

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

  • vectorFrom Vector3

    Объект Vector3

Returns:

Object:

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

isBoxInCamera

(
  • box
)
Boolean

Defined in base\site3d.js:12591

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

Parameters:

  • box Box3

    Бокс three.js

Returns:

Boolean:

Результат

isBoxVectorsInCamera

(
  • vectors
)
Boolean

Defined in base\site3d.js:12602

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

Parameters:

  • vectors Vector3

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

Returns:

Boolean:

Результат

getObject3dScreenInfo

(
  • object3d
)
Object

Defined in base\site3d.js:12614

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object:

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

getObject3dScreenSize

(
  • object3d
)
Number

Defined in base\site3d.js:12635

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Number:

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

getObject3dScreenSquare

(
  • object3d
)
Number

Defined in base\site3d.js:12646

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Number:

Результат

correctObject3dByScreenSize

(
  • object3d
  • options
)
Object

Defined in base\site3d.js:12657

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

Returns:

Object:

Результат

disableObject3dCorrectionByScreenSize

(
  • object3d
)

Defined in base\site3d.js:12702

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

Parameters:

  • object3d Object3D

    Объект three.js

getObject3dVolume

(
  • object3d
)
Number

Defined in base\site3d.js:12721

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Number:

Результат

getObject3dWorldCenter

(
  • object3d
)
Vector3

Defined in base\site3d.js:12733

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Vector3:

Центр

getObject3dLocalCenter

(
  • object3d
)
Vector3

Defined in base\site3d.js:12744

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Vector3:

Центр

getObject3dWorldInfo

(
  • object3d
)
Object

Defined in base\site3d.js:12755

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object:

Результат

object3dAsOtherGlobal

(
  • object3dResult
  • object3dSource
  • options
)

Defined in base\site3d.js:12776

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

Parameters:

  • object3dResult Object3D

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

  • object3dSource Object3D

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

  • options Object

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

getObject3dMeshes

(
  • object3d
  • options
)
Mesh

Defined in base\site3d.js:12810

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

Returns:

Mesh:

Массив мешей

object3dClone

(
  • object3d
)
Object3D

Defined in base\site3d.js:12840

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Object3D:

Новый объект

object3dGeometriesMerge

(
  • object3d
)
BufferGeometry

Defined in base\site3d.js:12867

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

BufferGeometry:

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

isCanObject3dTransform

(
  • object3d
)
Boolean

Defined in base\site3d.js:12892

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

Parameters:

  • object3d Object3D

    Объект three.js

Returns:

Boolean:

Результат

object3dToLocalCenter

(
  • object3d
  • options
)

Defined in base\site3d.js:12903

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

object3dToBoundCenter

(
  • object3d
  • options
)

Defined in base\site3d.js:12915

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

setObject3dColor

(
  • object3d
  • color
  • options
)

Defined in base\site3d.js:12934

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

Parameters:

  • object3d Object3D

    Объект three.js

  • color String

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

  • options Object

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

getObject3dSameMeshes

(
  • object3d
  • options
)
Promise async

Defined in base\site3d.js:12947

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

Returns:

Promise:

Массив мешей

getObject3dOptimizeParamValue

(
  • object3d
  • param
)
String

Defined in base\site3d.js:13036

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

Parameters:

  • object3d Object3D

    Объект three.js

  • param String

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

Returns:

String:

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

setObject3dOptimizeParamValue

(
  • object3d
  • param
  • value
)

Defined in base\site3d.js:13048

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

Parameters:

  • object3d Object3D

    Объект three.js

  • param String

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

  • value String

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

getObject3dOptimizeParam

(
  • object3d
  • param
)
String

Defined in base\site3d.js:13060

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

Parameters:

  • object3d Object3D

    Объект three.js

  • param String

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

Returns:

String:

Параметр

object3dOptimizePrepare

(
  • object3d
  • options
)
async

Defined in base\site3d.js:13072

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

object3dOptimize

(
  • object3d
  • options
)
Object async

Defined in base\site3d.js:13128

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

Returns:

Object:

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

object3dConnectInside

(
  • object3d
  • options
)

Defined in base\site3d.js:13358

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

getObject3dClipping

(
  • object3d
  • options
)

Defined in base\site3d.js:13424

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

updateObject3dClipping

(
  • object3d
)

Defined in base\site3d.js:13498

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

Parameters:

  • object3d Object3D

    Объект среза

getGroupMeshes

(
  • group
)
Mesh

Defined in base\site3d.js:13515

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

Parameters:

  • group Group

    Группа

Returns:

Mesh:

Массив мешей

getChildGroupByName

(
  • parentGroup
  • childGroupName
)
Group

Defined in base\site3d.js:13526

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

Parameters:

  • parentGroup Group

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

  • childGroupName String

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

Returns:

Group:

Группа

meshInitParams

(
  • mesh
)

Defined in base\site3d.js:13548

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

Parameters:

  • mesh Mesh

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

getMeshMaterials

(
  • mesh
)
Material

Defined in base\site3d.js:13562

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

Parameters:

  • mesh Mesh

    Меш

Returns:

Material:

Материалы

setMeshColor

(
  • mesh
  • color
  • options
)

Defined in base\site3d.js:13573

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

Parameters:

  • mesh Mesh | InstancedMesh

    Меш

  • color String

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

  • options Object

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

meshClone

(
  • mesh
)
Mesh

Defined in base\site3d.js:13603

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

Parameters:

  • mesh Mesh

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

Returns:

Mesh:

Новый меш

meshesMerge

(
  • meshes
  • options
)
Mesh

Defined in base\site3d.js:13629

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

Parameters:

  • meshes Mesh

    Массив мешей

  • options Object

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

Returns:

Mesh:

Меш

meshSimplify

(
  • mesh
  • percent
)

Defined in base\site3d.js:13672

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

Parameters:

  • mesh Mesh

    Меш

  • percent Number

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

meshToBoundCenter

(
  • mesh
  • options
)
Vector3

Defined in base\site3d.js:13689

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

Parameters:

  • mesh Mesh

    Меш

  • options Object

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

Returns:

Vector3:

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

meshAsTriangle

(
  • mesh
  • triangleGeometry
)

Defined in base\site3d.js:13739

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

Parameters:

  • mesh Mesh

    Меш

  • triangleGeometry BufferGeometry

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

compareMeshes

(
  • meshes
  • options
)
Boolean

Defined in base\site3d.js:13756

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

Parameters:

  • meshes Mesh

    Меши

  • options Object

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

Returns:

Boolean:

Результат

geometriesMerge

(
  • geometries
  • useGroups
)
BufferGeometry

Defined in base\site3d.js:13836

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

Parameters:

  • geometries BufferGeometry

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

  • useGroups Boolean

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

Returns:

BufferGeometry:

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

geometriesAttributesMerge

(
  • attributes
)
BufferAttribute

Defined in base\site3d.js:14042

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

Parameters:

  • attributes BufferAttribute

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

Returns:

BufferAttribute:

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

geometrySimplify

(
  • geometry
  • percent
)
BufferGeometry

Defined in base\site3d.js:14109

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

Parameters:

  • geometry BufferGeometry

    Геометрия

  • percent Number

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

Returns:

BufferGeometry:

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

getTriangleGeometry

(
  • v1
  • v2
  • v3
)
BufferGeometry

Defined in base\site3d.js:14136

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

Parameters:

  • v1 Vector3

    Вершина 1

  • v2 Vector3

    Вершина 2

  • v3 Vector3

    Вершина 3

Returns:

BufferGeometry:

Геометрия

getTriangleMesh

(
  • v1
  • v2
  • v3
  • material
)
Mesh

Defined in base\site3d.js:14153

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

Parameters:

  • v1 Vector3

    Вершина 1

  • v2 Vector3

    Вершина 2

  • v3 Vector3

    Вершина 3

  • material Material

    Материал

Returns:

Mesh:

Меш

getTriangleNormal

(
  • geometry
)
Vector3

Defined in base\site3d.js:14177

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

Parameters:

  • geometry BufferGeometry

    Геометрия

Returns:

Vector3:

Нормаль

getTriangleVertices

(
  • geometry
)
Vector3

Defined in base\site3d.js:14189

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

Parameters:

  • geometry BufferGeometry

    Геометрия

Returns:

Vector3:

Вершины

getTriangleCenter

(
  • geometry
)
Vector3

Defined in base\site3d.js:14208

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

Parameters:

  • geometry BufferGeometry

    Геометрия

Returns:

Vector3:

Центр

getQuaternionBetweenTriangles

(
  • geometry1
  • geometry2
)
Quaternion

Defined in base\site3d.js:14221

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

Parameters:

  • geometry1 BufferGeometry

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

  • geometry2 BufferGeometry

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

Returns:

Quaternion:

Поворот

getPlaneFromPoints

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

Defined in base\site3d.js:14235

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

Parameters:

  • width Number

    Ширина

  • height Number

    Высота

  • v1 Vector3

    Вершина 1

  • v2 Vector3

    Вершина 2

  • v3 Vector3

    Вершина 3

  • material Material

    Материал

Returns:

Mesh:

Меш

getPointProjection

(
  • point
  • objects
)
Vector3 | undefined

Defined in base\site3d.js:14261

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

Parameters:

  • point Vector3

    Точка

  • objects Object3D

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

Returns:

Vector3 | undefined:

Точка

exportToBlob

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

Defined in base\site3d.js:14286

Метод экспортирует объект 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:14369

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

Returns:

BoxHelper:

Объект BoxHelper

getBoundBox

(
  • object3d
  • options
)
Mesh

Defined in base\site3d.js:14392

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

Returns:

Mesh:

Меш

addBoundBox

(
  • object3d
  • options
)
Mesh

Defined in base\site3d.js:14418

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

Returns:

Mesh:

Меш

updateTexture

(
  • texture
  • options
)
Texture | CanvasTexture

Defined in base\site3d.js:14437

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

Parameters:

  • texture Texture | CanvasTexture

    Текстура

  • options Object

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

Returns:

Texture | CanvasTexture:

Результат

createTextTexture

(
  • texture
  • options
)
Texture | CanvasTexture

Defined in base\site3d.js:14502

Метод создает текстуру из текста

Parameters:

  • texture Texture | CanvasTexture

    Текстура

  • options Object

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

Returns:

Texture | CanvasTexture:

Результат

disposeMaterial

(
  • material
)

Defined in base\site3d.js:14591

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

Parameters:

  • material Material

    Материал

disposeObject3d

(
  • object3d
)

Defined in base\site3d.js:14624

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

Parameters:

  • object3d Object3D

    Объект three.js

setOptions

(
  • optionsCur
  • options
)
Object

Defined in base\site3d.js:14654

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

Parameters:

  • optionsCur Object

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

  • options Object

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

Returns:

Object:

Результат

getObject3dMeshes

(
  • object3d
  • options
)
Mesh

Defined in base\site3d_dev.js:9

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

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

Returns:

Mesh:

Массив мешей

object3dToBoundCenter

(
  • object3d
  • options
)

Defined in base\site3d_dev.js:39

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

Parameters:

  • object3d Object3D

    Объект three.js

  • options Object

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

meshInitParams

(
  • mesh
)

Defined in base\site3d_dev.js:53

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

Parameters:

  • mesh Mesh

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

meshToBoundCenter

(
  • mesh
  • options
)
Vector3

Defined in base\site3d_dev.js:67

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

Parameters:

  • mesh Mesh

    Меш

  • options Object

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

Returns:

Vector3:

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

Properties

simplifyModifier

Object

Defined in base\site3d.js:12230

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

OS

String

Defined in base\site3d.js:14808

Свойство возвращает операционную систему

isMobile

Boolean

Defined in base\site3d.js:14818

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