API Docs for:
Show:

Site3d Class

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

Класс сцены

Constructor

Site3d

(
  • canvasId
  • options
)

Defined in base\site3d.js:11

Parameters:

  • canvasId String

    Идентификатор тега canvas

  • options Object

    Параметры сцены:

    • load(info) – функция обработки процесса загрузки сцены, которая в качестве аргумента возвращает объект со следующими свойствами:
    • countModel – число добавленных для загрузки моделей
    • countModelLoaded – число загруженных моделей
    • isPreloadCompleted – истина, если завершена предварительная загрузка сцены (данный этап помечается методом preload)
    • quality – качество рендера от 1 до 100 (по умолчанию 100)

Item Index

Methods

Properties

Events

Methods

() String static

Defined in base\common\debug\_В разработке\three_178.js:2280

Generate a [UUID]{@link https://en.wikipedia.org/wiki/Universally_unique_identifier} (universally unique identifier).

Returns:

String:

The UUID.

(
  • value
  • min
  • max
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2289

Clamps the given value between min and max.

Parameters:

  • value Number
    • The value to clamp.
  • min Number
    • The min value.
  • max Number
    • The max value.

Returns:

Number:

The clamped value.

(
  • n
  • m
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2300

Computes the Euclidean modulo of the given parameters that is ( ( n % m ) + m ) % m.

Parameters:

  • n Number
    • The first parameter.
  • m Number
    • The second parameter.

Returns:

Number:

The Euclidean modulo.

(
  • x
  • a1
  • a2
  • b1
  • b2
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2311

Performs a linear mapping from range <a1, a2> to range <b1, b2> for the given value.

Parameters:

  • x Number
    • The value to be mapped.
  • a1 Number
    • Minimum value for range A.
  • a2 Number
    • Maximum value for range A.
  • b1 Number
    • Minimum value for range B.
  • b2 Number
    • Maximum value for range B.

Returns:

Number:

The mapped value.

(
  • x
  • y
  • value
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2325

Returns the percentage in the closed interval [0, 1] of the given value between the start and end point.

Parameters:

  • x Number
    • The start point
  • y Number
    • The end point.
  • value Number
    • A value between start and end.

Returns:

Number:

The interpolation factor.

(
  • x
  • y
  • t
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2337

Returns a value linearly interpolated from two known points based on the given interval - t = 0 will return x and t = 1 will return y.

Parameters:

  • x Number
    • The start point
  • y Number
    • The end point.
  • t Number
    • The interpolation factor in the closed interval [0, 1].

Returns:

Number:

The interpolated value.

(
  • x
  • y
  • lambda
  • dt
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2349

Smoothly interpolate a number from x to y in a spring-like manner using a delta time to maintain frame rate independent movement. For details, see [Frame rate independent damping using lerp]{@link http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/}.

Parameters:

  • x Number
    • The current point.
  • y Number
    • The target point.
  • lambda Number
    • A higher lambda value will make the movement more sudden, and a lower value will make the movement more gradual.
  • dt Number
    • Delta time in seconds.

Returns:

Number:

The interpolated value.

(
  • x
  • [length=1]
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2364

Returns a value that alternates between 0 and the given length parameter.

Parameters:

  • x Number
    • The value to pingpong.
  • [length=1] Number optional
    • The positive value the function will pingpong to.

Returns:

Number:

The alternated value.

(
  • x
  • min
  • max
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2374

Returns a value in the range [0,1] that represents the percentage that x has moved between min and max, but smoothed or slowed down the closer x is to the min and max.

See [Smoothstep]{@link http://en.wikipedia.org/wiki/Smoothstep} for more details.

Parameters:

  • x Number
    • The value to evaluate based on its position between min and max.
  • min Number
    • The min value. Any x value below min will be 0.
  • max Number
    • The max value. Any x value above max will be 1.

Returns:

Number:

The alternated value.

(
  • x
  • min
  • max
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2389

A [variation on smoothstep]{@link https://en.wikipedia.org/wiki/Smoothstep#Variations} that has zero 1st and 2nd order derivatives at x=0 and x=1.

Parameters:

  • x Number
    • The value to evaluate based on its position between min and max.
  • min Number
    • The min value. Any x value below min will be 0.
  • max Number
    • The max value. Any x value above max will be 1.

Returns:

Number:

The alternated value.

(
  • low
  • high
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2401

Returns a random integer from <low, high> interval.

Parameters:

  • low Number
    • The lower value boundary.
  • high Number
    • The upper value boundary

Returns:

Number:

A random integer.

(
  • low
  • high
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2411

Returns a random float from <low, high> interval.

Parameters:

  • low Number
    • The lower value boundary.
  • high Number
    • The upper value boundary

Returns:

Number:

A random float.

(
  • range
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2421

Returns a random integer from <-range/2, range/2> interval.

Parameters:

  • range Number
    • Defines the value range.

Returns:

Number:

A random float.

(
  • [s]
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2430

Returns a deterministic pseudo-random float in the interval [0, 1].

Parameters:

  • [s] Number optional
    • The integer seed.

Returns:

Number:

A random float.

(
  • degrees
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2439

Converts degrees to radians.

Parameters:

  • degrees Number
    • A value in degrees.

Returns:

Number:

The converted value in radians.

(
  • radians
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2448

Converts radians to degrees.

Parameters:

  • radians Number
    • A value in radians.

Returns:

Number:

The converted value in degrees.

(
  • value
)
Boolean static

Defined in base\common\debug\_В разработке\three_178.js:2457

Returns true if the given number is a power of two.

Parameters:

  • value Number
    • The value to check.

Returns:

Boolean:

Whether the given number is a power of two or not.

(
  • value
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2466

Returns the smallest power of two that is greater than or equal to the given number.

Parameters:

  • value Number
    • The value to find a POT for.

Returns:

Number:

The smallest power of two that is greater than or equal to the given number.

(
  • value
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2475

Returns the largest power of two that is less than or equal to the given number.

Parameters:

  • value Number
    • The value to find a POT for.

Returns:

Number:

The largest power of two that is less than or equal to the given number.

(
  • q
  • a
  • b
  • c
  • order
)
static

Defined in base\common\debug\_В разработке\three_178.js:2484

Sets the given quaternion from the [Intrinsic Proper Euler Angles]{@link https://en.wikipedia.org/wiki/Euler_angles} defined by the given angles and order.

Rotations are applied to the axes in the order specified by order: rotation by angle a is applied first, then by angle b, then by angle c.

Parameters:

  • q Quaternion
    • The quaternion to set.
  • a Number
    • The rotation applied to the first axis, in radians.
  • b Number
    • The rotation applied to the second axis, in radians.
  • c Number
    • The rotation applied to the third axis, in radians.
  • order ('XYX' | 'XZX' | 'YXY' | 'YZY' | 'ZXZ' | 'ZYZ')
    • A string specifying the axes order.

(
  • value
  • array
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2500

Normalizes the given value according to the given typed array.

Parameters:

  • value Number
    • The float value in the range [0,1] to normalize.
  • array TypedArray
    • The typed array that defines the data type of the value.

Returns:

Number:

The normalize value.

(
  • value
  • array
)
Number static

Defined in base\common\debug\_В разработке\three_178.js:2510

Denormalizes the given value according to the given typed array.

Parameters:

  • value Number
    • The value to denormalize.
  • array TypedArray
    • The typed array that defines the data type of the value.

Returns:

Number:

The denormalize (float) value in the range [0,1].

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.

getVector

(
  • array
)
Vector3 static

Defined in base\site3d.js:627

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

Parameters:

  • array Number

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

Returns:

Vector3:

Объект Vector3

getArrayVector

(
  • vector
)
Number static

Defined in base\site3d.js:639

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

Parameters:

  • vector Object

    Тройка чисел в виде объекта

Returns:

Number:

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

normalizeRad

(
  • angle
)
Number static

Defined in base\site3d.js:651

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

Parameters:

  • angle Number

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

Returns:

Number:

Результат

normalizeDeg

(
  • angle
)
Number static

Defined in base\site3d.js:663

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

Parameters:

  • angle Number

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

Returns:

Number:

Результат

toRad

(
  • angle
)
Number static

Defined in base\site3d.js:675

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

Parameters:

  • angle Number

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

Returns:

Number:

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

toDeg

(
  • angle
)
Number static

Defined in base\site3d.js:687

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

Parameters:

  • angle Number

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

Returns:

Number:

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

getFloat

(
  • value
  • fraction
)
Number | number static

Defined in base\site3d.js:699

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

Parameters:

  • value Number | string | number | string

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

  • fraction Number

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

Returns:

Number | number:

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

getFloatArray

(
  • array
  • fraction
)
Number static

Defined in base\site3d.js:722

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

Parameters:

  • array Number | string

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

  • fraction Number

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

Returns:

Number:

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

isPosEqual

(
  • pos1
  • pos2
  • error
)
Boolean static

Defined in base\site3d.js:740

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

Parameters:

  • pos1 Number

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

  • pos2 Number

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

  • error Number

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

Returns:

Boolean:

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

sum

() Number static

Defined in base\site3d.js:754

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

Returns:

Number:

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

diff

(
  • pos1
  • pos2
  • fraction
)
Number static

Defined in base\site3d.js:779

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

Parameters:

  • pos1 Number

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

  • pos2 Number

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

  • fraction Number

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

Returns:

Number:

Разность

getDistance

(
  • pos1
  • pos2
)
Number static

Defined in base\site3d.js:793

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

Parameters:

  • pos1 Number

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

  • pos2 Number

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

Returns:

Number:

Расстояние

mousePos

(
  • e
)
Number static

Defined in base\site3d.js:806

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

Parameters:

  • e Object

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

Returns:

Number:

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

fingerDistance

(
  • p1
  • p2
)
Number static

Defined in base\site3d.js:818

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

Parameters:

  • p1 Object

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

  • p2 Object

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

Returns:

Number:

Расстояние

getModelsCenter

(
  • models
)
Number static

Defined in base\site3d.js:861

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

Parameters:

Returns:

Number:

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

getModelsBoundSize

(
  • models
)
Number static

Defined in base\site3d.js:873

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

Parameters:

Returns:

Number:

Размеры

getModelsInfo

(
  • models
  • include
)
Object static

Defined in base\site3d.js:885

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

Parameters:

  • models Site3dModel[]

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

  • include String

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

Returns:

Object:

Результат

blobToBase64

(
  • blob
)
Promise static async

Defined in base\site3d.js:912

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

Parameters:

  • blob Blob

    Blob объект

Returns:

Promise:

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

clear

() static

Defined in base\site3d.js:946

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

preload

()

Defined in base\site3d.js:961

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

getElapsedTime

() Number

Defined in base\site3d.js:971

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

Returns:

Number:

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

background

(
  • value
)

Defined in base\site3d.js:983

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

Parameters:

  • value String | null

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

setEffectsActivity

()

Defined in base\site3d.js:1004

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

effects

(
  • options
)

Defined in base\site3d.js:1021

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

Parameters:

  • options Object

    Параметры эффектов:

    • brightness – яркость от 0 до 10 (по умолчанию 5)
    • contrast – контраст от 0 до 10 (по умолчанию 5)

setModelOutline

(
  • model
  • options
)

Defined in base\site3d.js:1141

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

Parameters:

  • model Site3dModel

    Модель

  • options Object

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

showModelOutline

(
  • model
)

Defined in base\site3d.js:1167

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

Parameters:

hideModelOutline

(
  • model
)

Defined in base\site3d.js:1184

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

Parameters:

updateOutlines

()

Defined in base\site3d.js:1201

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

clearOutlines

()

Defined in base\site3d.js:1283

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

updateWatermark

(
  • value
)
async

Defined in base\site3d.js:1293

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

Parameters:

  • value Object

    Параметры

enableEnvironment

(
  • options
)

Defined in base\site3d.js:1335

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

Parameters:

  • options String

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

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

disableEnvironment

()

Defined in base\site3d.js:1377

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

fog

(
  • options
)

Defined in base\site3d.js:1391

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

Parameters:

  • options String

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

    • color – цвет
    • near и far – параметры густоты тумана в зависимости от расстояния

cameraSetup

(
  • options
)

Defined in base\site3d.js:1405

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

Parameters:

  • options Object

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

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

cameraRotateWorld

(
  • stepX
  • stepY
  • stepZ
)

Defined in base\site3d.js:1419

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

Parameters:

  • stepX Number

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

  • stepY Number

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

  • stepZ Number

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

cameraSetPrev

()

Defined in base\site3d.js:1431

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

line

(
  • name
  • posList
  • fill
  • load
)
Site3dLine

Defined in base\site3d.js:1442

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

Parameters:

  • name String

    Имя модели

  • posList Number[]

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

  • fill Object

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

  • load Function

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

Returns:

Site3dLine:

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

sprite

(
  • name
  • path
  • load
)
Site3dSprite

Defined in base\site3d.js:1456

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

Parameters:

  • name String

    Имя модели

  • path String

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

  • load Function

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

Returns:

Site3dSprite:

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

triangle

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

Defined in base\site3d.js:1469

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

Parameters:

  • name String

    Имя модели

  • pos1 Number

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

  • pos2 Number

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

  • pos3 Number

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

  • fill Object

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

  • load Function

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

Returns:

Site3dTriangle:

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

plane

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

Defined in base\site3d.js:1485

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

Parameters:

  • name String

    Имя модели

  • width Number

    Ширина

  • height Number

    Высота

  • fill Object

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

  • load Function

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

Returns:

Site3dPlane:

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

circle

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

Defined in base\site3d.js:1500

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

Parameters:

  • name String

    Имя модели

  • radius Number

    Радиус

  • detail Number

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

  • fill Object

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

  • load Function

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

Returns:

Site3dCircle:

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

cube

(
  • name
  • size
  • fill
  • load
)
Site3dCube

Defined in base\site3d.js:1515

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

Parameters:

  • name String

    Имя модели

  • size Number

    Размеры

  • fill Object

    Наполнение

  • load Function

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

Returns:

Site3dCube:

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

sphere

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

Defined in base\site3d.js:1529

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

Parameters:

  • name String

    Имя модели

  • radius Number

    Радиус

  • detail Number

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

  • fill Object

    Наполнение

  • load Function

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

Returns:

Site3dSphere:

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

hemisphere

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

Defined in base\site3d.js:1544

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

Parameters:

  • name String

    Имя модели

  • radius Number

    Радиус

  • detail Number

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

  • fill Object

    Наполнение

  • load Function

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

Returns:

Site3dHemisphere:

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

octahedron

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

Defined in base\site3d.js:1559

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

Parameters:

  • name String

    Имя модели

  • radius Number

    Радиус

  • detail Number

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

  • fill Object

    Наполнение

  • load Function

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

Returns:

Site3dOctahedron:

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

shape

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

Defined in base\site3d.js:1574

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

Parameters:

  • name String

    Имя модели

  • points Number[]

    Массив точек

  • fill Object

    Наполнение

  • options Object

    Параметры:

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

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

Returns:

Site3dShape:

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

importModel

(
  • name
  • path
  • options
)
Site3dImportModel

Defined in base\site3d.js:1592

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

Parameters:

  • name String

    Имя модели

  • path String

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

  • options Object

    Параметры

Returns:

Site3dImportModel:

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

importModelAsync

(
  • name
  • path
  • options
)
Site3dImportModel async

Defined in base\site3d.js:1605

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

Parameters:

  • name String

    Имя модели

  • path String

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

  • options Object

    Параметры

Returns:

Site3dImportModel:

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

modelClipping

(
  • name
  • model
  • options
  • load
)
Site3dModelClipping

Defined in base\site3d.js:1645

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

Parameters:

  • name String

    Имя модели

  • model Site3dModel

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

  • options Object

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

  • load Function

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

Returns:

Site3dModelClipping:

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

isModel

(
  • name
)
Boolean

Defined in base\site3d.js:1659

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

Parameters:

  • name String

    Имя модели

Returns:

Boolean:

Результат

model

(
  • name
)
Site3dModel

Defined in base\site3d.js:1670

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

Parameters:

  • name String

    Имя модели

Returns:

Site3dModel:

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

removeModel

(
  • name
)

Defined in base\site3d.js:1681

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

Parameters:

  • name String

    Имя модели

removeModelSilent

(
  • name
)

Defined in base\site3d.js:1695

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

Parameters:

  • name String

    Имя модели

addFill

(
  • name
  • fill
  • load
)
async

Defined in base\site3d.js:1711

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

Parameters:

  • name String

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

  • fill Object

    Наполнение

  • load Function

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

ambientLight

(
  • name
  • options
)
Site3dAmbientLight

Defined in base\site3d.js:1730

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

Parameters:

  • name String

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

  • options Object

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

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

Returns:

Site3dAmbientLight:

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

directionalLight

(
  • name
  • options
)
Site3dDirectionalLight

Defined in base\site3d.js:1751

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

Parameters:

  • name String

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

  • options Object

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

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

Returns:

Site3dDirectionalLight:

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

spotLight

(
  • name
  • options
)
Site3dSpotLight

Defined in base\site3d.js:1775

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

Parameters:

  • name String

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

  • options Object

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

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

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

Parameters:

  • name String

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

Returns:

Site3dLight:

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

enableControls

(
  • options
)

Defined in base\site3d.js:1806

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

Parameters:

  • options Object

    Параметры:

    • 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)
    • axes – оси вращения (y (по умолчанию: «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:1875

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

setControlsTargetSilent

(
  • target
)
Boolean

Defined in base\site3d.js:1934

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

Parameters:

  • target Number

    Позиция

Returns:

Boolean:

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

moveControlsTarget

(
  • steps
)

Defined in base\site3d.js:1951

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

Parameters:

  • steps Number

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

moveControlsTargetSilent

(
  • steps
)

Defined in base\site3d.js:1964

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

Parameters:

  • steps Number

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

rotateAroundTarget

(
  • angle
  • options
)

Defined in base\site3d.js:2007

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

Parameters:

  • angle Number

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

  • options Object

    Параметры

intersectModel

(
  • model
  • fromModels
  • options
)
Object | null

Defined in base\site3d.js:2036

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

Parameters:

  • model Site3dModel

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

  • fromModels Site3dModel[] | null

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

  • options Object

    Параметры:

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

Returns:

Object | null:

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

  • model - модель, с которой нашлось пересечение
  • pos - позиция пересечения

event

(
  • name
  • call
  • options
)

Defined in base\site3d.js:2161

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

Parameters:

  • name String

    Имя события

  • call Function

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

  • options Object

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

removeEvent

(
  • name
  • call
)

Defined in base\site3d.js:2184

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

Parameters:

  • name String

    Имя события

  • call Function

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

callEvent

(
  • name
  • options
)

Defined in base\site3d.js:2195

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

Parameters:

  • name String

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

  • options Object

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

startCallEvents

()

Defined in base\site3d.js:2224

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

startCallEvents

()

Defined in base\site3d.js:2233

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

addEventListener

(
  • name
  • handler
)

Defined in base\site3d.js:2242

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

Parameters:

  • name String

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

  • handler Function

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

removeEventListener

(
  • name
  • handler
)

Defined in base\site3d.js:2254

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

Parameters:

  • name String

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

  • handler Function

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

setEvents

(
  • domElement
)

Defined in base\site3d.js:2266

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

Parameters:

  • domElement HTMLElement

    HTML-элемент

setPostRenderPrev

()

Defined in base\site3d.js:2340

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

startLastRender

()

Defined in base\site3d.js:2487

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

stopLastRender

()

Defined in base\site3d.js:2496

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

render

(
  • options
)

Defined in base\site3d.js:2505

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

Parameters:

  • options Object

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

updateIsRender

(
  • value
)

Defined in base\site3d.js:2593

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

Parameters:

  • value Boolean

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

renderOn

(
  • render
)

Defined in base\site3d.js:2613

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

Parameters:

  • render Site3dRender

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

renderOff

()

Defined in base\site3d.js:2628

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

setRenderSize

(
  • size
)

Defined in base\site3d.js:2637

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

Parameters:

  • size Number

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

resize

(
  • options
)

Defined in base\site3d.js:2675

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

Parameters:

  • options Object

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

getScreenshotAsBlob

(
  • options
)
Blob async

Defined in base\site3d.js:2756

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

Parameters:

  • options Object

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

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

Returns:

Blob:

Скриншот

downloadScreenshot

(
  • fileName
  • options
)
async

Defined in base\site3d.js:2842

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

Parameters:

  • fileName String

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

  • options Object

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

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

hideByClick

(
  • elem
  • hide
  • except
)

Defined in base\site3d.js:2877

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

Parameters:

  • elem HTMLElement | string

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

  • hide Function

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

  • except HTMLElement

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

removeHideByClick

(
  • elem
)

Defined in base\site3d.js:2898

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

Parameters:

  • elem HTMLElement | string

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

updateHideByClickContainer

(
  • container
)

Defined in base\site3d.js:2923

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

Parameters:

  • container HTMLElement

    Элемент DOM

getMinViewDistance

(
  • size
  • options
)
Number

Defined in base\site3d.js:2939

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

Parameters:

  • size Number

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

  • options Object

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

Returns:

Number:

Расстояние

getViewDistance

(
  • size
  • distance
  • options
)
Number

Defined in base\site3d.js:2958

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

Parameters:

  • size Number

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

  • distance Number | string

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

  • options Object

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

Returns:

Number:

Расстояние

loseContext

()

Defined in base\site3d.js:2988

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

Properties

{number} PAN - A pan interaction.

Number

Defined in base\common\debug\_В разработке\three_178.js:1621

This type represents mouse buttons and interaction types in context of controls.

{number} DOLLY_ROTATE - A dolly-rotate interaction.

Number

Defined in base\common\debug\_В разработке\three_178.js:1633

This type represents touch interaction types in context of controls.

{string} RENDER - A `render` timestamp query.

String

Defined in base\common\debug\_В разработке\three_178.js:1643

This type represents the different timestamp query types.

{string} FLAT - Flat interpolation.

String

Defined in base\common\debug\_В разработке\three_178.js:1651

Represents the different interpolation sampling types.

{string} FLAT_EITHER - Flat interpolation using either vertex.

String

Defined in base\common\debug\_В разработке\three_178.js:1660

Represents the different interpolation sampling modes.

{boolean} [multiview=false] - Whether this target is used for multiview rendering.

Boolean

Defined in base\common\debug\_В разработке\three_178.js:8717

Render target options.

{number} instanceId - The index number of the instance where the ray intersects the {@link InstancedMesh}.

Number

Defined in base\common\debug\_В разработке\three_178.js:54565

The intersection point of a raycaster intersection test.

controlsIsEnabled

Boolean

Defined in base\site3d.js:1884

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

controlsIsEnabled

Unknown

Defined in base\site3d.js:1894

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

Sub-properties:

  • value Boolean

    Значение

controlsTarget

Number

Defined in base\site3d.js:1911

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

controlsTarget

Unknown

Defined in base\site3d.js:1921

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

Sub-properties:

  • target Number

    Позиция

controlsPrevTarget

Number

Defined in base\site3d.js:1987

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

controlsTargetDistance

Number

Defined in base\site3d.js:1997

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

canvas

HTMLCanvasElement

Defined in base\site3d.js:2283

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

options

Object

Defined in base\site3d.js:2293

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

webglVersion

String

Defined in base\site3d.js:2303

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

isPostRender

Boolean

Defined in base\site3d.js:2313

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

isPostRender

Unknown

Defined in base\site3d.js:2323

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

lastRender

Site3dRender

Defined in base\site3d.js:2354

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

shadows

Boolean

Defined in base\site3d.js:2364

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

shadows

Unknown

Defined in base\site3d.js:2374

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

info

Object

Defined in base\site3d.js:2385

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

maxAnisotropy

Number

Defined in base\site3d.js:2397

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

scene

Scene

Defined in base\site3d.js:2407

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

camera

Site3dCamera

Defined in base\site3d.js:2417

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

models

Map

Defined in base\site3d.js:2427

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

materials

Map

Defined in base\site3d.js:2437

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

lights

Map

Defined in base\site3d.js:2447

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

controls

Object

Defined in base\site3d.js:2457

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

actions

Object

Defined in base\site3d.js:2467

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

events

Map

Defined in base\site3d.js:2477

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

quality

Number

Defined in base\site3d.js:2705

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

quality

Unknown

Defined in base\site3d.js:2715

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

Sub-properties:

  • value Number

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

alpha

Boolean

Defined in base\site3d.js:2731

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

alpha

Unknown

Defined in base\site3d.js:2741

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

Sub-properties:

  • value Boolean

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

isCursorPointer

Boolean

Defined in base\site3d.js:2856

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

isCursorPointer

Unknown

Defined in base\site3d.js:2866

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

Sub-properties:

  • value Boolean

    Значение

hideByClickDone

Boolean

Defined in base\site3d.js:2913

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

Events

Texture#dispose

Object

Defined in base\common\debug\_В разработке\three_178.js:7484

Fires when the texture has been disposed of.

Object3D#added

Object

Defined in base\common\debug\_В разработке\three_178.js:13163

Fires when the object has been added to its parent object.

Object3D#removed

Object

Defined in base\common\debug\_В разработке\three_178.js:13171

Fires when the object has been removed from its parent object.

Object3D#childadded

Object

Defined in base\common\debug\_В разработке\three_178.js:13179

Fires when a new child object has been added.

Object3D#childremoved

Object

Defined in base\common\debug\_В разработке\three_178.js:13187

Fires when a child object has been removed.

Material#dispose

Object

Defined in base\common\debug\_В разработке\three_178.js:17222

Fires when the material has been disposed of.