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

---
title: "Коническая спираль (Интерфейсы ksConicSpiralDefinition и IConicSpiralDefinition)"
type: interface
api: [api7]
domain: [2d]
tags: [interface, api7, 2d, ksconicspiraldefinition]
sources:
  - ksconicspiraldefinition.html
---

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


## Коническая спираль (Интерфейсы ksConicSpiralDefinition и IConicSpiralDefinition)

Интерфейс параметров конической спирали.
| ksConicSpiralDefinition | - интерфейс Automation |
| --- | --- |
| IConicSpiralDefinition | - интерфейс COM |
Примечание:
Данный интерфейс можно получить, используя метод интерфейса элемента модели ksEntity::GetDefinition или IEntity::GetDefinition.


## buildDir - Направление построения спирали

Тип данных: BOOL
Значения свойства:
| TRUE | - нормальное (совпадающее с положительным направлением нормали к базовой плоскости спирали), |
| --- | --- |
| FALSE | - обратное. |
Синтаксис Automation:
```
buildDir = iConicSpiral.buildDir    Получить свойство (* )
iConicSpiral.buildDir = buildDir    Установить свойство (* )
buildDir = iConicSpiral.GetBuildDir()    Получить свойство (**)
iConicSpiral.SetBuildDir(buildDir)    Установить свойство (**)
```


## buildMode - Способ построения спирали

Тип данных: short
Значения свойства:
| 0 | - по шагу и количеству витков, |
| --- | --- |
| 1 | - по шагу и высоте, |
| 2 | - по количеству витков и высоте. |
Синтаксис Automation:
```
buildMode = iConicSpiral.buildMode    Получить свойство (* )
iConicSpiral.buildMode = buildMode    Установить свойство (* )
buildMode = iConicSpiral.GetBuildMode()    Получить свойство (**)
iConicSpiral.SetBuildMode(buildMode)    Установить свойство (**)
```


## firstAngle - Начальный угол (или угол поворота спирали вокруг своей оси)

Тип данных:double.
Синтаксис Automation:
```
firstAngle = iConicSpiral.firstAngle    Получить свойство (* )
iConicSpiral.firstAngle = firstAngle    Установить свойство (* )
firstAngle = iConicSpiral.GetFirstAngle()    Получить свойство (**)
iConicSpiral.SetFirstAngle(firstAngle)    Установить свойство (**)
```


## GetCurve3D - Получить указатель на интерфейс математической кривой

Синтаксис Automation:
```
LPDISPATCH GetCurve3D();
```
Синтаксис COM:
```
LPCURVE3D GetCurve3D();
Возвращаемое значение:
- интерфейс математической кривой ksCurve3D или ICurve3D.
```


## GetHeightObject - Получить объект, задающий высоту

Синтаксис Automation:
```
LPDISPATCH GetHeightObject();
```
Синтаксис COM:
```
LPENTITY GetHeightObject();
Возвращаемое значение:
- указатель на интерфейс объекта ksEntity или IEntity.
```


## GetInitialDiamObject - Получить объект, задающий начальный диаметр

Синтаксис Automation:
```
LPDISPATCH GetInitialDiamObject();
```
Синтаксис COM:
```
LPENTITY GetInitialDiamObject();
Возвращаемое значение:
- указатель на интерфейс объекта ksEntity или IEntity.
```


## GetLocation - Получить координаты точки привязки спирали на базовой плоскости (точку пересечения оси спирали с базовой плоскостью)

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


## GetPlane - Получить указатель на базовую плоскость спирали

Синтаксис Automation:
```
LPDISPATCH GetPlane();
```
Синтаксис COM:
```
LPENTITY GetPlane();
Возвращаемое значение:
- указатель на интерфейс спирали ksEntity или IEntity.
```


## GetSketch - Получить указатель на интерфейс эскиза элемента

Синтаксис Automation:
```
LPDISPATCH GetSketch();
```
Синтаксис COM:
```
LPENTITY GetSketch();
Возвращаемое значение:
- указатель на интерфейс ksEntity или IEntity.
```


## GetTerminalDiamObject - Получить объект, задающий конечный диаметр

Синтаксис Automation:
```
LPDISPATCH GetTerminalDiamObject();
```
Синтаксис COM:
```
LPENTITY GetTerminalDiamObject();
Возвращаемое значение:
- указатель на интерфейс объекта ksEntity или IEntity.
```


## height - Высота спирали

Тип данных: double
Синтаксис Automation:
```
height = iConicSpiral.height    Получить свойство (* )
iConicSpiral.height = height    Установить свойство (* )
height = iConicSpiral.GetHeight()    Получить свойство (**)
iConicSpiral.SetHeight(height)    Установить свойство (**)
```


## heightAdd - Дополнительная высота

Тип данных: double
Синтаксис Automation:
```
heightAdd = iConicSpiral.heightAdd    Получить свойство (* )
iConicSpiral.heightAdd = heightAdd    Установить свойство (* )
heightAdd = iConicSpiral.GetHeightAdd()    Получить свойство (**)
iConicSpiral.SetHeightAdd(heightAdd)    Установить свойство (**)
```


## heightAddHow - Признак дополнительной высоты

Тип данных: BOOL
Значения свойства:
| TRUE | - продолжить за объект, |
| --- | --- |
| FALSE | - не доходя до объекта. |
Синтаксис Automation:
```
heightAddHow = iConicSpiral.heightAddHow    Получить свойство (* )
iConicSpiral.heightAddHow = heightAddHow    Установить свойство (* )
heightAddHow = iConicSpiral.GetHeightAddHow()    Получить свойство (**)
iConicSpiral.SetHeightAddHow(heightAddHow)    Установить свойство (**)
```
Примечание:
Данное свойство используется только при способе задания высоты "по объекту" (heightType = 1).


## heightType - Способ задания высоты

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


## initialDiam - Начальный диаметр спирали

Тип данных: double
Синтаксис Automation:
```
initialDiam = iConicSpiral.initialDiam    Получить свойство (* )
iConicSpiral.initialDiam = initialDiam    Установить свойство (* )
initialDiam = iConicSpiral.GetInitialDiam()    Получить свойство (**)
iConicSpiral.SetInitialDiam(initialDiam)    Установить свойство (**)
```


## initialDiamType - Способ задания начального диаметра

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


## SetHeightObject - Установить объект, задающий высоту

Синтаксис Automation:
```
BOOL SetHeightObject (LPDISPATCH heightObject);
```
Синтаксис COM:
```
BOOL SetHeightObject (LPENTITY heightObject);
Входной параметр:
heightObject    - указатель на интерфейс объекта ksEntity или IEntity.
Возвращаемое значение:
TRUE    - в случае успешного завершения.
```


## SetInitialDiamObject - Установить объект, задающий начальный диаметр

Синтаксис Automation:
```
BOOL SetInitialDiamObject (LPDISPATCH initialDiamObject);
```
Синтаксис COM:
```
BOOL SetInitialDiamObject (LPENTITY initialDiamObject);
Входной параметр:
initialDiamObject    - указатель на интерфейс объекта ksEntity или IEntity.
Возвращаемое значение:
TRUE    - в случае успешного завершения.
```


## SetLocation - Установить точку привязки спирали на базовой плоскости (точку пересечения оси спирали с базовой плоскостью)

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


## SetPlane - Установить указатель на базовую плоскость спирали

Синтаксис Automation:
```
BOOL SetPlane (LPDISPATCH plane);
```
Синтаксис COM:
```
BOOL SetPlane (LPENTITY plane);
Входной параметр:
plane    - указатель на интерфейс спирали ksEntity или IEntity.
Возвращаемое значение:
TRUE    - в случае успешного завершения.
```


## SetTerminalDiamObject - Установить объект, задающий конечный диаметр

Синтаксис Automation:
```
BOOL SetTerminalDiamObject (LPDISPATCH TerminalDiamObject);
```
Синтаксис COM:
```
BOOL SetTerminalDiamObject (LPENTITY terminalDiamObject);
Входной параметр:
terminalDiamObject    - указатель на интерфейс объекта ksEntity или IEntity.
Возвращаемое значение:
TRUE    - в случае успешного завершения.
```


## step - Шаг витков спирали

Тип данных: double
Синтаксис Automation:
```
step = iConicSpiral.step    Получить свойство (* )
iConicSpiral.step = step    Установить свойство (* )
step = iConicSpiral.GetStep()    Получить свойство (**)
iConicSpiral.SetStep(step)    Установить свойство (**)
```


## terminalDiam - Конечный диаметр спирали

Тип данных: double
Синтаксис Automation:
```
terminalDiam = iConicSpiral.terminalDiam    Получить свойство (* )
iConicSpiral.terminalDiam = terminalDiam    Установить свойство (* )
terminalDiam = iConicSpiral.GetTerminalDiam()    Получить свойство (**)
iConicSpiral.SetTerminalDiam(terminalDiam)    Установить свойство (**)
```


## terminalDiamType - Способ задания конечного диаметра

Тип данных: short
Значения свойства:
| 0 | - по размеру, |
| --- | --- |
| 1 | - по объекту, |
| 2 | - по углу наклона образующей. |
Синтаксис Automation:
```
terminalDiamType = iConicSpiral.terminalDiamType    Получить свойство (* )
iConicSpiral.terminalDiamType = terminalDiamType    Установить свойство (* )
terminalDiamType = iConicSpiral.GetTerminalDiamType()    Получить свойство (**)
iConicSpiral.SetTerminalDiamType(terminalDiamType)    Установить свойство (**)
```


## tiltAngle - Угол наклона образующей спирали

Тип данных: double
Синтаксис Automation:
```
tiltAngle = iConicSpiral.tiltAngle    Получить свойство (* )
iConicSpiral.tiltAngle = tiltAngle    Установить свойство (* )
tiltAngle = iConicSpiral.GetTiltAngle()    Получить свойство (**)
iConicSpiral.SetTiltAngle(tiltAngle)    Установить свойство (**)
```


## tiltAngleHow - Направление отсчета угла наклона образующей

Тип данных: BOOL
Значения свойства:
| TRUE | - наружу, |
| --- | --- |
| FALSE | - внутрь (к оси спирали). |
Синтаксис Automation:
```
tiltAngleHow = iConicSpiral.tiltAngleHow    Получить свойство (* )
iConicSpiral.tiltAngleHow = tiltAngleHow    Установить свойство (* )
tiltAngleHow = iConicSpiral.GetTiltAngleHow()    Получить свойство (**)
iConicSpiral.SetTiltAngleHow(tiltAngleHow)    Установить свойство (**)
```


## turn - Количество витков спирали

Тип данных: double
Синтаксис Automation:
```
turn = iConicSpiral.turn    Получить свойство (* )
iConicSpiral.turn = turn    Установить свойство (* )
turn = iConicSpiral.GetTurn()    Получить свойство (**)
iConicSpiral.SetTurn(turn)    Установить свойство (**)
```


## turnDir - Направление навивки спирали

Тип данных: BOOL
Значения свойства:
| TRUE | - по часовой стрелке, |
| --- | --- |
| FALSE | - против часовой стрелки. |
Синтаксис Automation:
```
turnDir = iConicSpiral.turnDir()    Получить свойство (* )
iConicSpiral.turnDir = turnDir    Установить свойство (* )
turnDir = iConicSpiral.GetTurnDir()    Получить свойство (**)
iConicSpiral.SetTurnDir(turnDir)    Установить свойство (**)
```