API Docs for:
Show:

Site3d Class

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

Класс сцены

Constructor

Site3d

(
  • canvasId
  • options
)

Defined in base\site3d.js:996

Parameters:

  • canvasId String
    • Идентификатор тега canvas
  • options Site3dSceneOptions
    • Параметры сцены

Item Index

Methods

Properties

Methods

load

(
  • url
  • onLoad
  • onProgress
  • onError
)

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:29

Load 3ds file from url.

Parameters:

  • url type

    URL for the file.

  • onLoad Function

    onLoad callback, receives group Object3D as argument.

  • onProgress Function

    onProgress callback.

  • onError Function

    onError callback.

parse

(
  • arraybuffer
  • path
)
Group

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:83

Parse arraybuffer data and load 3ds file.

Parameters:

  • arraybuffer ArrayBuffer

    Arraybuffer data to be loaded.

  • path String

    Path for external resources.

Returns:

Group:

Group loaded from 3ds file.

readFile

(
  • arraybuffer
  • path
)

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:111

Decode file content to read 3ds data.

Parameters:

  • arraybuffer ArrayBuffer

    Arraybuffer data to be loaded.

  • path String

    Path for external resources.

readMeshData

(
  • chunk
  • path
)

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:162

Read mesh data chunk.

Parameters:

  • chunk Chunk

    to read mesh from

  • path String

    Path for external resources.

readNamedObject

(
  • chunk
)

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:219

Read named object chunk.

Parameters:

  • chunk Chunk

    Chunk in use.

readMaterialEntry

(
  • chunk
  • path
)

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:255

Read material data chunk and add it to the material list.

Parameters:

  • chunk Chunk

    Chunk in use.

  • path String

    Path for external resources.

readMesh

(
  • chunk
)
Mesh

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:388

Read mesh data chunk.

Parameters:

  • chunk Chunk

    Chunk in use.

Returns:

Mesh:

The parsed mesh.

readFaceArray

(
  • chunk
  • mesh
)

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:526

Read face array data chunk.

Parameters:

  • chunk Chunk

    Chunk in use.

  • mesh Mesh

    Mesh to be filled with the data read.

readMap

(
  • chunk
  • path
)
Texture

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:607

Read texture map data chunk.

Parameters:

  • chunk Chunk

    Chunk in use.

  • path String

    Path for external resources.

Returns:

Texture:

Texture read from this data chunk.

readMaterialGroup

(
  • chunk
)
Object

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:679

Read material group data chunk.

Parameters:

  • chunk Chunk

    Chunk in use.

Returns:

Object:

Object with name and index of the object.

readColor

(
  • chunk
)
Color

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:710

Read a color value.

Parameters:

  • chunk Chunk

    Chunk.

Returns:

Color:

Color value read..

readPercentage

(
  • chunk
)
Number

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:758

Read percentage value.

Parameters:

  • chunk Chunk

    Chunk to read data from.

Returns:

Number:

Data read from the dataview.

debugMessage

(
  • message
)

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:789

Print debug message to the console.

Is controlled by a flag to show or hide debug messages.

Parameters:

  • message Object

    Debug message to print to the console.

readChunk

() Chunk | null

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:855

read a sub cchunk.

Returns:

Chunk | null:

next sub chunk

idToString

() String

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:888

return the ID of this chunk as Hex

Returns:

String:

hex-string of id

readByte

() Number

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:908

Read byte value.

Returns:

Number:

Data read from the dataview.

readFloat

() Number

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:923

Read 32 bit float value.

Returns:

Number:

Data read from the dataview.

readInt

() Number

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:949

Read 32 bit signed integer value.

Returns:

Number:

Data read from the dataview.

readShort

() Number

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:964

Read 16 bit signed integer value.

Returns:

Number:

Data read from the dataview.

readDWord

() Number

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:979

Read 64 bit unsigned integer value.

Returns:

Number:

Data read from the dataview.

readWord

() Number

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:994

Read 32 bit unsigned integer value.

Returns:

Number:

Data read from the dataview.

readString

() String

Defined in base\common\debug\formats\libs\3ds\3dsLib.js:1009

Read NULL terminated ASCII string value from chunk-pos.

Returns:

String:

Data read from the dataview.

getVector2

(
  • array
)
Vector2 static

Defined in base\site3d.js:1682

Метод преобразует массив из двух чисел в объект Vector2

Parameters:

  • array Site3dPoint2D

    Массив из двух чисел

Returns:

Vector2:

Объект Vector2

getVector

(
  • array
)
Vector3 static

Defined in base\site3d.js:1699

Метод преобразует массив из трех чисел в объект Vector3

Parameters:

  • array Site3dPoint3D

    Массив из трех чисел

Returns:

Vector3:

Объект Vector3

getArrayVector

(
  • vector
)
Site3dPoint3D static

Defined in base\site3d.js:1716

Метод преобразует тройку чисел в виде объекта со свойствами x, y, z в массив из трех чисел

Parameters:

  • vector VectorData | Vector3

    Трехмерный вектор

Returns:

Site3dPoint3D:

Массив из трех чисел

normalizeRad

(
  • angle
)
Number static

Defined in base\site3d.js:1728

Метод возвращает значение угла в радианах между -2PI и 2PI

Parameters:

  • angle Number

    Угол в радианах

Returns:

Number:

Результат

normalizeDeg

(
  • angle
)
Number static

Defined in base\site3d.js:1740

Метод возвращает значение угла в градусах между -360 и 360

Parameters:

  • angle Number

    Угол в градусах

Returns:

Number:

Результат

toRad

(
  • angle
)
Number static

Defined in base\site3d.js:1752

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

Parameters:

  • angle Number

    Угол в градусах

Returns:

Number:

Угол в радинах

toDeg

(
  • angle
)
Number static

Defined in base\site3d.js:1764

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

Parameters:

  • angle Number

    Угол в радинах

Returns:

Number:

Угол в градусах

getFloat

(
  • value
  • fraction
)
Number | number static

Defined in base\site3d.js:1776

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

Parameters:

  • value Number | string | number | string

    Входное значение (может быть числом или строкой)

  • fraction Number

    Число знаков после запятой (по умолчанию Site3d.fraction)

Returns:

Number | number:

Округленное значение с дробной частью

getFloatArray

(
  • array
  • fraction
)
Number static

Defined in base\site3d.js:1799

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

Parameters:

  • array Number | string

    Входной массив

  • fraction Number

    Число знаков после запятой (по умолчанию Site3d.fraction)

Returns:

Number:

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

isPosEqual

(
  • pos1
  • pos2
  • error
)
Boolean static

Defined in base\site3d.js:1817

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

Parameters:

  • pos1 Site3dPoint3D

    Массив координат позиции

  • pos2 Site3dPoint3D

    Массив координат позиции

  • error Number

    Точность сравнения (по умолчанию 0.01)

Returns:

Boolean:

Результат сравнения

sum

() Site3dPoint3D static

Defined in base\site3d.js:1831

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

Returns:

Site3dPoint3D:

Результат сложения

diff

(
  • pos1
  • pos2
  • fraction
)
Site3dPoint3D static

Defined in base\site3d.js:1856

Метод возвращает разницу в координатах двух позиций

Parameters:

  • pos1 Site3dPoint3D

    Первая позиция

  • pos2 Site3dPoint3D

    Вторая позиция

  • fraction Number

    Число знаков после запятой (по умолчанию Site3d.fraction)

Returns:

Site3dPoint3D:

Разность

getDistance

(
  • pos1
  • pos2
)
Number static

Defined in base\site3d.js:1870

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

Parameters:

  • pos1 Site3dPoint3D

    Первая позиция

  • pos2 Site3dPoint3D

    Вторая позиция

Returns:

Number:

Расстояние

mousePos

(
  • e
)
Number static

Defined in base\site3d.js:1883

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

Parameters:

  • e MouseEvent | TouchEvent

    Объект результата события

Returns:

Number:

Координаты указателя

fingersDistance

(
  • p1
  • p2
)
Number static

Defined in base\site3d.js:1895

Метод возвращает расстояние между двумя касаниями тача

Parameters:

  • p1 Touch

    Объект результата события для первого касания

  • p2 Touch

    Объект результата события для второго касания

Returns:

Number:

Расстояние

getModelsCenter

(
  • models
)
Site3dPoint3D static

Defined in base\site3d.js:1938

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

Parameters:

Returns:

Site3dPoint3D:

Массив координат центра

getModelsBoundSize

(
  • models
)
Site3dPoint3D static

Defined in base\site3d.js:1950

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

Parameters:

Returns:

Site3dPoint3D:

Размеры

getModelsInfo

(
  • models
  • include
)
Site3dModelsInfo static

Defined in base\site3d.js:1962

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

Parameters:

  • models Site3dModel[]

    Массив моделей

  • include String

    Массив возвращаемых значений

Returns:

Site3dModelsInfo:

Результат

blobToBase64

(
  • blob
)
Promise static async

Defined in base\site3d.js:1989

Метод возвращает Base64 версию Blob объекта

Parameters:

  • blob Blob

    Blob объект

Returns:

Promise:

Результат в виде строки

clear

() static

Defined in base\site3d.js:2023

Метод очистки сцены

preload

()

Defined in base\site3d.js:2038

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

getElapsedTime

() Number

Defined in base\site3d.js:2048

Метод возвращает время существования сцены

Returns:

Number:

Время в миллисекундах

background

(
  • value
)

Defined in base\site3d.js:2060

Метод установки цвета фона

Parameters:

  • value String | null

    Цвет в HEX-формате или путь до изображения в формате jpg или png

setEffectsActivity

()

Defined in base\site3d.js:2081

Метод установки активности эффектов сцены

effects

(
  • options
)

Defined in base\site3d.js:2098

Метод установки эффектов сцены

Parameters:

  • options Site3dEffectsOptions

    Параметры эффектов сцены

setModelOutline

(
  • model
  • options
)

Defined in base\site3d.js:2198

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

Parameters:

  • model Site3dModel

    Модель

  • options Site3dModelOutlineOptions

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

showModelOutline

(
  • model
)

Defined in base\site3d.js:2224

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

Parameters:

hideModelOutline

(
  • model
)

Defined in base\site3d.js:2241

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

Parameters:

updateOutlines

()

Defined in base\site3d.js:2258

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

_removeOutlinePasses

() private

Defined in base\site3d.js:2327

Метод удаляет шаги рендера свечений

clearOutlines

()

Defined in base\site3d.js:2342

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

updateWatermark

(
  • value
)
async

Defined in base\site3d.js:2352

Метод обновляет водяной знак

Parameters:

  • value Site3dWatermarkOptions

    Параметры

enableEnvironment

(
  • options
)

Defined in base\site3d.js:2398

Метод включения окружения

Parameters:

  • options Site3dEnvironmentOptions

    Параметры окружения:

    • fill – путь до файла панорамной текстуры в формате HDR или одно и предустановленных значений: «grey» (по умолчанию), «sunset»
    • tone – степень наложения текстуры на объекты от 0 до 1 (по умолчанию, 0.5)
    • isBackground – истина, если нужно отобразить текстуру в качестве фона сцены (по умолчанию false)

disableEnvironment

()

Defined in base\site3d.js:2440

Метод отключения окружения

fog

(
  • options
)

Defined in base\site3d.js:2454

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

Parameters:

  • options Site3dFogOptions

    Параметры тумана

cameraSetup

(
  • options
)

Defined in base\site3d.js:2466

Метод настройки основных параметров камеры

Parameters:

  • options Site3dCameraOptions

    Параметры камеры:

    • angle – угол зрения (по умолчанию 50)
    • near и far – пространство перед камерой (от и до, по умолчанию 0.1 и 100)
    • pos – позиция (по умолчанию [0, 0, 1])
    • target – точка наблюдения (по умолчанию [0, 0, 0])

cameraRotateWorld

(
  • stepX
  • stepY
  • stepZ
)

Defined in base\site3d.js:2480

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

Parameters:

  • stepX Number

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

  • stepY Number

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

  • stepZ Number

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

cameraSetPrev

()

Defined in base\site3d.js:2492

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

line

(
  • name
  • posList
  • fill
  • load
)
Site3dLine

Defined in base\site3d.js:2503

Метод добавляет линию

Parameters:

  • name String

    Имя модели

  • posList Number[]

    Двумерный массив точек линии

  • fill Site3dFillData

    Наполнение (по умолчанию белый цвет)

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dLine:

Объект модели

sprite

(
  • name
  • path
  • load
)
Site3dSprite

Defined in base\site3d.js:2517

Метод добавляет спрайт

Parameters:

  • name String

    Имя модели

  • path String

    Путь до изображения спрайта

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dSprite:

Объект модели

triangle

(
  • name
  • pos1
  • pos2
  • pos3
  • fill
  • load
)
Site3dTriangle

Defined in base\site3d.js:2530

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

Parameters:

  • name String

    Имя модели

  • pos1 Site3dPoint3D

    Позиция первой точки

  • pos2 Site3dPoint3D

    Позиция второй точки

  • pos3 Site3dPoint3D

    Позиция третей точки

  • fill Site3dFillData

    Наполнение (по умолчанию белый цвет)

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dTriangle:

Объект модели

plane

(
  • name
  • width
  • height
  • fill
  • load
)
Site3dPlane

Defined in base\site3d.js:2546

Метод добавляет плоскость

Parameters:

  • name String

    Имя модели

  • width Number

    Ширина

  • height Number

    Высота

  • fill Site3dFillData

    Наполнение (по умолчанию белый цвет)

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dPlane:

Объект модели

circle

(
  • name
  • radius
  • detail
  • fill
  • load
)
Site3dCircle

Defined in base\site3d.js:2561

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

Parameters:

  • name String

    Имя модели

  • radius Number

    Радиус

  • detail Number

    Число сегментов (по умолчанию 16)

  • fill Site3dFillData

    Наполнение (по умолчанию белый цвет)

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dCircle:

Объект модели

cube

(
  • name
  • size
  • fill
  • load
)
Site3dCube

Defined in base\site3d.js:2576

Метод добавляет параллелепипед

Parameters:

  • name String

    Имя модели

  • size Site3dPoint3D

    Размеры

  • fill Site3dFillData

    Наполнение

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dCube:

Объект модели

sphere

(
  • name
  • radius
  • detail
  • fill
  • load
)
Site3dSphere

Defined in base\site3d.js:2590

Метод добавляет сферу

Parameters:

  • name String

    Имя модели

  • radius Number

    Радиус

  • detail Number

    Число сегментов

  • fill Site3dFillData

    Наполнение

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dSphere:

Объект модели

hemisphere

(
  • name
  • radius
  • detail
  • fill
  • load
)
Site3dHemisphere

Defined in base\site3d.js:2605

Метод добавляет полусферу

Parameters:

  • name String

    Имя модели

  • radius Number

    Радиус

  • detail Number

    Число сегментов

  • fill Site3dFillData

    Наполнение

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dHemisphere:

Объект модели

octahedron

(
  • name
  • radius
  • detail
  • fill
  • load
)
Site3dOctahedron

Defined in base\site3d.js:2620

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

Parameters:

  • name String

    Имя модели

  • radius Number

    Радиус

  • detail Number

    Число сегментов

  • fill Site3dFillData

    Наполнение

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dOctahedron:

Объект модели

shape

(
  • name
  • points
  • fill
  • options
  • load
)
Site3dShape

Defined in base\site3d.js:2635

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

Parameters:

  • name String

    Имя модели

  • points Site3dPoint2D

    Массив точек

  • fill Site3dFillData

    Наполнение

  • options Site3dShapeOptions

    Параметры:

    • depth - глубина экструдирования (по-умолчанию 1)
    • steps - число шагов экструдирования (по-умолчанию 1)
    • bevelEnabled - истина, если края скошены (по-умолчанию false)
  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dShape:

Объект модели

importModel

(
  • name
  • path
  • [options]
)
Site3dImportModel

Defined in base\site3d.js:2653

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

Parameters:

  • name String

    Имя модели

  • path String

    Путь до файла модели

  • [options] Site3dImportModelLoadOptions optional

    Параметры загрузки

Returns:

Site3dImportModel:

Объект модели

importModelAsync

(
  • name
  • path
  • [options]
)
Promise async

Defined in base\site3d.js:2666

Метод добавляет модель в формате GLTF асинхронно

Parameters:

  • name String

    Имя модели

  • path String

    Путь до файла модели

  • [options] Site3dImportModelLoadOptions optional

    Параметры загрузки (дополняет/оборачивает load и error)

Returns:

Promise:

Объект модели в качестве результата промиса

modelClipping

(
  • name
  • model
  • options
  • load
)
Site3dModelClipping

Defined in base\site3d.js:2707

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

Parameters:

  • name String

    Имя модели

  • model Site3dModel

    Модель, у которой будет сделан срез

  • options Site3dObject3dClippingOptions

    Дополнительные опции

  • load Function

    Функцию информирования об окончании процесса загрузки (в качестве аргумента передается объект модели)

Returns:

Site3dModelClipping:

Объект модели

isModel

(
  • name
)
Boolean

Defined in base\site3d.js:2721

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

Parameters:

  • name String

    Имя модели

Returns:

Boolean:

Результат

model

(
  • name
)
Site3dModel

Defined in base\site3d.js:2732

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

Parameters:

  • name String

    Имя модели

Returns:

Site3dModel:

Объект модели

addModel

(
  • model
)

Defined in base\site3d.js:2743

Добавляет модель в сцену и обновляет счетчики.

Parameters:

removeModel

(
  • name
)

Defined in base\site3d.js:2766

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

Parameters:

  • name String

    Имя модели

removeModelSilent

(
  • name
)

Defined in base\site3d.js:2780

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

Parameters:

  • name String

    Имя модели

addFill

(
  • name
  • fill
  • load
)
async

Defined in base\site3d.js:2796

Метод добавляет поименованное наполнение

Parameters:

  • name String

    Имя наполнения

  • fill Site3dFillData

    Наполнение

  • load Function

    Функцию информирования об окончании процесса создания наполнения

ambientLight

(
  • name
  • options
)
Site3dAmbientLight

Defined in base\site3d.js:2815

Метод добавляет общий свет

Parameters:

  • name String

    Имя источника освещения

  • options Site3dAmbientLightOptions

    Параметры освещения:

    • color – цвет в HEX-формате (по умолчанию белый)
    • power – мощность (по умолчанию 1)

Returns:

Site3dAmbientLight:

Объект источника освещения

directionalLight

(
  • name
  • options
)
Site3dDirectionalLight

Defined in base\site3d.js:2836

Метод добавляет направленный свет

Parameters:

  • name String

    Имя источника освещения

  • options Site3dDirectionalLightOptions

    Параметры освещения:

    • color – цвет в HEX-формате (по умолчанию белый)
    • power – мощность (по умолчанию 1)
    • pos – позиция источника (по умолчанию [1, 1, 1])
    • target – позиция направления (по умолчанию [0, 0, 0])

Returns:

Site3dDirectionalLight:

Объект источника освещения

spotLight

(
  • name
  • options
)
Site3dSpotLight

Defined in base\site3d.js:2860

Метод добавляет конусный свет

Parameters:

  • name String

    Имя источника освещения

  • options Site3dSpotLightOptions

    Параметры освещения:

    • color – цвет в HEX-формате (по умолчанию белый)
    • power – мощность (по умолчанию 1)
    • pos – позиция источника (по умолчанию [1, 1, 1])
    • target – позиция направления (по умолчанию [0, 0, 0])
    • angle – угол конуса (по умолчанию 45)
    • blur – сглаженность светового пятна (по умолчанию 0.5)

Returns:

Site3dSpotLight:

Объект источника освещения

light

(
  • name
)
Site3dLight

Defined in base\site3d.js:2878

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

Parameters:

  • name String

    Имя источника освещения

Returns:

Site3dLight:

Объект источника освещения

addLight

(
  • light
)

Defined in base\site3d.js:2889

Добавляет источник света в сцену.

Parameters:

enableControls

(
  • options
)

Defined in base\site3d.js:2910

Метод включает управление сценой

Parameters:

  • options Site3dControlsOptions

    Параметры:

    • move – перемещение вдоль глобальных осей:
    • isEnabled – истина, если перемещение включено (по умолчанию включено, если передать параметр move)
    • events – массив строк органов управления (возможные значения: «mouse_left» – левая кнопка мыши, «mouse_right» – правая кнопка мыши, «touch_move» – перемещение пальцем (по умолчанию: [«mouse_left», «touch_move»]))
    • isControlTarget – истина, если нужно одновременно перемещать центр масштабирования и вращения (по умолчанию истина)
    • minY – минимальная координата перемещения вдоль оси y (по умолчанию 0)
    • maxY – максимальная координата перемещения вдоль оси y (по умолчанию 0)
    • minTargetY – минимальная координата перемещения центра масштабирования и вращения вдоль оси y (по умолчанию 0)
    • maxTargetY – максимальная координата перемещения центра масштабирования и вращения вдоль оси y (по умолчанию 0)
    • minZ – минимальная координата перемещения вдоль оси z (по умолчанию 0)
    • maxZ – максимальная координата перемещения вдоль оси z (по умолчанию 0)
    • minTargetZ – минимальная координата перемещения центра масштабирования и вращения вдоль оси z (по умолчанию 0)
    • maxTargetZ – максимальная координата перемещения центра масштабирования и вращения вдоль оси z (по умолчанию 0)
    • axes – оси перемещения (y (по умолчанию: «y»); вертикальное движение мыши/тача задаёт ось z, если ось z включена и не включены одновременно все три оси x, y и z — иначе вертикаль двигает ось y)
    • speed – скорость (по умолчанию: 1)
    • scale – масштабирование колесом прокрутки или жестом:
    • isEnabled – истина, если масштабирование включено (по умолчанию включено, если передать параметр scale)
    • min – минимальное расстояние до центра масштабирования (по умолчанию: 1)
    • max – максимальное расстояние до центра масштабирования (по умолчанию: 10)
    • speed – скорость (по умолчанию: 1)
    • rotate – вращение:
    • isEnabled – истина, если вращение включено (по умолчанию включено, если передать параметр rotate)
    • events – массив строк органов управления (возможные значения: «mouse_left» – левая кнопка мыши, «mouse_right» – правая кнопка мыши, «touch_move» – перемещение пальцем (по умолчанию: [«mouse_left», «touch_move»]))
    • min – минимальный угол поворота (по умолчанию 0)
    • max – максимальный угол поворота (по умолчанию 90)
    • axes – оси вращения (x, y или x и y одновременно (по умолчанию: «xy»))
    • speed – скорость (по умолчанию: 1)
    • target – центр масштабирования и вращения (по умолчанию [0, 0, 0]), если передать false, то масштабирование будет без учета минимального и максимального значений, а вращение будет на месте

disableControls

()

Defined in base\site3d.js:2983

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

setControlsTargetSilent

(
  • target
)
Boolean

Defined in base\site3d.js:3042

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

Parameters:

  • target Site3dPoint3D

    Позиция

Returns:

Boolean:

Истина, если произошло изменение

moveControlsTarget

(
  • steps
)

Defined in base\site3d.js:3059

Метод устанавливает центр масштабирования и вращения

Parameters:

  • steps Site3dPoint3D

    Шаги изменений в координатах

moveControlsTargetSilent

(
  • steps
)

Defined in base\site3d.js:3072

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

Parameters:

  • steps Site3dPoint3D

    Шаги изменений в координатах

rotateAroundTarget

(
  • angle
  • options
)

Defined in base\site3d.js:3115

Метод поворачивает камеру вокруг центра масштабирования и вращения

Parameters:

  • angle Number

    Угол поворота

  • options Site3dCameraRotateOptions

    Параметры

getMousePosNormalized

() Site3dPoint2D

Defined in base\site3d.js:3144

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

Returns:

Site3dPoint2D:

Координаты по осям

intersectModel

(
  • model
  • fromModels
  • options
)
Site3dModelIntersectResult | null

Defined in base\site3d.js:3156

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

Parameters:

  • model Site3dModel

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

  • fromModels Site3dModel[] | null

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

  • options Site3dIntersectModelOptions | null

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

Returns:

Site3dModelIntersectResult | null:

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

getHorizontalPlaneIntersectPos

(
  • model
)
Site3dPoint3D | null

Defined in base\site3d.js:3268

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

Parameters:

  • model Site3dModel

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

Returns:

Site3dPoint3D | null:

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

_intersectsParams

(
  • options
)
private

Defined in base\site3d.js:3294

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

Parameters:

  • options Site3dIntersectsParamsOptions

    Параметры пересечений

event

(
  • name
  • call
  • options
)

Defined in base\site3d.js:3323

Метод подписывает на события сцены

Parameters:

  • name String

    Имя события

  • call Function

    Функция обработки события

  • options Site3dEventSubscribeOptions

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

removeEvent

(
  • name
  • call
)

Defined in base\site3d.js:3346

Метод удаляет подписку на событие сцены

Parameters:

  • name String

    Имя события

  • call Function

    Функция обработки события

callEvent

(
  • name
  • options
)

Defined in base\site3d.js:3357

Метод вызывает событие Site3d

Parameters:

  • name String

    Кодовое обозначение события

  • options Object

    Дополнительные параметры (добавляются в параметр события в качестве свойства info)

startCallEvents

()

Defined in base\site3d.js:3386

Метод запускает генерацию событий сцены

startCallEvents

()

Defined in base\site3d.js:3395

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

addEventListener

(
  • name
  • handler
)

Defined in base\site3d.js:3404

Метод добавляет обработчик события Site3d

Parameters:

  • name String

    Кодовое обозначение события

  • handler Function

    Обработчик события

removeEventListener

(
  • name
  • handler
)

Defined in base\site3d.js:3416

Метод удаляет обработчик события Site3d

Parameters:

  • name String

    Кодовое обозначение события

  • handler Function

    Обработчик события

setEvents

(
  • domElement
)

Defined in base\site3d.js:3428

Метод устанавливает обработчики событий Site3d для HTML-элемента

Parameters:

  • domElement HTMLElement

    HTML-элемент

setPostRenderPrev

()

Defined in base\site3d.js:3502

Метод устанавливает предыдущее значение isPostRender

stereoEffectOn

() async

Defined in base\site3d.js:3650

Метод включает стерео режим

stereoEffectOff

()

Defined in base\site3d.js:3681

Метод выключает стерео режим

startLastRender

()

Defined in base\site3d.js:3700

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

stopLastRender

()

Defined in base\site3d.js:3709

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

render

(
  • options
)
async

Defined in base\site3d.js:3718

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

Parameters:

  • options Site3dRenderOptions

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

updateIsRender

(
  • value
)

Defined in base\site3d.js:3807

Метод обновляет включение или отключение рисования сцены

Parameters:

  • value Boolean

    Истина, если нужно включить рисование сцены виджета

renderOn

(
  • render
)

Defined in base\site3d.js:3827

Метод включает рисование сцены

Parameters:

  • render Site3dRender

    объект автоматической отрисовки сцены

renderOff

()

Defined in base\site3d.js:3842

Метод выключает рисование сцены

setRenderSize

(
  • size
)

Defined in base\site3d.js:3851

Метод изменяет размер рендера

Parameters:

  • size Number

    Размер рендера

resize

(
  • options
)

Defined in base\site3d.js:3889

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

Parameters:

  • options Site3dResizeOptions

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

getScreenshotAsBlob

(
  • [options]
)
Promise async

Defined in base\site3d.js:3970

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

Parameters:

  • [options] Site3dScreenshotOptions optional

    Параметры скриншота

Returns:

Promise:

Скриншот

downloadScreenshot

(
  • fileName
  • options
)
async

Defined in base\site3d.js:4052

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

Parameters:

  • fileName String

    Имя сохраняемого файла

  • options Site3dScreenshotOptions

    Параметры скриншота:

    • size - размеры скриншота (по умолчанию [1920, 1080])

hideByClick

(
  • elem
  • hide
  • except
)

Defined in base\site3d.js:4087

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

Parameters:

  • elem HTMLElement | string

    Элемент DOM или его идентификатор

  • hide Function

    Функция, срабатываемая при событии клика вне элемента

  • except HTMLElement

    Элементы DOM в виде исключения

removeHideByClick

(
  • elem
)

Defined in base\site3d.js:4108

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

Parameters:

  • elem HTMLElement | string

    Элемент DOM или его идентификатор

updateHideByClickContainer

(
  • container
)

Defined in base\site3d.js:4133

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

Parameters:

  • container HTMLElement

    Элемент DOM

getMinViewDistance

(
  • size
  • options
)
Number

Defined in base\site3d.js:4149

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

Parameters:

  • size Site3dPoint3D

    Размер параллелепипеда

  • options Site3dExportToBlobOptions

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

Returns:

Number:

Расстояние

getViewDistance

(
  • size
  • distance
  • options
)
Number

Defined in base\site3d.js:4168

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

Parameters:

  • size Site3dPoint3D

    Размер параллелепипеда

  • distance Number | string

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

  • options Site3dModelViewDistanceOptions

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

Returns:

Number:

Расстояние

loseContext

()

Defined in base\site3d.js:4198

Метод вызывает потерю контекста WebGL

getMaterial

(
  • fill
  • updatedInstance
  • load
  • progress
)
Material

Defined in base\site3d.js:4275

Создает и заполняет материал по параметрам fill.

Parameters:

  • fill Site3dFillData

    Параметры материала

  • updatedInstance Material | null

    Существующий экземпляр материала

  • load ((s3d: Site3d) => void)=

    Колбэк завершения заполнения

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

    Колбэк прогресса загрузки

Returns:

Material:

Экземпляр three.js-материала

getPos2d

(
  • obj
)
Site3dVectorScreenInfo

Defined in base\site3d.js:4330

Возвращает экранные координаты для модели или точки.

Parameters:

  • obj Site3dModel | Site3dPoint3D

    Модель или позиция

Returns:

Site3dVectorScreenInfo:

Результат вычисления экранной проекции вектора

setPos2dContent

(
  • content
  • point
  • align
)

Defined in base\site3d.js:4342

Устанавливает позицию HTML-контента в 2D с учетом выравнивания и границ canvas.

Parameters:

  • content HTMLElement | null

    DOM-элемент

  • point Number

    Точка [x, y]

  • align String

    Выравнивание

_isActiveControls

(
  • e
  • events
)
Boolean private

Defined in base\site3d.js:4431

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

Parameters:

  • e MouseEvent | TouchEvent | WheelEvent

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

  • events String

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

Returns:

Boolean:

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

_setContext

() private

Defined in base\site3d.js:4452

Инициализирует графический контекст (WebGPU/WebGL2/WebGL).

_updateCanvasSizeParams

() private

Defined in base\site3d.js:4474

Пересчитывает размеры canvas с учетом devicePixelRatio.

_setEquirectangularMap

(
  • fill
  • load
)
private async

Defined in base\site3d.js:4486

Загружает HDR-карту окружения и передает результат в callback.

Parameters:

  • fill String

    Путь или имя пресета окружения

  • load Function

    Колбэк с готовой текстурой окружения

_callLoad

() private

Defined in base\site3d.js:4515

Вызывает общий колбэк загрузки сцены с текущей статистикой.

_createModel

(
  • model
)
T private

Defined in base\site3d.js:4533

Регистрирует модель в коллекции сцены по имени. Если модель с таким именем уже существует, она тихо удаляется и заменяется новой.

Parameters:

  • model T

    Модель для регистрации

Returns:

T:

Зарегистрированная модель

_initModel

(
  • model
)
private

Defined in base\site3d.js:4549

Инициализирует меш модели и всех вложенных моделей.

Parameters:

_model

(
  • name
  • mesh
  • parentModel
  • load
)
Site3dModel private

Defined in base\site3d.js:4563

Создает базовую модель-обертку над переданным мешем.

Parameters:

  • name String

    Имя модели

  • mesh Mesh

    Меш

  • parentModel Site3dModel | undefined

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

  • load Function | undefined

    Колбэк загрузки

Returns:

Site3dModel:

Модель

_setCursor

() private

Defined in base\site3d.js:4578

Обновляет курсор canvas в зависимости от состояния hover.

_handleEventConditions

(
  • e
)
private

Defined in base\site3d.js:4611

Обрабатывает внутренние флаги состояний для мыши/тача.

Parameters:

  • e MouseEvent | TouchEvent | WheelEvent

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

_getRendererSize

() Vector2 private

Defined in base\site3d.js:5017

Возвращает текущий размер renderer.

Returns:

Vector2:

Размер рендера

Properties

{number} z - Координата Z

Number

Defined in base\site3d.js:24

Трёхмерный вектор.

[useRatio=false] - Использовать размеры canvas с учетом devicePixelRatio

Boolean

Defined in base\site3d.js:32

Параметры вычисления экранной проекции вектора.

{boolean} inCamera - Входит ли вектор в видимость камеры

number, number

Defined in base\site3d.js:38

Результат вычисления экранной проекции вектора.

{number} distance - Расстояние от точки до вершины

Vector3

Defined in base\site3d.js:45

Результат поиска минимальной дистанции от точки до Box3.

{boolean} isPreloadCompleted - Признак завершения preload

Number

Defined in base\site3d.js:52

Информация о прогрессе загрузки сцены.

{boolean} [onlyVisibleBoxes=false] - Только видимые боксы

Site3dSceneLoadCallback | null

Defined in base\site3d.js:68

Параметры сцены. Структура по умолчанию в конструкторе Site3d.

{number} renderTextures - Количество текстур рендера

Number

Defined in base\site3d.js:80

Информация о сцене (triangles, memory, renderGeometries, renderTextures).

{boolean} [isBackground=false] - Показывать окружение как фон сцены

String

Defined in base\site3d.js:89

Параметры окружения сцены.

{number} [height=512] - Высота canvas

String

Defined in base\site3d.js:97

Параметры генерации текстовой текстуры.

{number} [opacity] - Непрозрачность (интенсивность) отражений

Boolean

Defined in base\site3d.js:112

Параметры SSR-эффекта сцены.

{{r?: number, g?: number, b?: number}} [color] - Множители RGB в постобработке

Number

Defined in base\site3d.js:122

Параметры эффектов сцены.

{number} [threshold] - Порог яркости источника свечения

Boolean

Defined in base\site3d.js:133

Параметры bloom-прохода (поля передаются в UnrealBloomPass).

{number} far - Расстояние полной сгущённости тумана

String

Defined in base\site3d.js:142

Параметры тумана сцены.

{Site3dFillData} [fill] - Наполнение оттенка

String

Defined in base\site3d.js:150

Данные конфигуратора из JSON/options.

{boolean} [loop] - Зациклить воспроизведение

String

Defined in base\site3d.js:162

Параметры видеотекстуры.

{Object.<string, Site3dFillTintData>} [tints] - Дополнительные оттенки

'basic' | 'lambert' | 'phong' | 'physical'

Defined in base\site3d.js:172

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

{boolean} [shadows] - Учитывать тени

Dir: Site3dPoint3D, offset: number

Defined in base\site3d.js:212

Параметры clipping planes для материала.

{string} [hiddenEdgeColor='#cccccc'] - Цвет скрытых рёбер

Number

Defined in base\site3d.js:230

Параметры свечения модели.

{number} [opacity=100] - Непрозрачность в процентах (0–100)

Boolean

Defined in base\site3d.js:242

Параметры водяного знака.

{Site3dPoint3D} [posFromTarget] - Позиция относительно target (альтернатива pos)

'perspective' | 'orthographic'

Defined in base\site3d.js:250

Параметры настройки камеры.

{Site3dCameraOptions} [cameraOptions] - Временные параметры камеры для кадра

number, number

Defined in base\site3d.js:264

Параметры скриншота.

{Array<Array<[number, number]>>} [connections] - Связи рёбер между точками основания

Number

Defined in base\site3d.js:272

Параметры экструдирования формы.

{number} [power=1] - Относительная мощность

String

Defined in base\site3d.js:282

Параметры общего источника света.

{Site3dPoint3D} [target=[0, 0, 0]] - Точка, куда направлен свет

String

Defined in base\site3d.js:289

Параметры направленного источника света.

{number} [blur=0.5] - Размытие границы конуса (penumbra)

String

Defined in base\site3d.js:298

Параметры конусного источника света.

{number} [bias=-0.00005] - Смещение теней (борьба с shadow acne)

Number

Defined in base\site3d.js:309

Параметры теней источника света.

{Site3dPoint3D | null} [target=null] - Точка направления света относительно модели

Boolean

Defined in base\site3d.js:320

Параметры привязки источника освещения к модели.

{number} [speed=1] - Множитель скорости перемещения

Boolean

Defined in base\site3d.js:328

Параметры перемещения камеры.

{number} [speed=1] - Скорость изменения масштаба

Boolean

Defined in base\site3d.js:346

Параметры масштабирования камеры.

{number} [speed=1] - Скорость вращения

Boolean

Defined in base\site3d.js:355

Параметры вращения камеры.

{string[]} [events] - Общий список событий управления

Site3dControlsMoveOptions

Defined in base\site3d.js:366

Параметры управления сценой.

{Site3dPoint3D} [size] - Размеры AABB [dx, dy, dz]

Site3dPoint3D

Defined in base\site3d.js:378

Результат вычисления параметров группы моделей.

{boolean} [onlyVisibleBoxes=false] - Учитывать только видимые меши в bound

HTMLCanvasElement | null

Defined in base\site3d.js:385

Параметры конструктора Site3dThree.

[isOnlyVisible] - Строить bound только по видимым мешам

Boolean

Defined in base\site3d.js:395

Параметры вычисления Box3 для объекта.

{number} [near] - Ближняя плоскость камеры для расчёта дистанции

Boolean

Defined in base\site3d.js:401

Параметры расчёта дистанции/позиции камеры у модели.

{number} square - Площадь экранной области

Site3dPoint2D

Defined in base\site3d.js:408

Результат расчёта экранных размеров векторов.

{number} square - Площадь проекции на экране

Boolean

Defined in base\site3d.js:415

Результат расчёта экранной информации объекта.

{Site3dPoint3D} size - Локальные / мировые размеры

Vector3

Defined in base\site3d.js:423

Мировая информация об объекте three.js.

[minSquare=100] - Порог площади на экране; ниже — скрывать меш

Number

Defined in base\site3d.js:432

Параметры скрытия мелких мешей на экране.

countHiddenMeshes - Сколько мешей скрыто

Number

Defined in base\site3d.js:438

Результат скрытия мелких мешей на экране.

{boolean} [rotation=true] - Копировать поворот

Boolean

Defined in base\site3d.js:444

Параметры копирования глобальных трансформаций.

[exceptions] - Имена/идентификаторы мешей, исключить из выборки

String

Defined in base\site3d.js:452

Параметры выборки мешей объекта.

[instanceId] - Индекс InstancedMesh

Number

Defined in base\site3d.js:458

Параметры установки цвета меша.

[saveToFirst=false] - Сохранять результат в первом меше

Boolean

Defined in base\site3d.js:464

Параметры объединения мешей.

{string} [axis='y'] - Ось выравнивания

Number

Defined in base\site3d.js:470

Параметры выравнивания частей объекта по оси.

{number} [distanceFormOrigin] - Расстояние от начала координат

Number

Defined in base\site3d.js:477

Параметры плоскости среза.

{Site3dClippingPlaneOptions} [plane] - Плоскость среза (нормаль и расстояние)

String

Defined in base\site3d.js:484

Параметры построения объекта среза.

[color='#ff0000'] - Цвет в HEX/CSS

String

Defined in base\site3d.js:491

Параметры операций с цветом служебных объектов.

[onProgress] - Колбэк прогресса экспорта

((event: Site3dProgressInfo) => void) | null

Defined in base\site3d.js:497

Параметры экспорта объекта в Blob.

[zeroZ=false] - Обнулять локальную Z после центрирования

Boolean

Defined in base\site3d.js:508

Параметры центрирования меша по bound.

{'unknown' | 'yes' | 'no'} [existSameId='unknown'] - Ожидаемое наличие дубликатов

String

Defined in base\site3d.js:514

Параметры сравнения мешей.

{(info: Site3dProgressInfo) => void} [callback] - Колбэк прогресса по шагам

String

Defined in base\site3d.js:521

Параметры поиска одинаковых мешей.

{(event: Site3dProgressInfo) => void} [onProgress] - Прогресс подготовки

String

Defined in base\site3d.js:529

Параметры подготовки оптимизации объекта.

[isEnabled=false] - Объединять меши с одним материалом

Boolean

Defined in base\site3d.js:536

Включение объединения мешей по материалу.

{number} [percent=80] - Целевой процент сохранённых вершин

Boolean

Defined in base\site3d.js:542

Включение упрощения геометрии.

{string[]} [exceptions] - Исключения по имени меша

Boolean

Defined in base\site3d.js:549

Включение замены одинаковых мешей.

{Site3dObject3dOptimizeReplaceSameOptions} [replaceSame] - Замена одинаковых

Site3dObject3dOptimizePrepareCallback

Defined in base\site3d.js:573

Параметры оптимизации объекта.

{number} countInstancedMeshes - Число InstancedMesh

Number

Defined in base\site3d.js:583

Метрики оптимизации объекта.

{Site3dObject3dOptimizeMetrics} after - Метрики после

Site3dObject3dOptimizeMetrics

Defined in base\site3d.js:591

Информация об оптимизации объекта.

[isOnlyVisible=true] - Пересечение только с видимыми моделями и их частями

Boolean

Defined in base\site3d.js:598

Параметры поиска пересечения модели с указателем мыши.

{boolean} [isRecursive] - Искать пересечения рекурсивно по дочерним объектам

Site3dModel[]

Defined in base\site3d.js:604

Параметры набора моделей/режима рекурсии для пересечений сцены.

[once=false] - Автоматически снять подписку после первого вызова

Boolean

Defined in base\site3d.js:611

Дополнительные параметры подписки на событие сцены.

{boolean} [immediatelyRender=false] - Выполнить render() сразу после resize

Boolean

Defined in base\site3d.js:622

Дополнительные параметры изменения размера рендера.

{Site3dPoint3D} pos - Точка пересечения в мировых координатах

Site3dModel

Defined in base\site3d.js:629

Результат пересечения указателя мыши с моделью.

{boolean} isRender - Требуется ли перерисовка после события

String

Defined in base\site3d.js:636

Описание события Site3d.

{number} [percent] - Процент 0..100

Number

Defined in base\site3d.js:643

Информация о прогрессе загрузки.

{(event: Site3dProgressInfo) => void} [onProgress] - Прогресс чтения (вызывается только при lengthComputable у события)

() => void

Defined in base\site3d.js:652

Параметры {@link Site3dUtility.uploadBlob}.

{Vector2=} uv - UV в точке попадания

Object3D

Defined in base\site3d.js:659

Элемент результата raycast (как у three.js Intersection).

{Site3dRaycastIntersect[]} intersectedObjects - Список пересечений (от ближнего)

number, number

Defined in base\site3d.js:669

Результат raycast под курсором (кэш действий).

{boolean} isCameraRotate - Активен поворот камеры жестом

String

Defined in base\site3d.js:681

Состояние пользовательских действий (мышь/тач) для Site3d.

[isLocal=true] - истина, если в локальных координатах модели

Boolean

Defined in base\site3d.js:710

Опции перемещения модели.

[isLocal=true] - Истина, если оси локальные

Boolean

Defined in base\site3d.js:716

Опции поворота камеры.

{number} [maxTargetZ] - Максимальная Z target

Boolean

Defined in base\site3d.js:722

Опции перемещения камеры.

[isRotate=true] - Перед перемещением повернуться в направлении новой цели

Boolean

Defined in base\site3d.js:741

Опции перемещения камеры к новой цели.

{Site3dObject3dOptimizeInfo} [optimize] - Метрики последней оптимизации

Number

Defined in base\site3d.js:747

Информация о модели Site3dModel.

{boolean} [notEditGeometryEvent=false] - Не слать событие editGeometry

String

Defined in base\site3d.js:756

Опции добавления дочерней модели.

{boolean} [isAllItems=false] - Вернуть все совпадения

Boolean

Defined in base\site3d.js:764

Опции поиска дочерних моделей.

{(message: string) => void} [error] - Ошибка загрузки / парсинга

Url: string, data: Record

Defined in base\site3d.js:772

Опции загрузки импортируемой модели.

{boolean} [needDecode=false] - Включить декодирование Draco/Meshopt при поддержке лоадера

Site3dImportModel | null

Defined in base\site3d.js:783

Опции загрузчика импортируемой модели конкретного формата.

message - Текст ошибки

String

Defined in base\site3d.js:793

Ошибка загрузки импортируемой модели по формату.

{boolean} [isHideFrame=true] - Скрывать каркас/рамку при hide

Boolean

Defined in base\site3d.js:799

Опции видимости модели.

[notUpdateGeometry=false] - Не вызывать updateGeometry после setGeometry

Boolean

Defined in base\site3d.js:806

Опции замены геометрии.

{number} [duration] - Длительность анимации поворота (ms), если поддерживается

Boolean

Defined in base\site3d.js:817

Опции поворота модели.

{number} [speed] - Скорость изменения масштаба

Boolean

Defined in base\site3d.js:824

Параметры зума модели в контролах.

{number} [speed] - Скорость вращения

Boolean

Defined in base\site3d.js:833

Параметры вращения модели в контролах.

{Site3dModelControlsRotateOptions} [rotate] - Вращение модели

Site3dModelControlsScaleOptions

Defined in base\site3d.js:842

Параметры управления моделью.

{number} [rotateLocalY] - Доп. поворот вокруг локальной Y

String

Defined in base\site3d.js:849

Параметры соединения модели.

{boolean} [boundHover] - Подсветка bound при hover

String | Site3dModelLinkActionCallback

Defined in base\site3d.js:867

Параметры ссылки/интерактива модели.

{boolean} [isCallEvent=true] - Вызывать события сцены при изменении

Site3dFillDataObject

Defined in base\site3d.js:884

Параметры отображения рёбер модели.

{number} [thickness] - Толщина линии

String

Defined in base\site3d.js:897

Параметры каркаса границы.

{boolean} [isEnabled] - Включена ли метка

String | HTMLElement | null

Defined in base\site3d.js:904

Параметры метки модели.

{string} [template] - HTML-шаблон метки ([name], [value], [unit])

String

Defined in base\site3d.js:919

Параметры визуализации размеров модели (см. Site3dModelSizeInfo).

{number} [volume] - Объём (если посчитан)

String

Defined in base\site3d.js:932

Лог-срез состояния модели.

{number} [renderOrder] - Порядок отрисовки three.js

BufferGeometry

Defined in base\site3d.js:942

Базовый тип three-объекта, используемого как mesh у Site3dModel.

{number} [anisotropy] - Уровень anisotropy

Site3dFillWrapType

Defined in base\site3d.js:956

Опции оптимизации текстуры.

{number} [anisotropy] - Уровень anisotropic filtering

String | Texture

Defined in base\site3d.js:963

Опции загрузки текстуры для материала.

{'hide' | ((window: Site3dWindow) => void)} [onclick] - Действие по клику

String

Defined in base\site3d.js:971

Параметры кнопки окна.

{string | HTMLElement} [content] - Контент окна (html/id/element)

String

Defined in base\site3d.js:978

Параметры окна.

{number} [height=512] - Высота рабочей области канваса

Number

Defined in base\site3d.js:989

Параметры операций над канвасом.

controlsIsEnabled

Boolean

Defined in base\site3d.js:2992

Свойство возвращает истину, если включено управление сценой

controlsIsEnabled

Unknown

Defined in base\site3d.js:3002

Свойство устанавливает включение или отключение управления сценой

Sub-properties:

  • value Boolean

    Значение

controlsTarget

Site3dPoint3D

Defined in base\site3d.js:3019

Свойство возвращает центр масштабирования и вращения

controlsTarget

Unknown

Defined in base\site3d.js:3029

Свойство устанавливает центр масштабирования и вращения

Sub-properties:

  • target Site3dPoint3D

    Позиция

controlsPrevTarget

Site3dPoint3D

Defined in base\site3d.js:3095

Свойство возвращает предыдущий центр масштабирования и вращения

controlsTargetDistance

Number

Defined in base\site3d.js:3105

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

canvas

HTMLCanvasElement

Defined in base\site3d.js:3445

Свойство возвращает холст сцены

options

Site3dSceneOptions

Defined in base\site3d.js:3455

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

webglVersion

String

Defined in base\site3d.js:3465

Свойство возвращает версию WebGL

isPostRender

Boolean

Defined in base\site3d.js:3475

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

isPostRender

Unknown

Defined in base\site3d.js:3485

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

lastRender

Site3dRender

Defined in base\site3d.js:3516

Свойство возвращает последний запущенный рендер сцены

shadows

Boolean

Defined in base\site3d.js:3526

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

shadows

Unknown

Defined in base\site3d.js:3536

Свойство включает и отключает тени у всех источников

info

Site3dSceneInfo

Defined in base\site3d.js:3548

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

maxAnisotropy

Number

Defined in base\site3d.js:3560

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

scene

Scene

Defined in base\site3d.js:3570

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

camera

Site3dCamera

Defined in base\site3d.js:3580

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

models

Map

Defined in base\site3d.js:3590

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

materials

Map

Defined in base\site3d.js:3600

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

lights

Map

Defined in base\site3d.js:3610

Свойство возвращает коллекцию источников освещения

controls

Site3dControlsOptions

Defined in base\site3d.js:3620

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

actions

Site3dActions

Defined in base\site3d.js:3630

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

events

Map

Defined in base\site3d.js:3640

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

quality

Number

Defined in base\site3d.js:3919

Свойство возвращает качество рендера от 1 до 100

quality

Unknown

Defined in base\site3d.js:3929

Свойство устанавливает качество рендера

Sub-properties:

  • value Number

    Качество рендера от 1 до 100

alpha

Boolean

Defined in base\site3d.js:3945

Свойство возвращает включение прозрачности

alpha

Unknown

Defined in base\site3d.js:3955

Свойство устанавливает включение прозрачности

Sub-properties:

  • value Boolean

    Включение прозрачности

isCursorPointer

Boolean

Defined in base\site3d.js:4066

Свойство возвращает показ и скрытие курсора при наведении указателя

isCursorPointer

Unknown

Defined in base\site3d.js:4076

Свойство устанавливает показ и скрытие курсора при наведении указателя

Sub-properties:

  • value Boolean

    Значение

hideByClickDone

Boolean

Defined in base\site3d.js:4123

Свойство возвращает истину, если произошло закрытие DOM элементов по клику вне их области