API Docs for: 1.0.0
Show:

Site3dLine Class

Extends Site3dModel
Defined in: base\site3d.js:6471
Module: Site3d

Класс линии

Methods

isItem

(
  • name
)
Boolean

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

Parameters:

  • name String

    Имя модели

Returns:

Boolean:

Результат

item

(
  • name
)
Site3dModel

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

Parameters:

  • name String

    Имя модели

Returns:

Site3dModel:

Модель

searchItems

(
  • value
)
Site3dModel[]

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

Parameters:

  • value String

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

Returns:

Site3dModel[]:

Результат

addEventItem

(
  • model
)

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

Parameters:

saveGeometry

()

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

loadGeometry

()

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

setGeometryFromModel

(
  • model
)

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

Parameters:

updateGeometry

(
  • data
)

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

Parameters:

  • data Object

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

subtractModelBound

(
  • model
)

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

Parameters:

isLoaded

() Boolean

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

Returns:

Boolean:

Результат

show

(
  • options
)

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

Parameters:

  • options Object

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

showSilent

(
  • options
)

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

Parameters:

  • options Object

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

hide

(
  • options
)

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

Parameters:

  • options Object

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

hideSilent

(
  • options
)

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

Parameters:

  • options Object

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

remove

()

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

removeSilent

()

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

getPos

() Array

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

Returns:

Array:

Позиция

getPrevPos

() Array

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

Returns:

Array:

Позиция

pos

()

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

posSilent

()

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

move

()

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

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

moveSilent

()

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

movedPos

() Array

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

Returns:

Array:

Позиция

getScale

() Array

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

Returns:

Array:

Масштаб

scale

()

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

scaleSilent

()

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

zoom

(
  • stepX
  • stepY
  • stepZ
)

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

Parameters:

  • stepX Number

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

  • stepY Number

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

  • stepZ Number

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

zoomSilent

()

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

getRot

() Array

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

Returns:

Array:

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

rot

()

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

rotSilent

()

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

rotate

(
  • stepX
  • stepY
  • stepZ
  • options
)

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

Parameters:

  • stepX Number

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

  • stepY Number

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

  • stepZ Number

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

  • options Object

    Параметры:

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

rotateSilent

()

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

playRotate

()

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

pauseRotate

()

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

stopRotate

()

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

fill

(
  • fill
  • load
)
async

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

Parameters:

  • fill Object

    Наполнение

  • load Function

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

getColor

() String

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

Returns:

String:

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

worldToLocal

(
  • pos
)
Number[]

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

Parameters:

  • pos Number[]

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

Returns:

Number[]:

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

localToWorld

(
  • pos
)
Number[]

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

Parameters:

  • pos Number[]

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

Returns:

Number[]:

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

enableShadows

(
  • actions
)

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

Parameters:

  • actions String

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

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

disableShadows

()

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

enableControls

(
  • options
)

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

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

()

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

connect

(
  • options
)

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

Parameters:

  • options Object

    Параметры:

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

disconnect

()

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

updateConnect

()

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

intersect

(
  • fromModels
  • options
)
Object

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

Parameters:

  • fromModels Array

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

  • options Object

    Параметры:

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

Returns:

Object:

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

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

intersectModel

(
  • model
)
Object

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

Parameters:

Returns:

Object:

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

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

getNoIntersectShiftOnXZ

(
  • models
)
Number[]

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

Parameters:

Returns:

Number[]:

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

getSize

() Number[]

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

Returns:

Number[]:

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

getVolume

() Number

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

Returns:

Number:

Объем

calcSize

()

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

getMinViewDistance

() Number

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

Returns:

Number:

Расстояние

getViewDistance

(
  • distance
)
Number

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

Parameters:

  • distance Any

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

Returns:

Number:

Расстояние

getPosFromTarget

() Array

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

Returns:

Array:

Расстояние

createBound

()

Inherited from Site3dModel but overwritten in base\site3d.js:4602

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

createEdges

()

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

updateEdges

()

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

fillEdges

()

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

showEdges

()

Inherited from Site3dModel but overwritten in base\site3d.js:4692

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

updateBound

()

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

rebuildBound

()

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

getBoundPosList

() Number[]

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

Returns:

Number[]:

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

setFrame

(
  • options
)

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

Parameters:

  • options Object

    Параметры:

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

showFrame

(
  • options
)

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

Parameters:

  • options Object

    Параметры:

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

hideFrame

()

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

checkIntersect

(
  • model
)
Object

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

Parameters:

Returns:

Object:

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

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

label

(
  • name
  • options
)

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

Parameters:

  • name String

    Имя метки

  • options Object

    Параметры:

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

removeLabel

(
  • name
)

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

Parameters:

  • name String

    Имя метки

enableLabels

()

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

disableLabels

()

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

setInitEventsActivityLabels

()

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

disableEventsLabels

()

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

updateLabels

()

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

removeLabels

()

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

render

()

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

setRenderOrder

(
  • order
)

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

Parameters:

  • order Number

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

Properties

s3d

Site3d

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

name

String

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

mesh

Mesh

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

parentModel

Site3dModel

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

size

Number[]

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

volume

Number

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

items

Map

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

eventItems

Map

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

bound

Site3dModelBound

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

edges

Edges

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

labels

Map

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

content

HTMLElement

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

info

Object

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

isVisible

Boolean

Inherited from Site3dModel but overwritten in base\site3d.js:3534

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

isVisibleFrame

Boolean

Inherited from Site3dModel but overwritten in base\site3d.js:3557

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

isVisibleEdges

Boolean

Inherited from Site3dModel but overwritten in base\site3d.js:3580

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

isRotate

Boolean

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

log

Object

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