---
title: "Обозначение шероховатости (Интерфейс ksRoughPar)"
type: interface
api: [api7]
tags: [interface, api7, ksroughpar]
sources:
  - ksroughpar.html
---

*API интерфейсов. Версия 5 > Графический документ (Интерфейсы - ksDocument2D и IDocument2D)  > Интерфейсы параметров обозначений  > Обозначение шероховатости *


## Обозначение шероховатости (Интерфейс ksRoughPar)

Интерфейс параметров обозначения шероховатости.
Аналог данных параметров при использовании API экспортных функций - RoughPar.
Примечания:
1. Текст над знаком содержит параметры шероховатости по ГОСТ 2789-73.
2. Текст над полкой содержит вид обработки и дополнительные указания по ГОСТ 2789-73.
3. Первый текст под полкой содержит базовую длину по ГОСТ 2789-73.
4. Второй текст под полкой содержит условное обозначение направления неровностей по ГОСТ 2789-73.
5. Если cText0 = 0 или cText1 = 0, или cText2 = 0, или cText3 = 0, то соответствующий текст в обозначении шероховатости отсутствует.
6. Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct.
Смотрите также: KompasObject


## ang - Угол наклона оси знака шероховатости к оси OX

Тип данных: double
Синтаксис Automation:
```
ang = iRoughPar.ang    Получить свойство (* )
iRoughPar.ang = ang    Установить свойство (* )
ang = iRoughPar.GetAng()    Получить свойство (**)
iRoughPar.SetAng( ang )    Установить свойство (**)
```


## around - Признак наличия обозначения контура

Тип данных: short
Значения свойства:
| 0 | - обычный знак шероховатости, |
| --- | --- |
| 1 | - шероховатость "по контуру". |
Синтаксис Automation:
```
around = iRoughPar.around    Получить свойство (* )
iRoughPar.around = around    Установить свойство (* )
around = iRoughPar.GetAround()    Получить свойство (**)
iRoughPar.SetAround(around )    Установить свойство (**)
```


## cText0 - Количество строк в тексте над знаком шероховатости

Тип данных: short
Синтаксис Automation:
```
cText0 = iRoughPar.cText0    Получить свойство (* )
iRoughPar.cText0 = cText0    Установить свойство (* )
cText0 = iRoughPar.GetCText0()    Получить свойство (**)
iRoughPar.SetCText0( cText0 )    Установить свойство (**)
```


## cText1 - Количество строк в тексте над полкой знака шероховатости

Тип данных: short
Синтаксис Automation:
```
cText1 = iRoughPar.cText1    Получить свойство (* )
iRoughPar.cText1 = cText1    Установить свойство (* )
cText1 = iRoughPar.GetcText1()    Получить свойство (**)
iRoughPar.SetcText1( cText1 )    Установить свойство (**)
```


## cText2 - Количество строк в первом тексте под полкой (не более двух)

Тип данных: short
Синтаксис Automation:
```
cText2 = iRoughPar.cText2    Получить свойство (* )
iRoughPar.cText2 = cText2    Установить свойство (* )
cText2 = iRoughPar.GetcText2()    Получить свойство (**)
iRoughPar.SetcText2( cText2 )    Установить свойство (**)
```


## cText3 - Количество строк во втором тексте под полкой (не более одной)

Тип данных: short
Синтаксис Automation:
```
cText3 = iRoughPar.cText3    Получить свойство (* )
iRoughPar.cText2 = cText3    Установить свойство (* )
cText3 = iRoughPar.GetcText3()    Получить свойство (**)
iRoughPar.SetcText3( cText3 )    Установить свойство (**)
```


## GetpText - Получить указатель на интерфейс динамического массива текста обозначения шероховатости ksDynamicArray

Синтаксис Automation:
```
LPDISPATCH GetpText();
Возвращаемое значение:
- указатель на интерфейс динамического массива ksDynamicArray.
```
Примечания:
1. Если свойство ksRoughPar::style = INDICATIN_TEXT_LINE_ARR, то динамический массив - типа TEXT_LINE_ARR (динамический массив строк текста), в остальных случаях - типа CHAR_STR_ARR (динамический массив строк символов текста шероховатости).
2. Различают четыре разных текста для шероховатости, их строки лежат в следующей последовательности:
•текст над знаком (параметры шероховатости по ГОСТ 2789-73). Если свойство cText0 = 0, то этот текст отсутствует;
•текст над полкой (вид обработки и дополнительные указания). Если свойство cText1 = 0, то этот текст отсутствует;
•текст под полкой (базовая длина по ГОСТ 2789-73). Если свойство cText2 = 0, то этот текст отсутствует;
•текст под полкой (условное обозначение направления неровностей). Если свойство cText3 = 0, то этот текст отсутствует.
Смотрите также:
ksTextLineParam
ksChar255


## Init - Инициализировать параметры

Замечание:
Данный метод устарел. Рекомендуется использовать вместо него метод InitEx.
Синтаксис Automation:
```
BOOL Init();
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечания:
1. Метод обнуляет все параметры.
2. Создается динамический массив pText типа CHAR_STR_ARR.


## InitEx - Инициализировать параметры

Синтаксис Automation:
```
BOOL InitEx (int style);
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечания:
1. Метод обнуляет все параметры.
2. Если style = INDICATIN_TEXT_LINE_ARR, то создается динамический массив pText типа TEXT_LINE_ARR, в противном случае создается динамический массив pText типа CHAR_STR_ARR.


## SetpText - Установить указатель на интерфейс динамического массива текста обозначения шероховатости ksDynamicArray

Синтаксис Automation:
```
BOOL SetpText (LPDISPATCH pText);
Входной параметр:
pText    - указатель на интерфейс динамического массива ksDynamicArray.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечание:
1. Если свойство ksRoughPar::style = INDICATIN_TEXT_LINE_ARR, то динамический массив ksDynamicArray - типа TEXT_LINE_ARR (динамический массив строк текста), в остальных случаях - типа CHAR_STR_ARR (динамический массив строк символов текста шероховатости).
2. Различают четыре разных текста для шероховатости, их строки лежат в следующей последовательности:
•текст над знаком (параметры шероховатости по ГОСТ 2789-73). Если свойство cText0 = 0, то этот текст отсутствует;
•текст над полкой (вид обработки и дополнительные указания). Если свойство cText1 = 0, то этот текст отсутствует;
•текст под полкой (базовая длина по ГОСТ 2789-73). Если свойство cText2 = 0, то этот текст отсутствует;
•текст под полкой (усл.обозначение направления неровностей). Если свойство cText3 = 0, то этот текст отсутствует.
Смотрите также:
ksTextLineParam
ksChar255


## style - Стиль текста

Тип данных: long
Значения свойства:
| номер системного стиля, | |
| --- | --- |
| номер пользовательского стиля, | |
| INDICATIN_TEXT_LINE_ARR | - в этом случае текст задается массивом строк, и стиль текста может быть указан индивидуально для каждой строки. |
Системные стили текстов...
Синтаксис Automation:
```
style = iRoughPar.style    Получить свойство (* )
iRoughPar.style = style    Установить свойство (* )
style = iRoughPar.GetStyle()    Получить свойство (**)
iRoughPar.SetStyle( style )    Установить свойство (**)
```
Примечание:
Если style = INDICATIN_TEXT_LINE_ARR, то динамический массив pText - типа TEXT_LINE_ARR. В остальных случаях - типа CHAR_STR_ARR.


## type - Тип знака шероховатости

Тип данных: short
Значения свойства:
| 0 | - вид обработки не устанавливается, |
| --- | --- |
| 1 | - обработка удалением слоя материала, |
| 2 | - обработка без удаления слоя материала. |
Синтаксис Automation:
```
type = iRoughPar.type    Получить свойство (* )
iRoughPar.type = type    Установить свойство (* )
type = iRoughPar.GetType()    Получить свойство (**)
iRoughPar.SetType( type )    Установить свойство (**)
```


## x, y - Координаты точки привязки знака шероховатости

Тип данных: double
Синтаксис Automation:
```
x = iRoughPar.x    Получить свойство (* )
iRoughPar.x = x    Установить свойство (* )
x = iRoughPar.GetX()    Получить свойство (**)
iRoughPar.SetX( x )    Установить свойство (**)
```
