Комментарий

Ниже мы рассмотрим объект PMI, содержащий стрелку-выноску и линию с текстом.

Объект комментария

Объект

Обобщенный тип объекта комментария (TypeScript):

export type C3DViewComment = {
    type: C3DViewObjectTypes.Comment // "Comment"
    uuid?: string
    targetUuid?: string
    points: {
        target: C3DViewPoint
        shelf: C3DViewPoint
    }
    options: C3DViewCommentOptions
    userData: C3DUserData
}

Свойства type, uuid и userData описаны здесь. Кроме того, для этого объекта PMI:

type может быть C3DViewObjectTypes.Comment или строкой "Comment";
Объект userData создается в процессе (…/processes/comment.md) при возврате из обработчика события onCreate.

targetUuid — это уникальный идентификатор целевого объекта.
points — это группа точек, используемых для построения объекта:
- target — это целевая точка на геометрическом объекте;
- shelf — это точка на линии выноски.
options — это дополнительные параметры.

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

То же самое, что и для создания процесса.

Тип параметров комментариев (TypeScript):

export type C3DViewCommentOptions = {
    group?: number
    text:string,
    font?:{
        family?:string,
        size?:number,
    }
    colors?:{
        text?:C3DViewRGB
        textBkg?:C3DViewRGB
    }
    tipType?: C3DTipType
    textFrame?: C3DFrame[]
    textOrigin?: {
        vertical?: C3DVerticalPosition
        horizontal?: C3DHorizontalPosition
    }
}

Поле group определяет, к какой группе принадлежит комментарий.
text — это текстовое значение объекта.
font — это набор значений для настройки шрифта текста:
- family — это семейство шрифтов;
- size — это значение цвета текста в формате {r, g, b} (по умолчанию — black).
colors — это группа значений для задания цветов графического объекта:
- text — это значение цвета текста в формате {r, g, b} (по умолчанию — черный);
- textBkg — это значение {r, g, b} цвета фона текста (если не определено, фон будет прозрачным);
- lines — это значение {r, g, b} цвета линии (по умолчанию — black).
tipType — тип подсказки выноски. Доступные значения (по умолчанию — 'Arrow').
textFrame — это список доступных фреймов для текста комментария (по умолчанию — ["All"]).
textOrigin — это группа значений, позволяющая изменить точку привязки линии выноски для текста:
- vertical – вертикальное выравнивание. Доступные значения (по умолчанию "Auto");
- horizontal – горизонтальное выравнивание. Доступные значения (по умолчанию — "Auto").

Добавлено в версии 1.7.0: Удалена опция underlineText. Добавлены параметры tipType, textFrame и textOrigin.

Текстовая рамка

export enum C3DFrame {
    Bottom = 'Bottom',
    Right = 'Right',
    Top = 'Top',
    Left = 'Left',
    All = 'All',
}

Начальная точка текста

export enum C3DHorizontalPosition {
    Left = 'Left',
    Right = 'Right',
    Center = 'Center',
    Auto = 'Auto',
}

export enum C3DVerticalPosition {
    Center = 'Center',
    Above = 'Above',
    Below = 'Below',
    Auto = 'Auto',
}

Тип наконечника

export enum C3DTipType {
    None = 'None',
    Arrow = 'Arrow',
    Circle = 'Circle',
    Hatch = 'Hatch'
}