--- title: "Конвертация в дополнительные форматы (Интерфейсы ksAdditionFormatParam, IAdditionFormatParam)" type: interface api: [api7] domain: [3d] tags: [interface, api7, 3d, ksadditionformatparam] sources: - ksadditionformatparam.html --- *API интерфейсов. Версия 5 > Документ-модель (Интерфейсы - ksDocument3D, IDocument3D ) * ## Конвертация в дополнительные форматы (Интерфейсы ksAdditionFormatParam, IAdditionFormatParam) Интерфейс параметров для записи модели в форматы IGES, SAT, XT, X_B, STEP, STL, VRML. | ksAdditionFormatParam | - интерфейс Automation | | --- | --- | | IAdditionFormatParam | - интерфейс COM | Примечание: Данный интерфейс может быть получен с использованием метода интерфейса ksDocument3D::AdditionFormatParam. ## angle - Максимально допустимое угловое отклонение касательных кривой или нормалей поверхности в соседних точках на расстоянии шага Тип данных: double Синтаксис Automation: ``` angle = Object.angle Получить свойство(* ) Object.angle = angle Установить свойство (* ) angle = Object.GetAngle() Получить свойство (**) Object.SetAngle( angle ) Установить свойство (**) ``` ## author - Автор Тип данных: BSTR Синтаксис Automation: ``` author = Object.author Получить свойство(* ) Object.author = author Установить свойство (* ) author = Object.GetAuthor() Получить свойство (**) Object.SetAuthor( author ) Установить свойство (**) ``` ## comment - Комментарий Тип данных: BSTR Синтаксис Automation: ``` comment = Object.comment Получить свойство(* ) Object.comment = comment Установить свойство (* ) comment = Object.GetComment() Получить свойство (**) Object.SetComment( comment ) Установить свойство (**) ``` ## configuration - Выбранная конфигурация Тип данных: VARIANT Синтаксис Automation: ``` configuration = Object.configuration Получить свойство(* ) Object.configuration = configuration Установить свойство (* ) configuration = Object.GetConfiguration() Получить свойство (**) Object.SetInheritVisible( configuration ) Установить свойство (**) ``` Примечание: Свойство используется при загрузке файлов SolidWorks в функции IDocument3D::LoadFromAdditionFormat (ksIDocument3D::LoadFromAdditionFormat). Значение может быть следующих типов: •VT_I4 - индекс конфигурации, начиная с 0. •VT_BSTR - строковое имя конфигурации, •VT_EMPTY - загружать текущую конфигурацию. Версия: Компас v20 ## configurationFileName - Путь к текущему файлу конфигурации Тип данных: BSTR Синтаксис Automation: ``` configurationFileName = Object.configurationFileName Получить свойство(* ) Object.configurationFileName = configurationFileName Установить свойство (* ) configurationFileName = Object.GetConfigurationFileName() Получить свойство (**) Object.SetConfigurationFileName( configurationFileName ) Установить свойство (**) ``` Примечание: Метод позволяет получить\установить текущий путь к файлу конфигурации импорта\экспорта, заданного пользователем и сохраненного в настройках Компас для заданного формата. Версия Компас v21 ## createLocalComponents - TRUE - создавать вставки как локальные. FALSE - сохранять вставки в отдельных файлах Тип данных: BOOL Синтаксис Automation: ``` createLocalComponents = Object.createLocalComponents Получить свойство(* ) Object.createLocalComponents = createLocalComponents Установить свойство (* ) createLocalComponents = Object.GetCreateLocalComponents() Получить свойство (**) Object.SetCreateLocalComponents( createLocalComponents ) Установить свойство (**) ``` ## format - Формат файла для записи модели Тип данных: D3FormatConvType Значения свойства... Синтаксис Automation: ``` format = iAdditionFormatParam.format Получить свойство(* ) iAdditionFormatParam.format = format Установить свойство (* ) format = iAdditionFormatParam.GetFormat() Получить свойство (**) iAdditionFormatParam.SetFormat(format) Установить свойство (**) ``` ## formatBinary - Признак, определяющий тип файла (двоичный или текстовый) Тип данных: BOOL Значения свойства: | TRUE | - двоичный формат, | | --- | --- | | FALSE | - текстовый формат. | Синтаксис Automation: ``` formatBinary = iAdditionFormatParam.formatBinary Получить свойство(* ) iAdditionFormatParam.formatBinary = formatBinary Установить свойство (* ) formatBinary = iAdditionFormatParam.GetFormatBinary() Получить свойство (**) iAdditionFormatParam.SetFormatBinary(formatBinary) Установить свойство (**) ``` Примечание: Свойство используется при записи в форматы XT, X_B, STL. ## GetObjectsOptions - Получить признак чтения\записи объектов модели Синтаксис Automation: ``` BOOL GetObjectsOptions( long option ); ``` Синтаксис COM: ``` BOOL GetObjectsOptions( long option ); Входные параметры: option - константа из перечисления ksD3ConverterOptionsEnum. ``` ## GetPlacement - Получить систему координат позиционирования модели Синтаксис Automation: ``` LPDISPATCH GetPlacement(); Возвращаемое значение: - указатель на интерфейс ksPlacement системы координат отображения модели в окне. ``` Синтаксис COM: ``` LPPLACEMENT GetPlacement(); Возвращаемое значение: - указатель на интерфейс IPlacement системы координат отображения модели в окне. ``` ## Init - Инициализировать параметры Синтаксис Automation: ``` BOOL Init(); ``` Синтаксис COM: ``` BOOL Init(); Возвращаемое значение: TRUE - в случае удачного завершения. ``` Примечание: Метод обнуляет все параметры записи модели в дополнительные форматы. ## length - Максимально допустимое расстояние между соседними точками на расстоянии шага Тип данных: double Синтаксис Automation: ``` length = Object.length Получить свойство(* ) Object.length = length Установить свойство (* ) length = Object.GetLength() Получить свойство (**) Object.SetLength( length ) Установить свойство (**) ``` ## lengthUnits - Единицы измерения длины Тип данных: из перечисления ksLengthUnitsEnum Синтаксис Automation: ``` lengthUnits = Object.lengthUnits Получить свойство(* ) Object.lengthUnits = lengthUnits Установить свойство (* ) lengthUnits = Object.GetLengthUnits() Получить свойство (**) Object.SetLengthUnits( lengthUnits ) Установить свойство (**) ``` ## LoadConfigurationFile - Загрузить конфигурацию из файла Синтаксис Automation: ``` BOOL LoadConfigurationFile( BSTR fileName ); ``` Синтаксис COM: ``` BOOL LoadConfigurationFile( BSTR fileName ); Входные параметры: fileName - имя файла конфигурации. Возвращаемое значение: TRUE - в случае удачного завершения. FALSE - в случае неудачи. Версия Компас v21 ``` ## maxTeselationCellCount - Максимальное количество ячеек в строке и ряду триангуляционной сетки (если 0, то не задано) Тип данных: long Синтаксис Automation: ``` maxTeselationCellCount = Object.maxTeselationCellCount Получить свойство(* ) Object.maxTeselationCellCount = maxTeselationCellCount Установить свойство (* ) maxTeselationCellCount = Object.GetMaxTeselationCellCount() Получить свойство (**) Object.SetMaxTeselationCellCount( maxTeselationCellCount ) Установить свойство (**) ``` ## needCreateComponentsFiles - Создавать файлы компонентов Тип данных: BOOL Синтаксис: ``` needCreateComponentsFiles = Object.needCreateComponentsFiles Получить свойство(* ) Object.needCreateComponentsFiles = needCreateComponentsFiles Установить свойство (* ) needCreateComponentsFiles = Object.GetNeedCreateComponentsFiles() Получить свойство (**) Object.SetNeedCreateComponentsFiles( needCreateComponentsFiles ) Установить свойство (**) ``` Примечание По умолчанию используется значение TRUE - файлы компонентов создаются на диске рядом с файлом сборки, FALSE - создаются локальные вставки. ## organization - Организация Тип данных: BSTR Синтаксис Automation: ``` organization = Object.organization Получить свойство(* ) Object.organization = organization Установить свойство (* ) organization = Object.GetOrganization() Получить свойство (**) Object.SetOrganization( organization ) Установить свойство (**) ``` ## password - Пароль для загрузки упрощенных вставок перед экспортом Тип данных: BSTR Синтаксис Automation: ``` password = Object.password Получить свойство(* ) Object.password = password Установить свойство (* ) password = Object.GetPassword() Получить свойство (**) Object.SetPassword( password ) Установить свойство (**) ``` ## SaveConfigurationFile - Сохранить конфигурацию в файл Синтаксис Automation: ``` BOOL SaveConfigurationFile( BSTR fileName ); ``` Синтаксис COM: ``` BOOL SaveConfigurationFile( BSTR fileName ); Входные параметры: fileName - имя файла конфигурации. Возвращаемое значение: TRUE - в случае удачного завершения. FALSE - в случае неудачи. Версия Компас v21 ``` ## saveResultDocument - Сохранить полученный документ Тип данных: BOOL Синтаксис: ``` saveResultDocument = Object.saveResultDocument Получить свойство(* ) Object.saveResultDocument = saveResultDocument Установить свойство (* ) saveResultDocument = Object.GetSaveResultDocument() Получить свойство (**) Object.SetSaveResultDocument( saveResultDocument ) Установить свойство (**) ``` ## SetObjectsOptions - Установить признак чтения\записи объектов модели Синтаксис Automation: ``` BOOL SetObjectsOptions( long option, BOOL set ); ``` Синтаксис COM: ``` BOOL SetObjectsOptions( long option, BOOL set ); Входные параметры: option - константа из перечисления ksD3ConverterOptionsEnum, set - TRUE включить признак, FALSE - выключить признак. ``` ## SetPlacement - Установить систему координат позиционирования модели Синтаксис Automation: ``` BOOL SetPlacement( LPDISPATCH place ); Возвращаемое значение: TRUE - в случае успеха. Входные параметры: - указатель на интерфейс ksPlacement системы координат отображения модели в окне. ``` Синтаксис COM: ``` BOOL SetPlacement( LPPLACEMENT place ); Возвращаемое значение: TRUE - в случае успеха. Входные параметры: - указатель на интерфейс IPlacement системы координат отображения модели в окне. ``` ## stepType - Способ вычисления приращения параметра при движении по объекту Тип данных: из перечисления ksStepTypeEnum Синтаксис Automation: ``` stepType = Object.stepType Получить свойство(* ) Object.stepType = stepType Установить свойство (* ) stepType = Object.GetStepType() Получить свойство (**) Object.SetStepType( stepType ) Установить свойство (**) ``` Примечание: Тип шага может определяться комбинацией значений из перечисления ksStepTypeEnum. ## stitchPrecision - Точность сшивки поверхностей Тип данных: double Синтаксис Automation: ``` stitchPrecision = Object.stitchPrecision Получить свойство(* ) Object.stitchPrecision = stitchPrecision Установить свойство (* ) stitchPrecision = Object.GetStitchPrecision() Получить свойство (**) Object.SetStitchPrecision( stitchPrecision ) Установить свойство (**) ``` ## stitchSurfaces - Флаг необходимости сшивки поверхностей при импорте Тип данных: BOOL Синтаксис Automation: ``` stitchSurfaces = Object.stitchSurfaces Получить свойство(* ) Object.stitchSurfaces = stitchSurfaces Установить свойство (* ) stitchSurfaces = Object.GetStitchSurfaces() Получить свойство (**) Object.SetStitchSurfaces( stitchSurfaces ) Установить свойство (**) ``` ## textExportForm - Признак, чтения\записи текстов Тип данных: из перечисления ksTextExportFormEnum Синтаксис Automation: ``` textExportForm = Object.textExportForm Получить свойство(* ) Object.textExportForm = textExportForm Установить свойство (* ) textExportForm = Object.GetTextExportForm() Получить свойство (**) Object.SetTextExportForm( textExportForm ) Установить свойство (**) ``` ## topolgyIncluded - Признак, определяющий, включать ли топологию модели при экспорте Тип данных: BOOL Значения свойства: | TRUE | - включить топологию, | | --- | --- | | FALSE | - не включать топологию. | Синтаксис Automation: ``` topolgyIncluded = iAdditionFormatParam.topolgyIncluded Получить свойство(* ) iAdditionFormatParam.topolgyIncluded = topolgyIncluded Установить свойство (* ) topolgyIncluded = iAdditionFormatParam.GetTopolgyIncluded() Получить свойство (**) iAdditionFormatParam.SetTopolgyIncluded(topolgyIncluded) Установить свойство (**) ``` Примечание: Свойство используется при записи в формат IGES.