---
title: "Смещенная плоскость (Интерфейсы ksPlaneOffsetDefinition, IPlaneOffsetDefinition)"
type: interface
api: [api7]
domain: [2d]
tags: [interface, api7, 2d, ksplaneoffsetdefinition]
sources:
  - ksplaneoffsetdefinition.html
---

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


## Смещенная плоскость (Интерфейсы ksPlaneOffsetDefinition, IPlaneOffsetDefinition)

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


## direction - Направление смещения от базовой плоскости

Тип данных: BOOL
Синтаксис Automation:
```
direction = iPlaneOffset.direction    Получить свойство(* )
iPlaneOffset.direction = direction    Установить свойство (* )
direction = iPlaneOffset.GetDirection()    Получить свойство (**)
iPlaneOffset.SetDirection(direction)    Установить свойство (**)
Значения свойства:
TRUE    - прямое направление,
FALSE    - обратное направление.
```
Примечание:
Прямое направление совпадает с направлением нормали к базовой плоскости.


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

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


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

Синтаксис Automation:
```
LPDISPATCH GetSurface();
```
Синтаксис COM:
```
LPSURFACE GetSurface();
Возвращаемое значение:
- указатель на интерфейс математической поверхности ksSurface или ISurface.
```


## offset - Смещение (расстояние) от базовой плоскости

Тип данных: double
Синтаксис Automation:
```
offset = iPlaneOffset.offset    Получить свойство(* )
iPlaneOffset.offset = offset    Установить свойство (* )
offset = iPlaneOffset.GetOffset()    Получить свойство (**)
iPlaneOffset.SetOffset(offset)    Установить свойство (**)
```


## SetPlane - Изменить указатель на интерфейс базовой плоскости

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