API Docs for: 1.0.0
Show:

Site3dModel Class

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

Класс модели

Methods

isItem

(
  • name
)
Boolean

Defined in base\site3d.js:3603

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

Parameters:

  • name String

    Имя модели

Returns:

Boolean:

Результат

item

(
  • name
)
Site3dModel

Defined in base\site3d.js:3614

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

Parameters:

  • name String

    Имя модели

Returns:

Site3dModel:

Модель

searchItems

(
  • value
)
Site3dModel[]

Defined in base\site3d.js:3631

Метод ищет в модели его части

Parameters:

  • value String

    Имя части модели (можно указать только часть имени)

Returns:

Site3dModel[]:

Результат

addEventItem

(
  • model
)

Defined in base\site3d.js:3642

Метод добавляет модель в список моделей, для которых обрабатываются события

Parameters:

saveGeometry

()

Defined in base\site3d.js:3652

Метод сохраняет геометрию модели

loadGeometry

()

Defined in base\site3d.js:3661

Метод загружает геометрию модели

setGeometryFromModel

(
  • model
)

Defined in base\site3d.js:3670

Метод загружает геометрию модели

Parameters:

updateGeometry

(
  • data
)

Defined in base\site3d.js:3684

Метод обновляет геометрию модели

Parameters:

  • data Object

    Данные для обновления геометрии

subtractModelBound

(
  • model
)

Defined in base\site3d.js:3697

Метод вычитает из модели геометрию границы другой модели

Parameters:

isLoaded

() Boolean

Defined in base\site3d.js:3720

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

Returns:

Boolean:

Результат

show

(
  • options
)

Defined in base\site3d.js:3730

Метод показывает модель

Parameters:

  • options Object

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

showSilent

(
  • options
)

Defined in base\site3d.js:3741

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

Parameters:

  • options Object

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

hide

(
  • options
)

Defined in base\site3d.js:3759

Метод скрывает модель

Parameters:

  • options Object

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

hideSilent

(
  • options
)

Defined in base\site3d.js:3770

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

Parameters:

  • options Object

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

remove

()

Defined in base\site3d.js:3790

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

removeSilent

()

Defined in base\site3d.js:3800

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

getPos

() Array

Defined in base\site3d.js:3831

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

Returns:

Array:

Позиция

getPrevPos

() Array

Defined in base\site3d.js:3843

Метод возвращает предыдущую позицию модели

Returns:

Array:

Позиция

pos

()

Defined in base\site3d.js:3853

Метод изменяет позицию модели (передаются координаты в виде трех параметров или массив координат)

posSilent

()

Defined in base\site3d.js:3864

Метод изменяет позицию модели без вызова отрисовки (смотрите описание параметров для метода pos)

move

()

Defined in base\site3d.js:3876

Метод перемещает модель. Варианты параметров:

  • step – движение в направлении взгляда вдоль плоскости xz
  • step, pos – движение в направлении точки pos
  • stepX, stepY, stepZ, options – движение по трем осям, где options:
  • isLocal – истина, если локальное перемещение (по умолчанию истина)

moveSilent

()

Defined in base\site3d.js:3890

Метод перемещает модель без вызова отрисовки (смотрите описание параметров для метода move)

movedPos

() Array

Defined in base\site3d.js:3935

Метод возвращает позицию точки, возникшей путем перемещения модели (смотрите описание параметров для метода move)

Returns:

Array:

Позиция

getScale

() Array

Defined in base\site3d.js:3949

Метод возвращает масштаб модели в виде массива значений по трем осям

Returns:

Array:

Масштаб

scale

()

Defined in base\site3d.js:3959

Метод изменяет масштаб модели (можно задать одно значение для установки одинакового значения по трем осям)

scaleSilent

()

Defined in base\site3d.js:3969

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

zoom

(
  • stepX
  • stepY
  • stepZ
)

Defined in base\site3d.js:4004

Метод изменяет масштаб модели на определенный шаг (можно задать одно значение для равномерного масштабирования по трем осям)

Parameters:

  • stepX Number

    Шаг масштаба по оси X

  • stepY Number

    Шаг масштаба по оси Y

  • stepZ Number

    Шаг масштаба по оси Z

zoomSilent

()

Defined in base\site3d.js:4017

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

getRot

() Array

Defined in base\site3d.js:4030

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

Returns:

Array:

Состояние поворота

rot

()

Defined in base\site3d.js:4040

Метод устанавливает состояние поворота модели (передаются углы поворота в виде трех параметров или массив углов)

rotSilent

()

Defined in base\site3d.js:4050

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

rotate

(
  • stepX
  • stepY
  • stepZ
  • options
)

Defined in base\site3d.js:4062

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

Parameters:

  • stepX Number

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

  • stepY Number

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

  • stepZ Number

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

  • options Object

    Параметры:

    • isLocal – истина, если оси локальные (по умолчанию истина)
    • duration – время анимации

rotateSilent

()

Defined in base\site3d.js:4078

Метод поворачивает модель по трем локальным для модели или глобальным осям без вызова отрисовки (смотрите описание параметров для метода rotate)

playRotate

()

Defined in base\site3d.js:4169

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

pauseRotate

()

Defined in base\site3d.js:4178

Метод ставит вращение на паузу

stopRotate

()

Defined in base\site3d.js:4187

Метод останавливает вращение

fill

(
  • fill
  • load
)
async

Defined in base\site3d.js:4196

Метод редактирует наполнение (материал)

Parameters:

  • fill Object

    Наполнение

  • load Function

    Функция обработки окончания наполнения

getColor

() String

Defined in base\site3d.js:4228

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

Returns:

String:

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

worldToLocal

(
  • pos
)
Number[]

Defined in base\site3d.js:4238

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

Parameters:

  • pos Number[]

    Позиция в глобальных координатах

Returns:

Number[]:

Позиция в локальных координатах

localToWorld

(
  • pos
)
Number[]

Defined in base\site3d.js:4252

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

Parameters:

  • pos Number[]

    Позиция в локальных координатах

Returns:

Number[]:

Позиция в глобальных координатах

enableShadows

(
  • actions
)

Defined in base\site3d.js:4266

Метод включает тени от модели

Parameters:

  • actions String

    Режим (по умолчанию «castReceive»):

    • «cast» – отбрасывать тени
    • «receive» – принимать тени
    • «castReceive» – отбрасывать и принимать тени

disableShadows

()

Defined in base\site3d.js:4288

Метод отключает тени от модели

enableControls

(
  • options
)

Defined in base\site3d.js:4308

Метод включает управление моделью

Parameters:

  • options Object

    Параметры:

    • scale – масштабирование колесом прокрутки:
    • isEnabled – истина, если масштабирование включено (по умолчанию включено, если передать параметр scale)
    • min – минимальный масштаб (по умолчанию: 0.5)
    • max – максимальный масштаб (по умолчанию: 2)
    • speed – скорость (по умолчанию: 1)
    • rotate – вращение:
    • isEnabled – истина, если вращение включено (по умолчанию включено, если передать параметр rotate)
    • events – массив строк органов управления (возможные значения: «mouse_left» – левая кнопка мыши, «mouse_right» – правая кнопка мыши, «touch_move» – перемещение пальцем (по умолчанию: [«mouse_left», «touch_move»]))
    • axes – оси вращения (x, y или x и y одновременно (по умолчанию: «xy»))
    • speed – скорость (по умолчанию: 1)

disableControls

()

Defined in base\site3d.js:4345

Метод отключает управление моделью

connect

(
  • options
)

Defined in base\site3d.js:4356

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

Parameters:

  • options Object

    Параметры:

    • modelName – имя модели (если пустое значение, то соединение с камерой)
    • moveLocal - смещение в рамках локальных осей модели
    • rotateLocal – поворот относительно локальных осей

disconnect

()

Defined in base\site3d.js:4382

Метод отключает соединение

updateConnect

()

Defined in base\site3d.js:4391

Метод обновляет соединение (срабатывает при каждой отрисовке)

intersect

(
  • fromModels
  • options
)
Object

Defined in base\site3d.js:4484

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

Parameters:

  • fromModels Array

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

  • options Object

    Параметры:

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

Returns:

Object:

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

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

intersectModel

(
  • model
)
Object

Defined in base\site3d.js:4499

Метод возвращает информацию о взаимном расположении модели с другой моделью

Parameters:

Returns:

Object:

Объект результата {minDistance, minPos1, minPos2}:

  • minDistance - минимальное расстояние между гранями двух параллелепипедов (если пересекаются, то -1, если совпадают, то 0)
  • minPos1 - позиция линии минимального расстояния на грани первого параллелепипеда
  • minPos2 - позиция линии минимального расстояния на грани второго параллелепипеда

getNoIntersectShiftOnXZ

(
  • models
)
Number[]

Defined in base\site3d.js:4523

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

Parameters:

Returns:

Number[]:

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

getSize

() Number[]

Defined in base\site3d.js:4536

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

Returns:

Number[]:

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

getVolume

() Number

Defined in base\site3d.js:4550

Метод возвращает объем параллелепипеда, в который вписывается модель

Returns:

Number:

Объем

calcSize

()

Defined in base\site3d.js:4560

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

getMinViewDistance

() Number

Defined in base\site3d.js:4570

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

Returns:

Number:

Расстояние

getViewDistance

(
  • distance
)
Number

Defined in base\site3d.js:4580

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

Parameters:

  • distance Any

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

Returns:

Number:

Расстояние

getPosFromTarget

() Array

Defined in base\site3d.js:4592

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

Returns:

Array:

Расстояние

createBound

()

Defined in base\site3d.js:4602

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

createEdges

()

Defined in base\site3d.js:4611

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

updateEdges

()

Defined in base\site3d.js:4631

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

fillEdges

()

Defined in base\site3d.js:4666

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

showEdges

()

Defined in base\site3d.js:4692

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

showEdges

()

Defined in base\site3d.js:4711

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

updateBound

()

Defined in base\site3d.js:4730

Метод обновляет положение границы вокруг модели

createBound

()

Defined in base\site3d.js:4739

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

rebuildBound

()

Defined in base\site3d.js:4748

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

getBoundPosList

() Number[]

Defined in base\site3d.js:4757

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

Returns:

Number[]:

Вершины границы

setFrame

(
  • options
)

Defined in base\site3d.js:4767

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

Parameters:

  • options Object

    Параметры:

    • color - цвет каркаса в HEX-формате
    • thickness - толщина каркаса

showFrame

(
  • options
)

Defined in base\site3d.js:4783

Метод показывает каркас границы объекта

Parameters:

  • options Object

    Параметры:

    • color - цвет каркаса в HEX-формате

hideFrame

()

Defined in base\site3d.js:4800

Метод скрывает каркас границы объекта

checkIntersect

(
  • model
)
Object

Defined in base\site3d.js:4813

Метод возвращает информацию о взаимном расположении модели с другой моделью

Parameters:

Returns:

Object:

Объект результата {minDistance, minPos1, minPos2}:

  • minDistance - минимальное расстояние между гранями границ двух моделей (если пересекаются, то -1, если совпадают, то 0)
  • minPos1 - позиция линии минимального расстояния на грани первой границы
  • minPos2 - позиция линии минимального расстояния на грани второй границы

label

(
  • name
  • options
)

Defined in base\site3d.js:4840

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

Parameters:

  • name String

    Имя метки

  • options Object

    Параметры:

    • content – идентификатор HTML-элемента
    • pos – позиция относительно модели (по умолчанию [0, 0, 0])
    • text - Текст метки
    • isEnabled – истина, если метка видна (по умолчанию истина)

removeLabel

(
  • name
)

Defined in base\site3d.js:4870

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

Parameters:

  • name String

    Имя метки

enableLabels

()

Defined in base\site3d.js:4883

Метод показывает все метки

disableLabels

()

Defined in base\site3d.js:4893

Метод скрывает все метки

setInitEventsActivityLabels

()

Defined in base\site3d.js:4903

Метод включает события для всех меток

disableEventsLabels

()

Defined in base\site3d.js:4912

Метод выключает события для всех меток

updateLabels

()

Defined in base\site3d.js:4921

Метод обновляет метки (вызывается автоматически в процессе отрисовки)

removeLabels

()

Defined in base\site3d.js:4945

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

render

()

Defined in base\site3d.js:4971

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

setRenderOrder

(
  • order
)

Defined in base\site3d.js:4988

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

Parameters:

  • order Number

    Порядковый номер

Properties

s3d

Site3d

Defined in base\site3d.js:3404

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

name

String

Defined in base\site3d.js:3414

Свойство возвращает имя модели

mesh

Mesh

Defined in base\site3d.js:3424

Свойство возвращает меш модели

parentModel

Site3dModel

Defined in base\site3d.js:3434

Свойство возвращает меш модели

size

Number[]

Defined in base\site3d.js:3444

Свойство возвращает размеры модели

volume

Number

Defined in base\site3d.js:3454

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

items

Map

Defined in base\site3d.js:3464

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

eventItems

Map

Defined in base\site3d.js:3474

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

bound

Site3dModelBound

Defined in base\site3d.js:3484

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

edges

Edges

Defined in base\site3d.js:3494

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

labels

Map

Defined in base\site3d.js:3504

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

content

HTMLElement

Defined in base\site3d.js:3514

Свойство возвращает связанный с моделью HTML-элемент с контентом

info

Object

Defined in base\site3d.js:3524

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

isVisible

Boolean

Defined in base\site3d.js:3534

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

isVisible

Unknown

Defined in base\site3d.js:3544

Свойство устанавливает видимость модели

Sub-properties:

isVisibleFrame

Boolean

Defined in base\site3d.js:3557

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

isVisibleFrame

Unknown

Defined in base\site3d.js:3567

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

Sub-properties:

isVisibleEdges

Boolean

Defined in base\site3d.js:3580

Свойство возвращает истину, если видна сетка модели в виде граней

isVisibleEdges

Unknown

Defined in base\site3d.js:3590

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

Sub-properties:

isRotate

Boolean

Defined in base\site3d.js:4159

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

log

Object

Defined in base\site3d.js:5002

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