API Docs for: 1.0.0
Show:

Site3dCircle Class

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

Класс окружности

Methods

getPosList

(
  • index
)
Number[]

Defined in base\site3d.js:4592

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

Parameters:

  • index Number

    Индекс вершины

Returns:

Number[]:

Координаты позиции вершины

getPosList

() Number[]

Defined in base\site3d.js:4603

Метод возвращает глобальные позиции вершин основания геометрии формы

Returns:

Number[]:

Массив глобальных позиций вершин основания

getResizePosList

(
  • x
  • y
  • z
)
Number[]

Defined in base\site3d.js:4619

Метод возвращает позиции глобальные вершин основания геометрии формы в результате изменения её размеров вдоль осей координат (если передан null, то вдоль данной оси изменений нет)

Parameters:

  • x Number

    Размер вдоль оси X

  • y Number

    Размер вдоль оси Y

  • z Number

    Размер вдоль оси Z

Returns:

Number[]:

Массив позиций вершин основания

saveGeometry

()

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

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

saveGeometry

()

Defined in base\site3d.js:4699

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

subtractModelBound

(
  • model
)

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

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

Parameters:

updateGeometry

(
  • data
)

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

Parameters:

  • data Object

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

isLoaded

() Boolean

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

Returns:

Boolean:

Результат

show

()

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

hide

()

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

remove

()

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

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

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[]

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

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

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

() Array

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

Returns:

Array:

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

calcSize

()

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

createBound

()

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

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

updateBound

()

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

rebuildBound

()

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

getBoundPosList

() Number[]

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

Returns:

Number[]:

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

setFrame

(
  • options
)

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

Parameters:

  • options Object

    Параметры:

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

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])
    • isEnabled – истина, если метка видна (по умолчанию истина)

removeLabel

(
  • name
)

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

Parameters:

  • name String

    Имя метки

enableLabels

()

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

disableLabels

()

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

setInitEventsActivityLabels

()

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

disableEventsLabels

()

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

updateLabels

()

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

render

()

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

setRenderOrder

(
  • order
)

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

Parameters:

  • order Number

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

Properties

s3d

Site3d

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

name

String

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

mesh

Mesh

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

parentModel

Site3dModel

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

isVisible

Boolean

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

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

isRotate

Boolean

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

log

Object

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