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

---
title: "Интерфейс ISpiral3D"
type: interface
api: [api7]
domain: [3d]
tags: [interface, api7, 3d, ispiral3d]
sources:
  - ispiral3d.html
---

*API интерфейсов. Версия 7 > Документ 3D  > Вспомогательные объекты, 3D-кривые и элементы тела  > 3D-кривые и элементы тела  > Интерфейс IModelObjects  > IModelObjects - свойства *


## Интерфейс ISpiral3D

Иерархия:
IDispatch
IKompasAPIObject
IModelObject
ISpiral3D
Примечание:
Интерфейс можно получить у коллекции спиралей с помощью свойства ISpirals3D::Spiral3D и метода ISpirals3D::Add, а также у интерфейсов IConicSpiral3D и ICylindricSpiral3D с помощью метода IUnknown::QueryInterface.


## BasePlane - Базовая плоскость

Тип данных: Указатель на интерфейс IModelObject
Синтаксис Automation:
```
BasePlane = Object.BasePlane    Получить свойство (* )
Object.BasePlane = BasePlane    Установить свойство (* )
BasePlane = Object.GetBasePlane()    Получить свойство (**)
Object.SetBasePlane( BasePlane )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_BasePlane( &BasePlane )    Получить свойство
Object.put_BasePlane( BasePlane )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать базовую плоскость или плоскую грань, на которой располагается спираль.


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

Тип данных: BOOL
Синтаксис Automation:
```
BuildingDirection = Object.BuildingDirection    Получить свойство (* )
Object.BuildingDirection = BuildingDirection    Установить свойство (* )
BuildingDirection = Object.GetBuildingDirection()    Получить свойство (**)
Object.SetBuildingDirection( BuildingDirection )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_BuildingDirection( &BuildingDirection )    Получить свойство
Object.put_BuildingDirection( BuildingDirection )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать направление построения спирали.


## BuildingType - Способ построения

Тип данных: из перечисления ksSpline3DBuildingTypeEnum
Синтаксис Automation:
```
BuildingType = Object.BuildingType    Получить свойство (* )
Object.BuildingType = BuildingType    Установить свойство (* )
BuildingType = Object.GetBuildingType()    Получить свойство (**)
Object.SetBuildingType( BuildingType )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_BuildingType( &BuildingType )    Получить свойство
Object.put_BuildingType( BuildingType )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать способ построения спирали.


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

Синтаксис Automation:
```
BOOL GetBasePoint( double * X, double * Y );
```
Синтаксис COM:
```
HRESULT GetBasePoint( double * X, double * Y, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
Выходные параметры:
X, Y - координаты точки привязки спирали.
```
Примечание:
Метод возвращает координаты точки привязки спирали.


## Heigh - Высота

Тип данных: double
Синтаксис Automation:
```
Height = Object.Height    Получить свойство (* )
Object.Height = Height    Установить свойство (* )
Height = Object.GetHeight()    Получить свойство (**)
Object.SetHeight( Height )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_Height( &Height )    Получить свойство
Object.put_Height( Height )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать высоту спирали.


## HeightBaseObject - Объект, задающий высоту

Тип данных: Указатель на интерфейс IModelObject
Синтаксис Automation:
```
HeightBaseObject = Object.HeightBaseObject    Получить свойство (* )
Object.HeightBaseObject = HeightBaseObject    Установить свойство (* )
HeightBaseObject = Object.GetHeightBaseObject()    Получить свойство (**)
Object.SetHeightBaseObject( HeightBaseObject )    Установить свойство (**)
```
Синтаксис COM:
```
bject.get_HeightBaseObject( &HeightBaseObject )    Получить свойство
Object.put_HeightBaseObject( HeightBaseObject )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать указатель на объект, задающий высоту спирали.


## HeightCorrection - Коррекция высоты, заданной по объекту

Тип данных: double
Синтаксис Automation:
```
HeightCorrection = Object.HeightCorrection    Получить свойство (* )
Object.HeightCorrection = HeightCorrection    Установить свойство (* )
HeightCorrection = Object.GetHeightCorrection()    Получить свойство (**)
Object.SetHeightCorrection( HeightCorrection )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_HeightCorrection( &HeightCorrection )    Получить свойство
Object.put_HeightCorrection( HeightCorrection )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать коррекцию высоты, заданной по объекту.


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

Тип данных: из перечисления ksSpiral3DHeightTypeEnum
Синтаксис Automation:
```
HeightType = Object.HeightType    Получить свойство (* )
Object.HeightType = HeightType    Установить свойство (* )
HeightType = Object.GetHeightType()    Получить свойство (**)
Object.SetHeightType( HeightType )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_HeightType( &HeightType )    Получить свойство
Object.put_HeightType( HeightType )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать способ задания высоты спирали.


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

Синтаксис Automation:
```
BOOL SetBasePoint( double X, double Y );
```
Синтаксис COM:
```
HRESULT SetBasePoint( double X, double Y, BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
Входные параметры:
X, Y - координаты точки привязки спирали.
```
Примечание:
Метод устанавливает координаты точки привязки спирали.


## Sketch - Эскиз

Тип данных: Указатель на интерфейс ISketch
Синтаксис Automation:
```
Sketch = Object.Sketch    Получить свойство (* )
Sketch = Object.GetSketch()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_Sketch( &Sketch )    Получить свойство
```
Примечание:
1. Свойство доступно только для чтения.
2. Свойство позволяет получить указатель на эскиз спирали.


## Step - Шаг

Тип данных: double
Синтаксис Automation:
```
Step = Object.Step    Получить свойство (* )
Object.Step = Step    Установить свойство (* )
Step = Object.GetStep()    Получить свойство (**)
Object.SetStep( Step )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_Step( &Step )    Получить свойство
Object.put_Step( Step )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать шаг витков спирали.


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

Тип данных: BOOL
Синтаксис Automation:
```
TurnDirection = Object.TurnDirection    Получить свойство (* )
Object.TurnDirection = TurnDirection    Установить свойство (* )
TurnDirection = Object.GetTurnDirection()    Получить свойство (**)
Object.SetTurnDirection( TurnDirection )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_TurnDirection( &TurnDirection )    Получить свойство
Object.put_TurnDirection( TurnDirection )    Установить свойство
Значение свойства:
TRUE    - прямое,
FALSE    - обратное.
```
Примечание:
Свойство позволяет устанавливать и получать направление навивки.


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

Тип данных: double
Синтаксис Automation:
```
TurningAngle = Object.TurningAngle    Получить свойство (* )
Object.TurningAngle = TurningAngle    Установить свойство (* )
TurningAngle = Object.GetTurningAngle()    Получить свойство (**)
Object.SetTurningAngle( TurningAngle )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_TurningAngle( &TurningAngle )    Получить свойство
Object.put_TurningAngle( TurningAngle )    Установить свойство
```
Примечание:
1. Свойство позволяет устанавливать и получать угол поворота спирали вокруг перпендикуляра к опорной грани.
2. Угол измеряется относительно оси абсцисс системы координат опорной грани.


## TurnsCount - Количество витков

Тип данных: double
Синтаксис Automation:
```
TurnsCount = Object.TurnsCount    Получить свойство (* )
Object.TurnsCount = TurnsCount    Установить свойство (* )
TurnsCount = Object.GetTurnsCount()    Получить свойство (**)
Object.SetTurnsCount( TurnsCount )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_TurnsCount( &TurnsCount )    Получить свойство
Object.put_TurnsCount( TurnsCount )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать количество витков спирали.