Перейти к основному содержимому

Viewer3D

Отображает 3D-модель

Позволяет визуализировать 3D-модели и выполнять с ними различные операции, например, следующие:

  • вращение;
  • масштабирование;
  • смена проекции;
  • сечения по плоскостям. Для работы сцены с бэкенд-сервисом используется c3dViewer-API через отдельную конечную точку. См. демонстрационный пример использования компонента.

Свойства​

AccessToken​

Токен доступа к 3D-модели. Токен можно получить с помощью метода getToken() библиотеки FrontendCore следующим образом:

AccessToken={() => "Bearer " + getToken()}

Тип: undefined

AddAnnotations​

Объект, описывающий аннотации для добавления на сцену.

Тип: object

AddComment​

Свойство для обратной совместимости. Не рекомендуется использовать. Комментарий к выбранному объекту 3D-модели.

Вместо этого свойства рекомендуется использовать AddNote.

Тип: string

AddCuttingPlanes​

Объект, описывающий сечения для добавления на сцену.

Тип: object

AddDimension​

Триггер — число, при изменении которого сцена переходит в режим добавления точек измерения расстояния на выбранных объектах 3D-модели и ожидания действий пользователя в зависимости от вида измерения.

По умолчанию, когда SurfaceInterpretation имеет значение false, ожидаются следующие действия пользователя:

  1. нажатие кнопки мыши, когда указатель мыши находится на одной грани, одной вершине или плоскости объекта;
  2. нажатие кнопки мыши, когда указатель мыши находится на другой грани, другой вершине или плоскости объекта.

В режиме измерений между плоскостями, когда SurfaceInterpretation имеет значение true, ожидаются следующие действия пользователя:

  1. нажатие кнопки мыши, когда указатель мыши находится на плоскости одного объекта;
  2. нажатие кнопки мыши, когда указатель мыши находится на параллельной плоскости другого объекта.

Тип: number

AddLightSource​

Объект, описывающий точку освещения для добавления на сцену.

Тип: object

AddNote​

Комментарий к выбранному объекту 3D-модели, например, { value: "Мой комментарий" }.

При передаче AddNote сцена переходит в режим создания комментария и ожидания следующих действий пользователя:

  1. нажатие кнопки мыши, когда указатель мыши находится на объекте;
  2. нажатие кнопки мыши, когда указатель мыши находится вне объекта, в позиции размещения комментария.

Тип: object

Значение по умолчанию: <pre>{
"value": ""
}</pre>

ApiSubPath​

Дополнительный путь к API 3D-сервиса. Используется для совместимости с версиями Атомкод до v. 3.0.

Тип: string

Значение по умолчанию: /

BackendPath​

Конечная точка для работы сцены с сервисом c3dservice.

Тип: string

Badge​

Количественная информация в компонентах Menu, Accordion, Link, Text.

В качестве значения может использоваться объект с полями: counter (число), position ("post" или "pre"), color (цвет)

Тип: any

CSS​

Массив строк-классов CSS-стилей, описанных в файле CSS.css разрабатываемого проекта или встроенных CSS-стилей Атомкод.

Пример:

// внешние (m) и внутренние (p) отступы для компонента. 
// Число после символа "-" (в этом примере представлено числом 4) должно быть кратно величине,
// указанной в параметре, определяющем кратность отступов, 
// в файле Style.mdtheme разрабатываемого проекта.
CSS={["m-4", "p-4"]}

Тип: array

CameraControls​

Массив настроек вращения камеры, например, { value: ["Pan", "Zoom", "Orbit", "Rotation"] }. Элементы массива могут иметь следующие значения:

  • Pan: перемещение в плоскости камеры;
  • FreeRotation: свободное вращение вокруг объекта;
  • Orbit: вращение объекта;
  • Rotation: вращение вокруг объекта;
  • Zoom: приближение к объектам.

Тип: object

Значение по умолчанию: <pre>{}</pre>

CameraOrientation​

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

Вместо этого свойства рекомендуется использовать CameraPosition.

Тип: enum

Возможные значения:

Down - снизу Front - спереди ISO - изометрически Left - слева Rear - сзади Right - справа Up - сверху

  • Значение по умолчанию для инициализации.

CameraPosition​

Предустановленные точки обзора, позволяющие менять положение камеры. Положение камеры обеспечивает видимость всех объектов 3D-модели, добавленных на сцену, а точка обзора расположена в одной из следующих позиций: снизу: { value: "Down" }, спереди: { value: "Front" }, слева: { value: "Left" }, сзади: { value: "Rear" }, справа: { value: "Right" }, сверху: { value: "Up" }, изометрически: { value: "ISO" }

Тип: object

Значение по умолчанию: <pre>{
"value": ""
}</pre>

CameraProjection​

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

Вместо этого свойства рекомендуется использовать CameraView.

Тип: enum

Возможные значения:

Orthogonal - Ортогональная Perspective - Перспективная


  • Значение по умолчанию для инициализации.

CameraView​

Проекция камеры, которая описывает способы представления трехмерных объектов на двумерной плоскости в зависимости от обработки линий, отображающих направления в пространстве. Параллельная проекция не учитывает эффект глубины и не использует линии, сходящиеся в точке:

{
  value: "Orthogonal",
}

Перспективная проекция моделирует эффект глубины и использует линии, сходящиеся в точке:

{
  value: "Perspective",
}

Тип: object

Значение по умолчанию: <pre>{
"value": ""
}</pre>

CaptureEvent​

Обработчик события сдвига камеры после однократной установки точки обзора. В качестве параметра принимает функцию без параметров. CaptureEvent срабатывает, только если значение SetViewPoint указано.

Пример:

CaptureEvent={ () => { 
    console.log("Произошел сдвиг камеры");
  }
}

Тип: undefined

ChangeBackground​

Объект, описывающий цвет фона для изменения, например, { value: { fColor: "#FFFFFF", sColor: "#FFFFFF" }}.

Тип: object

ColorElements​

Массив объектов, каждый из которых содержит идентификатор объекта 3D-модели, цвет для окрашивания объекта и прозрачность. При повторной передаче массива окрашенными останутся только переданные объекты, окраска других объектов сбросится к значениям по умолчанию.

Пример:

[
    {
        "uuid": "3147f915-cf2f-4bc0-949a-1ae7ff357825",
        "color": "#F9F9FB",
        "opacity": 0.8
    }
]

Тип: array

CombineConfig​

Служебное свойство, используемое в визуальном режиме Редактора Форм, для присваивания значений свойствам компонента в виде генерируемых блоков кода. Описывает код вызова действий типа Static, код вызова действий, описанных в параметре subscribe источника данных, а также переход к экранной форме с настроенными параметрами маршрутизации.

Тип: object

CuttingPlane​

Сечение по точкам. Свойство используется для обратной совместимости. Не рекомендуется использовать.

Тип: enum

Возможные значения:

OnePointPlaneXY - По одной точке XY OnePointPlaneXZ - По одной точке XZ OnePointPlaneYZ - По одной точке YZ ThreePointSlice - По трем точкам

  • Значение для инициализации по умолчанию

CuttingPlanesColors​

Объект, описывающий цветовые характеристики сечения при его редактировании. Объект имеет следующие поля:

  • transparent: прозрачность сечения;
  • rect: цвет сечения;
  • lines: цвет линий по периметру сечения.

Тип: object

Значение по умолчанию: <pre>{
"transparent": 0.3,
"rect": "#0000ff",
"lines": "#0000ff"
}</pre>

Direction​

Объект, описывающий привязку линейки с фиксацией оси, например:

  • { x: 1, y: 0, z:0 }: фиксация оси x;
  • { x: 0, y: 1, z:0 }: фиксация оси y;
  • { x: 0, y: 0, z:1 }: фиксация оси z.

Тип: object

DisplayingObjects​

Скрытие или отображение объектов: Скрытие выбранных объектов: { value: "HideSelected" }, Отображение выбранных объектов: { value: "ShowSelected" }, Отображение всех объектов: { value: "ShowAll" }

Тип: object

Значение по умолчанию: <pre>{
"value": ""
}</pre>

DisplayingObjectsIds​

Массив идентификаторов отображаемых объектов 3D-модели, например:

  • ["someId1", "someId2"] отображает выбранные объекты;
  • ["*"] отображет все объекты.

Тип: array

DivToRenderId​

Идентификатор html-элемента, в области которого отрисовывается сцена.

Тип: undefined

DynamicLoad​

Признак динамической загрузки 3D-моделей на сцену: true — объекты загружаются согласно установленным в C3D приоритетам; false — 3D-модель загружается на сцену без учета приоритетов.

Тип: boolean

Значение по умолчанию: True

EditCuttingPlane​

Редактирование сечения по идентификатору.

Пример передачи параметров:

{
  planeId: number, 
}

Тип: object

EnableBackground​

Признак окрашивания заднего фона сцены: true — задний фон сцены окрашен; false — задний фон сцены не окрашен.

Тип: boolean

Значение по умолчанию: True

Hidden​

Признак состояния компонента Скрыт: true — компонент скрыт; false — компонент отображается.

Тип: boolean

HiddenObjectsIds​

Массив идентификаторов скрываемых объектов 3D-модели, например:

  • ["someId1", "someId2"] скрывает выбранные объекты;
  • ["*"] скрывает все объекты.

Тип: array

HighlightColor​

Цвет для отображения объектов на сцене при наведении указателя мыши.

Тип: string

Значение по умолчанию: #e1decd

HighlightCuttingPlaneId​

Свойство для обратной совместимости. Не рекомендуется использовать. Идентификатор подсвечиваемого сечения.

Тип: string

HighlightPlaneMode​

Свойство для обратной совместимости. Не рекомендуется использовать. Триггер для вызова подсвечивания сечения с идентификатором HighlightCuttingPlaneId.

Тип: number

Hint​

Текст, отображаемый при наведении указателя мыши на компонент. Текст отображается на белом фоне.

Тип: any

Hostname​

Имя узла для сцены и сервиса c3dservice.

Тип: string

Id​

Идентификатор компонента для навигации к нему на HTML-странице. Подробнее см. HTML id Attribute или ID

Тип: string

IdToClose​

Идентификатор закрываемой 3D-модели.

Тип: string

IdToOpen​

Идентификатор открываемой 3D-модели.

Тип: string

IsolatedObjects​

Массив идентификаторов объектов 3D-модели для изоляции на сцене, например, ["UUID1", "UUID2"]. Изолированные объекты остаются окрашенными, а остальные объекты становятся прозрачными.

Тип: array

OnAddAnnotation​

Обработчик события завершения добавленния аннотации на сцену. В качестве параметра принимает идентификатор аннотации.

Пример:

OnAddAnnotation={() => {
    const uuid = getEvent();
    console.log(uuid);
    //930993af-2850-4ed1-a5ce-b99d69482335
}}

Тип: undefined

OnClick​

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

В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnClick={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnCtrlOriginChangedCuttingPlane​

Обработчик события изменения координат центра сечения. Событие возникает при перетаскивании центра (желтой точки) сечения с помощью левой кнопки мыши. При перетаскивании свойство centering сечения принимает значение false. В качестве параметра обработчик события принимает булево значение.

Тип: undefined

OnCuttingPlane​

Обработчик события добавления сечения по точкам. Событие возникает при передаче значения в PlaneSlice.

Пример:

OnCuttingPlane= {() => {
    const cuttingPlanesEvent = getEvent();
    console.log(cuttingPlanesEvent); // вывод массива объектов сечений в консоль браузера 
    //[{
    //    "id": 1,
    //    "placement": {
    //        "a": 1.5707963267948966,
    //        "b": 1.5707963267948966,
    //        "c": 5645.5146484375
    //    },
    //    "direction": "front"
    //}]
  }
}

Тип: undefined

OnFPS​

Обработчик события фиксации частоты кадров.

Тип: undefined

OnGetAnnotations​

Обработчик события получения всех объектов, добавленных на сцену. В качестве параметра принимает массив объектов, описывающих аннотации.

Пример:

OnGetAnnotations = {() => {
    const allAnnotations = getEvent();
    console.log(allAnnotations);
    //[
    //     {
    //         "type": "Comment",
    //         "uuid": "023412e4-9d3b-4138-9392-477c33938f5e",
    //         "targetUuid": "d5646dc2-2f0b-4723-8abc-cb25b79e69b6",
    //         "points": {
    //             "target": {
    //                 "x": -9215.4365234375,
    //                 "y": 3977.446044921875,
    //                 "z": -1264.71484375
    //             },
    //             "shelf": {
    //                 "x": -9215.4365234375,
    //                 "y": 5040.53955078125,
    //                 "z": -67.20703125
    //             }
    //         },
    //         "options": {
    //             "text": "123",
    //             "font": {
    //                 "size": 32,
    //                 "family": "GOST type A"
    //             },
    //             "textFrame": [
    //                 "All"
    //             ],
    //             "tipType": "Arrow",
    //             "colors": {
    //                 "text": {
    //                     "r": 0,
    //                     "g": 0,
    //                     "b": 0
    //                 }
    //             },
    //             "textOrigin": {
    //                 "horizontal": "Auto",
    //                 "vertical": "Auto"
    //             }
    //         }
    //     }
    // ]
  }
}

Тип: undefined

OnGetLightSources​

Обработчик события получения точек освещения, добавленных на сцену.

Тип: undefined

OnGettingCuttingPlanes​

Обработчик события получения сечений, добавленных на сцену.

Тип: undefined

OnInitialize​

Обработчик события инициализации компонента 3DViewer, возвращающий объект initResult.

Тип: undefined

OnInvertCuttingPlane​

Обработчик события изменения направления сечения. Событие возникает при изменении направления сечения с идентификатором, переданным в EditCuttingPlane.

Тип: undefined

OnItemsSelect​

Обработчик события выбора объектов 3D-модели.

В качестве параметра принимает функцию без параметров. Возвращает массив GUID-объектов 3D-модели на сцене.

Пример:

OnItemsSelect={ () => { 
    const uuids = getEvent();
  }
}

Тип: undefined

OnKeyDown​

Обработчик события нажатия любой клавиши клавиатуры. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа KeyboardEvent.

Пример:

OnKeyDown={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnKeyUp​

Обработчик события отпускания любой клавиши клавиатуры. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа KeyboardEvent.

Пример:

OnKeyUp={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnLightSourcesChanged​

Обработчик события изменения источников света. В качестве параметра принимает массив источников света.

Тип: undefined

OnMouseDown​

Обработчик события нажатия любой кнопки мыши, когда указатель мыши находится на компоненте. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseDown={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseEnter​

Обработчик события перемещения указателя мыши на компонент. Событие срабатывает только в случае, если указатель мыши находится за пределами компонента и пользователь перемещает указатель мыши внутрь компонента. Если указатель мыши в текущий момент находится внутри компонента, для срабатывания события пользователь должен переместить указатель мыши за пределы компонента, а затем обратно внутрь компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseEnter={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseLeave​

Обработчик события перемещения указателя мыши за пределы компонента. Событие срабатывает, только если указатель мыши находится внутри компонента, а пользователь перемещает указатель мыши за пределы компонента. Если указатель мыши в текущий момент находится за пределами компонента, для срабатывания события пользователь должен переместить указатель мыши внутрь компонента, а затем обратно за пределы компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseLeave={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseMove​

Обработчик события наведения указателя мыши на компонент. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseMove={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseOut​

Обработчик события перемещения указателя мыши за пределы компонента. Когда пользователь наводит указатель мыши на компонент, происходит одно событие MouseOver, за которым следует одно или несколько событий MouseMove, когда пользователь перемещает указатель мыши внутри компонента. Одно событие MouseOut возникает, когда пользователь выводит указатель мыши за пределы компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseOut={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseOver​

Обработчик события перемещения указателя мыши на компонент. Событие возникает, когда пользователь наводит указатель мыши на компонент, и не повторяется до тех пор, пока пользователь не выведет указатель мыши за пределы компонента и затем не вернет его обратно. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseOver={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnMouseUp​

Обработчик события отпускания кнопки мыши, когда указатель мыши находится на компоненте. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent.

Пример:

OnMouseUp={() => {
  // Получение параметра события
  const event = getEvent();
  // Вывод параметра события в консоль браузера
  console.log(event);
  }
}

Тип: undefined

OnNumberTriangles​

Обработчик события фиксации количества треугольников на сцене.

Тип: undefined

OnSaveView​

Обработчик события добавления точки обзора. Срабатывает при увеличении триггера TriggerFetchAndUpdateView. В качестве параметра принимает объект с описанием точки обзора.

Пример:

OnSaveView = {() => {
    const saveView = getEvent();
    console.log(saveView); //вывод объекта с описанием точки обзора в консоль браузера 
  //{
  //    "cameraParams": {
  //        "projection": "Orthogonal",
  //       "stdUpVector": 2,
  //        "orientation": {
  //            "type": "custom",
  //            "eyeVector": {
  //                "x": -1,
  //                "y": 0,
  //                "z": 0
  //            },
  //            "upVector": {
  //                "x": 0,
  //                "y": 0,
  //                "z": 1
  //            },
  //            "target": {
  //                "x": -9778.90625,
  //               "y": 5382.68505859375,
  //                "z": 0
  //            },
  //            "distance": 17967.84765625
  //        }
  //    }
  //}
  }
}

Тип: undefined

OnUnmount​

Обработчик события размонтирования согласно жизненному циклу экранной формы. Не имеет параметров.

Пример:

OnUnmount={() => {
  // Отмена выполнения периодического действия при размонтировании экранной формы
    return clearInterval(getValue("pleerInterval"))
  }
}

Тип: undefined

OnUpdateCuttingPlane​

Обработчик события изменения координат сечения. Событие возникает при изменении положения сечения с идентификатором, переданным в EditCuttingPlane.

Тип: undefined

PlaneSlice​

Объект, при передаче которого сцена переходит в режим добавления сечения на выбранных объектах 3D-модели и ожидания действий пользователя в зависимости от вида сечения:

  • в направлении осей X и Y, X и Z, Y и Z: нажатие кнопки мыши, когда указатель мыши находится на одной грани, одной вершине или плоскости объекта;
  • по трем точкам: нажатие кнопки мыши трижды, когда указатель мыши находится на одной грани, одной вершине или плоскости объекта.

При создании сечения модель разрезается на две части, одна из которых скрывается, отображая внутренность 3D-модели. Скрываемая часть описывается параметром direction, который может принимать следующие значения:

  • "front": скрывается передняя часть 3D-модели;
  • "back": скрывается задняя часть 3D-модели.

При передаче объекта со значением value равным "OnePointPlaneXY" включается режим добавления сечения по одной точке в направлении осей X и Y, например:

{
  value: "OnePointPlaneXY",
  direction: "front"
}

При передаче объекта со значением value равным "OnePointPlaneYZ" включается режим добавления сечения по одной точке в направлении осей Y и Z, например:

{
  value: "OnePointPlaneYZ",
  direction: "front"
}

При передаче объекта со значением value равным "OnePointPlaneXZ" включается режим добавления сечения по одной точке в направлении осей X и Z, например:

{
  value: "OnePointPlaneXZ",
  direction: "front"
}

При передаче объекта со значением value равным "ThreePointSlice" включается режим добавления сечения по трем точкам, например:

{
  value: "OnePointPlaneXZ",
  direction: "front"
}

Тип: object

Значение по умолчанию: <pre>{
"value": ""
}</pre>

Port​

Порт для сцены и сервиса c3dservice.

Тип: string

Print3DImage​

Триггер — число, при увеличении которого вызывается диалоговое окно печати 3D-снимка сцены.

Тип: number

Protocol​

Протокол, который использует сцена и сервис c3dservice.

Тип: string

Значение по умолчанию: https

RebuildModel​

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

Тип: number

RemoveComments​

Свойство для обратной совместимости. Не рекомендуется использовать. Триггер для вызова команды удаления комментария с выбранных объектов 3D-модели.

Вместо этого свойства рекомендуется использовать RemoveCommentsIds.

Тип: number

RemoveCommentsIds​

Массив идентификаторов комментариев, которые должны быть удалены, например, ["someId1", "someId2"].

Тип: array

RemoveCuttingPlane​

Триггер — число, при увеличении которого удаляется сечение с идентификатором RemoveCuttingPlaneId.

Тип: number

RemoveCuttingPlaneId​

Идентификатор удаляемого сечения.

Тип: string

RemoveDimensions​

Триггер — число, при увеличении которого происходит удаление измерений со сцены. Идентификаторы измерений могут быть переданы в параметре SelectedObjects или выбраны пользователем на сцене.

Тип: number

RemoveDimensionsIds​

Массив идентификаторов измерений для удаления со сцены, например, ["someId1", "someId2"].

Тип: array

RemoveLightSourceId​

Идентификатор удаляемой точки освещения.

Тип: number

RenderMode​

Тип отображения сцены, например, { value: "shaded" }. Может иметь следующие значения:

  • shaded: отображаются только поверхности модели;
  • wireFrame: отображаются только ребра модели;
  • shadedAndWireFrame: отображаются поверхности и ребра модели.

Тип: object

Значение по умолчанию: <pre>{}</pre>

ResetHighlightPlaneMode​

Триггер — число, при увеличении которого отключается подсветка сечения с идентификатором HighlightCuttingPlaneId.

Тип: number

SavingImageFileName​

Имя файла для сохранения 3D-снимка сцены, например, { value: "screenshot.png" }.

Тип: object

SelectByColor​

Объект с цветом, согласно которому выбираются объекты 3D-модели с аналогичным цветом, например, { value: "#FFFFFF" }.

Тип: object

SelectByOpacity​

Значение прозрачности в процентах, согласно которому выбираются объекты 3D-модели с аналогичной прозрачностью.

Тип: number

SelectedObjects​

Массив идентификаторов выбранных объектов 3D-модели. Идентификаторы объектов хранятся в метаданных сервиса metadata3dservice. Выбранные объекты окрашиваются в цвет, определенный в SelectionColor.

Тип: array

SelectionColor​

Цвет для окрашивания выбранных объектов 3D-модели.

Тип: string

Значение по умолчанию: #fdec04

ServiceName​

Имя сервиса c3dservice.

Тип: string

Значение по умолчанию: c3dservice/

SetLightSourceOn​

Признак включения всех точек освещения: true — все точки включены; false — все точки выключены.

Тип: boolean

Значение по умолчанию: True

SetLightSources​

Объект, описывающий массив точек освещения для добавления на сцену.

Тип: object

SetViewPoint​

Установка камеры в передаваемую точку обзора, описываемую объектом {view: saveView, duration: 1000}. duration — время, за которое происходит сдвиг камеры из текущего положения в положение, указанное в передаваемой точке обзора.

Тип: object

Slot​

Именованное пространство во фрагменте экранной формы или именованное пространство в шаблоне компонента с возможностью шаблонизации, например, Select, DataGrid.

Тип: string

SurfaceInterpretation​

Признак измерения расстояния между плоскостями объекта: true — измерение расстояния между плоскостями включено; false — измерение расстояния между плоскостями выключено, измеряется расстояние между гранями или вершинами.

Тип: boolean

Tolerance​

Параметр для режима измерения: количество пикселей для привязки конечных точек измерения к ближайшим граням, плоскостям или вершинам объекта. Привязка происходит при движении указателя мыши на объекте.

Тип: number

Tooltip​

Текст, отображаемый при наведении указателя мыши на компонент. Текст отображается на черном фоне.

Тип: any

TraceId​

Идентификатор для отслеживания состояния компонента исходя из жизненного цикла экранной формы. Используется для выполнения фрагмента кода при изменении состояния компонента.

Тип: string

TriggerFetchAndUpdateLights​

Триггер — число, при увеличении которого срабатывает обработчик события OnGetLightSources.

Тип: number

TriggerFetchAndUpdateView​

Триггер — число, при увеличении которого срабатывает обработчик события OnSaveView().

Тип: number

TriggerGetAnnotations​

Триггер — число, при увеличении которого вызывается обработчик события OnGetAnnotations().

Тип: number

TriggerGetCuttingPlanes​

Триггер — число, при увеличении которого срабатывает обработчик события OnGettingCuttingPlanes.

Тип: number

UnloadLoadedModels​

Признак очистки 3D-модели, загруженной на сцену перед добавлением новой 3D-модели.

Тип: boolean

UseLogger​

Признак записи в консоль браузера служебной информации от фронтэнд-пакета c3dviewer-API и компонента Viewer3D: true — служебная информация записывается; false — служебная информация не записывается.

Тип: boolean

ViewMode​

Режим отображения сцены.

Тип: enum

Значение по умолчанию: selection

Возможные значения:

selection - Режим выбора объектов на сцене default - Режим по умолчанию

VisibilityObjects​

Скрытие или отображение выбранных элементов. Свойство используется для обратной совместимости. Не рекомендуется использовать.

Вместо этого свойства рекомендуется использовать DisplayingObjects

Тип: enum

Возможные значения:

HideSelected -
Скрытие выбранных объектов. ShowSelected - Отображение выбранных объектов ShowAll - Отображение всех скрытых объектов

  • Значение по умолчанию для инициализации

Visible​

Признак инверсии состояния компонента Скрыт: true — компонент отображается; false — компонент скрыт.

Тип: boolean

Значение по умолчанию: True

ZoomFitAll​

Триггер — число, при увеличении которого происходит сдвиг камеры. Положение камеры обеспечивает видимость всех объектов 3D-модели, добавленных на сцену.

Тип: number

ZoomFitObjects​

Массив идентификаторов объектов 3D-модели, при передаче которого происходит сдвиг камеры. Положение камеры обеспечивает размещение определенных объектов 3D-модели в области видимости камеры. Идентификаторы объектов хранятся в метаданных сервиса metadata3dservice.

Тип: array

ZoomFitSelected​

Триггер — число, при увеличении которого происходит сдвиг камеры. Положение камеры обеспечивает размещение определенных объектов 3D-модели в области видимости камеры. Эти объекты должны быть переданы в SelectedObjects.

Тип: number

Примеры​

Скрипты:


      setState({
         triggerFetchAndUpdateView: 0,
         viewPointsArray: [],
         selectedViewPoint: undefined,
         triggerGetAnnotations: 0,
         allAnnotations: [],
         triggerGetCuttingPlanes: 0,
         allCuttingPlanes: []
      })

JSX:

<Group >
  <Viewer3D 
    ServiceName="c3dservice/" 
    BackendPath="/c3drpc"
    AccessToken={()=>"Bearer " + getToken()}
  />
</Group>