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

title, type, api, domain, tags, sources

title	type	api	domain	tags	sources
Интерфейс привязки (Интерфейс ksSnapOptions)	interface	api7	2d	interface api7 2d kssnapoptions	kssnapoptions.html

*API интерфейсов. Версия 5 > Графический документ (Интерфейсы - ksDocument2D и IDocument2D) *

Интерфейс привязки (Интерфейс ksSnapOptions)

Интерфейс параметров привязок в графическом документе. Аналог данных параметров при использовании API экспортных функций - SnapOptrions. Примечание: Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct. Смотрите также: KompasObject

angleStep - Шаг угловой привязки (в градусах)

Тип данных: double. Синтаксис Automation:

angleStep = iSnapOptrions.angleStep    Получить свойство (* )
iSnapOptrions.angleStep = angleStep    Установить свойство (* )
angleStep = iSnapOptrions.GetAngleStep()    Получить свойство (**)
iSnapOptrions.SetAngleStep (angleStep)    Установить свойство (**)

angSnap - Глобальная "Угловая привязка"

Тип данных: BOOL. Значения свойства:

TRUE	- привязка включена,
FALSE	- привязка выключена.
Синтаксис Automation:

angSnap = iSnapOptrions.angSnap    Получить свойство (* )
iSnapOptrions.angSnap = angSnap    Установить свойство (* )
angSnap = iSnapOptrions.GetAngSnap()    Получить свойство (**)
iSnapOptrions.SetAngSnap (angSnap)    Установить свойство (**)

commonOpt - Общие настройки привязок

Тип данных:long. Общие настройки привязок... Синтаксис Automation:

commonOpt = iSnapOptrions.commonOpt    Получить свойство (* )
iSnapOptrions.commonOpt = commonOpt    Установить свойство (* )
commonOpt = iSnapOptrions.GetCommonOpt()    Получить свойство (**)
iSnapOptrions.SetCommonOpt (commonOpt)    Установить свойство (**)

GetCommonOptValue - Получить значение одного из флагов признака commonOpt

Синтаксис Automation:

BOOL GetCommonOptValue (long commonOpt);
Входной параметр:
commonOpt    - битовый флаг, характеризующий определенную общую настройку привязок.
Возвращаемое значение:
TRUE    - данный битовый флаг включен,
FALSE    - данный битовый флаг выключен.

grid - Глобальная привязка "По сетке"

Тип данных:BOOL. Значения свойства:

TRUE	- привязка включена,
FALSE	- привязка выключена.
Синтаксис Automation:

grid = iSnapOptrions.grid    Получить свойство (* )
iSnapOptrions.grid = grid    Установить свойство (* )
grid = iSnapOptrions.GetGrid()    Получить свойство (**)
iSnapOptrions.SetGrid (grid)    Установить свойство (**)

Init - Инициализировать параметры

Синтаксис Automation:

BOOL Init();
Возвращаемое значение:
TRUE    - в случае удачного завершения.

Примечание: Метод обнуляет все параметры привязок в графическом документе.

intersect - Глобальная привязка "Пересечение"

Тип данных:BOOL. Значения свойства:

TRUE	- привязка включена,
FALSE	- привязка выключена.
Синтаксис Automation:

intersect = iSnapOptrions.intersect    Получить свойство (* )
iSnapOptrions.intersect = intersect    Установить свойство (* )
intersect = iSnapOptrions.GetIntersect()    Получить свойство (**)
iSnapOptrions.SetIntersect (intersect)    Установить свойство (**)

lolcalSnap - Тип локальной привязки

Тип данных:short. Типы локальной привязки... Синтаксис Automation:

localSnap = iSnapOptrions.localSnap    Получить свойство (* )
iSnapOptrions.localSnap = localSnap    Установить свойство (* )
localSnap = iSnapOptrions.GetLocalSnap()    Получить свойство (**)
iSnapOptrions.SetLocalSnap (localSnap)    Установить свойство (**)

nearestMiddle - Глобальная привязка "Середина"

Тип данных: BOOL. Значения свойства:

TRUE	- привязка включена,
FALSE	- привязка выключена.
Синтаксис Automation:

nearestMiddle = iSnapOptrions.nearestMiddle    Получить свойство (* )
iSnapOptrions.nearestMiddle = nearestMiddle    Установить свойство (* )
nearestMiddle = iSnapOptrions.GetNearestMiddle()    Получить свойство (**)
iSnapOptrions.SetNearestMiddle (nearestMiddle)    Установить свойство (**)

nearestPoint - Глобальная привязка "Ближайшая точка"

Тип данных:BOOL. Значения свойства:

TRUE	- привязка включена,
FALSE	- привязка выключена.
Синтаксис Automation:

nearestPoint = iSnapOptrions.nearestPoint    Получить свойство (* )
iSnapOptrions.nearestPoint = nearestPoint    Установить свойство (* )
nearestPoint = iSnapOptrions.GetNearestPoint()    Получить свойство (**)
iSnapOptrions.SetNearestPoint (nearestPoint)    Установить свойство (**)

pointOnCurve - Глобальная привязка "Точка на кривой"

Тип данных:BOOL. Значения свойства:

TRUE	- привязка включена,
FALSE	- привязка выключена.
Синтаксис Automation:

pointOnCurve = iSnapOptrions.pointOnCurve    Получить свойство (* )
iSnapOptrions.pointOnCurve = pointOnCurve    Установить свойство (* )
pointOnCurve = iSnapOptrions.GetPointOnCurve()    Получить свойство (**)
iSnapOptrions.SetPointOnCurve (pointOnCurve)    Установить свойство (**)

SetCommonOptValue - Установить значение одного из флагов признака commonOpt

Синтаксис Automation:

BOOL SetCommonOptValue (long commonOpt,
BOOL state);
Входные параметры:
commonOpt    - битовый флаг, характеризующий определенную общую настройку привязок,
state    - состояние указанного битового флага: TRUE - включен, FALSE - выключен.
Возвращаемое значение:
TRUE    - в случае удачного завершения.

tangentToCurve - Глобальная привязка "Касание"

Тип данных:BOOL. Значения свойства:

TRUE	- привязка включена,
FALSE	- привязка выключена.
Синтаксис Automation:

tangentToCurve = iSnapOptrions.tangentToCurve    Получить свойство (* )
iSnapOptrions.tangentToCurve = tangentToCurve    Установить свойство (* )
tangentToCurve = iSnapOptrions.GetTangentToCurve()    Получить свойство (**)
iSnapOptrions.SetTangentToCurve (tangentToCurve)    Установить свойство (**)

xyAlign - Глобальная привязка "Выравнивание"

Тип данных:BOOL. Значения свойства:

TRUE	- привязка включена,
FALSE	- привязка выключена.
Синтаксис Automation:

xyAlign = iSnapOptrions.xyAlign    Получить свойство (* )
iSnapOptrions.xyAlign = xyAlign    Установить свойство (* )
xyAlign = iSnapOptrions.GetXyAlign()    Получить свойство (**)
iSnapOptrions.SetXyAlign (xyAlign)    Установить свойство (**)