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
title, type, api, domain, tags, sources
| title | type | api | domain | tags | sources | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GetCommandsString - Получить строку меню, если меню было задано строкой | interface |
|
|
|
|
*API интерфейсов. Версия 5 > Документ-модель (Интерфейсы - ksDocument3D, IDocument3D ) > Запрос к сиcтеме (Интерфейсы ksRequestInfo3D, IRequestInfo) > IRequestInfo - методы *
GetCommandsString - Получить строку меню, если меню было задано строкой
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::Prompt. Синтаксис COM:
LPOLESTR GetCommandsString();
Возвращаемое значение:
- строка меню.
GetCursorId - Получить идентификатор курсора
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::CursorId. Синтаксис COM:
long GetCursorId();
Возвращаемое значение:
- идентификатор курсора.
GetCursorName - Получить имя курсора
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::CursorName. Синтаксис COM:
LPOLESTR GetCursorName();
Возвращаемое значение:
- имя курсора.
GetDynamicFiltering - Получить свойство режима динамической фильтрации
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::DynamicFiltering. Синтаксис COM:
GetDynamicFiltering();
Возвращаемое значение:
TRUE - режим динамической фильтрации включен,
FALSE - режим динамической фильтрации выключен.
Примечания: Метод позволяет получить флаг режима динамической фильтрации (TRUE - включен). Метод распространяется на работу процесса указания местоположения или объектов IDocument3D::UserGetPlacementAndEntity. Перед запуском процесса определяются параметры запроса к системе - интерфейс IRequestInfo, в котором можно определить функцию фильтрации. Если свойство DynamicFiltering, определяющее режим динамической фильтрации, равно FALSE (умолчательный режим), то функция фильтрации вызывается только когда курсор проходит над объектом, чтобы библиотека могла сообщить системе, подходит данный объект или нет. Если функция фильтрации возвращает TRUE, объект библиотеке подходит. Если свойство DynamicFiltering равно TRUE, то функция фильтрации вызывается не только когда курсор проходит над объектом, но и когда объекта под курсором нет. В таком случае передается сигнал библиотеке, что объекта под курсором нет. Возвращаемое значение функции фильтрации игнорируется.
GetMenuId - Получить идентификатор меню
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::MenuId. Синтаксис COM:
long GetMenuId();
Возвращаемое значение:
- идентификатор меню.
GetProcessParam - Получить указатель на интерфейс параметров процесса
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::processParam. Синтаксис COM:
LPUNKNOWN GetProcessParam();
Возвращаемое значение:
- Указатель на интерфейс IProcessParam.
Примечания: Если в интерфейсе параметров запроса к системе указатель на интерфейс параметров процесса не NULL, то при выполнении процесса UserGetPlacementAndEntity элементы управления из IProcessParam попадут на Панель свойств процесса.
GetPrompt - Получить строку-подсказку процесса
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::Prompt. Синтаксис COM:
GetPrompt();
Возвращаемое значение:
- строка подсказки.
GetTitle - Получить заголовок
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::title. Синтаксис COM:
LPOLESTR GetTitle();
Возвращаемое значение:
- заголовок.
SetCommandsString - Установить строку меню, если меню было задано строкой
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::Prompt. Синтаксис COM:
BOOL SetCommandsString(LPOLESTR menu);
Входные параметры:
menu - строка меню.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
SetCursorId - Установить идентификатор курсора
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::CursorId. Синтаксис COM:
BOOL SetCursorId(long cursorId);
Входные параметры:
cursorId - идентификатор курсора.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
SetCursorName - Установить имя курсора
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::CursorName. Синтаксис COM:
BOOL SetCursorName(LPOLESTR cursor);
Входные параметры:
cursor - имя курсора.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
SetCursorText - Установить текст курсора
Синтаксис COM:
BOOL SetCursorText( BSTR Text );
Примечание Функция работает при запущенном процессе. Текст сразу выдается над курсором.
SetDynamicFiltering - Установить свойство режима динамической фильтрации
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::DynamicFiltering. Синтаксис COM:
SetDynamicFiltering(BOOL f);
Входные параметры:
f - (BOOL) - флаг режима динамической фильтрации (TRUE - включить).
Возвращаемое значение:
TRUE - режим динамической фильтрации изменен.
Примечания: Метод позволяет установить флаг режима динамической фильтрации (TRUE - включен). Метод распространяется на работу процесса указания местоположения или объектов IDocument3D::UserGetPlacementAndEntity. Перед запуском процесса определяются параметры запроса к системе - интерфейс IRequestInfo, в котором можно определить функцию фильтрации. Если свойство DynamicFiltering, определяющее режим динамической фильтрации, равно FALSE (умолчательный режим), то функция фильтрации вызывается только когда курсор проходит над объектом, чтобы библиотека могла сообщить системе, подходит данный объект или нет. Если функция фильтрации возвращает TRUE, объект библиотеке подходит. Если свойство DynamicFiltering равно TRUE, то функция фильтрации вызывается не только когда курсор проходит над объектом, но и когда объекта под курсором нет. В таком случае передается сигнал библиотеке, что объекта под курсором нет. Возвращаемое значение функции фильтрации игнорируется.
SetMenuId - Установить идентификатор меню
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::MenuId. Синтаксис COM:
BOOL SetMenuId(long menuId);
Входные параметры:
menuId - идентификатор меню.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
SetProcessParam - Установить указатель на интерфейс параметров процесса
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::processParam. Синтаксис COM:
BOOL SetProcessParam( LPUNKNOWN param);
Входные параметры:
param - указатель на интерфейс IProcessParam.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
Примечания: Если в интерфейсе параметров запроса к системе указатель на интерфейс параметров процесса не NULL, то при выполнении процесса UserGetPlacementAndEntity элементы управления из IProcessParam попадут на Панель свойств процесса.
SetPrompt - Установить строку-подсказку процесса
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::Prompt. Синтаксис COM:
BOOL SetPrompt(LPOLESTR prompt);
Входные параметры:
prompt - строка подсказки.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
SetTitle - Установить заголовок
Аналог данного метода при использовании Automation - свойство ksRequestInfo3D::title Синтаксис COM:
BOOL SetTitle(LPOLESTR title);
Входные параметры:
title - заголовок.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.