mikhail
e1337e4016
docs/Kompas3D_SDK/ становится каноническим источником справки КОМПАС SDK и включается в репозиторий (2491 файл, ~14 МБ). HTML-зеркало docs/KOMPAS_SDK_ru-RU/ (~1.4 ГБ, © АСКОН) и генератор tools/build_kompas3d_sdk.py больше не нужны — регенерация не предполагается. - .gitignore: MD-база разблокирована; зеркало остаётся проигнорированным (safety-net на случай повторной локальной выгрузки). - CLAUDE.md / SKILL.md: убраны упоминания регенерации и зеркала. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
12 KiB
12 KiB
title, type, api, domain, tags, sources
| title | type | api | domain | tags | sources | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Цилиндрическая спираль (Интерфейсы ksCylindricSpiralDefinition и CylindricSpiralDefinition | interface |
|
|
|
|
*API интерфейсов. Версия 5 > Документ-модель (Интерфейсы - ksDocument3D, IDocument3D ) > Компонент сборки (деталь или подсборка). Интерфейсы ksPart и IPart > Объект модели (Интерфейсы ksEntity и IEntity) > Интерфейсы ksEntity и iEntity - Интерфейс элемента модели (оси, плоскости, формообразующего элемента) > Интерфейсы пространственных кривых *
Цилиндрическая спираль (Интерфейсы ksCylindricSpiralDefinition и CylindricSpiralDefinition
Интерфейс параметров цилиндрической спирали.
| ksCylindricSpiralDefinition | - интерфейс Automation |
|---|---|
| ICylindricSpiralDefinition | - интерфейс COM |
| Примечание: | |
| Данный интерфейс можно получить, используя метод интерфейса элемента модели ksEntity::GetDefinition или IEntity::GetDefinition. |
buildDir - Направление построения спирали
Тип данных: BOOL Значения свойства:
| TRUE | - нормальное (совпадающее с положительным направлением нормали к базовой плоскости спирали), |
|---|---|
| FALSE | - обратное. |
| Синтаксис Automation: |
buildDir = iCylindricSpiral.buildDir Получить свойство (* )
iCylindricSpiral.buildDir = buildDir Установить свойство (* )
buildDir = iCylindricSpiral.GetBuildDir() Получить свойство (**)
iCylindricSpiral.SetBuildDir(buildDir) Установить свойство (**)
buildMode - Способ построения спирали
Тип данных: short Значения свойства:
| 0 | - по шагу и количеству витков, |
|---|---|
| 1 | - по шагу и высоте, |
| 2 | - по количеству витков и высоте. |
| Синтаксис Automation: |
buildMode = iCylindricSpiral.buildMode Получить свойство (* )
iCylindricSpiral.buildMode = buildMode Установить свойство (* )
buildMode = iCylindricSpiral.GetBuildMode() Получить свойство (**)
iCylindricSpiral.SetBuildMode(buildMode) Установить свойство (**)
diam - Диаметр спирали
Тип данных: double Синтаксис Automation:
diam = iCylindricSpiral.diam Получить свойство (* )
iCylindricSpiral.diam = diam Установить свойство (* )
diam = iCylindricSpiral.GetDiam() Получить свойство (**)
iCylindricSpiral.SetDiam(diam) Установить свойство (**)
diamType - Способ задания диаметра
Тип данных: short Значения свойства:
| 0 | - по размеру, |
|---|---|
| 1 | - по объекту. |
| Синтаксис Automation: |
diamType = iCylindricSpiral.diamType Получить свойство (* )
iCylindricSpiral.diamType = diamType Установить свойство (* )
diamType = iCylindricSpiral.GetDiamType() Получить свойство (**)
iCylindricSpiral.SetDiamType(diamType) Установить свойство (**)
firstAngle - Начальный угол (или угол поворота спирали вокруг своей оси)
Тип данных: double Синтаксис Automation:
firstAngle = iCylindricSpiral.firstAngle Получить свойство (* )
iCylindricSpiral.firstAngle = firstAngle Установить свойство (* )
firstAngle = iCylindricSpiral.GetFirstAngle() Получить свойство (**)
iCylindricSpiral.SetFirstAngle(firstAngle) Установить свойство (**)
GetCurve3D - Получить указатель на интерфейс математической кривой
Синтаксис Automation:
LPDISPATCH GetCurve3D();
Синтаксис COM:
LPCURVE3D GetCurve3D();
Возвращаемое значение:
- интерфейс математической кривой ksCurve3D или ICurve3D.
GetDiamObject - Получить объект, задающий диаметр
Синтаксис Automation:
LPDISPATCH GetDiamObject();
Синтаксис COM:
LPENTITY GetDiamObject();
Возвращаемое значение:
- указатель на интерфейс объекта ksEntity или IEntity.
GetHeightObject - Получить объект, задающий высоту
Синтаксис Automation:
LPDISPATCH GetHeightObject();
Синтаксис COM:
LPENTITY GetHeightObject();
Возвращаемое значение:
- указатель на интерфейс объекта 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 эскиза.
height - Высота спирали
Тип данных: double Синтаксис Automation:
height = iCylindricSpiral.height Получить свойство (* )
iCylindricSpiral.height = height Установить свойство (* )
height = iCylindricSpiral.GetHeight() Получить свойство (**)
iCylindricSpiral.SetHeight(height) Установить свойство (**)
heightAdd - Дополнительная высота
Тип данных: double Синтаксис Automation:
heightAdd = iCylindricSpiral.heightAdd Получить свойство (* )
iCylindricSpiral.heightAdd = heightAdd Установить свойство (* )
heightAdd = iCylindricSpiral.GetHeightAdd() Получить свойство (**)
iCylindricSpiral.SetHeightAdd(heightAdd) Установить свойство (**)
heightAddHow - Признак дополнительной высоты
Тип данных: BOOL Значения свойства:
| TRUE | - продолжить за объект, |
|---|---|
| FALSE | - не доходя до объекта. |
| Синтаксис Automation: |
heightAddHow = iCylindricSpiral.heightAddHow Получить свойство (* )
iCylindricSpiral.heightAddHow = heightAddHow Установить свойство (* )
heightAddHow = iCylindricSpiral.GetHeightAddHow() Получить свойство (**)
iCylindricSpiral.SetHeightAddHow(heightAddHow) Установить свойство (**)
Примечание Данное свойство используется только при способе задания высоты "по объекту" (heightType = 1).
heightType - Способ задания высоты
Тип данных: short Значения свойства:
| 0 | - по размеру, |
|---|---|
| 1 | - по объекту. |
| Синтаксис Automation: |
heightType = iCylindricSpiral.heightType Получить свойство (* )
iCylindricSpiral.heightType = heightType Установить свойство (* )
heightType = iCylindricSpiral.GetHeightType() Получить свойство (**)
iCylindricSpiral.SetHeightType(heightType) Установить свойство (**)
SetDiamObject - Установить объект, задающий диаметр
Синтаксис Automation:
BOOL SetDiamObject (LPDISPATCH diamObject);
Синтаксис COM:
BOOL SetDiamObject (LPENTITY diamObject);
Входной параметр:
diamObject - указатель на интерфейс объекта ksEntity или IEntity.
Возвращаемое значение:
TRUE - в случае успешного завершения.
SetHeightObject - Установить объект, задающий высоту
Синтаксис Automation:
BOOL SetHeightObject (LPDISPATCH heightObject);
Синтаксис COM:
BOOL SetHeightObject (LPENTITY heightObject);
Входной параметр:
heightObject - указатель на интерфейс объекта ksEntity или IEntity.
Возвращаемое значение:
TRUE - в случае успешного завершения.
SetLocation - Установить точку привязки спирали на базовой плоскости (точку пересечения оси спирали с базовой плоскостью)
Синтаксис Automation:
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 - в случае успешного завершения.
step - Шаг витков спирали
Тип данных: double Синтаксис Automation:
step = iCylindricSpiral.step Получить свойство (* )
iCylindricSpiral.step = step Установить свойство (* )
step = iCylindricSpiral.GetStep() Получить свойство (**)
iCylindricSpiral.SetStep(step) Установить свойство (**)
turn - Количество витков спирали
Тип данных: double Синтаксис Automation:
turn = iCylindricSpiral.turn Получить свойство (* )
iCylindricSpiral.turn = turn Установить свойство (* )
turn = iCylindricSpiral.GetTurn() Получить свойство (**)
iCylindricSpiral.SetTurn(turn) Установить свойство (**)
turnDir - Направление навивки спирали
Тип данных: BOOL Значения свойства:
| TRUE | - по часовой стрелке, |
|---|---|
| FALSE | - против часовой стрелки. |
| Синтаксис Automation: |
turnDir = iCylindricSpiral.turnDir Получить свойство (* )
iCylindricSpiral.turnDir = turnDir Установить свойство (* )
turnDir = iCylindricSpiral.GetTurnDir() Получить свойство (**)
iCylindricSpiral.SetTurnDir(turnDir) Установить свойство (**)