kompas3d-mcp/docs/Kompas3D_SDK/interfaces/kspolylinevertexparam.md

---
title: "Интерфейс параметров вершины ломаной Интерфейсы ksPolyLineVertexParam, IPolygonalLineVertexParam)"
type: interface
api: [api7]
domain: [2d]
tags: [interface, api7, 2d, kspolylinevertexparam]
sources:
  - kspolylinevertexparam.html
---

*API интерфейсов. Версия 5 > Документ-модель (Интерфейсы - ksDocument3D, IDocument3D )  > Компонент сборки (деталь или подсборка). Интерфейсы ksPart и IPart  > Объект модели (Интерфейсы ksEntity и IEntity)  > Интерфейсы ksEntity и iEntity - Интерфейс элемента модели (оси, плоскости, формообразующего элемента) *


## Интерфейс параметров вершины ломаной Интерфейсы ksPolyLineVertexParam, IPolygonalLineVertexParam)

Интерфейс параметров вершины ломаной.
| ksPolyLineVertexParam | - интерфейс Automation |
| --- | --- |
| IPolygonalLineVertexParam | - интерфейс COM |


## buildingType - Способ построения сегмента ломаной

Тип данных: ksLineBuildingType
Синтаксис Automation:
```
buildingType = iObject.buildingType    Получить свойство(* )
iObject.buildingType = buildingType    Установить свойство (* )
buildingType = iObject.GetbuildingType()    Получить свойство (**)
iObject.SetbuildingType (buildingType)    Установить свойство (**)
```


## GetAssociation - Получить ассоциированную вершину

Синтаксис Automation:
```
ksEntity * GetAssociation();
```
Синтаксис COM:
```
LPENTITY GetAssociation();
Возвращаемое значение:
Указатель на интерфейс объекта ksEntity или IEntity    - если объект задан,
NULL    - если объект не задан.
```
Примечание:
Тип возвращаемого объекта вершина o3d_vertex.


## GetBuildingObject - Получить объект относительно которого ведется построение

Синтаксис Automation:
```
ksEntity * GetBuildingObject();
```
Синтаксис COM:
```
LPENTITY GetBuildingObject();
Возвращаемое значение:
Указатель на интерфейс объекта ksEntity или IEntity    - если объект задан,
NULL    - если объект не задан.
```
Примечание:
Задать объект, относительно которого ведется построение, можно для типа построения ksLineBuildingType, равного ksLBTParallel и ksLBTPerpendicular.


## GetIndex - Получить индекс вершины

Синтаксис:
```
int GetIndex();
Возвращаемое значение:
Индекс вершины.    - если объект задан.
```


## GetParamByDistance - Получить расстояние и радиус

Синтаксис:
```
BOOL GetParamByDistance (double * distance, double * radius);
Входные параметры:
distance    - расстояние до предыдущей вершины,
radius    - радиус.
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
1. Для вершины с индексом 0 расстояние выдается до вершины с индексом 1. Для остальных вершин расстояние выдается до вершины с индексом на 1 меньше, чем у данной вершины.
2. Получить расстояние можно для любого типа построения.
3. Установить расстояние можно, если тип построения ksLineBuildingType не равен ksLBTByPoint.


## GetParamVertex - Получить параметры вершины

Синтаксис:
```
BOOL GetParamVertex (double *x, double *y, double *z, double *radius);
Входные параметры:
x    - x координата вершины,
y    - y координата вершины,
z    - z координата вершины,
radius    - радиус.
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```


## GetVertex - Получить вершину

Синтаксис Automation:
```
ksEntity * GetVertex();
```
Синтаксис COM:
```
LPENTITY GetVertex();
Возвращаемое значение:
Указатель на интерфейс объекта ksEntity или IEntity    - если объект задан,
NULL    - если объект не задан.
```
Примечание:
Тип возвращаемого объекта - вершина o3d_vertex.


## SetAssociation - Установить ассоциированную вершину

Синтаксис Automation:
```
BOOL SetAssociation (ksEntity * vertex);
```
Синтаксис COM:
```
BOOL SetAssociation( LPENTITY vertex);
Входные параметры:
vertex    - указатель на интерфейс объекта ksEntity или IEntity, если нужно установить ассоциацию,
NULL    - если нужно снять ассоциацию.
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
Объект должен быть вершиной o3d_vertex.


## SetBuildingObject - Установить объект относительно которого ведется построение

Синтаксис Automation:
```
BOOL SetBuildingObject (ksEntity * object);
```
Синтаксис COM:
```
BOOL SetBuildingObject (LPENTITY object);
Входные параметры:
object    - указатель на интерфейс объекта ksEntity или IEntity
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
Задать объект, относительно которого ведется построение, можно для типа построения ksLineBuildingType, равного ksLBTParallel и ksLBTPerpendicular.


## SetParamByDistance - Установить расстояние и радиус

Синтаксис:
```
BOOL SetParamByDistance (double distance, double radius);
Входные параметры:
distance    - расстояние до предыдущей вершины,
radius    - радиус.
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
1. Установить расстояние можно, если тип построения ksLineBuildingType не равен ksLBTByPoint.
2. Нельзя установить расстояние для вершины с индексом 0.


## SetParamByVertex - Установить параметры вершины по парамерам вершины другого объекта

Синтаксис Automation:
```
BOOL SetParamByVertex (ksEntity * vertex, double radius);
```
Синтаксис COM:
```
BOOL SetParamByVertex (LPENTITY vertex, double radius);
Входные параметры:
vertex    - указатель на интерфейс параметров вершины ksEntity или IEntity,
radius    - радиус.
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```


## SetParamVertex - Установить параметры вершины

Синтаксис:
```
BOOL SetParamVertex (double x, double y, double z, double radius);
Входные параметры:
x    - x координата вершины,
y    - y координата вершины,
z    - z координата вершины,
radius    - радиус.
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```