**API List** ############ EXPORT_API ********** .. tabs:: .. code-tab:: python def ExportZPac() -> str """ @ingroup EXPORT_API @brief Export ZPac file in the CLO temporary folder @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportZPac() /// @ingroup EXPORT_API /// @brief Export ZPac file in the CLO temporary folder /// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportZPac(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export ZPac file @param string _filePath : target file path in ASCII @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportZPac(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export ZPac file /// @param string _filePath : target file path in ASCII /// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportZPacW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export ZPac file @param wstring _filePath : target file path in UNICODE @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportZPacW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export ZPac file /// @param wstring _filePath : target file path in UNICODE /// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportZPrj() -> str """ @ingroup EXPORT_API @brief Export ZPrj file @return Output file path; output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportZPrj() /// @ingroup EXPORT_API /// @brief Export ZPrj file /// @return Output file path; output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportZPrj(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export ZPrj file @param _filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZPrj(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export ZPrj file /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportZPrj(_filePath : str, _bCreateThumbnail : bool) -> str """ @ingroup EXPORT_API @brief Export ZPrj file @param _filePath: output file path @param _bCreateThumbnail: if _bCreateThumbnail is true, 'png' file will be created along 'zprj' file. @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZPrj(const string& _filePath, bool _bCreateThumbnail) /// @ingroup EXPORT_API /// @brief Export ZPrj file /// @param _filePath: output file path /// @param _bCreateThumbnail: if _bCreateThumbnail is true, 'png' file will be created along 'zprj' file. /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportZPrjW(_filePath : str, _bCreateThumbnail : bool) -> str """ @ingroup EXPORT_API @brief Export ZPrj file @param _filePath: output file path @param _bCreateThumbnail: if _bCreateThumbnail is true, 'png' file will be created along 'zprj' file. @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportZPrjW(const wstring& _filePath, bool _bCreateThumbnail) /// @ingroup EXPORT_API /// @brief Export ZPrj file /// @param _filePath: output file path /// @param _bCreateThumbnail: if _bCreateThumbnail is true, 'png' file will be created along 'zprj' file. /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportOBJ() -> list[str] """ @ingroup EXPORT_API @brief Export OBJ file @param options If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportOBJ() /// @ingroup EXPORT_API /// @brief Export OBJ file /// @param options If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportOBJ(_filePath : str) -> list[str] """ @ingroup EXPORT_API @brief Export OBJ file @param _filePath: output file path @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportOBJ() /// @ingroup EXPORT_API /// @brief Export OBJ file /// @param _filePath: output file path /// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportOBJ(_options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export OBJ file @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportOBJ(const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export OBJ file /// @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportOBJ(_filePath : str, _options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export OBJ file @param _filePath: output file path @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportOBJ(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export OBJ file /// @param _filePath: output file path /// @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportOBJW(_filePath : str, _options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export OBJ file @param _filePath: output file path @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty wstring. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportOBJW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export OBJ file /// @param _filePath: output file path /// @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty wstring. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportGLTF(_filePath : str, _options : ImportExportOption, _bGLBinary : bool) -> list[str] """ @ingroup EXPORT_API @brief Export GLTF @param options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. """ .. code-tab:: c++ ExportGLTF(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export GLTF /// @param options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportGLTFW(_filePath : str, _options : ImportExportOption, _bGLBinary : bool) -> list[str] """ @ingroup EXPORT_API @brief Export GLTFW @param options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. """ .. code-tab:: c++ ExportGLTFW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export GLTFW /// @param options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportAlembic(_filePath : str, _options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export Alembic @param options: If "options" is given, it exports Alembic according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. """ .. code-tab:: c++ ExportAlembic(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export Alembic /// @param options: If "options" is given, it exports Alembic according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportAlembicW(_filePath : str, _options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export Alembic W @param options: If "options" is given, it exports Alembic according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. """ .. code-tab:: c++ ExportAlembicW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export Alembic W /// @param options: If "options" is given, it exports Alembic according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportDXF() -> str """ @ingroup EXPORT_API @brief Export DXF file. This api call will display the dialog to set options @return Output file path. If an error occurs, return empty string. Output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportDXF() /// @ingroup EXPORT_API /// @brief Export DXF file. This api call will display the dialog to set options /// @return Output file path. If an error occurs, return empty string. Output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportDXF(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export DXF file. This api call will display the dialog to set options @param _filePath: output file path to export dxf @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportDXF(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export DXF file. This api call will display the dialog to set options /// @param _filePath: output file path to export dxf /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportDXF(_filePath : str, _exportOption : ExportDxfOption) -> str """ @ingroup EXPORT_API @brief Export DXF file without the option dialog. Param ExportDxfOption is applicable for the options. @param _filePath: output file path to export dxf @param _exportOption: options to export dxf file @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportDXF(const string& _filePath, const Marvelous::ExportDxfOption& _exportOption) /// @ingroup EXPORT_API /// @brief Export DXF file without the option dialog. Param ExportDxfOption is applicable for the options. /// @param _filePath: output file path to export dxf /// @param _exportOption: options to export dxf file /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportDXFW(_filePath : str, _exportOption : ExportDxfOption) -> str """ @ingroup EXPORT_API @brief Export DXF file without the option dialog. Param ExportDxfOption is applicable for the options. @param _filePath: output file path @param _exportOption: options to export dxf file @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportDXFW(const wstring& _filePath, const Marvelous::ExportDxfOption& _exportOption) /// @ingroup EXPORT_API /// @brief Export DXF file without the option dialog. Param ExportDxfOption is applicable for the options. /// @param _filePath: output file path /// @param _exportOption: options to export dxf file /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportTechPack(_filePath : str, _exportOption : ExportTechpackOption) -> None """ @ingroup EXPORT_API @brief Export Tech Pack data in json file and associated image files. @param _filePath: output filepath; the filePath Should be given in "*.json" format @param _exportOption: options to export techpack(.json) file """ .. code-tab:: c++ ExportTechPack(const string& _filePath, const Marvelous::ExportTechpackOption& _exportOption) /// @ingroup EXPORT_API /// @brief Export Tech Pack data in json file and associated image files. /// @param _filePath: output filepath; the filePath Should be given in "*.json" format /// @param _exportOption: options to export techpack(.json) file .. tabs:: .. code-tab:: python def ExportTechPackW(_filepath : str, _exportOption : ExportTechpackOption) -> None """ @ingroup EXPORT_API @brief Export Tech Pack data in json file and associated image files. @param _filePath: output filepath; the filePath Should be given in "*.json" format @param _exportOption: options to export techpack(.json) file """ .. code-tab:: c++ ExportTechPackW(const wstring& _filepath, const Marvelous::ExportTechpackOption& _exportOption) /// @ingroup EXPORT_API /// @brief Export Tech Pack data in json file and associated image files. /// @param _filePath: output filepath; the filePath Should be given in "*.json" format /// @param _exportOption: options to export techpack(.json) file .. tabs:: .. code-tab:: python def ExportTechPackToStream(_outputImageFolderPath : str) -> str """ @ingroup EXPORT_API @brief Export Tech Pack data in string and associated image files. @param _outputImageFolderPath: get output folder path where the image files are located by ExportTechpack @return Output stream for JSON data with the output folder path at the first line. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTechPackToStream(string& _outputImageFolderPath) /// @ingroup EXPORT_API /// @brief Export Tech Pack data in string and associated image files. /// @param _outputImageFolderPath: get output folder path where the image files are located by ExportTechpack /// @return Output stream for JSON data with the output folder path at the first line. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTechPackToStreamW(_outputImageFolderPath : str) -> str """ @ingroup EXPORT_API @brief Export Tech Pack data in string and associated image files. @param _outputImageFolderPath: get output folder path where the image files are located by ExportTechpack @return Output stream for JSON data with the output folder path at the first line. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportTechPackToStreamW(wstring& _outputImageFolderPath) /// @ingroup EXPORT_API /// @brief Export Tech Pack data in string and associated image files. /// @param _outputImageFolderPath: get output folder path where the image files are located by ExportTechpack /// @return Output stream for JSON data with the output folder path at the first line. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportThumbnail3D() -> str """ @ingroup EXPORT_API @brief Export thumbnail of the current scene @return Output file path: output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportThumbnail3D() /// @ingroup EXPORT_API /// @brief Export thumbnail of the current scene /// @return Output file path: output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportThumbnail3D(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export thumbnail of the current scene in the 3D Windows @param _filePath: output file path to save the screenshot @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportThumbnail3D(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export thumbnail of the current scene in the 3D Windows /// @param _filePath: output file path to save the screenshot /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportThumbnail3DW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export thumbnail of the current scene in the 3D Windows @param _filePath: output file path to save the screenshot @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportThumbnail3DW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export thumbnail of the current scene in the 3D Windows /// @param _filePath: output file path to save the screenshot /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportMaskSnapshot3D(_filePath : str, _exportOption : ExportTechpackOption) -> list[ list [ str] ] """ @ingroup EXPORT_API @brief Export mask snapshot of the current scene in the 3D windows. only for H&M. @param _filePath: output file path to save the screenshot. @param _exportOption: export option include autentication key. """ .. code-tab:: c++ ExportMaskSnapshot3D(const std::string& _filePath, const Marvelous::ExportTechpackOption& _exportOption) /// @ingroup EXPORT_API /// @brief Export mask snapshot of the current scene in the 3D windows. only for H&M. /// @param _filePath: output file path to save the screenshot. /// @param _exportOption: export option include autentication key. .. tabs:: .. code-tab:: python def ExportSnapshot3D(_filePath : str) -> list[ list [ str ] ] """ @ingroup EXPORT_API @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ... @param _filePath: output file path to save the screenshot @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportSnapshot3D(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ... /// @param _filePath: output file path to save the screenshot /// @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportSnapshot3D() -> list[ list [ str ] ] """ @ingroup EXPORT_API @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ... @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportSnapshot3D() /// @ingroup EXPORT_API /// @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ... /// @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportSnapshot3DW(_filePath : str) -> list[ list [ str ] ] """ @ingroup EXPORT_API @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ... @param _filePath: output file path to save the screenshot @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportSnapshot3DW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ... /// @param _filePath: output file path to save the screenshot /// @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportCustomViewSnapshot(_targetFolderPath : str, _width : int, _height : int, _outputPrefix : str) -> list [ str ] """ @ingroup EXPORT_API @brief Export snapshot images of Custom View. @param _targetFolderPath: output folder path @param _width: image width for the snapshots @param _height: image height for the snapshots @param _outputPrefix: If you set the 'outputPrefix' as empty value - "", then the saved file names will start with the index in the custom view; or if you set the 'outputPrefix' as some letters, the saved file names will have it as the first letters. @return Return the list of the path of output files """ .. code-tab:: c++ ExportCustomViewSnapshot(const string& _targetFolderPath, unsigned int _width, unsigned int _height, string _outputPrefix = "") /// @ingroup EXPORT_API /// @brief Export snapshot images of Custom View. /// @param _targetFolderPath: output folder path /// @param _width: image width for the snapshots /// @param _height: image height for the snapshots /// @param _outputPrefix: If you set the 'outputPrefix' as empty value - "", then the saved file names will start with the index in the custom view; or if you set the 'outputPrefix' as some letters, the saved file names will have it as the first letters. /// @return Return the list of the path of output files .. tabs:: .. code-tab:: python def ExportCustomViewSnapshotW(_targetFolderPath : str, _width : int, _height : int, _outputPrefix : str) -> list [ str ] """ @ingroup EXPORT_API @brief Export snapshot images of Custom View. @param _targetFolderPath: output folder path @param _width: image width for the snapshots @param _height: image height for the snapshots @param _outputPrefix: If you set the 'outputPrefix' as empty value - "", then the saved file names will start with the index in the custom view; or if you set the 'outputPrefix' as some letters, the saved file names will have it as the first letters. @return Return the list of the path of output files """ .. code-tab:: c++ ExportCustomViewSnapshotW(const wstring& _targetFolderPath, unsigned int _width, unsigned int _height, wstring _outputPrefix = L"") /// @ingroup EXPORT_API /// @brief Export snapshot images of Custom View. /// @param _targetFolderPath: output folder path /// @param _width: image width for the snapshots /// @param _height: image height for the snapshots /// @param _outputPrefix: If you set the 'outputPrefix' as empty value - "", then the saved file names will start with the index in the custom view; or if you set the 'outputPrefix' as some letters, the saved file names will have it as the first letters. /// @return Return the list of the path of output files .. tabs:: .. code-tab:: python def ExportRenderingImage(_filePath : str, _bRenderAllColorways : bool, _startIndex : int) -> list[ list [ str ] ] """ @ingroup EXPORT_API @brief Export Rendering Image. @param _filePath: output file path @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user. @param _startIndex : Specifies the starting index for turntable rendering. @return Return the list of the path of output files per colorway. """ .. code-tab:: c++ ExportRenderingImage(const string& _filePath, bool _bRenderAllColorways) /// @ingroup EXPORT_API /// @brief Export Rendering Image. /// @param _filePath: output file path /// @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user. /// @param _startIndex : Specifies the starting index for turntable rendering. /// @return Return the list of the path of output files per colorway. .. tabs:: .. code-tab:: python def ExportRenderingImage(_filePath : str, _startIndex : int) -> list[ list [ str ] ] """ @ingroup EXPORT_API @brief Export Rendering Image. @param _filePath: output file path @param _startIndex : Specifies the starting index for turntable rendering. @return Return the list of the path of output files per colorway. """ .. code-tab:: c++ ExportRenderingImage(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export Rendering Image. /// @param _filePath: output file path /// @param _startIndex : Specifies the starting index for turntable rendering. /// @return Return the list of the path of output files per colorway. .. tabs:: .. code-tab:: python def ExportRenderingImage(_bRenderAllColorways : bool, _startIndex : int) -> list[ list [ str ] ] """ @ingroup EXPORT_API @brief Export Rendering Image. @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user. @param _startIndex : Specifies the starting index for turntable rendering. @return Return the list of the path of output files per colorway. """ .. code-tab:: c++ ExportRenderingImage(bool _bRenderAllColorways) /// @ingroup EXPORT_API /// @brief Export Rendering Image. /// @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user. /// @param _startIndex : Specifies the starting index for turntable rendering. /// @return Return the list of the path of output files per colorway. .. tabs:: .. code-tab:: python def ExportRenderingImageW(_filePath : str, _bRenderAllColorways : bool, _startIndex : int) -> list[ list [ str ] ] """ @ingroup EXPORT_API @brief Export Rendering Image. @param _filePath: output file path @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user. @param _startIndex : Specifies the starting index for turntable rendering. @return Return the list of the path of output files per colorway. """ .. code-tab:: c++ ExportRenderingImageW(const wstring& _filePath, bool _bRenderAllColorways) /// @ingroup EXPORT_API /// @brief Export Rendering Image. /// @param _filePath: output file path /// @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user. /// @param _startIndex : Specifies the starting index for turntable rendering. /// @return Return the list of the path of output files per colorway. .. tabs:: .. code-tab:: python def ExportSingleColorwayRenderingImage(_filePath : str, _colorwayIndex : int, _startIndex : int) -> list [ str ] """ @ingroup EXPORT_API @brief Export Rendering Image for the colorway @param _filePath: output file path @param _colorwayIndex: colorway index to render the image @param _startIndex : Specifies the starting index for turntable rendering. @return Return the list of the path of output files """ .. code-tab:: c++ ExportSingleColorwayRenderingImage(const string& _filePath, unsigned int _colorwayIndex) /// @ingroup EXPORT_API /// @brief Export Rendering Image for the colorway /// @param _filePath: output file path /// @param _colorwayIndex: colorway index to render the image /// @param _startIndex : Specifies the starting index for turntable rendering. /// @return Return the list of the path of output files .. tabs:: .. code-tab:: python def ExportSingleColorwayRenderingImage(_colorwayIndex : int, _startIndex : int) -> list [ str ] """ @ingroup EXPORT_API @brief Export Rendering Image for the colorway @param _colorwayIndex: colorway index to render the image @param _startIndex : Specifies the starting index for turntable rendering. @return Return the list of the path of output files; output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportSingleColorwayRenderingImage(unsigned int _colorwayIndex) /// @ingroup EXPORT_API /// @brief Export Rendering Image for the colorway /// @param _colorwayIndex: colorway index to render the image /// @param _startIndex : Specifies the starting index for turntable rendering. /// @return Return the list of the path of output files; output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportSingleColorwayRenderingImageW(_filePath : str, _colorwayIndex : int, _startIndex : int) -> list [ str ] """ @ingroup EXPORT_API @brief Export Rendering Image for the colorway @param _filePath: output file path @param _colorwayIndex: colorway index to render the image /// @param _startIndex : Specifies the starting index for turntable rendering. @return Return the list of the path of output files """ .. code-tab:: c++ ExportSingleColorwayRenderingImageW(const wstring& _filePath, unsigned int _colorwayIndex) /// @ingroup EXPORT_API /// @brief Export Rendering Image for the colorway /// @param _filePath: output file path /// @param _colorwayIndex: colorway index to render the image /// /// @param _startIndex : Specifies the starting index for turntable rendering. /// @return Return the list of the path of output files .. tabs:: .. code-tab:: python def GetTotalRenderImagePaths() -> list [ str ] """ @ingroup EXPORT_API @brief Get File name list for all the exported rendering images @return all the rendered image file paths """ .. code-tab:: c++ GetTotalRenderImagePaths() /// @ingroup EXPORT_API /// @brief Get File name list for all the exported rendering images /// @return all the rendered image file paths .. tabs:: .. code-tab:: python def GetTotalRenderImagePathsW() -> list [ str ] """ @ingroup EXPORT_API @brief Get File name list for all the exported rendering images @return all the rendered image file paths """ .. code-tab:: c++ GetTotalRenderImagePathsW() /// @ingroup EXPORT_API /// @brief Get File name list for all the exported rendering images /// @return all the rendered image file paths .. tabs:: .. code-tab:: python def GetCurrentRenderImagePaths() -> list [ str ] """ @ingroup EXPORT_API @brief Current Render Image paths @return all current renderded image files paths per colorways """ .. code-tab:: c++ GetCurrentRenderImagePaths() /// @ingroup EXPORT_API /// @brief Current Render Image paths /// @return all current renderded image files paths per colorways .. tabs:: .. code-tab:: python def GetCurrentRenderImagePathsW() -> list [ str ] """ @ingroup EXPORT_API @brief Current Render Image paths @return all current renderded image files paths per colorways """ .. code-tab:: c++ GetCurrentRenderImagePathsW() /// @ingroup EXPORT_API /// @brief Current Render Image paths /// @return all current renderded image files paths per colorways .. tabs:: .. code-tab:: python def GetFileNameOnRenderingProperty() -> str """ @ingroup EXPORT_API @return the output file names set on the Rendering Property in CLO """ .. code-tab:: c++ GetFileNameOnRenderingProperty() /// @ingroup EXPORT_API /// @return the output file names set on the Rendering Property in CLO .. tabs:: .. code-tab:: python def GetFileNameOnRenderingPropertyW() -> str """ @ingroup EXPORT_API @return the output file names set on the Rendering Property in CLO """ .. code-tab:: c++ GetFileNameOnRenderingPropertyW() /// @ingroup EXPORT_API /// @return the output file names set on the Rendering Property in CLO .. tabs:: .. code-tab:: python def ExportGarmentInformation() -> str """ @ingroup EXPORT_API @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO) @return Output file path. If an error occurs, return empty string; output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportGarmentInformation() /// @ingroup EXPORT_API /// @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO) /// @return Output file path. If an error occurs, return empty string; output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportGarmentInformation(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO) @param _filePath output file path to export the garment information @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGarmentInformation(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO) /// @param _filePath output file path to export the garment information /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGarmentInformationW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO) @param _filePath output file path to export the garment information @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportGarmentInformationW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO) /// @param _filePath output file path to export the garment information /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportGarmentInformationToStream() -> str """ @ingroup EXPORT_API @brief Export garment information in string @return Garment Information stream in sstring """ .. code-tab:: c++ ExportGarmentInformationToStream() /// @ingroup EXPORT_API /// @brief Export garment information in string /// @return Garment Information stream in sstring .. tabs:: .. code-tab:: python def ExportGarmentInformationToStreamW() -> str """ @ingroup EXPORT_API @brief Export garment information in string as well as json file @return Garment Information stream in wstring """ .. code-tab:: c++ ExportGarmentInformationToStreamW() /// @ingroup EXPORT_API /// @brief Export garment information in string as well as json file /// @return Garment Information stream in wstring .. tabs:: .. code-tab:: python def ExportGarmentInformationConfigData() -> str """ @ingroup EXPORT_API @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference @return Output file path; the output files will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGarmentInformationConfigData() /// @ingroup EXPORT_API /// @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference /// @return Output file path; the output files will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGarmentInformationConfigData(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference @param _filePath output file path to export the garment information configuration data @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGarmentInformationConfigData(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference /// @param _filePath output file path to export the garment information configuration data /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGarmentInformationConfigDataW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference @param _filePath output file path to export the garment information configuration data @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGarmentInformationConfigDataW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference /// @param _filePath output file path to export the garment information configuration data /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGarmentInformationConfigDataToStream() -> str """ @ingroup EXPORT_API Export garment information configuration data in string @return Output stream for JSON data. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGarmentInformationConfigDataToStream() /// @ingroup EXPORT_API /// Export garment information configuration data in string /// @return Output stream for JSON data. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGarmentInformationConfigDataToStreamW() -> str """ @ingroup EXPORT_API Export garment information configuration data in string @return Output stream for JSON data. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGarmentInformationConfigDataToStreamW() /// @ingroup EXPORT_API /// Export garment information configuration data in string /// @return Output stream for JSON data. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTurntableVideo() -> str """ @ingroup EXPORT_API @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer. @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableVideo() /// @ingroup EXPORT_API /// @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer. /// @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTurntableVideo(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer. @param _filePath @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableVideo(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer. /// @param _filePath /// @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTurntableVideoW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer. @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableVideoW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer. /// @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportAnimationVideo() -> str """ @ingroup EXPORT_API @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer. @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportAnimationVideo() /// @ingroup EXPORT_API /// @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer. /// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportAnimationVideo(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer. @param _filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportAnimationVideo(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer. /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportAnimationVideoW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer. @param _filePath: output file path @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportAnimationVideoW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer. /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportAnimationVideo(_options : VideoExportOption) -> str """ @brief Export animation video without showing any UI dialog. @param _options: Export options controlling video dimensions, frame range, and FPS. @return Output file path. If an error occurs, return empty string. Output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportAnimationVideo(const Marvelous::VideoExportOption& _options) /// @brief Export animation video without showing any UI dialog. /// @param _options: Export options controlling video dimensions, frame range, and FPS. /// @return Output file path. If an error occurs, return empty string. Output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportAnimationVideo(_filePath : str, _options : VideoExportOption) -> str """ @brief Export animation video without showing any UI dialog. @param _filePath: output file path @param _options: Export options controlling video dimensions, frame range, and FPS. @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportAnimationVideo(const string& _filePath, const Marvelous::VideoExportOption& _options) /// @brief Export animation video without showing any UI dialog. /// @param _filePath: output file path /// @param _options: Export options controlling video dimensions, frame range, and FPS. /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportAnimationVideoW(_filePath : str, _options : VideoExportOption) -> str """ @brief Export animation video without showing any UI dialog. @param _filePath: output file path @param _options: Export options controlling video dimensions, frame range, and FPS. @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportAnimationVideoW(const wstring& _filePath, const Marvelous::VideoExportOption& _options) /// @brief Export animation video without showing any UI dialog. /// @param _filePath: output file path /// @param _options: Export options controlling video dimensions, frame range, and FPS. /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def GetColorwayCount() -> int """ /////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////// @ingroup EXPORT_API @brief Get the number of colorways in the current garment loaded in CLO @return total count of colorways """ .. code-tab:: c++ GetColorwayCount() /// /////////////////////////////////////////////////////////////////// /// /////////////////////////////////////////////////////////////////// /// @ingroup EXPORT_API /// @brief Get the number of colorways in the current garment loaded in CLO /// @return total count of colorways .. tabs:: .. code-tab:: python def GetCurrentColorwayIndex() -> int """ @ingroup EXPORT_API @brief Get the index of the current colorway in CLO @return the current colorway index """ .. code-tab:: c++ GetCurrentColorwayIndex() /// @ingroup EXPORT_API /// @brief Get the index of the current colorway in CLO /// @return the current colorway index .. tabs:: .. code-tab:: python def GetColorwayNameList() -> list[str] """ @ingroup EXPORT_API @brief Get all the colorway names for the current garment @return the list of name of all colorways """ .. code-tab:: c++ GetColorwayNameList() /// @ingroup EXPORT_API /// @brief Get all the colorway names for the current garment /// @return the list of name of all colorways .. tabs:: .. code-tab:: python def GetColorwayNameListW() -> list[str] """ @ingroup EXPORT_API @brief Get all the colorway names for the current garment @return the list of name of all colorways """ .. code-tab:: c++ GetColorwayNameListW() /// @ingroup EXPORT_API /// @brief Get all the colorway names for the current garment /// @return the list of name of all colorways .. tabs:: .. code-tab:: python def GetAvatarCount() -> int """ @ingroup EXPORT_API @brief Get the number of avatars loaded in CLO @return total count of avatars """ .. code-tab:: c++ GetAvatarCount() /// @ingroup EXPORT_API /// @brief Get the number of avatars loaded in CLO /// @return total count of avatars .. tabs:: .. code-tab:: python def GetAvatarNameList() -> list[str] """ @ingroup EXPORT_API @brief Get all the names of avatars loaded in CLO @return the list of name of all avatars """ .. code-tab:: c++ GetAvatarNameList() /// @ingroup EXPORT_API /// @brief Get all the names of avatars loaded in CLO /// @return the list of name of all avatars .. tabs:: .. code-tab:: python def GetAvatarNameListW() -> list[str] """ @ingroup EXPORT_API @brief Get all the names of avatars loaded in CLO @return the list of name of all avatars """ .. code-tab:: c++ GetAvatarNameListW() /// @ingroup EXPORT_API /// @brief Get all the names of avatars loaded in CLO /// @return the list of name of all avatars .. tabs:: .. code-tab:: python def GetAvatarGenderList() -> list[int] """ @ingroup EXPORT_API @brief Get all the genders of avatars loaded in CLO repectively @return the list of gender of all avatars. 0 : male, 1 : female, -1: unknown """ .. code-tab:: c++ GetAvatarGenderList() /// @ingroup EXPORT_API /// @brief Get all the genders of avatars loaded in CLO repectively /// @return the list of gender of all avatars. 0 : male, 1 : female, -1: unknown .. tabs:: .. code-tab:: python def ExportTurntableImages(_numberOfImages : int) -> list[str] """ @ingroup EXPORT_API @brief Export turntable images for current colorway. @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. @return Output file path list; output files will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableImages(int _numberOfImages) /// @ingroup EXPORT_API /// @brief Export turntable images for current colorway. /// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. /// @return Output file path list; output files will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTurntableImages(_filePath : str, _numberOfImages : int, _width : int, _height : int, _startIndex : int) -> list[str] """ @ingroup EXPORT_API @brief Export turntable images for current colorway. @param _filePath: the output file path to export the turntable snapshots @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. @param _width: image width for the snapshots @param _height: image height for the snapshots @param _startIndex: specifies the starting index position of the turntable. @return Output file path list. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableImages(const string& _filePath, int _numberOfImages, int _width = 2500, int _height = 2500, int _startIndex = 0) /// @ingroup EXPORT_API /// @brief Export turntable images for current colorway. /// @param _filePath: the output file path to export the turntable snapshots /// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. /// @param _width: image width for the snapshots /// @param _height: image height for the snapshots /// @param _startIndex: specifies the starting index position of the turntable. /// @return Output file path list. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTurntableImagesW(_filePath : str, _numberOfImages : int, _width : int, _height : int, _startIndex : int) -> list[str] """ @ingroup EXPORT_API @brief Export turntable images for current colorway. @param _filePath: the output file path to export the turntable snapshots @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. @param _width: image width for the snapshots @param _height: image height for the snapshots @param _startIndex: specifies the starting index position of the turntable. @return Output file path list. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableImagesW(const wstring& _filePath, int _numberOfImages, int _width = 2500, int _height = 2500, int _startIndex = 0) /// @ingroup EXPORT_API /// @brief Export turntable images for current colorway. /// @param _filePath: the output file path to export the turntable snapshots /// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. /// @param _width: image width for the snapshots /// @param _height: image height for the snapshots /// @param _startIndex: specifies the starting index position of the turntable. /// @return Output file path list. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGLB(_filePath : str, _options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export GLB @param options: If "options" is given, it exports GLB according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. """ .. code-tab:: c++ ExportGLB(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export GLB /// @param options: If "options" is given, it exports GLB according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportGLBW(_filePath : str, _options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export GLBW @param options: If "options" is given, it exports GLB according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. """ .. code-tab:: c++ ExportGLBW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export GLBW /// @param options: If "options" is given, it exports GLB according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportPOM() -> str """ @ingroup EXPORT_API @brief Export POM @return Output file path;output file will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportPOM() /// @ingroup EXPORT_API /// @brief Export POM /// @return Output file path;output file will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportPOM(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export POM @param _filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportPOM(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export POM /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportPOMW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export POM @param _filePath: output file path @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportPOMW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export POM /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportPOM(_bInclude3DLength : bool) -> str """ @ingroup EXPORT_API @brief Export POM @param _bInclude3DLength: true: include 3D info, false: exclude 3D info @return Output file path;output file will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportPOM(bool _bInclude3DLength) /// @ingroup EXPORT_API /// @brief Export POM /// @param _bInclude3DLength: true: include 3D info, false: exclude 3D info /// @return Output file path;output file will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportPOM(_bInclude3DLength : bool, _filePath : str) -> str """ @ingroup EXPORT_API @brief Export POM @param _bInclude3DLength: true: include 3D info, false: exclude 3D info @param _filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportPOM(bool _bInclude3DLength, const string& _filePath) /// @ingroup EXPORT_API /// @brief Export POM /// @param _bInclude3DLength: true: include 3D info, false: exclude 3D info /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportPOMW(_bInclude3DLength : bool, _filePath : str) -> str """ @ingroup EXPORT_API @brief Export POM @param _bInclude3DLength: true: include 3D info, false: exclude 3D info @param _filePath: output file path @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportPOMW(bool _bInclude3DLength, const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export POM /// @param _bInclude3DLength: true: include 3D info, false: exclude 3D info /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportBOM(_filePath : str) -> bool """ @ingroup EXPORT_API @brief Export BOM @param _filePath: output file path @return If an error occurs, return false. """ .. code-tab:: c++ ExportBOM(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export BOM /// @param _filePath: output file path /// @return If an error occurs, return false. .. tabs:: .. code-tab:: python def ExportBOMW(_filePath : str) -> bool """ @ingroup EXPORT_API @brief Export BOM @param _filePath: output file path @return If an error occurs, return false. """ .. code-tab:: c++ ExportBOM(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export BOM /// @param _filePath: output file path /// @return If an error occurs, return false. .. tabs:: .. code-tab:: python def ExportGLTFWithDialog(_filePath : str, _bGLBinary : bool) -> list[str] """ @ingroup EXPORT_API @brief Export GLTF with Dialog @param _filePath: output file path @return Output file paths. """ .. code-tab:: c++ ExportGLTFWithDialog(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export GLTF with Dialog /// @param _filePath: output file path /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportGLBWithDialog(_filePath : str) -> list[str] """ @ingroup EXPORT_API @brief Export GLB with Dialog @param _filePath: output file path @return Output file paths. """ .. code-tab:: c++ ExportGLBWithDialog(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export GLB with Dialog /// @param _filePath: output file path /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportThumbnail3DByColorwayIndex(_colorwayIndex : int) -> str """ @ingroup EXPORT_API @brief Export thumbnail of the current scene @param _colorwayIndex: colorway index to render the image @return Output file path: output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportThumbnail3DByColorwayIndex(unsigned int _colorwayIndex) /// @ingroup EXPORT_API /// @brief Export thumbnail of the current scene /// @param _colorwayIndex: colorway index to render the image /// @return Output file path: output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportThumbnail3DByColorwayIndex(_filePath : str, _colorwayIndex : int) -> str """ @ingroup EXPORT_API @brief Export thumbnail of the current scene in the 3D Windows @param _filePath: output file path to save the screenshot @param _colorwayIndex: colorway index to render the image @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportThumbnail3DByColorwayIndex(const string& _filePath, unsigned int _colorwayIndex) /// @ingroup EXPORT_API /// @brief Export thumbnail of the current scene in the 3D Windows /// @param _filePath: output file path to save the screenshot /// @param _colorwayIndex: colorway index to render the image /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportThumbnail3DWByColorwayIndexW(_filePath : str, _colorwayIndex : int) -> str """ @ingroup EXPORT_API @brief Export thumbnail of the current scene in the 3D Windows @param _filePath: output file path to save the screenshot @param _colorwayIndex: colorway index to render the image @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportThumbnail3DByColorwayIndexW(const wstring& _filePath, unsigned int _colorwayIndex) /// @ingroup EXPORT_API /// @brief Export thumbnail of the current scene in the 3D Windows /// @param _filePath: output file path to save the screenshot /// @param _colorwayIndex: colorway index to render the image /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportTurntableImagesByColorwayIndex(_numberOfImages : int, _colorwayIndex : int) -> list[str] """ @ingroup EXPORT_API @brief Export turntable images for colorway. @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. @param _colorwayIndex: colorway index to render the image @return Output file path list; output files will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableImagesByColorwayIndex(int _numberOfImages, unsigned int _colorwayIndex) /// @ingroup EXPORT_API /// @brief Export turntable images for colorway. /// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. /// @param _colorwayIndex: colorway index to render the image /// @return Output file path list; output files will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTurntableImagesByColorwayIndex(_filePath : str, _numberOfImages : int, _colorwayIndex : int, _width : int, _height : int) -> list[str] """ @ingroup EXPORT_API @brief Export turntable images for colorway. @param _filePath: the output file path to export the turntable snapshots @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. @param _colorwayIndex: colorway index to render the image @param _width: image width for the snapshots @param _height: image height for the snapshots @return Output file path list. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableImagesByColorwayIndex(const string& _filePath, int _numberOfImages, unsigned int _colorwayIndex, int _width = 2500, int _height = 2500) /// @ingroup EXPORT_API /// @brief Export turntable images for colorway. /// @param _filePath: the output file path to export the turntable snapshots /// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. /// @param _colorwayIndex: colorway index to render the image /// @param _width: image width for the snapshots /// @param _height: image height for the snapshots /// @return Output file path list. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTurntableImagesByColorwayIndexW(_filePath : str, _numberOfImages : int, _colorwayIndex : int, _width : int, _height : int) -> list[str] """ @ingroup EXPORT_API @brief Export turntable images for colorway. @param _filePath: the output file path to export the turntable snapshots @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. @param _colorwayIndex: colorway index to render the image @param _width: image width for the snapshots @param _height: image height for the snapshots @return Output file path list. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTurntableImagesByColorwayIndexW(const wstring& _filePath, int _numberOfImages, unsigned int _colorwayIndex, int _width = 2500, int _height = 2500) /// @ingroup EXPORT_API /// @brief Export turntable images for colorway. /// @param _filePath: the output file path to export the turntable snapshots /// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each. /// @param _colorwayIndex: colorway index to render the image /// @param _width: image width for the snapshots /// @param _height: image height for the snapshots /// @return Output file path list. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportPose() -> str """ @ingroup EXPORT_API @brief Export Pose file in the CLO temporary folder @return Output file path. If an error occurs, return empty string. Output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportPose() /// @ingroup EXPORT_API /// @brief Export Pose file in the CLO temporary folder /// @return Output file path. If an error occurs, return empty string. Output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportPose(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export Pose file @param string _filePath : target file path in ASCII @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportPose(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export Pose file /// @param string _filePath : target file path in ASCII /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportPoseW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export Pose file @param wstring _filePath : target file path in UNICODE @return Output file path. If an error occurs, return empty wstring. """ .. code-tab:: c++ ExportPoseW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export Pose file /// @param wstring _filePath : target file path in UNICODE /// @return Output file path. If an error occurs, return empty wstring. .. tabs:: .. code-tab:: python def ExportFBX(_options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export FBX file @param _options: It exports FBX according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. Output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportFBX(const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export FBX file /// @param _options: It exports FBX according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. Output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportFBX(_filePath : str, _options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export FBX file @param _filePath: target file path in ASCII @param _options: It exports FBX according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. """ .. code-tab:: c++ ExportFBX(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export FBX file /// @param _filePath: target file path in ASCII /// @param _options: It exports FBX according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportFBXW(_filePath : str, _options : ImportExportOption) -> list[str] """ @ingroup EXPORT_API @brief Export FBX file @param _filePath: target file path in UNICODE @param _options: It exports FBX according to options, not allowing user for selecting options in Export Dialog. @return Output file paths. """ .. code-tab:: c++ ExportFBXW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup EXPORT_API /// @brief Export FBX file /// @param _filePath: target file path in UNICODE /// @param _options: It exports FBX according to options, not allowing user for selecting options in Export Dialog. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportAVT(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export AVT @param _filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportAVT(const string& _filePath) /// @ingroup EXPORT_API /// @brief Export AVT /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportAVTW(_filePath : str) -> str """ @ingroup EXPORT_API @brief Export AVT @param _filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportAVTW(const wstring& _filePath) /// @ingroup EXPORT_API /// @brief Export AVT /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportTrim(_filePath : str, _trimStyleIndex : int) -> str """ @ingroup EXPORT_API @brief Export trim file @param _filePath: the output file path to export trim @param _trimStyleIndex: trimstyle index to export trim style @return Output file path list. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTrim(const std::string& _filePath, unsigned int _trimStyleIndex) /// @ingroup EXPORT_API /// @brief Export trim file /// @param _filePath: the output file path to export trim /// @param _trimStyleIndex: trimstyle index to export trim style /// @return Output file path list. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportStdViewImage(_viewIndex : int, _outputFolderPath : str, _colorwayIndex : int, _width : int, _height : int) -> str """ @ingroup EXPORT_API @brief ExportStdViewImage : Exports The Image based on the given Standard image view index for selected colorway. @param : @return Output file path along with the selected colorway name. If an error occurs, return error message string. """ .. code-tab:: c++ ExportStdViewImage(int _viewIndex, const std::string& _outputFolderPath, int _colorwayIndex, int _width, int _height) /// @ingroup EXPORT_API /// @brief ExportStdViewImage : Exports The Image based on the given Standard image view index for selected colorway. /// @param : /// @return Output file path along with the selected colorway name. If an error occurs, return error message string. .. tabs:: .. code-tab:: python def ExportStdViewImageForAllColorways(_viewIndex : int, _outputFolderPath : str, _width : int, _height : int) -> str """ @ingroup EXPORT_API @brief ExportStdViewImageForAllColorways : Exports The Image based on the given Standard image view index for all Colorways. @param : @return Output file paths along with the colorway names. If an error occurs, return error message string. """ .. code-tab:: c++ ExportStdViewImageForAllColorways(int _viewIndex, const std::string& _outputFolderPath, int _width, int _height) /// @ingroup EXPORT_API /// @brief ExportStdViewImageForAllColorways : Exports The Image based on the given Standard image view index for all Colorways. /// @param : /// @return Output file paths along with the colorway names. If an error occurs, return error message string. .. tabs:: .. code-tab:: python def ExportCustomViewImage(_zcmrFileUrl : str, _outputFolderPath : str, _colorwayIndex : int, _width : int, _height : int) -> str """ @ingroup EXPORT_API @brief ExportCustomViewImage : Exports The Custom image based on the given custom angles in ZCMR file for selected Colorway. @param : @return Output file path along with the selected colorway name. If an error occurs, return error message string. """ .. code-tab:: c++ ExportCustomViewImage((const std::string& _zcmrFileUrl, const std::string& _outputFolderPath, int _colorwayIndex, int _width, int _height) /// @ingroup EXPORT_API /// @brief ExportCustomViewImage : Exports The Custom image based on the given custom angles in ZCMR file for selected Colorway. /// @param : /// @return Output file path along with the selected colorway name. If an error occurs, return error message string. .. tabs:: .. code-tab:: python def ExportCustomViewImageForAllColorways(_zcmrFileUrl : str, _outputFolderPath : str, _width : int, _height : int) -> str """ @ingroup EXPORT_API @brief ExportCustomViewImageForAllColorways : Exports The Custom image based on the given custom angles in ZCMR file for all Colorways. @param : @return Output file path along with the colorway names. If an error occurs, return error message string. """ .. code-tab:: c++ ExportCustomViewImageForAllColorways((const std::string& _zcmrFileUrl, const std::string& _outputFolderPath, int _width, int _height) /// @ingroup EXPORT_API /// @brief ExportCustomViewImageForAllColorways : Exports The Custom image based on the given custom angles in ZCMR file for all Colorways. /// @param : /// @return Output file path along with the colorway names. If an error occurs, return error message string. .. tabs:: .. code-tab:: python def ExportMultiViewImages(_mvsFilePath : str, _outputFilePath : str, _colorwayIndex : int, _width : int, _height : int) -> str """ @ingroup EXPORT_API @brief ExportMultiViewImages : Exports The Multi View Images based on the given MVS File for selected Colorway. @param : @return Output file path along with the selected colorway name. If an error occurs, return error message string. """ .. code-tab:: c++ ExportMultiViewImages(const std::string& _mvsFilePath, const std::string& _outputFilePath, int _colorwayIndex, int _width, int _height) /// @ingroup EXPORT_API /// @brief ExportMultiViewImages : Exports The Multi View Images based on the given MVS File for selected Colorway. /// @param : /// @return Output file path along with the selected colorway name. If an error occurs, return error message string. .. tabs:: .. code-tab:: python def ExportMultiViewImagesForAllColorways(_mvsFilePath : str, _outputFilePath : str, _width : int, _height : int) -> str """ @ingroup EXPORT_API @brief ExportMultiViewImagesForAllColorways : Exports The Multi View Images based on the given MVS File for all Colorways. @param : @return Output file path along with the colorway names. If an error occurs, return error message string. """ .. code-tab:: c++ ExportMultiViewImagesForAllColorways(const std::string& _mvsFilePath, const std::string& _outputFilePath, int _width, int _height) /// @ingroup EXPORT_API /// @brief ExportMultiViewImagesForAllColorways : Exports The Multi View Images based on the given MVS File for all Colorways. /// @param : /// @return Output file path along with the colorway names. If an error occurs, return error message string. .. tabs:: .. code-tab:: python def ConvertZblcToZmod(_zblcFilePathList : list[str], _saveDirPath : str, _categoryName : str, _styleName : str, _lineName : str) -> list[str] """ @ingroup EXPORT_API @brief Convert .zblc file to .zmod file @param _zblcFilePathList: The path of the ZBLC files you want to convert @param _saveDirPath: Where to save the converted file @param _categoryName : Category name @param _styleName : Style name @param _lineName : Line Name (This is not mandatory data. By default, an empty string is set.) @return Returns the path list of failed files. Returns an empty list if all files are successful. """ .. code-tab:: c++ ConvertZblcToZmod(const std::vector& _zblcFilePathList, const std::wstring& _saveDirPath, const std::wstring& _categoryName, const std::wstring& _styleName, const std::wstring& _lineName = L"") /// @ingroup EXPORT_API /// @brief Convert .zblc file to .zmod file /// @param _zblcFilePathList: The path of the ZBLC files you want to convert /// @param _saveDirPath: Where to save the converted file /// @param _categoryName : Category name /// @param _styleName : Style name /// @param _lineName : Line Name (This is not mandatory data. By default, an empty string is set.) /// @return Returns the path list of failed files. Returns an empty list if all files are successful. .. tabs:: .. code-tab:: python def ExportMVSData(_mvsFilePath : str) -> str """ @ingroup EXPORT_API @brief ExportMVSData : Exports The MVS File data without creating any Images. @param : @return MVS file data and with custom angles. If an error occurs, return error message string. """ .. code-tab:: c++ ExportMVSData(const std::string& _mvsFilePath) /// @ingroup EXPORT_API /// @brief ExportMVSData : Exports The MVS File data without creating any Images. /// @param : /// @return MVS file data and with custom angles. If an error occurs, return error message string. .. tabs:: .. code-tab:: python def ExportUSD(_options : ImportExportOption, _usdOptions : ExportUSDOption) -> list[str] """ @ingroup EXPORT_API @brief Export USD file @param _options: It exports USD according to options, not allowing user for selecting options in Export Dialog. @param _usdOptions: USD-specific export options. @return Output file paths. Output files will be created in CLO temporary folder. """ .. code-tab:: c++ ExportUSD(const Marvelous::ImportExportOption& _options, const Marvelous::ExportUSDOption& _usdOptions) /// @ingroup EXPORT_API /// @brief Export USD file /// @param _options: It exports USD according to options, not allowing user for selecting options in Export Dialog. /// @param _usdOptions: USD-specific export options. /// @return Output file paths. Output files will be created in CLO temporary folder. .. tabs:: .. code-tab:: python def ExportUSD(_filePath : str, _options : ImportExportOption, _usdOptions : ExportUSDOption) -> list[str] """ @ingroup EXPORT_API @brief Export USD file @param _filePath: target file path in ASCII @param _options: It exports USD according to options, not allowing user for selecting options in Export Dialog. @param _usdOptions: USD-specific export options. @return Output file paths. """ .. code-tab:: c++ ExportUSD(const string& _filePath, const Marvelous::ImportExportOption& _options, const Marvelous::ExportUSDOption& _usdOptions) /// @ingroup EXPORT_API /// @brief Export USD file /// @param _filePath: target file path in ASCII /// @param _options: It exports USD according to options, not allowing user for selecting options in Export Dialog. /// @param _usdOptions: USD-specific export options. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportUSDW(_filePath : str, _options : ImportExportOption, _usdOptions : ExportUSDOption) -> list[str] """ @ingroup EXPORT_API @brief Export USD file @param _filePath: target file path in UNICODE @param _options: It exports USD according to options, not allowing user for selecting options in Export Dialog. @param _usdOptions: USD-specific export options. @return Output file paths. """ .. code-tab:: c++ ExportUSDW(const wstring& _filePath, const Marvelous::ImportExportOption& _options, const Marvelous::ExportUSDOption& _usdOptions) /// @ingroup EXPORT_API /// @brief Export USD file /// @param _filePath: target file path in UNICODE /// @param _options: It exports USD according to options, not allowing user for selecting options in Export Dialog. /// @param _usdOptions: USD-specific export options. /// @return Output file paths. .. tabs:: .. code-tab:: python def ExportZCMR(_folderPath : str) -> list[str] """ @ingroup EXPORT_API @brief Export ZCMR files @param _folderPath: folder path to store the output files @return Output file path list. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZCMR(const std::string& _folderPath) /// @ingroup EXPORT_API /// @brief Export ZCMR files /// @param _folderPath: folder path to store the output files /// @return Output file path list. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def GenerateZcmrFrom3DWindow(_filePath : str, _addToList : bool) -> list[str] """ @ingroup EXPORT_API @brief Load and export custom view from 3D window @param _filePath: file path to export the custom view from 3D window @param _addToList: true to add the custom view to the existing Custom View list, false to not add @return Output file path list. If an error occurs, return empty string. """ .. code-tab:: c++ GenerateZcmrFrom3DWindow(const std::string& _filePath, bool _addToList) /// @ingroup EXPORT_API /// @brief Load and export custom view from 3D window /// @param _filePath: file path to export the custom view from 3D window /// @param _addToList: true to add the custom view to the existing Custom View list, false to not add /// @return Output file path list. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportSnapshot2D(_filePath : str, SnapShotMode : int) -> list[str] """ @ingroup EXPORT_API @brief Captures and exports a snapshot of the 2D Window. @param _filePath: The file path where the snapshot image will be saved (including file name and extension). @param SnapShotMode: Specifies the capture mode (0: Captures the 2D Window in Simulation Mode, 1: Captures the 2D Window in Print Layout Mode). @return A list of the exported image file paths. Returns an empty vector if an error occurs. """ .. code-tab:: c++ ExportSnapshot2D(const std::string& _filePath, int SnapShotMode) /// @ingroup EXPORT_API /// @brief Captures and exports a snapshot of the 2D Window. /// @param _filePath: The file path where the snapshot image will be saved (including file name and extension). /// @param SnapShotMode: Specifies the capture mode (0: Captures the 2D Window in Simulation Mode, 1: Captures the 2D Window in Print Layout Mode). /// @return A list of the exported image file paths. Returns an empty vector if an error occurs. .. tabs:: .. code-tab:: python def ExportTopStitchStyle(_filePath : str, _topStitchIndex : int) -> str """ @ingroup EXPORT_API @brief Export topstitch style file @param _filePath: the output file path to export topstitch style @param _topStitchIndex: topstitch style index to export topstitch style @return Output file path list. If an error occurs, return empty string. """ .. code-tab:: c++ ExportTopStitchStyle(const std::string& _filePath, unsigned int _topStitchIndex) /// @ingroup EXPORT_API /// @brief Export topstitch style file /// @param _filePath: the output file path to export topstitch style /// @param _topStitchIndex: topstitch style index to export topstitch style /// @return Output file path list. If an error occurs, return empty string. FABRIC_API ********** .. tabs:: .. code-tab:: python def GetFabricCount(_bCurrentColorway : bool) -> int """ @ingroup FABRIC_API @brief Get the number of fabrics @param _bCurrentColorway: If this value is true, counting only Fabrics that are used in current Colorway (Default: true) @return the number of fabric in object browser for the current project. """ .. code-tab:: c++ GetFabricCount(bool _bCurrentColorway = true) /// @ingroup FABRIC_API /// @brief Get the number of fabrics /// @param _bCurrentColorway: If this value is true, counting only Fabrics that are used in current Colorway (Default: true) /// @return the number of fabric in object browser for the current project. .. tabs:: .. code-tab:: python def GetFabricCount(_colorwayIndex : int) -> int """ @ingroup FABRIC_API @brief Get the number of fabrics @param _colorwayIndex: _colorwayIndex = -2 : It counts all Fabrics for all the Colorways _colorwayIndex = -1 : It counts the Fabrics of the current Colorway selected _colorwayIndex >= 0 : It counts the Fabrics of the _colorwayIndex index given by parameter @return the number of fabric in object browser for the current project. """ .. code-tab:: c++ GetFabricCount(int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Get the number of fabrics /// @param _colorwayIndex: /// _colorwayIndex = -2 : It counts all Fabrics for all the Colorways /// _colorwayIndex = -1 : It counts the Fabrics of the current Colorway selected /// _colorwayIndex >= 0 : It counts the Fabrics of the _colorwayIndex index given by parameter /// @return the number of fabric in object browser for the current project. .. tabs:: .. code-tab:: python def GetCurrentFabricIndex() -> int """ @ingroup FABRIC_API @brief Get the index of the selected Fabric @return the index of selected fabric in object browser for the current project.. """ .. code-tab:: c++ GetCurrentFabricIndex() /// @ingroup FABRIC_API /// @brief Get the index of the selected Fabric /// @return the index of selected fabric in object browser for the current project.. .. tabs:: .. code-tab:: python def ExportZFab() -> str """ @ingroup FABRIC_API @brief Export ZFab which cotains the fabric data selected in the object browser @return Output file path;output files will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZFab() /// @ingroup FABRIC_API /// @brief Export ZFab which cotains the fabric data selected in the object browser /// @return Output file path;output files will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportZFab(filePath : str) -> str """ @ingroup FABRIC_API @brief Export Zfab which cotains the fabric data selected in the object browser @param filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZFab(const string& filePath) /// @ingroup FABRIC_API /// @brief Export Zfab which cotains the fabric data selected in the object browser /// @param filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportZFab(filePath : str, index : int) -> str """ @ingroup FABRIC_API @brief Export ZFab which cotains the fabric data in the index of the object browser @param filePath: output file path @param index: target fabric index on the object browser to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZFab(const string& filePath, const int& index) /// @ingroup FABRIC_API /// @brief Export ZFab which cotains the fabric data in the index of the object browser /// @param filePath: output file path /// @param index: target fabric index on the object browser to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportZFab(_filePath : str, _colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Export ZFab which cotains the fabric data in the index of the object browser @param _filePath: output file path @param _colorwayIndex: target Colorway index @param _fabricIndex: target Fabric index on the Colorway Editor to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZFab(const string& _filePath, const int& _colorwayIndex, const int& _fabricIndex) /// @ingroup FABRIC_API /// @brief Export ZFab which cotains the fabric data in the index of the object browser /// @param _filePath: output file path /// @param _colorwayIndex: target Colorway index /// @param _fabricIndex: target Fabric index on the Colorway Editor to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportZFabW(filePath : str, index : int) -> str """ @ingroup FABRIC_API @brief Export ZFab file which cotains the fabric data in the index of the object browser @param filePath: output file path @param index: target fabric index on the object browser to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZFabW(const wstring& filePath, const int& index) /// @ingroup FABRIC_API /// @brief Export ZFab file which cotains the fabric data in the index of the object browser /// @param filePath: output file path /// @param index: target fabric index on the object browser to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportZFabW(_filePath : str, _colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Export ZFab file which cotains the fabric data in the index of the object browser @param _filePath: output file path @param _colorwayIndex: target Colorway index @param _fabricIndex: target Fabric index on the Colorway Editor to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportZFabW(const wstring& _filePath, const int& _colorwayIndex, const int& _fabricIndex) /// @ingroup FABRIC_API /// @brief Export ZFab file which cotains the fabric data in the index of the object browser /// @param _filePath: output file path /// @param _colorwayIndex: target Colorway index /// @param _fabricIndex: target Fabric index on the Colorway Editor to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportFabric(filePath : str) -> str """ @ingroup FABRIC_API @brief Export the selected fabric to the file(.jfab or .zfab) @param filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportFabric(const string& filePath) /// @ingroup FABRIC_API /// @brief Export the selected fabric to the file(.jfab or .zfab) /// @param filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportFabric(filePath : str, index : int) -> str """ @ingroup FABRIC_API @brief Export the selected fabric to the file(.jfab or .zfab) @param filePath: output file path @param index: target fabric index on the object browser to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportFabric(const string& filePath, const int& index) /// @ingroup FABRIC_API /// @brief Export the selected fabric to the file(.jfab or .zfab) /// @param filePath: output file path /// @param index: target fabric index on the object browser to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportFabric(_filePath : str, _colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Export the selected fabric to the file(.jfab or .zfab) @param _filePath: output file path @param _colorwayIndex: target Colorway index @param _fabricIndex: target Fabric index on the Colorway Editor to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportFabric(const string& _filePath, const int& _colorwayIndex, const int& _fabricIndex) /// @ingroup FABRIC_API /// @brief Export the selected fabric to the file(.jfab or .zfab) /// @param _filePath: output file path /// @param _colorwayIndex: target Colorway index /// @param _fabricIndex: target Fabric index on the Colorway Editor to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportFabricW(filePath : str, index : int) -> str """ @ingroup FABRIC_API @brief Export the selected fabric to the file(.jfab or .zfab) @param filePath: output file path @param index: target fabric index on the object browser to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportFabricW(const wstring& filePath, const int& index) /// @ingroup FABRIC_API /// @brief Export the selected fabric to the file(.jfab or .zfab) /// @param filePath: output file path /// @param index: target fabric index on the object browser to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportFabricW(_filePath : str, _colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Export the selected fabric to the file(.jfab or .zfab) @param _filePath: output file path @param _colorwayIndex: target Colorway index @param _fabricIndex: target Fabric index on the Colorway Editor to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportFabricW(const wstring& _filePath, const int& _colorwayIndex, const int& _fabricIndex) /// @ingroup FABRIC_API /// @brief Export the selected fabric to the file(.jfab or .zfab) /// @param _filePath: output file path /// @param _colorwayIndex: target Colorway index /// @param _fabricIndex: target Fabric index on the Colorway Editor to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def AddFabric(inputFilePath : str) -> int """ @ingroup FABRIC_API @brief Add Fabric into the Object Browser @param inputFilePath: 'zfab'(CLO file) path or 'jfab'(json) path @return the index of added fabric in object browser for the current project. . """ .. code-tab:: c++ AddFabric(const string& inputFilePath) /// @ingroup FABRIC_API /// @brief Add Fabric into the Object Browser /// @param inputFilePath: 'zfab'(CLO file) path or 'jfab'(json) path /// @return the index of added fabric in object browser for the current project. . .. tabs:: .. code-tab:: python def ReplaceFabric(_fabricIndex : int, _inputFilePath : str) -> bool """ @ingroup FABRIC_API @brief Replaces Fabric with provided index in the Object Browser @param fabricIndex: fabric index from the object browser @param inputFilePath: 'zfab'(CLO file) path. @return if it succeeds, return true. """ .. code-tab:: c++ ReplaceFabric(const int& _fabricIndex, const std::string& _inputFilePath) /// @ingroup FABRIC_API /// @brief Replaces Fabric with provided index in the Object Browser /// @param fabricIndex: fabric index from the object browser /// @param inputFilePath: 'zfab'(CLO file) path. /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def AddFabricW(inputFilePath : str) -> int """ @ingroup FABRIC_API @brief Add Fabric into the Object Browser @param inputFilePath: 'zfab'(CLO file) path or 'jfab'(json) path @return the index of added fabric in object browser for the current project. . """ .. code-tab:: c++ AddFabricW(const wstring& inputFilePath) /// @ingroup FABRIC_API /// @brief Add Fabric into the Object Browser /// @param inputFilePath: 'zfab'(CLO file) path or 'jfab'(json) path /// @return the index of added fabric in object browser for the current project. . .. tabs:: .. code-tab:: python def GetFirstFabricTextureName() -> str """ @ingroup FABRIC_API @brief Get the main image file name for the first fabric in the object browser @return the name of the image file name without folder path and extension. """ .. code-tab:: c++ GetFirstFabricTextureName() /// @ingroup FABRIC_API /// @brief Get the main image file name for the first fabric in the object browser /// @return the name of the image file name without folder path and extension. .. tabs:: .. code-tab:: python def GetFirstFabricTextureNameW() -> str """ @ingroup FABRIC_API @brief Get the main image file name for the first fabric in the object browser @return the name of the image file name without folder path and extension. """ .. code-tab:: c++ GetFirstFabricTextureNameW() /// @ingroup FABRIC_API /// @brief Get the main image file name for the first fabric in the object browser /// @return the name of the image file name without folder path and extension. .. tabs:: .. code-tab:: python def GetFirstFabricTextureName(_colorwayIndex : int) -> str """ @ingroup FABRIC_API @brief Get the main image file name for the first fabric in the object browser for a colorway index @param _colorwayIndex: colorway index @return the name of the image file name without folder path and extension. """ .. code-tab:: c++ GetFirstFabricTextureName(unsigned int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Get the main image file name for the first fabric in the object browser for a colorway index /// @param _colorwayIndex: colorway index /// @return the name of the image file name without folder path and extension. .. tabs:: .. code-tab:: python def GetFirstFabricTextureNameW(_colorwayIndex : int) -> str """ @ingroup FABRIC_API @brief Get the main image file name for the first fabric in the object browser for a colorway index @param _colorwayIndex: colorway index @return the name of the image file name without folder path and extension. """ .. code-tab:: c++ GetFirstFabricTextureNameW(unsigned int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Get the main image file name for the first fabric in the object browser for a colorway index /// @param _colorwayIndex: colorway index /// @return the name of the image file name without folder path and extension. .. tabs:: .. code-tab:: python def ChangeFabricWithJson(fabricIndex : int, inputJsonFilePath : str) -> bool """ @ingroup FABRIC_API @brief Overwrite all the properties of a fabric with json file(.jfab) @param fabricIndex: target fabric index in the object browser @param inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex @return if it succeeds, return true. """ .. code-tab:: c++ ChangeFabricWithJson(unsigned int fabricIndex, const string& inputJsonFilePath) /// @ingroup FABRIC_API /// @brief Overwrite all the properties of a fabric with json file(.jfab) /// @param fabricIndex: target fabric index in the object browser /// @param inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ChangeFabricWithJsonW(fabricIndex : int, inputJsonFilePath : str) -> bool """ @ingroup FABRIC_API @brief Overwrite all the properties of a fabric with json file(.jfab) @param fabricIndex: target fabric index in the object browser @param inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex @return if it succeeds, return true. """ .. code-tab:: c++ ChangeFabricWithJsonW(unsigned int fabricIndex, const wstring& inputJsonFilePath) /// @ingroup FABRIC_API /// @brief Overwrite all the properties of a fabric with json file(.jfab) /// @param fabricIndex: target fabric index in the object browser /// @param inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ChangeFabricWithJson(_colorwayIndex : int, _fabricIndex : int, _inputJsonFilePath : str) -> bool """ @ingroup FABRIC_API @brief Overwrite all the properties of a fabric with json file(.jfab) @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: target fabric index in the Colorway Editor @param _inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex @return if it succeeds, return true. """ .. code-tab:: c++ ChangeFabricWithJson(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::string& _inputJsonFilePath) /// @ingroup FABRIC_API /// @brief Overwrite all the properties of a fabric with json file(.jfab) /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: target fabric index in the Colorway Editor /// @param _inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ChangeFabricWithJsonW(_colorwayIndex : int, _fabricIndex : int, _inputJsonFilePath : str) -> bool """ @ingroup FABRIC_API @brief Overwrite all the properties of a fabric with json file(.jfab) @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: target fabric index in the Colorway Editor @param _inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex @return if it succeeds, return true. """ .. code-tab:: c++ ChangeFabricWithJsonW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::wstring& _inputJsonFilePath) /// @ingroup FABRIC_API /// @brief Overwrite all the properties of a fabric with json file(.jfab) /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: target fabric index in the Colorway Editor /// @param _inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def AssignFabricToPattern(_fabricIndex : int, _patternIndex : int, _assignOption : int) -> bool """ @ingroup FABRIC_API @brief Assign a fabric to a pattern. @param _fabricIndex: the source fabric index in the object browser to apply to the target pattern @param _patternIndex: the tagert pattern index to apply the fabric in the fabricIndex @param _assignOption: _assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items. _assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors. _assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously @return if it succeeds, return true. """ .. code-tab:: c++ AssignFabricToPattern(unsigned int _fabricIndex, unsigned int _patternIndex) /// @ingroup FABRIC_API /// @brief Assign a fabric to a pattern. /// @param _fabricIndex: the source fabric index in the object browser to apply to the target pattern /// @param _patternIndex: the tagert pattern index to apply the fabric in the fabricIndex /// @param _assignOption: /// _assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items. /// _assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors. /// _assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def AssignFabricToPattern(_colorwayIndex : int, _fabricIndex : int, _patternIndex : int, _assignOption : int) -> bool """ @ingroup FABRIC_API @brief Assign a fabric to a pattern. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the source fabric index in the Colorway Editor to apply to the target pattern @param _patternIndex: the tagert pattern index to apply the fabric in the fabricIndex @param _assignOption: _assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items. _assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors. _assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously @return if it succeeds, return true. """ .. code-tab:: c++ AssignFabricToPattern(unsigned int _colorwayIndex, unsigned int _fabricIndex, unsigned int _patternIndex) /// @ingroup FABRIC_API /// @brief Assign a fabric to a pattern. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the source fabric index in the Colorway Editor to apply to the target pattern /// @param _patternIndex: the tagert pattern index to apply the fabric in the fabricIndex /// @param _assignOption: /// _assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items. /// _assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors. /// _assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportXtexFile(fabricIndex : int, xTexFilePath : str) -> bool """ @ingroup FABRIC_API @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric @param fabricIndex: the target fabric index in the object browser to import xTex file onto @param xTexFilePath: the xTex file path to import @return if it succeeds, return true. """ .. code-tab:: c++ ImportXtexFile(unsigned int fabricIndex, const string& xTexFilePath) /// @ingroup FABRIC_API /// @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric /// @param fabricIndex: the target fabric index in the object browser to import xTex file onto /// @param xTexFilePath: the xTex file path to import /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportXtexFileW(fabricIndex : int, xTexFilePath : str) -> bool """ @ingroup FABRIC_API @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric @param fabricIndex: the target fabric index in the object browser to import xTex file onto @param xTexFilePath: the xTex file path to import @return if it succeeds, return true. """ .. code-tab:: c++ ImportXtexFileW(unsigned int fabricIndex, const wstring& xTexFilePath) /// @ingroup FABRIC_API /// @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric /// @param fabricIndex: the target fabric index in the object browser to import xTex file onto /// @param xTexFilePath: the xTex file path to import /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportXtexFile(_colorwayIndex : int, _fabricIndex : int, _xTexFilePath : str) -> bool """ @ingroup FABRIC_API @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor to import xTex file onto @param _xTexFilePath: the xTex file path to import @return if it succeeds, return true. """ .. code-tab:: c++ ImportXtexFile(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::string& _xTexFilePath) /// @ingroup FABRIC_API /// @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor to import xTex file onto /// @param _xTexFilePath: the xTex file path to import /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportXtexFileW(_colorwayIndex : int, _fabricIndex : int, _xTexFilePath : str) -> bool """ @ingroup FABRIC_API @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor to import xTex file onto @param _xTexFilePath: the xTex file path to import @return if it succeeds, return true. """ .. code-tab:: c++ ImportXtexFileW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::wstring& _xTexFilePath) /// @ingroup FABRIC_API /// @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor to import xTex file onto /// @param _xTexFilePath: the xTex file path to import /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ApplyXtexFile(fabricIndex : int, xTexFilePath : str) -> bool """ @ingroup FABRIC_API @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric. @param fabricIndex: the target fabric index in the object browser to apply xTex file onto @param xTexFilePath: the xTex file path to apply @return if it succeeds, return true. """ .. code-tab:: c++ ApplyXtexFile(unsigned int fabricIndex, const string& xTexFilePath) /// @ingroup FABRIC_API /// @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric. /// @param fabricIndex: the target fabric index in the object browser to apply xTex file onto /// @param xTexFilePath: the xTex file path to apply /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ApplyXtexFileW(fabricIndex : int, xTexFilePath : str) -> bool """ @ingroup FABRIC_API @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric. @param fabricIndex: the target fabric index in the object browser to apply xTex file onto @param xTexFilePath: the xTex file path to apply @return if it succeeds, return true. """ .. code-tab:: c++ ApplyXtexFileW(unsigned int fabricIndex, const wstring& xTexFilePath) /// @ingroup FABRIC_API /// @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric. /// @param fabricIndex: the target fabric index in the object browser to apply xTex file onto /// @param xTexFilePath: the xTex file path to apply /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ApplyXtexFile(_colorwayIndex : int, _fabricIndex : int, _xTexFilePath : str) -> bool """ @ingroup FABRIC_API @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor to apply xTex file onto @param _xTexFilePath: the xTex file path to apply @return if it succeeds, return true. """ .. code-tab:: c++ ApplyXtexFile(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& _xTexFilePath) /// @ingroup FABRIC_API /// @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor to apply xTex file onto /// @param _xTexFilePath: the xTex file path to apply /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ApplyXtexFileW(_colorwayIndex : int, _fabricIndex : int, _xTexFilePath : str) -> bool """ @ingroup FABRIC_API @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor to apply xTex file onto @param _xTexFilePath: the xTex file path to apply @return if it succeeds, return true. """ .. code-tab:: c++ ApplyXtexFileW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& _xTexFilePath) /// @ingroup FABRIC_API /// @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor to apply xTex file onto /// @param _xTexFilePath: the xTex file path to apply /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def DeleteFabric(fabricIndex : int) -> bool """ @ingroup FABRIC_API @brief Delete a fabric. If the fabric was assigned on Patterns, the patterns will have the default fabric @param fabricIndex: the target fabric index in the object browser to delete @return if it succeeds, return true. """ .. code-tab:: c++ DeleteFabric(unsigned int fabricIndex) /// @ingroup FABRIC_API /// @brief Delete a fabric. If the fabric was assigned on Patterns, the patterns will have the default fabric /// @param fabricIndex: the target fabric index in the object browser to delete /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def DeleteFabric(_colorwayIndex : int, _fabricIndex : int) -> bool """ @ingroup FABRIC_API @brief Delete a fabric. If the fabric was assigned on Patterns, the patterns will have the default fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor to delete @return if it succeeds, return true. """ .. code-tab:: c++ DeleteFabric(unsigned int _colorwayIndex, unsigned int _fabricIndex) /// @ingroup FABRIC_API /// @brief Delete a fabric. If the fabric was assigned on Patterns, the patterns will have the default fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor to delete /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def GetAPIMetaData(fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get API meta data for the fabric @param fabricIndex: target fabric index on the Object Browser @return json string for meta data [key - value] list """ .. code-tab:: c++ GetAPIMetaData(unsigned int fabricIndex) /// @ingroup FABRIC_API /// @brief Get API meta data for the fabric /// @param fabricIndex: target fabric index on the Object Browser /// @return json string for meta data [key - value] list .. tabs:: .. code-tab:: python def GetAPIMetaDataW(fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get API meta data for the fabric @param fabricIndex: target fabric index on the Object Browser @return json string for meta data [key - value] list """ .. code-tab:: c++ GetAPIMetaDataW(unsigned int fabricIndex) /// @ingroup FABRIC_API /// @brief Get API meta data for the fabric /// @param fabricIndex: target fabric index on the Object Browser /// @return json string for meta data [key - value] list .. tabs:: .. code-tab:: python def GetAPIMetaData(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get API meta data for the fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: target fabric index on the Colorway Editor @return json string for meta data [key - value] list """ .. code-tab:: c++ GetAPIMetaData(unsigned int _colorwayIndex, unsigned int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get API meta data for the fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: target fabric index on the Colorway Editor /// @return json string for meta data [key - value] list .. tabs:: .. code-tab:: python def GetAPIMetaDataW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get API meta data for the fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: target fabric index on the Colorway Editor @return json string for meta data [key - value] list """ .. code-tab:: c++ GetAPIMetaDataW(unsigned int _colorwayIndex, unsigned int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get API meta data for the fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: target fabric index on the Colorway Editor /// @return json string for meta data [key - value] list .. tabs:: .. code-tab:: python def SetAPIMetaData(fabricIndex : int, jsonStr : str) -> bool """ @ingroup FABRIC_API @brief Set API meta data for the fabric @param fabricIndex: target fabric index on the Object Browser @param jsonStr: api meta data in string format @return if it succeeds, return true """ .. code-tab:: c++ SetAPIMetaData(unsigned int fabricIndex, string jsonStr) /// @ingroup FABRIC_API /// @brief Set API meta data for the fabric /// @param fabricIndex: target fabric index on the Object Browser /// @param jsonStr: api meta data in string format /// @return if it succeeds, return true .. tabs:: .. code-tab:: python def SetAPIMetaDataW(fabricIndex : int, jsonStr : str) -> bool """ @ingroup FABRIC_API @brief Set API meta data for the fabric @param fabricIndex: target fabric index on the Object Browser @param jsonStr: api meta data in wstring format @return if it succeeds, return true """ .. code-tab:: c++ SetAPIMetaDataW(unsigned int fabricIndex, wstring jsonStr) /// @ingroup FABRIC_API /// @brief Set API meta data for the fabric /// @param fabricIndex: target fabric index on the Object Browser /// @param jsonStr: api meta data in wstring format /// @return if it succeeds, return true .. tabs:: .. code-tab:: python def SetAPIMetaData(_colorwayIndex : int, _fabricIndex : int, _jsonStr : str) -> bool """ @ingroup FABRIC_API @brief Set API meta data for the fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: target fabric index on the Colorway Editor @param _jsonStr: api meta data in string format @return if it succeeds, return true """ .. code-tab:: c++ SetAPIMetaData(unsigned int _colorwayIndex, unsigned int _fabricIndex, string jsonStr) /// @ingroup FABRIC_API /// @brief Set API meta data for the fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: target fabric index on the Colorway Editor /// @param _jsonStr: api meta data in string format /// @return if it succeeds, return true .. tabs:: .. code-tab:: python def SetAPIMetaDataW(_colorwayIndex : int, _fabricIndex : int, _jsonStr : str) -> bool """ @ingroup FABRIC_API @brief Set API meta data for the fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: target fabric index on the Colorway Editor @param _jsonStr: api meta data in wstring format @return if it succeeds, return true """ .. code-tab:: c++ SetAPIMetaDataW(unsigned int _colorwayIndex, unsigned int _fabricIndex, wstring _jsonStr) /// @ingroup FABRIC_API /// @brief Set API meta data for the fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: target fabric index on the Colorway Editor /// @param _jsonStr: api meta data in wstring format /// @return if it succeeds, return true .. tabs:: .. code-tab:: python def ChangeMetaDataValueForFabric(fabricIndex : int, metaDataKey : str, metaDataValue : str) -> None """ @ingroup FABRIC_API @brief Change or add Meta Data Value for the fabric with the index @param fabricIndex: target fabric index on the Object Browser @param metaDataKey: target Key @param metaDataValue: the new value for the key """ .. code-tab:: c++ ChangeMetaDataValueForFabric(unsigned int fabricIndex, const string& metaDataKey, const string& metaDataValue) /// @ingroup FABRIC_API /// @brief Change or add Meta Data Value for the fabric with the index /// @param fabricIndex: target fabric index on the Object Browser /// @param metaDataKey: target Key /// @param metaDataValue: the new value for the key .. tabs:: .. code-tab:: python def ChangeMetaDataValueForFabricW(fabricIndex : int, metaDataKey : str, metaDataValue : str) -> None """ @ingroup FABRIC_API @brief Change or add Meta Data Value for the fabric with the index @param fabricIndex: target fabric index on the Object Browser @param metaDataKey: target Key @param metaDataValue: the new value for the key """ .. code-tab:: c++ ChangeMetaDataValueForFabricW(unsigned int fabricIndex, const wstring& metaDataKey, const wstring& metaDataValue) /// @ingroup FABRIC_API /// @brief Change or add Meta Data Value for the fabric with the index /// @param fabricIndex: target fabric index on the Object Browser /// @param metaDataKey: target Key /// @param metaDataValue: the new value for the key .. tabs:: .. code-tab:: python def ChangeMetaDataValueForFabric(_colorwayIndex : int, _fabricIndex : int, _metaDataKey : str, _metaDataValue : str) -> None """ @ingroup FABRIC_API @brief Change or add Meta Data Value for the fabric with the index @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: target fabric index on the Colorway Editor @param _metaDataKey: target Key @param _metaDataValue: the new value for the key """ .. code-tab:: c++ ChangeMetaDataValueForFabric(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& metaDataKey, const string& metaDataValue) /// @ingroup FABRIC_API /// @brief Change or add Meta Data Value for the fabric with the index /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: target fabric index on the Colorway Editor /// @param _metaDataKey: target Key /// @param _metaDataValue: the new value for the key .. tabs:: .. code-tab:: python def ChangeMetaDataValueForFabricW(_colorwayIndex : int, _fabricIndex : int, _metaDataKey : str, _metaDataValue : str) -> None """ @ingroup FABRIC_API @brief Change or add Meta Data Value for the fabric with the index @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: target fabric index on the Colorway Editor @param _metaDataKey: target Key @param _metaDataValue: the new value for the key """ .. code-tab:: c++ ChangeMetaDataValueForFabricW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& _metaDataKey, const wstring& _metaDataValue) /// @ingroup FABRIC_API /// @brief Change or add Meta Data Value for the fabric with the index /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: target fabric index on the Colorway Editor /// @param _metaDataKey: target Key /// @param _metaDataValue: the new value for the key .. tabs:: .. code-tab:: python def GetFabricIndexForPattern(patternIndex : int) -> int """ @ingroup FABRIC_API @brief Get the fabric index which is assigned on the pattern with the pattern index @param patternIndex: the input pattern index to get the fabric index @return fabric index on the object browser for the pattern with the pattern index """ .. code-tab:: c++ GetFabricIndexForPattern(int patternIndex) /// @ingroup FABRIC_API /// @brief Get the fabric index which is assigned on the pattern with the pattern index /// @param patternIndex: the input pattern index to get the fabric index /// @return fabric index on the object browser for the pattern with the pattern index .. tabs:: .. code-tab:: python def GetFabricIndexForPattern(_patternIndex : int, _colorwayIndex : int) -> int """ @ingroup FABRIC_API @brief Get the fabric index which is assigned on the pattern with the pattern index @param _patternIndex: the input pattern index to get the fabric index _colorwayIndex: the colorway index to get the fabric index @return fabric index on the object browser for the pattern with the pattern index and colorway index """ .. code-tab:: c++ GetFabricIndexForPattern(int _patternIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Get the fabric index which is assigned on the pattern with the pattern index /// @param _patternIndex: the input pattern index to get the fabric index /// _colorwayIndex: the colorway index to get the fabric index /// @return fabric index on the object browser for the pattern with the pattern index and colorway index .. tabs:: .. code-tab:: python def GetFabricIndex(fabricName : str) -> int """ @ingroup FABRIC_API @brief Get the fabric index which is using the fabric name @param fabricName: the fabric name to get the fabric index @return fabric index. If the fabric name is not found, return -1. """ .. code-tab:: c++ GetFabricIndex(const string& fabricName) /// @ingroup FABRIC_API /// @brief Get the fabric index which is using the fabric name /// @param fabricName: the fabric name to get the fabric index /// @return fabric index. If the fabric name is not found, return -1. .. tabs:: .. code-tab:: python def GetFabricIndex(_colorwayIndex : int, _fabricName : str) -> int """ @ingroup FABRIC_API @brief Get the fabric index which is using the fabric name @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricName: the fabric name to get the fabric index @return fabric index """ .. code-tab:: c++ GetFabricIndex(const string& fabricName) /// @ingroup FABRIC_API /// @brief Get the fabric index which is using the fabric name /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricName: the fabric name to get the fabric index /// @return fabric index .. tabs:: .. code-tab:: python def GetFabricIndexW(fabricName : str) -> int """ @ingroup FABRIC_API @brief Get the fabric index which is using the fabric name @param fabricName: the fabric name to get the fabric index @return fabric index """ .. code-tab:: c++ GetFabricIndexW(const wstring& fabricName) /// @ingroup FABRIC_API /// @brief Get the fabric index which is using the fabric name /// @param fabricName: the fabric name to get the fabric index /// @return fabric index .. tabs:: .. code-tab:: python def GetFabricIndexW(_colorwayIndex : int, _fabricName : str) -> int """ @ingroup FABRIC_API @brief Get the fabric index which is using the fabric name @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricName: the fabric name to get the fabric index @return fabric index """ .. code-tab:: c++ GetFabricIndexW(const wstring& fabricName) /// @ingroup FABRIC_API /// @brief Get the fabric index which is using the fabric name /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricName: the fabric name to get the fabric index /// @return fabric index .. tabs:: .. code-tab:: python def GetFabricName(fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get the fabric name of the fabric in the fabricIndex on the object browser @param fabricIndex: the fabric index on the Object Browser to get the name @return fabric name """ .. code-tab:: c++ GetFabricName(int fabricIndex) /// @ingroup FABRIC_API /// @brief Get the fabric name of the fabric in the fabricIndex on the object browser /// @param fabricIndex: the fabric index on the Object Browser to get the name /// @return fabric name .. tabs:: .. code-tab:: python def GetFabricNameW(fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get the fabric name of the fabric in the fabricIndex on the object browser @param fabricIndex: the fabric index on the Object Browser to get the name @return fabric name """ .. code-tab:: c++ GetFabricNameW(int fabricIndex) /// @ingroup FABRIC_API /// @brief Get the fabric name of the fabric in the fabricIndex on the object browser /// @param fabricIndex: the fabric index on the Object Browser to get the name /// @return fabric name .. tabs:: .. code-tab:: python def GetFabricName(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get the fabric name of the fabric in the fabricIndex on the object browser @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the fabric index on the Colorway Editor to get the name @return fabric name """ .. code-tab:: c++ GetFabricName(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get the fabric name of the fabric in the fabricIndex on the object browser /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the fabric index on the Colorway Editor to get the name /// @return fabric name .. tabs:: .. code-tab:: python def GetFabricNameW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get the fabric name of the fabric in the fabricIndex on the object browser @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the fabric index on the Colorway Editor to get the name @return fabric name """ .. code-tab:: c++ GetFabricNameW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get the fabric name of the fabric in the fabricIndex on the object browser /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the fabric index on the Colorway Editor to get the name /// @return fabric name .. tabs:: .. code-tab:: python def GetFabricInfo(fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information @param fabricIndex: the fabricIndex for the fabric to get the fabric info @return json string for fabric information """ .. code-tab:: c++ GetFabricInfo(int fabricIndex) /// @ingroup FABRIC_API /// @brief Get a fabric information /// @param fabricIndex: the fabricIndex for the fabric to get the fabric info /// @return json string for fabric information .. tabs:: .. code-tab:: python def GetFabricInfoW(fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information @param fabricIndex: the fabricIndex for the fabric to get the fabric info @return json string for fabric information """ .. code-tab:: c++ GetFabricInfoW(int fabricIndex) /// @ingroup FABRIC_API /// @brief Get a fabric information /// @param fabricIndex: the fabricIndex for the fabric to get the fabric info /// @return json string for fabric information .. tabs:: .. code-tab:: python def GetColorwayFabricInfo(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information for a colorway @param _colorwayIndex: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info @return json string for fabric information """ .. code-tab:: c++ GetColorwayFabricInfo(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get a fabric information for a colorway /// @param _colorwayIndex: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info /// @return json string for fabric information .. tabs:: .. code-tab:: python def GetColorwayFabricInfoW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information for a colorway @param _colorwayIndex: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info @return json string for fabric information """ .. code-tab:: c++ GetColorwayFabricInfoW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get a fabric information for a colorway /// @param _colorwayIndex: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info /// @return json string for fabric information .. tabs:: .. code-tab:: python def GetAPIMetaDataFromFile(filePath : str) -> str """ @ingroup FABRIC_API @brief Get API meta data for the fabric @param filePath: filepath (.zfab / .jfab) @return json string for meta data [key - value] list """ .. code-tab:: c++ GetAPIMetaDataFromFile(const string& filePath) /// @ingroup FABRIC_API /// @brief Get API meta data for the fabric /// @param filePath: filepath (.zfab / .jfab) /// @return json string for meta data [key - value] list .. tabs:: .. code-tab:: python def GetAPIMetaDataFromFileW(filePath : str) -> str """ @ingroup FABRIC_API @brief Get API meta data for the fabric @param filePath: filepath (.zfab / .jfab) @return json string for meta data [key - value] list """ .. code-tab:: c++ GetAPIMetaDataFromFileW(const wstring& filePath) /// @ingroup FABRIC_API /// @brief Get API meta data for the fabric /// @param filePath: filepath (.zfab / .jfab) /// @return json string for meta data [key - value] list .. tabs:: .. code-tab:: python def SetFabricInformation(_fabricIndex : int, _infoMap : map[str, str]) -> None """ @ingroup FABRIC_API @brief Set Fabric Information to fabric @param _fabricIndex: the fabricIndex for the fabric to set the fabric info @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner) """ .. code-tab:: c++ SetFabricInformation(int _fabricIndex, const std::map _infoMap) /// @ingroup FABRIC_API /// @brief Set Fabric Information to fabric /// @param _fabricIndex: the fabricIndex for the fabric to set the fabric info /// @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner) .. tabs:: .. code-tab:: python def SetFabricInformationW(_fabricIndex : int, _infoMap : map[str, str]) -> None """ @ingroup FABRIC_API @brief Set Fabric Information to fabric @param _fabricIndex: the fabricIndex for the fabric to set the fabric info @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner) """ .. code-tab:: c++ SetFabricInformationW(int _fabricIndex, const std::map _infoMap) /// @ingroup FABRIC_API /// @brief Set Fabric Information to fabric /// @param _fabricIndex: the fabricIndex for the fabric to set the fabric info /// @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner) .. tabs:: .. code-tab:: python def SetFabricInformation(_colorwayIndex : int, _fabricIndex : int, _infoMap : map[str, str]) -> None """ @ingroup FABRIC_API @brief Set Fabric Information to fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner) """ .. code-tab:: c++ SetFabricInformation(int _colorwayIndex, int _fabricIndex, const std::map _infoMap) /// @ingroup FABRIC_API /// @brief Set Fabric Information to fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info /// @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner) .. tabs:: .. code-tab:: python def SetFabricInformationW(_colorwayIndex : int, _fabricIndex : int, _infoMap : map[str, str]) -> None """ @ingroup FABRIC_API @brief Set Fabric Information to fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner) """ .. code-tab:: c++ SetFabricInformationW(int _colorwayIndex, int _fabricIndex, const std::map _infoMap) /// @ingroup FABRIC_API /// @brief Set Fabric Information to fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info /// @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner) .. tabs:: .. code-tab:: python def GetFabricInformation(_fabricIndex : int) -> map[str, str] """ @ingroup FABRIC_API @brief Get Fabric Information for fabric @param _fabricIndex: the fabricIndex for the fabric to get the fabric info @return Fabric Information """ .. code-tab:: c++ GetFabricInformation(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get Fabric Information for fabric /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info /// @return Fabric Information .. tabs:: .. code-tab:: python def GetFabricInformationW(_fabricIndex : int) -> map[str, str] """ @ingroup FABRIC_API @brief Get Fabric Information for fabric @param _fabricIndex: the fabricIndex for the fabric to get the fabric info @return Fabric Information """ .. code-tab:: c++ GetFabricInformationW(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get Fabric Information for fabric /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info /// @return Fabric Information .. tabs:: .. code-tab:: python def GetFabricInformation(_colorwayIndex : int, _fabricIndex : int) -> map[str, str] """ @ingroup FABRIC_API @brief Get Fabric Information for fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info @return Fabric Information """ .. code-tab:: c++ GetFabricInformation(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get Fabric Information for fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info /// @return Fabric Information .. tabs:: .. code-tab:: python def GetFabricInformationW(_colorwayIndex : int, _fabricIndex : int) -> map[str, str] """ @ingroup FABRIC_API @brief Get Fabric Information for fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info @return Fabric Information """ .. code-tab:: c++ GetFabricInformationW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get Fabric Information for fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info /// @return Fabric Information .. tabs:: .. code-tab:: python def SetCustomImage(_fabricIndex : int, _filePath : str) -> None """ @ingroup FABRIC_API @brief Set Custom Image to fabric @param _fabricIndex: the fabricIndex for the fabric @param _filePath: filepath (.png / .jpeg) """ .. code-tab:: c++ SetCustomImage(int _fabricIndex, const string& _filePath) /// @ingroup FABRIC_API /// @brief Set Custom Image to fabric /// @param _fabricIndex: the fabricIndex for the fabric /// @param _filePath: filepath (.png / .jpeg) .. tabs:: .. code-tab:: python def SetCustomImageW(_fabricIndex : int, _filePath : str) -> None """ @ingroup FABRIC_API @brief Set Custom Image to fabric @param _fabricIndex: the fabricIndex for the fabric @param _filePath: filepath (.png / .jpeg) """ .. code-tab:: c++ SetCustomImageW(int _fabricIndex, const wstring& _filePath) /// @ingroup FABRIC_API /// @brief Set Custom Image to fabric /// @param _fabricIndex: the fabricIndex for the fabric /// @param _filePath: filepath (.png / .jpeg) .. tabs:: .. code-tab:: python def SetCustomImage(_colorwayIndex : int, _fabricIndex : int, _filePath : str) -> None """ @ingroup FABRIC_API @brief Set Custom Image to fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric @param _filePath: filepath (.png / .jpeg) """ .. code-tab:: c++ SetCustomImage(int _colorwayIndex, int _fabricIndex, const string& _filePath) /// @ingroup FABRIC_API /// @brief Set Custom Image to fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric /// @param _filePath: filepath (.png / .jpeg) .. tabs:: .. code-tab:: python def SetCustomImageW(_colorwayIndex : int, _fabricIndex : int, _filePath : str) -> None """ @ingroup FABRIC_API @brief Set Custom Image to fabric @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric @param _filePath: filepath (.png / .jpeg) """ .. code-tab:: c++ SetCustomImageW(int _colorwayIndex, int _fabricIndex, const wstring& _filePath) /// @ingroup FABRIC_API /// @brief Set Custom Image to fabric /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric /// @param _filePath: filepath (.png / .jpeg) .. tabs:: .. code-tab:: python def GetPrimaryFabric() -> int """ @ingroup FABRIC_API @brief Return the fabric index used for a major number of the patterns """ .. code-tab:: c++ GetPrimaryFabric() /// @ingroup FABRIC_API /// @brief Return the fabric index used for a major number of the patterns .. tabs:: .. code-tab:: python def SetFabricName(index : int, str : str) -> None """ @ingroup FABRIC_API @brief Change fabric name @param index: the target fabric index on the object browser to change the name @param str: new name for the fabric """ .. code-tab:: c++ SetFabricName(unsigned int index, const string& str) /// @ingroup FABRIC_API /// @brief Change fabric name /// @param index: the target fabric index on the object browser to change the name /// @param str: new name for the fabric .. tabs:: .. code-tab:: python def SetFabricNameW(index : int, wstr : str) -> None """ @ingroup FABRIC_API @brief Change fabric name @param index: the target fabric index on the object browser to change the name @param wstr: new name for the fabric """ .. code-tab:: c++ SetFabricNameW(unsigned int index, const wstring& wstr) /// @ingroup FABRIC_API /// @brief Change fabric name /// @param index: the target fabric index on the object browser to change the name /// @param wstr: new name for the fabric .. tabs:: .. code-tab:: python def SetFabricName(_colorwayIndex : int, _fabricIndex : int, _str : str) -> None """ @ingroup FABRIC_API @brief Change fabric name @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index on the object browser to change the name @param str: new name for the fabric """ .. code-tab:: c++ SetFabricName(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& str) /// @ingroup FABRIC_API /// @brief Change fabric name /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index on the object browser to change the name /// @param str: new name for the fabric .. tabs:: .. code-tab:: python def SetFabricNameW(_colorwayIndex : int, _fabricIndex : int, _wstr : str) -> None """ @ingroup FABRIC_API @brief Change fabric name @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index on the object browser to change the name @param _wstr: new name for the fabric """ .. code-tab:: c++ SetFabricNameW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& _wstr) /// @ingroup FABRIC_API /// @brief Change fabric name /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index on the object browser to change the name /// @param _wstr: new name for the fabric .. tabs:: .. code-tab:: python def SetFabricName(_index : int, _str : str, _bRefreshTab : bool) -> None """ @ingroup FABRIC_API @brief Change fabric name @param index: the target fabric index on the object browser to change the name @param str: new name for the fabric @param refreshTab: refreshes the tab after setting the new name """ .. code-tab:: c++ SetFabricName(unsigned int index, const string& str, bool refreshTab) /// @ingroup FABRIC_API /// @brief Change fabric name /// @param index: the target fabric index on the object browser to change the name /// @param str: new name for the fabric /// @param refreshTab: refreshes the tab after setting the new name .. tabs:: .. code-tab:: python def GetFabricStyleNameList() -> list[str] """ @ingroup FABRIC_API @brief Return all fabric style name """ .. code-tab:: c++ GetFabricStyleNameList() /// @ingroup FABRIC_API /// @brief Return all fabric style name .. tabs:: .. code-tab:: python def ImportSubstanceFile(fabricIndex : int, substanceFilePath : str) -> bool """ @ingroup FABRIC_API @brief Import substance to a fabric. @param fabricIndex: the target fabric index in the object browser to import substance file onto @param substanceFilePath: the substance file path to import @return if it succeeds, return true. """ .. code-tab:: c++ ImportSubstanceFile(unsigned int fabricIndex, const string& substanceFilePath) /// @ingroup FABRIC_API /// @brief Import substance to a fabric. /// @param fabricIndex: the target fabric index in the object browser to import substance file onto /// @param substanceFilePath: the substance file path to import /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportSubstanceFileW(fabricIndex : int, substanceFilePath : str) -> bool """ @ingroup FABRIC_API @brief Import substance to a fabric. @param fabricIndex: the target fabric index in the object browser to import substance file onto @param substanceFilePath: the substance file path to import @return if it succeeds, return true. """ .. code-tab:: c++ ImportSubstanceFileW(unsigned int fabricIndex, const wstring& substanceFilePath) /// @ingroup FABRIC_API /// @brief Import substance to a fabric. /// @param fabricIndex: the target fabric index in the object browser to import substance file onto /// @param substanceFilePath: the substance file path to import /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportSubstanceFile(_colorwayIndex : int, _fabricIndex : int, _substanceFilePath : str) -> bool """ @ingroup FABRIC_API @brief Import substance to a fabric. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor to import substance file onto @param _substanceFilePath: the substance file path to import @return if it succeeds, return true. """ .. code-tab:: c++ ImportSubstanceFile(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& _substanceFilePath) /// @ingroup FABRIC_API /// @brief Import substance to a fabric. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor to import substance file onto /// @param _substanceFilePath: the substance file path to import /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportSubstanceFileW(_colorwayIndex : int, _fabricIndex : int, _substanceFilePath : str) -> bool """ @ingroup FABRIC_API @brief Import substance to a fabric. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor to import substance file onto @param _substanceFilePath: the substance file path to import @return if it succeeds, return true. """ .. code-tab:: c++ ImportSubstanceFileW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& _substanceFilePath) /// @ingroup FABRIC_API /// @brief Import substance to a fabric. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor to import substance file onto /// @param _substanceFilePath: the substance file path to import /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def GetFabricWidth(fabricIndex : int) -> float """ @ingroup FABRIC_API @brief Get Fabric width (mm) @param fabricIndex: the target fabric index in the object browser @return fabric width """ .. code-tab:: c++ GetFabricWidth(int fabricIndex) /// @ingroup FABRIC_API /// @brief Get Fabric width (mm) /// @param fabricIndex: the target fabric index in the object browser /// @return fabric width .. tabs:: .. code-tab:: python def GetFabricWidth(_colorwayIndex : int, _fabricIndex : int) -> float """ @ingroup FABRIC_API @brief Get Fabric width (mm) @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return fabric width """ .. code-tab:: c++ GetFabricWidth(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get Fabric width (mm) /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return fabric width .. tabs:: .. code-tab:: python def SetFabricWidth(_fabricIndex : int, mm : float) -> None """ @ingroup FABRIC_API @brief Set Fabric width (mm) @param fabricIndex: the target fabric index in the object browser @param mm: Fabric width @return void """ .. code-tab:: c++ SetFabricWidth(int fabricIndex, float mm) /// @ingroup FABRIC_API /// @brief Set Fabric width (mm) /// @param fabricIndex: the target fabric index in the object browser /// @param mm: Fabric width /// @return void .. tabs:: .. code-tab:: python def SetFabricWidth(_colorwayIndex : int, _fabricIndex : int, _mm : float) -> None """ @ingroup FABRIC_API @brief Set Fabric width (mm) @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _mm: Fabric width @return void """ .. code-tab:: c++ SetFabricWidth(unsigned int _colorwayIndex, int fabricIndex, float mm) /// @ingroup FABRIC_API /// @brief Set Fabric width (mm) /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _mm: Fabric width /// @return void .. tabs:: .. code-tab:: python def GetFabricLength(fabricIndex : int) -> float """ @ingroup FABRIC_API @brief Get Fabric Length (mm) @param fabricIndex: the target fabric index in the object browser @return Fabric Length """ .. code-tab:: c++ GetFabricLength(int fabricIndex) /// @ingroup FABRIC_API /// @brief Get Fabric Length (mm) /// @param fabricIndex: the target fabric index in the object browser /// @return Fabric Length .. tabs:: .. code-tab:: python def GetFabricLength(_colorwayIndex : int, _fabricIndex : int) -> float """ @ingroup FABRIC_API @brief Get Fabric Length (mm) @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return Fabric Length """ .. code-tab:: c++ GetFabricLength(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get Fabric Length (mm) /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return Fabric Length .. tabs:: .. code-tab:: python def SetTextureMapping(fabricIndex : int, mappingType : int) -> None """ @ingroup FABRIC_API @brief Set Texture Mapping Type (Repeat or Unified) @param fabricIndex: the target fabric index in the object browser @param mappingType: the target mapping type to set. 0: "Repeat", 1: "Unified" """ .. code-tab:: c++ SetTextureMapping(unsigned int fabricIndex, int mappingType) /// @ingroup FABRIC_API /// @brief Set Texture Mapping Type (Repeat or Unified) /// @param fabricIndex: the target fabric index in the object browser /// @param mappingType: the target mapping type to set. 0: "Repeat", 1: "Unified" .. tabs:: .. code-tab:: python def SetTextureMapping(_colorwayIndex : int, _fabricIndex : int, _mappingType : int) -> None """ @ingroup FABRIC_API @brief Set Texture Mapping Type (Repeat or Unified) @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the ColorwayEditor @param _mappingType: the target mapping type to set. 0: "Repeat", 1: "Unified" """ .. code-tab:: c++ SetTextureMapping(unsigned int _colorwayIndex, unsigned int _fabricIndex, int _mappingType) /// @ingroup FABRIC_API /// @brief Set Texture Mapping Type (Repeat or Unified) /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the ColorwayEditor /// @param _mappingType: the target mapping type to set. 0: "Repeat", 1: "Unified" .. tabs:: .. code-tab:: python def SetSubstancePreset(fabricIndex : int, materialFace : int, presetIndex : int) -> None """ @ingroup FABRIC_API @brief Set Substance Preset @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param presetIndex: the preset index to set """ .. code-tab:: c++ SetSubstancePreset(unsigned int fabricIndex, int materialFace, int presetIndex) /// @ingroup FABRIC_API /// @brief Set Substance Preset /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param presetIndex: the preset index to set .. tabs:: .. code-tab:: python def SetSubstancePreset(colorwayIndex : int, fabricIndex : int, materialFace : int, presetIndex : int) -> None """ @ingroup FABRIC_API @brief Set Substance Preset @param colorwayIndex: target colorway index in the Colorway Editor @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param presetIndex: the preset index to set """ .. code-tab:: c++ SetSubstancePreset(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace, int presetIndex) /// @ingroup FABRIC_API /// @brief Set Substance Preset /// @param colorwayIndex: target colorway index in the Colorway Editor /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param presetIndex: the preset index to set .. tabs:: .. code-tab:: python def SetSubstanceResolution(fabricIndex : int, materialFace : int, resolutionIndex : int) -> None """ @ingroup FABRIC_API @brief Set Substance Resolution @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param resolutionIndex: the resolution index to set """ .. code-tab:: c++ SetSubstanceResolution(unsigned int fabricIndex, int materialFace, int resolutionIndex) /// @ingroup FABRIC_API /// @brief Set Substance Resolution /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param resolutionIndex: the resolution index to set .. tabs:: .. code-tab:: python def SetSubstanceResolution(colorwayIndex : int, fabricIndex : int, materialFace : int, resolutionIndex : int) -> None """ @ingroup FABRIC_API @brief Set Substance Resolution @param colorwayIndex: target colorway index in the Colorway Editor @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param resolutionIndex: the resolution index to set """ .. code-tab:: c++ SetSubstanceResolution(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace, int resolutionIndex) /// @ingroup FABRIC_API /// @brief Set Substance Resolution /// @param colorwayIndex: target colorway index in the Colorway Editor /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param resolutionIndex: the resolution index to set .. tabs:: .. code-tab:: python def ImportSubstanceFileAsFaceType(_fabricIndex : int, _substanceFilePath : str, _faceType : str) -> bool """ @ingroup FABRIC_API @brief Import substance to a fabric as facetype. @param _fabricIndex: the target fabric index in the object browser to import substance file onto @param _substanceFilePath: the substance file path to import @param _facetype :“Front”, “Back”, “Side” @return if it succeeds, return true. """ .. code-tab:: c++ ImportSubstanceFileAsFaceType(unsigned int _fabricIndex, const string& _substanceFilePath, const string& _faceType) /// @ingroup FABRIC_API /// @brief Import substance to a fabric as facetype. /// @param _fabricIndex: the target fabric index in the object browser to import substance file onto /// @param _substanceFilePath: the substance file path to import /// @param _facetype :“Front”, “Back”, “Side” /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportSubstanceFileAsFaceType(_colorwayIndex : int, _fabricIndex : int, _substanceFilePath : str, _faceType : str) -> bool """ @ingroup FABRIC_API @brief Import substance to a fabric as facetype. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the object browser to import substance file onto @param _substanceFilePath: the substance file path to import @param _facetype :“Front”, “Back”, “Side” @return if it succeeds, return true. """ .. code-tab:: c++ ImportSubstanceFileAsFaceType(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& _substanceFilePath, const string& _faceType) /// @ingroup FABRIC_API /// @brief Import substance to a fabric as facetype. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the object browser to import substance file onto /// @param _substanceFilePath: the substance file path to import /// @param _facetype :“Front”, “Back”, “Side” /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportSubstanceFileAsFaceTypeW(_fabricIndex : int, _substanceFilePath : str, _faceType : str) -> bool """ @ingroup FABRIC_API @brief Import substance to a fabric. @param _fabricIndex: the target fabric index in the object browser to import substance file onto @param _substanceFilePath: the substance file path to import @param _facetype :“Front”, “Back”, “Side” @return if it succeeds, return true. """ .. code-tab:: c++ ImportSubstanceFileAsFaceTypeW(unsigned int _fabricIndex, const wstring& _substanceFilePath, const string& _faceType) /// @ingroup FABRIC_API /// @brief Import substance to a fabric. /// @param _fabricIndex: the target fabric index in the object browser to import substance file onto /// @param _substanceFilePath: the substance file path to import /// @param _facetype :“Front”, “Back”, “Side” /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportSubstanceFileAsFaceTypeW(_colorwayIndex : int, _fabricIndex : int, _substanceFilePath : str, _faceType : str) -> bool """ @ingroup FABRIC_API @brief Import substance to a fabric. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the object browser to import substance file onto @param _substanceFilePath: the substance file path to import @param _facetype :“Front”, “Back”, “Side” @return if it succeeds, return true. """ .. code-tab:: c++ ImportSubstanceFileAsFaceTypeW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& _substanceFilePath, const string& _faceType) /// @ingroup FABRIC_API /// @brief Import substance to a fabric. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the object browser to import substance file onto /// @param _substanceFilePath: the substance file path to import /// @param _facetype :“Front”, “Back”, “Side” /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetUseSameMaterialAsFront(fabricIndex : int, materialFace : int, _useSameMaterial : bool) -> None """ @ingroup FABRIC_API @brief Set use same material as front. @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" @param _useSameMaterial: use same material as front @return void """ .. code-tab:: c++ SetUseSameMaterialAsFront(unsigned int fabricIndex, int materialFace, bool _useSameMaterial) /// @ingroup FABRIC_API /// @brief Set use same material as front. /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" /// @param _useSameMaterial: use same material as front /// @return void .. tabs:: .. code-tab:: python def SetUseSameMaterialAsFront(colorwayIndex : int, fabricIndex : int, materialFace : int, _useSameMaterial : bool) -> None """ @ingroup FABRIC_API @brief Set use same material as front. @param colorwayIndex: target colorway index in the Colorway Editor @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" @param _useSameMaterial: use same material as front @return void """ .. code-tab:: c++ SetUseSameMaterialAsFront(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace, bool _useSameMaterial) /// @ingroup FABRIC_API /// @brief Set use same material as front. /// @param colorwayIndex: target colorway index in the Colorway Editor /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" /// @param _useSameMaterial: use same material as front /// @return void .. tabs:: .. code-tab:: python def GetUseSameMaterialAsFront(fabricIndex : int, materialFace : int) -> bool """ @ingroup FABRIC_API @brief Get use same material as front. @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" @return It returns True if the UseSameMaterialAsFront option is enabled. """ .. code-tab:: c++ GetUseSameMaterialAsFront(unsigned int fabricIndex, int materialFace) /// @ingroup FABRIC_API /// @brief Get use same material as front. /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" /// @return It returns True if the UseSameMaterialAsFront option is enabled. .. tabs:: .. code-tab:: python def GetUseSameMaterialAsFront(colorwayIndex : int, fabricIndex : int, materialFace : int) -> bool """ @ingroup FABRIC_API @brief Get use same material as front. @param colorwayIndex: target colorway index in the Colorway Editor @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" @return It returns True if the UseSameMaterialAsFront option is enabled. """ .. code-tab:: c++ GetUseSameMaterialAsFront(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace) /// @ingroup FABRIC_API /// @brief Get use same material as front. /// @param colorwayIndex: target colorway index in the Colorway Editor /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" /// @return It returns True if the UseSameMaterialAsFront option is enabled. .. tabs:: .. code-tab:: python def SetUseSameColorAsFront(fabricIndex : int, materialFace : int, _useSameColor : bool) -> None """ @ingroup FABRIC_API @brief Set use same color as front. @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" @param _useSameColor: use same color as front """ .. code-tab:: c++ SetUseSameColorAsFront(unsigned int fabricIndex, int materialFace, bool _useSameColor) /// @ingroup FABRIC_API /// @brief Set use same color as front. /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" /// @param _useSameColor: use same color as front .. tabs:: .. code-tab:: python def SetUseSameColorAsFront(colorwayIndex : int, fabricIndex : int, materialFace : int, _useSameColor : bool) -> None """ @ingroup FABRIC_API @brief Set use same color as front. @param colorwayIndex: target colorway index in the Colorway Editor @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" @param _useSameColor: use same color as front """ .. code-tab:: c++ SetUseSameColorAsFront(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace, bool _useSameColor) /// @ingroup FABRIC_API /// @brief Set use same color as front. /// @param colorwayIndex: target colorway index in the Colorway Editor /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" /// @param _useSameColor: use same color as front .. tabs:: .. code-tab:: python def GetUseSameColorAsFront(fabricIndex : int, materialFace : int) -> bool """ @ingroup FABRIC_API @brief Get use same color as front. @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" @return It returns True if the UseSameColorAsFront option is enabled. """ .. code-tab:: c++ GetUseSameColorAsFront(unsigned int fabricIndex, int materialFace) /// @ingroup FABRIC_API /// @brief Get use same color as front. /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" /// @return It returns True if the UseSameColorAsFront option is enabled. .. tabs:: .. code-tab:: python def GetUseSameColorAsFront(colorwayIndex : int, fabricIndex : int, materialFace : int) -> bool """ @ingroup FABRIC_API @brief Get use same color as front. @param colorwayIndex: target colorway index in the Colorway Editor @param fabricIndex: the target fabric index in the object browser @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" @return It returns True if the UseSameColorAsFront option is enabled. """ .. code-tab:: c++ GetUseSameColorAsFront(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace) /// @ingroup FABRIC_API /// @brief Get use same color as front. /// @param colorwayIndex: target colorway index in the Colorway Editor /// @param fabricIndex: the target fabric index in the object browser /// @param materialFace: the target material index in the property editor. 1: "Back", 2: "Side" /// @return It returns True if the UseSameColorAsFront option is enabled. .. tabs:: .. code-tab:: python def SetFabricPBRMaterialBaseColor(fabricIndex : int, materialFace : int, r : float, g : float, b : float, a : float) -> bool """ @ingroup FABRIC_API @brief Set a base color of PBR material in a fabric using given RGBA values. @param fabricIndex: the target fabric index in the object browser to import substance file onto @param materialFace :"Front", "Back", "Side" @param r : To be set as red value @param g : To be set as green value @param b : To be set as blue value @param a : To be set as alpha value @return if it succeeds, return true. """ .. code-tab:: c++ SetFabricPBRMaterialBaseColor(unsigned int fabricIndex, unsigned int materialFace, float r, float g, float b, float a) /// @ingroup FABRIC_API /// @brief Set a base color of PBR material in a fabric using given RGBA values. /// @param fabricIndex: the target fabric index in the object browser to import substance file onto /// @param materialFace :"Front", "Back", "Side" /// @param r : To be set as red value /// @param g : To be set as green value /// @param b : To be set as blue value /// @param a : To be set as alpha value /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetFabricPBRMaterialBaseColor(_colorwayIndex : int, _fabricIndex : int, _materialFace : int, _r : float, _g : float, _b : float, _a : float) -> bool """ @ingroup FABRIC_API @brief Set a base color of PBR material in a fabric using given RGBA values. @param _colorwayIndex: the target colorway index @param _fabricIndex: the target fabric index in the object browser(Fabric index calculated assuming that the "Show All Colorways" option is turned off) @param _materialFace :“Front”, “Back”, “Side” @param _r : To be set as red value @param _g : To be set as green value @param _b : To be set as blue value @param _a : To be set as alpha value @return if it succeeds, return true. """ .. code-tab:: c++ SetFabricPBRMaterialBaseColor(unsigned int _colorwayIndex, unsigned int _fabricIndex, unsigned int _materialFace, float _r, float _g, float _b, float _a) /// @ingroup FABRIC_API /// @brief Set a base color of PBR material in a fabric using given RGBA values. /// @param _colorwayIndex: the target colorway index /// @param _fabricIndex: the target fabric index in the object browser(Fabric index calculated assuming that the "Show All Colorways" option is turned off) /// @param _materialFace :“Front”, “Back”, “Side” /// @param _r : To be set as red value /// @param _g : To be set as green value /// @param _b : To be set as blue value /// @param _a : To be set as alpha value /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetFabricPBRMaterialBaseColor(fabricIndex : int, materialFace : int, _colorName : str) -> bool """ @ingroup FABRIC_API @brief Set a base color of PBR material in a fabric using given name of color. @param fabricIndex: the target fabric index in the object browser to import substance file onto @param materialFace :“Front”, “Back”, “Side” @param _colorName: Name of color @return if it succeeds, return true. """ .. code-tab:: c++ SetFabricPBRMaterialBaseColor(unsigned int fabricIndex, unsigned int materialFace, const std::string& _colorName) /// @ingroup FABRIC_API /// @brief Set a base color of PBR material in a fabric using given name of color. /// @param fabricIndex: the target fabric index in the object browser to import substance file onto /// @param materialFace :“Front”, “Back”, “Side” /// @param _colorName: Name of color /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetFabricPBRMaterialBaseColor(_colorwayIndex : int, _fabricIndex : int, _materialFace : int, _colorName : str) -> bool """ @ingroup FABRIC_API @brief Set a base color of PBR material in a fabric using given name of color. @param _colorwayIndex: the target colorway index @param _fabricIndex: the target fabric index in the object browser(Fabric index calculated assuming that the "Show All Colorways" option is turned off) @param _materialFace :“Front”, “Back”, “Side” @param _colorName: Name of color @return if it succeeds, return true. """ .. code-tab:: c++ SetFabricPBRMaterialBaseColor(unsigned int _colorwayIndex, unsigned int _fabricIndex, unsigned int _materialFace, const std::string& _colorName) /// @ingroup FABRIC_API /// @brief Set a base color of PBR material in a fabric using given name of color. /// @param _colorwayIndex: the target colorway index /// @param _fabricIndex: the target fabric index in the object browser(Fabric index calculated assuming that the "Show All Colorways" option is turned off) /// @param _materialFace :“Front”, “Back”, “Side” /// @param _colorName: Name of color /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def GetFabricPBRMaterialBaseColor(fabricIndex : int, materialFace : int) -> tuple[float, float, float, float] """ @ingroup FABRIC_API @brief Get a base color of PBR material in a fabric. @param fabricIndex: the target fabric index in the object browser to import substance file onto @param materialFace :“Front”, “Back”, “Side” @return RGBA float tuple """ .. code-tab:: c++ GetFabricPBRMaterialBaseColor(unsigned int fabricIndex, unsigned int materialFace) /// @ingroup FABRIC_API /// @brief Get a base color of PBR material in a fabric. /// @param fabricIndex: the target fabric index in the object browser to import substance file onto /// @param materialFace :“Front”, “Back”, “Side” /// @return RGBA float tuple .. tabs:: .. code-tab:: python def GetFabricPBRMaterialBaseColor(_colorwayIndex : int, _fabricIndex : int, _materialFace : int) -> tuple[float, float, float, float] """ @ingroup FABRIC_API @brief Get a base color of PBR material in a fabric. @param _colorwayIndex: the target colorway index @param _fabricIndex: the target fabric index in the object browser to import substance file onto @param _materialFace :“Front”, “Back”, “Side” @return RGBA float tuple """ .. code-tab:: c++ GetFabricPBRMaterialBaseColor(unsigned int _colorwayIndex, unsigned int _fabricIndex, unsigned int _materialFace) /// @ingroup FABRIC_API /// @brief Get a base color of PBR material in a fabric. /// @param _colorwayIndex: the target colorway index /// @param _fabricIndex: the target fabric index in the object browser to import substance file onto /// @param _materialFace :“Front”, “Back”, “Side” /// @return RGBA float tuple .. tabs:: .. code-tab:: python def SetCurrentFabricIndex(_index : int) -> bool """ @ingroup FABRIC_API @brief Set Current Fabric Index @param _index: Fabric Index @return Fabric setting success or failure return """ .. code-tab:: c++ SetCurrentFabricIndex(int _index) /// @ingroup FABRIC_API /// @brief Set Current Fabric Index /// @param _index: Fabric Index /// @return Fabric setting success or failure return .. tabs:: .. code-tab:: python def SetCurrentFabricIndex(_colorwayIndex : int, _index : int) -> bool """ @ingroup FABRIC_API @brief Set Current Fabric Index @param _colorwayIndex: target colorway index in the Colorway Editor @param _index: Fabric Index @return Fabric setting success or failure return """ .. code-tab:: c++ SetCurrentFabricIndex(unsigned int _colorwayIndex, int _index) /// @ingroup FABRIC_API /// @brief Set Current Fabric Index /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _index: Fabric Index /// @return Fabric setting success or failure return .. tabs:: .. code-tab:: python def CreateZfabFromTextures(_filePath : str, _baseTexturePath : str, _normalTexturePath : str, _disPlacementTexturePath : str, _opacityTexturePath : str, _roughnessTexturePath : str, _metalnessTexturePath : str) -> bool """ @ingroup FABRIC_API @brief Create Zfab From Textures @param _filePath: created filepath (.zfab) @param _baseTexturePath: the baseTexture file path to create zfab @param _normalTexturePath: the normalTexturePath file path to create zfab @param _disPlacementTexturePath :the disPlacementTexturePath file path to create zfab @param _opacityTexturePath :the opacityTexturePath file path to create zfab @param _roughnessTexturePath :the roughnessTexturePath file path to create zfab @param _metalnessTexturePath :the metalnessTexturePath file path to create zfab @return zfab file creating success or failure return """ .. code-tab:: c++ CreateZfabFromTextures(const std::string& _filePath, const std::string& _baseTexturePath, const std::string& _normalTexturePath, const std::string& _disPlacementTexturePath, const std::string& _opacityTexturePath, const std::string& _roughnessTexturePath, const std::string& _metalnessTexturePath) /// @ingroup FABRIC_API /// @brief Create Zfab From Textures /// @param _filePath: created filepath (.zfab) /// @param _baseTexturePath: the baseTexture file path to create zfab /// @param _normalTexturePath: the normalTexturePath file path to create zfab /// @param _disPlacementTexturePath :the disPlacementTexturePath file path to create zfab /// @param _opacityTexturePath :the opacityTexturePath file path to create zfab /// @param _roughnessTexturePath :the roughnessTexturePath file path to create zfab /// @param _metalnessTexturePath :the metalnessTexturePath file path to create zfab /// @return zfab file creating success or failure return .. tabs:: .. code-tab:: python def CombineZfab(_filePath : str, _baseZfabPath : str, _targetZfabPath : str) -> None """ @ingroup FABRIC_API @brief Combining two zfab files into one @param _filePath: created filepath (.zfab) @param _baseZfabPath: the Path to the zfab file on which the physical properties will be based @param _targetZfabPath: the path to the zfab file on which the image will be based """ .. code-tab:: c++ CombineZfab(const std::string& _filePath, const std::string& _baseZfabPath, const std::string& _targetZfabPath) /// @ingroup FABRIC_API /// @brief Combining two zfab files into one /// @param _filePath: created filepath (.zfab) /// @param _baseZfabPath: the Path to the zfab file on which the physical properties will be based /// @param _targetZfabPath: the path to the zfab file on which the image will be based .. tabs:: .. code-tab:: python def GetRoughnessType(_index : int, _materialFace : int) -> int """ @ingroup FABRIC_API @brief Get Material RoughnessType @param _index: Fabric Index, _materialFace : Fabric Material Face Type (0 : Front , 1 : BACK , 2 : SIDE) @return Return fabric's material Roughness Type. ( 0 : Intensity, 1 : Map ) """ .. code-tab:: c++ int GetRoughnessType(int _index, int _materialFace) /// @ingroup FABRIC_API /// @brief Get Material RoughnessType /// @param _index: Fabric Index, _materialFace : Fabric Material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// @return Return fabric's material Roughness Type. ( 0 : Intensity, 1 : Map ) .. tabs:: .. code-tab:: python def GetRoughnessType(_colorwayIndex : int, _index : int, _materialFace : int) -> int """ @ingroup FABRIC_API @brief Get Material RoughnessType @param _colorwayIndex: target colorway index in the Colorway Editor @param _index: Fabric Index, _materialFace : Fabric Material Face Type (0 : Front , 1 : BACK , 2 : SIDE) @return Return fabric's material Roughness Type. ( 0 : Intensity, 1 : Map ) """ .. code-tab:: c++ int GetRoughnessType(unsigned int _colorwayIndex, int _index, int _materialFace) /// @ingroup FABRIC_API /// @brief Get Material RoughnessType /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _index: Fabric Index, _materialFace : Fabric Material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// @return Return fabric's material Roughness Type. ( 0 : Intensity, 1 : Map ) .. tabs:: .. code-tab:: python def SetRoughnessType(_index : int, _materialFace : int, _roughnessType : int) -> None """ @ingroup FABRIC_API @brief Set Current Fabric's material roughnessType @param _index: Fabric Index, _materialFace : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _roughnessType : roughnessType to be set ( 0 : Intensity, 1 : Map ) @return Fabric setting success or failure return """ .. code-tab:: c++ SetRoughnessType(int _index, int _materialFace, int _roughnessType) /// @ingroup FABRIC_API /// @brief Set Current Fabric's material roughnessType /// @param _index: Fabric Index, _materialFace : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _roughnessType : roughnessType to be set ( 0 : Intensity, 1 : Map ) /// @return Fabric setting success or failure return .. tabs:: .. code-tab:: python def SetRoughnessType(_colorwayIndex : int, _index : int, _materialFace : int, _roughnessType : int) -> None """ @ingroup FABRIC_API @brief Set Current Fabric's material roughnessType @param _colorwayIndex: target colorway index in the Colorway Editor @param _index: Fabric Index, _materialFace : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _roughnessType : roughnessType to be set ( 0 : Intensity, 1 : Map ) @return Fabric setting success or failure return """ .. code-tab:: c++ SetRoughnessType(unsigned int _colorwayIndex, int _index, int _materialFace, int _roughnessType) /// @ingroup FABRIC_API /// @brief Set Current Fabric's material roughnessType /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _index: Fabric Index, _materialFace : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _roughnessType : roughnessType to be set ( 0 : Intensity, 1 : Map ) /// @return Fabric setting success or failure return .. tabs:: .. code-tab:: python def GetRoughnessValueIntensity(_index : int, _face : int) -> int """ @ingroup FABRIC_API @brief Get fabric material's Roughness Intensity values. @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) @return Fabric material's Roughness Intensity values. """ .. code-tab:: c++ int GetRoughnessValueIntensity(int _index, int _face) /// @ingroup FABRIC_API /// @brief Get fabric material's Roughness Intensity values. /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// @return Fabric material's Roughness Intensity values. .. tabs:: .. code-tab:: python def GetRoughnessValueIntensity(_colorwayIndex : int, _index : int, _face : int) -> int """ @ingroup FABRIC_API @brief Get fabric material's Roughness Intensity values. @param _colorwayIndex: target colorway index in the Colorway Editor @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) @return Fabric material's Roughness Intensity values. """ .. code-tab:: c++ int GetRoughnessValueIntensity(unsigned int _colorwayIndex, int _index, int _face) /// @ingroup FABRIC_API /// @brief Get fabric material's Roughness Intensity values. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// @return Fabric material's Roughness Intensity values. .. tabs:: .. code-tab:: python def SetRoughnessValueIntensity(_fabricIndex : int, _face : int, _value : int) -> None """ @ingroup FABRIC_API @brief Set fabric material's Roughness Intensity values. @param _fabricIndex: Fabric Index _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) _value : roughness value @return Fabric material's Roughness Intensity values. """ .. code-tab:: c++ void SetRoughnessValueIntensity(int _fabricIndex, int _face, int _value) /// @ingroup FABRIC_API /// @brief Set fabric material's Roughness Intensity values. /// @param _fabricIndex: Fabric Index /// _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// _value : roughness value /// @return Fabric material's Roughness Intensity values. .. tabs:: .. code-tab:: python def SetRoughnessValueIntensity(_colorwayIndex : int, _fabricIndex : int, _face : int, _value : int) -> None """ @ingroup FABRIC_API @brief Set fabric material's Roughness Intensity values. @param _colorwayIndex: target colorway index in the Colorway Editor _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) _value : roughness value @return Fabric material's Rough @return Fabric material's Roughness Intensity values. """ .. code-tab:: c++ void SetRoughnessValueIntensity(unsigned int _colorwayIndex, int _fabricIndex, int _face, int _value) /// @ingroup FABRIC_API /// @brief Set fabric material's Roughness Intensity values. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info /// _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// _value : roughness value /// @return Fabric material's Rough /// @return Fabric material's Roughness Intensity values. .. tabs:: .. code-tab:: python def GetRoughnessValueMapIntensity(_index : int, _face : int) -> int """ @ingroup FABRIC_API @brief Get fabric material's map type roughness intensity values. @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) @return Fabric material's map type roughness Intensity values. """ .. code-tab:: c++ int GetRoughnessValueMapIntensity(int _index, int _face) /// @ingroup FABRIC_API /// @brief Get fabric material's map type roughness intensity values. /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// @return Fabric material's map type roughness Intensity values. .. tabs:: .. code-tab:: python def GetRoughnessValueMapIntensity(_colorwayIndex : int, _index : int, _face : int) -> int """ @ingroup FABRIC_API @brief Get fabric material's map type roughness intensity values. @param _colorwayIndex: target colorway index in the Colorway Editor @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) @return Fabric material's map type roughness Intensity values. """ .. code-tab:: c++ int GetRoughnessValueMapIntensity(unsigned int _colorwayIndex, int _index, int _face) /// @ingroup FABRIC_API /// @brief Get fabric material's map type roughness intensity values. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// @return Fabric material's map type roughness Intensity values. .. tabs:: .. code-tab:: python def SetRoughnessValueMapIntensity(_index : int, _face : int, _value : int) -> None """ @ingroup FABRIC_API @brief Set fabric material's map type roughness intensity values. @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _value : intensity value to be set. """ .. code-tab:: c++ SetRoughnessValueMapIntensity(int _index, int _face, int _value) /// @ingroup FABRIC_API /// @brief Set fabric material's map type roughness intensity values. /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _value : intensity value to be set. .. tabs:: .. code-tab:: python def SetRoughnessValueMapIntensity(_colorwayIndex : int, _index : int, _face : int, _value : int) -> None """ @ingroup FABRIC_API @brief Set fabric material's map type roughness intensity values. @param _colorwayIndex: target colorway index in the Colorway Editor @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _value : intensity value to be set. """ .. code-tab:: c++ SetRoughnessValueMapIntensity(unsigned int _colorwayIndex, int _index, int _face, int _value) /// @ingroup FABRIC_API /// @brief Set fabric material's map type roughness intensity values. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _value : intensity value to be set. .. tabs:: .. code-tab:: python def IsRoughnessValueMapInvert(_index : int, _face : int) -> bool """ @ingroup FABRIC_API @brief Return whether roughness map is inverted. @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) @Return whether roughness map is inverted. """ .. code-tab:: c++ bool IsRoughnessValueMapInvert(int _index, int _face) /// @ingroup FABRIC_API /// @brief Return whether roughness map is inverted. /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// @Return whether roughness map is inverted. .. tabs:: .. code-tab:: python def IsRoughnessValueMapInvert(_colorwayIndex : int, _index : int, _face : int) -> bool """ @ingroup FABRIC_API @brief Return whether roughness map is inverted. @param _colorwayIndex: target colorway index in the Colorway Editor @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) @Return whether roughness map is inverted. """ .. code-tab:: c++ bool IsRoughnessValueMapInvert(unsigned int _colorwayIndex, int _index, int _face) /// @ingroup FABRIC_API /// @brief Return whether roughness map is inverted. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE) /// @Return whether roughness map is inverted. .. tabs:: .. code-tab:: python def SetRoughnessValueMapInvert(_index : int, _face : int, _bInvert : bool) -> None """ @ingroup FABRIC_API @brief Set whether roughness map is inverted @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), bInvert : Whether roughness map is inverted. """ .. code-tab:: c++ bool SetRoughnessValueMapInvert(int _index, int _face, bool _bInvert) /// @ingroup FABRIC_API /// @brief Set whether roughness map is inverted /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), bInvert : Whether roughness map is inverted. .. tabs:: .. code-tab:: python def SetRoughnessValueMapInvert(_colorwayIndex : int, _index : int, _face : int, _bInvert : bool) -> None """ @ingroup FABRIC_API @brief Set whether roughness map is inverted @param _colorwayIndex: target colorway index in the Colorway Editor @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), bInvert : Whether roughness map is inverted. """ .. code-tab:: c++ bool SetRoughnessValueMapInvert(unsigned int _colorwayIndex, int _index, int _face, bool _bInvert) /// @ingroup FABRIC_API /// @brief Set whether roughness map is inverted /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), bInvert : Whether roughness map is inverted. .. tabs:: .. code-tab:: python def SetPBRMaterialDisplacementMap(_fabricIndex : int, _path : str) -> bool """ @ingroup FABRIC_API @brief Set fabric's displacement map using given image path. @param _fabricIndex: index of fabric @param _path: path of the image file @Return true if succeed, false othrewise. """ .. code-tab:: c++ bool SetFabricDisplacementMap(unsigned int _fabricIndex, const std::string &path) /// @ingroup FABRIC_API /// @brief Set fabric's displacement map using given image path. /// @param _fabricIndex: index of fabric /// @param _path: path of the image file /// @Return true if succeed, false othrewise. .. tabs:: .. code-tab:: python def SetPBRMaterialDisplacementMap(_colorwayIndex : int, _fabricIndex : int, _path : str) -> bool """ @ingroup FABRIC_API @brief Set fabric's displacement map using given image path. @param _colorwayIndex: index of colorway @param _fabricIndex: index of fabric @param _path: path of the image file @Return true if succeed, false othrewise. """ .. code-tab:: c++ bool SetFabricDisplacementMap(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::string& _path) /// @ingroup FABRIC_API /// @brief Set fabric's displacement map using given image path. /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: index of fabric /// @param _path: path of the image file /// @Return true if succeed, false othrewise. .. tabs:: .. code-tab:: python def GetPBRMaterialDisplacementMapValue(_fabricIndex : int) -> tuple[float, float, float, float, bool] """ @ingroup FABRIC_API @brief Get fabric's displacement map values. @param _fabricIndex: index of fabric @Return [Amount, Shift, Clipping, Particle Distance, Keep(bool)] tuple if succeed, [0, 0, 0, 0, false] otherwise. """ .. code-tab:: c++ std::tuple GetPBRMaterialDisplacementMapValue(unsigned int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get fabric's displacement map values. /// @param _fabricIndex: index of fabric /// @Return [Amount, Shift, Clipping, Particle Distance, Keep(bool)] tuple if succeed, [0, 0, 0, 0, false] otherwise. .. tabs:: .. code-tab:: python def GetPBRMaterialDisplacementMapValue(_colorwayIndex : int, _fabricIndex : int) -> tuple[float, float, float, float, bool] """ @ingroup FABRIC_API @brief Get fabric's displacement map values. @param _colorwayIndex: _colorwayIndex: index of colorway @param _fabricIndex: index of fabric @Return [Amount, Shift, Clipping, Particle Distance, Keep(bool)] tuple if succeed, [0, 0, 0, 0, false] otherwise. """ .. code-tab:: c++ std::tuple GetPBRMaterialDisplacementMapValue(unsigned int _colorwayIndex, unsigned int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get fabric's displacement map values. /// @param _colorwayIndex: _colorwayIndex: index of colorway /// @param _fabricIndex: index of fabric /// @Return [Amount, Shift, Clipping, Particle Distance, Keep(bool)] tuple if succeed, [0, 0, 0, 0, false] otherwise. .. tabs:: .. code-tab:: python def SetPBRMaterialDisplacementMapValue(_fabricIndex : int, _amount : float, _shift : float, _clipping : float, _particleDist : float, _keep : bool) -> bool """ @ingroup FABRIC_API @brief Set fabric's displacement map values. @param _fabricIndex: index of fabric @param _amount: Amount value to be set (mm) @param _shift: Shift value to be set (mm) @param _clipping: Clipping value to be set (mm) @param _particleDist: Particle distance value to be set (mm) @param _keep: Keep Continuity value to be set @Return true if succeed, false othrewise. """ .. code-tab:: c++ bool SetPBRMaterialDisplacementMapValue(unsigned int _fabricIndex, float _amount, float _shift, float _clipping, float _particleDist, bool _keep) /// @ingroup FABRIC_API /// @brief Set fabric's displacement map values. /// @param _fabricIndex: index of fabric /// @param _amount: Amount value to be set (mm) /// @param _shift: Shift value to be set (mm) /// @param _clipping: Clipping value to be set (mm) /// @param _particleDist: Particle distance value to be set (mm) /// @param _keep: Keep Continuity value to be set /// @Return true if succeed, false othrewise. .. tabs:: .. code-tab:: python def SetPBRMaterialDisplacementMapValue(_colorwayIndex : int, _fabricIndex : int, _amount : float, _shift : float, _clipping : float, _particleDist : float, _keep : bool) -> bool """ @ingroup FABRIC_API @brief Set fabric's displacement map values. @param _colorwayIndex: index of colorway @param _fabricIndex: index of fabric @param _amount: Amount value to be set (mm) @param _shift: Shift value to be set (mm) @param _clipping: Clipping value to be set (mm) @param _particleDist: Particle distance value to be set (mm) @param _keep: Keep Continuity value to be set @Return true if succeed, false othrewise. """ .. code-tab:: c++ bool SetPBRMaterialDisplacementMapValue(unsigned int _colorwayIndex, unsigned int _fabricIndex, float _amount, float _shift, float _clipping, float _particleDist, bool _keep) /// @ingroup FABRIC_API /// @brief Set fabric's displacement map values. /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: index of fabric /// @param _amount: Amount value to be set (mm) /// @param _shift: Shift value to be set (mm) /// @param _clipping: Clipping value to be set (mm) /// @param _particleDist: Particle distance value to be set (mm) /// @param _keep: Keep Continuity value to be set /// @Return true if succeed, false othrewise. .. tabs:: .. code-tab:: python def GetReflectionRoughness(_fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get reflection roughness value @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return reflection roughness value """ .. code-tab:: c++ GetReflectionRoughness(int _fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get reflection roughness value /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return reflection roughness value .. tabs:: .. code-tab:: python def GetReflectionRoughness(_colorwayIndex : int, fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get reflection roughness value @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return reflection roughness value """ .. code-tab:: c++ GetReflectionRoughness(unsigned int _colorwayIndex, int fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get reflection roughness value /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return reflection roughness value .. tabs:: .. code-tab:: python def SetReflectionRoughness(_fabricIndex : int, _materialFace : int, _reflectionRoughness : float) -> None """ @ingroup FABRIC_API @brief Set reflection roughness value @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _reflectionRoughness roughness value @return void """ .. code-tab:: c++ SetReflectionRoughness(int _fabricIndex, int _materialFace, float _reflectionRoughness) /// @ingroup FABRIC_API /// @brief Set reflection roughness value /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _reflectionRoughness roughness value /// @return void .. tabs:: .. code-tab:: python def SetReflectionRoughness(_colorwayIndex : int, fabricIndex : int, _materialFace : int, _reflectionRoughness : float) -> None """ @ingroup FABRIC_API @brief Set reflection roughness value @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _reflectionRoughness roughness value @return void """ .. code-tab:: c++ SetReflectionRoughness(unsigned int _colorwayIndex, int fabricIndex, int _materialFace, float _reflectionRoughness) /// @ingroup FABRIC_API /// @brief Set reflection roughness value /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _reflectionRoughness roughness value /// @return void .. tabs:: .. code-tab:: python def GetReflectionIntensity(_fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get reflection intensity @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return reflection intensity value """ .. code-tab:: c++ GetReflectionIntensity(int _fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get reflection intensity /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return reflection intensity value .. tabs:: .. code-tab:: python def GetReflectionIntensity(_colorwayIndex : int, fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get reflection intensity @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return reflection intensity value """ .. code-tab:: c++ GetReflectionIntensity(unsigned int _colorwayIndex, int fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get reflection intensity /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return reflection intensity value .. tabs:: .. code-tab:: python def SetReflectionIntensity(_fabricIndex : int, _materialFace : int, _reflectionIntensity : float) -> None """ @ingroup FABRIC_API @brief Set reflection intensity @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _reflectionIntensity: reflection intensity value @return void """ .. code-tab:: c++ SetReflectionIntensity(int _fabricIndex, int _materialFace, float _reflectionIntensity) /// @ingroup FABRIC_API /// @brief Set reflection intensity /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _reflectionIntensity: reflection intensity value /// @return void .. tabs:: .. code-tab:: python def SetReflectionIntensity(_colorwayIndex : int, fabricIndex : int, _materialFace : int, _reflectionIntensity : float) -> None """ @ingroup FABRIC_API @brief Set reflection intensity @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _reflectionIntensity: reflection intensity value @return void """ .. code-tab:: c++ SetReflectionIntensity(unsigned int _colorwayIndex, int fabricIndex, int _materialFace, float _reflectionIntensity) /// @ingroup FABRIC_API /// @brief Set reflection intensity /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _reflectionIntensity: reflection intensity value /// @return void .. tabs:: .. code-tab:: python def GetMetalness(_fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get metalness @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return metalness value """ .. code-tab:: c++ GetMetalness(int _fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get metalness /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return metalness value .. tabs:: .. code-tab:: python def GetMetalness(_colorwayIndex : int, fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get metalness @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return metalness value """ .. code-tab:: c++ GetMetalness(unsigned int _colorwayIndex, int fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get metalness /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return metalness value .. tabs:: .. code-tab:: python def SetMetalness(_fabricIndex : int, _materialFace : int, _metalness : float) -> None """ @ingroup FABRIC_API @brief Set metalness @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _metalness: metalness value @return void """ .. code-tab:: c++ SetMetalness(int _fabricIndex, int _materialFace, float _metalness) /// @ingroup FABRIC_API /// @brief Set metalness /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _metalness: metalness value /// @return void .. tabs:: .. code-tab:: python def SetMetalness(_colorwayIndex : int, fabricIndex : int, _materialFace : int, _metalness : float) -> None """ @ingroup FABRIC_API @brief Set metalness @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _metalness: metalness value @return void """ .. code-tab:: c++ SetMetalness(unsigned int _colorwayIndex, int fabricIndex, int _materialFace, float _metalness) /// @ingroup FABRIC_API /// @brief Set metalness /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _metalness: metalness value /// @return void .. tabs:: .. code-tab:: python def GetNormalMapIntensity(_fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get normal map intensity in percent @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return normal map intensity value """ .. code-tab:: c++ GetNormalMapIntensity(int _fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get normal map intensity in percent /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return normal map intensity value .. tabs:: .. code-tab:: python def GetNormalMapIntensity(_colorwayIndex : int, fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get normal map intensity in percent @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return normal map intensity value """ .. code-tab:: c++ GetNormalMapIntensity(unsigned int _colorwayIndex, int fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get normal map intensity in percent /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return normal map intensity value .. tabs:: .. code-tab:: python def SetNormalMapIntensity(_fabricIndex : int, _materialFace : int, _normalMapIntensity : float) -> None """ @ingroup FABRIC_API @brief Set normal map intensity in percent @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _normalMapIntensity: normal map intensity value @return void """ .. code-tab:: c++ SetNormalMapIntensity(int _fabricIndex, int _materialFace, float _normalMapIntensity) /// @ingroup FABRIC_API /// @brief Set normal map intensity in percent /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _normalMapIntensity: normal map intensity value /// @return void .. tabs:: .. code-tab:: python def SetNormalMapIntensity(_colorwayIndex : int, fabricIndex : int, _materialFace : int, _normalMapIntensity : float) -> None """ @ingroup FABRIC_API @brief Set normal map intensity in percent @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _normalMapIntensity: normal map intensity value @return void """ .. code-tab:: c++ SetNormalMapIntensity(unsigned int _colorwayIndex, int fabricIndex, int _materialFace, float _normalMapIntensity) /// @ingroup FABRIC_API /// @brief Set normal map intensity in percent /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _normalMapIntensity: normal map intensity value /// @return void .. tabs:: .. code-tab:: python def GetMaterialType(_fabricIndex : int, _materialFace : int) -> int """ @ingroup FABRIC_API @brief Get material type @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return material type """ .. code-tab:: c++ GetMaterialType(int _fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get material type /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return material type .. tabs:: .. code-tab:: python def GetMaterialType(_colorwayIndex : int, _fabricIndex : int, _materialFace : int) -> int """ @ingroup FABRIC_API @brief Get material type @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the Colorway Editor @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return material type """ .. code-tab:: c++ GetMaterialType(int _colorwayIndex, int _fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get material type /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return material type .. tabs:: .. code-tab:: python def SetMaterialType(_fabricIndex : int, _materialFace : int, _materialType : int) -> None """ @ingroup FABRIC_API @brief Set material type @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _materialType: material type value """ .. code-tab:: c++ SetMaterialType(int _fabricIndex, int _materialFace, int _materialType) /// @ingroup FABRIC_API /// @brief Set material type /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _materialType: material type value .. tabs:: .. code-tab:: python def SetMaterialType(_colorwayIndex : int, _fabricIndex : int, _materialFace : int, _materialType : int) -> None """ @ingroup FABRIC_API @brief Set material type @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the Colorway Editor @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _materialType: material type value """ .. code-tab:: c++ SetMaterialType(int _colorwayIndex, int _fabricIndex, int _materialFace, int _materialType) /// @ingroup FABRIC_API /// @brief Set material type /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _materialType: material type value .. tabs:: .. code-tab:: python def GetOpacityIntensity(_fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get opacity intensity in percent @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return opacity intensity value """ .. code-tab:: c++ GetOpacityIntensity(int _fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get opacity intensity in percent /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return opacity intensity value .. tabs:: .. code-tab:: python def GetOpacityIntensity(_colorwayIndex : int, _fabricIndex : int, _materialFace : int) -> float """ @ingroup FABRIC_API @brief Get opacity intensity in percent @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the Colorway Editor @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @return opacity intensity value """ .. code-tab:: c++ GetOpacityIntensity(int _colorwayIndex, int _fabricIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get opacity intensity in percent /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @return opacity intensity value .. tabs:: .. code-tab:: python def SetOpacityIntensity(_fabricIndex : int, _materialFace : int, _opacityIntensity : float) -> None """ @ingroup FABRIC_API @brief Set opacity intensity in percent @param _fabricIndex: the target fabric index in the object browser @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _opacityIntensity: opacity intensity value """ .. code-tab:: c++ SetOpacityIntensity(int _fabricIndex, int _materialFace, float _opacityIntensity) /// @ingroup FABRIC_API /// @brief Set opacity intensity in percent /// @param _fabricIndex: the target fabric index in the object browser /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _opacityIntensity: opacity intensity value .. tabs:: .. code-tab:: python def SetOpacityIntensity(_colorwayIndex : int, _fabricIndex : int, _materialFace : int, _opacityIntensity : float) -> None """ @ingroup FABRIC_API @brief Set opacity intensity in percent @param _colorwayIndex: index of colorway @param _fabricIndex: the target fabric index in the Colorway Editor @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _opacityIntensity: opacity intensity value @return void """ .. code-tab:: c++ SetOpacityIntensity(int _colorwayIndex, int _fabricIndex, int _materialFace, float _opacityIntensity) /// @ingroup FABRIC_API /// @brief Set opacity intensity in percent /// @param _colorwayIndex: index of colorway /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _opacityIntensity: opacity intensity value /// @return void .. tabs:: .. code-tab:: python def GetBaseTextureMapImageFilePath() -> str """ @ingroup FABRIC_API @brief Get base texture map image file path of current selected fabric @return image file path string """ .. code-tab:: c++ GetBaseTextureMapImageFilePath() /// @ingroup FABRIC_API /// @brief Get base texture map image file path of current selected fabric /// @return image file path string .. tabs:: .. code-tab:: python def GetNormalMapImageFilePath() -> str """ @ingroup FABRIC_API @brief Get normal map image file path of current selected fabric @return image file path string """ .. code-tab:: c++ GetNormalMapImageFilePath() /// @ingroup FABRIC_API /// @brief Get normal map image file path of current selected fabric /// @return image file path string .. tabs:: .. code-tab:: python def GetDisplacementMapImageFilePath() -> str """ @ingroup FABRIC_API @brief Get displacement map image file path of current selected fabric @return image file path string """ .. code-tab:: c++ GetDisplacementMapImageFilePath() /// @ingroup FABRIC_API /// @brief Get displacement map image file path of current selected fabric /// @return image file path string .. tabs:: .. code-tab:: python def GetOpacityMapImageFilePath() -> str """ @ingroup FABRIC_API @brief Get opacity map image file path of current selected fabric @return image file path string """ .. code-tab:: c++ GetOpacityMapImageFilePath() /// @ingroup FABRIC_API /// @brief Get opacity map image file path of current selected fabric /// @return image file path string .. tabs:: .. code-tab:: python def GetRoughnessMapImageFilePath() -> str """ @ingroup FABRIC_API @brief Get roughness map image file path of current selected fabric @return image file path string """ .. code-tab:: c++ GetRoughnessMapImageFilePath() /// @ingroup FABRIC_API /// @brief Get roughness map image file path of current selected fabric /// @return image file path string .. tabs:: .. code-tab:: python def GetMetalnessMapImageFilePath() -> str """ @ingroup FABRIC_API @brief Get metalness map image file path of current selected fabric @return image file path string """ .. code-tab:: c++ GetMetalnessMapImageFilePath() /// @ingroup FABRIC_API /// @brief Get metalness map image file path of current selected fabric /// @return image file path string .. tabs:: .. code-tab:: python def GetBaseTextureMapImageFilePathW() -> str """ @ingroup FABRIC_API @brief Get base texture map image file path of current selected fabric @return image file path wstring """ .. code-tab:: c++ GetBaseTextureMapImageFilePathW() /// @ingroup FABRIC_API /// @brief Get base texture map image file path of current selected fabric /// @return image file path wstring .. tabs:: .. code-tab:: python def GetNormalMapImageFilePathW() -> str """ @ingroup FABRIC_API @brief Get normal map image file path of current selected fabric @return image file path wstring """ .. code-tab:: c++ GetNormalMapImageFilePathW() /// @ingroup FABRIC_API /// @brief Get normal map image file path of current selected fabric /// @return image file path wstring .. tabs:: .. code-tab:: python def GetDisplacementMapImageFilePathW() -> str """ @ingroup FABRIC_API @brief Get displacement map image file path of current selected fabric @return image file path wstring """ .. code-tab:: c++ GetDisplacementMapImageFilePathW() /// @ingroup FABRIC_API /// @brief Get displacement map image file path of current selected fabric /// @return image file path wstring .. tabs:: .. code-tab:: python def GetOpacityMapImageFilePathW() -> str """ @ingroup FABRIC_API @brief Get opacity map image file path of current selected fabric @return image file path wstring """ .. code-tab:: c++ GetOpacityMapImageFilePathW() /// @ingroup FABRIC_API /// @brief Get opacity map image file path of current selected fabric /// @return image file path wstring .. tabs:: .. code-tab:: python def GetRoughnessMapImageFilePathW() -> str """ @ingroup FABRIC_API @brief Get roughness map image file path of current selected fabric @return image file path wstring """ .. code-tab:: c++ GetRoughnessMapImageFilePathW() /// @ingroup FABRIC_API /// @brief Get roughness map image file path of current selected fabric /// @return image file path wstring .. tabs:: .. code-tab:: python def GetMetalnessMapImageFilePathW() -> str """ @ingroup FABRIC_API @brief Get metalness map image file path of current selected fabric @return image file path wstring """ .. code-tab:: c++ GetMetalnessMapImageFilePathW() /// @ingroup FABRIC_API /// @brief Get metalness map image file path of current selected fabric /// @return image file path wstring .. tabs:: .. code-tab:: python def GetBaseTextureMapImageFilePath(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get base texture map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path string """ .. code-tab:: c++ GetBaseTextureMapImageFilePath(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get base texture map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path string .. tabs:: .. code-tab:: python def GetBaseTextureMapImageFilePath(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get base texture map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path string """ .. code-tab:: c++ GetBaseTextureMapImageFilePath(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get base texture map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path string .. tabs:: .. code-tab:: python def GetNormalMapImageFilePath(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get normal map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path string """ .. code-tab:: c++ GetNormalMapImageFilePath(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get normal map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path string .. tabs:: .. code-tab:: python def GetNormalMapImageFilePath(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get normal map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path string """ .. code-tab:: c++ GetNormalMapImageFilePath(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get normal map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path string .. tabs:: .. code-tab:: python def GetDisplacementMapImageFilePath(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get displacement map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path string """ .. code-tab:: c++ GetDisplacementMapImageFilePath(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get displacement map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path string .. tabs:: .. code-tab:: python def GetDisplacementMapImageFilePath(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get displacement map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path string """ .. code-tab:: c++ GetDisplacementMapImageFilePath(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get displacement map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path string .. tabs:: .. code-tab:: python def GetOpacityMapImageFilePath(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get opacity map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path string """ .. code-tab:: c++ GetOpacityMapImageFilePath(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get opacity map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path string .. tabs:: .. code-tab:: python def GetOpacityMapImageFilePath(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get opacity map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path string """ .. code-tab:: c++ GetOpacityMapImageFilePath(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get opacity map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path string .. tabs:: .. code-tab:: python def GetRoughnessMapImageFilePath(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get roughness map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path string """ .. code-tab:: c++ GetRoughnessMapImageFilePath(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get roughness map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path string .. tabs:: .. code-tab:: python def GetRoughnessMapImageFilePath(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get roughness map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path string """ .. code-tab:: c++ GetRoughnessMapImageFilePath(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get roughness map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path string .. tabs:: .. code-tab:: python def GetMetalnessMapImageFilePath(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get metalness map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path string """ .. code-tab:: c++ GetMetalnessMapImageFilePath(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get metalness map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path string .. tabs:: .. code-tab:: python def GetMetalnessMapImageFilePath(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get metalness map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path string """ .. code-tab:: c++ GetMetalnessMapImageFilePath(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get metalness map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path string .. tabs:: .. code-tab:: python def GetBaseTextureMapImageFilePathW(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get base texture map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path wstring """ .. code-tab:: c++ GetBaseTextureMapImageFilePathW(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get base texture map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path wstring .. tabs:: .. code-tab:: python def GetBaseTextureMapImageFilePathW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get base texture map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path wstring """ .. code-tab:: c++ GetBaseTextureMapImageFilePathW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get base texture map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path wstring .. tabs:: .. code-tab:: python def GetNormalMapImageFilePathW(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get normal map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path wstring """ .. code-tab:: c++ GetNormalMapImageFilePathW(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get normal map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path wstring .. tabs:: .. code-tab:: python def GetNormalMapImageFilePathW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get normal map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path wstring """ .. code-tab:: c++ GetNormalMapImageFilePathW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get normal map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path wstring .. tabs:: .. code-tab:: python def GetDisplacementMapImageFilePathW(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get displacement map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path wstring """ .. code-tab:: c++ GetDisplacementMapImageFilePathW(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get displacement map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path wstring .. tabs:: .. code-tab:: python def GetDisplacementMapImageFilePathW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get displacement map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path wstring """ .. code-tab:: c++ GetDisplacementMapImageFilePathW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get displacement map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path wstring .. tabs:: .. code-tab:: python def GetOpacityMapImageFilePathW(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get opacity map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path wstring """ .. code-tab:: c++ GetOpacityMapImageFilePathW(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get opacity map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path wstring .. tabs:: .. code-tab:: python def GetOpacityMapImageFilePathW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get opacity map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path wstring """ .. code-tab:: c++ GetOpacityMapImageFilePathW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get opacity map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path wstring .. tabs:: .. code-tab:: python def GetRoughnessMapImageFilePathW(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get roughness map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path wstring """ .. code-tab:: c++ GetRoughnessMapImageFilePathW(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get roughness map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path wstring .. tabs:: .. code-tab:: python def GetRoughnessMapImageFilePathW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get roughness map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path wstring """ .. code-tab:: c++ GetRoughnessMapImageFilePathW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get roughness map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path wstring .. tabs:: .. code-tab:: python def GetMetalnessMapImageFilePathW(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get metalness map image file path of specified fabric @param _fabricIndex: the target fabric index in the object browser @return image file path wstring """ .. code-tab:: c++ GetMetalnessMapImageFilePathW(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get metalness map image file path of specified fabric /// @param _fabricIndex: the target fabric index in the object browser /// @return image file path wstring .. tabs:: .. code-tab:: python def GetMetalnessMapImageFilePathW(_colorwayIndex : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get metalness map image file path of specified fabric in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return image file path wstring """ .. code-tab:: c++ GetMetalnessMapImageFilePathW(int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get metalness map image file path of specified fabric in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return image file path wstring .. tabs:: .. code-tab:: python def SetBaseTextureMapImageGivenFilePath(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set base texture map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetBaseTextureMapImageGivenFilePath(const std::string _imageFilePath) /// @ingroup FABRIC_API /// @brief Set base texture map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetNormalMapImageGivenFilePath(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set normal map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetNormalMapImageGivenFilePath(const std::string _imageFilePath) /// @ingroup FABRIC_API /// @brief Set normal map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetDisplacementMapImageGivenFilePath(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set displacement map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetDisplacementMapImageGivenFilePath(const std::string _imageFilePath) /// @ingroup FABRIC_API /// @brief Set displacement map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetOpacityMapImageGivenFilePath(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set opacity map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetOpacityMapImageGivenFilePath(const std::string _imageFilePath) /// @ingroup FABRIC_API /// @brief Set opacity map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetRoughnessMapImageGivenFilePath(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set roughness map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetRoughnessMapImageGivenFilePath(const std::string _imageFilePath) /// @ingroup FABRIC_API /// @brief Set roughness map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetMetalnessMapImageGivenFilePath(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set metalness map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetMetalnessMapImageGivenFilePath(const std::string _imageFilePath) /// @ingroup FABRIC_API /// @brief Set metalness map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetBaseTextureMapImageGivenFilePathW(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set base texture map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetBaseTextureMapImageGivenFilePathW(const std::wstring _imageFilePath) /// @ingroup FABRIC_API /// @brief Set base texture map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetNormalMapImageGivenFilePathW(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set normal map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetNormalMapImageGivenFilePathW(const std::wstring _imageFilePath) /// @ingroup FABRIC_API /// @brief Set normal map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetDisplacementMapImageGivenFilePathW(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set displacement map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetDisplacementMapImageGivenFilePathW(const std::wstring _imageFilePath) /// @ingroup FABRIC_API /// @brief Set displacement map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetOpacityMapImageGivenFilePathW(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set opacity map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetOpacityMapImageGivenFilePathW(const std::wstring _imageFilePath) /// @ingroup FABRIC_API /// @brief Set opacity map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetRoughnessMapImageGivenFilePathW(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set roughness map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetRoughnessMapImageGivenFilePathW(const std::wstring _imageFilePath) /// @ingroup FABRIC_API /// @brief Set roughness map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetMetalnessMapImageGivenFilePathW(_imageFilePath : str) -> None """ @ingroup FABRIC_API @brief Set metalness map image for current selected fabric @param _imageFilePath: image file path to set @return void """ .. code-tab:: c++ SetMetalnessMapImageGivenFilePathW(const std::wstring _imageFilePath) /// @ingroup FABRIC_API /// @brief Set metalness map image for current selected fabric /// @param _imageFilePath: image file path to set /// @return void .. tabs:: .. code-tab:: python def SetBaseTextureMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set base texture map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetBaseTextureMapImageGivenFilePath(const std::string _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set base texture map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetBaseTextureMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set base texture map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetBaseTextureMapImageGivenFilePath(const std::string _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set base texture map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetNormalMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set normal map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetNormalMapImageGivenFilePath(const std::string _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set normal map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetNormalMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set normal map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetNormalMapImageGivenFilePath(const std::string _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set normal map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetDisplacementMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set displacement map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetDisplacementMapImageGivenFilePath(const std::string _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set displacement map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetDisplacementMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set displacement map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetDisplacementMapImageGivenFilePath(const std::string _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set displacement map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetOpacityMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set opacity map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetOpacityMapImageGivenFilePath(const std::string _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set opacity map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetOpacityMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set opacity map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetOpacityMapImageGivenFilePath(const std::string _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set opacity map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetRoughnessMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set roughness map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetRoughnessMapImageGivenFilePath(const std::string _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set roughness map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetRoughnessMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set roughness map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetRoughnessMapImageGivenFilePath(const std::string _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set roughness map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetMetalnessMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set metalness map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetMetalnessMapImageGivenFilePath(const std::string _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set metalness map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetMetalnessMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set metalness map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetMetalnessMapImageGivenFilePath(const std::string _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set metalness map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetBaseTextureMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set base texture map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetBaseTextureMapImageGivenFilePathW(const std::wstring _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set base texture map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetBaseTextureMapImageGivenFilePathW(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set base texture map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetBaseTextureMapImageGivenFilePathW(const std::wstring _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set base texture map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetNormalMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set normal map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetNormalMapImageGivenFilePathW(const std::wstring _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set normal map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetNormalMapImageGivenFilePathW(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set normal map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetNormalMapImageGivenFilePathW(const std::wstring _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set normal map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetDisplacementMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set displacement map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetDisplacementMapImageGivenFilePathW(const std::wstring _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set displacement map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetDisplacementMapImageGivenFilePathW(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set displacement map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetDisplacementMapImageGivenFilePathW(const std::wstring _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set displacement map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetOpacityMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set opacity map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetOpacityMapImageGivenFilePathW(const std::wstring _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set opacity map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetOpacityMapImageGivenFilePathW(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set opacity map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetOpacityMapImageGivenFilePathW(const std::wstring _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set opacity map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetRoughnessMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set roughness map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetRoughnessMapImageGivenFilePathW(const std::wstring _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set roughness map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetRoughnessMapImageGivenFilePathW(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set roughness map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetRoughnessMapImageGivenFilePathW(const std::wstring _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set roughness map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def SetMetalnessMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set metalness map image for specified fabric @param _imageFilePath: image file path to set @param _fabricIndex: the target fabric index in the object browser @return void """ .. code-tab:: c++ SetMetalnessMapImageGivenFilePathW(const std::wstring _imageFilePath, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set metalness map image for specified fabric /// @param _imageFilePath: image file path to set /// @param _fabricIndex: the target fabric index in the object browser /// @return void .. tabs:: .. code-tab:: python def SetMetalnessMapImageGivenFilePathW(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int) -> None """ @ingroup FABRIC_API @brief Set metalness map image for specified fabric in colorway @param _imageFilePath: image file path to set @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @return void """ .. code-tab:: c++ SetMetalnessMapImageGivenFilePathW(const std::wstring _imageFilePath, int _colorwayIndex, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Set metalness map image for specified fabric in colorway /// @param _imageFilePath: image file path to set /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @return void .. tabs:: .. code-tab:: python def GetBaseTextureMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Get base texture map image file path of specified fabric and material face in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return image file path string. Returns empty string if parameters are invalid. """ .. code-tab:: c++ GetBaseTextureMapImageFilePath(int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get base texture map image file path of specified fabric and material face in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return image file path string. Returns empty string if parameters are invalid. .. tabs:: .. code-tab:: python def GetNormalMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Get normal map image file path of specified fabric and material face in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return image file path string. Returns empty string if parameters are invalid. """ .. code-tab:: c++ GetNormalMapImageFilePath(int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get normal map image file path of specified fabric and material face in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return image file path string. Returns empty string if parameters are invalid. .. tabs:: .. code-tab:: python def GetDisplacementMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Get displacement map image file path of specified fabric and material face in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return image file path string. Returns empty string if parameters are invalid. """ .. code-tab:: c++ GetDisplacementMapImageFilePath(int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get displacement map image file path of specified fabric and material face in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return image file path string. Returns empty string if parameters are invalid. .. tabs:: .. code-tab:: python def GetOpacityMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Get opacity map image file path of specified fabric and material face in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return image file path string. Returns empty string if parameters are invalid. """ .. code-tab:: c++ GetOpacityMapImageFilePath(int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get opacity map image file path of specified fabric and material face in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return image file path string. Returns empty string if parameters are invalid. .. tabs:: .. code-tab:: python def GetRoughnessMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Get roughness map image file path of specified fabric and material face in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return image file path string. Returns empty string if parameters are invalid. """ .. code-tab:: c++ GetRoughnessMapImageFilePath(int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get roughness map image file path of specified fabric and material face in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return image file path string. Returns empty string if parameters are invalid. .. tabs:: .. code-tab:: python def GetMetalnessMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Get metalness map image file path of specified fabric and material face in colorway @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return image file path string. Returns empty string if parameters are invalid. """ .. code-tab:: c++ GetMetalnessMapImageFilePath(int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Get metalness map image file path of specified fabric and material face in colorway /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: target style chip index used to resolve exact linked fabric/colorway applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return image file path string. Returns empty string if parameters are invalid. .. tabs:: .. code-tab:: python def SetBaseTextureMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Set base texture map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return Names of other colorways that share this fabric, comma-separated. Empty string if none. """ .. code-tab:: c++ SetBaseTextureMapImageGivenFilePath(const std::string& _imageFilePath, int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Set base texture map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. /// @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return Names of other colorways that share this fabric, comma-separated. Empty string if none. .. tabs:: .. code-tab:: python def SetNormalMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Set normal map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return Names of other colorways that share this fabric, comma-separated. Empty string if none. """ .. code-tab:: c++ SetNormalMapImageGivenFilePath(const std::string& _imageFilePath, int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Set normal map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. /// @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return Names of other colorways that share this fabric, comma-separated. Empty string if none. .. tabs:: .. code-tab:: python def SetDisplacementMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Set displacement map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return Names of other colorways that share this fabric, comma-separated. Empty string if none. """ .. code-tab:: c++ SetDisplacementMapImageGivenFilePath(const std::string& _imageFilePath, int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Set displacement map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. /// @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return Names of other colorways that share this fabric, comma-separated. Empty string if none. .. tabs:: .. code-tab:: python def SetOpacityMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Set opacity map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return Names of other colorways that share this fabric, comma-separated. Empty string if none. """ .. code-tab:: c++ SetOpacityMapImageGivenFilePath(const std::string& _imageFilePath, int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Set opacity map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. /// @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return Names of other colorways that share this fabric, comma-separated. Empty string if none. .. tabs:: .. code-tab:: python def SetRoughnessMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Set roughness map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return Names of other colorways that share this fabric, comma-separated. Empty string if none. """ .. code-tab:: c++ SetRoughnessMapImageGivenFilePath(const std::string& _imageFilePath, int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Set roughness map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. /// @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return Names of other colorways that share this fabric, comma-separated. Empty string if none. .. tabs:: .. code-tab:: python def SetMetalnessMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str """ @ingroup FABRIC_API @brief Set metalness map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. @param _colorwayIndex: target colorway index in the Colorway Editor @param _fabricIndex: the target fabric index in the Colorway Editor @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored @param _materialFace: target material face (0: Front, 1: Back, 2: Side) @return Names of other colorways that share this fabric, comma-separated. Empty string if none. """ .. code-tab:: c++ SetMetalnessMapImageGivenFilePath(const std::string& _imageFilePath, int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _materialFace) /// @ingroup FABRIC_API /// @brief Set metalness map image for specified fabric and material face in colorway. If an empty string is passed, the existing texture will be removed. /// @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face. /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _styleChipIndex: the target style chip index in the Colorway Editor applicable if _colorwayIndex = -1, otherwise can be ignored /// @param _materialFace: target material face (0: Front, 1: Back, 2: Side) /// @return Names of other colorways that share this fabric, comma-separated. Empty string if none. .. tabs:: .. code-tab:: python def ExportGLTFAsFabric() -> list[str] """ @brief Export gltf/glb which contains the fabric data selected in the object browser @return Output file path;output files will be created in CLO temporary folder. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGLTFAsFabric() /// @brief Export gltf/glb which contains the fabric data selected in the object browser /// @return Output file path;output files will be created in CLO temporary folder. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGLTFAsFabric(_filePath : str) -> list[str] """ @ingroup FABRIC_API @brief Export gltf/glb which contains the fabric data selected in the object browser @param _filePath: output file path @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGLTFAsFabric(const string& _filePath) /// @ingroup FABRIC_API /// @brief Export gltf/glb which contains the fabric data selected in the object browser /// @param _filePath: output file path /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGLTFAsFabric(_filePath : str, index : int) -> list[str] """ @ingroup FABRIC_API @brief Export gltf/glb which contains the fabric data in the index of the object browser @param _filePath: output file path @param index: target fabric index on the object browser to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGLTFAsFabric(const string& _filePath, int index) /// @ingroup FABRIC_API /// @brief Export gltf/glb which contains the fabric data in the index of the object browser /// @param _filePath: output file path /// @param index: target fabric index on the object browser to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ExportGLTFAsFabricW(_filePath : str, index : int) -> list[str] """ @ingroup FABRIC_API @brief Export gltf/glb file which contains the fabric data in the index of the object browser @param _filePath: output file path @param index: target fabric index on the object browser to export @return Output file path. If an error occurs, return empty string. """ .. code-tab:: c++ ExportGLTFAsFabricW(const wstring& _filePath, int index) /// @ingroup FABRIC_API /// @brief Export gltf/glb file which contains the fabric data in the index of the object browser /// @param _filePath: output file path /// @param index: target fabric index on the object browser to export /// @return Output file path. If an error occurs, return empty string. .. tabs:: .. code-tab:: python def ImportGLTFAsFabric(_filePath : str) -> list[int] """ @ingroup FABRIC_API @brief Import gltf/glb as Fabrics into the Object Browser @param _filePath: input file path @return the index list of added fabric in object browser for the current project """ .. code-tab:: c++ ImportGLTFAsFabric(const string& _filePath) /// @ingroup FABRIC_API /// @brief Import gltf/glb as Fabrics into the Object Browser /// @param _filePath: input file path /// @return the index list of added fabric in object browser for the current project .. tabs:: .. code-tab:: python def ImportGLTFAsFabric(_filePath : str, _index : int) -> int """ @ingroup FABRIC_API @brief Import gltf/glb as a Fabric into the Object Browser @param _filePath: input file path @param _index: target material index on the gltf/glb file to import as a fabric @return the index of added fabric in object browser for the current project """ .. code-tab:: c++ ImportGLTFAsFabric(const string& _filePath, int index) /// @ingroup FABRIC_API /// @brief Import gltf/glb as a Fabric into the Object Browser /// @param _filePath: input file path /// @param _index: target material index on the gltf/glb file to import as a fabric /// @return the index of added fabric in object browser for the current project .. tabs:: .. code-tab:: python def ImportGLTFAsFabricW(_filePath : str) -> list[int] """ @ingroup FABRIC_API @brief Import gltf/glb as Fabrics into the Object Browser @param _filePath: input file path @return the index list of added fabric in object browser for the current project """ .. code-tab:: c++ ImportGLTFAsFabricW(const wstring& _filePath, int index) /// @ingroup FABRIC_API /// @brief Import gltf/glb as Fabrics into the Object Browser /// @param _filePath: input file path /// @return the index list of added fabric in object browser for the current project .. tabs:: .. code-tab:: python def ImportGLTFAsFabricW(_filePath : str, _index : int) -> int """ @ingroup FABRIC_API @brief Import gltf/glb as a Fabric into the Object Browser @param _filePath: input file path @param _index: target material index on the gltf/glb file to import as a fabric @return the index of added fabric in object browser for the current project """ .. code-tab:: c++ ImportGLTFAsFabricW(const wstring& _filePath, int index) /// @ingroup FABRIC_API /// @brief Import gltf/glb as a Fabric into the Object Browser /// @param _filePath: input file path /// @param _index: target material index on the gltf/glb file to import as a fabric /// @return the index of added fabric in object browser for the current project .. tabs:: .. code-tab:: python def GetSpecificColorwayFabricInfo(_fabricIndex : int, _colorwayIndexForStyleChip : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information for a colorway @param _fabricIndex: the fabricIndex for the fabric to get the fabric info @param _colorwayIndexForStyleChip: the colorway index that you want to get StyleChip information @return json string for fabric information """ .. code-tab:: c++ GetSpecificColorwayFabricInfo(int _fabricIndex, int _colorwayIndexForStyleChip) /// @ingroup FABRIC_API /// @brief Get a fabric information for a colorway /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info /// @param _colorwayIndexForStyleChip: the colorway index that you want to get StyleChip information /// @return json string for fabric information .. tabs:: .. code-tab:: python def GetSpecificColorwayFabricInfoW(_fabricIndex : int, _colorwayIndexForStyleChip : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information for a colorway @param _fabricIndex: the fabricIndex for the fabric to get the fabric info @param _colorwayIndexForStyleChip: the colorway index that you want to get StyleChip information @return json string for fabric information """ .. code-tab:: c++ GetColorwayFabricInfoW(int _fabricIndex, int _colorwayIndexForStyleChip) /// @ingroup FABRIC_API /// @brief Get a fabric information for a colorway /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info /// @param _colorwayIndexForStyleChip: the colorway index that you want to get StyleChip information /// @return json string for fabric information .. tabs:: .. code-tab:: python def GetSpecificColorwayFabricInfo(_colorwayIndexForFabric : int, _fabricIndex : int, _colorwayIndexForStyleChip : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information for a colorway @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor @param _colorwayIndexForStyleChip: the colorway index that you want to get StyleChip information @return json string for fabric information """ .. code-tab:: c++ GetSpecificColorwayFabricInfo(int _colorwayIndexForFabric, int _fabricIndex, int _colorwayIndexForStyleChip) /// @ingroup FABRIC_API /// @brief Get a fabric information for a colorway /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor /// @param _colorwayIndexForStyleChip: the colorway index that you want to get StyleChip information /// @return json string for fabric information .. tabs:: .. code-tab:: python def GetSpecificColorwayFabricInfoW(_colorwayIndexForFabric : int, _fabricIndex : int, _colorwayIndexForStyleChip : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information for a colorway @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor @param _colorwayIndexForStyleChip: the colorway index that you want to get StyleChip information @return json string for fabric information that only includes 1 StyleChip information in (_colorwayIndexForStyleChip) """ .. code-tab:: c++ GetColorwayFabricInfoW(int _colorwayIndexForFabric, int _fabricIndex, int _colorwayIndexForStyleChip) /// @ingroup FABRIC_API /// @brief Get a fabric information for a colorway /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor /// @param _colorwayIndexForStyleChip: the colorway index that you want to get StyleChip information /// @return json string for fabric information that only includes 1 StyleChip information in (_colorwayIndexForStyleChip) .. tabs:: .. code-tab:: python def GetFabricItemNo(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get a fabric information for a colorway @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser @return Item No string """ .. code-tab:: c++ GetFabricItemNo(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get a fabric information for a colorway /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser /// @return Item No string .. tabs:: .. code-tab:: python def GetFabricItemNo(_colorwayIndexForFabric : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get a Fabric item NO @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor @return Item No string """ .. code-tab:: c++ GetFabricItemNo(int _colorwayIndexForFabric, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get a Fabric item NO /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor /// @return Item No string .. tabs:: .. code-tab:: python def GetFabricItemNoW(_fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get a Fabric item NO @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser @return Item No string """ .. code-tab:: c++ GetFabricItemNoW(int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get a Fabric item NO /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser /// @return Item No string .. tabs:: .. code-tab:: python def GetFabricItemNoW(_colorwayIndexForFabric : int, _fabricIndex : int) -> str """ @ingroup FABRIC_API @brief Get a Fabric item NO @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor @return Item No string """ .. code-tab:: c++ GetFabricItemNoW(int _colorwayIndexForFabric, int _fabricIndex) /// @ingroup FABRIC_API /// @brief Get a Fabric item NO /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor /// @return Item No string .. tabs:: .. code-tab:: python def SetFabricItemNo(_fabricIndex : int, _itemNo : str) -> bool """ @ingroup FABRIC_API @brief Set a Fabric item NO @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser @return if it succeeds, return true. """ .. code-tab:: c++ SetFabricItemNo(int _fabricIndex, const std::string& _itemNo) /// @ingroup FABRIC_API /// @brief Set a Fabric item NO /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetFabricItemNo(_colorwayIndexForFabric : int, _fabricIndex : int, _itemNo : str) -> bool """ @ingroup FABRIC_API @brief Set a Fabric item NO @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor @return if it succeeds, return true. """ .. code-tab:: c++ SetFabricItemNo(int _colorwayIndexForFabric, int _fabricIndex, const std::string& _itemNo) /// @ingroup FABRIC_API /// @brief Set a Fabric item NO /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetFabricItemNoW(_fabricIndex : int, _itemNo : str) -> bool """ @ingroup FABRIC_API @brief Set a Fabric item NO @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser @return if it succeeds, return true. """ .. code-tab:: c++ SetFabricItemNoW(int _fabricIndex, const std::wstring& _itemNo) /// @ingroup FABRIC_API /// @brief Set a Fabric item NO /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetFabricItemNoW(_colorwayIndexForFabric : int, _fabricIndex : int, _itemNo : str) -> bool """ @ingroup FABRIC_API @brief Set a Fabric item NO @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor @return if it succeeds, return true. """ .. code-tab:: c++ SetFabricItemNoW(int _colorwayIndexForFabric, int _fabricIndex, const std::wstring& _itemNo) /// @ingroup FABRIC_API /// @brief Set a Fabric item NO /// @param _colorwayIndexForFabric: the colorway index for the fabric to get the fabric info /// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Colorway Editor /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ExtractSBSARInputToJson(_fabricIndex : int, _colorwayIndex : int, materialFace : int, _savePath : str) -> str """ @ingroup FABRIC_API @brief Extract SBSAR InputData to Json (Only Headless) @param _fabricIndex : Fabric Index @param _colorwayIndex : Colorway Index @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" @param _savePath : Save path @return the index of added fabric in object browser for the current project """ .. code-tab:: c++ ExtractSBSARInputToJson(int _fabricIndex, int _colorwayIndex, int materialFace, const std::wstring& _savePath) /// @ingroup FABRIC_API /// @brief Extract SBSAR InputData to Json (Only Headless) /// @param _fabricIndex : Fabric Index /// @param _colorwayIndex : Colorway Index /// @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side" /// @param _savePath : Save path /// @return the index of added fabric in object browser for the current project .. tabs:: .. code-tab:: python def GetFabricTextureMappingType(_fabricIndex : int) -> int """ @ingroup FABRIC_API @param _fabricIndex: the target fabric index in the object browser @return it return 0: "Repeat" or 1: "Unified". """ .. code-tab:: c++ GetFabricTextureMappingType(const int& _fabricIndex) /// @ingroup FABRIC_API /// @param _fabricIndex: the target fabric index in the object browser /// @return it return 0: "Repeat" or 1: "Unified". .. tabs:: .. code-tab:: python def AutoGenerateFabricNormalMap(_fabricIndex : int, _colorwayIndex : int) -> None """ @ingroup FABRIC_API @brief Auto-generates a normal map from the base color texture of the fabric's front material. Uses the bump effect algorithm (MV_BUMP_EFFECT mode) to create the normal map. If no base color texture exists, this operation has no effect. @param _fabricIndex: target fabric index in the object browser @param _colorwayIndex: target colorway index """ .. code-tab:: c++ AutoGenerateFabricNormalMap(int _fabricIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Auto-generates a normal map from the base color texture of the fabric's front material. /// Uses the bump effect algorithm (MV_BUMP_EFFECT mode) to create the normal map. /// If no base color texture exists, this operation has no effect. /// @param _fabricIndex: target fabric index in the object browser /// @param _colorwayIndex: target colorway index .. tabs:: .. code-tab:: python def DeleteFabricNormalMap(_fabricIndex : int, _colorwayIndex : int) -> None """ @ingroup FABRIC_API @brief Deletes the normal map texture from the fabric's front material and resets the bump mode. @param _fabricIndex: target fabric index in the object browser @param _colorwayIndex: target colorway index """ .. code-tab:: c++ DeleteFabricNormalMap(int _fabricIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Deletes the normal map texture from the fabric's front material and resets the bump mode. /// @param _fabricIndex: target fabric index in the object browser /// @param _colorwayIndex: target colorway index .. tabs:: .. code-tab:: python def AutoGenerateFabricOpacityMap(_fabricIndex : int, _colorwayIndex : int) -> None """ @ingroup FABRIC_API @brief Auto-generates an opacity map by copying the base color texture of the fabric's front material. If no base color texture exists, this operation has no effect. @param _fabricIndex: target fabric index in the object browser @param _colorwayIndex: target colorway index """ .. code-tab:: c++ AutoGenerateFabricOpacityMap(int _fabricIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Auto-generates an opacity map by copying the base color texture of the fabric's front material. /// If no base color texture exists, this operation has no effect. /// @param _fabricIndex: target fabric index in the object browser /// @param _colorwayIndex: target colorway index .. tabs:: .. code-tab:: python def DeleteFabricOpacityMap(_fabricIndex : int, _colorwayIndex : int) -> None """ @ingroup FABRIC_API @brief Deletes the opacity map texture from the fabric's front material. @param _fabricIndex: target fabric index in the object browser @param _colorwayIndex: target colorway index """ .. code-tab:: c++ DeleteFabricOpacityMap(int _fabricIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Deletes the opacity map texture from the fabric's front material. /// @param _fabricIndex: target fabric index in the object browser /// @param _colorwayIndex: target colorway index .. tabs:: .. code-tab:: python def AutoGenerateFabricRoughnessMap(_fabricIndex : int, _colorwayIndex : int) -> None """ @ingroup FABRIC_API @brief Auto-generates a roughness map by copying the base color texture of the fabric's front material. If no base color texture exists, this operation has no effect. @param _fabricIndex: target fabric index in the object browser @param _colorwayIndex: target colorway index """ .. code-tab:: c++ AutoGenerateFabricRoughnessMap(int _fabricIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Auto-generates a roughness map by copying the base color texture of the fabric's front material. /// If no base color texture exists, this operation has no effect. /// @param _fabricIndex: target fabric index in the object browser /// @param _colorwayIndex: target colorway index .. tabs:: .. code-tab:: python def DeleteFabricRoughnessMap(_fabricIndex : int, _colorwayIndex : int) -> None """ @ingroup FABRIC_API @brief Deletes the roughness map texture from the fabric's front material. @param _fabricIndex: target fabric index in the object browser @param _colorwayIndex: target colorway index """ .. code-tab:: c++ DeleteFabricRoughnessMap(int _fabricIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Deletes the roughness map texture from the fabric's front material. /// @param _fabricIndex: target fabric index in the object browser /// @param _colorwayIndex: target colorway index .. tabs:: .. code-tab:: python def AutoGenerateFabricDisplacementMap(_fabricIndex : int, _colorwayIndex : int) -> None """ @ingroup FABRIC_API @brief Auto-generates a displacement map by copying the base color texture of the fabric's front material. If no base color texture exists, this operation has no effect. @param _fabricIndex: target fabric index in the object browser @param _colorwayIndex: target colorway index """ .. code-tab:: c++ AutoGenerateFabricDisplacementMap(int _fabricIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Auto-generates a displacement map by copying the base color texture of the fabric's front material. /// If no base color texture exists, this operation has no effect. /// @param _fabricIndex: target fabric index in the object browser /// @param _colorwayIndex: target colorway index .. tabs:: .. code-tab:: python def DeleteFabricDisplacementMap(_fabricIndex : int, _colorwayIndex : int) -> None """ @ingroup FABRIC_API @brief Deletes the displacement map texture from the fabric's front material. @param _fabricIndex: target fabric index in the object browser @param _colorwayIndex: target colorway index """ .. code-tab:: c++ DeleteFabricDisplacementMap(int _fabricIndex, int _colorwayIndex) /// @ingroup FABRIC_API /// @brief Deletes the displacement map texture from the fabric's front material. /// @param _fabricIndex: target fabric index in the object browser /// @param _colorwayIndex: target colorway index .. tabs:: .. code-tab:: python def TransformAOPOnFabric(_aopMode : int, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _transformOptions : TransformOptions, _materialSide : int) -> str """ @ingroup FABRIC_API @brief Transform (rotate, scale, translate) an AOP texture on a fabric. Works for both Print and BaseColorMap modes. @param _aopMode: texture application mode: 0=Print, 1=BaseColorMap @param _colorwayIndex: target colorway index (0 to n-1 for specific colorway, -1 to apply to all colorways when "Show all Colorways" is on) @param _fabricIndex: target fabric index in the object browser @param _styleChipIndex: target AOP style chip index (>= 0 for specific style chip, -1 for all applicable style chips). Only used in Print mode (_aopMode=0) @param _transformOptions: transformation options containing angle, width/height (mm/percent), position, and aspect ratio settings @param _materialSide: which material face: 0=Front (default), 1=Back, 2=Side @return JSON string with "status" (success/failure) and "description" (details about the operation) """ .. code-tab:: c++ TransformAOPOnFabric(int _aopMode, int _colorwayIndex, int _fabricIndex, int _styleChipIndex, const TransformOptions& _transformOptions, int _materialSide) /// @ingroup FABRIC_API /// @brief Transform (rotate, scale, translate) an AOP texture on a fabric. Works for both Print and BaseColorMap modes. /// @param _aopMode: texture application mode: 0=Print, 1=BaseColorMap /// @param _colorwayIndex: target colorway index (0 to n-1 for specific colorway, -1 to apply to all colorways when "Show all Colorways" is on) /// @param _fabricIndex: target fabric index in the object browser /// @param _styleChipIndex: target AOP style chip index (>= 0 for specific style chip, -1 for all applicable style chips). Only used in Print mode (_aopMode=0) /// @param _transformOptions: transformation options containing angle, width/height (mm/percent), position, and aspect ratio settings /// @param _materialSide: which material face: 0=Front (default), 1=Back, 2=Side /// @return JSON string with "status" (success/failure) and "description" (details about the operation) .. tabs:: .. code-tab:: python def AddTextureToPatterns(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _aopMode : int, _materialSide : int) -> str """ @brief Apply an AOP texture to a specific fabric and style chip for a given colorway. @param _imageFilePath: path to the AOP texture image file (.png, .jpg, .sbsar, etc.) @param _colorwayIndex: target colorway index. Use -1 to apply to the current colorway. @param _fabricIndex: target fabric index in the object browser. @param _styleChipIndex: target AOP style chip index within the fabric's style chip list. Use -1 to target all style chips. @param _aopMode: how to apply the texture: 0=Print (default), 1=BaseColorMap @param _materialSide: which material face to apply to: 0=Front (default), 1=Back, 2=Side @return A JSON string with format: {\"status\": \"done\"|\"error\", \"description\": \"message\"}. Status is \"done\" on success, \"error\" on failure. """ .. code-tab:: c++ AddTextureToPatterns(const std::string& _imageFilePath, int _colorwayIndex, int _fabricIndex, int _styleChipIndex, int _aopMode, int _materialSide) /// @brief Apply an AOP texture to a specific fabric and style chip for a given colorway. /// @param _imageFilePath: path to the AOP texture image file (.png, .jpg, .sbsar, etc.) /// @param _colorwayIndex: target colorway index. Use -1 to apply to the current colorway. /// @param _fabricIndex: target fabric index in the object browser. /// @param _styleChipIndex: target AOP style chip index within the fabric's style chip list. Use -1 to target all style chips. /// @param _aopMode: how to apply the texture: 0=Print (default), 1=BaseColorMap /// @param _materialSide: which material face to apply to: 0=Front (default), 1=Back, 2=Side /// @return A JSON string with format: {\"status\": \"done\"|\"error\", \"description\": \"message\"}. Status is \"done\" on success, \"error\" on failure. IMPORT_API ********** .. tabs:: .. code-tab:: python def ImportFile(filePath : str) -> bool """ @ingroup IMPORT_API @brief Load File (zprj, zpac, avt, obj, fbx, zcmr). This function will show up the dialog per the file type. @param filePath: the input file path to load @return if it succeeds, return true. """ .. code-tab:: c++ ImportFile(const string& filePath) /// @ingroup IMPORT_API /// @brief Load File (zprj, zpac, avt, obj, fbx, zcmr). This function will show up the dialog per the file type. /// @param filePath: the input file path to load /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportFileW(filePath : str) -> bool """ @ingroup IMPORT_API @brief Load File (zprj, zpac, avt, obj, fbx, zcmr). This function will show up the dialog per the file type. @param filePath: the input file path to load @return if it succeeds, return true. """ .. code-tab:: c++ ImportFileW(const wstring& filePath) /// @ingroup IMPORT_API /// @brief Load File (zprj, zpac, avt, obj, fbx, zcmr). This function will show up the dialog per the file type. /// @param filePath: the input file path to load /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportZprj(filePath : str, loadOption : ImportZPRJOption) -> bool """ @ingroup IMPORT_API @brief Load zprj File without the dialog but the loadOption @param filePath: the input file path to load @param loadOption: the options to load the file @return if it succeeds, return true. """ .. code-tab:: c++ ImportZprj(const string& filePath, const Marvelous::ImportZPRJOption& loadOption) /// @ingroup IMPORT_API /// @brief Load zprj File without the dialog but the loadOption /// @param filePath: the input file path to load /// @param loadOption: the options to load the file /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportZprjW(filePath : str, loadOption : ImportZPRJOption) -> bool """ @ingroup IMPORT_API @brief Load zprj File without the dialog but the loadOption @param filePath: the input file path to load @param loadOption: the options to load the file @return if it succeeds, return true. """ .. code-tab:: c++ ImportZprjW(const wstring& filePath, const Marvelous::ImportZPRJOption& loadOption) /// @ingroup IMPORT_API /// @brief Load zprj File without the dialog but the loadOption /// @param filePath: the input file path to load /// @param loadOption: the options to load the file /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportGarmentInformation(filePath : str) -> bool """ @ingroup IMPORT_API @brief Load Garment Information (json) @param filePath: the input file to load the garment information (.json) @return if it succeeds, return true. """ .. code-tab:: c++ ImportGarmentInformation(const string& filePath) /// @ingroup IMPORT_API /// @brief Load Garment Information (json) /// @param filePath: the input file to load the garment information (.json) /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportGarmentInformationW(filePath : str) -> bool """ @ingroup IMPORT_API @brief Load Garment Information (json) @param filePath: the input file to load the garment information (.json) @return if it succeeds, return true. """ .. code-tab:: c++ ImportGarmentInformationW(const wstring& filePath) /// @ingroup IMPORT_API /// @brief Load Garment Information (json) /// @param filePath: the input file to load the garment information (.json) /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportGarmentInformationConfigData(filePath : str) -> bool """ @ingroup IMPORT_API @brief Load Garment Information Configuration (json) @param filePath: the input file to load the garment information configuration data(.json) @return if it succeeds, return true. """ .. code-tab:: c++ ImportGarmentInformationConfigData(const string& filePath) /// @ingroup IMPORT_API /// @brief Load Garment Information Configuration (json) /// @param filePath: the input file to load the garment information configuration data(.json) /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportGarmentInformationConfigDataW(filePath : str) -> bool """ @ingroup IMPORT_API @brief Load Garment Information Configuration (json) @param filePath: the input file to load the garment information configuration data(.json) @return if it succeeds, return true. """ .. code-tab:: c++ ImportGarmentInformationConfigDataW(const wstring& filePath) /// @ingroup IMPORT_API /// @brief Load Garment Information Configuration (json) /// @param filePath: the input file to load the garment information configuration data(.json) /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportOBJ(_filePath : str, _options : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import OBJ file @param _filePath: input file path @param options: If "options" is given, it imports OBJ according to options, not allowing user for selecting options in Import Dialog. @return if it succeeds, return true. """ .. code-tab:: c++ ImportOBJ(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup IMPORT_API /// @brief Import OBJ file /// @param _filePath: input file path /// @param options: If "options" is given, it imports OBJ according to options, not allowing user for selecting options in Import Dialog. /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportOBJW(_filePath : str, _options : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import OBJ file @param _filePath: input file path @param options: If "options" is given, it imports OBJ according to options, not allowing user for selecting options in Import Dialog. @return if it succeeds, return true. """ .. code-tab:: c++ ImportOBJW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup IMPORT_API /// @brief Import OBJ file /// @param _filePath: input file path /// @param options: If "options" is given, it imports OBJ according to options, not allowing user for selecting options in Import Dialog. /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportVMP(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import VMP file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportVMP(const string& _filePath) /// @ingroup IMPORT_API /// @brief Import VMP file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportVMPW(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import VMP file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportVMPW(const wstring& _filePath) /// @ingroup IMPORT_API /// @brief Import VMP file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportCPT(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import CPT file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportCPT(const string& _filePath) /// @ingroup IMPORT_API /// @brief Import CPT file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportCPTW(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import CPT file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportCPTW(const wstring& _filePath) /// @ingroup IMPORT_API /// @brief Import CPT file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportVLP(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import VLP file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportVLP(const string& _filePath) /// @ingroup IMPORT_API /// @brief Import VLP file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportVLPW(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import VLP file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportVLPW(const wstring& _filePath) /// @ingroup IMPORT_API /// @brief Import VLP file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportVRP(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import VRP file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportVRP(const string& _filePath) /// @ingroup IMPORT_API /// @brief Import VRP file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportVRPW(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import VRP file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportVRPW(const wstring& _filePath) /// @ingroup IMPORT_API /// @brief Import VRP file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportDXF(_filePath : str, loadOption : ImportDxfOption) -> bool """ @ingroup IMPORT_API @brief Import DXF file @param _filePath: input file path @param loadOption: the options to load the file @return if it succeeds, return true. """ .. code-tab:: c++ ImportDXF(const string& _filePath, const Marvelous::ImportDxfOption& loadOption) /// @ingroup IMPORT_API /// @brief Import DXF file /// @param _filePath: input file path /// @param loadOption: the options to load the file /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportDXFW(_filePath : str, loadOption : ImportDxfOption) -> bool """ @ingroup IMPORT_API @brief Import DXF file @param _filePath: input file path @param loadOption: the options to load the file @return if it succeeds, return true. """ .. code-tab:: c++ ImportDXFW(const wstring& _filePath, const Marvelous::ImportDxfOption& loadOption) /// @ingroup IMPORT_API /// @brief Import DXF file /// @param _filePath: input file path /// @param loadOption: the options to load the file /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportGraphicStyleFromImage(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import image file as graphic style @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportGraphicStyleFromImage(const string& _filePath) /// @ingroup IMPORT_API /// @brief Import image file as graphic style /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportGraphicStyleFromImage(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import image file as graphic style @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportGraphicStyleFromImage(const wstring& _filePath) /// @ingroup IMPORT_API /// @brief Import image file as graphic style /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportAVAC(_filePath : str, _apfFilePath : str) -> bool """ @ingroup IMPORT_API @brief Import avac avatar file @param _filePath: input avatar file path @param _apfFilePath: input apf File path @return if it succeeds, return true. """ .. code-tab:: c++ ImportAVAC(const wstring& _filePath, const wstring& _apfFilePath) /// @ingroup IMPORT_API /// @brief Import avac avatar file /// @param _filePath: input avatar file path /// @param _apfFilePath: input apf File path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportAVAC(_filePath : str, _apfFilePath : str) -> bool """ @ingroup IMPORT_API @brief Import avac avatar file @param _filePath: input avatar file path @param _apfFilePath: input apf File path @return if it succeeds, return true. """ .. code-tab:: c++ ImportAVAC(const string& _filePath, const string& _apfFilePath) /// @ingroup IMPORT_API /// @brief Import avac avatar file /// @param _filePath: input avatar file path /// @param _apfFilePath: input apf File path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportFile(filePath : str, _options : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Load File(obj, fbx, gltf) by obj type . This function will show up the dialog per the file type. @param filePath: the input file path to load, ImportExportOption - loadObjectType 0 : avater, 1 : trim @return if it succeeds, return true. """ .. code-tab:: c++ ImportFile(const string& filePath, const Marvelous::ImportExportOption& _options) /// @ingroup IMPORT_API /// @brief Load File(obj, fbx, gltf) by obj type . This function will show up the dialog per the file type. /// @param filePath: the input file path to load, ImportExportOption - loadObjectType 0 : avater, 1 : trim /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportFileW(filePath : str, _options : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Load File(obj, fbx, gltf) by obj type. This function will show up the dialog per the file type. @param filePath: the input file path to load, ImportExportOption - loadObjectType 0 : avater, 1 : trim @return if it succeeds, return true. """ .. code-tab:: c++ ImportFileW(const wstring& filePath, const Marvelous::ImportExportOption& _options) /// @ingroup IMPORT_API /// @brief Load File(obj, fbx, gltf) by obj type. This function will show up the dialog per the file type. /// @param filePath: the input file path to load, ImportExportOption - loadObjectType 0 : avater, 1 : trim /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportFBX(_filePath : str, _options : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import FBX file @param _filePath: input file path @param options: If "options" is given, it imports FBX according to options, not allowing user for selecting options in Import Dialog. @return if it succeeds, return true. """ .. code-tab:: c++ ImportFBX(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup IMPORT_API /// @brief Import FBX file /// @param _filePath: input file path /// @param options: If "options" is given, it imports FBX according to options, not allowing user for selecting options in Import Dialog. /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportFBXW(_filePath : str, _options : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import FBX file @param _filePath: input file path @param options: If "options" is given, it imports FBX according to options, not allowing user for selecting options in Import Dialog. @return if it succeeds, return true. """ .. code-tab:: c++ ImportFBXW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup IMPORT_API /// @brief Import FBX file /// @param _filePath: input file path /// @param options: If "options" is given, it imports FBX according to options, not allowing user for selecting options in Import Dialog. /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportGLTF(_filePath : str, _options : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import GLTF file @param _filePath: input file path @param options: If "options" is given, it imports GLTF according to options, not allowing user for selecting options in Import Dialog. @return if it succeeds, return true. """ .. code-tab:: c++ ImportGLTF(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup IMPORT_API /// @brief Import GLTF file /// @param _filePath: input file path /// @param options: If "options" is given, it imports GLTF according to options, not allowing user for selecting options in Import Dialog. /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportGLTFW(_filePath : str, _options : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import GLTF file @param _filePath: input file path @param options: If "options" is given, it imports GLTF according to options, not allowing user for selecting options in Import Dialog. @return if it succeeds, return true. """ .. code-tab:: c++ ImportGLTFW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup IMPORT_API /// @brief Import GLTF file /// @param _filePath: input file path /// @param options: If "options" is given, it imports GLTF according to options, not allowing user for selecting options in Import Dialog. /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportSMP(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import SMP file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportSMP(const string& _filePath) /// @ingroup IMPORT_API /// @brief Import SMP file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportSMPW(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import SMP file @param _filePath: input file path @return if it succeeds, return true. """ .. code-tab:: c++ ImportSMPW(const wstring& _filePath) /// @ingroup IMPORT_API /// @brief Import SMP file /// @param _filePath: input file path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def ImportAsGraphic(_filePath : str) -> None """ @ingroup IMPORT_API @brief Import an image file as Graphic. @param _filePath: input file path """ .. code-tab:: c++ ImportAsGraphic(const std::string& _filePath) /// @ingroup IMPORT_API /// @brief Import an image file as Graphic. /// @param _filePath: input file path .. tabs:: .. code-tab:: python def ImportAsGraphicW(_filePath : str) -> None """ @ingroup IMPORT_API @brief Import an image file as Graphic. @param _filePath: input file path """ .. code-tab:: c++ ImportAsGraphicW(const std::wstring& _filePath) /// @ingroup IMPORT_API /// @brief Import an image file as Graphic. /// @param _filePath: input file path .. tabs:: .. code-tab:: python def ImportTrim(_filePath : str, _bTranslateToOrigin : bool) -> None """ @ingroup IMPORT_API @brief Import a trim @param _filePath : input file path @param _bTranslateToOrigin : option to translate the position of the imported trim true: move trim to the pos(0,0) false: move trim to original pos """ .. code-tab:: c++ ImportTrim(const std::string& _filePath) /// @ingroup IMPORT_API /// @brief Import a trim /// @param _filePath : input file path /// @param _bTranslateToOrigin : option to translate the position of the imported trim /// true: move trim to the pos(0,0) /// false: move trim to original pos .. tabs:: .. code-tab:: python def ImportAvatarMeasurement(_csvPath : str, _avtPath : str, _opt : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import Avatar Measurement CSV file @param _csvPath: input CSV file path, _avtPath : input Avatar file path, _opt : input load options """ .. code-tab:: c++ ImportAvatarMeasurement(std::string _csvPath, std::string _avtPath, ImportExportOption _opt) /// @ingroup IMPORT_API /// @brief Import Avatar Measurement CSV file /// @param _csvPath: input CSV file path, _avtPath : input Avatar file path, _opt : input load options .. tabs:: .. code-tab:: python def ImportAvatar(_avtPath : str, _opt : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import Avatar @param _avtPath : input Avatar file path, _opt : input load options """ .. code-tab:: c++ ImportAvatar(std::string _avtPath, ImportExportOption _opt) /// @ingroup IMPORT_API /// @brief Import Avatar /// @param _avtPath : input Avatar file path, _opt : input load options .. tabs:: .. code-tab:: python def ImportMeasurement(_csvPath : str) -> bool """ @ingroup IMPORT_API @brief Import Avatar Measurement CSV file @param _csvPath: input CSV file path """ .. code-tab:: c++ ImportMeasurement(std::string _csvPath) /// @ingroup IMPORT_API /// @brief Import Avatar Measurement CSV file /// @param _csvPath: input CSV file path .. tabs:: .. code-tab:: python def ImportPose(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import a pose/hand pose file. @param _filePath: input file path """ .. code-tab:: c++ ImportPose(const std::string& _filePath) /// @ingroup IMPORT_API /// @brief Import a pose/hand pose file. /// @param _filePath: input file path .. tabs:: .. code-tab:: python def ImportPoseW(_filePath : str) -> bool """ @ingroup IMPORT_API @brief Import a pose/hand pose file. @param _filePath: input file path """ .. code-tab:: c++ ImportPoseW(const std::wstring& _filePath) /// @ingroup IMPORT_API /// @brief Import a pose/hand pose file. /// @param _filePath: input file path .. tabs:: .. code-tab:: python def ImportPose(_filePath : str, _bPoseAndTranslation : bool, _bBottomToGround : bool) -> bool """ @ingroup IMPORT_API @brief Import a pose/hand pose file with options. @param _filePath: input file path @param _bPoseAndTranslation: if true, import both pose and translation; if false, import only pose @param _bBottomToGround: if true, adjust the bottom of the avatar to ground level """ .. code-tab:: c++ ImportPose(const std::string& _filePath, bool _bPoseAndTranslation, bool _bBottomToGround) /// @ingroup IMPORT_API /// @brief Import a pose/hand pose file with options. /// @param _filePath: input file path /// @param _bPoseAndTranslation: if true, import both pose and translation; if false, import only pose /// @param _bBottomToGround: if true, adjust the bottom of the avatar to ground level .. tabs:: .. code-tab:: python def ImportPoseW(_filePath : str, _bPoseAndTranslation : bool, _bBottomToGround : bool) -> bool """ @ingroup IMPORT_API @brief Import a pose/hand pose file with options. @param _filePath: input file path @param _bPoseAndTranslation: if true, import both pose and translation; if false, import only pose @param _bBottomToGround: if true, adjust the bottom of the avatar to ground level """ .. code-tab:: c++ ImportPoseW(const std::wstring& _filePath, bool _bPoseAndTranslation, bool _bBottomToGround) /// @ingroup IMPORT_API /// @brief Import a pose/hand pose file with options. /// @param _filePath: input file path /// @param _bPoseAndTranslation: if true, import both pose and translation; if false, import only pose /// @param _bBottomToGround: if true, adjust the bottom of the avatar to ground level .. tabs:: .. code-tab:: python def ImportAlembic(filePath : str, option : ImportAlembicOption) -> bool """ @ingroup IMPORT_API @brief Import an alembic (.abc) file. @param filePath: input file path @param option: alembic import options """ .. code-tab:: c++ ImportAlembic(const std::string& filePath, const Marvelous::ImportAlembicOption& option) /// @ingroup IMPORT_API /// @brief Import an alembic (.abc) file. /// @param filePath: input file path /// @param option: alembic import options .. tabs:: .. code-tab:: python def ImportZpac(filePath : str, loadOption : ImportExportOption) -> bool """ @ingroup IMPORT_API @brief Import Zpac file @param filePath: input file path @param loadOption: If "loadOption" is given, it imports zpac according to options, not allowing user for selecting options in Import Dialog. @return if it succeeds, return true. """ .. code-tab:: c++ ImportZpac(const string& filePath, const Marvelous::ImportExportOption& loadOption) /// @ingroup IMPORT_API /// @brief Import Zpac file /// @param filePath: input file path /// @param loadOption: If "loadOption" is given, it imports zpac according to options, not allowing user for selecting options in Import Dialog. /// @return if it succeeds, return true. PATTERN_API *********** .. tabs:: .. code-tab:: python def GetPatternSize() -> int """ @ingroup PATTERN_API @brief Get the number of patterns @return return the number of patterns on the pattern editor and avatar window """ .. code-tab:: c++ GetPatternSize() /// @ingroup PATTERN_API /// @brief Get the number of patterns /// @return return the number of patterns on the pattern editor and avatar window .. tabs:: .. code-tab:: python def GetPatternIndex(patternName : str) -> int """ @ingroup PATTERN_API @brief Get the pattern index which is using the pattern name @param patternName: the input pattern name to get the pattern index @return pattern index """ .. code-tab:: c++ GetPatternIndex(const string& patternName) /// @ingroup PATTERN_API /// @brief Get the pattern index which is using the pattern name /// @param patternName: the input pattern name to get the pattern index /// @return pattern index .. tabs:: .. code-tab:: python def GetPatternIndexW(patternName : str) -> int """ @ingroup PATTERN_API @brief Get the pattern index which is using the pattern name @param patternName: the pattern name to get the pattern index @return pattern index """ .. code-tab:: c++ GetPatternIndexW(const wstring& patternName) /// @ingroup PATTERN_API /// @brief Get the pattern index which is using the pattern name /// @param patternName: the pattern name to get the pattern index /// @return pattern index .. tabs:: .. code-tab:: python def GetPatternIndexFrom2DView(_scenePosX : float, _scenePosY : float) -> int """ @ingroup PATTERN_API @brief Get the pattern index which is using the 2D scene position @param scenePosX: the scene position X @param scenePosY: the scene position Y @return pattern index """ .. code-tab:: c++ GetPatternIndexFrom2DView(float _scenePosX, float _scenePosY) /// @ingroup PATTERN_API /// @brief Get the pattern index which is using the 2D scene position /// @param scenePosX: the scene position X /// @param scenePosY: the scene position Y /// @return pattern index .. tabs:: .. code-tab:: python def GetPatternIndexFrom3DView(_scenePosX : float, _scenePosY : float) -> int """ @ingroup PATTERN_API @brief Get the pattern index which is using the 3D scene position @param scenePosX: the scene position X @param scenePosY: the scene position Y @return pattern index """ .. code-tab:: c++ GetPatternIndexFrom3DView(float _scenePosX, float _scenePosY) /// @ingroup PATTERN_API /// @brief Get the pattern index which is using the 3D scene position /// @param scenePosX: the scene position X /// @param scenePosY: the scene position Y /// @return pattern index .. tabs:: .. code-tab:: python def GetPatternInformation(patternIndex : int) -> str """ @ingroup PATTERN_API @brief Get the pattern information which is using for pattern index @param patternIndex: the pattern index to get the pattern information @return json string for pattern information """ .. code-tab:: c++ GetPatternInformation(int patternIndex) /// @ingroup PATTERN_API /// @brief Get the pattern information which is using for pattern index /// @param patternIndex: the pattern index to get the pattern information /// @return json string for pattern information .. tabs:: .. code-tab:: python def GetPatternInformationW(patternIndex : int) -> str """ @ingroup PATTERN_API @brief Get the pattern information which is using for pattern index @param patternIndex: the pattern index to get the pattern information @return json string for pattern information """ .. code-tab:: c++ GetPatternInformationW(int patternIndex) /// @ingroup PATTERN_API /// @brief Get the pattern information which is using for pattern index /// @param patternIndex: the pattern index to get the pattern information /// @return json string for pattern information .. tabs:: .. code-tab:: python def GetPatternCount() -> int """ @ingroup PATTERN_API @brief Get the number of patterns @return return the number of patterns on the pattern editor and avatar window """ .. code-tab:: c++ GetPatternCount() /// @ingroup PATTERN_API /// @brief Get the number of patterns /// @return return the number of patterns on the pattern editor and avatar window .. tabs:: .. code-tab:: python def GetPatternInputInformation(_patternIndex : int) -> str """ @ingroup PATTERN_API @brief Get the pattern input information which is using for pattern index @param patternIndex: the pattern index to get the pattern input information @return json string for pattern input information """ .. code-tab:: c++ GetPatternInputInformation(int patternIndex) /// @ingroup PATTERN_API /// @brief Get the pattern input information which is using for pattern index /// @param patternIndex: the pattern index to get the pattern input information /// @return json string for pattern input information .. tabs:: .. code-tab:: python def GetPatternInputInformationW(_patternIndex : int) -> str """ @ingroup PATTERN_API @brief Get the pattern input information which is using for pattern index @param patternIndex: the pattern index to get the pattern input information @return json string for pattern input information """ .. code-tab:: c++ GetPatternInputInformationW(int patternIndex) /// @ingroup PATTERN_API /// @brief Get the pattern input information which is using for pattern index /// @param patternIndex: the pattern index to get the pattern input information /// @return json string for pattern input information .. tabs:: .. code-tab:: python def GetPatternInputInformation() -> str """ @ingroup PATTERN_API @brief Get the pattern input information which is using for pattern index @param patternIndex: the pattern index to get the pattern input information @return json string for pattern input information """ .. code-tab:: c++ GetPatternInputInformation() /// @ingroup PATTERN_API /// @brief Get the pattern input information which is using for pattern index /// @param patternIndex: the pattern index to get the pattern input information /// @return json string for pattern input information .. tabs:: .. code-tab:: python def GetPatternInputInformationW() -> str """ @ingroup PATTERN_API @brief Get the pattern input information which is using for pattern index @param patternIndex: the pattern index to get the pattern input information @return json string for pattern input information """ .. code-tab:: c++ GetPatternInputInformationW() /// @ingroup PATTERN_API /// @brief Get the pattern input information which is using for pattern index /// @param patternIndex: the pattern index to get the pattern input information /// @return json string for pattern input information .. tabs:: .. code-tab:: python def GetPatternPieceArea(_patternIndex : int) -> float """ @ingroup PATTERN_API @brief Get the pattern piece area which is using for pattern index @return return pattern piece """ .. code-tab:: c++ GetPatternPieceArea() /// @ingroup PATTERN_API /// @brief Get the pattern piece area which is using for pattern index /// @return return pattern piece .. tabs:: .. code-tab:: python def GetLineLength(_patternIndex : int, _lineIndex : int) -> float """ @ingroup PATTERN_API @brief Get the pattern line length which is using for pattern index and line index @return return line length """ .. code-tab:: c++ GetLineLength() /// @ingroup PATTERN_API /// @brief Get the pattern line length which is using for pattern index and line index /// @return return line length .. tabs:: .. code-tab:: python def GetLineLength(_patternIndex : int, _childrenIndex : int, _lineIndex : int) -> float """ @ingroup PATTERN_API @brief Get the pattern line length which is using for pattern index and children shape index and line index @return return line length """ .. code-tab:: c++ GetLineLengthForInnerShape() /// @ingroup PATTERN_API /// @brief Get the pattern line length which is using for pattern index and children shape index and line index /// @return return line length .. tabs:: .. code-tab:: python def GetParticleDistanceOfPattern(_patternIndex : int) -> float """ @ingroup PATTERN_API @brief Get particle distance which is using pattern index @param patternIndex: the pattern index to get the pattern particle distance @return Output particle distance; If an error occurs, return MIN_PARTICLE_DISTANCE, 0.8f. """ .. code-tab:: c++ GetParticleDistanceOfPattern(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get particle distance which is using pattern index /// @param patternIndex: the pattern index to get the pattern particle distance /// @return Output particle distance; If an error occurs, return MIN_PARTICLE_DISTANCE, 0.8f. .. tabs:: .. code-tab:: python def GetParticleDistanceOfPattern(_patternName : str) -> float """ @ingroup PATTERN_API @brief Get particle distance which is using the pattern name @param patternName: the pattern name to get the pattern particle distance @return Output particle distance; If an error occurs, return MIN_PARTICLE_DISTANCE, 0.8f. """ .. code-tab:: c++ GetParticleDistanceOfPattern(const string& _patternName) /// @ingroup PATTERN_API /// @brief Get particle distance which is using the pattern name /// @param patternName: the pattern name to get the pattern particle distance /// @return Output particle distance; If an error occurs, return MIN_PARTICLE_DISTANCE, 0.8f. .. tabs:: .. code-tab:: python def GetParticleDistanceOfPatternW(_patternName : str) -> float """ @ingroup PATTERN_API @brief Get particle distance which is using the pattern name @param patternName: the pattern name to get the pattern particle distance @return Output particle distance; If an error occurs, return MIN_PARTICLE_DISTANCE, 0.8f. """ .. code-tab:: c++ GetParticleDistanceOfPatternW(const wstring& _patternName) /// @ingroup PATTERN_API /// @brief Get particle distance which is using the pattern name /// @param patternName: the pattern name to get the pattern particle distance /// @return Output particle distance; If an error occurs, return MIN_PARTICLE_DISTANCE, 0.8f. .. tabs:: .. code-tab:: python def GetMeshCountByType(_patternIndex : int) -> map[str, str] """ @ingroup PATTERN_API @brief Get mesh face, vertex count by mesh type which is using pattern index @param patternIndex: the pattern index to get the pattern mesh face, vertex count @return Output map string mesh face,vertex count, mesh type; If an error occurs, return infoMap """ .. code-tab:: c++ GetMeshCountByType(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get mesh face, vertex count by mesh type which is using pattern index /// @param patternIndex: the pattern index to get the pattern mesh face, vertex count /// @return Output map string mesh face,vertex count, mesh type; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetMeshCountByType(_patternName : str) -> map[str, str] """ @ingroup PATTERN_API @brief Get mesh face, vertex count by mesh type which is using the pattern name @param patternName: the pattern name to get the pattern mesh face, vertex count @return Output map string mesh face,vertex count, mesh type; If an error occurs, return infoMap """ .. code-tab:: c++ GetMeshCountByType(const string& _patternName) /// @ingroup PATTERN_API /// @brief Get mesh face, vertex count by mesh type which is using the pattern name /// @param patternName: the pattern name to get the pattern mesh face, vertex count /// @return Output map string mesh face,vertex count, mesh type; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetMeshCountByTypeW(_patternName : str) -> map[str, str] """ @ingroup PATTERN_API @brief Get mesh face, vertex count by mesh type which is using the pattern name @param patternName: the pattern name to get the pattern mesh face, vertex count @return Output map string mesh face,vertex count, mesh type; If an error occurs, return infoMap """ .. code-tab:: c++ GetMeshCountByTypeW(const wstring& _patternName) /// @ingroup PATTERN_API /// @brief Get mesh face, vertex count by mesh type which is using the pattern name /// @param patternName: the pattern name to get the pattern mesh face, vertex count /// @return Output map string mesh face,vertex count, mesh type; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetShrinkagePercentage(_patternIndex : int) -> map[str, str] """ @ingroup PATTERN_API @brief Get ShrinkagePercentage each width, height which is using pattern index @param patternIndex: the pattern index to get the pattern shrinkagePercentage each width, height @return Output map string shrinkagePercentage width, height; If an error occurs, return infoMap """ .. code-tab:: c++ GetShrinkagePercentage(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get ShrinkagePercentage each width, height which is using pattern index /// @param patternIndex: the pattern index to get the pattern shrinkagePercentage each width, height /// @return Output map string shrinkagePercentage width, height; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetShrinkagePercentage(_patternName : str) -> map[str, str] """ @ingroup PATTERN_API @brief Get ShrinkagePercentage each width, height which is using the pattern name @param patternName: the pattern name to get the pattern shrinkagePercentage each width, height @return Output map string shrinkagePercentage width, height; If an error occurs, return infoMap """ .. code-tab:: c++ GetShrinkagePercentage(const string& _patternName) /// @ingroup PATTERN_API /// @brief Get ShrinkagePercentage each width, height which is using the pattern name /// @param patternName: the pattern name to get the pattern shrinkagePercentage each width, height /// @return Output map string shrinkagePercentage width, height; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetShrinkagePercentageW(_patternName : str) -> map[str, str] """ @ingroup PATTERN_API @brief Get ShrinkagePercentage each width, height which is using the pattern name @param patternName: the pattern name to get the pattern shrinkagePercentage each width, height @return Output map string shrinkagePercentage width, height; If an error occurs, return infoMap """ .. code-tab:: c++ GetShrinkagePercentageW(const wstring& _patternName) /// @ingroup PATTERN_API /// @brief Get ShrinkagePercentage each width, height which is using the pattern name /// @param patternName: the pattern name to get the pattern shrinkagePercentage each width, height /// @return Output map string shrinkagePercentage width, height; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetBoundingBoxOfPattern() -> list[map[str, str]] """ @ingroup PATTERN_API @brief Get patterns BoundingBox Size each width, height @param none @return Output vector map string patterns BoundingBox Size width, height, pattern index, pattern count; If an error occurs, return infoMap """ .. code-tab:: c++ GetBoundingBoxOfPattern() /// @ingroup PATTERN_API /// @brief Get patterns BoundingBox Size each width, height /// @param none /// @return Output vector map string patterns BoundingBox Size width, height, pattern index, pattern count; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetBoundingBoxOfPattern(_patternIndex : int) -> map[str, str] """ @ingroup PATTERN_API @brief Get BoundingBox Size each width, height which is using pattern index @param patternIndex: the pattern index to get the pattern BoundingBox Size each width, height @return Output map string BoundingBox Size width, height; If an error occurs, return infoMap """ .. code-tab:: c++ GetBoundingBoxOfPattern(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get BoundingBox Size each width, height which is using pattern index /// @param patternIndex: the pattern index to get the pattern BoundingBox Size each width, height /// @return Output map string BoundingBox Size width, height; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetBoundingBoxOfPattern(_patternName : str) -> map[str, str] """ @ingroup PATTERN_API @brief Get BoundingBox Size each width, height which is using the pattern name @param patternName: the pattern name to get the pattern BoundingBox Size each width, height @return Output map string BoundingBox Size width, height, pattern index; If an error occurs, return infoMap """ .. code-tab:: c++ GetBoundingBoxOfPattern(const string& _patternName) /// @ingroup PATTERN_API /// @brief Get BoundingBox Size each width, height which is using the pattern name /// @param patternName: the pattern name to get the pattern BoundingBox Size each width, height /// @return Output map string BoundingBox Size width, height, pattern index; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetBoundingBoxOfPatternW(_patternName : str) -> map[str, str] """ @ingroup PATTERN_API @brief Get BoundingBox Size each width, height which is using the pattern name @param patternName: the pattern name to get the pattern BoundingBox Size each width, height @return Output map string BoundingBox Size width, height, pattern index; If an error occurs, return infoMap """ .. code-tab:: c++ GetBoundingBoxOfPatternW(const wstring& _patternName) /// @ingroup PATTERN_API /// @brief Get BoundingBox Size each width, height which is using the pattern name /// @param patternName: the pattern name to get the pattern BoundingBox Size each width, height /// @return Output map string BoundingBox Size width, height, pattern index; If an error occurs, return infoMap .. tabs:: .. code-tab:: python def SetParticleDistanceOfPattern(_patternIndex : int, _length : float) -> None """ @ingroup PATTERN_API @brief Set particle distance using pattern index, length @param patternIndex: the pattern index to set the pattern particle distance, length: the length value to determine particle distance """ .. code-tab:: c++ SetParticleDistanceOfPattern(int _patternIndex, float _length) /// @ingroup PATTERN_API /// @brief Set particle distance using pattern index, length /// @param patternIndex: the pattern index to set the pattern particle distance, /// length: the length value to determine particle distance .. tabs:: .. code-tab:: python def SetParticleDistanceOfPatterns(_length : float) -> None """ @ingroup PATTERN_API @brief Set patterns particle distance using length @param length: the length value to determine particle distance """ .. code-tab:: c++ SetParticleDistanceOfPatterns() /// @ingroup PATTERN_API /// @brief Set patterns particle distance using length /// @param length: the length value to determine particle distance .. tabs:: .. code-tab:: python def SetMeshType(_patternIndex : int, _meshType : str) -> None """ @ingroup PATTERN_API @brief Set mesh type to get mesh count information @param patternIndex: the pattern index to set the pattern mesh type, meshType: the mesh type to set the pattern mesh type "Triangle", "Quad" Other types not allowed """ .. code-tab:: c++ SetMeshType(int _patternIndex, const string& _meshType) /// @ingroup PATTERN_API /// @brief Set mesh type to get mesh count information /// @param patternIndex: the pattern index to set the pattern mesh type, /// meshType: the mesh type to set the pattern mesh type "Triangle", "Quad" Other types not allowed .. tabs:: .. code-tab:: python def SetMeshTypeW(_patternIndex : int, _meshType : str) -> None """ @ingroup PATTERN_API @brief Set mesh type to get mesh count information @param _patternIndex: the pattern index to set the pattern mesh type, _meshType: the mesh type to set the pattern mesh type "Triangle", "Quad" Other types not allowed """ .. code-tab:: c++ SetMeshTypeW(int _patternIndex, const wstring& _meshType) /// @ingroup PATTERN_API /// @brief Set mesh type to get mesh count information /// @param _patternIndex: the pattern index to set the pattern mesh type, /// _meshType: the mesh type to set the pattern mesh type "Triangle", "Quad" Other types not allowed .. tabs:: .. code-tab:: python def SetWidthShrinkagePercentage(_patternIndex : int, _width : float) -> None """ @ingroup PATTERN_API @brief Set Width Shrinkage Percentage using pattern index, width @param _patternIndex: the pattern index to set the pattern width shrinkage percentage, _width: the width value to determine width shrinkage percentage """ .. code-tab:: c++ SetWidthShrinkagePercentage(int _patternIndex, float _width) /// @ingroup PATTERN_API /// @brief Set Width Shrinkage Percentage using pattern index, width /// @param _patternIndex: the pattern index to set the pattern width shrinkage percentage, /// _width: the width value to determine width shrinkage percentage .. tabs:: .. code-tab:: python def SetHeightShrinkagePercentage(_patternIndex : int, _height : float) -> None """ @ingroup PATTERN_API @brief Set Height Shrinkage Percentage using pattern index, height @param _patternIndex: the pattern index to set the pattern height shrinkage percentage, _height: the height value to determine height shrinkage percentage """ .. code-tab:: c++ SetHeightShrinkagePercentage(int _patternIndex, float _height) /// @ingroup PATTERN_API /// @brief Set Height Shrinkage Percentage using pattern index, height /// @param _patternIndex: the pattern index to set the pattern height shrinkage percentage, /// _height: the height value to determine height shrinkage percentage .. tabs:: .. code-tab:: python def GetArrangementList() -> list[map[str, str]] """ @ingroup PATTERN_API @brief Get all ArrangementList @param none @return Output vector map string Arrangement information of avatar arrangementlist (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return vector infoMap """ .. code-tab:: c++ GetArrangementList() /// @ingroup PATTERN_API /// @brief Get all ArrangementList /// @param none /// @return Output vector map string Arrangement information of avatar arrangementlist (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return vector infoMap .. tabs:: .. code-tab:: python def GetArrangementOfPattern() -> list[map[str, str]] """ @ingroup PATTERN_API @brief Get Arrangement of patterns @param none @return Output vector map string Arrangement information of patterns (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return vector infoMap """ .. code-tab:: c++ GetArrangementOfPattern() /// @ingroup PATTERN_API /// @brief Get Arrangement of patterns /// @param none /// @return Output vector map string Arrangement information of patterns (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return vector infoMap .. tabs:: .. code-tab:: python def GetArrangementOfPattern(_patternIndex : int) -> map[str, str] """ @ingroup PATTERN_API @brief Get Arrangement of pattern which is using pattern index @param patternIndex: the pattern index to get the pattern arrangement information @return Output map string Arrangement information of pattern (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return infoMap """ .. code-tab:: c++ GetArrangementOfPattern(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get Arrangement of pattern which is using pattern index /// @param patternIndex: the pattern index to get the pattern arrangement information /// @return Output map string Arrangement information of pattern (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetArrangementOfPattern(_patternName : str) -> map[str, str] """ @ingroup PATTERN_API @brief Get Arrangement of pattern which is using the pattern name @param patternName: the pattern name to get the pattern arrangement information @return Output map string Arrangement information of pattern (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return infoMap """ .. code-tab:: c++ GetArrangementOfPattern(const string& _patternName) /// @ingroup PATTERN_API /// @brief Get Arrangement of pattern which is using the pattern name /// @param patternName: the pattern name to get the pattern arrangement information /// @return Output map string Arrangement information of pattern (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return infoMap .. tabs:: .. code-tab:: python def GetArrangementOfPatternW(_patternName : str) -> map[str, str] """ @ingroup PATTERN_API @brief Get Arrangement of pattern which is using the pattern name @param patternName: the pattern name to get the pattern arrangement information @return Output map string Arrangement information of pattern (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return infoMap """ .. code-tab:: c++ GetArrangementOfPatternW(const wstring& _patternName) /// @ingroup PATTERN_API /// @brief Get Arrangement of pattern which is using the pattern name /// @param patternName: the pattern name to get the pattern arrangement information /// @return Output map string Arrangement information of pattern (Arrangement Name,Type, Offset x,y,z, Orientation); If an error occurs, return infoMap .. tabs:: .. code-tab:: python def SetArrangementShapeStyle(_patternIndex : int, _shapeStyle : str) -> None """ @ingroup PATTERN_API @brief Set Arrangement ShapeStyle to set Arrangement ShapeStyle @param patternIndex: the pattern index to set the pattern Arrangement shapeStyle, shapeStyle: the shapeStyle to set the pattern shapeStyle "Flat", "Curved" Other types not allowed """ .. code-tab:: c++ SetArrangementShapeStyle(int _patternIndex, const string& _shapeStyle) /// @ingroup PATTERN_API /// @brief Set Arrangement ShapeStyle to set Arrangement ShapeStyle /// @param patternIndex: the pattern index to set the pattern Arrangement shapeStyle, /// shapeStyle: the shapeStyle to set the pattern shapeStyle "Flat", "Curved" Other types not allowed .. tabs:: .. code-tab:: python def SetArrangementShapeStyleW(_patternIndex : int, _shapeStyle : str) -> None """ @ingroup PATTERN_API @brief Set Arrangement ShapeStyle to set Arrangement ShapeStyle @param patternIndex: the pattern index to set the pattern arrangement ShapeStyle, shapeStyle: the shapeStyle to set the pattern shapeStyle "Flat", "Curved" Other types not allowed """ .. code-tab:: c++ SetArrangementShapeStyleW(int _patternIndex, const wstring& _shapeStyle) /// @ingroup PATTERN_API /// @brief Set Arrangement ShapeStyle to set Arrangement ShapeStyle /// @param patternIndex: the pattern index to set the pattern arrangement ShapeStyle, /// shapeStyle: the shapeStyle to set the pattern shapeStyle "Flat", "Curved" Other types not allowed .. tabs:: .. code-tab:: python def SetArrangementPosition(_patternIndex : int, _positionX : int, _positionY : int, _offset : int) -> None """ @ingroup PATTERN_API @brief Set Arrangement Position using positionX, positionY, offset @param patternIndex: the pattern index to set the pattern arrangement position, positionX, positionY, offset : the value to determine pattern arrangement positionX, positionY, offset """ .. code-tab:: c++ SetArrangementPosition(int _patternIndex, int _positionX, int _positionY, int _offset) /// @ingroup PATTERN_API /// @brief Set Arrangement Position using positionX, positionY, offset /// @param patternIndex: the pattern index to set the pattern arrangement position, /// positionX, positionY, offset : the value to determine pattern arrangement positionX, positionY, offset .. tabs:: .. code-tab:: python def SetArrangementOrientation(_patternIndex : int, _orientation : int) -> None """ @ingroup PATTERN_API @brief Set Arrangement Orientation using pattern arrangement Orientation @param patternIndex: the pattern index to set the pattern arrangement orientation, Orientation: the value to determine pattern arrangement orientation """ .. code-tab:: c++ SetArrangementOrientation(int _patternIndex, int _orientation) /// @ingroup PATTERN_API /// @brief Set Arrangement Orientation using pattern arrangement Orientation /// @param patternIndex: the pattern index to set the pattern arrangement orientation, /// Orientation: the value to determine pattern arrangement orientation .. tabs:: .. code-tab:: python def SetArrangement(_patternIndex : int, _arrangementIndex : int) -> None """ @ingroup PATTERN_API @brief Set Arrangement using arrangementlist Index @param patternIndex: the pattern index to set the arrangement ArrangementIndex: the value to determine arrangement information """ .. code-tab:: c++ SetArrangement(int _patternIndex, int _arrangementIndex) /// @ingroup PATTERN_API /// @brief Set Arrangement using arrangementlist Index /// @param patternIndex: the pattern index to set the arrangement /// ArrangementIndex: the value to determine arrangement information .. tabs:: .. code-tab:: python def CopyPatternPiecePos(_patternPieceIndex : int, _x : float, _y : float) -> int """ @ingroup PATTERN_API @brief Copy Pattern using the pattern index and x,y position @param patternIndex: the pattern index for copying pattern positionX, positionY : the value to determine pattern copy position """ .. code-tab:: c++ CopyPatternPiecePos(int _patternPieceIndex, float _x, float _y) /// @ingroup PATTERN_API /// @brief Copy Pattern using the pattern index and x,y position /// @param patternIndex: the pattern index for copying pattern /// positionX, positionY : the value to determine pattern copy position .. tabs:: .. code-tab:: python def CopyPatternPieceMove(_patternPieceIndex : int, _offsetX : float, _offsetY : float) -> int """ @ingroup PATTERN_API @brief Copy Pattern using the pattern index and x,y offset distance @param _patternPieceIndex: the pattern index for copying pattern _offsetX, _offsetY : the value to determine pattern copy offset distance, @return return copy pattern index """ .. code-tab:: c++ CopyPatternPieceMove(int _patternPieceIndex, float _offsetX, float _offsetY) /// @ingroup PATTERN_API /// @brief Copy Pattern using the pattern index and x,y offset distance /// @param _patternPieceIndex: the pattern index for copying pattern /// _offsetX, _offsetY : the value to determine pattern copy offset distance, /// @return return copy pattern index .. tabs:: .. code-tab:: python def DeletePatternPiece(_patternIndex : int) -> None """ @ingroup PATTERN_API @brief Delete Pattern using the pattern index @param _patternIndex: the pattern index for delete pattern """ .. code-tab:: c++ DeletePatternPiece(int _patternIndex) /// @ingroup PATTERN_API /// @brief Delete Pattern using the pattern index /// @param _patternIndex: the pattern index for delete pattern .. tabs:: .. code-tab:: python def DeleteLine(_patternIndex : int, _lineIndex : int) -> None """ @ingroup PATTERN_API @brief Delete a line from a pattern @param _patternIndex: the pattern index for delete pattern @param _lineIndex: the line index for delete line """ .. code-tab:: c++ DeleteLine(int _patternIndex, int _lineIndex) /// @ingroup PATTERN_API /// @brief Delete a line from a pattern /// @param _patternIndex: the pattern index for delete pattern /// @param _lineIndex: the line index for delete line .. tabs:: .. code-tab:: python def DeletePoint(_patternIndex : int, _pointIndex : int) -> None """ @ingroup PATTERN_API @brief Delete a point from a pattern @param _patternIndex: the pattern index for delete pattern @param _pointIndex: the point index for delete point """ .. code-tab:: c++ DeletePoint(int _patternIndex, int _pointIndex) /// @ingroup PATTERN_API /// @brief Delete a point from a pattern /// @param _patternIndex: the pattern index for delete pattern /// @param _pointIndex: the point index for delete point .. tabs:: .. code-tab:: python def FlipPatternPiece(_patternIndex : int, _bHorizontally : bool, _bEach : bool) -> None """ @ingroup PATTERN_API @brief Flip Pattern using the pattern index @param patternIndex: the pattern index for flip pattern _bHorizontally : the value is in the flip direction _bEach : the value is based on the pattern local matrix """ .. code-tab:: c++ FlipPatternPiece(int _patternIndex, bool _bHorizontally, bool _bEach) /// @ingroup PATTERN_API /// @brief Flip Pattern using the pattern index /// @param patternIndex: the pattern index for flip pattern /// _bHorizontally : the value is in the flip direction /// _bEach : the value is based on the pattern local matrix .. tabs:: .. code-tab:: python def LayerClonePatternPiecePos(_patternIndex : int, _x : float, _y : float, _bUnder : bool) -> None """ @ingroup PATTERN_API @brief Layer Clone Pattern using the pattern index and x,y position @param patternIndex: the pattern index for layer clone copying pattern positionX, positionY : the value to determine pattern copy position _bUnder : the value to 3D phase pattern position """ .. code-tab:: c++ LayerClonePatternPiecePos(int _patternIndex, float _x, float _y, bool _bUnder) /// @ingroup PATTERN_API /// @brief Layer Clone Pattern using the pattern index and x,y position /// @param patternIndex: the pattern index for layer clone copying pattern /// positionX, positionY : the value to determine pattern copy position /// _bUnder : the value to 3D phase pattern position .. tabs:: .. code-tab:: python def LayerClonePatternPieceMove(_patternIndex : int, _offsetX : float, _offsetY : float, _bUnder : bool) -> None """ @ingroup PATTERN_API @brief Layer Clone Pattern using the pattern index and x,y offset distance @param patternIndex: the pattern index for layer clone copying pattern _offsetX, _offsetY : the value to determine pattern copy offset distance, _bUnder : the value to 3D phase pattern position """ .. code-tab:: c++ LayerClonePatternPiecePos(int _patternIndex, float _offsetX, float _offsetY, bool _bUnder) /// @ingroup PATTERN_API /// @brief Layer Clone Pattern using the pattern index and x,y offset distance /// @param patternIndex: the pattern index for layer clone copying pattern /// _offsetX, _offsetY : the value to determine pattern copy offset distance, /// _bUnder : the value to 3D phase pattern position .. tabs:: .. code-tab:: python def OffsetAsInternalLine(_patternIndex : int, _lineIndex : int, _number : int, _distance : float, _bReverseDirection : bool, _bExtend : bool) -> None """ @ingroup PATTERN_API @brief OffsetAsInternalLine using the pattern index and offset option @param patternIndex: the pattern index for OffsetAsInternalLine pattern _lineIndex: the line index for Offset line _number: the value for number of offset internalLines, _distance: the value to offset distance, _bReverseDirection: the value to offset reverse direction, _bExtend: the value to offset internalLines extend, """ .. code-tab:: c++ OffsetAsInternalLine(int _patternIndex, int _lineIndex, int _number, float _distance, bool _bReverse, bool _bDirection, bool _bExtend) /// @ingroup PATTERN_API /// @brief OffsetAsInternalLine using the pattern index and offset option /// @param patternIndex: the pattern index for OffsetAsInternalLine pattern /// _lineIndex: the line index for Offset line /// _number: the value for number of offset internalLines, /// _distance: the value to offset distance, /// _bReverseDirection: the value to offset reverse direction, /// _bExtend: the value to offset internalLines extend, .. tabs:: .. code-tab:: python def UnfoldPatternPiece(_patternIndex : int, _lineIndex : int, _bHalfSymmetry : bool) -> bool """ @ingroup PATTERN_API @brief Unfold Pattern using the pattern index and line index and halfSymmetry option @param patternIndex: the pattern index for unfold pattern lineIndex: the line index for unfold line halfSymmetry: the value to make halfSymmetry pattern @return return true if success, false otherwise """ .. code-tab:: c++ UnfoldPatternPiece(int _patternIndex, int _lineIndex, bool _bHalfSymmetry) /// @ingroup PATTERN_API /// @brief Unfold Pattern using the pattern index and line index and halfSymmetry option /// @param patternIndex: the pattern index for unfold pattern /// lineIndex: the line index for unfold line /// halfSymmetry: the value to make halfSymmetry pattern /// @return return true if success, false otherwise .. tabs:: .. code-tab:: python def UnfoldPatternPieceWithPatternName(_patternName : str, _lineIndex : int, _bHalfSymmetry : bool) -> bool """ @ingroup PATTERN_API @brief Unfold Pattern using the pattern name and line index and halfSymmetry option @param _patternName: the pattern index for unfold pattern @param _lineIndex: the line index for unfold line @param _bHalfSymmetry: the value to make halfSymmetry pattern @return return true if success, false otherwise """ .. code-tab:: c++ UnfoldPatternPieceWithPatternName(std::wstring _patternName, int _lineIndex, bool _bHalfSymmetry) /// @ingroup PATTERN_API /// @brief Unfold Pattern using the pattern name and line index and halfSymmetry option /// @param _patternName: the pattern index for unfold pattern /// @param _lineIndex: the line index for unfold line /// @param _bHalfSymmetry: the value to make halfSymmetry pattern /// @return return true if success, false otherwise .. tabs:: .. code-tab:: python def SymmetryPatternPiece(_patternIndex : int, _bWithSewing : bool) -> None """ @ingroup PATTERN_API @brief Symmetry Pattern using the pattern index and withSewing option @param _patternIndex: the pattern index for symmetry pattern @param _bWithSewing: the value to make symmetry pattern with sewing """ .. code-tab:: c++ SymmetryPatternPiece(int _patternIndex, bool _bWithSewing) /// @ingroup PATTERN_API /// @brief Symmetry Pattern using the pattern index and withSewing option /// @param _patternIndex: the pattern index for symmetry pattern /// @param _bWithSewing: the value to make symmetry pattern with sewing .. tabs:: .. code-tab:: python def InstancePatternPiece(_patternIndex : int) -> None """ @ingroup PATTERN_API @brief Instance Pattern using the pattern index @param patternIndex: this pattern index for instance pattern """ .. code-tab:: c++ InstancePatternPiece(int _patternIndex) /// @ingroup PATTERN_API /// @brief Instance Pattern using the pattern index /// @param patternIndex: this pattern index for instance pattern .. tabs:: .. code-tab:: python def SymmetryPatternPieceWithPatternName(_patternName : str, _bWithSewing : bool) -> None """ @ingroup PATTERN_API @brief Symmetry Pattern using the pattern name and withSewing option @param _patternName: the pattern name for symmetry pattern @param _bWithSewing: the value to make symmetry pattern with sewing """ .. code-tab:: c++ SymmetryPatternPieceWithPatternName(std::wstring _patternName, bool _bWithSewing) /// @ingroup PATTERN_API /// @brief Symmetry Pattern using the pattern name and withSewing option /// @param _patternName: the pattern name for symmetry pattern /// @param _bWithSewing: the value to make symmetry pattern with sewing .. tabs:: .. code-tab:: python def InstancePatternPieceWithPatternName(_patternName : str) -> None """ @ingroup PATTERN_API @brief Instance Pattern using the pattern name @param _patternName: the pattern name for instance pattern """ .. code-tab:: c++ InstancePatternPieceWithPatternName(std::wstring _patternName) /// @ingroup PATTERN_API /// @brief Instance Pattern using the pattern name /// @param _patternName: the pattern name for instance pattern .. tabs:: .. code-tab:: python def GetPatternPieceName(_patternIndex : int) -> str """ @ingroup PATTERN_API @brief Get Pattern name using the pattern index @param _patternIndex: the pattern index for get name """ .. code-tab:: c++ GetPatternPieceName(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get Pattern name using the pattern index /// @param _patternIndex: the pattern index for get name .. tabs:: .. code-tab:: python def SetPatternPieceName(_patternIndex : int, _patternName : str) -> None """ @ingroup PATTERN_API @brief Set Pattern name using the pattern index @param _patternIndex: the pattern index to set @param _patternName: the value to set as pattern name """ .. code-tab:: c++ SetPatternPieceName(int _patternIndex) /// @ingroup PATTERN_API /// @brief Set Pattern name using the pattern index /// @param _patternIndex: the pattern index to set /// @param _patternName: the value to set as pattern name .. tabs:: .. code-tab:: python def GetPatternPieceFabricIndex(_patternPieceIndex : int) -> int """ @ingroup PATTERN_API @brief Get Pattern fabric index using the pattern index @param _patternIndex: the pattern index to get """ .. code-tab:: c++ GetPatternPieceFabricIndex(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get Pattern fabric index using the pattern index /// @param _patternIndex: the pattern index to get .. tabs:: .. code-tab:: python def SetPatternPieceFabricIndex(_patternPieceIndex : int, _fabricIndex : int) -> None """ @ingroup PATTERN_API @brief Set Pattern fabric index using the pattern index @param _patternIndex: the pattern index to set _fabricIndex: the value to set as gabric index """ .. code-tab:: c++ SetPatternPieceFabricIndex(int _patternPieceIndex, int _fabricIndex) /// @ingroup PATTERN_API /// @brief Set Pattern fabric index using the pattern index /// @param _patternIndex: the pattern index to set /// _fabricIndex: the value to set as gabric index .. tabs:: .. code-tab:: python def GetPatternPieceGrainDirection(_patternPieceIndex : int) -> float """ @ingroup PATTERN_API @brief Get Pattern Grain direction info using the pattern index @param _patternIndex: the pattern index to get """ .. code-tab:: c++ GetPatternPieceGrainDirection(int _patternPieceIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Grain direction info using the pattern index /// @param _patternIndex: the pattern index to get .. tabs:: .. code-tab:: python def SetPatternPieceGrainDirection(_patternPieceIndex : int, _degree : float) -> None """ @ingroup PATTERN_API @brief Set Pattern grain direction value using the pattern index @param _patternIndex: the pattern index to set _degree: the value to set as grain direction """ .. code-tab:: c++ SetPatternPieceGrainDirection(int _patternPieceIndex, float _degree) /// @ingroup PATTERN_API /// @brief Set Pattern grain direction value using the pattern index /// @param _patternIndex: the pattern index to set /// _degree: the value to set as grain direction .. tabs:: .. code-tab:: python def IsPatternPieceGrainLinkAllColorways(_patternPieceIndex : int) -> bool """ @ingroup PATTERN_API @brief Check if Pattern link all color ways value using the pattern index @param _patternIndex: the pattern index to set """ .. code-tab:: c++ IsPatternPieceGrainLinkAllColorways(int patternPieceIndex) /// @ingroup PATTERN_API /// @brief Check if Pattern link all color ways value using the pattern index /// @param _patternIndex: the pattern index to set .. tabs:: .. code-tab:: python def SetPatternPieceGrainLinkAllColorways(_patternPieceIndex : int, _isOn : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern link all color ways value using the pattern index @param _patternIndex: the pattern index to set _isOn: the value to set as link all color ways """ .. code-tab:: c++ SetPatternPieceGrainLinkAllColorways(int _patternPieceIndex, bool _isOn) /// @ingroup PATTERN_API /// @brief Set Pattern link all color ways value using the pattern index /// @param _patternIndex: the pattern index to set /// _isOn: the value to set as link all color ways .. tabs:: .. code-tab:: python def GetPatternPieceCategory(_patternPieceIndex : int) -> int """ @ingroup PATTERN_API @brief Get Pattern category number using the pattern index @param _patternPieceIndex: the pattern index to get """ .. code-tab:: c++ GetPatternPieceCategory(int _patternPieceIndex) /// @ingroup PATTERN_API /// @brief Get Pattern category number using the pattern index /// @param _patternPieceIndex: the pattern index to get .. tabs:: .. code-tab:: python def SetPatternPieceCategory(_patternPieceIndex : int, _category : int) -> None """ @ingroup PATTERN_API @brief Set Pattern category number using the pattern index @param _patternPieceIndex: the pattern index to get _category: the value to set category value """ .. code-tab:: c++ SetPatternPieceCategory(int _patternPieceIndex, int _category) /// @ingroup PATTERN_API /// @brief Set Pattern category number using the pattern index /// @param _patternPieceIndex: the pattern index to get /// _category: the value to set category value .. tabs:: .. code-tab:: python def GetPatternPieceClassification(_patternPieceIndex : int) -> str """ @ingroup PATTERN_API @brief Get Pattern classification using the pattern index @param _patternPieceIndex: the pattern index to get """ .. code-tab:: c++ GetPatternPieceClassification(int _patternPieceIndex) /// @ingroup PATTERN_API /// @brief Get Pattern classification using the pattern index /// @param _patternPieceIndex: the pattern index to get .. tabs:: .. code-tab:: python def SetPatternPieceClassification(_patternPieceIndex : int, _classification : str) -> None """ @ingroup PATTERN_API @brief Set Pattern classification using the pattern index @param _patternPieceIndex: the pattern index to get _classification: the value to set classification """ .. code-tab:: c++ SetPatternPieceClassification(int _patternPieceIndex, std::string _classification) /// @ingroup PATTERN_API /// @brief Set Pattern classification using the pattern index /// @param _patternPieceIndex: the pattern index to get /// _classification: the value to set classification .. tabs:: .. code-tab:: python def IsPatternPieceSolidify(_patternPieceIndex : int) -> bool """ @ingroup PATTERN_API @brief Check if Pattern Solidify using the pattern index @param _patternPieceIndex: the pattern index to get """ .. code-tab:: c++ IsPatternPieceSolidify(int _patternPieceIndex) /// @ingroup PATTERN_API /// @brief Check if Pattern Solidify using the pattern index /// @param _patternPieceIndex: the pattern index to get .. tabs:: .. code-tab:: python def SetPatternPieceSolidify(_patternPieceIndex : int, _isOn : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Solidify using the pattern index @param _patternPieceIndex: the pattern index to get _isOn: the value to set Solidify On/Off """ .. code-tab:: c++ SetPatternPieceSolidify(int _patternPieceIndex, bool _isOn); /// @ingroup PATTERN_API /// @brief Set Pattern Solidify using the pattern index /// @param _patternPieceIndex: the pattern index to get /// _isOn: the value to set Solidify On/Off .. tabs:: .. code-tab:: python def GetPatternPieceSolidifyStrengthen(_patternPieceIndex : int) -> float """ @ingroup PATTERN_API @brief Get Pattern Solidify using the pattern index @param _patternPieceIndex: the pattern index to get """ .. code-tab:: c++ GetPatternPieceSolidifyStrengthen(int _patternPieceIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Solidify using the pattern index /// @param _patternPieceIndex: the pattern index to get .. tabs:: .. code-tab:: python def SetPatternPieceSolidifyStrengthen(_patternPieceIndex : int, _strengthen : float) -> None """ @ingroup PATTERN_API @brief Set Pattern Solidify Strengthen using the pattern index @param _patternPieceIndex: the pattern index to set _strengthen : strengthen value to set """ .. code-tab:: c++ SetPatternPieceSolidifyStrengthen(int _patternPieceIndex, float _strengthen) /// @ingroup PATTERN_API /// @brief Set Pattern Solidify Strengthen using the pattern index /// @param _patternPieceIndex: the pattern index to set /// _strengthen : strengthen value to set .. tabs:: .. code-tab:: python def ConvertToBaseLine(_patternIndex : int, _childrenIndex : int) -> None """ @ingroup PATTERN_API @brief Convert To BaseLine using the pattern index and children index @param patternIndex: the pattern index for convert pattern children Index: the children index for convert children """ .. code-tab:: c++ ConvertToBaseLine(int _patternIndex, int _childrenIndex) /// @ingroup PATTERN_API /// @brief Convert To BaseLine using the pattern index and children index /// @param patternIndex: the pattern index for convert pattern /// children Index: the children index for convert children .. tabs:: .. code-tab:: python def ConvertToInternalLine(_patternIndex : int, _childrenIndex : int) -> None """ @ingroup PATTERN_API @brief Convert To InternalLine using the pattern index and children index @param _patternIndex: the pattern index for convert pattern _childrenIndex: the children index for convert children """ .. code-tab:: c++ ConvertToInternalLine(int _patternIndex, int _childrenIndex) /// @ingroup PATTERN_API /// @brief Convert To InternalLine using the pattern index and children index /// @param _patternIndex: the pattern index for convert pattern /// _childrenIndex: the children index for convert children .. tabs:: .. code-tab:: python def DistribueInternalLinesbetweenSegments(_patternIndex : int, _lineIndexs : list[int], _number : int, _bStraightLine : bool, _bPerpendicularDirection : bool, _bGraduateSegmentLengths : bool) -> None """ @ingroup PATTERN_API @brief Distribue Internal Lines betweenSegments using the pattern index and line indexs and option @param patternIndex: the pattern index for taget pattern lineIndexs: the line indexs for taget lines number: the number of internal shapes to be created straightLine: create an internal figure with straight lines perpendicularDirection: target line reversal GraduateSegmentLengths: extend to the outline of the pattern """ .. code-tab:: c++ DistribueInternalLinesbetweenSegments(int _patternIndex, vector _indexs, int _number, bool _bStraightLine, bool _bPerpendicularDirection, bool _bGraduateSegmentLengths) /// @ingroup PATTERN_API /// @brief Distribue Internal Lines betweenSegments using the pattern index and line indexs and option /// @param patternIndex: the pattern index for taget pattern /// lineIndexs: the line indexs for taget lines /// number: the number of internal shapes to be created /// straightLine: create an internal figure with straight lines /// perpendicularDirection: target line reversal /// GraduateSegmentLengths: extend to the outline of the pattern .. tabs:: .. code-tab:: python def GetPatternPiecePos(_patternIndex : int) -> list[float] """ @brief Get Pattern piece's world position @param _patternIndex: The pattern index to get the world position @return The world position of pattern is given in order (x, y). If an error occurs, return empty vector """ .. code-tab:: c++ GetPatternPiecePos(int _patternIndex) /// @brief Get Pattern piece's world position /// @param _patternIndex: The pattern index to get the world position /// @return The world position of pattern is given in order (x, y). If an error occurs, return empty vector .. tabs:: .. code-tab:: python def SetPatternPiecePos(_patternIndex : int, _x : float, _y : float) -> None """ @brief Set Pattern piece's world position to (_x, _y) @param _patternIndex: The pattern index to move _x: The X position of pattern want to move _y: The Y position of pattern want to move """ .. code-tab:: c++ SetPatternPiecePos(int _patternIndex) /// @brief Set Pattern piece's world position to (_x, _y) /// @param _patternIndex: The pattern index to move /// _x: The X position of pattern want to move /// _y: The Y position of pattern want to move .. tabs:: .. code-tab:: python def SetPatternPieceMove(_patternIndex : int, _offsetX : float, _offsetY : float) -> None """ @brief Set Pattern piece's world position to (CurrentPosition.x + _offsetX, CurrentPosition.y + _offsetY) @param _patternIndex: The pattern index to move _offsetX: The X position offset of pattern want to move _offsetY: The Y position offset of pattern want to move """ .. code-tab:: c++ SetPatternPieceMove(int _patternIndex, float _offsetX, float _offsetY) /// @brief Set Pattern piece's world position to (CurrentPosition.x + _offsetX, CurrentPosition.y + _offsetY) /// @param _patternIndex: The pattern index to move /// _offsetX: The X position offset of pattern want to move /// _offsetY: The Y position offset of pattern want to move .. tabs:: .. code-tab:: python def SetPatternPieceElastic(_patternIndex : int, _lineIndex : int, _bElastic : bool) -> None """ @brief Set Pattern piece's elastic. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply elastic _lineIndex: The line index to apply elastic. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _bElastic: Whether to apply elastic """ .. code-tab:: c++ SetPatternPieceElastic(int _patternIndex, int _lineIndex, bool _bElastic) /// @brief Set Pattern piece's elastic. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply elastic /// _lineIndex: The line index to apply elastic. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _bElastic: Whether to apply elastic .. tabs:: .. code-tab:: python def SetPatternPieceElasticStrength(_patternIndex : int, _lineIndex : int, _strength : float) -> None """ @brief Set Pattern piece's elastic strength. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply elastic strength _lineIndex: The line index to apply elastic strength. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _strength: The strength of elastic """ .. code-tab:: c++ SetPatternPieceElasticStrength(int _patternIndex, int _lineIndex, float _strength) /// @brief Set Pattern piece's elastic strength. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply elastic strength /// _lineIndex: The line index to apply elastic strength. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _strength: The strength of elastic .. tabs:: .. code-tab:: python def SetPatternPieceElasticStrengthRatio(_patternIndex : int, _lineIndex : int, _ratio : int) -> None """ @brief Set Pattern piece's elastic strength ratio. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply elastic strength ratio _lineIndex: The line index to apply elastic strength ratio. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _ratio: The strength ratio of elastic """ .. code-tab:: c++ SetPatternPieceElasticStrengthRatio(int _patternIndex, int _lineIndex, int _ratio) /// @brief Set Pattern piece's elastic strength ratio. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply elastic strength ratio /// _lineIndex: The line index to apply elastic strength ratio. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _ratio: The strength ratio of elastic .. tabs:: .. code-tab:: python def SetPatternPieceElasticSegmentLength(_patternIndex : int, _lineIndex : int, _segmentLength : float) -> None """ @brief Set Pattern piece's segment length of elastic. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply segment length _lineIndex: The line index to apply segment length. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _segmentLength: The segment length of elastic """ .. code-tab:: c++ SetPatternPieceElasticSegmentLength(int _patternIndex, int _lineIndex, float _segmentLength) /// @brief Set Pattern piece's segment length of elastic. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply segment length /// _lineIndex: The line index to apply segment length. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _segmentLength: The segment length of elastic .. tabs:: .. code-tab:: python def SetPatternPieceElasticTotalLength(_patternIndex : int, _lineIndex : int, _totalLength : float) -> None """ @brief Set Pattern piece's total length of elastic. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply total length _lineIndex: The line index to apply total length. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _totalLength: The total length of elasitc """ .. code-tab:: c++ SetPatternPieceElasticTotalLength(int _patternIndex, int _lineIndex, float _totalLength) /// @brief Set Pattern piece's total length of elastic. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply total length /// _lineIndex: The line index to apply total length. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _totalLength: The total length of elasitc .. tabs:: .. code-tab:: python def SetPatternPieceShirring(_patternIndex : int, _lineIndex : int, _bShirring : bool) -> None """ @brief Set Pattern piece's shirring. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply shirring _lineIndex: The line index to apply shirring. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _bShirring: Whether to apply shirring """ .. code-tab:: c++ SetPatternPieceShirring(int _patternIndex, int _lineIndex, bool _bShirring) /// @brief Set Pattern piece's shirring. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply shirring /// _lineIndex: The line index to apply shirring. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _bShirring: Whether to apply shirring .. tabs:: .. code-tab:: python def SetPatternPieceShirringInterval(_patternIndex : int, _lineIndex : int, _interval : float) -> None """ @brief Set Pattern piece's shirring interval. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply shirring interval _lineIndex: The line index to apply shirring interval. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _interval: The interval of shirring """ .. code-tab:: c++ SetPatternPieceShirringInterval(int _patternIndex, int _lineIndex, float _interval) /// @brief Set Pattern piece's shirring interval. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply shirring interval /// _lineIndex: The line index to apply shirring interval. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _interval: The interval of shirring .. tabs:: .. code-tab:: python def SetPatternPieceShirringHeight(_patternIndex : int, _lineIndex : int, _height : float) -> None """ @brief Set Pattern piece's shirring height. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply shirring height _lineIndex: The line index to apply shirring height. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _height: The height of shirring """ .. code-tab:: c++ SetPatternPieceShirringHeight(int _patternIndex, int _lineIndex, float _height) /// @brief Set Pattern piece's shirring height. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply shirring height /// _lineIndex: The line index to apply shirring height. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _height: The height of shirring .. tabs:: .. code-tab:: python def SetPatternPieceShirringExtend(_patternIndex : int, _lineIndex : int, _bExtend : bool) -> None """ @brief Set Pattern piece's shirring extend. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply shirring extend _lineIndex: The line index to apply shirring extend. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _bExtend: Whether to apply shirring extend """ .. code-tab:: c++ SetPatternPieceShirringExtend(int _patternIndex, int _lineIndex, bool _bExtend) /// @brief Set Pattern piece's shirring extend. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply shirring extend /// _lineIndex: The line index to apply shirring extend. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _bExtend: Whether to apply shirring extend .. tabs:: .. code-tab:: python def SetPatternPieceSeamtaping(_patternIndex : int, _lineIndex : int, _bSeamtaping : bool) -> None """ @brief Set Pattern piece's seamtaping. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply seamtaping _lineIndex: The line index to apply seamtaping. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _bSeamtaping: Whether to apply seamtaping """ .. code-tab:: c++ SetPatternPieceSeamtaping(int _patternIndex, int _lineIndex, bool _bSeamtaping) /// @brief Set Pattern piece's seamtaping. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply seamtaping /// _lineIndex: The line index to apply seamtaping. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _bSeamtaping: Whether to apply seamtaping .. tabs:: .. code-tab:: python def SetPatternPieceSametapingWidth(_patternIndex : int, _lineIndex : int, _width : float) -> None """ @brief Set Pattern piece's seamtaping width. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line @param _patternIndex: The pattern index to apply seamtaping width _lineIndex: The line index to apply seamtaping width. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line _width: The width of seamtaping width """ .. code-tab:: c++ SetPatternPieceSametapingWidth(int _patternIndex, int _lineIndex, float _width) /// @brief Set Pattern piece's seamtaping width. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// @param _patternIndex: The pattern index to apply seamtaping width /// _lineIndex: The line index to apply seamtaping width. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line /// _width: The width of seamtaping width .. tabs:: .. code-tab:: python def CreatePatternWithPoints(_points : list[tuple[float, float, int]]) -> int """ @brief Create a pattern using a set of vertices. @param _points: set of vertices. tuple --> postion X, postion Y, VertexType VertexType : 0, 2, 3 0 : Straight Point 2 : Spline Curve Point 3 : Bezier Curve Point """ .. code-tab:: c++ CreatePatternWithPoints /// @brief Create a pattern using a set of vertices. /// @param _points: set of vertices. /// tuple --> postion X, postion Y, VertexType /// VertexType : 0, 2, 3 /// 0 : Straight Point /// 2 : Spline Curve Point /// 3 : Bezier Curve Point .. tabs:: .. code-tab:: python def CreateInternalShapeWithPoints(_patternIndex : int, _points : list[tuple[float, float, int]], _isClosed : bool) -> int """ @brief Create a pattern's internal shape using a set of vertices. @param _patternIndex: Parent Pattern Index tuple --> postion X, postion Y, VertexType VertexType : 0, 2, 3 0 : Straight Point 2 : Spline Curve Point 3 : Bezier Curve Point _isClosed: If true, connect the last vertex to the first vertex. @return PatternIndex """ .. code-tab:: c++ CreateInternalShapeWithPoints /// @brief Create a pattern's internal shape using a set of vertices. /// @param _patternIndex: Parent Pattern Index /// tuple --> postion X, postion Y, VertexType /// VertexType : 0, 2, 3 /// 0 : Straight Point /// 2 : Spline Curve Point /// 3 : Bezier Curve Point /// _isClosed: If true, connect the last vertex to the first vertex. /// @return PatternIndex .. tabs:: .. code-tab:: python def CreateBaseShapeWithPoints(_patternIndex : int, _points : list[tuple[float, float, int]], _isClosed : bool) -> int """ @brief Create a pattern's base shape using a set of vertices. @param _patternIndex: Parent Pattern Index _points: set of vertices. tuple --> postion X, postion Y, VertexType VertexType : 0, 2, 3 0 : Straight Point 2 : Spline Curve Point 3 : Bezier Curve Point _isClosed: If true, connect the last vertex to the first vertex. @return InternalShapeIndex """ .. code-tab:: c++ CreateBaseShapeWithPoints /// @brief Create a pattern's base shape using a set of vertices. /// @param _patternIndex: Parent Pattern Index /// _points: set of vertices. /// tuple --> postion X, postion Y, VertexType /// VertexType : 0, 2, 3 /// 0 : Straight Point /// 2 : Spline Curve Point /// 3 : Bezier Curve Point /// _isClosed: If true, connect the last vertex to the first vertex. /// @return InternalShapeIndex .. tabs:: .. code-tab:: python def SetPatternLayer(_patternIndex : int, _layer : int) -> None """ @ingroup PATTERN_API @brief Set Pattern Layer using pattern index, layer @param patternIndex: the pattern index to set the pattern layer, layer: the layer value to determine pattern layer @return BaseShapeIndex """ .. code-tab:: c++ SetPatternLayer(int _patternIndex, int _layer) /// @ingroup PATTERN_API /// @brief Set Pattern Layer using pattern index, layer /// @param patternIndex: the pattern index to set the pattern layer, /// layer: the layer value to determine pattern layer /// @return BaseShapeIndex .. tabs:: .. code-tab:: python def GetPatternLayer(_patternIndex : int) -> int """ @ingroup PATTERN_API @brief Get Pattern Layer using pattern index @param patternIndex: the pattern index to get the pattern layer, """ .. code-tab:: c++ GetPatternLayer(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Layer using pattern index /// @param patternIndex: the pattern index to get the pattern layer, .. tabs:: .. code-tab:: python def SetPatternFreeze(_patternIndex : int, _bFreeze : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Freeze using pattern index, freeze state @param patternIndex: the pattern index to set the pattern freeze state, freeze: the freeze state to determine pattern freeze """ .. code-tab:: c++ SetPatternFreeze(int _patternIndex, int _bFreeze) /// @ingroup PATTERN_API /// @brief Set Pattern Freeze using pattern index, freeze state /// @param patternIndex: the pattern index to set the pattern freeze state, /// freeze: the freeze state to determine pattern freeze .. tabs:: .. code-tab:: python def SetPatternStrengthen(_patternIndex : int, _bStrengthen : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Strengthen using pattern index, Active state @param patternIndex: the pattern index to set the pattern Strengthen, Strengthen: the Active state to determine pattern Strengthen """ .. code-tab:: c++ SetPatternStrengthen(int _patternIndex, bool _bActive) /// @ingroup PATTERN_API /// @brief Set Pattern Strengthen using pattern index, Active state /// @param patternIndex: the pattern index to set the pattern Strengthen, /// Strengthen: the Active state to determine pattern Strengthen .. tabs:: .. code-tab:: python def SetPatternLock(_patternIndex : int, _bLock : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Lock using pattern index, Lock state @param patternIndex: the pattern index to set the pattern Lock, Lock: the Lock state to determine pattern Lock """ .. code-tab:: c++ SetPatternLock(int _patternIndex, bool _bLock) /// @ingroup PATTERN_API /// @brief Set Pattern Lock using pattern index, Lock state /// @param patternIndex: the pattern index to set the pattern Lock, /// Lock: the Lock state to determine pattern Lock .. tabs:: .. code-tab:: python def SetPatternHide3D(_patternIndex : int, _bHide : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Hide 3d using pattern index, Hide state @param patternIndex: the pattern index to set the pattern Hide 3d, Hide: the Hide state to determine pattern Lock """ .. code-tab:: c++ SetPatternHide3D(int _patternIndex, bool _bHide) /// @ingroup PATTERN_API /// @brief Set Pattern Hide 3d using pattern index, Hide state /// @param patternIndex: the pattern index to set the pattern Hide 3d, /// Hide: the Hide state to determine pattern Lock .. tabs:: .. code-tab:: python def AddSegmentTopstitch(_patternIndex : int, _lineIndex : int, _topStitchStyleIndex : int) -> bool """ @ingroup PATTERN_API @brief Add Segment Topstitch to Pattern using the pattern index, lineindex , topStitchStyleIndex @param patternIndex: the pattern index for Add Segment Topstitch to pattern @param lineIndex: the line index for topstitch added line @param topStitchStyleIndex: the topstitch style index for topstitch """ .. code-tab:: c++ AddSegmentTopstitch(int _patternIndex, int _lineIndex) /// @ingroup PATTERN_API /// @brief Add Segment Topstitch to Pattern using the pattern index, lineindex , topStitchStyleIndex /// @param patternIndex: the pattern index for Add Segment Topstitch to pattern /// @param lineIndex: the line index for topstitch added line /// @param topStitchStyleIndex: the topstitch style index for topstitch .. tabs:: .. code-tab:: python def AddSeamlineTopstitch(_seamlinePairGroupIndex : int, _startRatio : float, _endRatio : float, _topStichStyleIndex : int) -> bool """ @ingroup PATTERN_API @brief Add Seamline Topstitch to Seamline using the seamline pair group index, startRatio, endRatio, topStitchStyleIndex @param _seamlinePairGroupIndex: the seamline pair groupindex for Add Seamilne Topstitch to pattern @param _startRatio: This is where the topstitch starts. You need to enter what percentage of the total seamline pair group length you want to start at. @param _endRatio: This is where the topstitch ends. You need to enter what percentage of the total seamline pair group length you want to end at. @param _topStichStyleIndex : the topstitch style index for topstitch """ .. code-tab:: c++ AddSeamlineTopstitch(unsigned int _seamlinePairGroupIndex, float _startRatio, float _endRatio, int _topStichStyleIndex) /// @ingroup PATTERN_API /// @brief Add Seamline Topstitch to Seamline using the seamline pair group index, startRatio, endRatio, topStitchStyleIndex /// @param _seamlinePairGroupIndex: the seamline pair groupindex for Add Seamilne Topstitch to pattern /// @param _startRatio: This is where the topstitch starts. You need to enter what percentage of the total seamline pair group length you want to start at. /// @param _endRatio: This is where the topstitch ends. You need to enter what percentage of the total seamline pair group length you want to end at. /// @param _topStichStyleIndex : the topstitch style index for topstitch .. tabs:: .. code-tab:: python def GetTopstitchStyleList() -> list[map[str, str]] """ @ingroup PATTERN_API @brief Get all GetTopstitchStyleList @param none @return Output vector map string TopstitchStyleList information (Topstitch style Name, index); If an error occurs, return vector infoMap """ .. code-tab:: c++ GetTopstitchStyleList() /// @ingroup PATTERN_API /// @brief Get all GetTopstitchStyleList /// @param none /// @return Output vector map string TopstitchStyleList information (Topstitch style Name, index); If an error occurs, return vector infoMap .. tabs:: .. code-tab:: python def GetPatternAssignedTopstitchCount(_patternIndex : int) -> int """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch Count @param none @return Output int Count Pattern Assigned Topstitch Count; If an error occurs, return -1 """ .. code-tab:: c++ GetPatternAssignedTopstitchCount() /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch Count /// @param none /// @return Output int Count Pattern Assigned Topstitch Count; If an error occurs, return -1 .. tabs:: .. code-tab:: python def GetPatternAssignedTopstitchStyle(_patternIndex : int) -> list[map[str, str]] """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch style @param none @return Output vector map string Pattern Assigned Topstitch Style (Topstitch style Name, Count); If an error occurs, return vector vMap """ .. code-tab:: c++ GetPatternAssignedTopstitchStyle(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch style /// @param none /// @return Output vector map string Pattern Assigned Topstitch Style (Topstitch style Name, Count); If an error occurs, return vector vMap .. tabs:: .. code-tab:: python def GetPatternAssignedTopstitch(_patternIndex : int) -> list[map[str, str]] """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch @param patternIndex: the pattern index for Get Topstitch @return Output vector map string Pattern Assigned Topstitch (Topstitch Name, index); If an error occurs, return vector vMap """ .. code-tab:: c++ GetPatternAssignedTopstitch(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch /// @param patternIndex: the pattern index for Get Topstitch /// @return Output vector map string Pattern Assigned Topstitch (Topstitch Name, index); If an error occurs, return vector vMap .. tabs:: .. code-tab:: python def GetPatternAssignedTopstitchStyleIndex(_patternIndex : int, _segmentStitchIndex : int) -> int """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch Style @param patternIndex: the pattern index for Get Topstitch Style @return Output int Pattern Assigned Topstitch Syle index; If an error occurs, return 0 """ .. code-tab:: c++ GetPatternAssignedTopstitchStyleIndex(int _patternIndex, int _segmentStitchIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch Style /// @param patternIndex: the pattern index for Get Topstitch Style /// @return Output int Pattern Assigned Topstitch Syle index; If an error occurs, return 0 .. tabs:: .. code-tab:: python def SetPatternAssignedTopstitchStyle(_patternIndex : int, _segmentStitchIndex : int, _stitchStyleIndex : int) -> None """ @ingroup PATTERN_API @brief Set Pattern Assigned Topstitch Style @param patternIndex: the pattern index for Set Topstitch Style """ .. code-tab:: c++ SetPatternAssignedTopstitchStyle(int _patternIndex, int _segmentStitchIndex, int _stitchStyleIndex) /// @ingroup PATTERN_API /// @brief Set Pattern Assigned Topstitch Style /// @param patternIndex: the pattern index for Set Topstitch Style .. tabs:: .. code-tab:: python def IsPatternAssignedTopstitchExtendStart(_patternIndex : int, _segmentStitchIndex : int) -> bool """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch Property Value ExtendStart @param patternIndex: the pattern index for Get Topstitch Style @param segmentStitchIndex: the segmentStitch index for Get Topstitch property ExtendStart """ .. code-tab:: c++ IsPatternAssignedTopstitchExtendStart(int _patternIndex, int _segmentStitchIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch Property Value ExtendStart /// @param patternIndex: the pattern index for Get Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Get Topstitch property ExtendStart .. tabs:: .. code-tab:: python def SetPatternAssignedTopstitchExtendStart(_patternIndex : int, _segmentStitchIndex : int, _bStart : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Assigned Topstitch Property Value ExtendStart @param patternIndex: the pattern index for Set Topstitch Style @param segmentStitchIndex: the segmentStitch index for Set Topstitch property ExtendStart """ .. code-tab:: c++ SetPatternAssignedTopstitchExtendStart(int _patternIndex, int _segmentStitchIndex, bool _bStart) /// @ingroup PATTERN_API /// @brief Set Pattern Assigned Topstitch Property Value ExtendStart /// @param patternIndex: the pattern index for Set Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Set Topstitch property ExtendStart .. tabs:: .. code-tab:: python def IsPatternAssignedTopstitchExtendEnd(_patternIndex : int, _segmentStitchIndex : int) -> bool """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch Property Value ExtendEnd @param patternIndex: the pattern index for Get Topstitch Style @param segmentStitchIndex: the segmentStitch index for Get Topstitch property ExtendEnd """ .. code-tab:: c++ IsPatternAssignedTopstitchExtendEnd(int _patternIndex, int _segmentStitchIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch Property Value ExtendEnd /// @param patternIndex: the pattern index for Get Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Get Topstitch property ExtendEnd .. tabs:: .. code-tab:: python def SetPatternAssignedTopstitchExtendEnd(_patternIndex : int, _segmentStitchIndex : int, _bEnd : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Assigned Topstitch Property Value ExtendEnd @param patternIndex: the pattern index for Set Topstitch Style @param segmentStitchIndex: the segmentStitch index for Set Topstitch property ExtendEnd """ .. code-tab:: c++ SetPatternAssignedTopstitchExtendEnd(int _patternIndex, int _segmentStitchIndex, bool _bEnd) /// @ingroup PATTERN_API /// @brief Set Pattern Assigned Topstitch Property Value ExtendEnd /// @param patternIndex: the pattern index for Set Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Set Topstitch property ExtendEnd .. tabs:: .. code-tab:: python def IsPatternAssignedTopstitchCurved(_patternIndex : int, _segmentStitchIndex : int) -> bool """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch Property Value Curved @param patternIndex: the pattern index for Get Topstitch Style @param segmentStitchIndex: the segmentStitch index for Get Topstitch property Curved """ .. code-tab:: c++ IsPatternAssignedTopstitchCurved(int _patternIndex, int _segmentStitchIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch Property Value Curved /// @param patternIndex: the pattern index for Get Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Get Topstitch property Curved .. tabs:: .. code-tab:: python def SetPatternAssignedTopstitchCurved(_patternIndex : int, _segmentStitchIndex : int, _bCurved : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Assigned Topstitch Property Value Curved @param patternIndex: the pattern index for Set Topstitch Style @param segmentStitchIndex: the segmentStitch index for Set Topstitch property Curved """ .. code-tab:: c++ SetPatternAssignedTopstitchCurved(int _patternIndex, int _segmentStitchIndex, bool _bCurved) /// @ingroup PATTERN_API /// @brief Set Pattern Assigned Topstitch Property Value Curved /// @param patternIndex: the pattern index for Set Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Set Topstitch property Curved .. tabs:: .. code-tab:: python def GetPatternAssignedTopstitchCurvedLength(_patternIndex : int, _segmentStitchIndex : int) -> int """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch Property Value CurvedLength @param patternIndex: the pattern index for Get Topstitch Style @param segmentStitchIndex: the segmentStitch index for Get Topstitch property CurvedLength """ .. code-tab:: c++ GetPatternAssignedTopstitchCurvedLength(int _patternIndex, int _segmentStitchIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch Property Value CurvedLength /// @param patternIndex: the pattern index for Get Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Get Topstitch property CurvedLength .. tabs:: .. code-tab:: python def SetPatternAssignedTopstitchCurvedLength(_patternIndex : int, _segmentStitchIndex : int, _length : int) -> None """ @ingroup PATTERN_API @brief Set Pattern Assigned Topstitch Property Value CurvedLength @param patternIndex: the pattern index for Set Topstitch Style @param segmentStitchIndex: the segmentStitch index for Set Topstitch property CurvedLength """ .. code-tab:: c++ SetPatternAssignedTopstitchCurvedLength(int _patternIndex, int _segmentStitchIndex, int _length) /// @ingroup PATTERN_API /// @brief Set Pattern Assigned Topstitch Property Value CurvedLength /// @param patternIndex: the pattern index for Set Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Set Topstitch property CurvedLength .. tabs:: .. code-tab:: python def IsPatternAssignedTopstitchCurvedRightAngled(_patternIndex : int, _segmentStitchIndex : int) -> bool """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch Property Value CurvedRightAngled @param patternIndex: the pattern index for Get Topstitch Style @param segmentStitchIndex: the segmentStitch index for Get Topstitch property CurvedRightAngled """ .. code-tab:: c++ IsPatternAssignedTopstitchCurvedRightAngled(int _patternIndex, int _segmentStitchIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch Property Value CurvedRightAngled /// @param patternIndex: the pattern index for Get Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Get Topstitch property CurvedRightAngled .. tabs:: .. code-tab:: python def SetPatternAssignedTopstitchCurvedRightAngled(_patternIndex : int, _segmentStitchIndex : int, _bRightAngled : bool) -> None """ @ingroup PATTERN_API @brief Set Pattern Assigned Topstitch Property Value CurvedRightAngled @param patternIndex: the pattern index for Set Topstitch Style @param segmentStitchIndex: the segmentStitch index for Set Topstitch property CurvedRightAngled """ .. code-tab:: c++ SetPatternAssignedTopstitchCurvedRightAngled(int _patternIndex, int _segmentStitchIndex, bool _bRightAngled) /// @ingroup PATTERN_API /// @brief Set Pattern Assigned Topstitch Property Value CurvedRightAngled /// @param patternIndex: the pattern index for Set Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Set Topstitch property CurvedRightAngled .. tabs:: .. code-tab:: python def GetPatternAssignedTopstitchZOffset(_patternIndex : int, _segmentStitchIndex : int) -> float """ @ingroup PATTERN_API @brief Get Pattern Assigned Topstitch Property Value ZOffset @param patternIndex: the pattern index for Get Topstitch Style @param segmentStitchIndex: the segmentStitch index for Get Topstitch property ZOffset """ .. code-tab:: c++ GetPatternAssignedTopstitchZOffset(int _patternIndex, int _segmentStitchIndex) /// @ingroup PATTERN_API /// @brief Get Pattern Assigned Topstitch Property Value ZOffset /// @param patternIndex: the pattern index for Get Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Get Topstitch property ZOffset .. tabs:: .. code-tab:: python def SetPatternAssignedTopstitchZOffset(_patternIndex : int, _segmentStitchIndex : int, _zOffset : float) -> None """ @ingroup PATTERN_API @brief Set Pattern Assigned Topstitch Property Value ZOffset @param patternIndex: the pattern index for Set Topstitch Style @param segmentStitchIndex: the segmentStitch index for Set Topstitch property ZOffset """ .. code-tab:: c++ SetPatternAssignedTopstitchZOffset(int _patternIndex, int _segmentStitchIndex, float _zOffset) /// @ingroup PATTERN_API /// @brief Set Pattern Assigned Topstitch Property Value ZOffset /// @param patternIndex: the pattern index for Set Topstitch Style /// @param segmentStitchIndex: the segmentStitch index for Set Topstitch property ZOffset .. tabs:: .. code-tab:: python def ImportTopStitchStyle(_filePath : str) -> bool """ @ingroup PATTERN_API @brief Import TopStitch Style from file path @param filePath: the .sst file path for Import TopStitch Style """ .. code-tab:: c++ ImportTopStitchStyle(const string& _filePath) /// @ingroup PATTERN_API /// @brief Import TopStitch Style from file path /// @param filePath: the .sst file path for Import TopStitch Style .. tabs:: .. code-tab:: python def GetNestingPatternPieceGrainDirection(patternPieceIndex : int) -> int """ @ingroup PATTERN_API @brief Returns the index of the graindirection option widget for the pattern. @param patternPieceIndex: PatternIndex """ .. code-tab:: c++ GetNestingPatternPieceGrainDirection(int patternPieceIndex) /// @ingroup PATTERN_API /// @brief Returns the index of the graindirection option widget for the pattern. /// @param patternPieceIndex: PatternIndex .. tabs:: .. code-tab:: python def SetNestingPatternPieceGrainDirection(patternPieceIndex : int, menuIndex : int) -> None """ @ingroup PATTERN_API @brief Set the index of the graindirection option widget for the pattern. @param patternPieceIndex: PatternIndex @param menuIndex: graindirection option widget index, 0 : 1-way, 1 : 2-way , 2 : 4-way """ .. code-tab:: c++ SetNestingPatternPieceGrainDirection(int patternPieceIndex, int menuIndex) /// @ingroup PATTERN_API /// @brief Set the index of the graindirection option widget for the pattern. /// @param patternPieceIndex: PatternIndex /// @param menuIndex: graindirection option widget index, 0 : 1-way, 1 : 2-way , 2 : 4-way .. tabs:: .. code-tab:: python def GetNestingFixedPatternPiecePos(patternPieceIndex : int) -> std::pair[int, int] """ @ingroup PATTERN_API @brief When the pattern is fixed in print layout mode, the coordinates of the fixed position are returned. If not, it returns {0, 0}. @param patternPieceIndex: PatternIndex """ .. code-tab:: c++ GetNestingFixedPatternPiecePos(int patternPieceIndex) /// @ingroup PATTERN_API /// @brief When the pattern is fixed in print layout mode, the coordinates of the fixed position are returned. If not, it returns {0, 0}. /// @param patternPieceIndex: PatternIndex .. tabs:: .. code-tab:: python def SetNestingFixedPatternPiecePos(patternPieceIndex : int, x : int, y : int) -> None """ @ingroup PATTERN_API @brief Fix the pattern in print layout mode. @param patternPieceIndex: PatternIndex @param x: fixed position x @param y: fixed position y """ .. code-tab:: c++ SetNestingFixedPatternPiecePos(int patternPieceIndex, int x, int y) /// @ingroup PATTERN_API /// @brief Fix the pattern in print layout mode. /// @param patternPieceIndex: PatternIndex /// @param x: fixed position x /// @param y: fixed position y .. tabs:: .. code-tab:: python def AddPatternAnnotation(patternIndex : int, posX : float, posY : float, annotation : str) -> None """ @ingroup PATTERN_API @brief Add Annotation in pattern @param patternPieceIndex: PatternIndex @param posX: annotation position x @param posY: annotation position y """ .. code-tab:: c++ AddPatternAnnotation(int patternIndex, float posX, float posY, std::string annotation) /// @ingroup PATTERN_API /// @brief Add Annotation in pattern /// @param patternPieceIndex: PatternIndex /// @param posX: annotation position x /// @param posY: annotation position y .. tabs:: .. code-tab:: python def EditPatternAnnotation(patternIndex : int, posX : float, posY : float, annotationIndex : int, annotation : str) -> None """ @ingroup PATTERN_API @brief Edit Annotation @param patternPieceIndex: PatternIndex @param posX: annotation position x @param posY: annotation position y @param annotationIndex: annotation Index """ .. code-tab:: c++ EditPatternAnnotation(int patternIndex, float posX, float posY, int annotationIndex, std::string annotation) /// @ingroup PATTERN_API /// @brief Edit Annotation /// @param patternPieceIndex: PatternIndex /// @param posX: annotation position x /// @param posY: annotation position y /// @param annotationIndex: annotation Index .. tabs:: .. code-tab:: python def GetPatternAnnotation(patternIndex : int) -> list[tuple[str, float, float]] """ @ingroup PATTERN_API @brief Returns all annotations the pattern has. @param patternIndex: PatternIndex """ .. code-tab:: c++ GetPatternAnnotation(int patternIndex) /// @ingroup PATTERN_API /// @brief Returns all annotations the pattern has. /// @param patternIndex: PatternIndex .. tabs:: .. code-tab:: python def GetLinkedPatternIndex(patternIndex : int) -> list[int] """ @ingroup PATTERN_API @brief Get the pattern index information connected to the pattern. @param patternIndex: Tartget Pattern Index """ .. code-tab:: c++ std::vector GetLinkedPatternIndex(int patternIndex) /// @ingroup PATTERN_API /// @brief Get the pattern index information connected to the pattern. /// @param patternIndex: Tartget Pattern Index .. tabs:: .. code-tab:: python def GetTopstitchStyleModelType(_topStitchStyleIndex : int) -> int """ @ingroup PATTERN_API @brief Get topstitch style's model type (Type value: OBJ = 0, Texture = 1, Fail = -1) @param _topStitchStyleIndex: the topstitch style index for topstitch """ .. code-tab:: c++ GetTopstitchStyleModelType(int _topStitchStyleIndex) /// @ingroup PATTERN_API /// @brief Get topstitch style's model type (Type value: OBJ = 0, Texture = 1, Fail = -1) /// @param _topStitchStyleIndex: the topstitch style index for topstitch .. tabs:: .. code-tab:: python def SetTopstitchStyleModelType(_topStitchStyleIndex : int, _modelType : int) -> bool """ @ingroup PATTERN_API @brief Set topstitch style's model type. If it succeeds, return true @param _topStitchStyleIndex: the topstitch style index for topstitch @param _modelType: the topstitch style model type (Type value: OBJ = 0, Texture = 1) """ .. code-tab:: c++ SetTopstitchStyleModelType(int _topStitchStyleIndex, int _modelType) /// @ingroup PATTERN_API /// @brief Set topstitch style's model type. If it succeeds, return true /// @param _topStitchStyleIndex: the topstitch style index for topstitch /// @param _modelType: the topstitch style model type (Type value: OBJ = 0, Texture = 1) .. tabs:: .. code-tab:: python def ExportObjectBrowserMaterialsList() -> str """ @ingroup PATTERN_API @brief Get the material name used in the garment @return json string for pattern input information """ .. code-tab:: c++ ExportObjectBrowserMaterialsList() /// @ingroup PATTERN_API /// @brief Get the material name used in the garment /// @return json string for pattern input information .. tabs:: .. code-tab:: python def GetPinListSize() -> int """ @ingroup PATTERN_API @brief Count the number of pins from patterns @return number of pins """ .. code-tab:: c++ GetPinListSize() /// @ingroup PATTERN_API /// @brief Count the number of pins from patterns /// @return number of pins .. tabs:: .. code-tab:: python def RemovePin() -> bool """ @ingroup PATTERN_API @brief Removes Pin one by one """ .. code-tab:: c++ RemovePin() /// @ingroup PATTERN_API /// @brief Removes Pin one by one .. tabs:: .. code-tab:: python def RemoveAllPins() -> bool """ @ingroup PATTERN_API @brief Removes all active pins """ .. code-tab:: c++ RemoveAllPins() /// @ingroup PATTERN_API /// @brief Removes all active pins .. tabs:: .. code-tab:: python def GetValidGradingSizeGroupInformation() -> list[str] """ @ingroup PATTERN_API @brief Gets the names of the grading size groups that are valid for the patterns currently loaded in the scene. @return names of the grading size groups """ .. code-tab:: c++ GetValidGradingSizeGroupInformation() /// @ingroup PATTERN_API /// @brief Gets the names of the grading size groups that are valid for the patterns currently loaded in the scene. /// @return names of the grading size groups .. tabs:: .. code-tab:: python def GetValidGradingSizeGroupCount() -> int """ @ingroup PATTERN_API @brief Get the size of the grading size grouplist that is valid for the patterns currently loaded in the scene. @return size of the grading size groups """ .. code-tab:: c++ GetValidGradingSizeGroupCount() /// @ingroup PATTERN_API /// @brief Get the size of the grading size grouplist that is valid for the patterns currently loaded in the scene. /// @return size of the grading size groups .. tabs:: .. code-tab:: python def GetGradingSizeGroupInformation() -> list[str] """ @ingroup PATTERN_API @brief Get the names of all existing grading size groups. @return names of the grading size groups """ .. code-tab:: c++ GetGradingSizeGroupNameList() /// @ingroup PATTERN_API /// @brief Get the names of all existing grading size groups. /// @return names of the grading size groups .. tabs:: .. code-tab:: python def GetGradingSizeGroupCount() -> int """ @ingroup PATTERN_API @brief Get the size of all existing grading size groups. @return size of the grading size groups """ .. code-tab:: c++ GetGradingSizeGroupCount() /// @ingroup PATTERN_API /// @brief Get the size of all existing grading size groups. /// @return size of the grading size groups .. tabs:: .. code-tab:: python def GetGradingSizeTotalCount() -> int """ @ingroup PATTERN_API @brief Get the number of sizes/gradings @return total count of sizes/gradings """ .. code-tab:: c++ GetGradingSizeTotalCount() /// @ingroup PATTERN_API /// @brief Get the number of sizes/gradings /// @return total count of sizes/gradings .. tabs:: .. code-tab:: python def GetCurrentGradingSizeIndex() -> int """ @ingroup PATTERN_API @brief Get the index of the current size/grading @return the current index of size/grading """ .. code-tab:: c++ GetCurrentGradingSizeIndex() /// @ingroup PATTERN_API /// @brief Get the index of the current size/grading /// @return the current index of size/grading .. tabs:: .. code-tab:: python def GetGradingSizeListFromRuleTable(_gradingSizeGroupName : str) -> list[str] """ @ingroup PATTERN_API @brief Get the list of name about the grading size from grading size group; @return the list of name of all sizes/gradings """ .. code-tab:: c++ GetGradingSizeListFromRuleTable() /// @ingroup PATTERN_API /// @brief Get the list of name about the grading size from grading size group; /// @return the list of name of all sizes/gradings .. tabs:: .. code-tab:: python def GetGradingSizeListFromRuleTable(_gradingSizeGroupIndex : int) -> list[str] """ """ .. code-tab:: c++ GetGradingSizeListFromRuleTable(_gradingSizeGroupIndex) .. tabs:: .. code-tab:: python def GetGradingSizeNameList() -> list[str] """ @ingroup PATTERN_API @brief Get the name of the current size/grading @return the list of name of all sizes/gradings """ .. code-tab:: c++ GetGradingSizeNameList() /// @ingroup PATTERN_API /// @brief Get the name of the current size/grading /// @return the list of name of all sizes/gradings .. tabs:: .. code-tab:: python def GetGradingSizeNameListW() -> list[str] """ @ingroup PATTERN_API @brief Get the index of the current size/grading @return the list of name of all sizes/gradings """ .. code-tab:: c++ GetSizeNameListW() /// @ingroup PATTERN_API /// @brief Get the index of the current size/grading /// @return the list of name of all sizes/gradings .. tabs:: .. code-tab:: python def ChangeGradingSizeInformation(_gradingSizeGroupName : str, _gradingSizeName : str) -> bool """ @ingroup PATTERN_API @brief Change Grading Size information @param _gradingSizeGroupName: sizegroup name @param _gradingSizeName: grading size name @return Successful grading size change """ .. code-tab:: c++ ChangeGradingSizeInformation(const std::wstring& _gradingSizeGroupName, const std::wstring& _gradingSizeName) /// @ingroup PATTERN_API /// @brief Change Grading Size information /// @param _gradingSizeGroupName: sizegroup name /// @param _gradingSizeName: grading size name /// @return Successful grading size change .. tabs:: .. code-tab:: python def ChangeGradingSizeInformation(_gradingSizeGroupIndex : int, _gradingSizeIndex : int) -> bool """ @ingroup PATTERN_API @brief Change Grading Size information @param _gradingSizeGroupIndex: sizegroup index @param _gradingSizeIndex: grading size index @return Successful grading size change """ .. code-tab:: c++ ChangeGradingSizeInformation(unsigned int _gradingSizeGroupIndex, unsigned int _gradingSizeIndex) /// @ingroup PATTERN_API /// @brief Change Grading Size information /// @param _gradingSizeGroupIndex: sizegroup index /// @param _gradingSizeIndex: grading size index /// @return Successful grading size change .. tabs:: .. code-tab:: python def GetGradingPairedAvatar(_gradingIndex : int) -> str """ @ingroup PATTERN_API @brief Get grading paired avatar's name @return Paired avatar's name @param grading index """ .. code-tab:: c++ GetGradingPairedAvatar(unsigned int _gradingIndex) /// @ingroup PATTERN_API /// @brief Get grading paired avatar's name /// @return Paired avatar's name /// @param grading index .. tabs:: .. code-tab:: python def GetSeamlinePairGroupListInPattern(_patternIndex : int) -> list[ int] """ @ingroup PATTERN_API @brief Gets a list of the seamlinePairGroup associated with the pattern. @return Index List of seamlinePairGroup @param _patternIndex: pattern index """ .. code-tab:: c++ GetSeamlinePairGroupListInPattern(unsigned int _patternIndex) /// @ingroup PATTERN_API /// @brief Gets a list of the seamlinePairGroup associated with the pattern. /// @return Index List of seamlinePairGroup /// @param _patternIndex: pattern index .. tabs:: .. code-tab:: python def GetSeamlinePairGroupCount() -> int """ @ingroup PATTERN_API @brief Gets the number of seamlinePairGroup that exist in the scene. @return Number of seamlinePairGroup """ .. code-tab:: c++ GetSeamlinePairGroupCount() /// @ingroup PATTERN_API /// @brief Gets the number of seamlinePairGroup that exist in the scene. /// @return Number of seamlinePairGroup .. tabs:: .. code-tab:: python def GetSeamlinePairGroupName(_seamlinePiarGroupIndex : int) -> str """ @ingroup PATTERN_API @brief Get name from seamline pair group index @return name of seamline Pair Group @param _seamlinePiarGroupIndex : seamlinePairGroup index """ .. code-tab:: c++ GetSeamlinePairGroupName(int _seamlinePiarGroupIndex) /// @ingroup PATTERN_API /// @brief Get name from seamline pair group index /// @return name of seamline Pair Group /// @param _seamlinePiarGroupIndex : seamlinePairGroup index .. tabs:: .. code-tab:: python def GetSeamlinePairGroupNameW(_seamlinePiarGroupIndex : int) -> str """ @ingroup PATTERN_API @brief Get name from seamline pair group index @return name of seamline Pair Group @param _seamlinePiarGroupIndex : seamline Pair Group index """ .. code-tab:: c++ GetSeamlinePairGroupNameW(int _seamlinePiarGroupIndex) /// @ingroup PATTERN_API /// @brief Get name from seamline pair group index /// @return name of seamline Pair Group /// @param _seamlinePiarGroupIndex : seamline Pair Group index .. tabs:: .. code-tab:: python def GetSeamlinePairGroupIndexFromName(_seamlinePairGroupName : str) -> int """ @ingroup PATTERN_API @brief Get index from seamline pair group name @return name of sewing group(wide string) @param _seamlinePairGroupName : seamlinePairGroup name """ .. code-tab:: c++ GetSeamlinePairGroupIndexFromName(std::string _seamlinePairGroupName) /// @ingroup PATTERN_API /// @brief Get index from seamline pair group name /// @return name of sewing group(wide string) /// @param _seamlinePairGroupName : seamlinePairGroup name .. tabs:: .. code-tab:: python def GetSeamlinePairGroupIndexFromNameW(_seamlinePairGroupNameW : str) -> int """ @ingroup PATTERN_API @brief Get index from seamline pair group name @return name of sewing group(wide string) @param _seamlinePairGroupNameW : seamlinePairGroup name """ .. code-tab:: c++ GetSeamlinePairGroupIndexFromName(std::string _seamlinePairGroupName) /// @ingroup PATTERN_API /// @brief Get index from seamline pair group name /// @return name of sewing group(wide string) /// @param _seamlinePairGroupNameW : seamlinePairGroup name .. tabs:: .. code-tab:: python def ExportPatternJSON(_path : str) -> bool """ @ingroup PATTERN_API @brief Export pattern information by JSON format @return boolean result of exporting json file """ .. code-tab:: c++ ExportPatternJSON(std::string _path) /// @ingroup PATTERN_API /// @brief Export pattern information by JSON format /// @return boolean result of exporting json file .. tabs:: .. code-tab:: python def ImportPatternJSON(_path : str) -> bool """ @ingroup PATTERN_API @brief Import pattern information of JSON file @return boolean result of importing json file """ .. code-tab:: c++ ImportPatternJSON(std::string _path) /// @ingroup PATTERN_API /// @brief Import pattern information of JSON file /// @return boolean result of importing json file .. tabs:: .. code-tab:: python def ExportPatternCPX(_path : str) -> bool """ @ingroup PATTERN_API @brief Export pattern information in binary .cpx (CLO Pattern eXchange) format. Returns false on hosts without CLO_HAS_PATTERN_API_CPX support (e.g. WASM builds). @return boolean result of exporting cpx file """ .. code-tab:: c++ ExportPatternCPX(std::string _path) /// @ingroup PATTERN_API /// @brief Export pattern information in binary .cpx (CLO Pattern eXchange) format. /// Returns false on hosts without CLO_HAS_PATTERN_API_CPX support /// (e.g. WASM builds). /// @return boolean result of exporting cpx file .. tabs:: .. code-tab:: python def ImportPatternCPX(_path : str) -> bool """ @ingroup PATTERN_API @brief Import pattern information from a .cpx binary file. Returns false on hosts without CLO_HAS_PATTERN_API_CPX support. @return boolean result of importing cpx file """ .. code-tab:: c++ ImportPatternCPX(std::string _path) /// @ingroup PATTERN_API /// @brief Import pattern information from a .cpx binary file. /// Returns false on hosts without CLO_HAS_PATTERN_API_CPX support. /// @return boolean result of importing cpx file .. tabs:: .. code-tab:: python def ConvertPatternJSONToCPX(_jsonPath : str, _cpxPath : str) -> bool """ @ingroup PATTERN_API @brief Convert a .json pattern file to a .cpx binary without permanently altering the current scene's user-visible state. Useful for batch conversion / vendor pipelines. Returns false on hosts without CLO_HAS_PATTERN_API_CPX support. @return boolean result of conversion """ .. code-tab:: c++ ConvertPatternJSONToCPX(std::string _jsonPath, std::string _cpxPath) /// @ingroup PATTERN_API /// @brief Convert a .json pattern file to a .cpx binary without /// permanently altering the current scene's user-visible state. /// Useful for batch conversion / vendor pipelines. /// Returns false on hosts without CLO_HAS_PATTERN_API_CPX support. /// @return boolean result of conversion .. tabs:: .. code-tab:: python def GetAllStitchProperty() -> str """ @ingroup PATTERN_API @brief Gets property information for all the stitches that exist in the scene. It will be returned as a JSON string. @return stitch property list, It will be returned as a JSON string. """ .. code-tab:: c++ GetAllStitchProperty() /// @ingroup PATTERN_API /// @brief Gets property information for all the stitches that exist in the scene. It will be returned as a JSON string. /// @return stitch property list, It will be returned as a JSON string. .. tabs:: .. code-tab:: python def AddSeamlinePairGroup(_patternAIndex : int, _lineAIndex : int, _patternBIndex : int, _lineBIndex : int, _directionA : bool, _directionB : bool) -> bool """ @ingroup PATTERN_API @brief Add Pattern and Sewing between Pattern @return name of sewing group(wide string) @param _patternAIndex : A pattern index @param _lineAIndex : The index of the line that belongs to the A pattern. @param _patternBIndex : B pattern index @param _lineBIndex : The index of the line that belongs to the B pattern. @param _directionA : The direction of the stitching, true : forward, false : backward @param _directionB : The direction of the stitching, true : forward, false : backward """ .. code-tab:: c++ AddSeamlinePairGroup(int _patternAIndex, int _lineAIndex, int _patternBIndex, int _lineBIndex, bool _bReverse) /// @ingroup PATTERN_API /// @brief Add Pattern and Sewing between Pattern /// @return name of sewing group(wide string) /// @param _patternAIndex : A pattern index /// @param _lineAIndex : The index of the line that belongs to the A pattern. /// @param _patternBIndex : B pattern index /// @param _lineBIndex : The index of the line that belongs to the B pattern. /// @param _directionA : The direction of the stitching, true : forward, false : backward /// @param _directionB : The direction of the stitching, true : forward, false : backward .. tabs:: .. code-tab:: python def AddSeamlinePairGroup(_patternAIndex : int, _lineAIndex : int, _patternBIndex : int, _childIndex : int, _lineBIndex : int, _directionA : bool, _directionB : bool) -> bool """ @ingroup PATTERN_API @brief Add Patterns and Sewing between InnerShape @return name of sewing group(wide string) @param _patternAIndex : A pattern index @param _lineAIndex : The index of the line that belongs to the A pattern. @param _patternBIndex : B pattern index @param _childIndex : The index of the innershape that belongs to the B pattern. @param _lineBIndex : The index of the line that belongs to the innerShape. @param _directionA : The direction of the stitching, true : forward, false : backward @param _directionB : The direction of the stitching, true : forward, false : backward """ .. code-tab:: c++ AddSeamlinePairGroup(int _patternAIndex, int _lineAIndex, int _patternBIndex, int _lineBIndex, bool _directionA, bool _directionB) /// @ingroup PATTERN_API /// @brief Add Patterns and Sewing between InnerShape /// @return name of sewing group(wide string) /// @param _patternAIndex : A pattern index /// @param _lineAIndex : The index of the line that belongs to the A pattern. /// @param _patternBIndex : B pattern index /// @param _childIndex : The index of the innershape that belongs to the B pattern. /// @param _lineBIndex : The index of the line that belongs to the innerShape. /// @param _directionA : The direction of the stitching, true : forward, false : backward /// @param _directionB : The direction of the stitching, true : forward, false : backward .. tabs:: .. code-tab:: python def AddSeamlinePairGroup(_patternAIndex : int, _childAIndex : int, _lineAIndex : int, _patternBIndex : int, _childBIndex : int, _lineBIndex : int, _directionA : bool, _directionB : bool) -> bool """ @ingroup PATTERN_API @brief Add InnerShape and Sewing between InnerShape @return name of sewing group(wide string) @param _patternAIndex : A pattern index @param _childAIndex : The index of the innershape that belongs to the A pattern. @param _lineAIndex : The index of the line that belongs to the innerShape. @param _patternBIndex : B pattern index @param _childBIndex : The index of the innershape that belongs to the B pattern. @param _lineBIndex : The index of the line that belongs to the innerShape. @param _directionA : The direction of the stitching, true : forward, false : backward @param _directionB : The direction of the stitching, true : forward, false : backward """ .. code-tab:: c++ AddSeamlinePairGroup(int _patternAIndex, int _lineAIndex, int _patternBIndex, int _lineBIndex, bool _directionA, bool _directionB) /// @ingroup PATTERN_API /// @brief Add InnerShape and Sewing between InnerShape /// @return name of sewing group(wide string) /// @param _patternAIndex : A pattern index /// @param _childAIndex : The index of the innershape that belongs to the A pattern. /// @param _lineAIndex : The index of the line that belongs to the innerShape. /// @param _patternBIndex : B pattern index /// @param _childBIndex : The index of the innershape that belongs to the B pattern. /// @param _lineBIndex : The index of the line that belongs to the innerShape. /// @param _directionA : The direction of the stitching, true : forward, false : backward /// @param _directionB : The direction of the stitching, true : forward, false : backward .. tabs:: .. code-tab:: python def GetSelectedPattern() -> list[str] """ @ingroup PATTERN_API @brief Get the selected pattern name @return returns the selected pattern name """ .. code-tab:: c++ GetSelectedPattern() /// @ingroup PATTERN_API /// @brief Get the selected pattern name /// @return returns the selected pattern name .. tabs:: .. code-tab:: python def GetSelectedPatternViaIndex(patternIndex : int) -> bool """ @ingroup PATTERN_API @brief Check if the pattern is selected via pattern index @param patternIndex : The index of the pattern to select. @return returns true if the pattern is selected. """ .. code-tab:: c++ GetSelectedPatternViaIndex(unsigned int patternIndex) /// @ingroup PATTERN_API /// @brief Check if the pattern is selected via pattern index /// @param patternIndex : The index of the pattern to select. /// @return returns true if the pattern is selected. .. tabs:: .. code-tab:: python def SelectPatternViaIndex(patternIndex : int, keepPreviousSelection : bool) -> None """ @ingroup PATTERN_API @brief Select patterns via name @param patternIndex : The index of the pattern to select. @param keepPreviousSelection : True if you want to keep the previous selection. False will clear the previous selection. """ .. code-tab:: c++ SelectPatternViaIndex(unsigned int patternIndex, bool keepPreviousSelection) /// @ingroup PATTERN_API /// @brief Select patterns via name /// @param patternIndex : The index of the pattern to select. /// @param keepPreviousSelection : True if you want to keep the previous selection. False will clear the previous selection. .. tabs:: .. code-tab:: python def SelectPatternViaName(_patternName : str, keepPreviousSelection : bool) -> None """ @ingroup PATTERN_API @brief Select patterns via name @param _patternName : The name of the pattern to select. @param keepPreviousSelection : True if you want to keep the previous selection. False will clear the previous selection. """ .. code-tab:: c++ SelectPatternViaName(std::string _patternName, bool keepPreviousSelection) /// @ingroup PATTERN_API /// @brief Select patterns via name /// @param _patternName : The name of the pattern to select. /// @param keepPreviousSelection : True if you want to keep the previous selection. False will clear the previous selection. .. tabs:: .. code-tab:: python def GetBackUVExpansion(_patternIndex : int) -> bool """ @ingroup PATTERN_API @brief Get the status of back face UV expansion using pattern index @param patternIndex: the pattern index to get the pattern back face UV expansion @return pattern state for back UV expansion """ .. code-tab:: c++ GetBackUVExpansion(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get the status of back face UV expansion using pattern index /// @param patternIndex: the pattern index to get the pattern back face UV expansion /// @return pattern state for back UV expansion .. tabs:: .. code-tab:: python def SetBackUVExpansion(_patternIndex : int, _bSet : bool) -> None """ @ingroup PATTERN_API @brief Set back face UV expansion using pattern index @param patternIndex: the pattern index to set the pattern back face UV expansion @param _bSet : The state for back UV expansion, true : Enable back UV expansion, false : Disable back UV expansion """ .. code-tab:: c++ SetBackUVExpansion(int _patternIndex, bool _bSet) /// @ingroup PATTERN_API /// @brief Set back face UV expansion using pattern index /// @param patternIndex: the pattern index to set the pattern back face UV expansion /// @param _bSet : The state for back UV expansion, true : Enable back UV expansion, false : Disable back UV expansion .. tabs:: .. code-tab:: python def GetSideUVExpansion(_patternIndex : int) -> bool """ @ingroup PATTERN_API @brief Get the status of side face UV expansion using pattern index @param patternIndex: the pattern index to get the pattern side face UV expansion @return pattern state for side UV expansion """ .. code-tab:: c++ GetSideUVExpansion(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get the status of side face UV expansion using pattern index /// @param patternIndex: the pattern index to get the pattern side face UV expansion /// @return pattern state for side UV expansion .. tabs:: .. code-tab:: python def SetSideUVExpansion(_patternIndex : int, _bSet : bool) -> None """ @ingroup PATTERN_API @brief Set side face UV expansion using pattern index @param patternIndex: the pattern index to set the pattern side face UV expansion @param _bSet : The state for side UV expansion, true : Enable side UV expansion, false : Disable side UV expansion """ .. code-tab:: c++ SetSideUVExpansion(int _patternIndex, bool _bSet) /// @ingroup PATTERN_API /// @brief Set side face UV expansion using pattern index /// @param patternIndex: the pattern index to set the pattern side face UV expansion /// @param _bSet : The state for side UV expansion, true : Enable side UV expansion, false : Disable side UV expansion .. tabs:: .. code-tab:: python def FitPatternUVToUDIM(_patternIndex : int, _udim : int, _fillRatio : float) -> bool """ @ingroup PATTERN_API @brief Scales and translates all UV dummies of the specified pattern to fill the given UDIM tile. UDIM 1001 is the base tile (col 0, row 0); each column increments by 1 and each row increments by 10 (e.g. 1002 = col 1 row 0, 1011 = col 0 row 1). The 2D window arrangement is not affected. The entire operation is a single undo step. @param _patternIndex: zero-based index of the pattern to fit @param _udim: target UDIM tile number (must be >= 1001) @param _fillRatio: fraction of the tile to occupy in 0-1 range (default 1.0 = full tile) @return true on success, false if any argument is invalid or no UV dummies were found """ .. code-tab:: c++ FitPatternUVToUDIM(int _patternIndex, int _udim, float _fillRatio) /// @ingroup PATTERN_API /// @brief Scales and translates all UV dummies of the specified pattern to fill the given /// UDIM tile. UDIM 1001 is the base tile (col 0, row 0); each column increments by 1 /// and each row increments by 10 (e.g. 1002 = col 1 row 0, 1011 = col 0 row 1). /// The 2D window arrangement is not affected. The entire operation is a single undo step. /// @param _patternIndex: zero-based index of the pattern to fit /// @param _udim: target UDIM tile number (must be >= 1001) /// @param _fillRatio: fraction of the tile to occupy in 0-1 range (default 1.0 = full tile) /// @return true on success, false if any argument is invalid or no UV dummies were found .. tabs:: .. code-tab:: python def SetAddlThicknessCollision(_patternIndex : int, _value : float) -> None """ @ingroup PATTERN_API @brief Set additional thickness collision using pattern index @param patternIndex: the pattern index to set the pattern @param _value : The value for additional thickness collision) """ .. code-tab:: c++ SetAddlThicknessCollision(int _patternIndex, float _value) /// @ingroup PATTERN_API /// @brief Set additional thickness collision using pattern index /// @param patternIndex: the pattern index to set the pattern /// @param _value : The value for additional thickness collision) .. tabs:: .. code-tab:: python def GetAddlThicknessCollisionValue(_patternIndex : int) -> float """ @ingroup PATTERN_API @brief Get additional thickness collision value using pattern index @param patternIndex: the pattern index to get the pattern @return additional thickness collision value """ .. code-tab:: c++ GetAddlThicknessCollisionValue(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get additional thickness collision value using pattern index /// @param patternIndex: the pattern index to get the pattern /// @return additional thickness collision value .. tabs:: .. code-tab:: python def MovePatternPoint(_patternIndex : int, _pointIndex : int, _x : float, _y : float) -> None """ @ingroup PATTERN_API @brief Move Pattern Point @param patternIndex: Index of the pattern. @param pointIndex: Index of the point within the pattern. @param X, Y : New 2D coordinates in pattern space. """ .. code-tab:: c++ MovePatternPoint(int _patternIndex, int _pointIndex, float _x, float _y) /// @ingroup PATTERN_API /// @brief Move Pattern Point /// @param patternIndex: Index of the pattern. /// @param pointIndex: Index of the point within the pattern. /// @param X, Y : New 2D coordinates in pattern space. .. tabs:: .. code-tab:: python def GetGradingSizeQuantityMix(_groupIndex : int) -> map[str, int] """ @ingroup PATTERN_API @brief Get grading size/quantity mix for a specific grading rule group @param _groupIndex: Index of the grading rule group (0-based) @return Map of size names (as std::string) to quantity values (as int) """ .. code-tab:: c++ GetGradingSizeQuantityMix(int _groupIndex) /// @ingroup PATTERN_API /// @brief Get grading size/quantity mix for a specific grading rule group /// @param _groupIndex: Index of the grading rule group (0-based) /// @return Map of size names (as std::string) to quantity values (as int) .. tabs:: .. code-tab:: python def SetGradingSizeQuantityMix(_groupIndex : int, _sizeQuantityDict : map[str, int]) -> bool """ @ingroup PATTERN_API @brief Set grading size/quantity mix for a specific grading rule group @param _groupIndex: Index of the grading rule group (0-based) @param _sizeQuantityDict: Map of size names to quantity values @return True if successful, false if group index is invalid """ .. code-tab:: c++ SetGradingSizeQuantityMix(int _groupIndex, const std::map& _sizeQuantityDict) /// @ingroup PATTERN_API /// @brief Set grading size/quantity mix for a specific grading rule group /// @param _groupIndex: Index of the grading rule group (0-based) /// @param _sizeQuantityDict: Map of size names to quantity values /// @return True if successful, false if group index is invalid .. tabs:: .. code-tab:: python def GetGradingSizeTotalQuantity(_groupIndex : int) -> int """ @ingroup PATTERN_API @brief Get total quantity for a specific grading rule group @param _groupIndex: Index of the grading rule group (0-based) @return Sum of all quantities in the group """ .. code-tab:: c++ GetGradingSizeTotalQuantity(int _groupIndex) /// @ingroup PATTERN_API /// @brief Get total quantity for a specific grading rule group /// @param _groupIndex: Index of the grading rule group (0-based) /// @return Sum of all quantities in the group .. tabs:: .. code-tab:: python def AddGraphicStyleToPattern(_patternIndex : int, _graphicStyleIndex : int, _positionRefFromBoundingBox : list[float], _positionRefTypeCenter : bool, _face : int, _zOffset : float, _fAngle : float) -> bool """ @ingroup PATTERN_API @brief Places a graphic style onto a specific pattern piece using bounding-box-relative coordinates for current colorway. @param _patternIndex: Index of the pattern piece where the graphic will be placed. @param _graphicStyleIndex: Index of the graphic style to place. @param _positionRefFromBoundingBox: Vector of 4 floats [left, right, top, bottom] relative to the pattern bounding box. When _positionRefTypeCenter is true, only [0] (left) and [2] (top) are used as the (X, Y) offset to the graphic center. When _positionRefTypeCenter is false, width = right - left, height = bottom - top, and the graphic is sized and centered accordingly. @param _positionRefTypeCenter: If true, position values refer to the center of the graphic bounding box. If false, values refer to the outline. @param _face: Face side: 0 = front, 1 = back, 2 = both. @param _zOffset: Z offset value for the graphic placement. @param _fAngle: Rotation angle of the graphic in degrees. @return true if the graphic was successfully placed; otherwise false. """ .. code-tab:: c++ AddGraphicStyleToPattern(int _patternIndex, int _graphicStyleIndex, const std::vector& _positionRefFromBoundingBox, bool _positionRefTypeCenter, int _face, float _zOffset, float _fAngle) /// @ingroup PATTERN_API /// @brief Places a graphic style onto a specific pattern piece using bounding-box-relative coordinates for current colorway. /// @param _patternIndex: Index of the pattern piece where the graphic will be placed. /// @param _graphicStyleIndex: Index of the graphic style to place. /// @param _positionRefFromBoundingBox: Vector of 4 floats [left, right, top, bottom] relative to the pattern bounding box. /// When _positionRefTypeCenter is true, only [0] (left) and [2] (top) are used as the (X, Y) offset to the graphic center. /// When _positionRefTypeCenter is false, width = right - left, height = bottom - top, and the graphic is sized and centered accordingly. /// @param _positionRefTypeCenter: If true, position values refer to the center of the graphic bounding box. If false, values refer to the outline. /// @param _face: Face side: 0 = front, 1 = back, 2 = both. /// @param _zOffset: Z offset value for the graphic placement. /// @param _fAngle: Rotation angle of the graphic in degrees. /// @return true if the graphic was successfully placed; otherwise false. .. tabs:: .. code-tab:: python def GetLinkedPatternLists() -> str """ @ingroup PATTERN_API @brief Get all linked pattern group lists (e.g., Layer Clone) @return json string containing all linked pattern group information, If an error occurs or no linked patterns exist, return empty string """ .. code-tab:: c++ GetLinkedPatternLists() /// @ingroup PATTERN_API /// @brief Get all linked pattern group lists (e.g., Layer Clone) /// @return json string containing all linked pattern group information, If an error occurs or no linked patterns exist, return empty string .. tabs:: .. code-tab:: python def GetPatternsAttachedToAvatarMeasures() -> list[map[str, str]] """ @ingroup PATTERN_API @brief Retrieve all patterns that are currently attached (pinned/tacked) to avatar measures, grouped by avatar measure. Each entry in the returned vector represents one avatar measure and contains the following keys: "avatarMeasureName" - name of the avatar measure, "patternNames" - comma-separated names of all patterns attached to that measure. @return Vector of maps. Each map represents one avatar measure. Returns an empty vector when no patterns are attached to any avatar measure. """ .. code-tab:: c++ GetPatternsAttachedToAvatarMeasures() /// @ingroup PATTERN_API /// @brief Retrieve all patterns that are currently attached (pinned/tacked) to avatar measures, /// grouped by avatar measure. Each entry in the returned vector represents one avatar measure /// and contains the following keys: /// "avatarMeasureName" - name of the avatar measure, /// "patternNames" - comma-separated names of all patterns attached to that measure. /// @return Vector of maps. Each map represents one avatar measure. Returns an empty vector when /// no patterns are attached to any avatar measure. .. tabs:: .. code-tab:: python def GetPatternArchiveState(_patternIndex : int) -> bool """ @brief Get the archive state of a pattern using the pattern index @param _patternIndex: the pattern index to get the archive state @return true if the pattern is archived, false otherwise """ .. code-tab:: c++ GetPatternArchiveState(int _patternIndex) /// @brief Get the archive state of a pattern using the pattern index /// @param _patternIndex: the pattern index to get the archive state /// @return true if the pattern is archived, false otherwise .. tabs:: .. code-tab:: python def SetPatternArchiveState(_patternIndex : int, _archiveState : bool) -> None """ @ingroup PATTERN_API @brief Set the archive state of a pattern using the pattern index @param _patternIndex: the pattern index to set the archive state @param _archiveState: true to archive the pattern, false to unarchive """ .. code-tab:: c++ SetPatternArchiveState(int _patternIndex, bool _archiveState) /// @ingroup PATTERN_API /// @brief Set the archive state of a pattern using the pattern index /// @param _patternIndex: the pattern index to set the archive state /// @param _archiveState: true to archive the pattern, false to unarchive .. tabs:: .. code-tab:: python def GetPatternUVSpace(_patternIndex : int) -> str """ @ingroup PATTERN_API @brief Query which UV tile a pattern currently occupies (its origin tile). @param _patternIndex: target pattern index (RealPatternList order) @return JSON: {"status","patternIndex","uvSpace","tile":{"x","y"},"bbox":{"x","y","width","height"}} or {"status":"failed","message"} """ .. code-tab:: c++ GetPatternUVSpace(int _patternIndex) /// @ingroup PATTERN_API /// @brief Query which UV tile a pattern currently occupies (its origin tile). /// @param _patternIndex: target pattern index (RealPatternList order) /// @return JSON: {"status","patternIndex","uvSpace","tile":{"x","y"},"bbox":{"x","y","width","height"}} or {"status":"failed","message"} .. tabs:: .. code-tab:: python def MovePatternToUVSpace(_patternIndex : int, _uvTileX : int, _uvTileY : int, _offsetX : float, _offsetY : float, _bAllowRotation : bool, _scale : float, _padding : float) -> str """ @ingroup PATTERN_API @brief Pack a pattern into the target UV tile (via the nesting engine), with optional in-tile placement. @param _patternIndex: target pattern index (RealPatternList order) @param _uvTileX: target UV tile column (>= 0) @param _uvTileY: target UV tile row (>= 0) @param _offsetX: post-pack X offset, normalized 0..1 of the tile (default 0) @param _offsetY: post-pack Y offset, normalized 0..1 of the tile (default 0) @param _bAllowRotation: allow the nester to rotate patterns to fit, like the UV Packing dialog Rotation option ({0,90,180,270} when true, {0} when false). Default false @param _scale: uniform pre-scale about the pattern's UV center, must be > 0 (default 1) @param _padding: spacing kept around each pattern while packing, normalized 0..1 of the tile (default 0) @return JSON: {"status","results":[{"patternIndex","ok","fromTile":{"x","y"},"toTile":{"x","y"},"bbox"}],"message"} """ .. code-tab:: c++ MovePatternToUVSpace(int _patternIndex, int _uvTileX, int _uvTileY, float _offsetX, float _offsetY, bool _bAllowRotation, float _scale, float _padding) /// @ingroup PATTERN_API /// @brief Pack a pattern into the target UV tile (via the nesting engine), with optional in-tile placement. /// @param _patternIndex: target pattern index (RealPatternList order) /// @param _uvTileX: target UV tile column (>= 0) /// @param _uvTileY: target UV tile row (>= 0) /// @param _offsetX: post-pack X offset, normalized 0..1 of the tile (default 0) /// @param _offsetY: post-pack Y offset, normalized 0..1 of the tile (default 0) /// @param _bAllowRotation: allow the nester to rotate patterns to fit, like the UV Packing dialog Rotation option ({0,90,180,270} when true, {0} when false). Default false /// @param _scale: uniform pre-scale about the pattern's UV center, must be > 0 (default 1) /// @param _padding: spacing kept around each pattern while packing, normalized 0..1 of the tile (default 0) /// @return JSON: {"status","results":[{"patternIndex","ok","fromTile":{"x","y"},"toTile":{"x","y"},"bbox"}],"message"} .. tabs:: .. code-tab:: python def MovePatternsToUVSpace(_patternIndices : list[int], _uvTileX : int, _uvTileY : int, _offsetX : float, _offsetY : float, _bAllowRotation : bool, _scale : float, _padding : float) -> str """ @ingroup PATTERN_API @brief Batch-pack multiple patterns into the target UV tile (one undo step; per-item success/failure reported). @param _patternIndices: target pattern indices (RealPatternList order) @param _uvTileX: target UV tile column (>= 0) @param _uvTileY: target UV tile row (>= 0) @param _offsetX: post-pack X offset, normalized 0..1 of the tile (default 0) @param _offsetY: post-pack Y offset, normalized 0..1 of the tile (default 0) @param _bAllowRotation: allow the nester to rotate patterns to fit, like the UV Packing dialog Rotation option ({0,90,180,270} when true, {0} when false). Default false @param _scale: uniform pre-scale about each pattern's UV center, must be > 0 (default 1) @param _padding: spacing kept around each pattern while packing, normalized 0..1 of the tile (default 0) @return JSON: {"status","results":[{"patternIndex","ok","fromTile":{"x","y"},"toTile":{"x","y"},"bbox"}],"message"} """ .. code-tab:: c++ MovePatternsToUVSpace(const std::vector& _patternIndices, int _uvTileX, int _uvTileY, float _offsetX, float _offsetY, bool _bAllowRotation, float _scale, float _padding) /// @ingroup PATTERN_API /// @brief Batch-pack multiple patterns into the target UV tile (one undo step; per-item success/failure reported). /// @param _patternIndices: target pattern indices (RealPatternList order) /// @param _uvTileX: target UV tile column (>= 0) /// @param _uvTileY: target UV tile row (>= 0) /// @param _offsetX: post-pack X offset, normalized 0..1 of the tile (default 0) /// @param _offsetY: post-pack Y offset, normalized 0..1 of the tile (default 0) /// @param _bAllowRotation: allow the nester to rotate patterns to fit, like the UV Packing dialog Rotation option ({0,90,180,270} when true, {0} when false). Default false /// @param _scale: uniform pre-scale about each pattern's UV center, must be > 0 (default 1) /// @param _padding: spacing kept around each pattern while packing, normalized 0..1 of the tile (default 0) /// @return JSON: {"status","results":[{"patternIndex","ok","fromTile":{"x","y"},"toTile":{"x","y"},"bbox"}],"message"} .. tabs:: .. code-tab:: python def GetPatternOnBodyDetails() -> str """ @ingroup PATTERN_API @brief Get details of all patterns and their position on the human body with semantic labels and body region grouping. Returns a JSON string with two top-level arrays, "upperBody" and "lowerBody", each containing the pattern objects that belong to that body section. Each pattern object includes: - patternName: name of the pattern piece - patternIndex: index in the real pattern list - arrangementPosition: internal body region ID (e.g. "Arm_Front_2_L") - semanticLabel: fine-grained garment part label (e.g. "sleeve", "bodice_front") - bodyRegion: high-level anatomical region (e.g. "torso_front", "arm_full", "leg_back") - patternPosition: front/back orientation derived from bodyRegion ("front", "back", "full", "side", "center", or "unknown") Arrangement position naming convention: {Region}_{Facing}_{Zone}_{Side} Region : body area (Arm, Body, Leg, Wrist, Ankle, Neck, Head, Shoulder) Facing : orientation (Front, Back, Inside, Outside, Center, Skirt, Calf) Zone : vertical segment (1 = closest to torso, 2 = mid, 3 = distal) Side : laterality (L = Left, R = Right; omitted for center-line positions) Supported semantic labels: "bodice_front" - front torso patterns (set-in, raglan, legacy, Adidas) "bodice_back" - back torso patterns (set-in, raglan, legacy, Adidas) "bodice_full" - full wrap-around torso patterns "sleeve" - arm/sleeve patterns (set-in, raglan, dummy) "cuff" - wrist cuff patterns "collar" - collar/neck patterns (set-in, raglan, Adidas) "hem" - bottom hem band of the top "placket" - front placket (button/zipper strip) "waistband" - waist transition patterns "pants_front" - front pants panels "pants_back" - back pants panels "pants_left" - outer left leg panels "pants_right" - outer right leg panels "pants_front_left" - front left leg panel "pants_front_right" - front right leg panel "pants_back_left" - back left leg panel "pants_back_right" - back right leg panel "pants_full" - full leg panel "skirt_front" - front skirt patterns "skirt_back" - back skirt patterns "skirt_full" - full skirt patterns "cuff_leg" - ankle cuff patterns "pocket" - pocket patterns "unknown" - unrecognized or unassigned Supported body regions: "torso_front" - front bodice, placket, front jacket pocket blocks "torso_back" - back bodice blocks (set-in, raglan, legacy) "torso_full" - full wrap-around bodice, hem, Adidas full body, body dummy blocks "arm_front" - sleeve blocks (set-in, raglan, dummy) "arm_full" - wrist cuff blocks (wraps around) "leg_front" - front pants, front-left/right pants, front skirt, pants pocket blocks "leg_back" - back pants, back-left/right pants, back skirt blocks "leg_side" - outer seam leg panels (left/right) "leg_full" - full pants, full skirt, ankle cuff, pants dummy blocks "neck" - all collar blocks "waist" - waistband blocks Patterns connected through seamline pairs form a single garment piece; each piece is classified by majority vote (torso/arm/neck -> upper body, leg/waist -> lower body, ties default to upper body) and every member is placed in the matching array. @return JSON string with two array keys, "upperBody" and "lowerBody", each containing the pattern detail objects for that section. On failure (no pattern editor), both arrays are empty so the response is always valid, parseable JSON. """ .. code-tab:: c++ GetPatternOnBodyDetails() /// @ingroup PATTERN_API /// @brief Get details of all patterns and their position on the human body with semantic labels and body region grouping. /// Returns a JSON string with two top-level arrays, "upperBody" and "lowerBody", each /// containing the pattern objects that belong to that body section. /// Each pattern object includes: /// - patternName: name of the pattern piece /// - patternIndex: index in the real pattern list /// - arrangementPosition: internal body region ID (e.g. "Arm_Front_2_L") /// - semanticLabel: fine-grained garment part label (e.g. "sleeve", "bodice_front") /// - bodyRegion: high-level anatomical region (e.g. "torso_front", "arm_full", "leg_back") /// - patternPosition: front/back orientation derived from bodyRegion /// ("front", "back", "full", "side", "center", or "unknown") /// Arrangement position naming convention: {Region}_{Facing}_{Zone}_{Side} /// Region : body area (Arm, Body, Leg, Wrist, Ankle, Neck, Head, Shoulder) /// Facing : orientation (Front, Back, Inside, Outside, Center, Skirt, Calf) /// Zone : vertical segment (1 = closest to torso, 2 = mid, 3 = distal) /// Side : laterality (L = Left, R = Right; omitted for center-line positions) /// Supported semantic labels: /// "bodice_front" - front torso patterns (set-in, raglan, legacy, Adidas) /// "bodice_back" - back torso patterns (set-in, raglan, legacy, Adidas) /// "bodice_full" - full wrap-around torso patterns /// "sleeve" - arm/sleeve patterns (set-in, raglan, dummy) /// "cuff" - wrist cuff patterns /// "collar" - collar/neck patterns (set-in, raglan, Adidas) /// "hem" - bottom hem band of the top /// "placket" - front placket (button/zipper strip) /// "waistband" - waist transition patterns /// "pants_front" - front pants panels /// "pants_back" - back pants panels /// "pants_left" - outer left leg panels /// "pants_right" - outer right leg panels /// "pants_front_left" - front left leg panel /// "pants_front_right" - front right leg panel /// "pants_back_left" - back left leg panel /// "pants_back_right" - back right leg panel /// "pants_full" - full leg panel /// "skirt_front" - front skirt patterns /// "skirt_back" - back skirt patterns /// "skirt_full" - full skirt patterns /// "cuff_leg" - ankle cuff patterns /// "pocket" - pocket patterns /// "unknown" - unrecognized or unassigned /// Supported body regions: /// "torso_front" - front bodice, placket, front jacket pocket blocks /// "torso_back" - back bodice blocks (set-in, raglan, legacy) /// "torso_full" - full wrap-around bodice, hem, Adidas full body, body dummy blocks /// "arm_front" - sleeve blocks (set-in, raglan, dummy) /// "arm_full" - wrist cuff blocks (wraps around) /// "leg_front" - front pants, front-left/right pants, front skirt, pants pocket blocks /// "leg_back" - back pants, back-left/right pants, back skirt blocks /// "leg_side" - outer seam leg panels (left/right) /// "leg_full" - full pants, full skirt, ankle cuff, pants dummy blocks /// "neck" - all collar blocks /// "waist" - waistband blocks /// Patterns connected through seamline pairs form a single garment piece; each piece is /// classified by majority vote (torso/arm/neck -> upper body, leg/waist -> lower body, /// ties default to upper body) and every member is placed in the matching array. /// @return JSON string with two array keys, "upperBody" and "lowerBody", each containing /// the pattern detail objects for that section. On failure (no pattern editor), /// both arrays are empty so the response is always valid, parseable JSON. .. tabs:: .. code-tab:: python def GetPatternLineInfo(_patternIndex : int) -> str """ @ingroup PATTERN_API @brief List a pattern's outline lines to help pick the _lineIndex for AttachPatternToAvatarMeasure. lineIndex matches GetLineLength / DeleteLine ordering. Coordinates are 2D pattern-window units. @param _patternIndex: target pattern index (RealPatternList order) @return JSON: {"status","patternIndex","patternName","lineCount", "boundingBox":{"minX","minY","maxX","maxY","width","height"}, "lines":[{"lineIndex","length"(mm),"orientation"("horizontal"|"vertical"|"diagonal"), "location"("top"|"bottom"|"left"|"right"|"top-left"|...|"center"), "start":{x,y},"end":{x,y},"mid":{x,y},"midNorm":{x,y}(0..1 in bbox)}]}. On failure: {"status":"failed","message"}. """ .. code-tab:: c++ GetPatternLineInfo(int _patternIndex) /// @ingroup PATTERN_API /// @brief List a pattern's outline lines to help pick the _lineIndex for AttachPatternToAvatarMeasure. /// lineIndex matches GetLineLength / DeleteLine ordering. Coordinates are 2D pattern-window units. /// @param _patternIndex: target pattern index (RealPatternList order) /// @return JSON: {"status","patternIndex","patternName","lineCount", /// "boundingBox":{"minX","minY","maxX","maxY","width","height"}, /// "lines":[{"lineIndex","length"(mm),"orientation"("horizontal"|"vertical"|"diagonal"), /// "location"("top"|"bottom"|"left"|"right"|"top-left"|...|"center"), /// "start":{x,y},"end":{x,y},"mid":{x,y},"midNorm":{x,y}(0..1 in bbox)}]}. /// On failure: {"status":"failed","message"}. .. tabs:: .. code-tab:: python def AttachPatternToAvatarMeasure(_patternIndex : int, _lineIndex : int, _avatarMeasureName : str) -> str """ @ingroup PATTERN_API @brief Attach a pattern line to an avatar measure (Line Pin) - the programmatic equivalent of the manual "Attach to Measure (Avatar)" workflow. Runs the cloth solver afterwards so the result is visible without a separate Simulate() call. Registered as one undo step. @param _patternIndex: target pattern index (RealPatternList order) @param _lineIndex: outline line index to pin (see GetPatternLineInfo) @param _avatarMeasureName: avatar measure name (height/linear measures are rejected) @return JSON: {"status","message","patternIndex","patternName","lineIndex","lineLength", "avatarMeasureIndex","avatarMeasureName","measureBasicLength","measureSurfaceLength"} (lengths in mm). On failure: {"status":"failed","message"}. """ .. code-tab:: c++ AttachPatternToAvatarMeasure(int _patternIndex, int _lineIndex, const std::string& _avatarMeasureName) /// @ingroup PATTERN_API /// @brief Attach a pattern line to an avatar measure (Line Pin) - the programmatic equivalent of the manual /// "Attach to Measure (Avatar)" workflow. Runs the cloth solver afterwards so the result is visible /// without a separate Simulate() call. Registered as one undo step. /// @param _patternIndex: target pattern index (RealPatternList order) /// @param _lineIndex: outline line index to pin (see GetPatternLineInfo) /// @param _avatarMeasureName: avatar measure name (height/linear measures are rejected) /// @return JSON: {"status","message","patternIndex","patternName","lineIndex","lineLength", /// "avatarMeasureIndex","avatarMeasureName","measureBasicLength","measureSurfaceLength"} /// (lengths in mm). On failure: {"status":"failed","message"}. .. tabs:: .. code-tab:: python def SetGradingPairedAvatar(_gradingIndex : int, _avatarName : str) -> bool """ @ingroup PATTERN_API @brief Pair an avatar already loaded in the scene to a grading size — the API equivalent of the GUI 'Pair 3D Form' action in Object Browser - Grading. The avatar is looked up by name among the avatars currently in the scene (import it first via ImportAvatar; names via GetAvatarNameList). Pass an empty name to remove the pairing for that size — like the GUI, this also deletes the avatar from the scene (with undo) when no other grading size references it. @param _gradingIndex: grading size index (0-based, order of GetGradingSizeNameList) @param _avatarName: name of a scene avatar to pair; an empty string removes the pairing @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. @return true if the pairing (or removal) was applied; false when no grading table exists, the index is out of range, or no scene avatar matches the name """ .. code-tab:: c++ SetGradingPairedAvatar(unsigned int _gradingIndex, const std::string& _avatarName) /// @ingroup PATTERN_API /// @brief Pair an avatar already loaded in the scene to a grading size — the API equivalent of the GUI 'Pair 3D Form' action in Object Browser - Grading. The avatar is looked up by name among the avatars currently in the scene (import it first via ImportAvatar; names via GetAvatarNameList). Pass an empty name to remove the pairing for that size — like the GUI, this also deletes the avatar from the scene (with undo) when no other grading size references it. /// @param _gradingIndex: grading size index (0-based, order of GetGradingSizeNameList) /// @param _avatarName: name of a scene avatar to pair; an empty string removes the pairing /// @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. /// @return true if the pairing (or removal) was applied; false when no grading table exists, the index is out of range, or no scene avatar matches the name .. tabs:: .. code-tab:: python def GetGraphicGradingScaleRatios(_graphicStyleIndex : int, _patternIndex : int) -> list[list[float]] """ @ingroup PATTERN_API @brief Get the per-size grading scale ratios of a graphic placed on a pattern — the values edited by the GUI 'Edit Grading' tool when clicking a graphic. Each entry is the [x, y] bounding-box scale of that size relative to the currently selected grading size (so the current size reads [1, 1]). @param _graphicStyleIndex: graphic style index (see GetGraphicStyleListWithIndex) @param _patternIndex: index of the pattern piece the graphic instance is placed on, in the full pattern list order shared with AddGraphicStyleToPattern (0-based, buttons/bindings included) — this differs from the real-pattern-list order used by most pattern APIs @return one [x, y] ratio per grading size, ordered like GetGradingSizeNameList; empty when the graphic/pattern is not found, the pattern has no grading rule table, or the graphic's grading has not been initialized yet (this getter never modifies state; grading is initialized by the Set APIs or a GUI edit) """ .. code-tab:: c++ GetGraphicGradingScaleRatios(int _graphicStyleIndex, int _patternIndex) /// @ingroup PATTERN_API /// @brief Get the per-size grading scale ratios of a graphic placed on a pattern — the values edited by the GUI 'Edit Grading' tool when clicking a graphic. Each entry is the [x, y] bounding-box scale of that size relative to the currently selected grading size (so the current size reads [1, 1]). /// @param _graphicStyleIndex: graphic style index (see GetGraphicStyleListWithIndex) /// @param _patternIndex: index of the pattern piece the graphic instance is placed on, in the full pattern list order shared with AddGraphicStyleToPattern (0-based, buttons/bindings included) — this differs from the real-pattern-list order used by most pattern APIs /// @return one [x, y] ratio per grading size, ordered like GetGradingSizeNameList; empty when the graphic/pattern is not found, the pattern has no grading rule table, or the graphic's grading has not been initialized yet (this getter never modifies state; grading is initialized by the Set APIs or a GUI edit) .. tabs:: .. code-tab:: python def GetGraphicGradingPositionOffsets(_graphicStyleIndex : int, _patternIndex : int) -> list[list[float]] """ @ingroup PATTERN_API @brief Get the per-size grading position offsets of a graphic placed on a pattern. Each entry is the [x, y] offset of that size's graphic center from the currently selected grading size's center, in 2D pattern-window units (mm; X to the right, Y downward). @param _graphicStyleIndex: graphic style index (see GetGraphicStyleListWithIndex) @param _patternIndex: index of the pattern piece the graphic instance is placed on, in the full pattern list order shared with AddGraphicStyleToPattern (0-based, buttons/bindings included) — this differs from the real-pattern-list order used by most pattern APIs @return one [x, y] offset per grading size, ordered like GetGradingSizeNameList; empty when the graphic/pattern is not found, the pattern has no grading rule table, or the graphic's grading has not been initialized yet (this getter never modifies state; grading is initialized by the Set APIs or a GUI edit) """ .. code-tab:: c++ GetGraphicGradingPositionOffsets(int _graphicStyleIndex, int _patternIndex) /// @ingroup PATTERN_API /// @brief Get the per-size grading position offsets of a graphic placed on a pattern. Each entry is the [x, y] offset of that size's graphic center from the currently selected grading size's center, in 2D pattern-window units (mm; X to the right, Y downward). /// @param _graphicStyleIndex: graphic style index (see GetGraphicStyleListWithIndex) /// @param _patternIndex: index of the pattern piece the graphic instance is placed on, in the full pattern list order shared with AddGraphicStyleToPattern (0-based, buttons/bindings included) — this differs from the real-pattern-list order used by most pattern APIs /// @return one [x, y] offset per grading size, ordered like GetGradingSizeNameList; empty when the graphic/pattern is not found, the pattern has no grading rule table, or the graphic's grading has not been initialized yet (this getter never modifies state; grading is initialized by the Set APIs or a GUI edit) .. tabs:: .. code-tab:: python def SetGraphicGradingScaleRatios(_graphicStyleIndex : int, _patternIndex : int, _scaleRatios : list[list[float]]) -> bool """ @ingroup PATTERN_API @brief Grade the scale of a graphic per size — the API equivalent of grading a graphic's scale with the GUI 'Edit Grading' tool. Each entry is the target [x, y] scale of that size relative to the currently selected grading size (pass [1, 1] for the current size). The list length must equal the grading size count. @param _graphicStyleIndex: graphic style index (see GetGraphicStyleListWithIndex) @param _patternIndex: index of the pattern piece the graphic instance is placed on, in the full pattern list order shared with AddGraphicStyleToPattern (0-based, buttons/bindings included) — this differs from the real-pattern-list order used by most pattern APIs @param _scaleRatios: one [x, y] ratio per grading size, ordered like GetGradingSizeNameList @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. @return true on success; false when the graphic/pattern is not found, the pattern has no grading rule table, or the list length does not match the grading size count """ .. code-tab:: c++ SetGraphicGradingScaleRatios(int _graphicStyleIndex, int _patternIndex, const std::vector>& _scaleRatios) /// @ingroup PATTERN_API /// @brief Grade the scale of a graphic per size — the API equivalent of grading a graphic's scale with the GUI 'Edit Grading' tool. Each entry is the target [x, y] scale of that size relative to the currently selected grading size (pass [1, 1] for the current size). The list length must equal the grading size count. /// @param _graphicStyleIndex: graphic style index (see GetGraphicStyleListWithIndex) /// @param _patternIndex: index of the pattern piece the graphic instance is placed on, in the full pattern list order shared with AddGraphicStyleToPattern (0-based, buttons/bindings included) — this differs from the real-pattern-list order used by most pattern APIs /// @param _scaleRatios: one [x, y] ratio per grading size, ordered like GetGradingSizeNameList /// @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. /// @return true on success; false when the graphic/pattern is not found, the pattern has no grading rule table, or the list length does not match the grading size count .. tabs:: .. code-tab:: python def SetGraphicGradingPositionOffsets(_graphicStyleIndex : int, _patternIndex : int, _offsets : list[list[float]]) -> bool """ @ingroup PATTERN_API @brief Grade the position of a graphic per size — the API equivalent of grading a graphic's position with the GUI 'Edit Grading' tool. Each entry is the target [x, y] offset of that size's graphic center from the currently selected grading size's center, in 2D pattern-window units (mm; X to the right, Y downward; pass [0, 0] for the current size). The list length must equal the grading size count. Values are absolute targets — calling again with the same values leaves the result unchanged. Apply scale grading first (SetGraphicGradingScaleRatios), then position, mirroring the GUI workflow. @param _graphicStyleIndex: graphic style index (see GetGraphicStyleListWithIndex) @param _patternIndex: index of the pattern piece the graphic instance is placed on, in the full pattern list order shared with AddGraphicStyleToPattern (0-based, buttons/bindings included) — this differs from the real-pattern-list order used by most pattern APIs @param _offsets: one [x, y] offset per grading size, ordered like GetGradingSizeNameList @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. @return true on success; false when the graphic/pattern is not found, the pattern has no grading rule table, or the list length does not match the grading size count """ .. code-tab:: c++ SetGraphicGradingPositionOffsets(int _graphicStyleIndex, int _patternIndex, const std::vector>& _offsets) /// @ingroup PATTERN_API /// @brief Grade the position of a graphic per size — the API equivalent of grading a graphic's position with the GUI 'Edit Grading' tool. Each entry is the target [x, y] offset of that size's graphic center from the currently selected grading size's center, in 2D pattern-window units (mm; X to the right, Y downward; pass [0, 0] for the current size). The list length must equal the grading size count. Values are absolute targets — calling again with the same values leaves the result unchanged. Apply scale grading first (SetGraphicGradingScaleRatios), then position, mirroring the GUI workflow. /// @param _graphicStyleIndex: graphic style index (see GetGraphicStyleListWithIndex) /// @param _patternIndex: index of the pattern piece the graphic instance is placed on, in the full pattern list order shared with AddGraphicStyleToPattern (0-based, buttons/bindings included) — this differs from the real-pattern-list order used by most pattern APIs /// @param _offsets: one [x, y] offset per grading size, ordered like GetGradingSizeNameList /// @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. /// @return true on success; false when the graphic/pattern is not found, the pattern has no grading rule table, or the list length does not match the grading size count .. tabs:: .. code-tab:: python def AddGradingSize(_gradingSizeGroupIndex : int, _newSizeName : str) -> bool """ @ingroup PATTERN_API @brief Append a new grading size to a grading rule group — the API equivalent of the GUI 'Add Size' button in Object Browser - Grading. The size is propagated through the whole grading pipeline: rule table, every graded pattern's per-point size positions (extrapolated from the last sizes), attached trims, and the pair-avatar size-combination table. @param _gradingSizeGroupIndex: grading rule group index (0-based, see GetGradingSizeGroupCount) @param _newSizeName: name of the new size; must not be empty or duplicate an existing size in the group @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. @return true if the size was added; false when no grading table exists, the group index is out of range, or the name is empty/duplicated """ .. code-tab:: c++ AddGradingSize(unsigned int _gradingSizeGroupIndex, const std::string& _newSizeName) /// @ingroup PATTERN_API /// @brief Append a new grading size to a grading rule group — the API equivalent of the GUI 'Add Size' button in Object Browser - Grading. The size is propagated through the whole grading pipeline: rule table, every graded pattern's per-point size positions (extrapolated from the last sizes), attached trims, and the pair-avatar size-combination table. /// @param _gradingSizeGroupIndex: grading rule group index (0-based, see GetGradingSizeGroupCount) /// @param _newSizeName: name of the new size; must not be empty or duplicate an existing size in the group /// @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. /// @return true if the size was added; false when no grading table exists, the group index is out of range, or the name is empty/duplicated .. tabs:: .. code-tab:: python def AddGradingSizeGroup(_bAssignToAllPatterns : bool) -> int """ @ingroup PATTERN_API @brief Create a new grading rule group (rule table) holding a single default size — the API equivalent of the GUI 'Add (And Assign) Grading Rule Table' button in Object Browser - Grading. Use it to start grading on a garment that has none, then append sizes with AddGradingSize or load a .rul file with ImportGradeRuleToSizeGroup. @param _bAssignToAllPatterns: when true, assign every pattern piece to the new group (the headless equivalent of selecting all patterns before the GUI 'Add And Assign'); when false, only create the table @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. @note Unlike the GUI, which auto-pairs the first visible scene avatar into the empty avatar slots of a new rule table, the table created here starts with all avatar slots empty (intentional — pair explicitly via SetGradingPairedAvatar / SetGradingPairedAvatarFromFile). @return the new grading size group index (0-based); -1 on failure (no pattern editor) """ .. code-tab:: c++ AddGradingSizeGroup(bool _bAssignToAllPatterns) /// @ingroup PATTERN_API /// @brief Create a new grading rule group (rule table) holding a single default size — the API equivalent of the GUI 'Add (And Assign) Grading Rule Table' button in Object Browser - Grading. Use it to start grading on a garment that has none, then append sizes with AddGradingSize or load a .rul file with ImportGradeRuleToSizeGroup. /// @param _bAssignToAllPatterns: when true, assign every pattern piece to the new group (the headless equivalent of selecting all patterns before the GUI 'Add And Assign'); when false, only create the table /// @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. /// @note Unlike the GUI, which auto-pairs the first visible scene avatar into the empty avatar slots of a new rule table, the table created here starts with all avatar slots empty (intentional — pair explicitly via SetGradingPairedAvatar / SetGradingPairedAvatarFromFile). /// @return the new grading size group index (0-based); -1 on failure (no pattern editor) .. tabs:: .. code-tab:: python def ImportGradeRuleToSizeGroup(_gradingSizeGroupIndex : int, _rulFilePath : str) -> bool """ @ingroup PATTERN_API @brief Load a grade rule (.rul) file onto an existing grading size group — the API equivalent of the GUI 'Open Grade Rule File' action on a rule table in Object Browser - Grading. Unlike the File-Open .rul route, which only applies when the rule name inside the file matches the patterns' grading rule name, this loads the .rul onto the chosen group unconditionally, keeping the group's pattern assignments. @param _gradingSizeGroupIndex: grading rule group index to load onto (0-based, see GetGradingSizeGroupCount) @param _rulFilePath: path to the .rul file @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. @return true if the rule was loaded and swapped in; false when the group index is out of range, the file does not exist, or the .rul contains no valid size """ .. code-tab:: c++ ImportGradeRuleToSizeGroup(unsigned int _gradingSizeGroupIndex, const std::string& _rulFilePath) /// @ingroup PATTERN_API /// @brief Load a grade rule (.rul) file onto an existing grading size group — the API equivalent of the GUI 'Open Grade Rule File' action on a rule table in Object Browser - Grading. Unlike the File-Open .rul route, which only applies when the rule name inside the file matches the patterns' grading rule name, this loads the .rul onto the chosen group unconditionally, keeping the group's pattern assignments. /// @param _gradingSizeGroupIndex: grading rule group index to load onto (0-based, see GetGradingSizeGroupCount) /// @param _rulFilePath: path to the .rul file /// @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. /// @return true if the rule was loaded and swapped in; false when the group index is out of range, the file does not exist, or the .rul contains no valid size .. tabs:: .. code-tab:: python def SetGradingPairedAvatarSizing(_gradingIndex : int, _avsFilePath : str) -> bool """ @ingroup PATTERN_API @brief Load an Avatar Size (.avs) file and store it as the avatar sizing of a grading size — the API equivalent of the GUI 'Add Avatar Size' action in the Pair Avatar tab. Requires an avatar already paired to that size (SetGradingPairedAvatar) that is resizable; the .avs gender/avatar ID must match the paired avatar. When the target size is the currently selected grading size the sizing is applied to the avatar body immediately; otherwise it is stored and applied on the next switch to that size. 4.x-era .avs files (format v1/v2) are not supported. @param _gradingIndex: grading size index (0-based, order of GetGradingSizeNameList) @param _avsFilePath: path to the .avs file @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. @return true if the sizing was loaded and stored; false when no grading table/paired avatar exists, the index is out of range, the avatar is not resizable, the file is missing/empty/unsupported, the gender/avatar ID does not match, or the table currently suppresses resizing-status updates (the sizing would be silently dropped) """ .. code-tab:: c++ SetGradingPairedAvatarSizing(unsigned int _gradingIndex, const std::string& _avsFilePath) /// @ingroup PATTERN_API /// @brief Load an Avatar Size (.avs) file and store it as the avatar sizing of a grading size — the API equivalent of the GUI 'Add Avatar Size' action in the Pair Avatar tab. Requires an avatar already paired to that size (SetGradingPairedAvatar) that is resizable; the .avs gender/avatar ID must match the paired avatar. When the target size is the currently selected grading size the sizing is applied to the avatar body immediately; otherwise it is stored and applied on the next switch to that size. 4.x-era .avs files (format v1/v2) are not supported. /// @param _gradingIndex: grading size index (0-based, order of GetGradingSizeNameList) /// @param _avsFilePath: path to the .avs file /// @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. /// @return true if the sizing was loaded and stored; false when no grading table/paired avatar exists, the index is out of range, the avatar is not resizable, the file is missing/empty/unsupported, the gender/avatar ID does not match, or the table currently suppresses resizing-status updates (the sizing would be silently dropped) .. tabs:: .. code-tab:: python def SetGradingPairedAvatarFromFile(_gradingIndex : int, _avtFilePath : str) -> bool """ @ingroup PATTERN_API @brief Load an avatar file (.avt) and pair it to a grading size — the exact API equivalent of the GUI 'Pair 3D Form' action. Unlike ImportAvatar (which replaces the scene avatar), the file is loaded additively, so calling this with different files per size builds a size set where each grading size has its own avatar; the paired avatar activates automatically on switching to its size. An existing pairing on the size is replaced. @param _gradingIndex: grading size index (0-based, order of GetGradingSizeNameList) @param _avtFilePath: path to the avatar file to load and pair @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. @return true if the avatar was loaded and paired; false when no grading table exists, the index is out of range, or the file failed to load """ .. code-tab:: c++ SetGradingPairedAvatarFromFile(unsigned int _gradingIndex, const std::string& _avtFilePath) /// @ingroup PATTERN_API /// @brief Load an avatar file (.avt) and pair it to a grading size — the exact API equivalent of the GUI 'Pair 3D Form' action. Unlike ImportAvatar (which replaces the scene avatar), the file is loaded additively, so calling this with different files per size builds a size set where each grading size has its own avatar; the paired avatar activates automatically on switching to its size. An existing pairing on the size is replaced. /// @param _gradingIndex: grading size index (0-based, order of GetGradingSizeNameList) /// @param _avtFilePath: path to the avatar file to load and pair /// @note In a GUI session the grading-related widgets (Object Browser - Grading, property panels) are not refreshed automatically by this API. /// @return true if the avatar was loaded and paired; false when no grading table exists, the index is out of range, or the file failed to load .. tabs:: .. code-tab:: python def RemovePatternFromAvatarMeasure(_patternIndex : int, _avatarMeasureName : str) -> str """ @ingroup PATTERN_API @brief Detach a pattern from an avatar measure (clears its "Attach to Measure (Avatar)" Line Pins). Companion write API to GetPatternsAttachedToAvatarMeasures. Auto-simulates so the pattern visibly releases from the measure. @param _patternIndex: target pattern index (RealPatternList order) @param _avatarMeasureName: avatar measure name (see GetPatternsAttachedToAvatarMeasures) @return JSON string: success : {"status":"success","patternIndex","patternName","avatarMeasureName","removedLinePins":N} errors : {"status":"invalidInput"|"notFound"|"failed","message",...} """ .. code-tab:: c++ RemovePatternFromAvatarMeasure(int _patternIndex, const std::string& _avatarMeasureName) /// @ingroup PATTERN_API /// @brief Detach a pattern from an avatar measure (clears its "Attach to Measure (Avatar)" Line Pins). /// Companion write API to GetPatternsAttachedToAvatarMeasures. Auto-simulates so the pattern /// visibly releases from the measure. /// @param _patternIndex: target pattern index (RealPatternList order) /// @param _avatarMeasureName: avatar measure name (see GetPatternsAttachedToAvatarMeasures) /// @return JSON string: /// success : {"status":"success","patternIndex","patternName","avatarMeasureName","removedLinePins":N} /// errors : {"status":"invalidInput"|"notFound"|"failed","message",...} .. tabs:: .. code-tab:: python def CutPatternAlongInternalShapes(_patternIndex : int, _internalShapeIndex : int, _bCutAndSew : bool) -> bool """ @ingroup PATTERN_API @brief Cut a pattern piece along its internal shape lines — the API equivalent of selecting internal line(s) in the 2D window and using the GUI 'Cut' / 'Cut & Sew' context menu. Grading, sewing, and trims are propagated to the cut pieces the same way the GUI cut does. The internal lines must form a valid cutting path (reaching the pattern outline or forming a closed shape), or the cut is rejected like in the GUI. @param _patternIndex: pattern index (0-based, real pattern list order) @param _internalShapeIndex: internal shape index on the pattern (0-based, order of the pattern's internal shape list — the same index space as GetPatternInternalShapePoints). NOT the child-shape index returned by CreateInternalShapeWithPoints / CreateBaseShapeWithPoints (that is m_children order); passing those return values here can cut a different shape. Pass -1 to cut along every internal shape of the pattern; -1 is the only accepted negative value — any other negative index fails. Note that -1 includes hole/binding shapes, so on a pattern with holes the whole-pattern cut fails (holes cannot be cut) — cut specific indices instead @param _bCutAndSew: true = 'Cut & Sew' (the cut pieces stay sewn together along the cut line); false = plain 'Cut' @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. @note Some confirmation dialogs inside the cut core are NOT suppressed by this API: the modular-template deletion question, the cut-line endpoint extension question, and the overlapping-seamline/overlapping-line notifications can appear. In a plain CLO build a headless script can block on them; in DLL builds they auto-answer YES. Avoid cutting patterns that trigger these cases from automation. @return true when the cut succeeded; false when the pattern/internal shape is not found, the index is negative (other than -1), the pattern has no internal shapes, no line of the target shape is selectable (e.g. protected after remeshing), or the cutting path is invalid """ .. code-tab:: c++ CutPatternAlongInternalShapes(int _patternIndex, int _internalShapeIndex, bool _bCutAndSew) /// @ingroup PATTERN_API /// @brief Cut a pattern piece along its internal shape lines — the API equivalent of selecting internal line(s) in the 2D window and using the GUI 'Cut' / 'Cut & Sew' context menu. Grading, sewing, and trims are propagated to the cut pieces the same way the GUI cut does. The internal lines must form a valid cutting path (reaching the pattern outline or forming a closed shape), or the cut is rejected like in the GUI. /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @param _internalShapeIndex: internal shape index on the pattern (0-based, order of the pattern's internal shape list — the same index space as GetPatternInternalShapePoints). NOT the child-shape index returned by CreateInternalShapeWithPoints / CreateBaseShapeWithPoints (that is m_children order); passing those return values here can cut a different shape. Pass -1 to cut along every internal shape of the pattern; -1 is the only accepted negative value — any other negative index fails. Note that -1 includes hole/binding shapes, so on a pattern with holes the whole-pattern cut fails (holes cannot be cut) — cut specific indices instead /// @param _bCutAndSew: true = 'Cut & Sew' (the cut pieces stay sewn together along the cut line); false = plain 'Cut' /// @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. /// @note Some confirmation dialogs inside the cut core are NOT suppressed by this API: the modular-template deletion question, the cut-line endpoint extension question, and the overlapping-seamline/overlapping-line notifications can appear. In a plain CLO build a headless script can block on them; in DLL builds they auto-answer YES. Avoid cutting patterns that trigger these cases from automation. /// @return true when the cut succeeded; false when the pattern/internal shape is not found, the index is negative (other than -1), the pattern has no internal shapes, no line of the target shape is selectable (e.g. protected after remeshing), or the cutting path is invalid .. tabs:: .. code-tab:: python def MergeSewnPatterns(_patternIndexA : int, _patternIndexB : int) -> bool """ @ingroup PATTERN_API @brief Merge two pattern pieces joined by a 1:1 sewing into one pattern — the API equivalent of clicking the seam line between two sewn patterns and using the GUI 'Merge' context menu. The seam between the two patterns is removed and the outlines are joined; pattern A is the base (the merged pattern keeps A's placement). A sewing group that spans more than the two patterns or an M:N sewing cannot be merged (same as the GUI). @param _patternIndexA: index of the base pattern (0-based, real pattern list order) @param _patternIndexB: index of the pattern to merge into the base @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. @return true when the merge succeeded; false when either pattern is not found, no 1:1 sewing connects exactly these two patterns, more than one sewing group connects them (ambiguous — remove the extra sewing first), or the core merge validation rejects the pair """ .. code-tab:: c++ MergeSewnPatterns(int _patternIndexA, int _patternIndexB) /// @ingroup PATTERN_API /// @brief Merge two pattern pieces joined by a 1:1 sewing into one pattern — the API equivalent of clicking the seam line between two sewn patterns and using the GUI 'Merge' context menu. The seam between the two patterns is removed and the outlines are joined; pattern A is the base (the merged pattern keeps A's placement). A sewing group that spans more than the two patterns or an M:N sewing cannot be merged (same as the GUI). /// @param _patternIndexA: index of the base pattern (0-based, real pattern list order) /// @param _patternIndexB: index of the pattern to merge into the base /// @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. /// @return true when the merge succeeded; false when either pattern is not found, no 1:1 sewing connects exactly these two patterns, more than one sewing group connects them (ambiguous — remove the extra sewing first), or the core merge validation rejects the pair .. tabs:: .. code-tab:: python def GetPatternInternalShapePoints(_patternIndex : int, _internalShapeIndex : int) -> list[list[float]] """ @ingroup PATTERN_API @brief Get the point positions of one internal shape (internal line/shape) of a pattern. Coordinates are millimeters with Y increasing downward, measured in the pattern's PSEUDO-bounding-box frame: the origin is derived from the pattern's mesh centroid minus half the bbox extents (the frame AddGraphicStyleToPattern has always used), which on asymmetric patterns can differ from the true bounding-box top-left corner by several millimeters. It is the SAME frame used by AddGraphicStyleToPattern, AddButtonToPattern, and AddButtonHoleToPattern, so the returned points can be passed straight back as placement positions (e.g. put a button on a marked internal baseline) — but do not treat them as absolute distances from the visual bbox corner. The placement APIs anchor at the item's CENTER: a button lands centered on the point, and for AddGraphicStyleToPattern pass the point with _positionRefTypeCenter=true so the graphic is centered on it (with false, the values describe the outline rectangle instead). Note that only the coordinate frame is shared: _patternIndex here is real-pattern-list order, while AddGraphicStyleToPattern indexes the full pattern list (buttons/bindings included). @param _patternIndex: pattern index (0-based, real pattern list order) @param _internalShapeIndex: internal shape index on the pattern (0-based, order of the pattern's internal shape list — GetInnerShapeList order). NOT the child-shape index returned by CreateInternalShapeWithPoints / CreateBaseShapeWithPoints (that is m_children order); those return values do not round-trip into this index space @return one [x, y] per point of the internal shape, ordered along the shape; empty list when the pattern/internal shape is not found """ .. code-tab:: c++ GetPatternInternalShapePoints(int _patternIndex, int _internalShapeIndex) /// @ingroup PATTERN_API /// @brief Get the point positions of one internal shape (internal line/shape) of a pattern. Coordinates are millimeters with Y increasing downward, measured in the pattern's PSEUDO-bounding-box frame: the origin is derived from the pattern's mesh centroid minus half the bbox extents (the frame AddGraphicStyleToPattern has always used), which on asymmetric patterns can differ from the true bounding-box top-left corner by several millimeters. It is the SAME frame used by AddGraphicStyleToPattern, AddButtonToPattern, and AddButtonHoleToPattern, so the returned points can be passed straight back as placement positions (e.g. put a button on a marked internal baseline) — but do not treat them as absolute distances from the visual bbox corner. The placement APIs anchor at the item's CENTER: a button lands centered on the point, and for AddGraphicStyleToPattern pass the point with _positionRefTypeCenter=true so the graphic is centered on it (with false, the values describe the outline rectangle instead). Note that only the coordinate frame is shared: _patternIndex here is real-pattern-list order, while AddGraphicStyleToPattern indexes the full pattern list (buttons/bindings included). /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @param _internalShapeIndex: internal shape index on the pattern (0-based, order of the pattern's internal shape list — GetInnerShapeList order). NOT the child-shape index returned by CreateInternalShapeWithPoints / CreateBaseShapeWithPoints (that is m_children order); those return values do not round-trip into this index space /// @return one [x, y] per point of the internal shape, ordered along the shape; empty list when the pattern/internal shape is not found .. tabs:: .. code-tab:: python def GetPatternBaselinePoints(_patternIndex : int, _baselineIndex : int) -> list[list[float]] """ @ingroup PATTERN_API @brief Get the point positions of one baseline (GUI 2D 'Baseline' tool shape, stored separately from internal shapes; only actual baseline-type shapes are enumerated — seam-allowance dummies and internal bookkeeping shapes such as link marks, symmetry reference lines, and DXF drill-hole/chalk shapes are excluded) of a pattern. Coordinates are millimeters with Y increasing downward in the same pseudo-bounding-box frame as GetPatternInternalShapePoints (see the frame note there), so the returned points can be passed straight back as placement positions (the placement APIs anchor at the item's center — for AddGraphicStyleToPattern use _positionRefTypeCenter=true). A punch-mark (cross-mark) entry returns its single [x, y] position. @param _patternIndex: pattern index (0-based, real pattern list order) @param _baselineIndex: baseline index on the pattern (0-based, order of the pattern's baseline list; punch marks are numbered after the line baselines). NOT the index returned by CreateBaseShapeWithPoints (that is m_children order and does not round-trip into this index space) @return one [x, y] per point of the baseline, ordered along the shape (a punch mark yields exactly one [x, y]); empty list when the pattern/baseline is not found """ .. code-tab:: c++ GetPatternBaselinePoints(int _patternIndex, int _baselineIndex) /// @ingroup PATTERN_API /// @brief Get the point positions of one baseline (GUI 2D 'Baseline' tool shape, stored separately from internal shapes; only actual baseline-type shapes are enumerated — seam-allowance dummies and internal bookkeeping shapes such as link marks, symmetry reference lines, and DXF drill-hole/chalk shapes are excluded) of a pattern. Coordinates are millimeters with Y increasing downward in the same pseudo-bounding-box frame as GetPatternInternalShapePoints (see the frame note there), so the returned points can be passed straight back as placement positions (the placement APIs anchor at the item's center — for AddGraphicStyleToPattern use _positionRefTypeCenter=true). A punch-mark (cross-mark) entry returns its single [x, y] position. /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @param _baselineIndex: baseline index on the pattern (0-based, order of the pattern's baseline list; punch marks are numbered after the line baselines). NOT the index returned by CreateBaseShapeWithPoints (that is m_children order and does not round-trip into this index space) /// @return one [x, y] per point of the baseline, ordered along the shape (a punch mark yields exactly one [x, y]); empty list when the pattern/baseline is not found .. tabs:: .. code-tab:: python def AddButtonToPattern(_patternIndex : int, _x : float, _y : float, _angleDegree : float) -> bool """ @ingroup PATTERN_API @brief Create a button (button head) on a pattern at the given position — the API equivalent of the GUI 2D 'Button' creation tool. The button uses the current default button head style and, when the pattern is graded, inherits per-size grading positions from the adjacent pattern geometry (same as GUI creation). Not allowed on curved patterns. @param _patternIndex: pattern index (0-based, real pattern list order) @param _x: X position in mm in the pattern's pseudo-bounding-box frame (see GetPatternInternalShapePoints — shared with the point getters and AddGraphicStyleToPattern) @param _y: Y position in mm in the same frame (downward) @param _angleDegree: button rotation angle in degrees (0 = default orientation) @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. @return true when the button was created; false when the pattern is not found/curved, no default button head style exists, or the position does not land on the pattern """ .. code-tab:: c++ AddButtonToPattern(int _patternIndex, float _x, float _y, float _angleDegree) /// @ingroup PATTERN_API /// @brief Create a button (button head) on a pattern at the given position — the API equivalent of the GUI 2D 'Button' creation tool. The button uses the current default button head style and, when the pattern is graded, inherits per-size grading positions from the adjacent pattern geometry (same as GUI creation). Not allowed on curved patterns. /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @param _x: X position in mm in the pattern's pseudo-bounding-box frame (see GetPatternInternalShapePoints — shared with the point getters and AddGraphicStyleToPattern) /// @param _y: Y position in mm in the same frame (downward) /// @param _angleDegree: button rotation angle in degrees (0 = default orientation) /// @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. /// @return true when the button was created; false when the pattern is not found/curved, no default button head style exists, or the position does not land on the pattern .. tabs:: .. code-tab:: python def AddButtonHoleToPattern(_patternIndex : int, _x : float, _y : float, _angleDegree : float) -> bool """ @ingroup PATTERN_API @brief Create a buttonhole on a pattern at the given position — the API equivalent of the GUI 2D 'Buttonhole' creation tool. The buttonhole uses the current default buttonhole style and, when the pattern is graded, inherits per-size grading positions from the adjacent pattern geometry (same as GUI creation). Not allowed on curved patterns. @param _patternIndex: pattern index (0-based, real pattern list order) @param _x: X position in mm in the pattern's pseudo-bounding-box frame (see GetPatternInternalShapePoints — shared with the point getters and AddGraphicStyleToPattern) @param _y: Y position in mm in the same frame (downward) @param _angleDegree: buttonhole rotation angle in degrees (0 = default orientation) @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. @return true when the buttonhole was created; false when the pattern is not found/curved, no default buttonhole style exists, or the position does not land on the pattern """ .. code-tab:: c++ AddButtonHoleToPattern(int _patternIndex, float _x, float _y, float _angleDegree) /// @ingroup PATTERN_API /// @brief Create a buttonhole on a pattern at the given position — the API equivalent of the GUI 2D 'Buttonhole' creation tool. The buttonhole uses the current default buttonhole style and, when the pattern is graded, inherits per-size grading positions from the adjacent pattern geometry (same as GUI creation). Not allowed on curved patterns. /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @param _x: X position in mm in the pattern's pseudo-bounding-box frame (see GetPatternInternalShapePoints — shared with the point getters and AddGraphicStyleToPattern) /// @param _y: Y position in mm in the same frame (downward) /// @param _angleDegree: buttonhole rotation angle in degrees (0 = default orientation) /// @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. /// @return true when the buttonhole was created; false when the pattern is not found/curved, no default buttonhole style exists, or the position does not land on the pattern .. tabs:: .. code-tab:: python def TraceBaselineAsInternalShape(_patternIndex : int, _baselineIndex : int) -> bool """ @ingroup PATTERN_API @brief Trace baseline(s) of a pattern into internal shapes — the API equivalent of selecting baseline lines in the GUI 2D 'Trace' tool and applying 'Trace as Internal Shape'. The traced internal lines inherit the baseline's per-size grading, so they follow the pattern's grading sizes. The original baseline is kept (same as the GUI). @param _patternIndex: pattern index (0-based, real pattern list order) @param _baselineIndex: baseline index on the pattern (0-based, same order as GetPatternBaselinePoints); pass -1 to trace every baseline of the pattern (-1 is the only accepted negative value — any other negative index fails). Punch-mark (cross-mark) entries in that index space are position markers, not traceable shapes — they are skipped, and passing a punch-mark index returns false @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. @note The receiving pattern is decided by geometric containment of the traced lines (the core's FindParentPattern), not by _patternIndex — when patterns overlap in the 2D window, the internal shape can be created on a different pattern than the baseline's owner. @note On trace failure the core shows a modal message box that this API cannot suppress — it can block a headless session. @return true when at least one internal shape was created; false when the pattern/baseline is not found, the index is negative (other than -1), no baseline line is selectable, or the trace failed """ .. code-tab:: c++ TraceBaselineAsInternalShape(int _patternIndex, int _baselineIndex) /// @ingroup PATTERN_API /// @brief Trace baseline(s) of a pattern into internal shapes — the API equivalent of selecting baseline lines in the GUI 2D 'Trace' tool and applying 'Trace as Internal Shape'. The traced internal lines inherit the baseline's per-size grading, so they follow the pattern's grading sizes. The original baseline is kept (same as the GUI). /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @param _baselineIndex: baseline index on the pattern (0-based, same order as GetPatternBaselinePoints); pass -1 to trace every baseline of the pattern (-1 is the only accepted negative value — any other negative index fails). Punch-mark (cross-mark) entries in that index space are position markers, not traceable shapes — they are skipped, and passing a punch-mark index returns false /// @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. /// @note The receiving pattern is decided by geometric containment of the traced lines (the core's FindParentPattern), not by _patternIndex — when patterns overlap in the 2D window, the internal shape can be created on a different pattern than the baseline's owner. /// @note On trace failure the core shows a modal message box that this API cannot suppress — it can block a headless session. /// @return true when at least one internal shape was created; false when the pattern/baseline is not found, the index is negative (other than -1), no baseline line is selectable, or the trace failed .. tabs:: .. code-tab:: python def GetButtonGradingPositionOffsets(_buttonIndex : int) -> list[list[float]] """ @ingroup PATTERN_API @brief Get the per-size grading position offsets of a button (button head). Each entry is the [x, y] movement in millimeters of that grading size relative to the button's CURRENT position (the currently selected grading size reads [0, 0]), in the 2D window world axes. Buttons are indexed in scene order (creation order). @param _buttonIndex: button index (0-based, scene order) @return one [x, y] offset per grading size, ordered like GetGradingSizeNameList; empty list when the button is not found or has no grading """ .. code-tab:: c++ GetButtonGradingPositionOffsets(int _buttonIndex) /// @ingroup PATTERN_API /// @brief Get the per-size grading position offsets of a button (button head). Each entry is the [x, y] movement in millimeters of that grading size relative to the button's CURRENT position (the currently selected grading size reads [0, 0]), in the 2D window world axes. Buttons are indexed in scene order (creation order). /// @param _buttonIndex: button index (0-based, scene order) /// @return one [x, y] offset per grading size, ordered like GetGradingSizeNameList; empty list when the button is not found or has no grading .. tabs:: .. code-tab:: python def SetButtonGradingPositionOffsets(_buttonIndex : int, _offsets : list[list[float]]) -> bool """ @ingroup PATTERN_API @brief Grade the position of a button (button head) per size — the API equivalent of moving a button per size with the GUI 'Edit Grading' tool. Each entry is the target [x, y] movement in millimeters of that size relative to the button's CURRENT position (pass [0, 0] for the currently selected size), in the 2D window world axes. The list length must equal the grading size count. The new positions are applied when the grading size is switched. @param _buttonIndex: button index (0-based, scene order) @param _offsets: one [x, y] offset per grading size, ordered like GetGradingSizeNameList @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. @return true on success; false when the button is not found, no grading rule table exists, or the list length does not match the grading size count """ .. code-tab:: c++ SetButtonGradingPositionOffsets(int _buttonIndex, const std::vector>& _offsets) /// @ingroup PATTERN_API /// @brief Grade the position of a button (button head) per size — the API equivalent of moving a button per size with the GUI 'Edit Grading' tool. Each entry is the target [x, y] movement in millimeters of that size relative to the button's CURRENT position (pass [0, 0] for the currently selected size), in the 2D window world axes. The list length must equal the grading size count. The new positions are applied when the grading size is switched. /// @param _buttonIndex: button index (0-based, scene order) /// @param _offsets: one [x, y] offset per grading size, ordered like GetGradingSizeNameList /// @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. /// @return true on success; false when the button is not found, no grading rule table exists, or the list length does not match the grading size count .. tabs:: .. code-tab:: python def GetButtonHoleGradingPositionOffsets(_buttonHoleIndex : int) -> list[list[float]] """ @ingroup PATTERN_API @brief Get the per-size grading position offsets of a buttonhole. Same semantics as GetButtonGradingPositionOffsets; buttonholes are indexed in scene order (creation order). @param _buttonHoleIndex: buttonhole index (0-based, scene order) @return one [x, y] offset per grading size, ordered like GetGradingSizeNameList; empty list when the buttonhole is not found or has no grading """ .. code-tab:: c++ GetButtonHoleGradingPositionOffsets(int _buttonHoleIndex) /// @ingroup PATTERN_API /// @brief Get the per-size grading position offsets of a buttonhole. Same semantics as GetButtonGradingPositionOffsets; buttonholes are indexed in scene order (creation order). /// @param _buttonHoleIndex: buttonhole index (0-based, scene order) /// @return one [x, y] offset per grading size, ordered like GetGradingSizeNameList; empty list when the buttonhole is not found or has no grading .. tabs:: .. code-tab:: python def SetButtonHoleGradingPositionOffsets(_buttonHoleIndex : int, _offsets : list[list[float]]) -> bool """ @ingroup PATTERN_API @brief Grade the position of a buttonhole per size — same semantics as SetButtonGradingPositionOffsets. @param _buttonHoleIndex: buttonhole index (0-based, scene order) @param _offsets: one [x, y] offset per grading size, ordered like GetGradingSizeNameList @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. @return true on success; false when the buttonhole is not found, no grading rule table exists, or the list length does not match the grading size count """ .. code-tab:: c++ SetButtonHoleGradingPositionOffsets(int _buttonHoleIndex, const std::vector>& _offsets) /// @ingroup PATTERN_API /// @brief Grade the position of a buttonhole per size — same semantics as SetButtonGradingPositionOffsets. /// @param _buttonHoleIndex: buttonhole index (0-based, scene order) /// @param _offsets: one [x, y] offset per grading size, ordered like GetGradingSizeNameList /// @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. /// @return true on success; false when the buttonhole is not found, no grading rule table exists, or the list length does not match the grading size count .. tabs:: .. code-tab:: python def ActivateAllPatterns(_bActivate : bool, _bIncludeSewing : bool) -> bool """ @ingroup PATTERN_API @brief Activate or deactivate every pattern piece for simulation — the API equivalent of selecting all patterns and using the GUI 3D context menu 'Deactivate (Pattern & Sewing)' (_bActivate=false, _bIncludeSewing=true) or 'Activate' back. Deactivated patterns are excluded from simulation; with _bIncludeSewing the sewing (seam line pair groups) connected to the patterns is toggled together, like the GUI menu of the same name. @param _bActivate: true = activate, false = deactivate @param _bIncludeSewing: true = also toggle the connected sewing (GUI 'Pattern & Sewing'); false = patterns only @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. @return true when at least one pattern or sewing group changed state; false when nothing changed (already in the requested state) or no garment is loaded """ .. code-tab:: c++ ActivateAllPatterns(bool _bActivate, bool _bIncludeSewing) /// @ingroup PATTERN_API /// @brief Activate or deactivate every pattern piece for simulation — the API equivalent of selecting all patterns and using the GUI 3D context menu 'Deactivate (Pattern & Sewing)' (_bActivate=false, _bIncludeSewing=true) or 'Activate' back. Deactivated patterns are excluded from simulation; with _bIncludeSewing the sewing (seam line pair groups) connected to the patterns is toggled together, like the GUI menu of the same name. /// @param _bActivate: true = activate, false = deactivate /// @param _bIncludeSewing: true = also toggle the connected sewing (GUI 'Pattern & Sewing'); false = patterns only /// @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API. /// @return true when at least one pattern or sewing group changed state; false when nothing changed (already in the requested state) or no garment is loaded .. tabs:: .. code-tab:: python def GetPatternOutlinePoints(_patternIndex : int) -> list[list[float]] """ @ingroup PATTERN_API @brief Get the positions of a pattern's outline points (the segment endpoints of the pattern boundary; curve control points excluded). Coordinates are millimeters from the pattern bounding box TOP-LEFT with Y increasing downward — the same frame as GetPatternInternalShapePoints and the button/graphic placement APIs. Note that only the coordinate frame is shared with the graphic APIs: _patternIndex here is real-pattern-list order, while AddGraphicStyleToPattern indexes the full pattern list (buttons/bindings included). The returned order is the outline traversal order, and the indices identify points for SetPatternPointsGradingPositionOffsets / GetPatternPointGradingPositionOffsets. @param _patternIndex: pattern index (0-based, real pattern list order) @return one [x, y] per outline point, ordered along the boundary; empty list when the pattern is not found """ .. code-tab:: c++ GetPatternOutlinePoints(int _patternIndex) /// @ingroup PATTERN_API /// @brief Get the positions of a pattern's outline points (the segment endpoints of the pattern boundary; curve control points excluded). Coordinates are millimeters from the pattern bounding box TOP-LEFT with Y increasing downward — the same frame as GetPatternInternalShapePoints and the button/graphic placement APIs. Note that only the coordinate frame is shared with the graphic APIs: _patternIndex here is real-pattern-list order, while AddGraphicStyleToPattern indexes the full pattern list (buttons/bindings included). The returned order is the outline traversal order, and the indices identify points for SetPatternPointsGradingPositionOffsets / GetPatternPointGradingPositionOffsets. /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @return one [x, y] per outline point, ordered along the boundary; empty list when the pattern is not found .. tabs:: .. code-tab:: python def GetPatternPointGradingPositionOffsets(_patternIndex : int, _pointIndex : int) -> list[list[float]] """ @ingroup PATTERN_API @brief Get the per-size grading position offsets of one pattern outline point — the values shown in the GUI 'Edit Grading' Distance table. Each entry is the [x, y] movement in millimeters of that grading size relative to the point's CURRENT position (the currently selected grading size reads [0, 0]), in the 2D window world axes (Y up, so a hem graded downwards reads a negative Y). @param _patternIndex: pattern index (0-based, real pattern list order) @param _pointIndex: outline point index (0-based, order of GetPatternOutlinePoints) @return one [x, y] offset per grading size, ordered like GetGradingSizeNameList; empty list when the pattern/point is not found, the pattern has no grading, or the point's per-size grading data does not match the grading size count (stale grading state) """ .. code-tab:: c++ GetPatternPointGradingPositionOffsets(int _patternIndex, int _pointIndex) /// @ingroup PATTERN_API /// @brief Get the per-size grading position offsets of one pattern outline point — the values shown in the GUI 'Edit Grading' Distance table. Each entry is the [x, y] movement in millimeters of that grading size relative to the point's CURRENT position (the currently selected grading size reads [0, 0]), in the 2D window world axes (Y up, so a hem graded downwards reads a negative Y). /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @param _pointIndex: outline point index (0-based, order of GetPatternOutlinePoints) /// @return one [x, y] offset per grading size, ordered like GetGradingSizeNameList; empty list when the pattern/point is not found, the pattern has no grading, or the point's per-size grading data does not match the grading size count (stale grading state) .. tabs:: .. code-tab:: python def SetPatternPointsGradingPositionOffsets(_patternIndex : int, _pointIndices : list[int], _offsets : list[list[float]]) -> bool """ @ingroup PATTERN_API @brief Grade the positions of selected pattern outline points per size — the API equivalent of selecting points with the GUI 'Edit Grading' tool and typing per-size values into the Distance table. Offsets are [x, y] millimeters per grading size relative to the points' CURRENT positions in the 2D window world axes (Y up); the entry for the currently selected grading size is the reference and is ignored (pass [0, 0]). Existing deviations of the edited points are REPLACED, matching the Distance-table semantics. @param _patternIndex: pattern index (0-based, real pattern list order) @param _pointIndices: outline point indices to grade (0-based, order of GetPatternOutlinePoints) @param _offsets: one [x, y] offset per grading size, ordered like GetGradingSizeNameList; length must equal the grading size count @note In a GUI session the grading-related widgets (Edit Grading Distance table, property panels) are not refreshed automatically by this API. @return true on success; false when the pattern/point is not found, the pattern has no grading rule table, the offsets length does not match the grading size count, or any target point's per-size grading data does not match the grading size count (stale grading state — nothing is applied) """ .. code-tab:: c++ SetPatternPointsGradingPositionOffsets(int _patternIndex, const std::vector& _pointIndices, const std::vector>& _offsets) /// @ingroup PATTERN_API /// @brief Grade the positions of selected pattern outline points per size — the API equivalent of selecting points with the GUI 'Edit Grading' tool and typing per-size values into the Distance table. Offsets are [x, y] millimeters per grading size relative to the points' CURRENT positions in the 2D window world axes (Y up); the entry for the currently selected grading size is the reference and is ignored (pass [0, 0]). Existing deviations of the edited points are REPLACED, matching the Distance-table semantics. /// @param _patternIndex: pattern index (0-based, real pattern list order) /// @param _pointIndices: outline point indices to grade (0-based, order of GetPatternOutlinePoints) /// @param _offsets: one [x, y] offset per grading size, ordered like GetGradingSizeNameList; length must equal the grading size count /// @note In a GUI session the grading-related widgets (Edit Grading Distance table, property panels) are not refreshed automatically by this API. /// @return true on success; false when the pattern/point is not found, the pattern has no grading rule table, the offsets length does not match the grading size count, or any target point's per-size grading data does not match the grading size count (stale grading state — nothing is applied) .. tabs:: .. code-tab:: python def GetUnusedSinglePatterns() -> str """ @brief Identify "unused" single pattern pieces in the current project - garment pieces that are not connected to any other pattern by ANY assembly mechanism. A piece is flagged only when it is simultaneously unsewed AND unbonded/unglued AND unzipped AND unlaced. Trim pieces and internal/ linked helper pieces (already excluded by the real-pattern list) are not considered. @note Detection of unused MULTIPLE patterns (pieces connected to other pieces but not part of a larger garment assembly such as tops or bottoms) is out of scope and not reported here. @return JSON array string: [{"patternIndex":,"patternName":}, ...], one entry per unused single pattern. patternIndex is the real-pattern-list index shared with the other pattern APIs (e.g. GetPatternPieceName). Returns an empty array [] when there is no open project / no match. """ .. code-tab:: c++ GetUnusedSinglePatterns() /// @brief Identify "unused" single pattern pieces in the current project - garment pieces that are not /// connected to any other pattern by ANY assembly mechanism. A piece is flagged only when it is /// simultaneously unsewed AND unbonded/unglued AND unzipped AND unlaced. Trim pieces and internal/ /// linked helper pieces (already excluded by the real-pattern list) are not considered. /// @note Detection of unused MULTIPLE patterns (pieces connected to other pieces but not part of a larger /// garment assembly such as tops or bottoms) is out of scope and not reported here. /// @return JSON array string: [{"patternIndex":,"patternName":}, ...], one entry per unused /// single pattern. patternIndex is the real-pattern-list index shared with the other pattern APIs /// (e.g. GetPatternPieceName). Returns an empty array [] when there is no open project / no match. REST_API ******** .. tabs:: .. code-tab:: python def CallRESTGet(url : str, headerNameAndValueList : list[std::pair[str, str]], progressBarText : str) -> str """ @brief HTTP GET Method @param url : e.g. https://api.clo3d.com/customers?version=2.5.9999.299999&userid=clo @param headerNameAndValueList : pair list of input HTTP request header parameters @param progressBarText : text for the progress bar @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body """ .. code-tab:: c++ CallRESTGet(const string& url, const vector>& headerNameAndValueList, const string& progressBarText) /// @brief HTTP GET Method /// @param url : e.g. https://api.clo3d.com/customers?version=2.5.9999.299999&userid=clo /// @param headerNameAndValueList : pair list of input HTTP request header parameters /// @param progressBarText : text for the progress bar /// @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body .. tabs:: .. code-tab:: python def CallRESTPost(url : str, postField : str, headerNameAndValueList : list[std::pair[str, str]], progressBarText : str) -> str """ @ingroup REST_API @brief HTTP POST Method @param url : the full URL for REST API call @param postField HTTP Post Body parameter e.g. "{"parameter1":20,"parameter2":100,"date":"2017-12-13T00:00:00"}" @param headerNameAndValueList : pair list of input HTTP request header parameters @param progressBarText : text for the progress bar @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body """ .. code-tab:: c++ CallRESTPost(const string& url, string *postField, const vector>& headerNameAndValueList, const string& progressBarText) /// @ingroup REST_API /// @brief HTTP POST Method /// @param url : the full URL for REST API call /// @param postField HTTP Post Body parameter e.g. "{"parameter1":20,"parameter2":100,"date":"2017-12-13T00:00:00"}" /// @param headerNameAndValueList : pair list of input HTTP request header parameters /// @param progressBarText : text for the progress bar /// @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body .. tabs:: .. code-tab:: python def CallRESTPost2(url : str, postField : char, sizeInByte : int, headerNameAndValueList : list[std::pair[str, str]], progressBarText : str) -> str """ @ingroup REST_API @brief HTTP POST Method 2 @param url : the full URL for REST API call @param postField HTTP Post Body parameter @param sizeInByte The size of postField in bytes @param headerNameAndValueList : pair list of input HTTP request header parameters @param progressBarText : text for the progress bar @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body """ .. code-tab:: c++ CallRESTPost2(const string& url, unsigned char *postField, unsigned int& sizeInByte, const vector>& headerNameAndValueList, const string& progressBarText) /// @ingroup REST_API /// @brief HTTP POST Method 2 /// @param url : the full URL for REST API call /// @param postField HTTP Post Body parameter /// @param sizeInByte The size of postField in bytes /// @param headerNameAndValueList : pair list of input HTTP request header parameters /// @param progressBarText : text for the progress bar /// @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body .. tabs:: .. code-tab:: python def CallRESTPostWithMultipartFormData(url : str, filePath : str, headerNameAndValueList : list[std::pair[str, str]], progressBarText : str) -> str """ @ingroup REST_API @brief HTTP POST with multipart/form-data Method @param url : the full URL for REST API call @param filePath : path of file to send via REST API @param headerNameAndValueList : pair list of input HTTP request header parameters @param progressBarText : text for the progress bar @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body """ .. code-tab:: c++ CallRESTPostWithMultipartFormData(const string& url, const string& filePath, const vector>& headerNameAndValueList, const string& progressBarText) /// @ingroup REST_API /// @brief HTTP POST with multipart/form-data Method /// @param url : the full URL for REST API call /// @param filePath : path of file to send via REST API /// @param headerNameAndValueList : pair list of input HTTP request header parameters /// @param progressBarText : text for the progress bar /// @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body .. tabs:: .. code-tab:: python def CallRESTPostWithMultipartFormData(url : str, filePathList : list[str], headerNameAndValueList : list[std::pair[str, str]], progressBarText : str) -> str """ @ingroup REST_API @brief HTTP POST with multipart/form-data Method @param url : the full URL for REST API call @param filePathList : path list of files to send via REST API @param headerNameAndValueList : pair list of input HTTP request header parameters @param progressBarText : text for the progress bar @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body """ .. code-tab:: c++ CallRESTPostWithMultipartFormData(const string& url, const vector& filePathList, const vector>& headerNameAndValueList, const string& progressBarText) /// @ingroup REST_API /// @brief HTTP POST with multipart/form-data Method /// @param url : the full URL for REST API call /// @param filePathList : path list of files to send via REST API /// @param headerNameAndValueList : pair list of input HTTP request header parameters /// @param progressBarText : text for the progress bar /// @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body .. tabs:: .. code-tab:: python def CallbackRestRequest(restRequest : CloApiRestRequest, callbackFunc : std::function[None (CloApiRestResponse)]) -> None """ @ingroup REST_API @brief It makes an Http request with a CloApiRestRequest structure and then triggers a callbackFunc when the server responds @param restRequest : It is the request with header, body, url and attachements @param callbackFunc : When the server responds, a callback function is called with CloApiRestResponse. """ .. code-tab:: c++ CallbackRestRequest(const Marvelous::CloApiRestRequest& restReq, const std::function& callbackFunc) /// @ingroup REST_API /// @brief It makes an Http request with a CloApiRestRequest structure and then triggers a callbackFunc when the server responds /// @param restRequest : It is the request with header, body, url and attachements /// @param callbackFunc : When the server responds, a callback function is called with CloApiRestResponse. .. tabs:: .. code-tab:: python def CallbackRestMultiRequest(restRequests : list[CloApiRestRequest], callbackFunc : std::function[None (CloApiRestResponse)], callbackFinished : std::function[None()]) -> None """ @ingroup REST_API @brief It uses the CloApiRestRequest structure to make multiple Http requests and then trigger each callbackFunc when each server responds. The callbackFinished is trrigered after all requests have been responded to. @param restRequests : Request list with header, body, url and attachements @param callbackFunc : When the server responds, a callback function is called with CloApiRestResponse. @param callbackFinished : The callbackFinished function is called last after all requests have been responded to. """ .. code-tab:: c++ CallbackRestMultiRequest(const std::vector& restRequests, const std::function& callbackFunc, const std::function& callbackFinished) /// @ingroup REST_API /// @brief It uses the CloApiRestRequest structure to make multiple Http requests and then trigger each callbackFunc when each server responds. The callbackFinished is trrigered after all requests have been responded to. /// @param restRequests : Request list with header, body, url and attachements /// @param callbackFunc : When the server responds, a callback function is called with CloApiRestResponse. /// @param callbackFinished : The callbackFinished function is called last after all requests have been responded to. .. tabs:: .. code-tab:: python def CallRESTPut(restReq : CloApiRestRequest, progressBarText : str) -> str """ @ingroup REST_API @brief HTTP PUT Method @param restRequests : Request list with header, body, url and attachements @param progressBarText : text for the progress bar @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body """ .. code-tab:: c++ CallRESTPut(const Marvelous::CloApiRestRequest& restReq, const std::string& progressBarText) /// @ingroup REST_API /// @brief HTTP PUT Method /// @param restRequests : Request list with header, body, url and attachements /// @param progressBarText : text for the progress bar /// @return string = HTTP Response header + "\r\n\r\n" + HTTP Response body UTILITY_API *********** .. tabs:: .. code-tab:: python def GetCLOTemporaryFolderPath() -> str """ @ingroup UTILITY_API @brief Create and get the temporary folder path @return Get the temporary folder path to store temporary files used when exporting to server """ .. code-tab:: c++ GetCLOTemporaryFolderPath() /// @ingroup UTILITY_API /// @brief Create and get the temporary folder path /// @return Get the temporary folder path to store temporary files used when exporting to server .. tabs:: .. code-tab:: python def GetCLOTemporaryFolderPathW() -> str """ @ingroup UTILITY_API @brief Create and get the temporary folder path @return Get the temporary folder path to store temporary files used when exporting to server """ .. code-tab:: c++ GetCLOTemporaryFolderPathW() /// @ingroup UTILITY_API /// @brief Create and get the temporary folder path /// @return Get the temporary folder path to store temporary files used when exporting to server .. tabs:: .. code-tab:: python def DisplayMessageBox(str : str) -> None """ @ingroup UTILITY_API @brief Show a message with using the DialogBox implemented in CLO software @param str: message @return Display a message box to show input string on CLO. This can be used for debugging. """ .. code-tab:: c++ DisplayMessageBox(string str) /// @ingroup UTILITY_API /// @brief Show a message with using the DialogBox implemented in CLO software /// @param str: message /// @return Display a message box to show input string on CLO. This can be used for debugging. .. tabs:: .. code-tab:: python def DisplayMessageBoxW(str : str) -> None """ @ingroup UTILITY_API @brief Show a message with using the DialogBox implemented in CLO software @param str: message @return Display a message box to show input string on CLO. This can be used for debugging. """ .. code-tab:: c++ DisplayMessageBoxW(wstring str) /// @ingroup UTILITY_API /// @brief Show a message with using the DialogBox implemented in CLO software /// @param str: message /// @return Display a message box to show input string on CLO. This can be used for debugging. .. tabs:: .. code-tab:: python def GetProjectName() -> str """ @ingroup UTILITY_API @brief Get the current project name in CLO @return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test" """ .. code-tab:: c++ GetProjectName() /// @ingroup UTILITY_API /// @brief Get the current project name in CLO /// @return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test" .. tabs:: .. code-tab:: python def GetProjectNameW() -> str """ @ingroup UTILITY_API @brief Get the current project name in CLO @return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test" """ .. code-tab:: c++ GetProjectNameW() /// @ingroup UTILITY_API /// @brief Get the current project name in CLO /// @return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test" .. tabs:: .. code-tab:: python def GetProjectFilePath() -> str """ @ingroup UTILITY_API @brief Get the current profile file path @return The current project file path. If you load a project file saved in "c://download/default.zprj", this function returns the full path - "c://download/default.zprj". If you never load project files, then it returns "NULL". """ .. code-tab:: c++ GetProjectFilePath() /// @ingroup UTILITY_API /// @brief Get the current profile file path /// @return The current project file path. If you load a project file saved in "c://download/default.zprj", this function returns the full path - "c://download/default.zprj". If you never load project files, then it returns "NULL". .. tabs:: .. code-tab:: python def GetProjectFilePathW() -> str """ @ingroup UTILITY_API @brief Get the current profile file path @return The current project file path. If you load a project file saved in "c://download/default.zprj", this function returns the full path - "c://download/default.zprj". If you never load project files, then it returns "NULL". """ .. code-tab:: c++ GetProjectFilePathW() /// @ingroup UTILITY_API /// @brief Get the current profile file path /// @return The current project file path. If you load a project file saved in "c://download/default.zprj", this function returns the full path - "c://download/default.zprj". If you never load project files, then it returns "NULL". .. tabs:: .. code-tab:: python def GetMajorVersion() -> int """ @ingroup UTILITY_API @brief Get the major version of the CLO software @return Major version of SW. ex) 5 of 5.0.72 """ .. code-tab:: c++ GetMajorVersion() /// @ingroup UTILITY_API /// @brief Get the major version of the CLO software /// @return Major version of SW. ex) 5 of 5.0.72 .. tabs:: .. code-tab:: python def GetMinorVersion() -> int """ @ingroup UTILITY_API @brief Get the minor version of the CLO software @return Minor version of SW. ex) 0 of 5.0.72 """ .. code-tab:: c++ GetMinorVersion() /// @ingroup UTILITY_API /// @brief Get the minor version of the CLO software /// @return Minor version of SW. ex) 0 of 5.0.72 .. tabs:: .. code-tab:: python def GetPatchVersion() -> int """ @ingroup UTILITY_API @brief Get the patch version of the CLO software @return Patch version of SW. ex) 72 of 5.0.72 """ .. code-tab:: c++ GetPatchVersion() /// @ingroup UTILITY_API /// @brief Get the patch version of the CLO software /// @return Patch version of SW. ex) 72 of 5.0.72 .. tabs:: .. code-tab:: python def toUtf8(str : str) -> str """ @ingroup UTILITY_API @brief Convert and get the string encoded in UTF-8 from wstring @param str: target wstring to convert @return string in UTF8 from wstring encoded by UCS-2 in Windows or UTF-8 in Mac OS """ .. code-tab:: c++ toUtf8(const std::wstring &str) /// @ingroup UTILITY_API /// @brief Convert and get the string encoded in UTF-8 from wstring /// @param str: target wstring to convert /// @return string in UTF8 from wstring encoded by UCS-2 in Windows or UTF-8 in Mac OS .. tabs:: .. code-tab:: python def CleanFilePath(_filePath : str) -> CleanedPathResult """ @ingroup UTILITY_API @brief Sanitize a file name or full file path for safe cross-platform / cloud / web use. @param _filePath: the raw file name or path (UTF-8). The input is auto-detected as a standalone file name or a full path (it is a path when it contains a slash or a drive letter such as "C:"). Processing per component: NFC Unicode normalization; stripping of characters that conflict with Windows / cloud clients / HTTP-FTP (< > : " | ? * # % & { } \ $ ! ' @ + = and ASCII control characters); spaces become '_'; leading/trailing spaces and periods are trimmed; "." and ".." segments are dropped; Windows reserved device names (CON, PRN, AUX, NUL, COM1..9, LPT1..9) get a trailing '_' on the stem; each component is truncated to 255 bytes on a UTF-8 boundary. Drive letters (e.g. "C:") and UNC / POSIX roots are preserved, and mixed slashes are collapsed. @return a CleanedPathResult holding the path in universal ('/'), Windows native ('\') and Windows long-path (\\?\ / \\?\UNC\) forms, plus the isolated and percent-encoded file name. """ .. code-tab:: c++ CleanFilePath(const std::string& _filePath) /// @ingroup UTILITY_API /// @brief Sanitize a file name or full file path for safe cross-platform / cloud / web use. /// @param _filePath: the raw file name or path (UTF-8). The input is auto-detected as a standalone /// file name or a full path (it is a path when it contains a slash or a drive letter such as /// "C:"). Processing per component: NFC Unicode normalization; stripping of characters that /// conflict with Windows / cloud clients / HTTP-FTP /// (< > : " | ? * # % & { } \ $ ! ' @ + = and ASCII control characters); spaces become '_'; /// leading/trailing spaces and periods are trimmed; "." and ".." segments are dropped; Windows /// reserved device names (CON, PRN, AUX, NUL, COM1..9, LPT1..9) get a trailing '_' on the stem; /// each component is truncated to 255 bytes on a UTF-8 boundary. Drive letters (e.g. "C:") and /// UNC / POSIX roots are preserved, and mixed slashes are collapsed. /// @return a CleanedPathResult holding the path in universal ('/'), Windows native ('\') and Windows /// long-path (\\?\ / \\?\UNC\) forms, plus the isolated and percent-encoded file name. .. tabs:: .. code-tab:: python def GetColorwayCount() -> int """ @ingroup UTILITY_API @brief Get the number of colorways in the current project @return The number of Colorways in the current project. """ .. code-tab:: c++ GetColorwayCount() /// @ingroup UTILITY_API /// @brief Get the number of colorways in the current project /// @return The number of Colorways in the current project. .. tabs:: .. code-tab:: python def GetCurrentColorwayIndex() -> int """ @ingroup UTILITY_API @brief Get the current colorway index @return The current colorway index. """ .. code-tab:: c++ GetCurrentColorwayIndex() /// @ingroup UTILITY_API /// @brief Get the current colorway index /// @return The current colorway index. .. tabs:: .. code-tab:: python def SetCurrentColorwayIndex(index : int) -> None """ @ingroup UTILITY_API @brief Change the current colorway @param index: the colorway index """ .. code-tab:: c++ SetCurrentColorwayIndex(unsigned int index) /// @ingroup UTILITY_API /// @brief Change the current colorway /// @param index: the colorway index .. tabs:: .. code-tab:: python def SetColorwayName(index : int, str : str) -> None """ @ingroup UTILITY_API @brief Change colorway name @param index: the target colorway index to change the name @param str: new name for the colorway """ .. code-tab:: c++ SetColorwayName(unsigned int index, const string& str) /// @ingroup UTILITY_API /// @brief Change colorway name /// @param index: the target colorway index to change the name /// @param str: new name for the colorway .. tabs:: .. code-tab:: python def SetColorwayNameW(index : int, wstr : str) -> None """ @ingroup UTILITY_API @brief Change colorway name @param index: the target colorway index to change the name @param wstr: new name for the colorway """ .. code-tab:: c++ SetColorwayNameW(unsigned int index, const wstring& wstr) /// @ingroup UTILITY_API /// @brief Change colorway name /// @param index: the target colorway index to change the name /// @param wstr: new name for the colorway .. tabs:: .. code-tab:: python def GetColorwayName(index : int) -> str """ @ingroup UTILITY_API @brief Get the colorway name for the colorway index @param index: colorway index to get the name @return the colorway name for the colorway index """ .. code-tab:: c++ GetColorwayName(unsigned int index) /// @ingroup UTILITY_API /// @brief Get the colorway name for the colorway index /// @param index: colorway index to get the name /// @return the colorway name for the colorway index .. tabs:: .. code-tab:: python def GetColorwayNameW(index : int) -> str """ @ingroup UTILITY_API @brief Get the colorway name for the colorway index @param index: colorway index to get the name @return the colorway name for the colorway index """ .. code-tab:: c++ GetColorwayNameW(unsigned int index) /// @ingroup UTILITY_API /// @brief Get the colorway name for the colorway index /// @param index: colorway index to get the name /// @return the colorway name for the colorway index .. tabs:: .. code-tab:: python def CopyColorway(index : int, _colorwayCopyOption : int) -> int """ @ingroup UTILITY_API @brief Copy the colorway in the index and create a new one @param index: the source colorway index to copy @param _colorwayCopyOption: The copy option 0: Unlink all properties 1: Unlink material properties only 2: Link all properties @return index for the created colorway """ .. code-tab:: c++ CopyColorway(unsigned int index, int _colorwayCopyOption) /// @ingroup UTILITY_API /// @brief Copy the colorway in the index and create a new one /// @param index: the source colorway index to copy /// @param _colorwayCopyOption: The copy option /// 0: Unlink all properties /// 1: Unlink material properties only /// 2: Link all properties /// @return index for the created colorway .. tabs:: .. code-tab:: python def GetCustomViewInformation() -> str """ @ingroup UTILITY_API @brief Get the custom view information { "customViewList": [ { "cameraMatrix": [ // row vector 0, 1, 2 of "local to world camera matrix" 1.0, 0.000166, -0.001024, 0.352125, 0.0, 0.987069, 0.160306, 2592.8, 0.001039, -0.160306, 0.987068, 7973.05 ], "fov": 40.0 } ] } @return Json stream including the data of Custom View such as Camera Matrix, FOV, and so on. """ .. code-tab:: c++ GetCustomViewInformation() /// @ingroup UTILITY_API /// @brief Get the custom view information /// { /// "customViewList": [ /// { /// "cameraMatrix": [ // row vector 0, 1, 2 of "local to world camera matrix" /// 1.0, /// 0.000166, /// -0.001024, /// 0.352125, /// 0.0, /// 0.987069, /// 0.160306, /// 2592.8, /// 0.001039, /// -0.160306, /// 0.987068, /// 7973.05 /// ], /// "fov": 40.0 /// } /// ] /// } /// @return Json stream including the data of Custom View such as Camera Matrix, FOV, and so on. .. tabs:: .. code-tab:: python def GetCustomViewInformationW() -> str """ @ingroup UTILITY_API @brief Get the custom view information { "customViewList": [ { "cameraMatrix": [ // row vector 0, 1, 2 of "local to world camera matrix" 1.0, 0.000166, -0.001024, 0.352125, 0.0, 0.987069, 0.160306, 2592.8, 0.001039, -0.160306, 0.987068, 7973.05 ], "fov": 40.0 } ] } @return Json stream including the data of Custom View such as Camera Matrix, FOV, and so on. """ .. code-tab:: c++ GetCustomViewInformationW() /// @ingroup UTILITY_API /// @brief Get the custom view information /// { /// "customViewList": [ /// { /// "cameraMatrix": [ // row vector 0, 1, 2 of "local to world camera matrix" /// 1.0, /// 0.000166, /// -0.001024, /// 0.352125, /// 0.0, /// 0.987069, /// 0.160306, /// 2592.8, /// 0.001039, /// -0.160306, /// 0.987068, /// 7973.05 /// ], /// "fov": 40.0 /// } /// ] /// } /// @return Json stream including the data of Custom View such as Camera Matrix, FOV, and so on. .. tabs:: .. code-tab:: python def GetClothPositions(positions : list[float]) -> None """ @ingroup UTILITY_API @brief Get the position array of cloth shape. Each three array has x, y, z position of each vertex. @param positions: the output position list for the cloth shape """ .. code-tab:: c++ GetClothPositions(vector& positions) /// @ingroup UTILITY_API /// @brief Get the position array of cloth shape. Each three array has x, y, z position of each vertex. /// @param positions: the output position list for the cloth shape .. tabs:: .. code-tab:: python def ResetClothArrangement() -> None """ @ingroup UTILITY_API @brief Restore the shape of cloth to when the cloth was loaded """ .. code-tab:: c++ ResetClothArrangement() /// @ingroup UTILITY_API /// @brief Restore the shape of cloth to when the cloth was loaded .. tabs:: .. code-tab:: python def GetThumbnailInCLOFile(filePath : str, thumbnailIndex : int, fileSize : int) -> char* """ @ingroup UTILITY_API @brief Get Preview thumbnail file buffer(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on) @param filePath: the source file path to retrieve the thumbnail buffer @param thumbnailIndex: the index of the thumbnails in the CLO file format(the number of thumbnails differs by the format) @param fileSize: get the size of the thumbnail buffer @return thumbnail(png) buffer """ .. code-tab:: c++ GetThumbnailInCLOFile(std::string filePath, unsigned int thumbnailIndex, unsigned int& fileSize) /// @ingroup UTILITY_API /// @brief Get Preview thumbnail file buffer(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on) /// @param filePath: the source file path to retrieve the thumbnail buffer /// @param thumbnailIndex: the index of the thumbnails in the CLO file format(the number of thumbnails differs by the format) /// @param fileSize: get the size of the thumbnail buffer /// @return thumbnail(png) buffer .. tabs:: .. code-tab:: python def SaveCLOFileThumbnail(filePath : str, outputPath : str, thumbnailIndex : int) -> bool """ @ingroup UTILITY_API @brief Save Preview thumbnail image file(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on) @param filePath: the source file path to retrieve the thumbnail buffer @param outputPath: output png imager path @param thumbnailIndex: the index of the thumbnails in the CLO file format(the number of thumbnails differs by the format) @return save result """ .. code-tab:: c++ SaveCLOFileThumbnail(std::string filePath, std::string outputPath, unsigned int thumbnailIndex) /// @ingroup UTILITY_API /// @brief Save Preview thumbnail image file(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on) /// @param filePath: the source file path to retrieve the thumbnail buffer /// @param outputPath: output png imager path /// @param thumbnailIndex: the index of the thumbnails in the CLO file format(the number of thumbnails differs by the format) /// @return save result .. tabs:: .. code-tab:: python def SaveCLOFileThumbnail(filePath : str, outputPath : str, thumbnailIndex : int) -> bool """ @ingroup UTILITY_API @brief Save Preview thumbnail image file(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on) @param filePath: the source file path to retrieve the thumbnail buffer @param outputPath: output png imager path @param thumbnailIndex: the index of the thumbnails in the CLO file format(the number of thumbnails differs by the format) @return save result """ .. code-tab:: c++ SaveCLOFileThumbnail(std::string filePath, std::wstring outputPath, unsigned int thumbnailIndex) /// @ingroup UTILITY_API /// @brief Save Preview thumbnail image file(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on) /// @param filePath: the source file path to retrieve the thumbnail buffer /// @param outputPath: output png imager path /// @param thumbnailIndex: the index of the thumbnails in the CLO file format(the number of thumbnails differs by the format) /// @return save result .. tabs:: .. code-tab:: python def GetAssetIconInCLOFile(filePath : str, fileSize : int) -> char* """ @ingroup UTILITY_API @brief Get Asset Icon thumbnail file buffer(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on) @param filePath: the source file path to retrieve the thumbnail buffer @param fileSize: get the size of the thumbnail buffer @return thumbnail(png) buffer """ .. code-tab:: c++ GetAssetIconInCLOFile(std::string filePath, unsigned int& fileSize) /// @ingroup UTILITY_API /// @brief Get Asset Icon thumbnail file buffer(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on) /// @param filePath: the source file path to retrieve the thumbnail buffer /// @param fileSize: get the size of the thumbnail buffer /// @return thumbnail(png) buffer .. tabs:: .. code-tab:: python def GetMetaDataForCurrentGarment() -> str """ @ingroup UTILITY_API @brief Get Meta data for the current Garment @return the meta data for the current garment """ .. code-tab:: c++ GetMetaDataForCurrentGarment() /// @ingroup UTILITY_API /// @brief Get Meta data for the current Garment /// @return the meta data for the current garment .. tabs:: .. code-tab:: python def GetMetaDataForCurrentGarmentW() -> str """ @ingroup UTILITY_API @brief Get Meta data for the current Garment @return the meta data for the current garment """ .. code-tab:: c++ GetMetaDataForCurrentGarmentW() /// @ingroup UTILITY_API /// @brief Get Meta data for the current Garment /// @return the meta data for the current garment .. tabs:: .. code-tab:: python def SetMetaDataForCurrentGarment(metaDataStr : str) -> None """ @ingroup UTILITY_API @brief Overwrite Meta data for the current Garment @param metaDataStr: the new meata data to set to the current garment """ .. code-tab:: c++ SetMetaDataForCurrentGarment(const string& metaDataStr) /// @ingroup UTILITY_API /// @brief Overwrite Meta data for the current Garment /// @param metaDataStr: the new meata data to set to the current garment .. tabs:: .. code-tab:: python def ChangeMetaDataValueForCurrentGarment(metaDataKey : str, metaDataValue : str) -> None """ @ingroup UTILITY_API @brief Change Meta Data Value for the current Garment @param metaDataKey: target Key @param metaDataValue: the new value for the key """ .. code-tab:: c++ ChangeMetaDataValueForCurrentGarment(const string& metaDataKey, const string& metaDataValue) /// @ingroup UTILITY_API /// @brief Change Meta Data Value for the current Garment /// @param metaDataKey: target Key /// @param metaDataValue: the new value for the key .. tabs:: .. code-tab:: python def CreateProgressBar() -> None """ @ingroup UTILITY_API @brief Create Progress Bar to show progress. This function should be called before using SetProgress function """ .. code-tab:: c++ CreateProgressBar() /// @ingroup UTILITY_API /// @brief Create Progress Bar to show progress. This function should be called before using SetProgress function .. tabs:: .. code-tab:: python def SetProgress(title : str, progress : int) -> None """ @ingroup UTILITY_API @brief Set progress on the Progress Bar """ .. code-tab:: c++ SetProgress(const string& title, int progress) /// @ingroup UTILITY_API /// @brief Set progress on the Progress Bar .. tabs:: .. code-tab:: python def SetProgressW(title : str, progress : int) -> None """ @ingroup UTILITY_API @brief Set progress on the Progress Bar """ .. code-tab:: c++ SetProgressW(const wstring& title, int progress) /// @ingroup UTILITY_API /// @brief Set progress on the Progress Bar .. tabs:: .. code-tab:: python def DeleteProgressBar(bForce : bool) -> None """ @ingroup UTILITY_API @brief Delete the current Progress Bar. This function should be called after using the SetProgress funtion @param bForce: true - retry to delete progress bar; false - try only once to delete progress bar """ .. code-tab:: c++ DeleteProgressBar(bool bForce) /// @ingroup UTILITY_API /// @brief Delete the current Progress Bar. This function should be called after using the SetProgress funtion /// @param bForce: true - retry to delete progress bar; false - try only once to delete progress bar .. tabs:: .. code-tab:: python def stringToMD5(str : str) -> str """ @ingroup UTILITY_API @brief Create MD5 hashing string from string @param str: the source string to hash @return MD5 hashed string """ .. code-tab:: c++ stringToMD5(const string& str) /// @ingroup UTILITY_API /// @brief Create MD5 hashing string from string /// @param str: the source string to hash /// @return MD5 hashed string .. tabs:: .. code-tab:: python def AddColorSwatch(plmIDtoNameList : map[str, str], plmIDtoColorList : map[str, CloApiRgb], plmIDtoApiMetaDataList : map[str, str], swatchName : str) -> str """ @ingroup UTILITY_API @brief Add Color Swatch @param plmIDtoNameList: the list for map of PLM ID to Color Name @param plmIDtoColorList: list for map of PLM ID to color name @param plmIDtoApiMetaDataList: list for map of PLM ID to Api Meta Data @param swatchName: swatchName which will be shown in the color palette and the swatch file name to save @return added swatch file name(.aco) inside the asset folder for the current version of CLO """ .. code-tab:: c++ AddColorSwatch(const map& plmIDtoNameList, const map& plmIDtoColorList, const map& plmIDtoApiMetaDataList, const string& swatchName) /// @ingroup UTILITY_API /// @brief Add Color Swatch /// @param plmIDtoNameList: the list for map of PLM ID to Color Name /// @param plmIDtoColorList: list for map of PLM ID to color name /// @param plmIDtoApiMetaDataList: list for map of PLM ID to Api Meta Data /// @param swatchName: swatchName which will be shown in the color palette and the swatch file name to save /// @return added swatch file name(.aco) inside the asset folder for the current version of CLO .. tabs:: .. code-tab:: python def AddColorSwatchW(plmIDtoNameList : map[str, str], plmIDtoColorList : map[str, CloApiRgb], plmIDtoApiMetaDataList : map[str, str], swatchName : str) -> str """ @ingroup UTILITY_API @brief Add Color Swatch @param plmIDtoNameList: the list for map of PLM ID to Color Name @param plmIDtoColorList: list for map of PLM ID to color name @param plmIDtoApiMetaDataList: list for map of PLM ID to Api Meta Data @param swatchName: swatchName which will be shown in the color palette and the swatch file name to save @return added swatch file name(.aco) inside the asset folder for the current version of CLO """ .. code-tab:: c++ AddColorSwatchW(const map& plmIDtoNameList, const map& plmIDtoColorList, const map& plmIDtoApiMetaDataList, const wstring& swatchName) /// @ingroup UTILITY_API /// @brief Add Color Swatch /// @param plmIDtoNameList: the list for map of PLM ID to Color Name /// @param plmIDtoColorList: list for map of PLM ID to color name /// @param plmIDtoApiMetaDataList: list for map of PLM ID to Api Meta Data /// @param swatchName: swatchName which will be shown in the color palette and the swatch file name to save /// @return added swatch file name(.aco) inside the asset folder for the current version of CLO .. tabs:: .. code-tab:: python def LoadLibraryColorSwatchList(library : list[str], tabName : str) -> None """ @ingroup UTILITY_API @brief Load the library and add it to the color palette tab. @param library: the list with multiple color swatch file paths @param tabName: tabName which will be shown in the color palette library tab """ .. code-tab:: c++ LoadLibraryColorSwatchList(const std::vector& library) /// @ingroup UTILITY_API /// @brief Load the library and add it to the color palette tab. /// @param library: the list with multiple color swatch file paths /// @param tabName: tabName which will be shown in the color palette library tab .. tabs:: .. code-tab:: python def AddLibraryColorSwatchList(library : list[str], tabName : str) -> bool """ @ingroup UTILITY_API @brief Add the library to the color swatch list of the color palette tab(for combobox palette). @param library: The list of multiple color swatch file paths @param tabName: Name of the color palette library tab @return true on success, false on failure """ .. code-tab:: c++ AddLibraryColorSwatchList(const std::vector& library, const std::string& tabName) /// @ingroup UTILITY_API /// @brief Add the library to the color swatch list of the color palette tab(for combobox palette). /// @param library: The list of multiple color swatch file paths /// @param tabName: Name of the color palette library tab /// @return true on success, false on failure .. tabs:: .. code-tab:: python def SetColorSwatchListItemName(tabName : str, index : int, text : str) -> bool """ @ingroup UTILITY_API @brief Sets the name of a color switch item in the library(for combobox palette). @param tabName: Name of the color palette library tab @param index: Index of the item to be renamed from the color swatch list @param text: Text to be set @return true on success, false on failure """ .. code-tab:: c++ SetColorSwatchListItemName(const std::string& tabName, const int index, const std::string& text) /// @ingroup UTILITY_API /// @brief Sets the name of a color switch item in the library(for combobox palette). /// @param tabName: Name of the color palette library tab /// @param index: Index of the item to be renamed from the color swatch list /// @param text: Text to be set /// @return true on success, false on failure .. tabs:: .. code-tab:: python def DeleteColorSwatchListItem(tabName : str, index : int) -> bool """ @ingroup UTILITY_API @brief Delete the index item from the Color Switch list within the library tab(for combobox palette). @param tabName: Name of the color palette library tab @param index: Index of the item to be deleted from the color swatch list. @return true on success, false on failure """ .. code-tab:: c++ DeleteColorSwatchListItem(const std::string& tabName, int index) /// @ingroup UTILITY_API /// @brief Delete the index item from the Color Switch list within the library tab(for combobox palette). /// @param tabName: Name of the color palette library tab /// @param index: Index of the item to be deleted from the color swatch list. /// @return true on success, false on failure .. tabs:: .. code-tab:: python def SetColorSwatchLibraryTabName(tabName : str, newTabName : str) -> bool """ @ingroup UTILITY_API @brief Sets the name of the library tab. @param tabName: Name of the color palette library tab @param newTabName: Text to be set @return true on success, false on failure """ .. code-tab:: c++ SetColorSwatchListItemName(const std::string& tabName, const int index, const std::string& text) /// @ingroup UTILITY_API /// @brief Sets the name of the library tab. /// @param tabName: Name of the color palette library tab /// @param newTabName: Text to be set /// @return true on success, false on failure .. tabs:: .. code-tab:: python def DeleteColorSwatchLibraryTabByName(tabName : str, bCaseInsensitive : bool) -> bool """ @ingroup UTILITY_API @brief Delete library tab from color palette in name @param tabName: tabName which will be shown in the color palette library tab @param bCaseInsensitive: If true, case is not sensitive. @return true if deletion is successful """ .. code-tab:: c++ DeleteColorSwatchLibraryTabByName(const std::string tabName, bool bCaseInsensitive = true) /// @ingroup UTILITY_API /// @brief Delete library tab from color palette in name /// @param tabName: tabName which will be shown in the color palette library tab /// @param bCaseInsensitive: If true, case is not sensitive. /// @return true if deletion is successful .. tabs:: .. code-tab:: python def GetColorSwatchLibraryTabList() -> list[str] """ @ingroup UTILITY_API @brief Get the list of color swatch library tab names @return the list of color swatch library tab names """ .. code-tab:: c++ GetColorSwatchLibraryTabList() /// @ingroup UTILITY_API /// @brief Get the list of color swatch library tab names /// @return the list of color swatch library tab names .. tabs:: .. code-tab:: python def GetColorSwatchLibraryTabListW() -> list[str] """ @ingroup UTILITY_API @brief Get the list of color swatch library tab names as wstring @return the list of color swatch library tab names as wstring """ .. code-tab:: c++ GetColorSwatchLibraryTabListW() /// @ingroup UTILITY_API /// @brief Get the list of color swatch library tab names as wstring /// @return the list of color swatch library tab names as wstring .. tabs:: .. code-tab:: python def CreateUserCustomLibrary() -> int """ @ingroup UTILITY_API @brief Create a new empty User Custom Library tab. @return 0-based index among User Custom Library tabs in current visual order, or -1 on failure. """ .. code-tab:: c++ CreateUserCustomLibrary() /// @ingroup UTILITY_API /// @brief Create a new empty User Custom Library tab. /// @return 0-based index among User Custom Library tabs in current visual order, or -1 on failure. .. tabs:: .. code-tab:: python def AddUserCustomLibraryFolder(libraryIndex : int, folderPath : str) -> bool """ @ingroup UTILITY_API @brief Add a folder to a User Custom Library. @param libraryIndex: 0-based index among User Custom Library tabs in current visual order. @param folderPath: Absolute folder path to add. @return true on success, false on failure. """ .. code-tab:: c++ AddUserCustomLibraryFolder(int libraryIndex, const std::string& folderPath) /// @ingroup UTILITY_API /// @brief Add a folder to a User Custom Library. /// @param libraryIndex: 0-based index among User Custom Library tabs in current visual order. /// @param folderPath: Absolute folder path to add. /// @return true on success, false on failure. .. tabs:: .. code-tab:: python def AddUserCustomLibraryFolderW(libraryIndex : int, folderPath : str) -> bool """ @ingroup UTILITY_API @brief Add a folder to a User Custom Library. @param libraryIndex: 0-based index among User Custom Library tabs in current visual order. @param folderPath: Absolute folder path to add. @return true on success, false on failure. """ .. code-tab:: c++ AddUserCustomLibraryFolderW(int libraryIndex, const std::wstring& folderPath) /// @ingroup UTILITY_API /// @brief Add a folder to a User Custom Library. /// @param libraryIndex: 0-based index among User Custom Library tabs in current visual order. /// @param folderPath: Absolute folder path to add. /// @return true on success, false on failure. .. tabs:: .. code-tab:: python def DeleteUserCustomLibraryFolder(libraryIndex : int, index : int) -> bool """ @ingroup UTILITY_API @brief Delete a folder from a User Custom Library. @param libraryIndex: 0-based index among User Custom Library tabs in current visual order. @param index: 0-based index among the target library's root folders. @return true on success, false on failure. """ .. code-tab:: c++ DeleteUserCustomLibraryFolder(int libraryIndex, int index) /// @ingroup UTILITY_API /// @brief Delete a folder from a User Custom Library. /// @param libraryIndex: 0-based index among User Custom Library tabs in current visual order. /// @param index: 0-based index among the target library's root folders. /// @return true on success, false on failure. .. tabs:: .. code-tab:: python def DeleteUserCustomLibrary(index : int) -> bool """ @ingroup UTILITY_API @brief Delete a User Custom Library tab by 0-based index in the current visual order of User Custom tabs only. @param index: 0-based index among User Custom Library tabs only. @return true on success, false on failure. """ .. code-tab:: c++ DeleteUserCustomLibrary(int index) /// @ingroup UTILITY_API /// @brief Delete a User Custom Library tab by 0-based index in the current visual order of User Custom tabs only. /// @param index: 0-based index among User Custom Library tabs only. /// @return true on success, false on failure. .. tabs:: .. code-tab:: python def NewProject() -> None """ @ingroup UTILITY_API @brief Clear the current garment and begin a new garment """ .. code-tab:: c++ NewProject() /// @ingroup UTILITY_API /// @brief Clear the current garment and begin a new garment .. tabs:: .. code-tab:: python def IsReadableImageFormat(filePath : str) -> bool """ API calls; especially for Library Windows Sample Demo. - IsReadableImageFormatFromExtension / IsReadableImageFormatFromExtensionW : Check if the file stream loaded from the filepath used in Library Windows Implementations can be displayed on Library Windows for item thumbnail and/or preview dialog. (The files should not contain image data over 8bits per channel for 1 ~ 4 channels image.) - IsCLOFileFormatWithThumbnailExtension / IsCLOFileFormatWithThumbnailExtensionW : Check if the CLO file format has the thumbnail memory. - IsCLOFileFormatWithTripleThumbnailExtension / IsCLOFileFormatWithTripleThumbnailExtensionW : Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. @ingroup UTILITY_API @brief Check if the file stream loaded from the filepath used in Library Windows Implementations can be displayed on Library Windows for item thumbnail and/or preview dialog. @return true if the file can be displayed on Library Windows for item thumbnail and/or preview dialog """ .. code-tab:: c++ IsReadableImageFormat(const string& filePath) /// API calls; especially for Library Windows Sample Demo. /// - IsReadableImageFormatFromExtension / IsReadableImageFormatFromExtensionW /// : Check if the file stream loaded from the filepath used in Library Windows Implementations can be displayed on Library Windows for item thumbnail and/or preview dialog. /// (The files should not contain image data over 8bits per channel for 1 ~ 4 channels image.) /// - IsCLOFileFormatWithThumbnailExtension / IsCLOFileFormatWithThumbnailExtensionW /// : Check if the CLO file format has the thumbnail memory. /// - IsCLOFileFormatWithTripleThumbnailExtension / IsCLOFileFormatWithTripleThumbnailExtensionW /// : Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. /// @ingroup UTILITY_API /// @brief Check if the file stream loaded from the filepath used in Library Windows Implementations can be displayed on Library Windows for item thumbnail and/or preview dialog. /// @return true if the file can be displayed on Library Windows for item thumbnail and/or preview dialog .. tabs:: .. code-tab:: python def IsReadableImageFormatW(filePath : str) -> bool """ @ingroup UTILITY_API @brief Check if the file stream loaded from the filepath used in Library Windows Implementations can be displayed on Library Windows for item thumbnail and/or preview dialog. @return true if the file can be displayed on Library Windows for item thumbnail and/or preview dialog """ .. code-tab:: c++ IsReadableImageFormatW(const wstring& filePath) /// @ingroup UTILITY_API /// @brief Check if the file stream loaded from the filepath used in Library Windows Implementations can be displayed on Library Windows for item thumbnail and/or preview dialog. /// @return true if the file can be displayed on Library Windows for item thumbnail and/or preview dialog .. tabs:: .. code-tab:: python def IsCLOFileFormatWithThumbnail(filePath : str) -> bool """ @ingroup UTILITY_API @brief Check if the CLO file format has the thumbnail memory. @return true if the file is the CLO format file and contains the thumbnail memory which can be displayed on Library Windows for item thumbnail and/or preview dialog """ .. code-tab:: c++ IsCLOFileFormatWithThumbnail(const string& filePath) /// @ingroup UTILITY_API /// @brief Check if the CLO file format has the thumbnail memory. /// @return true if the file is the CLO format file and contains the thumbnail memory which can be displayed on Library Windows for item thumbnail and/or preview dialog .. tabs:: .. code-tab:: python def IsCLOFileFormatWithThumbnailW(filePath : str) -> bool """ @ingroup UTILITY_API @brief Check if the CLO file format has the thumbnail memory. @return true if the file is the CLO format file and contains the thumbnail memory which can be displayed on Library Windows for item thumbnail and/or preview dialog """ .. code-tab:: c++ IsCLOFileFormatWithThumbnailW(const wstring& filePath) /// @ingroup UTILITY_API /// @brief Check if the CLO file format has the thumbnail memory. /// @return true if the file is the CLO format file and contains the thumbnail memory which can be displayed on Library Windows for item thumbnail and/or preview dialog .. tabs:: .. code-tab:: python def IsCLOFileFormatWithTripleThumbnail(filePath : str) -> bool """ @ingroup UTILITY_API @brief Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. @return true if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. """ .. code-tab:: c++ IsCLOFileFormatWithTripleThumbnail(const string& filePath) /// @ingroup UTILITY_API /// @brief Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. /// @return true if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. .. tabs:: .. code-tab:: python def IsCLOFileFormatWithTripleThumbnailW(filePath : str) -> bool """ @ingroup UTILITY_API @brief Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. @return true if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. """ .. code-tab:: c++ IsCLOFileFormatWithTripleThumbnailW(const wstring& filePath) /// @ingroup UTILITY_API /// @brief Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. /// @return true if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog. .. tabs:: .. code-tab:: python def ValidateCLOFile(filePath : str) -> map[str, str] """ @ingroup UTILITY_API @brief Validate whether the given file is a CLO native file by checking its file signature. @param filePath: The absolute path to the file to validate. @return A map containing "isValid" ("true" / "false") and "fileType" (string, e.g., "CLO Fabric", "CLO Button"). """ .. code-tab:: c++ ValidateCLOFile(const string& filePath) /// @ingroup UTILITY_API /// @brief Validate whether the given file is a CLO native file by checking its file signature. /// @param filePath: The absolute path to the file to validate. /// @return A map containing "isValid" ("true" / "false") and "fileType" (string, e.g., "CLO Fabric", "CLO Button"). .. tabs:: .. code-tab:: python def ValidateCLOFileW(filePath : str) -> map[str, str] """ @ingroup UTILITY_API @brief Validate whether the given file is a CLO native file by checking its file signature. @param filePath: The absolute path to the file to validate. @return A map containing "isValid" ("true" / "false") and "fileType" (string, e.g., "CLO Fabric", "CLO Button"). """ .. code-tab:: c++ ValidateCLOFileW(const wstring& filePath) /// @ingroup UTILITY_API /// @brief Validate whether the given file is a CLO native file by checking its file signature. /// @param filePath: The absolute path to the file to validate. /// @return A map containing "isValid" ("true" / "false") and "fileType" (string, e.g., "CLO Fabric", "CLO Button"). .. tabs:: .. code-tab:: python def GetCLOExecutableFolderPath(bLinuxTypePathDelimeter : bool) -> str """ @ingroup UTILITY_API @brief Get the executable folder path where the current version of CLO is located @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\' @return Get the executable folder path for the current version of CLO software """ .. code-tab:: c++ GetCLOExecutableFolderPath(bool bLinuxTypePathDelimeter = true) /// @ingroup UTILITY_API /// @brief Get the executable folder path where the current version of CLO is located /// @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\' /// @return Get the executable folder path for the current version of CLO software .. tabs:: .. code-tab:: python def GetCLOExecutableFolderPathW(bLinuxTypePathDelimeter : bool) -> str """ @ingroup UTILITY_API @brief Get the executable folder path where the current version of CLO is located @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\' @return Get the executable folder path for the current version of CLO software """ .. code-tab:: c++ GetCLOExecutableFolderPathW(bool bLinuxTypePathDelimeter = true) /// @ingroup UTILITY_API /// @brief Get the executable folder path where the current version of CLO is located /// @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\' /// @return Get the executable folder path for the current version of CLO software .. tabs:: .. code-tab:: python def GetCLOAssetFolderPath(bLinuxTypePathDelimeter : bool) -> str """ @ingroup UTILITY_API @brief Get the folder path where the CLO asset files are distributed @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\' @return Get the asset folder path where the CLO asset files are located in """ .. code-tab:: c++ GetCLOAssetFolderPath(bool bLinuxTypePathDelimeter = true) /// @ingroup UTILITY_API /// @brief Get the folder path where the CLO asset files are distributed /// @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\' /// @return Get the asset folder path where the CLO asset files are located in .. tabs:: .. code-tab:: python def GetCLOAssetFolderPathW(bLinuxTypePathDelimeter : bool) -> str """ @ingroup UTILITY_API @brief Get the folder path where the CLO asset files are distributed @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\' @return Get the asset folder path where the CLO asset files are located in """ .. code-tab:: c++ GetCLOAssetFolderPathW(bool bLinuxTypePathDelimeter = true) /// @ingroup UTILITY_API /// @brief Get the folder path where the CLO asset files are distributed /// @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\' /// @return Get the asset folder path where the CLO asset files are located in .. tabs:: .. code-tab:: python def GetAPIMetaData(filePath : str) -> str """ @ingroup UTILITY_API @brief Get API meta data for the file @param filePath: CLO file path @return json string for meta data [key - value] list """ .. code-tab:: c++ GetAPIMetaData(const string& filePath) /// @ingroup UTILITY_API /// @brief Get API meta data for the file /// @param filePath: CLO file path /// @return json string for meta data [key - value] list .. tabs:: .. code-tab:: python def GetAPIMetaDataW(filePath : str) -> str """ @ingroup UTILITY_API @brief Get API meta data for the file @param filePath: CLO file path @return json string for meta data [key - value] list """ .. code-tab:: c++ GetAPIMetaDataW(const wstring& filePath) /// @ingroup UTILITY_API /// @brief Get API meta data for the file /// @param filePath: CLO file path /// @return json string for meta data [key - value] list .. tabs:: .. code-tab:: python def SetAPIMetaData(filePath : str, jsonStr : str) -> bool """ @ingroup UTILITY_API @brief Set API meta data to the file @param filePath: target file path @param jsonStr: api meta data in string format @return if it succeeds, return true """ .. code-tab:: c++ SetAPIMetaData(const string& filePath, string jsonStr) /// @ingroup UTILITY_API /// @brief Set API meta data to the file /// @param filePath: target file path /// @param jsonStr: api meta data in string format /// @return if it succeeds, return true .. tabs:: .. code-tab:: python def SetAPIMetaDataW(filePath : str, jsonStr : str) -> bool """ @ingroup UTILITY_API @brief Set API meta data to the file @param filePath: target file path @param jsonStr: api meta data in wstring format @return if it succeeds, return true """ .. code-tab:: c++ SetAPIMetaDataW(const wstring& filePath, wstring jsonStr) /// @ingroup UTILITY_API /// @brief Set API meta data to the file /// @param filePath: target file path /// @param jsonStr: api meta data in wstring format /// @return if it succeeds, return true .. tabs:: .. code-tab:: python def Set3DWindowTitle(title : str) -> bool """ @ingroup UTILITY_API @brief Set 3D Window Title @param title: desired text in 3D window @return if it succeeds, return true """ .. code-tab:: c++ Set3DWindowTitle(const string& title) /// @ingroup UTILITY_API /// @brief Set 3D Window Title /// @param title: desired text in 3D window /// @return if it succeeds, return true .. tabs:: .. code-tab:: python def Set3DWindowTitleW(title : str) -> bool """ @ingroup UTILITY_API @brief Set 3D Window Title @param title: desired text in 3D window @return if it succeeds, return true """ .. code-tab:: c++ Set3DWindowTitleW(const wstring& title) /// @ingroup UTILITY_API /// @brief Set 3D Window Title /// @param title: desired text in 3D window /// @return if it succeeds, return true .. tabs:: .. code-tab:: python def GetColorListForColorWay(_colorWayIndex : int) -> list[CloApiRgba] """ @ingroup UTILITY_API @brief Get Color List for ColorWay @param _colorwayIndex: the colorway index to get the result @return the color list in CloAgiRgba for the target ColorWay """ .. code-tab:: c++ GetColorListForColorWay(unsigned int _colorWayIndex) /// @ingroup UTILITY_API /// @brief Get Color List for ColorWay /// @param _colorwayIndex: the colorway index to get the result /// @return the color list in CloAgiRgba for the target ColorWay .. tabs:: .. code-tab:: python def SetShowHideAvatar(_bShow : bool) -> None """ @ingroup UTILITY_API @brief Set all avatars' show/hide status @param _bShow: true for show, false for hide """ .. code-tab:: c++ SetShowHideAvatar(bool _bShow) /// @ingroup UTILITY_API /// @brief Set all avatars' show/hide status /// @param _bShow: true for show, false for hide .. tabs:: .. code-tab:: python def SetShowHideAvatar(_bShow : bool, _avatarIdex : int) -> None """ @ingroup UTILITY_API @brief Set show/hide status of avatar that matches the index @param _bShow: true for show, false for hide @param _avatarIdex: the target avatar index """ .. code-tab:: c++ SetShowHideAvatar(bool _bShow, int _avatarIdex) /// @ingroup UTILITY_API /// @brief Set show/hide status of avatar that matches the index /// @param _bShow: true for show, false for hide /// @param _avatarIdex: the target avatar index .. tabs:: .. code-tab:: python def IsShowAvatar(_avatarIndex : int) -> bool """ @ingroup UTILITY_API @brief Get show status of avatar that matches the index @param _avatarIndex: the avatar index to get the result. @return if avatar is shown, return true. if avatar is hidden, return false. """ .. code-tab:: c++ IsShowAvatar(int _avatarIndex) /// @ingroup UTILITY_API /// @brief Get show status of avatar that matches the index /// @param _avatarIndex: the avatar index to get the result. /// @return if avatar is shown, return true. if avatar is hidden, return false. .. tabs:: .. code-tab:: python def SetSchematicRender(_bSet : bool) -> None """ @ingroup UTILITY_API @brief Set Schematic Render status @param _bSet: true for enable, false for disable """ .. code-tab:: c++ SetSchematicRender(bool _bSet) /// @ingroup UTILITY_API /// @brief Set Schematic Render status /// @param _bSet: true for enable, false for disable .. tabs:: .. code-tab:: python def UpdateColorways(bUpdateSnapshot : bool) -> None """ @ingroup UTILITY_API @brief Update Colorways in the CLO software @param bUpdateSnapshot: put the value to true to update the colorway's snapshot """ .. code-tab:: c++ UpdateColorways(bool bUpdateSnapshot = true) /// @ingroup UTILITY_API /// @brief Update Colorways in the CLO software /// @param bUpdateSnapshot: put the value to true to update the colorway's snapshot .. tabs:: .. code-tab:: python def DeleteColorwayItem(_index : int) -> None """ @ingroup UTILITY_API @brief Delete the colorway in the index @param index: the source colorway index to delete """ .. code-tab:: c++ DeleteColorwayItem(unsigned int _index) /// @ingroup UTILITY_API /// @brief Delete the colorway in the index /// @param index: the source colorway index to delete .. tabs:: .. code-tab:: python def ReplaceGraphicStyleFromImage(_graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool """ @ingroup UTILITY_API @brief Replace the image on a graphic style. All colorways that share this style are updated. The chosen anchor point on the original graphic stays fixed in world space after replacement. @param _graphicstyleIndex: index of the style to replace @param _imagePath: path to the new image file @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values: 0=Center 1=Up 2=RightUp 3=Right 4=RightDown 5=Down 6=LeftDown 7=Left 8=LeftUp @return true if successful @example anchor = CLOAPI_ANCHOR_LEFT_UP — wide logo replaced by tall logo, top-left pinned: BEFORE AFTER 8─────────────────2 8──2 <- top-left (8) same world position │ │ │ │ │ OLD LOGO │ --> │ │ │ │ │ │ 6─────────────────4 │ │ 6──4 @example anchor = CLOAPI_ANCHOR_CENTER (0) — also preserves original display size: BEFORE AFTER ┌─────────────────┐ ┌─────────────────┐ │ OLD LOGO │ --> │ NEW LOGO │ <- same size, center unmoved └─────────────────┘ └─────────────────┘ @example anchor = CLOAPI_ANCHOR_RIGHT_DOWN — bottom-right corner pinned: BEFORE AFTER 8─────────────────2 8──2 │ │ │ │ │ OLD LOGO │ --> │ │ │ │ │ │ 6─────────────────4 ───────6──4 <- bottom-right (4) same world position """ .. code-tab:: c++ ReplaceGraphicStyleFromImage(int _graphicstyleIndex, const string& _imagePath, int _anchor) /// @ingroup UTILITY_API /// @brief Replace the image on a graphic style. All colorways that share this style are updated. /// The chosen anchor point on the original graphic stays fixed in world space after replacement. /// @param _graphicstyleIndex: index of the style to replace /// @param _imagePath: path to the new image file /// @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values: /// 0=Center 1=Up 2=RightUp 3=Right 4=RightDown /// 5=Down 6=LeftDown 7=Left 8=LeftUp /// @return true if successful /// @example anchor = CLOAPI_ANCHOR_LEFT_UP — wide logo replaced by tall logo, top-left pinned: /// BEFORE AFTER /// 8─────────────────2 8──2 <- top-left (8) same world position /// │ │ │ │ /// │ OLD LOGO │ --> │ │ /// │ │ │ │ /// 6─────────────────4 │ │ /// 6──4 /// @example anchor = CLOAPI_ANCHOR_CENTER (0) — also preserves original display size: /// BEFORE AFTER /// ┌─────────────────┐ ┌─────────────────┐ /// │ OLD LOGO │ --> │ NEW LOGO │ <- same size, center unmoved /// └─────────────────┘ └─────────────────┘ /// @example anchor = CLOAPI_ANCHOR_RIGHT_DOWN — bottom-right corner pinned: /// BEFORE AFTER /// 8─────────────────2 8──2 /// │ │ │ │ /// │ OLD LOGO │ --> │ │ /// │ │ │ │ /// 6─────────────────4 ───────6──4 <- bottom-right (4) same world position .. tabs:: .. code-tab:: python def ReplaceGraphicStyleFromImageW(_graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool """ @ingroup UTILITY_API @brief Wide-string variant of ReplaceGraphicStyleFromImage(index, string, anchor). See the string overload for full documentation and diagrams. @param _graphicstyleIndex: index of the style to replace @param _imagePath: path to the new image file (wide string) @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values: 0=Center 1=Up 2=RightUp 3=Right 4=RightDown 5=Down 6=LeftDown 7=Left 8=LeftUp @return true if successful """ .. code-tab:: c++ ReplaceGraphicStyleFromImage(int _graphicstyleIndex, const wstring& _imagePath, int _anchor) /// @ingroup UTILITY_API /// @brief Wide-string variant of ReplaceGraphicStyleFromImage(index, string, anchor). /// See the string overload for full documentation and diagrams. /// @param _graphicstyleIndex: index of the style to replace /// @param _imagePath: path to the new image file (wide string) /// @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values: /// 0=Center 1=Up 2=RightUp 3=Right 4=RightDown /// 5=Down 6=LeftDown 7=Left 8=LeftUp /// @return true if successful .. tabs:: .. code-tab:: python def ReplaceGraphicStyleFromImage(_iColorwayIndex : int, _graphicstyleIndex : int, _imagePath : str, _anchor : int, _width : float, _height : float) -> bool """ @ingroup UTILITY_API @brief Replace the graphic style image for ONE colorway with an explicit display size. If the style is currently linked (shared) across colorways it is automatically unlinked for the target colorway first, so other colorways are NOT affected. The graphic is resized to exactly (_width x _height) mm regardless of anchor choice. @param _iColorwayIndex: index of the colorway to target @param _graphicstyleIndex: index within that colorway's graphic style list @param _imagePath: path to the new image file @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values: 0=Center 1=Up 2=RightUp 3=Right 4=RightDown 5=Down 6=LeftDown 7=Left 8=LeftUp @param _width: target display width in mm @param _height: target display height in mm @return true if successful, false if any index is out of range or the style is not applied in the target colorway @example Linked graphic — replace only colorway 0, colorway 1 unchanged: BEFORE (both linked to the same style) Colorway 0 --+ +--> [ old_logo ] Colorway 1 --+ AFTER ReplaceGraphicStyleFromImage(0, idx, "new_logo", CLOAPI_ANCHOR_LEFT_UP, 60, 30) Colorway 0 ------> [ new_logo 60x30mm ] (auto-unlinked, top-left pinned) Colorway 1 ------> [ old_logo ] (untouched) @example Already-unlinked graphic — replacement proceeds normally: Colorway 0 ------> [ logo_A ] Colorway 0 ------> [ new_logo 60x30mm ] Colorway 1 ------> [ logo_B ] --> Colorway 1 ------> [ logo_B ] (untouched) """ .. code-tab:: c++ ReplaceGraphicStyleFromImage(int _iColorwayIndex, int _graphicstyleIndex, const string& _imagePath, int _anchor, float _width, float _height) /// @ingroup UTILITY_API /// @brief Replace the graphic style image for ONE colorway with an explicit display size. /// If the style is currently linked (shared) across colorways it is automatically /// unlinked for the target colorway first, so other colorways are NOT affected. /// The graphic is resized to exactly (_width x _height) mm regardless of anchor choice. /// @param _iColorwayIndex: index of the colorway to target /// @param _graphicstyleIndex: index within that colorway's graphic style list /// @param _imagePath: path to the new image file /// @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values: /// 0=Center 1=Up 2=RightUp 3=Right 4=RightDown /// 5=Down 6=LeftDown 7=Left 8=LeftUp /// @param _width: target display width in mm /// @param _height: target display height in mm /// @return true if successful, false if any index is out of range or the style is not applied in the target colorway /// @example Linked graphic — replace only colorway 0, colorway 1 unchanged: /// BEFORE (both linked to the same style) /// Colorway 0 --+ /// +--> [ old_logo ] /// Colorway 1 --+ /// AFTER ReplaceGraphicStyleFromImage(0, idx, "new_logo", CLOAPI_ANCHOR_LEFT_UP, 60, 30) /// Colorway 0 ------> [ new_logo 60x30mm ] (auto-unlinked, top-left pinned) /// Colorway 1 ------> [ old_logo ] (untouched) /// @example Already-unlinked graphic — replacement proceeds normally: /// Colorway 0 ------> [ logo_A ] Colorway 0 ------> [ new_logo 60x30mm ] /// Colorway 1 ------> [ logo_B ] --> Colorway 1 ------> [ logo_B ] (untouched) .. tabs:: .. code-tab:: python def ReplaceGraphicStyleFromImageW(_iColorwayIndex : int, _graphicstyleIndex : int, _imagePath : str, _anchor : int, _width : float, _height : float) -> bool """ @ingroup UTILITY_API @brief Wide-string variant of ReplaceGraphicStyleFromImage(colorway, index, string, anchor, w, h). See the string overload for full documentation and diagrams. @param _iColorwayIndex: index of the colorway to target @param _graphicstyleIndex: index within that colorway's graphic style list @param _imagePath: path to the new image file (wide string) @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values: 0=Center 1=Up 2=RightUp 3=Right 4=RightDown 5=Down 6=LeftDown 7=Left 8=LeftUp @param _width: target display width in mm @param _height: target display height in mm @return true if successful, false if any index is out of range or the style is not applied in the target colorway """ .. code-tab:: c++ ReplaceGraphicStyleFromImageW(int _iColorwayIndex, int _graphicstyleIndex, const wstring& _imagePath, int _anchor, float _width, float _height) /// @ingroup UTILITY_API /// @brief Wide-string variant of ReplaceGraphicStyleFromImage(colorway, index, string, anchor, w, h). /// See the string overload for full documentation and diagrams. /// @param _iColorwayIndex: index of the colorway to target /// @param _graphicstyleIndex: index within that colorway's graphic style list /// @param _imagePath: path to the new image file (wide string) /// @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values: /// 0=Center 1=Up 2=RightUp 3=Right 4=RightDown /// 5=Down 6=LeftDown 7=Left 8=LeftUp /// @param _width: target display width in mm /// @param _height: target display height in mm /// @return true if successful, false if any index is out of range or the style is not applied in the target colorway .. tabs:: .. code-tab:: python def Simulate(_steps : int) -> bool """ @ingroup UTILITY_API @brief Simulate the garment in multi steps. All dynamics properties (time step, CG iteration count, ...) follow the current simulation properties @param _steps: how many steps(=frames) to simulate @return if it succeeds, return true. """ .. code-tab:: c++ Simulate(unsigned int _steps) /// @ingroup UTILITY_API /// @brief Simulate the garment in multi steps. All dynamics properties (time step, CG iteration count, ...) follow the current simulation properties /// @param _steps: how many steps(=frames) to simulate /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetSimulationQuality(_quality : int, _simulationMode : int) -> None """ @ingroup UTILITY_API @brief Set simulation quality preset @param _quality: input simulation preset (0: Normal(Default), 1: Animation(Stable), 2: Fitting(Accurate Fabric), 3: FAST(GPU)) @param _simulationMode: input simulation mode (0: CPU, 1: FAST(GPU)) """ .. code-tab:: c++ SetSimulationQuality(int _quality) /// @ingroup UTILITY_API /// @brief Set simulation quality preset /// @param _quality: input simulation preset (0: Normal(Default), 1: Animation(Stable), 2: Fitting(Accurate Fabric), 3: FAST(GPU)) /// @param _simulationMode: input simulation mode (0: CPU, 1: FAST(GPU)) .. tabs:: .. code-tab:: python def SetSimulationTimeStep(_timeStep : float) -> None """ @ingroup UTILITY_API @brief Set simulation time step @param _timeStep: time step in second (Default : 0.03333, Min value: 0.001) """ .. code-tab:: c++ SetSimulationTimeStep(int _timeStep) /// @ingroup UTILITY_API /// @brief Set simulation time step /// @param _timeStep: time step in second (Default : 0.03333, Min value: 0.001) .. tabs:: .. code-tab:: python def SetSimulationNumberOfSimulation(_numberOfSimulation : int) -> None """ @ingroup UTILITY_API @brief Set simulation substeps in one time step @param _numberOfSimulation: the number of substeps in one time step (Default : 1, Min/Max Range : 1~50) """ .. code-tab:: c++ SetSimulationNumberOfSimulation(int _numberOfSimulation) /// @ingroup UTILITY_API /// @brief Set simulation substeps in one time step /// @param _numberOfSimulation: the number of substeps in one time step (Default : 1, Min/Max Range : 1~50) .. tabs:: .. code-tab:: python def SetSimulationCGFinishCondition(_cgFinishCondition : int) -> None """ @ingroup UTILITY_API @brief Set simulation finish condition @param _cgFinishCondition : Conjugate Gradient finish condition (0: iteration, 1: residual) """ .. code-tab:: c++ SetSimulationCGFinishCondition(int _cgFinishCondition) /// @ingroup UTILITY_API /// @brief Set simulation finish condition /// @param _cgFinishCondition : Conjugate Gradient finish condition (0: iteration, 1: residual) .. tabs:: .. code-tab:: python def SetSimulationCGIterationCount(_cgIterationCount : int) -> None """ @ingroup UTILITY_API @brief Set Conjugate Gradient iteration count per one step. @param _cgIterationCount : iteration count (Default : 50, Min/Max Range 1~1000) """ .. code-tab:: c++ SetSimulationCGIterationCount(int _cgIterationCount) /// @ingroup UTILITY_API /// @brief Set Conjugate Gradient iteration count per one step. /// @param _cgIterationCount : iteration count (Default : 50, Min/Max Range 1~1000) .. tabs:: .. code-tab:: python def SetSimulationCGResidual(_cgResidual : float) -> None """ @ingroup UTILITY_API @brief Set Conjugate Gradient relative residual value for finishing @param _cgResidual : relative residual value for finishing (0.0001 in Normal, 0.00001 in Animation and Fitting) """ .. code-tab:: c++ SetSimulationCGResidual(int _cgResidual) /// @ingroup UTILITY_API /// @brief Set Conjugate Gradient relative residual value for finishing /// @param _cgResidual : relative residual value for finishing (0.0001 in Normal, 0.00001 in Animation and Fitting) .. tabs:: .. code-tab:: python def SetSimulationSelfCollisionIterationCount(_selfCollisionIterationCount : int) -> None """ @ingroup UTILITY_API @brief Set self collision iteration count @param _selfCollisionIterationCount : self collision iteration count (Default: 1) """ .. code-tab:: c++ SetSimulationSelfCollisionIterationCount(int _selfCollisionIterationCount) /// @ingroup UTILITY_API /// @brief Set self collision iteration count /// @param _selfCollisionIterationCount : self collision iteration count (Default: 1) .. tabs:: .. code-tab:: python def SetSimulationAirDamping(_airDamping : float) -> None """ @ingroup UTILITY_API @brief Set air damping value @param _airDamping : air damping(Default: 1.0) """ .. code-tab:: c++ SetSimulationAirDamping(int _airDamping) /// @ingroup UTILITY_API /// @brief Set air damping value /// @param _airDamping : air damping(Default: 1.0) .. tabs:: .. code-tab:: python def SetSimulationGravity(_gravity : float) -> None """ @ingroup UTILITY_API @brief Set gravity value in y-axis @param _gravity : gravity (Default: -9800.0 mm/s^2) """ .. code-tab:: c++ SetSimulationGravity(int _gravity) /// @ingroup UTILITY_API /// @brief Set gravity value in y-axis /// @param _gravity : gravity (Default: -9800.0 mm/s^2) .. tabs:: .. code-tab:: python def SetSimulationNumberOfCPUInUse(_numberOfSimulationInUse : int) -> None """ @ingroup UTILITY_API @brief Set the number of CPUs for simulation @param _numberOfSimulationInUse : the number of CPUs (Default: total number of logical threads - 1, Min/Max Range : 1~total number of logical threads) """ .. code-tab:: c++ SetSimulationNumberOfCPUInUse(int _numberOfSimulationInUse) /// @ingroup UTILITY_API /// @brief Set the number of CPUs for simulation /// @param _numberOfSimulationInUse : the number of CPUs (Default: total number of logical threads - 1, Min/Max Range : 1~total number of logical threads) .. tabs:: .. code-tab:: python def SetSimulationNonlinearSimulation(_bNonlinearSimulation : bool) -> None """ @ingroup UTILITY_API @brief Set nonlinear simulation @param _bNonlinearSimulation : true for enable, false for disable """ .. code-tab:: c++ SetSimulationNonlinearSimulation(int _bNonlinearSimulation) /// @ingroup UTILITY_API /// @brief Set nonlinear simulation /// @param _bNonlinearSimulation : true for enable, false for disable .. tabs:: .. code-tab:: python def SetSimulationGroundCollision(_bGroundCollision : bool) -> None """ @ingroup UTILITY_API @brief Set ground collision @param _bGroundCollision : true for enable, false for disable """ .. code-tab:: c++ SetSimulationGroundCollision(int _bGroundCollision) /// @ingroup UTILITY_API /// @brief Set ground collision /// @param _bGroundCollision : true for enable, false for disable .. tabs:: .. code-tab:: python def SetSimulationGroundHeight(_groundHeight : float) -> None """ @ingroup UTILITY_API @brief Set ground height value @param _groundHeight : ground height in y-axis (Default: 0.0) """ .. code-tab:: c++ SetSimulationGroundHeight(int _groundHeight) /// @ingroup UTILITY_API /// @brief Set ground height value /// @param _groundHeight : ground height in y-axis (Default: 0.0) .. tabs:: .. code-tab:: python def SetSimulationSelfCollisionAvoidanceStiffness(_avoidanceStiffness : float) -> None """ @ingroup UTILITY_API @brief Set stiffness of the inserted spring to avoid self collision @param _avoidanceStiffness : (Default: 0.001) """ .. code-tab:: c++ SetSimulationSelfCollisionAvoidanceStiffness(int _avoidanceStiffness) /// @ingroup UTILITY_API /// @brief Set stiffness of the inserted spring to avoid self collision /// @param _avoidanceStiffness : (Default: 0.001) .. tabs:: .. code-tab:: python def SetSimulationLayerBasedCollisionDetection(_bUseLayer : bool) -> None """ @ingroup UTILITY_API @brief Set layer based collision detection @param _bUseLayer : true for enable, false for disable """ .. code-tab:: c++ SetSimulationLayerBasedCollisionDetection(int _bUseLayer) /// @ingroup UTILITY_API /// @brief Set layer based collision detection /// @param _bUseLayer : true for enable, false for disable .. tabs:: .. code-tab:: python def StartNesting() -> None """ @ingroup UTILITY_API @brief Start Nesting Simulation """ .. code-tab:: c++ StartNesting() /// @ingroup UTILITY_API /// @brief Start Nesting Simulation .. tabs:: .. code-tab:: python def SetNestingBufferSpacing(_mm : float) -> None """ @ingroup UTILITY_API @brief Set all nesting buffer spacings (fabric and pattern) to the same value @param _mm : Buffer spacing in mm applied uniformly to all axes """ .. code-tab:: c++ SetNestingBufferSpacing(float _mm) /// @ingroup UTILITY_API /// @brief Set all nesting buffer spacings (fabric and pattern) to the same value /// @param _mm : Buffer spacing in mm applied uniformly to all axes .. tabs:: .. code-tab:: python def GetNestingFabricBufferSpacing() -> std::array[float, 4] """ @ingroup UTILITY_API @brief Get fabric buffer spacing as {left, right, top, bottom} in mm. """ .. code-tab:: c++ GetNestingFabricBufferSpacing() /// @ingroup UTILITY_API /// @brief Get fabric buffer spacing as {left, right, top, bottom} in mm. .. tabs:: .. code-tab:: python def SetNestingFabricBufferSpacing(_mmLeft : float, _mmRight : float, _mmTop : float, _mmBottom : float) -> None """ @ingroup UTILITY_API @brief Set fabric buffer spacing per side in mm @param _mmLeft : Left margin (Selvedge Side A) @param _mmRight : Right margin (Selvedge Side B) @param _mmTop : Top margin (Cut-Line Start) @param _mmBottom : Bottom margin (Cut-Line End) """ .. code-tab:: c++ SetNestingFabricBufferSpacing(float, float, float, float) /// @ingroup UTILITY_API /// @brief Set fabric buffer spacing per side in mm /// @param _mmLeft : Left margin (Selvedge Side A) /// @param _mmRight : Right margin (Selvedge Side B) /// @param _mmTop : Top margin (Cut-Line Start) /// @param _mmBottom : Bottom margin (Cut-Line End) .. tabs:: .. code-tab:: python def GetNestingPatternBufferSpacing() -> std::array[float, 4] """ @ingroup UTILITY_API @brief Get pattern buffer spacing as {left, right, top, bottom} in mm. """ .. code-tab:: c++ GetNestingPatternBufferSpacing() /// @ingroup UTILITY_API /// @brief Get pattern buffer spacing as {left, right, top, bottom} in mm. .. tabs:: .. code-tab:: python def SetNestingPatternBufferSpacing(_mmLeft : float, _mmRight : float, _mmTop : float, _mmBottom : float) -> None """ @ingroup UTILITY_API @brief Set pattern buffer spacing per side in mm @param _mmLeft : Left buffer @param _mmRight : Right buffer @param _mmTop : Top buffer @param _mmBottom : Bottom buffer """ .. code-tab:: c++ SetNestingPatternBufferSpacing(float, float, float, float) /// @ingroup UTILITY_API /// @brief Set pattern buffer spacing per side in mm /// @param _mmLeft : Left buffer /// @param _mmRight : Right buffer /// @param _mmTop : Top buffer /// @param _mmBottom : Bottom buffer .. tabs:: .. code-tab:: python def SetNestingTargetColorway(_colorwayList : list[int]) -> None """ @ingroup UTILITY_API @brief Colorway index to apply nesting result @param _colorwayList : Colorway index to apply nesting result """ .. code-tab:: c++ SetNestingTargetColorway(std::vector _colorwayList) /// @ingroup UTILITY_API /// @brief Colorway index to apply nesting result /// @param _colorwayList : Colorway index to apply nesting result .. tabs:: .. code-tab:: python def GetNestingTargetColorway() -> list[int] """ @ingroup UTILITY_API @brief Gets the colorway index to apply nesting to. """ .. code-tab:: c++ GetNestingTargetColorway() /// @ingroup UTILITY_API /// @brief Gets the colorway index to apply nesting to. .. tabs:: .. code-tab:: python def SetAvatarMeshTexture(_matShapeName : str, _matMeshIndex : int, _textureImagePath : str) -> bool """ @ingroup UTILITY_API @brief Import AvatarTexture Body Part(face, body, arm, leg) @param _matShapeName: input avatar shape name(find object browser) @param _matMeshIndex: mat mesh index (0: face, 1:body, 2:arm, 3:leg) @param _textureImagePath: change texture full path @return if it succeeds, return true. """ .. code-tab:: c++ SetAvatarMeshTexture(const wstring& _matShapeName, int _matMeshIndex, const wstring& _textureImagePath) /// @ingroup UTILITY_API /// @brief Import AvatarTexture Body Part(face, body, arm, leg) /// @param _matShapeName: input avatar shape name(find object browser) /// @param _matMeshIndex: mat mesh index (0: face, 1:body, 2:arm, 3:leg) /// @param _textureImagePath: change texture full path /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetAnimationRecording(_bStart : bool) -> None """ @ingroup UTILITY_API @brief set animation recording @param _bStart: true for recording start, false for recording stop """ .. code-tab:: c++ SetAnimationRecording(bool _bStart) /// @ingroup UTILITY_API /// @brief set animation recording /// @param _bStart: true for recording start, false for recording stop .. tabs:: .. code-tab:: python def SetCurrentAnimationFrame(_frame : double) -> None """ @ingroup UTILITY_API @brief set current animation frame @param _frame: Value for setting current frame """ .. code-tab:: c++ SetCurrentAnimationFrame(double _frame) /// @ingroup UTILITY_API /// @brief set current animation frame /// @param _frame: Value for setting current frame .. tabs:: .. code-tab:: python def GetCurrentAnimationFrame() -> double """ @ingroup UTILITY_API @brief get current animation frame """ .. code-tab:: c++ GetCurrentAnimationFrame() /// @ingroup UTILITY_API /// @brief get current animation frame .. tabs:: .. code-tab:: python def SetStartAnimationFrame(_frame : double) -> None """ @ingroup UTILITY_API @brief set start animation frame @param _frame: Value for setting start frame """ .. code-tab:: c++ SetStartAnimationFrame(double _frame) /// @ingroup UTILITY_API /// @brief set start animation frame /// @param _frame: Value for setting start frame .. tabs:: .. code-tab:: python def GetStartAnimationFrame() -> double """ @ingroup UTILITY_API @brief get start animation frame """ .. code-tab:: c++ GetStartAnimationFrame() /// @ingroup UTILITY_API /// @brief get start animation frame .. tabs:: .. code-tab:: python def SetEndAnimationFrame(_frame : double) -> None """ @ingroup UTILITY_API @brief set end animation frame @param _frame: Value for setting end frame """ .. code-tab:: c++ SetEndAnimationFrame(double _frame) /// @ingroup UTILITY_API /// @brief set end animation frame /// @param _frame: Value for setting end frame .. tabs:: .. code-tab:: python def GetEndAnimationFrame() -> double """ @ingroup UTILITY_API @brief get end animation frame """ .. code-tab:: c++ GetEndAnimationFrame() /// @ingroup UTILITY_API /// @brief get end animation frame .. tabs:: .. code-tab:: python def GetTotalEndAnimationFrame() -> double """ @ingroup UTILITY_API @brief Returns the last frame from the animation list. @return end animation frame value type Double. Returns -FLT_MAX if the value is invalid. """ .. code-tab:: c++ GetTotalEndAnimationFrame() /// @ingroup UTILITY_API /// @brief Returns the last frame from the animation list. /// @return end animation frame value type Double. Returns -FLT_MAX if the value is invalid. .. tabs:: .. code-tab:: python def GetAnimationLayerFrameRange(_layerIndex : int) -> std::pair[double, double] """ @ingroup UTILITY_API @brief Returns the start and end frame values of the specified animation layer. @return A pair containing the start frame (first) and end frame (second) as double values. Returns -FLT_MAX if the value is invalid. """ .. code-tab:: c++ GetAnimationLayerFrameRange(int _layerIndex) /// @ingroup UTILITY_API /// @brief Returns the start and end frame values of the specified animation layer. /// @return A pair containing the start frame (first) and end frame (second) as double values. Returns -FLT_MAX if the value is invalid. .. tabs:: .. code-tab:: python def RunAnimationRecording(_startFrame : double, _endFrame : double) -> None """ @ingroup UTILITY_API @brief Start recording an animation within the specified frame range. @param _startFrame The starting frame of the recording. @param _endFrame The ending frame of the recording. """ .. code-tab:: c++ RunAnimationRecording() /// @ingroup UTILITY_API /// @brief Start recording an animation within the specified frame range. /// @param _startFrame The starting frame of the recording. /// @param _endFrame The ending frame of the recording. .. tabs:: .. code-tab:: python def MoveAnimationFrame(_frame : double) -> None """ @ingroup UTILITY_API @brief Move the animation to a specific frame. @param _frame The target frame to move the animation to. """ .. code-tab:: c++ MoveAnimationFrame() /// @ingroup UTILITY_API /// @brief Move the animation to a specific frame. /// @param _frame The target frame to move the animation to. .. tabs:: .. code-tab:: python def CopyFromFirstClothCache() -> None """ @ingroup UTILITY_API @brief Copy the first cloth cache to current frame """ .. code-tab:: c++ CopyFromFirstClothCache() /// @ingroup UTILITY_API /// @brief Copy the first cloth cache to current frame .. tabs:: .. code-tab:: python def GetStressMapStatus() -> bool """ @ingroup UTILITY_API @brief return current rendered status of the stress map (false = Off | true = On) """ .. code-tab:: c++ GetStressMapStatus() /// @ingroup UTILITY_API /// @brief return current rendered status of the stress map (false = Off | true = On) .. tabs:: .. code-tab:: python def SetStressMapStatus(_bOn : bool) -> None """ @ingroup UTILITY_API @brief set the rendered status of stress map @param _bOn: false = Off | true = On """ .. code-tab:: c++ SetStressMapStatus(bool _bOn) /// @ingroup UTILITY_API /// @brief set the rendered status of stress map /// @param _bOn: false = Off | true = On .. tabs:: .. code-tab:: python def GetStrainMapStatus() -> bool """ @ingroup UTILITY_API @brief return current rendered status of the strain map (false = Off | true = On) """ .. code-tab:: c++ GetStrainMapStatus() /// @ingroup UTILITY_API /// @brief return current rendered status of the strain map (false = Off | true = On) .. tabs:: .. code-tab:: python def SetStrainMapStatus(_bOn : bool) -> None """ @ingroup UTILITY_API @brief set the rendered status of strain map @param _bOn: false = Off | true = On """ .. code-tab:: c++ SetStrainMapStatus(bool _bOn) /// @ingroup UTILITY_API /// @brief set the rendered status of strain map /// @param _bOn: false = Off | true = On .. tabs:: .. code-tab:: python def GetSchematicRender() -> bool """ @ingroup UTILITY_API @brief Get Show Schematic Render Status """ .. code-tab:: c++ GetSchematicRender(bool _bSet) /// @ingroup UTILITY_API /// @brief Get Show Schematic Render Status .. tabs:: .. code-tab:: python def RefreshPlugIns() -> None """ @ingroup UTILITY_API @brief Refresh all PlugIns """ .. code-tab:: c++ RefreshPlugIns() /// @ingroup UTILITY_API /// @brief Refresh all PlugIns .. tabs:: .. code-tab:: python def RegisterPythonScript(pythonScriptPath : str, menuPath : str) -> bool """ @ingroup UTILITY_API @brief Register one Python script under the target menu path. """ .. code-tab:: c++ RegisterPythonScript(const std::string& pythonScriptPath, const std::string& menuPath) /// @ingroup UTILITY_API /// @brief Register one Python script under the target menu path. .. tabs:: .. code-tab:: python def RegisterPythonScriptW(pythonScriptPath : str, menuPath : str) -> bool """ @ingroup UTILITY_API @brief Register one Python script under the target menu path. """ .. code-tab:: c++ RegisterPythonScriptW(const std::wstring& pythonScriptPath, const std::wstring& menuPath) /// @ingroup UTILITY_API /// @brief Register one Python script under the target menu path. .. tabs:: .. code-tab:: python def RegisterPythonScriptFolder(folderPath : str, menuPath : str) -> bool """ @ingroup UTILITY_API @brief Register all direct child Python scripts under a folder-named submenu in the target menu path. """ .. code-tab:: c++ RegisterPythonScriptFolder(const std::string& folderPath, const std::string& menuPath) /// @ingroup UTILITY_API /// @brief Register all direct child Python scripts under a folder-named submenu in the target menu path. .. tabs:: .. code-tab:: python def RegisterPythonScriptFolderW(folderPath : str, menuPath : str) -> bool """ @ingroup UTILITY_API @brief Register all direct child Python scripts under a folder-named submenu in the target menu path. """ .. code-tab:: c++ RegisterPythonScriptFolderW(const std::wstring& folderPath, const std::wstring& menuPath) /// @ingroup UTILITY_API /// @brief Register all direct child Python scripts under a folder-named submenu in the target menu path. .. tabs:: .. code-tab:: python def SetCamViewPoint(_viewPointIndex : int) -> None """ @ingroup UTILITY_API @brief set camera view point @param _viewPointIndex: Value for setting camera view point index(0: bottom, 1:3/4 right, 2:front, 3:3/4 left, 4: right, 5:top, 6:left, 7:focus zoom, 8:back, 9:zoom extents all) """ .. code-tab:: c++ SetCamViewPoint(int _viewPointIndex) /// @ingroup UTILITY_API /// @brief set camera view point /// @param _viewPointIndex: Value for setting camera view point index(0: bottom, 1:3/4 right, 2:front, 3:3/4 left, 4: right, 5:top, 6:left, 7:focus zoom, 8:back, 9:zoom extents all) .. tabs:: .. code-tab:: python def StopNesting() -> None """ @ingroup UTILITY_API @brief Stop Nesting process """ .. code-tab:: c++ StopNesting() /// @ingroup UTILITY_API /// @brief Stop Nesting process .. tabs:: .. code-tab:: python def CreateModularCategory(_title : str, _folderPath : str) -> None """ @ingroup UTILITY_API @brief create modular category @param _title : category title, @param _folderPath: groupFolderPath """ .. code-tab:: c++ CreateModularCategory(const std::wstring& _title, const std::wstring& _folderPath) /// @ingroup UTILITY_API /// @brief create modular category /// @param _title : category title, /// @param _folderPath: groupFolderPath .. tabs:: .. code-tab:: python def DeleteModularCategory(_categoryPath : str) -> None """ @ingroup UTILITY_API @brief delete modular category @param _categoryPath : category title """ .. code-tab:: c++ DeleteModularCategory(const std::wstring& _categoryPath) /// @ingroup UTILITY_API /// @brief delete modular category /// @param _categoryPath : category title .. tabs:: .. code-tab:: python def AddLineToCategory(_lineName : str, _lineThumbnailPath : str, _categoryPath : str) -> bool """ @ingroup UTILITY_API @brief This function creates a line that includes all existing styles if there are no lines in the current category. If there is a line, it adds the line to the category. @param _lineName : The name of the line to be added @param _lineThumbnailPath : The path of the thumbnail image to be used for the style @param _categoryPath : The path where the category to be added is located """ .. code-tab:: c++ AddLineToCategory(const std::wstring& _lineName, const std::wstring& _lineThumbnailPath, const std::wstring& _categoryPath) /// @ingroup UTILITY_API /// @brief This function creates a line that includes all existing styles if there are no lines in the current category. If there is a line, it adds the line to the category. /// @param _lineName : The name of the line to be added /// @param _lineThumbnailPath : The path of the thumbnail image to be used for the style /// @param _categoryPath : The path where the category to be added is located .. tabs:: .. code-tab:: python def AddStyleToCategory(_styleName : str, _styleThumbnailPath : str, _categoryPath : str, _lineName : str) -> bool """ @ingroup UTILITY_API @brief Add Style to category @param _styleName : The name of the style to be added @param _styleThumbnailPath : The path of the thumbnail image to be used for the style @param _categoryPath : The path where the category to be added is located @param _lineName : Has a default value of 'None'. Only provide a value if a line exists in the category you are adding """ .. code-tab:: c++ AddStyleToCategory(const std::wstring& _styleName, const std::wstring& _styleThumbnailPath, const std::wstring& _categoryPath, const std::wstring& _lineName = L"None") /// @ingroup UTILITY_API /// @brief Add Style to category /// @param _styleName : The name of the style to be added /// @param _styleThumbnailPath : The path of the thumbnail image to be used for the style /// @param _categoryPath : The path where the category to be added is located /// @param _lineName : Has a default value of 'None'. Only provide a value if a line exists in the category you are adding .. tabs:: .. code-tab:: python def AddBlockTypeToStyle(_blockName : str, _blockType : int, _styleName : str, _categoryPath : str, _lineName : str) -> bool """ @ingroup UTILITY_API @brief Add block type to style @param _blockName : The name of the block to be added @param _blockType : Specifies the block type. You must select the desired type from the list below. Block Type List: Front Body = 0 Back Body = 1 Full Body = 2 Sleeves = 3 Collar = 4 Raglan Front Body = 5 Raglan Back Body = 6 Raglan Full Body = 7 Raglan Sleeve = 8 Raglan Collar = 9 Hem = 10 Placket Front = 11 Cuff = 12 Front Skirt = 13 Skirt Back = 14 Full Skirt = 15 Front Pants = 16 Back Pants = 17 Left Pants = 18 Right Pants = 19 Front Left Pants = 20 Front Right Pants = 21 Back Left Pants = 22 Back Right Pants = 23 Full Pants = 24 Waistband = 25 Cuff Leg = 26 @param _styleName : The name of the style to which the block type will be added @param _categoryPath : Has a default value of 'None'. Only provide a value if a line exists in the category you are adding @param _lineName : Has a default value of 'None'. Only provide a value if a line exists in the category you are adding """ .. code-tab:: c++ AddBlockTypeToStyle(const std::wstring& _blockName, const unsigned int _blockType, const std::wstring& _styleName, const std::wstring& _categoryPath, const std::wstring& _lineName = L"None") /// @ingroup UTILITY_API /// @brief Add block type to style /// @param _blockName : The name of the block to be added /// @param _blockType : Specifies the block type. You must select the desired type from the list below. /// Block Type List: /// Front Body = 0 /// Back Body = 1 /// Full Body = 2 /// Sleeves = 3 /// Collar = 4 /// Raglan Front Body = 5 /// Raglan Back Body = 6 /// Raglan Full Body = 7 /// Raglan Sleeve = 8 /// Raglan Collar = 9 /// Hem = 10 /// Placket Front = 11 /// Cuff = 12 /// Front Skirt = 13 /// Skirt Back = 14 /// Full Skirt = 15 /// Front Pants = 16 /// Back Pants = 17 /// Left Pants = 18 /// Right Pants = 19 /// Front Left Pants = 20 /// Front Right Pants = 21 /// Back Left Pants = 22 /// Back Right Pants = 23 /// Full Pants = 24 /// Waistband = 25 /// Cuff Leg = 26 /// @param _styleName : The name of the style to which the block type will be added /// @param _categoryPath : Has a default value of 'None'. Only provide a value if a line exists in the category you are adding /// @param _lineName : Has a default value of 'None'. Only provide a value if a line exists in the category you are adding .. tabs:: .. code-tab:: python def GetNestingTime() -> int """ @ingroup UTILITY_API @brief Get Nesting duration Time (milliseconds) """ .. code-tab:: c++ GetNestingTime() /// @ingroup UTILITY_API /// @brief Get Nesting duration Time (milliseconds) .. tabs:: .. code-tab:: python def SetSchematicSilhouetteLineWidth(_value : int) -> None """ @ingroup UTILITY_API @brief set schematic silhouette line width @param _value: Value for setting schematic silhouette line width """ .. code-tab:: c++ SetSchematicSilhouetteLineWidth(int _value) /// @ingroup UTILITY_API /// @brief set schematic silhouette line width /// @param _value: Value for setting schematic silhouette line width .. tabs:: .. code-tab:: python def SetSchematicSeamLineWidth(_value : int) -> None """ @ingroup UTILITY_API @brief set schematic seamline width @param _value: Value for setting schematic seamline width """ .. code-tab:: c++ SetSchematicSeamLineWidth(int _value) /// @ingroup UTILITY_API /// @brief set schematic seamline width /// @param _value: Value for setting schematic seamline width .. tabs:: .. code-tab:: python def SetSchematicInternalLineWidth(_value : int) -> None """ @ingroup UTILITY_API @brief set schematic internal line width @param _value: Value for setting schematic internal line width """ .. code-tab:: c++ SetSchematicInternalLineWidth(int _value) /// @ingroup UTILITY_API /// @brief set schematic internal line width /// @param _value: Value for setting schematic internal line width .. tabs:: .. code-tab:: python def SetSchematicTopstitchLineScalePercent(_value : int) -> None """ @ingroup UTILITY_API @brief set schematic topstitch line scale percent @param _value: Value for setting schematic topstitch line scale percent """ .. code-tab:: c++ SetSchematicTopstitchLineScalePercent(int _value) /// @ingroup UTILITY_API /// @brief set schematic topstitch line scale percent /// @param _value: Value for setting schematic topstitch line scale percent .. tabs:: .. code-tab:: python def SetSchematicBrightness(_value : int) -> None """ @ingroup UTILITY_API @brief set schematic brightness @param _value: Value for setting schematic brightness """ .. code-tab:: c++ SetSchematicBrightness(int _value) /// @ingroup UTILITY_API /// @brief set schematic brightness /// @param _value: Value for setting schematic brightness .. tabs:: .. code-tab:: python def SetShowSchematicSilhouetteLine(_bOn : bool) -> None """ @ingroup UTILITY_API @brief set show schematic silhouetteline @param _bOn: Value for setting showschematic silhouetteline """ .. code-tab:: c++ SetShowSchematicSilhouetteLine(bool _bOn) /// @ingroup UTILITY_API /// @brief set show schematic silhouetteline /// @param _bOn: Value for setting showschematic silhouetteline .. tabs:: .. code-tab:: python def SetShowSchematicSeamLine(_bOn : bool) -> None """ @ingroup UTILITY_API @brief set show schematic seamline @param _bOn: Value for setting show schematic seamline """ .. code-tab:: c++ SetShowSchematicSeamLine(int _bOn) /// @ingroup UTILITY_API /// @brief set show schematic seamline /// @param _bOn: Value for setting show schematic seamline .. tabs:: .. code-tab:: python def SetShowSchematicInternalLine(_bOn : bool) -> None """ @ingroup UTILITY_API @brief set show schematic internal line @param _bOn: Value for setting show schematic internalline """ .. code-tab:: c++ SetShowSchematicInternalLine(bool _bOn) /// @ingroup UTILITY_API /// @brief set show schematic internal line /// @param _bOn: Value for setting show schematic internalline .. tabs:: .. code-tab:: python def SetShowSchematicTopstitchLine(_bOn : bool) -> None """ @ingroup UTILITY_API @brief set show schematic topstitch line @param _bOn: Value for setting show schematic topstitchline """ .. code-tab:: c++ SetShowSchematicTopstitchLine(bool _bOn) /// @ingroup UTILITY_API /// @brief set show schematic topstitch line /// @param _bOn: Value for setting show schematic topstitchline .. tabs:: .. code-tab:: python def SetSchematicClothRenderType(_bTexture : bool) -> None """ @ingroup UTILITY_API @brief set schematic cloth render type @param _bTexture: Value for setting schematic cloth render type """ .. code-tab:: c++ SetSchematicClothRenderType(bool _bTexture) /// @ingroup UTILITY_API /// @brief set schematic cloth render type /// @param _bTexture: Value for setting schematic cloth render type .. tabs:: .. code-tab:: python def SetStyleLineColor(_r : int, _g : int, _b : int) -> None """ @ingroup UTILITY_API @brief set style line color @param int _r, int _g, int _b: Value for setting style line color Red: 0 ~ 255 Green: 0 ~ 255 Blue: 0 ~ 255 """ .. code-tab:: c++ SetStyleLineColor(int _r, int _g, int _b) /// @ingroup UTILITY_API /// @brief set style line color /// @param int _r, int _g, int _b: Value for setting style line color /// Red: 0 ~ 255 /// Green: 0 ~ 255 /// Blue: 0 ~ 255 .. tabs:: .. code-tab:: python def SetSchematicClothColor(_r : int, _g : int, _b : int) -> None """ @ingroup UTILITY_API @brief set schematic cloth color @param int _r, int _g, int _b: Value for setting schematic cloth color Red: 0 ~ 255 Green: 0 ~ 255 Blue: 0 ~ 255 """ .. code-tab:: c++ SetSchematicClothColor(int _r, int _g, int _b) /// @ingroup UTILITY_API /// @brief set schematic cloth color /// @param int _r, int _g, int _b: Value for setting schematic cloth color /// Red: 0 ~ 255 /// Green: 0 ~ 255 /// Blue: 0 ~ 255 .. tabs:: .. code-tab:: python def SetQualityRender(_bSet : bool) -> None """ @ingroup UTILITY_API @brief Set Quality Render status @param _bSet: true for enable, false for disable """ .. code-tab:: c++ SetQualityRender(bool _bSet) /// @ingroup UTILITY_API /// @brief Set Quality Render status /// @param _bSet: true for enable, false for disable .. tabs:: .. code-tab:: python def GetQualityRenderStatus() -> bool """ @ingroup UTILITY_API @brief Get Current Quality Render Status """ .. code-tab:: c++ GetQualityRenderStatus(bool _bSet) /// @ingroup UTILITY_API /// @brief Get Current Quality Render Status .. tabs:: .. code-tab:: python def BakeUVTexture(_filePath : str, _options : ImportExportOption, _bAll : bool) -> list[str] """ @ingroup UTILITY_API @brief Bake textures on UV editor @param _filePath: File path to be saved. @param _options: It bakes textures according to options, not allowing user for selecting options in Bake Textures Dialog. @param _bAll: true for all UV tiles, false for only 0-1 tile @return Output file paths. """ .. code-tab:: c++ BakeUVTexture(const string& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup UTILITY_API /// @brief Bake textures on UV editor /// @param _filePath: File path to be saved. /// @param _options: It bakes textures according to options, not allowing user for selecting options in Bake Textures Dialog. /// @param _bAll: true for all UV tiles, false for only 0-1 tile /// @return Output file paths. .. tabs:: .. code-tab:: python def BakeUVTextureW(_filePath : str, _options : ImportExportOption, _bAll : bool) -> list[str] """ @ingroup UTILITY_API @brief Bake textures on UV editor @param _filePath: File path to be saved. @param _options: It bakes textures according to options, not allowing user for selecting options in Bake Textures Dialog. @param _bAll: true for all UV tiles, false for only 0-1 tile @return Output file paths. """ .. code-tab:: c++ BakeUVTextureW(const wstring& _filePath, const Marvelous::ImportExportOption& _options) /// @ingroup UTILITY_API /// @brief Bake textures on UV editor /// @param _filePath: File path to be saved. /// @param _options: It bakes textures according to options, not allowing user for selecting options in Bake Textures Dialog. /// @param _bAll: true for all UV tiles, false for only 0-1 tile /// @return Output file paths. .. tabs:: .. code-tab:: python def UVPacking(_bAll : bool, _bFixScaleRatio : bool, _bAdvancedSearch : bool, _padding : float, _fidelity : int, _roationAngleOptions : list[int]) -> bool """ @ingroup UTILITY_API @brief Packing patterns in UV editor @param _bAll: true for all patterns, false for selected patterns @param _bFixScaleRatio: true - preserve current patterns size; false - rescale patterns @param _bAdvancedSearch: true - use genetic algorithm to find improved solution @param _padding: related values for UV packing padding (0.001 = 1 padding value in the UV tile) @param _fidelity: (1-5) how simplified (internally) the patterns are for nesting (1=most simplified, 5=least simplified). @param _roationAngleOptions: rotation angle(degree) options for packing, default value is 0 degree ex) {0, 180} can rotate up side down @return If packing succeeds, return true. """ .. code-tab:: c++ UVPacking(bool _bAll, float _textureFillSeam, int _imgSize) /// @ingroup UTILITY_API /// @brief Packing patterns in UV editor /// @param _bAll: true for all patterns, false for selected patterns /// @param _bFixScaleRatio: true - preserve current patterns size; false - rescale patterns /// @param _bAdvancedSearch: true - use genetic algorithm to find improved solution /// @param _padding: related values for UV packing padding (0.001 = 1 padding value in the UV tile) /// @param _fidelity: (1-5) how simplified (internally) the patterns are for nesting (1=most simplified, 5=least simplified). /// @param _roationAngleOptions: rotation angle(degree) options for packing, default value is 0 degree ex) {0, 180} can rotate up side down /// @return If packing succeeds, return true. .. tabs:: .. code-tab:: python def ResetUVTo2DArrangement() -> None """ @ingroup UTILITY_API @brief Reset UV islands to the 2D arrangement. """ .. code-tab:: c++ ResetUVTo2DArrangement() /// @ingroup UTILITY_API /// @brief Reset UV islands to the 2D arrangement. .. tabs:: .. code-tab:: python def SetTrimWeight(_trimStyleIndex : int, _mass : float) -> None """ @ingroup UTILITY_API @brief Change weight of the trim style @param _trimStyleIndex: trimstyle index to change weight of trim style @param _mass: value to set weight of trim """ .. code-tab:: c++ SetTrimWeight(unsigned int _trimStyleIndex, float _mass) /// @ingroup UTILITY_API /// @brief Change weight of the trim style /// @param _trimStyleIndex: trimstyle index to change weight of trim style /// @param _mass: value to set weight of trim .. tabs:: .. code-tab:: python def Refresh3DWindow() -> None """ @ingroup UTILITY_API @brief Refresh 3D Garment Window """ .. code-tab:: c++ Refresh3DWindow() /// @ingroup UTILITY_API /// @brief Refresh 3D Garment Window .. tabs:: .. code-tab:: python def SetColorwayColorItem(_colorwayIndex : int, _colorItemIndex : int, _plmId : str, _colorName : str, _rgb : CloApiRgb) -> None """ @ingroup UTILITY_API @brief Changes the color of the color item in colorway @param _colorwayIndex: colorway index to change color of color item @param _colorItemIndex: color item index to change color of colorway @param _plmId: plm id of color @param _colorName: name of color @param _rgb: rgb value of color """ .. code-tab:: c++ SetColorwayColorItem(int _colorwayIndex, int _colorItemIndex, std::string _plmId, std::string _colorName, Marvelous::CloApiRgb _rgb) /// @ingroup UTILITY_API /// @brief Changes the color of the color item in colorway /// @param _colorwayIndex: colorway index to change color of color item /// @param _colorItemIndex: color item index to change color of colorway /// @param _plmId: plm id of color /// @param _colorName: name of color /// @param _rgb: rgb value of color .. tabs:: .. code-tab:: python def GetColorwayColorItemRGB(_colorwayIndex : int, _colorItemIndex : int) -> CloApiRgb """ @ingroup UTILITY_API @brief Get rgb color value of the color item in colorway @param _colorwayIndex: colorway index to get rgb color value of color item @param _colorItemIndex: color item index to get rgb color value color of colorway @return a rgb color value if the indices are valid, (0, 0, 0) otherwise. """ .. code-tab:: c++ GetColorwayColorItemRGB(int _colorwayIndex, int _colorItemIndex) /// @ingroup UTILITY_API /// @brief Get rgb color value of the color item in colorway /// @param _colorwayIndex: colorway index to get rgb color value of color item /// @param _colorItemIndex: color item index to get rgb color value color of colorway /// @return a rgb color value if the indices are valid, (0, 0, 0) otherwise. .. tabs:: .. code-tab:: python def GetColorwayColorItemPlmId(_colorwayIndex : int, _colorItemIndex : int) -> str """ @ingroup UTILITY_API @brief Get plm id of the color item in colorway @param _colorwayIndex: colorway index to get plm id of color item @param _colorItemIndex: color item index to get plm id of colorway @return a plm id if the indices are valid, empty string otherwise. """ .. code-tab:: c++ GetColorwayColorItemPlmId(int _colorwayIndex, int _colorItemIndex) /// @ingroup UTILITY_API /// @brief Get plm id of the color item in colorway /// @param _colorwayIndex: colorway index to get plm id of color item /// @param _colorItemIndex: color item index to get plm id of colorway /// @return a plm id if the indices are valid, empty string otherwise. .. tabs:: .. code-tab:: python def GetColorwayColorItemName(_colorwayIndex : int, _colorItemIndex : int) -> str """ @ingroup UTILITY_API @brief Get color name of the color item in colorway @param _colorwayIndex: colorway index to get color name of color item @param _colorItemIndex: color item index to get color name of colorway @return color name if the indices are valid, empty string otherwise. """ .. code-tab:: c++ GetColorwayColorItemName(int _colorwayIndex, int _colorItemIndex) /// @ingroup UTILITY_API /// @brief Get color name of the color item in colorway /// @param _colorwayIndex: colorway index to get color name of color item /// @param _colorItemIndex: color item index to get color name of colorway /// @return color name if the indices are valid, empty string otherwise. .. tabs:: .. code-tab:: python def RemovePlugInFromList(_pluginListIndex : int) -> None """ @ingroup UTILITY_API @brief Remove Plug In From PluginList @param _pluginListIndex: PluginList index to delete the plugin """ .. code-tab:: c++ RemovePlugInFromList(unsigned int _pluginListIndex) /// @ingroup UTILITY_API /// @brief Remove Plug In From PluginList /// @param _pluginListIndex: PluginList index to delete the plugin .. tabs:: .. code-tab:: python def AddPlugInFromFile(_filePath : str) -> None """ @ingroup UTILITY_API @brief Add Plug In From Filepath @param _filePath: File path to be added plugin. """ .. code-tab:: c++ AddPlugInFromFile(const std::string& _filePath) /// @ingroup UTILITY_API /// @brief Add Plug In From Filepath /// @param _filePath: File path to be added plugin. .. tabs:: .. code-tab:: python def UsePlugInFromList(_pluginListIndex : int) -> None """ @ingroup UTILITY_API @brief Use Plug In From PluginList @param _pluginListIndex: PluginList index to use the plugin """ .. code-tab:: c++ UsePlugInFromList(unsigned int _pluginListIndex) /// @ingroup UTILITY_API /// @brief Use Plug In From PluginList /// @param _pluginListIndex: PluginList index to use the plugin .. tabs:: .. code-tab:: python def TerminatePlugInFromList(_pluginListIndex : int) -> None """ @ingroup UTILITY_API @brief Terminate Plug In From PluginList @param _pluginListIndex: PluginList index to use the plugin """ .. code-tab:: c++ TerminatePlugInFromList(unsigned int _pluginListIndex) /// @ingroup UTILITY_API /// @brief Terminate Plug In From PluginList /// @param _pluginListIndex: PluginList index to use the plugin .. tabs:: .. code-tab:: python def Set3DGarmentRenderingStyle(_surfaceTextureTypeIndex : int) -> None """ @ingroup UTILITY_API @brief Sets garment surface rending style in the 3D window. @param _surfaceTextureTypeIndex : 0: textured surface, 1: thick textured surface, 2 : monochrome surface, 3 : translucent surface, 4 : mesh, 5 : thick textured surface (back), 6 : random color surface. Any other value defaults to 1. """ .. code-tab:: c++ Set3DGarmentRenderingStyle() /// @ingroup UTILITY_API /// @brief Sets garment surface rending style in the 3D window. /// @param _surfaceTextureTypeIndex : 0: textured surface, 1: thick textured surface, 2 : monochrome surface, /// 3 : translucent surface, 4 : mesh, 5 : thick textured surface (back), 6 : random color surface. Any other value defaults to 1. .. tabs:: .. code-tab:: python def Get3DGarmentRenderingStyle() -> int """ @ingroup UTILITY_API @brief Gets garment surface rending style currently used in the 3D window. return: _surfaceTextureTypeIndex : 0: textured surface, 1: thick textured surface, 2 : monochrome surface, 3 : translucent surface, 4 : mesh, 5 : thick textured surface (back), 6 : random color surface. Invalid response : -1. """ .. code-tab:: c++ Get3DGarmentRenderingStyle() /// @ingroup UTILITY_API /// @brief Gets garment surface rending style currently used in the 3D window. /// return: _surfaceTextureTypeIndex : 0: textured surface, 1: thick textured surface, 2 : monochrome surface, /// 3 : translucent surface, 4 : mesh, 5 : thick textured surface (back), 6 : random color surface. Invalid response : -1. .. tabs:: .. code-tab:: python def GetTotalGraphicItemQuantity() -> int """ @ingroup UTILITY_API @brief Returns the total quantity of all graphic items @return If valid, returns the total quantity; otherwise, -1. """ .. code-tab:: c++ GetTotalGraphicItemQuantity() /// @ingroup UTILITY_API /// @brief Returns the total quantity of all graphic items /// @return If valid, returns the total quantity; otherwise, -1. .. tabs:: .. code-tab:: python def GetGraphicStyleCount() -> int """ @ingroup UTILITY_API @brief Returns the number of graphic styles in the current colorway @return If valid, returns the number of graphic styles; otherwise, -1. """ .. code-tab:: c++ GetGraphicStyleCount() /// @ingroup UTILITY_API /// @brief Returns the number of graphic styles in the current colorway /// @return If valid, returns the number of graphic styles; otherwise, -1. .. tabs:: .. code-tab:: python def GetGraphicStylePosition(_graphicIndex : int, _is2D : bool) -> map[int, list[list[float]]] """ @ingroup UTILITY_API @brief Returns the position information of each graphic object. @param _graphicIndex: The index corresponding to the graphic style list. @param _is2D: If True, returns the value based on the 2D window; if False, returns the value based on the 3D window. @return The map’s key is the pattern index, and the value is a list of position information for the graphics assigned to that pattern. """ .. code-tab:: c++ GetGraphicStylePosition() /// @ingroup UTILITY_API /// @brief Returns the position information of each graphic object. /// @param _graphicIndex: The index corresponding to the graphic style list. /// @param _is2D: If True, returns the value based on the 2D window; if False, returns the value based on the 3D window. /// @return The map’s key is the pattern index, and the value is a list of position information for the graphics assigned to that pattern. .. tabs:: .. code-tab:: python def GetGraphicStylePosition(_graphicIndex : int, _colorwayIndex : int, _is2D : bool) -> map[int, list[list[float]]] """ @ingroup UTILITY_API @brief Returns the position information of each graphic object for the specified colorway. @param _graphicIndex: The index corresponding to the graphic style list of the target colorway. @param _colorwayIndex: The target colorway index. If out of range, the current colorway is used. @param _is2D: If True, returns the value based on the 2D window; if False, returns the value based on the 3D window. @return The map's key is the pattern index, and the value is a list of position information for the graphics assigned to that pattern. """ .. code-tab:: c++ GetGraphicStylePosition(int _graphicIndex, int _colorwayIndex, bool _is2D) /// @ingroup UTILITY_API /// @brief Returns the position information of each graphic object for the specified colorway. /// @param _graphicIndex: The index corresponding to the graphic style list of the target colorway. /// @param _colorwayIndex: The target colorway index. If out of range, the current colorway is used. /// @param _is2D: If True, returns the value based on the 2D window; if False, returns the value based on the 3D window. /// @return The map's key is the pattern index, and the value is a list of position information for the graphics assigned to that pattern. .. tabs:: .. code-tab:: python def GetGraphicStyleName(_index : int) -> str """ @ingroup UTILITY_API @brief Returns the name of the graphic style @param _index: Graphic style index to use the plugin @return If valid, returns the name; otherwise, an empty string. """ .. code-tab:: c++ GetGraphicStyleName(int _index) /// @ingroup UTILITY_API /// @brief Returns the name of the graphic style /// @param _index: Graphic style index to use the plugin /// @return If valid, returns the name; otherwise, an empty string. .. tabs:: .. code-tab:: python def SetGraphicStyleLocked(_graphicIndex : int, _bLocked : bool) -> None """ @ingroup UTILITY_API @brief Sets the lock state of the graphic style (style-level: affects size, map size/scale) @param _graphicIndex: Graphic style index in the current colorway's style list @param _bLocked: If true, locks the style; if false, unlocks it """ .. code-tab:: c++ SetGraphicStyleLocked(int _graphicIndex, bool _bLocked) /// @ingroup UTILITY_API /// @brief Sets the lock state of the graphic style (style-level: affects size, map size/scale) /// @param _graphicIndex: Graphic style index in the current colorway's style list /// @param _bLocked: If true, locks the style; if false, unlocks it .. tabs:: .. code-tab:: python def IsGraphicStyleLocked(_graphicIndex : int) -> bool """ @ingroup UTILITY_API @brief Returns whether the graphic style is locked (style-level) @param _graphicIndex: Graphic style index in the current colorway's style list @return true if the style is locked, false otherwise or if index is invalid """ .. code-tab:: c++ IsGraphicStyleLocked(int _graphicIndex) /// @ingroup UTILITY_API /// @brief Returns whether the graphic style is locked (style-level) /// @param _graphicIndex: Graphic style index in the current colorway's style list /// @return true if the style is locked, false otherwise or if index is invalid .. tabs:: .. code-tab:: python def SetGraphicInstanceLocked(_patternIndex : int, _graphicIndex : int, _bLocked : bool) -> None """ @ingroup UTILITY_API @brief Sets the lock state of the graphic instance placed on a specific pattern piece (instance-level: affects angle, position, Z-offset, configuration) @param _patternIndex: Pattern piece index in the PatternEditor's pattern list @param _graphicIndex: Graphic style index in the current colorway's style list @param _bLocked: If true, locks the instance; if false, unlocks it """ .. code-tab:: c++ SetGraphicInstanceLocked(int _patternIndex, int _graphicIndex, bool _bLocked) /// @ingroup UTILITY_API /// @brief Sets the lock state of the graphic instance placed on a specific pattern piece (instance-level: affects angle, position, Z-offset, configuration) /// @param _patternIndex: Pattern piece index in the PatternEditor's pattern list /// @param _graphicIndex: Graphic style index in the current colorway's style list /// @param _bLocked: If true, locks the instance; if false, unlocks it .. tabs:: .. code-tab:: python def IsGraphicInstanceLocked(_patternIndex : int, _graphicIndex : int) -> bool """ @ingroup UTILITY_API @brief Returns whether the graphic instance placed on a specific pattern piece is locked (instance-level) @param _patternIndex: Pattern piece index in the PatternEditor's pattern list @param _graphicIndex: Graphic style index in the current colorway's style list @return true if the instance is locked, false otherwise or if not found """ .. code-tab:: c++ IsGraphicInstanceLocked(int _patternIndex, int _graphicIndex) /// @ingroup UTILITY_API /// @brief Returns whether the graphic instance placed on a specific pattern piece is locked (instance-level) /// @param _patternIndex: Pattern piece index in the PatternEditor's pattern list /// @param _graphicIndex: Graphic style index in the current colorway's style list /// @return true if the instance is locked, false otherwise or if not found .. tabs:: .. code-tab:: python def GetGraphicStyleDimensions(_index : int) -> CloApiGraphicDimensions """ @ingroup UTILITY_API @brief Returns the dimensions of the graphic style @param _index: Graphic style index to use the plugin @return If valid, returns a Dimension object filled with the graphic's dimension information. """ .. code-tab:: c++ GetGraphicStyleDimensions(int _index) /// @ingroup UTILITY_API /// @brief Returns the dimensions of the graphic style /// @param _index: Graphic style index to use the plugin /// @return If valid, returns a Dimension object filled with the graphic's dimension information. .. tabs:: .. code-tab:: python def SetGraphicStyleName(_index : int, _name : str) -> None """ @ingroup UTILITY_API @brief Sets the name of the graphic style @param _index: Graphic style index to use the plugin @param _name: The name to be set for the graphic style """ .. code-tab:: c++ SetGraphicStyleName(int _index, std::string _name) /// @ingroup UTILITY_API /// @brief Sets the name of the graphic style /// @param _index: Graphic style index to use the plugin /// @param _name: The name to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicStyleDimensions(_index : int, _width : float, _height : float) -> None """ @ingroup UTILITY_API @brief Sets the dimensions of the graphic style @param _index: Graphic style index to use the plugin @param _width: The width to be set for the graphic style @param _height: The height to be set for the graphic style """ .. code-tab:: c++ SetGraphicStyleDimensions(int _index, float _width, float _height) /// @ingroup UTILITY_API /// @brief Sets the dimensions of the graphic style /// @param _index: Graphic style index to use the plugin /// @param _width: The width to be set for the graphic style /// @param _height: The height to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicStyleDimensions(_colorwayIndex : int, _index : int, _width : float, _height : float) -> None """ @ingroup UTILITY_API @brief Sets the dimensions of the graphic style for a specific colorway @param _colorwayIndex: Target colorway index @param _index: Graphic style index @param _width: The width to be set for the graphic style @param _height: The height to be set for the graphic style """ .. code-tab:: c++ SetGraphicStyleDimensions(int _colorwayIndex, int _index, float _width, float _height) /// @ingroup UTILITY_API /// @brief Sets the dimensions of the graphic style for a specific colorway /// @param _colorwayIndex: Target colorway index /// @param _index: Graphic style index /// @param _width: The width to be set for the graphic style /// @param _height: The height to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicStyleWidth(_index : int, _width : float, _bOnly : bool) -> None """ @ingroup UTILITY_API @brief Sets the width of the graphic style @param _index: Graphic style index to use the plugin @param _width: The width to be set for the graphic style @param _bOnly: If true, the ratio is ignored, if false, the height is set according to the ratio. """ .. code-tab:: c++ SetGraphicStyleWidth(int _index, float _width, bool _bOnly) /// @ingroup UTILITY_API /// @brief Sets the width of the graphic style /// @param _index: Graphic style index to use the plugin /// @param _width: The width to be set for the graphic style /// @param _bOnly: If true, the ratio is ignored, if false, the height is set according to the ratio. .. tabs:: .. code-tab:: python def SetGraphicStyleHeight(_index : int, _height : float, _bOnly : bool) -> None """ @ingroup UTILITY_API @brief Sets the height of the graphic style @param _index: Graphic style index to use the plugin @param _height: The height to be set for the graphic style @param _bOnly: If true, the ratio is ignored, if false, the height is set according to the ratio. """ .. code-tab:: c++ SetGraphicStyleHeight(int _index, float _height, bool _bOnly) /// @ingroup UTILITY_API /// @brief Sets the height of the graphic style /// @param _index: Graphic style index to use the plugin /// @param _height: The height to be set for the graphic style /// @param _bOnly: If true, the ratio is ignored, if false, the height is set according to the ratio. .. tabs:: .. code-tab:: python def GetGraphicStylePatternPieceIndices(_graphicIndex : int) -> list[int] """ @ingroup UTILITY_API @brief Returns the list of pattern piece indices that a graphic style is placed on @param _graphicIndex: The index corresponding to the graphic style list. @return A deduplicated vector of pattern piece indices. @note Use the returned indices as _patternIndex in the other OnPattern APIs (GetGraphicStyleDimensionsOnPattern, SetGraphicStylePositionOnPattern, etc.). """ .. code-tab:: c++ GetGraphicStylePatternPieceIndices(int _graphicIndex) /// @ingroup UTILITY_API /// @brief Returns the list of pattern piece indices that a graphic style is placed on /// @param _graphicIndex: The index corresponding to the graphic style list. /// @return A deduplicated vector of pattern piece indices. /// @note Use the returned indices as _patternIndex in the other OnPattern APIs (GetGraphicStyleDimensionsOnPattern, SetGraphicStylePositionOnPattern, etc.). .. tabs:: .. code-tab:: python def GetGraphicStylePatternPieceIndices(_colorwayIndex : int, _graphicIndex : int) -> list[int] """ @ingroup UTILITY_API @brief Returns the list of pattern piece indices that a graphic style is placed on for a specific colorway @param _colorwayIndex: Target colorway index @param _graphicIndex: The index corresponding to the graphic style list. @return A deduplicated vector of pattern piece indices. @note Use the returned indices as _patternIndex in the other OnPattern APIs (GetGraphicStyleDimensionsOnPattern, SetGraphicStylePositionOnPattern, etc.). """ .. code-tab:: c++ GetGraphicStylePatternPieceIndices(int _colorwayIndex, int _graphicIndex) /// @ingroup UTILITY_API /// @brief Returns the list of pattern piece indices that a graphic style is placed on for a specific colorway /// @param _colorwayIndex: Target colorway index /// @param _graphicIndex: The index corresponding to the graphic style list. /// @return A deduplicated vector of pattern piece indices. /// @note Use the returned indices as _patternIndex in the other OnPattern APIs (GetGraphicStyleDimensionsOnPattern, SetGraphicStylePositionOnPattern, etc.). .. tabs:: .. code-tab:: python def GetGraphicStyleDimensionsOnPattern(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int) -> CloApiGraphicDimensions """ @ingroup UTILITY_API @brief Returns the dimensions of a graphic placement on a specific pattern piece for a specific colorway @param _colorwayIndex: Target colorway index @param _graphicIndex: The index corresponding to the graphic style list. @param _patternIndex: The index of the pattern piece. @return If valid, returns a Dimension object filled with the graphic's dimension information. @note Width and height are measured from the graphic's center outward. Each pattern piece placement stores its own independent size. """ .. code-tab:: c++ GetGraphicStyleDimensionsOnPattern(int _colorwayIndex, int _graphicIndex, int _patternIndex) /// @ingroup UTILITY_API /// @brief Returns the dimensions of a graphic placement on a specific pattern piece for a specific colorway /// @param _colorwayIndex: Target colorway index /// @param _graphicIndex: The index corresponding to the graphic style list. /// @param _patternIndex: The index of the pattern piece. /// @return If valid, returns a Dimension object filled with the graphic's dimension information. /// @note Width and height are measured from the graphic's center outward. Each pattern piece placement stores its own independent size. .. tabs:: .. code-tab:: python def SetGraphicStylePositionOnPattern(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int, _x : float, _y : float) -> bool """ @ingroup UTILITY_API @brief Sets the 2D position of a graphic on a specific pattern piece for a specific colorway @param _colorwayIndex: Target colorway index @param _graphicIndex: The index corresponding to the graphic style list. @param _patternIndex: The index of the pattern piece. @param _x: The X coordinate of the graphic's center in 2D pattern-local space. @param _y: The Y coordinate of the graphic's center in 2D pattern-local space. @return true if the position was set successfully, false otherwise. @note (_x, _y) targets the graphic's center point, not its corner. """ .. code-tab:: c++ SetGraphicStylePositionOnPattern(int _colorwayIndex, int _graphicIndex, int _patternIndex, float _x, float _y) /// @ingroup UTILITY_API /// @brief Sets the 2D position of a graphic on a specific pattern piece for a specific colorway /// @param _colorwayIndex: Target colorway index /// @param _graphicIndex: The index corresponding to the graphic style list. /// @param _patternIndex: The index of the pattern piece. /// @param _x: The X coordinate of the graphic's center in 2D pattern-local space. /// @param _y: The Y coordinate of the graphic's center in 2D pattern-local space. /// @return true if the position was set successfully, false otherwise. /// @note (_x, _y) targets the graphic's center point, not its corner. .. tabs:: .. code-tab:: python def SetGraphicStyleDimensionsOnPattern(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int, _width : float, _height : float) -> bool """ @ingroup UTILITY_API @brief Sets the dimensions of a graphic on a specific pattern piece for a specific colorway @param _colorwayIndex: Target colorway index @param _graphicIndex: The index corresponding to the graphic style list. @param _patternIndex: The index of the pattern piece. @param _width: The width to be set for the graphic. Must be > 0 to take effect. @param _height: The height to be set for the graphic. Must be > 0 to take effect. @return true if the dimensions were set successfully, false otherwise. @note Resizes the graphic outward from its center. No aspect ratio lock is applied (width and height are set independently). @note Only affects this pattern piece placement for the given colorway. To resize all placements at once, use SetGraphicStyleDimensions instead. """ .. code-tab:: c++ SetGraphicStyleDimensionsOnPattern(int _colorwayIndex, int _graphicIndex, int _patternIndex, float _width, float _height) /// @ingroup UTILITY_API /// @brief Sets the dimensions of a graphic on a specific pattern piece for a specific colorway /// @param _colorwayIndex: Target colorway index /// @param _graphicIndex: The index corresponding to the graphic style list. /// @param _patternIndex: The index of the pattern piece. /// @param _width: The width to be set for the graphic. Must be > 0 to take effect. /// @param _height: The height to be set for the graphic. Must be > 0 to take effect. /// @return true if the dimensions were set successfully, false otherwise. /// @note Resizes the graphic outward from its center. No aspect ratio lock is applied (width and height are set independently). /// @note Only affects this pattern piece placement for the given colorway. To resize all placements at once, use SetGraphicStyleDimensions instead. .. tabs:: .. code-tab:: python def GetGraphicStylePlacementPoints(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int, _is2D : bool) -> CloApiGraphicPlacementPoints """ @ingroup UTILITY_API @brief Returns the center, corner, and edge center points of a graphic placement on a pattern piece for a specific colorway @param _colorwayIndex: Target colorway index @param _graphicIndex: The index corresponding to the graphic style list. @param _patternIndex: The index of the pattern piece. @param _is2D: If true, returns 2D pattern-local coordinates; if false, returns 3D world coordinates. @return A CloApiGraphicPlacementPoints struct containing center, corners, and edge center points. """ .. code-tab:: c++ GetGraphicStylePlacementPoints(int _colorwayIndex, int _graphicIndex, int _patternIndex, bool _is2D) /// @ingroup UTILITY_API /// @brief Returns the center, corner, and edge center points of a graphic placement on a pattern piece for a specific colorway /// @param _colorwayIndex: Target colorway index /// @param _graphicIndex: The index corresponding to the graphic style list. /// @param _patternIndex: The index of the pattern piece. /// @param _is2D: If true, returns 2D pattern-local coordinates; if false, returns 3D world coordinates. /// @return A CloApiGraphicPlacementPoints struct containing center, corners, and edge center points. .. tabs:: .. code-tab:: python def RepositionGraphicByAnchor(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int, _anchorPoint : CloApiAnchorPoint, _x : float, _y : float) -> bool """ @ingroup UTILITY_API @brief Repositions a graphic so the specified anchor point lands at (_x, _y) for a specific colorway. @param _colorwayIndex: Target colorway index. @param _graphicIndex: The index corresponding to the graphic style list. @param _patternIndex: The index of the pattern piece. @param _anchorPoint: Anchor point to pin (int value or CloApiAnchorPoint enum both accepted) -- see table below. @param _x: Target X coordinate for the anchor point in 2D pattern-local space. @param _y: Target Y coordinate for the anchor point in 2D pattern-local space. @return true if the position was updated successfully, false otherwise. @code Anchor layout (Y increases upward): 8---1---2 | | 7 0 3 | | 6---5---4 Value | Enum | Position ------+---------------------------+--------------------- 0 | CLOAPI_ANCHOR_CENTER | center 1 | CLOAPI_ANCHOR_UP | top edge midpoint 2 | CLOAPI_ANCHOR_RIGHT_UP | top-right corner 3 | CLOAPI_ANCHOR_RIGHT | right edge midpoint 4 | CLOAPI_ANCHOR_RIGHT_DOWN | bottom-right corner 5 | CLOAPI_ANCHOR_DOWN | bottom edge midpoint 6 | CLOAPI_ANCHOR_LEFT_DOWN | bottom-left corner 7 | CLOAPI_ANCHOR_LEFT | left edge midpoint 8 | CLOAPI_ANCHOR_LEFT_UP | top-left corner The graphic is translated so the chosen anchor point lands exactly at (_x, _y). Size and rotation are unchanged. Same convention as ReplaceGraphicStyleFromImage _anchor. @endcode """ .. code-tab:: c++ RepositionGraphicByAnchor(int _colorwayIndex, int _graphicIndex, int _patternIndex, CloApiAnchorPoint _anchorPoint, float _x, float _y) /// @ingroup UTILITY_API /// @brief Repositions a graphic so the specified anchor point lands at (_x, _y) for a specific colorway. /// @param _colorwayIndex: Target colorway index. /// @param _graphicIndex: The index corresponding to the graphic style list. /// @param _patternIndex: The index of the pattern piece. /// @param _anchorPoint: Anchor point to pin (int value or CloApiAnchorPoint enum both accepted) -- see table below. /// @param _x: Target X coordinate for the anchor point in 2D pattern-local space. /// @param _y: Target Y coordinate for the anchor point in 2D pattern-local space. /// @return true if the position was updated successfully, false otherwise. /// @code /// Anchor layout (Y increases upward): /// 8---1---2 /// | | /// 7 0 3 /// | | /// 6---5---4 /// Value | Enum | Position /// ------+---------------------------+--------------------- /// 0 | CLOAPI_ANCHOR_CENTER | center /// 1 | CLOAPI_ANCHOR_UP | top edge midpoint /// 2 | CLOAPI_ANCHOR_RIGHT_UP | top-right corner /// 3 | CLOAPI_ANCHOR_RIGHT | right edge midpoint /// 4 | CLOAPI_ANCHOR_RIGHT_DOWN | bottom-right corner /// 5 | CLOAPI_ANCHOR_DOWN | bottom edge midpoint /// 6 | CLOAPI_ANCHOR_LEFT_DOWN | bottom-left corner /// 7 | CLOAPI_ANCHOR_LEFT | left edge midpoint /// 8 | CLOAPI_ANCHOR_LEFT_UP | top-left corner /// The graphic is translated so the chosen anchor point lands /// exactly at (_x, _y). Size and rotation are unchanged. /// Same convention as ReplaceGraphicStyleFromImage _anchor. /// @endcode .. tabs:: .. code-tab:: python def UpdateCloStyleForPlugIn(_pWidget : QWidget*) -> None """ @ingroup UTILITY_API @brief Set CLO style-sheet code to QWidget. @param _pWidget: Root widget pointer of Plug-In Window. ex> QWidget, QDialog, QFrame, etc... """ .. code-tab:: c++ UpdateCloStyleForPlugIn(QWidget* _pWidget) /// @ingroup UTILITY_API /// @brief Set CLO style-sheet code to QWidget. /// @param _pWidget: Root widget pointer of Plug-In Window. /// ex> QWidget, QDialog, QFrame, etc... .. tabs:: .. code-tab:: python def UpdateCloStyleForPlugIn(_pWidget : QWidget*, _type : CloWidgetType) -> None """ @ingroup UTILITY_API @brief Set the style-sheet code corresponding to the CloWidgetType. @param _pWidget: Widget pointer to set style-sheet code @param _type: CloWidgetType of widget pointer ex> TitleBar, ComboBox, Slider, ScrollArea, Dialog, Frame, etc... """ .. code-tab:: c++ UpdateCloStyleForPlugIn(QWidget* _pWidget, Marvelous::CloWidgetType _type) /// @ingroup UTILITY_API /// @brief Set the style-sheet code corresponding to the CloWidgetType. /// @param _pWidget: Widget pointer to set style-sheet code /// @param _type: CloWidgetType of widget pointer /// ex> TitleBar, ComboBox, Slider, ScrollArea, Dialog, Frame, etc... .. tabs:: .. code-tab:: python def GetStyleSheetCodeForWidget(_type : CloWidgetType) -> str """ @ingroup UTILITY_API @brief Returns the style-sheet code for CloWidgetType @param _type: CloWidgetType of widget pointer @return Style-sheet code for CloWidgetType """ .. code-tab:: c++ GetStyleSheetCodeForWidget(Marvelous::CloWidgetType _type) /// @ingroup UTILITY_API /// @brief Returns the style-sheet code for CloWidgetType /// @param _type: CloWidgetType of widget pointer /// @return Style-sheet code for CloWidgetType .. tabs:: .. code-tab:: python def GetStyleSheetCodeForWidgetW(_type : CloWidgetType) -> str """ @ingroup UTILITY_API @brief Returns the style-sheet code for CloWidgetType @param _type: CloWidgetType of widget pointer @return Style-sheet code for CloWidgetType """ .. code-tab:: c++ GetStyleSheetCodeForWidgetW(Marvelous::CloWidgetType _type) /// @ingroup UTILITY_API /// @brief Returns the style-sheet code for CloWidgetType /// @param _type: CloWidgetType of widget pointer /// @return Style-sheet code for CloWidgetType .. tabs:: .. code-tab:: python def CurrentlyThemeInCLO() -> CloTheme """ @ingroup UTILITY_API @brief Returns the currently Theme information used in CLO @return currently Theme type """ .. code-tab:: c++ CurrentlyThemeInCLO() /// @ingroup UTILITY_API /// @brief Returns the currently Theme information used in CLO /// @return currently Theme type .. tabs:: .. code-tab:: python def SetCropBackground(_bToggle : bool) -> None """ @ingroup UTILITY_API @brief Set crop status. @param _bToggle: change crop background as _bToggle """ .. code-tab:: c++ SetCropStatus() /// @ingroup UTILITY_API /// @brief Set crop status. /// @param _bToggle: change crop background as _bToggle .. tabs:: .. code-tab:: python def SetBackgroundColorForExportRenderingImage(_r : float, _g : float, _b : float, _a : float) -> None """ @brief Set the background color used when exporting rendering images with the V-Ray renderer. This color will be applied as the rendering environment background, replacing any default scene background. It is useful for generating images with transparent backgrounds or consistent studio-like setups. @param _r Red component of the background color (range: 0.0 ~ 1.0). @param _g Green component of the background color (range: 0.0 ~ 1.0). @param _b Blue component of the background color (range: 0.0 ~ 1.0). @param _a Alpha component of the background color (range: 0.0 ~ 1.0). Set to 0.0 for fully transparent or 1.0 for fully opaque. """ .. code-tab:: c++ SetBackgroundColorForExportRenderingImage(_r, _g, _b, _a) /// @brief Set the background color used when exporting rendering images with the V-Ray renderer. /// This color will be applied as the rendering environment background, replacing any default /// scene background. It is useful for generating images with transparent backgrounds or /// consistent studio-like setups. /// @param _r Red component of the background color (range: 0.0 ~ 1.0). /// @param _g Green component of the background color (range: 0.0 ~ 1.0). /// @param _b Blue component of the background color (range: 0.0 ~ 1.0). /// @param _a Alpha component of the background color (range: 0.0 ~ 1.0). /// Set to 0.0 for fully transparent or 1.0 for fully opaque. .. tabs:: .. code-tab:: python def SetLightPresetForExportRenderingImage(_index : int) -> None """ @brief Set a light preset to be used when exporting rendering images with the V-Ray renderer. Light presets define preconfigured lighting environments (e.g., studio lights, daylight, HDRI setups) that affect the overall appearance of the rendered output. @param _index Index of the desired light preset, as retrieved from GetLightPresetForExportRenderingImage(). """ .. code-tab:: c++ SetLightPresetForExportRenderingImage(_index) /// @brief Set a light preset to be used when exporting rendering images with the V-Ray renderer. /// Light presets define preconfigured lighting environments (e.g., studio lights, /// daylight, HDRI setups) that affect the overall appearance of the rendered output. /// @param _index Index of the desired light preset, as retrieved from GetLightPresetForExportRenderingImage(). .. tabs:: .. code-tab:: python def GetLightPresetForExportRenderingImage() -> map[str, int] """ @brief Retrieve the list of available light presets for the V-Ray renderer. Each preset provides a predefined lighting setup that can be applied to the rendering scene. The returned map allows you to display preset options in a UI and use the corresponding index to apply a preset with SetLightPresetForExportRenderingImage(). @return A map containing pairs of preset name (key: std::string) and preset index (value: int). Example: { {"Studio Light", 0}, {"Daylight", 1}, {"HDRI Sky", 2} } """ .. code-tab:: c++ GetLightPresetForExportRenderingImage() /// @brief Retrieve the list of available light presets for the V-Ray renderer. /// Each preset provides a predefined lighting setup that can be applied to the rendering scene. /// The returned map allows you to display preset options in a UI and use the corresponding index /// to apply a preset with SetLightPresetForExportRenderingImage(). /// @return A map containing pairs of preset name (key: std::string) and preset index (value: int). /// Example: { {"Studio Light", 0}, {"Daylight", 1}, {"HDRI Sky", 2} } .. tabs:: .. code-tab:: python def SetTransparentBackgroundForExportRenderingImage(_bTransparent : bool) -> None """ @ingroup UTILITY_API @brief Enable the transparent background option in the V-Ray renderer. @param _bTransparent : If set to True, the transparent background option will be enabled. """ .. code-tab:: c++ SetTransparentBackgroundForExportRenderingImage() /// @ingroup UTILITY_API /// @brief Enable the transparent background option in the V-Ray renderer. /// @param _bTransparent : If set to True, the transparent background option will be enabled. .. tabs:: .. code-tab:: python def GetButtonHeadStyleListWithIndex() -> str """ @ingroup UTILITY_API @brief Gets the list of button head styles available in the Current project. @return Returns the list of button head styles with their corresponding indices. """ .. code-tab:: c++ GetButtonHeadStyleListWithIndex() /// @ingroup UTILITY_API /// @brief Gets the list of button head styles available in the Current project. /// @return Returns the list of button head styles with their corresponding indices. .. tabs:: .. code-tab:: python def GetTrimStyleListWithIndex() -> str """ @ingroup UTILITY_API @brief Gets the list of trim styles available in the current project's object browser. @return Returns a JSON-formatted string containing the list of trim styles with their corresponding indices and names. """ .. code-tab:: c++ GetTrimStyleListWithIndex() /// @ingroup UTILITY_API /// @brief Gets the list of trim styles available in the current project's object browser. /// @return Returns a JSON-formatted string containing the list of trim styles with their corresponding indices and names. .. tabs:: .. code-tab:: python def GetGraphicStyleListWithIndex() -> str """ @ingroup UTILITY_API @brief Gets the list of graphic files available in the current project's object browser. @return Returns a JSON-formatted string containing the list of graphic styles with their corresponding indices and names. """ .. code-tab:: c++ GetGraphicStyleListWithIndex() /// @ingroup UTILITY_API /// @brief Gets the list of graphic files available in the current project's object browser. /// @return Returns a JSON-formatted string containing the list of graphic styles with their corresponding indices and names. .. tabs:: .. code-tab:: python def OpenButtonHeadStyleFileByIndex(_filePath : str, _index : int) -> bool """ @ingroup UTILITY_API @brief Loads a button head style file based on the provided index. @param _filePath: The file path of the button head style file to be loaded, _Index: The index of the Designated button """ .. code-tab:: c++ OpenButtonHeadStyleFileByIndex(const std::string& _filePath, int _index) /// @ingroup UTILITY_API /// @brief Loads a button head style file based on the provided index. /// @param _filePath: The file path of the button head style file to be loaded, _Index: The index of the Designated button .. tabs:: .. code-tab:: python def OpenGraphicStyleFileByIndex(_filePath : str, _index : int) -> bool """ @ingroup UTILITY_API @brief Loads a graphic style file based on the provided index. @param _filePath: The file path of the graphic style file to be loaded, _Index: The index of the Designated graphic """ .. code-tab:: c++ OpenGraphicStyleFileByIndex(const std::string& _filePath, int _index) /// @ingroup UTILITY_API /// @brief Loads a graphic style file based on the provided index. /// @param _filePath: The file path of the graphic style file to be loaded, _Index: The index of the Designated graphic .. tabs:: .. code-tab:: python def OpenTrimStyleFileByIndex(_filePath : str, _index : int) -> bool """ @ingroup UTILITY_API @brief Loads a trim style file based on the provided index. @param _filePath: The file path of the trim style file to be loaded, _Index: The index of the Designated trim style """ .. code-tab:: c++ OpenTrimStyleFileByIndex(const std::string& _filePath, int _index) /// @ingroup UTILITY_API /// @brief Loads a trim style file based on the provided index. /// @param _filePath: The file path of the trim style file to be loaded, _Index: The index of the Designated trim style .. tabs:: .. code-tab:: python def AddGraphicStyleFromImageFile(_filePath : str, _index : int) -> bool """ @ingroup UTILITY_API @brief Converts an image file to a graphic style and inserts it into the graphic file list at the given index. @param _filePath: The file path of the image file (.png, .jpg, etc.). @param _index: The position in the graphic file list. Must be >= 0 and <= current graphic style count. @return true if the graphic style was added or replaced successfully, otherwise false. """ .. code-tab:: c++ AddGraphicStyleFromImageFile(const std::string& _filePath, int _index) /// @ingroup UTILITY_API /// @brief Converts an image file to a graphic style and inserts it into the graphic file list at the given index. /// @param _filePath: The file path of the image file (.png, .jpg, etc.). /// @param _index: The position in the graphic file list. Must be >= 0 and <= current graphic style count. /// @return true if the graphic style was added or replaced successfully, otherwise false. .. tabs:: .. code-tab:: python def SetRenderImageVideoProperties(_renderImageVideoOption : RenderImageVideoOptions) -> None """ @ingroup UTILITY_API @brief Sets render image/video property values. @param _renderImageVideoOption: render option values """ .. code-tab:: c++ SetRenderImageVideoProperties() /// @ingroup UTILITY_API /// @brief Sets render image/video property values. /// @param _renderImageVideoOption: render option values .. tabs:: .. code-tab:: python def GetRenderImageVideoProperties() -> str """ @ingroup UTILITY_API @brief Returns render image/video property values """ .. code-tab:: c++ GetRenderImageVideoProperties() /// @ingroup UTILITY_API /// @brief Returns render image/video property values .. tabs:: .. code-tab:: python def SetRenderingProperties(_renderPropertyOptions : RenderPropertyOptions) -> None """ @ingroup UTILITY_API @brief Sets rendering property values. @param _renderPropertyOptions: render property option values """ .. code-tab:: c++ SetRenderingProperties(Marvelous::RenderPropertyOptions& _renderPropertyOptions) /// @ingroup UTILITY_API /// @brief Sets rendering property values. /// @param _renderPropertyOptions: render property option values .. tabs:: .. code-tab:: python def GetRenderingProperties() -> str """ @ingroup UTILITY_API @brief Gets rendering property values @return If valid, returns a string containing rendering property values. """ .. code-tab:: c++ GetRenderingProperties() /// @ingroup UTILITY_API /// @brief Gets rendering property values /// @return If valid, returns a string containing rendering property values. .. tabs:: .. code-tab:: python def SetZoomView() -> None """ @ingroup UTILITY_API @brief Zoom cloth """ .. code-tab:: c++ SetZoomCloth() /// @ingroup UTILITY_API /// @brief Zoom cloth .. tabs:: .. code-tab:: python def SetViewPoint(_index : int) -> None """ @ingroup UTILITY_API @brief Set View Point in render property window @param _index: View Point index to set (0: Current View, 1: Custom View) """ .. code-tab:: c++ SetViewPoint() /// @ingroup UTILITY_API /// @brief Set View Point in render property window /// @param _index: View Point index to set (0: Current View, 1: Custom View) .. tabs:: .. code-tab:: python def GetViewPoint() -> int """ @ingroup UTILITY_API @brief Get current view point @return View Point index (0: Current View, 1: Custom View) @note If the view point is not set, it returns -1. """ .. code-tab:: c++ GetViewPoint() /// @ingroup UTILITY_API /// @brief Get current view point /// @return View Point index (0: Current View, 1: Custom View) /// @note If the view point is not set, it returns -1. .. tabs:: .. code-tab:: python def ReDrape3DArrangement(_options : ImportExportOption) -> None """ @ingroup UTILITY_API @brief Redrape all patterns 3D Arrangement """ .. code-tab:: c++ ReDrape3DArrangement() /// @ingroup UTILITY_API /// @brief Redrape all patterns 3D Arrangement .. tabs:: .. code-tab:: python def SetAPF(_path : str) -> None """ @ingroup UTILITY_API @brief Set APF file path @param _path: APF file path """ .. code-tab:: c++ SetAPF() /// @ingroup UTILITY_API /// @brief Set APF file path /// @param _path: APF file path .. tabs:: .. code-tab:: python def ABPNetworkAuth(id : str, pw : str, _APFpath : str) -> None """ @ingroup UTILITY_API @brief Regist Alvanon ID and Password @param id: Alvanon ID @param pw: Alvanon Password @param _APFpath : APF File path """ .. code-tab:: c++ ABPNetworkAuth() /// @ingroup UTILITY_API /// @brief Regist Alvanon ID and Password /// @param id: Alvanon ID /// @param pw: Alvanon Password /// @param _APFpath : APF File path .. tabs:: .. code-tab:: python def SetGraphicBaseColorMapTexture(_imageFilePath : str, _graphicStyleIndex : int) -> None """ @ingroup UTILITY_API @brief Sets the base color map texture for the graphic style @param _imageFilePath: The file path to be set for the graphic style @param _graphicStyleIndex: The graphic style index to change the base color map texture """ .. code-tab:: c++ SetGraphicBaseColorMapTexture(std::string _imageFilePath, int _graphicStyleIndex) /// @ingroup UTILITY_API /// @brief Sets the base color map texture for the graphic style /// @param _imageFilePath: The file path to be set for the graphic style /// @param _graphicStyleIndex: The graphic style index to change the base color map texture .. tabs:: .. code-tab:: python def SetGraphicBaseColorMapTexture(_imageFilePath : str, _graphicStyleIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Sets the base color map texture for the graphic style in the specified colorway @param _imageFilePath: The file path to be set for the graphic style @param _graphicStyleIndex: The graphic style index to change the base color map texture @param _colorwayIndex: The colorway index to change the base color map texture """ .. code-tab:: c++ SetGraphicBaseColorMapTexture(std::string _imageFilePath, int _graphicStyleIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Sets the base color map texture for the graphic style in the specified colorway /// @param _imageFilePath: The file path to be set for the graphic style /// @param _graphicStyleIndex: The graphic style index to change the base color map texture /// @param _colorwayIndex: The colorway index to change the base color map texture .. tabs:: .. code-tab:: python def SetGraphicNormalMapTexture(_imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style (default index = 0) @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicNormalMapTexture(std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style (default index = 0) /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicDisplacementMapTexture(_imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style (default index = 0) @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicDisplacementMapTexture(std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style (default index = 0) /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicOpacityMapTexture(_imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style (default index = 0) @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicOpacityMapTexture(std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style (default index = 0) /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicRoughnessMapTexture(_imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style (default index = 0) @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicRoughnessMapTexture(std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style (default index = 0) /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicMetalnessMapTexture(_imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style (default index = 0) @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicMetalnessMapTexture(std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style (default index = 0) /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetBaseTextureMapImageDesaturation(_fabricIndex : int, _colorwayIndex : int, _bSetOnOff : bool) -> None """ @ingroup UTILITY_API @brief Set desaturation on/off for base texture map image of fabric in colorway. @param _fabricIndex: the target fabric index in the Colorway Editor @param _colorwayIndex: target colorway index in the Colorway Editor @param _bSetOnOff: true to enable desaturation, false to disable """ .. code-tab:: c++ SetBaseTextureMapImageDesaturation(int _fabricIndex, int _colorwayIndex, bool _bSetOnOff) /// @ingroup UTILITY_API /// @brief Set desaturation on/off for base texture map image of fabric in colorway. /// @param _fabricIndex: the target fabric index in the Colorway Editor /// @param _colorwayIndex: target colorway index in the Colorway Editor /// @param _bSetOnOff: true to enable desaturation, false to disable .. tabs:: .. code-tab:: python def AutoGenerateGraphicNormalMap(_graphicIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Auto-generates the normal map from the current base color map of a graphic style. @param _graphicIndex: Graphic style index. @param _colorwayIndex: Colorway index. """ .. code-tab:: c++ AutoGenerateGraphicNormalMap(int _graphicIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Auto-generates the normal map from the current base color map of a graphic style. /// @param _graphicIndex: Graphic style index. /// @param _colorwayIndex: Colorway index. .. tabs:: .. code-tab:: python def DeleteGraphicNormalMap(_graphicIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Deletes the normal map of a graphic style. @param _graphicIndex: Graphic style index. @param _colorwayIndex: Colorway index. """ .. code-tab:: c++ DeleteGraphicNormalMap(int _graphicIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Deletes the normal map of a graphic style. /// @param _graphicIndex: Graphic style index. /// @param _colorwayIndex: Colorway index. .. tabs:: .. code-tab:: python def AutoGenerateGraphicOpacityMap(_graphicIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Auto-generates the opacity map from the current base color map of a graphic style. @param _graphicIndex: Graphic style index. @param _colorwayIndex: Colorway index. """ .. code-tab:: c++ AutoGenerateGraphicOpacityMap(int _graphicIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Auto-generates the opacity map from the current base color map of a graphic style. /// @param _graphicIndex: Graphic style index. /// @param _colorwayIndex: Colorway index. .. tabs:: .. code-tab:: python def DeleteGraphicOpacityMap(_graphicIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Deletes the opacity map of a graphic style. @param _graphicIndex: Graphic style index. @param _colorwayIndex: Colorway index. """ .. code-tab:: c++ DeleteGraphicOpacityMap(int _graphicIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Deletes the opacity map of a graphic style. /// @param _graphicIndex: Graphic style index. /// @param _colorwayIndex: Colorway index. .. tabs:: .. code-tab:: python def AutoGenerateGraphicRoughnessMap(_graphicIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Auto-generates the roughness map from the current base color map of a graphic style. @param _graphicIndex: Graphic style index. @param _colorwayIndex: Colorway index. """ .. code-tab:: c++ AutoGenerateGraphicRoughnessMap(int _graphicIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Auto-generates the roughness map from the current base color map of a graphic style. /// @param _graphicIndex: Graphic style index. /// @param _colorwayIndex: Colorway index. .. tabs:: .. code-tab:: python def DeleteGraphicRoughnessMap(_graphicIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Deletes the roughness map of a graphic style. @param _graphicIndex: Graphic style index. @param _colorwayIndex: Colorway index. """ .. code-tab:: c++ DeleteGraphicRoughnessMap(int _graphicIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Deletes the roughness map of a graphic style. /// @param _graphicIndex: Graphic style index. /// @param _colorwayIndex: Colorway index. .. tabs:: .. code-tab:: python def AutoGenerateGraphicDisplacementMap(_graphicIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Auto-generates the displacement map from the current base color map of a graphic style. @param _graphicIndex: Graphic style index. @param _colorwayIndex: Colorway index. """ .. code-tab:: c++ AutoGenerateGraphicDisplacementMap(int _graphicIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Auto-generates the displacement map from the current base color map of a graphic style. /// @param _graphicIndex: Graphic style index. /// @param _colorwayIndex: Colorway index. .. tabs:: .. code-tab:: python def DeleteGraphicDisplacementMap(_graphicIndex : int, _colorwayIndex : int) -> None """ @ingroup UTILITY_API @brief Deletes the displacement map of a graphic style. @param _graphicIndex: Graphic style index. @param _colorwayIndex: Colorway index. """ .. code-tab:: c++ DeleteGraphicDisplacementMap(int _graphicIndex, int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Deletes the displacement map of a graphic style. /// @param _graphicIndex: Graphic style index. /// @param _colorwayIndex: Colorway index. .. tabs:: .. code-tab:: python def SetGraphicNormalMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style @param _index: Graphic style index to use the plugin @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicNormalMapTexture(unsigned int _GraphicIndex, std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style /// @param _index: Graphic style index to use the plugin /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicDisplacementMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style @param _index: Graphic style index to use the plugin @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicDisplacementMapTexture(unsigned int _GraphicIndex, std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style /// @param _index: Graphic style index to use the plugin /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicOpacityMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style @param _GraphicIndex: Graphic style index to use the plugin @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicOpacityMapTexture(unsigned int _GraphicIndex, std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style /// @param _GraphicIndex: Graphic style index to use the plugin /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicRoughnessMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style @param _GraphicIndex: Graphic style index to use the plugin @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicRoughnessMapTexture(unsigned int _GraphicIndex, std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style /// @param _GraphicIndex: Graphic style index to use the plugin /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def SetGraphicMetalnessMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None """ @ingroup UTILITY_API @brief Sets the texture map for the graphic style @param _GraphicIndex: Graphic style index to use the plugin @param _imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ SetGraphicMetalnessMapTexture(unsigned int _GraphicIndex, std::string _imageFilePath) /// @ingroup UTILITY_API /// @brief Sets the texture map for the graphic style /// @param _GraphicIndex: Graphic style index to use the plugin /// @param _imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def GetGraphicNormalMapTexture() -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @return The file path of the graphic style """ .. code-tab:: c++ GetGraphicNormalMapTexture() /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @return The file path of the graphic style .. tabs:: .. code-tab:: python def GetGraphicDisplacementMapTexture() -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @return _imageFilePath: The file path of the graphic style """ .. code-tab:: c++ GetGraphicDisplacementMapTexture() /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @return _imageFilePath: The file path of the graphic style .. tabs:: .. code-tab:: python def GetGraphicOpacityMapTexture() -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @return _imageFilePath: The file path of the graphic style """ .. code-tab:: c++ GetGraphicOpacityMapTexture() /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @return _imageFilePath: The file path of the graphic style .. tabs:: .. code-tab:: python def GetGraphicRoughnessMapTexture() -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @return _imageFilePath: The file path of the graphic style """ .. code-tab:: c++ GetGraphicRoughnessMapTexture() /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @return _imageFilePath: The file path of the graphic style .. tabs:: .. code-tab:: python def GetGraphicMetalnessMapTexture() -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @return _imageFilePath: The file path of the graphic style """ .. code-tab:: c++ GetGraphicMetalnessMapTexture() /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @return _imageFilePath: The file path of the graphic style .. tabs:: .. code-tab:: python def GetGraphicNormalMapTexture(_GraphicIndex : int) -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @param _GraphicIndex: Graphic style index to use the plugin @return The file path to be set for the graphic style """ .. code-tab:: c++ GetGraphicNormalMapTexture(unsigned int _GraphicIndex) /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @param _GraphicIndex: Graphic style index to use the plugin /// @return The file path to be set for the graphic style .. tabs:: .. code-tab:: python def GetGraphicDisplacementMapTexture(_GraphicIndex : int) -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @param _GraphicIndex: Graphic style index to use the plugin @return imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ GetGraphicDisplacementMapTexture(unsigned int GraphicIndex) /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @param _GraphicIndex: Graphic style index to use the plugin /// @return imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def GetGraphicOpacityMapTexture(_GraphicIndex : int) -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @param _GraphicIndex: Graphic style index to use the plugin @return imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ GetGraphicOpacityMapTexture(unsigned int GraphicIndex) /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @param _GraphicIndex: Graphic style index to use the plugin /// @return imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def GetGraphicRoughnessMapTexture(_GraphicIndex : int) -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @param _GraphicIndex: Graphic style index to use the plugin @return imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ GetGraphicRoughnessMapTexture(unsigned int GraphicIndex) /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @param _GraphicIndex: Graphic style index to use the plugin /// @return imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def GetGraphicMetalnessMapTexture(_GraphicIndex : int) -> str """ @ingroup UTILITY_API @brief Gets the texture map for the graphic style @param _GraphicIndex: Graphic style index to use the plugin @return imageFilePath: The file path to be set for the graphic style """ .. code-tab:: c++ GetGraphicMetalnessMapTexture(unsigned int GraphicIndex) /// @ingroup UTILITY_API /// @brief Gets the texture map for the graphic style /// @param _GraphicIndex: Graphic style index to use the plugin /// @return imageFilePath: The file path to be set for the graphic style .. tabs:: .. code-tab:: python def GetGraphicStyleColor() -> tuple[float, float, float, float] """ @ingroup UTILITY_API @brief Get a base color of PBR material in a Graphic. (default index = 0) @return RGBA float tuple """ .. code-tab:: c++ GetGraphicStyleColor() /// @ingroup UTILITY_API /// @brief Get a base color of PBR material in a Graphic. (default index = 0) /// @return RGBA float tuple .. tabs:: .. code-tab:: python def SetGraphicStyleColor(_styleIndex : int, r : float, g : float, b : float, a : float) -> bool """ @ingroup UTILITY_API @brief Set a base color of PBR material in a Graphic using given RGBA values. (default index = 0) @param _styleIndex: Graphic style index @parm r : To be set as red value @parm g : To be set as green value @parm b : To be set as blue value @parm a : To be set as alpha value @return if it succeeds, return true. """ .. code-tab:: c++ SetGraphicStyleColor(float r, float g, float b, float a) /// @ingroup UTILITY_API /// @brief Set a base color of PBR material in a Graphic using given RGBA values. (default index = 0) /// @param _styleIndex: Graphic style index /// @parm r : To be set as red value /// @parm g : To be set as green value /// @parm b : To be set as blue value /// @parm a : To be set as alpha value /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetGraphicStyleColor(r : float, g : float, b : float, a : float) -> bool """ @ingroup UTILITY_API @brief Set a base color of PBR material in a Graphic using given RGBA values. (default index = 0) @parm r : To be set as red value @parm g : To be set as green value @parm b : To be set as blue value @parm a : To be set as alpha value @return if it succeeds, return true. """ .. code-tab:: c++ SetGraphicStyleColor(float r, float g, float b, float a) /// @ingroup UTILITY_API /// @brief Set a base color of PBR material in a Graphic using given RGBA values. (default index = 0) /// @parm r : To be set as red value /// @parm g : To be set as green value /// @parm b : To be set as blue value /// @parm a : To be set as alpha value /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetGraphicStyleColor(_styleIndex : int, _colorName : str) -> bool """ @ingroup UTILITY_API @brief Set a base color of PBR material in a Graphic using given color name values. (default index = 0) @param _styleIndex: Graphic style index @param _colorName: name of color @return if it succeeds, return true. """ .. code-tab:: c++ SetGraphicStyleColor(int _styleIndex, std::string _colorName) /// @ingroup UTILITY_API /// @brief Set a base color of PBR material in a Graphic using given color name values. (default index = 0) /// @param _styleIndex: Graphic style index /// @param _colorName: name of color /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def GetItemsCountsinColorway(_colorwayIndex : int) -> int """ @ingroup UTILITY_API @brief Get the color count in a target colorway. @parm colorwayIndex: the target colorway index @return if it succeeds, return the color count in a colorway. """ .. code-tab:: c++ GetItemsCountsinColorway(unsigned int _colorwayIndex) /// @ingroup UTILITY_API /// @brief Get the color count in a target colorway. /// @parm colorwayIndex: the target colorway index /// @return if it succeeds, return the color count in a colorway. .. tabs:: .. code-tab:: python def AutoHang(_garmentPath : str, _hangerPath : str, _hangerType : int, _hangerImportOption : ImportExportOption) -> bool """ @ingroup UTILITY_API @brief Auto-hang a garment to a hanger. @parm _garmentPath : path to a garment file. .zprj or .zpac is accepted. If .zprj is given, only the garment will be loaded. @parm _hangerPath : path to a hanger file. .obj or .avt is accepted. @parm _hangerType : type of the _hangerFIlePath hanger. 0 = top hanger, 1 = bottom hanger @parm _hangerImportOption : if .obj is given for _hangerFIlePath, specify the import option. Especially, specify the scale. For example, if the file is in cm, scale should be 10. @return if it succeeds, return true. """ .. code-tab:: c++ AutoHang(const std::string _garmentPath, const std::string _hangerPath, const unsigned int _hangerType, const Marvelous::ImportExportOption& _hangerImportOption) /// @ingroup UTILITY_API /// @brief Auto-hang a garment to a hanger. /// @parm _garmentPath : path to a garment file. .zprj or .zpac is accepted. If .zprj is given, only the garment will be loaded. /// @parm _hangerPath : path to a hanger file. .obj or .avt is accepted. /// @parm _hangerType : type of the _hangerFIlePath hanger. 0 = top hanger, 1 = bottom hanger /// @parm _hangerImportOption : if .obj is given for _hangerFIlePath, specify the import option. Especially, specify the scale. For example, if the file is in cm, scale should be 10. /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def AddPinsForFabricValidation(size1 : float, size2 : float, size3 : float, size4 : float) -> bool """ @ingroup UTILITY_API @brief Adjust lengths and adjust pin locations """ .. code-tab:: c++ AddPinsForFabricValidation(loat size1, float size2, float size3, float size4) /// @ingroup UTILITY_API /// @brief Adjust lengths and adjust pin locations .. tabs:: .. code-tab:: python def UpdatePropertyWindow() -> None """ @ingroup UTILITY_API @brief Update the PropertyWindow """ .. code-tab:: c++ UpdatePropertyWindow() /// @ingroup UTILITY_API /// @brief Update the PropertyWindow .. tabs:: .. code-tab:: python def FitAllUV(x_coordinate : int, y_coordinate : int, _bIsRelative : bool, _marginValue : float) -> None """ @ingroup UTILITY_API @brief Fitting patterns in UV editor to given coordinates @param x_coordinate: x coordinate value @param y_coordinate: y coordinate value @param _bIsRelative: true for relative, false for Absolute @param _marginValue: margin value """ .. code-tab:: c++ FitAllUV(int x_coordinate, int y_coordinate, bool _bIsRelative, float _marginValue) /// @ingroup UTILITY_API /// @brief Fitting patterns in UV editor to given coordinates /// @param x_coordinate: x coordinate value /// @param y_coordinate: y coordinate value /// @param _bIsRelative: true for relative, false for Absolute /// @param _marginValue: margin value .. tabs:: .. code-tab:: python def DeleteAvatar(_avatarIndexList : list[int]) -> bool """ @ingroup UTILITY_API @brief Delete Avatars @param _avatarIndexList: List of indices for avatars to delete """ .. code-tab:: c++ DeleteAvatar(std::vector _avatarIndexList) /// @ingroup UTILITY_API /// @brief Delete Avatars /// @param _avatarIndexList: List of indices for avatars to delete .. tabs:: .. code-tab:: python def GetGraphicStyleColor(_styleIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from Graphic Style @param _styleIndex: Graphic Style index on Object Browser to get Color @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetGraphicStyleColor(int _styleIndex) /// @brief Get base color of PBR material from Graphic Style /// @param _styleIndex: Graphic Style index on Object Browser to get Color /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def GetGraphicStyleColor(_styleIndex : int, _colorwayIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from Graphic Style @param _styleIndex: Graphic Style index on [_colorwayIndex]th Colorway to get Color _colorwayIndex: Colorway Index to get Style @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetGraphicStyleColor(int _styleIndex, int _colorwayIndex) /// @brief Get base color of PBR material from Graphic Style /// @param _styleIndex: Graphic Style index on [_colorwayIndex]th Colorway to get Color /// _colorwayIndex: Colorway Index to get Style /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def SetGraphicStyleColor(_styleIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a Graphic Style using given RGBA values @param _styleIndex: Graphic Style index on Object Browser to set Color @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetGraphicStyleColor(int _styleIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a Graphic Style using given RGBA values /// @param _styleIndex: Graphic Style index on Object Browser to set Color /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def SetGraphicStyleColor(_styleIndex : int, _colorwayIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a Graphic Style using given RGBA values @param _styleIndex: Graphic Style index on [_colorwayIndex]th Colorway to set Color @param _colorwayIndex: Colorway Index to get Style @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetGraphicStyleColor(int _styleIndex, int _colorwayIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a Graphic Style using given RGBA values /// @param _styleIndex: Graphic Style index on [_colorwayIndex]th Colorway to set Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def SetGraphicStyleColor(_styleIndex : int, _colorwayIndex : int, _colorName : str) -> bool """ @ingroup UTILITY_API @brief Set base color of PBR material in a Graphic Style using given color name @param _styleIndex: Graphic Style index on [_colorwayIndex]th Colorway to set Color @param _colorwayIndex: Colorway Index to get Style @param _colorName: Name of color from the color palette @return true if successful, false otherwise """ .. code-tab:: c++ SetGraphicStyleColor(int _styleIndex, int _colorwayIndex, const std::string& _colorName) /// @ingroup UTILITY_API /// @brief Set base color of PBR material in a Graphic Style using given color name /// @param _styleIndex: Graphic Style index on [_colorwayIndex]th Colorway to set Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _colorName: Name of color from the color palette /// @return true if successful, false otherwise .. tabs:: .. code-tab:: python def GetButtonHeadStyleColor(_styleIndex : int, _meshIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from ButtonHead Style @param _styleIndex: ButtonHead Style index on Object Browser to get Color @param _meshIndex: Mesh index to get Color 0: ButtonHead 1: Thread @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetButtonHeadStyleColor(int _styleIndex, int _meshIndex) /// @brief Get base color of PBR material from ButtonHead Style /// @param _styleIndex: ButtonHead Style index on Object Browser to get Color /// @param _meshIndex: Mesh index to get Color /// 0: ButtonHead /// 1: Thread /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def GetButtonHeadStyleColor(_styleIndex : int, _colorwayIndex : int, _meshIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from ButtonHead Style @param _styleIndex: ButtonHead Style index [_colorwayIndex]th Colorway to get Color @param _colorwayIndex: Colorway Index to get Style @param _meshIndex: Mesh index to get Color 0: ButtonHead 1: Thread @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetButtonHeadStyleColor(int _styleIndex, int _colorwayIndex, int _meshIndex) /// @brief Get base color of PBR material from ButtonHead Style /// @param _styleIndex: ButtonHead Style index [_colorwayIndex]th Colorway to get Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _meshIndex: Mesh index to get Color /// 0: ButtonHead /// 1: Thread /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def SetButtonHeadStyleColor(_styleIndex : int, _meshIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a ButtonHead Style using given RGBA values @param _styleIndex: ButtonHead Style index on Object Browser to set Color @param _meshIndex: Mesh index to get Color -1: All 0: ButtonHead 1: Thread @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetButtonHeadStyleColor(int _styleIndex, int _meshIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a ButtonHead Style using given RGBA values /// @param _styleIndex: ButtonHead Style index on Object Browser to set Color /// @param _meshIndex: Mesh index to get Color /// -1: All /// 0: ButtonHead /// 1: Thread /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def SetButtonHeadStyleColor(_styleIndex : int, _colorwayIndex : int, _meshIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a ButtonHead Style using given RGBA values @param _styleIndex: ButtonHead Style index [_colorwayIndex]th Colorway to set Color _colorwayIndex: Colorway Index to get Style @param _meshIndex: Mesh index to get Color -1: All 0: ButtonHead 1: Thread @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetButtonHeadStyleColor(int _styleIndex, int _colorwayIndex, int _meshIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a ButtonHead Style using given RGBA values /// @param _styleIndex: ButtonHead Style index [_colorwayIndex]th Colorway to set Color /// _colorwayIndex: Colorway Index to get Style /// @param _meshIndex: Mesh index to get Color /// -1: All /// 0: ButtonHead /// 1: Thread /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def GetButtonHoleStyleColor(_styleIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from ButtonHole Style @param _styleIndex: ButtonHole Style index on Object Browser to get Color @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetButtonHoleStyleColor(int _styleIndex) /// @brief Get base color of PBR material from ButtonHole Style /// @param _styleIndex: ButtonHole Style index on Object Browser to get Color /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def GetButtonHoleStyleColor(_styleIndex : int, _colorwayIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from ButtonHole Style @param _styleIndex: ButtonHole Style index [_colorwayIndex]th Colorway to get Color @param _colorwayIndex: Colorway Index to get Style @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetButtonHoleStyleColor(int _styleIndex, int _colorwayIndex) /// @brief Get base color of PBR material from ButtonHole Style /// @param _styleIndex: ButtonHole Style index [_colorwayIndex]th Colorway to get Color /// @param _colorwayIndex: Colorway Index to get Style /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def SetButtonHoleStyleColor(_styleIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a ButtonHole Style using given RGBA values @param _styleIndex: ButtonHole Style index on Object Browser to set Color @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetButtonHoleStyleColor(int _styleIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a ButtonHole Style using given RGBA values /// @param _styleIndex: ButtonHole Style index on Object Browser to set Color /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def SetButtonHoleStyleColor(_styleIndex : int, _colorwayIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a ButtonHole Style using given RGBA values @param _styleIndex: ButtonHole Style index [_colorwayIndex]th Colorway to set Color @param _colorwayIndex: Colorway Index to get Style @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetButtonHoleStyleColor(int _styleIndex, int _colorwayIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a ButtonHole Style using given RGBA values /// @param _styleIndex: ButtonHole Style index [_colorwayIndex]th Colorway to set Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def GetTrimStyleColor(_styleIndex : int, _meshIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from Trim Style @param _styleIndex: Trim Style index on Object Browser to get Color @param _meshIndex: Mesh index to get Color 0~: [_meshIndex]th mesh @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetTrimStyleColor(int _styleIndex, int _meshIndex) /// @brief Get base color of PBR material from Trim Style /// @param _styleIndex: Trim Style index on Object Browser to get Color /// @param _meshIndex: Mesh index to get Color /// 0~: [_meshIndex]th mesh /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def GetTrimStyleColor(_styleIndex : int, _colorwayIndex : int, _meshIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from Trim Style @param _styleIndex: Trim Style index [_colorwayIndex]th Colorway to get Color @param _colorwayIndex: Colorway Index to get Style @param _meshIndex: Mesh index to get Color 0~: [_meshIndex]th mesh @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetTrimStyleColor(int _styleIndex, int _colorwayIndex, int _meshIndex) /// @brief Get base color of PBR material from Trim Style /// @param _styleIndex: Trim Style index [_colorwayIndex]th Colorway to get Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _meshIndex: Mesh index to get Color /// 0~: [_meshIndex]th mesh /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def SetTrimStyleColor(_styleIndex : int, _meshIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a Trim Style using given RGBA values @param _styleIndex: Trim Style index on Object Browser to set Color @param _meshIndex: Mesh index to get Color -1: All 0~: [_meshIndex]th mesh @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetTrimStyleColor(int _styleIndex, int _meshIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a Trim Style using given RGBA values /// @param _styleIndex: Trim Style index on Object Browser to set Color /// @param _meshIndex: Mesh index to get Color /// -1: All /// 0~: [_meshIndex]th mesh /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def SetTrimStyleColor(_styleIndex : int, _meshIndex : int, _colorName : str) -> bool """ @brief Set base color of PBR material in a Trim Style using given Color name values @param _styleIndex: Trim Style index on Object Browser to set Color @param _meshIndex: Mesh index to get Color -1: All 0~: [_meshIndex]th mesh /// @param _colorName: Color name """ .. code-tab:: c++ SetTrimStyleColor(int _styleIndex, int _meshIndex, std::string _colorName) /// @brief Set base color of PBR material in a Trim Style using given Color name values /// @param _styleIndex: Trim Style index on Object Browser to set Color /// @param _meshIndex: Mesh index to get Color /// -1: All /// 0~: [_meshIndex]th mesh /// /// @param _colorName: Color name .. tabs:: .. code-tab:: python def SetTrimStyleColor(_styleIndex : int, _colorwayIndex : int, _meshIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a Trim Style using given RGBA values @param _styleIndex: Trim Style index [_colorwayIndex]th Colorway to set Color @param _colorwayIndex: Colorway Index to get Style @param _meshIndex: Mesh index to get Color -1: All 0~: [_meshIndex]th mesh @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetTrimStyleColor(int _styleIndex, int _colorwayIndex, int _meshIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a Trim Style using given RGBA values /// @param _styleIndex: Trim Style index [_colorwayIndex]th Colorway to set Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _meshIndex: Mesh index to get Color /// -1: All /// 0~: [_meshIndex]th mesh /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def SetTrimStyleColor(_styleIndex : int, _colorwayIndex : int, _meshIndex : int, _colorName : str) -> bool """ @ingroup UTILITY_API @brief Set base color of PBR material in a Trim Style using given color name @param _styleIndex: Trim Style index on [_colorwayIndex]th Colorway to set Color @param _colorwayIndex: Colorway Index to get Style @param _meshIndex: Mesh index to set color @param _colorName: Name of color from the color palette @return true if successful, false otherwise """ .. code-tab:: c++ SetTrimStyleColor(int _styleIndex, int _colorwayIndex, int _meshIndex, const std::string& _colorName) /// @ingroup UTILITY_API /// @brief Set base color of PBR material in a Trim Style using given color name /// @param _styleIndex: Trim Style index on [_colorwayIndex]th Colorway to set Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _meshIndex: Mesh index to set color /// @param _colorName: Name of color from the color palette /// @return true if successful, false otherwise .. tabs:: .. code-tab:: python def GetTopStitchOpacity(_styleIndex : int, _lineIndex : int) -> int """ @brief Get opacity of PBR material from TopStitch @param _styleIndex: TopStitch index on Object Browser @param _lineIndex: Stitch index to get opacity 0~: [_lineIndex]th Stitch @return Opacity value """ .. code-tab:: c++ GetTopStitchOpacity(int _styleIndex) /// @brief Get opacity of PBR material from TopStitch /// @param _styleIndex: TopStitch index on Object Browser /// @param _lineIndex: Stitch index to get opacity /// 0~: [_lineIndex]th Stitch /// @return Opacity value .. tabs:: .. code-tab:: python def GetTopStitchOpacity(_styleIndex : int, _colorwayIndex : int, _lineIndex : int) -> int """ @brief Get opacity of PBR material from TopStitch @param _styleIndex: TopStitch index [_colorwayIndex]th Colorway @param _colorwayIndex: Colorway Index to get Style @param _lineIndex: Stitch index to get opacity 0~: [_lineIndex]th Stitch @return Opacity value """ .. code-tab:: c++ GetTopStitchOpacity(int _styleIndex, int _colorwayIndex) /// @brief Get opacity of PBR material from TopStitch /// @param _styleIndex: TopStitch index [_colorwayIndex]th Colorway /// @param _colorwayIndex: Colorway Index to get Style /// @param _lineIndex: Stitch index to get opacity /// 0~: [_lineIndex]th Stitch /// @return Opacity value .. tabs:: .. code-tab:: python def SetTopStitchOpacity(_styleIndex : int, _lineIndex : int, _opacityValue : int) -> None """ @brief Set opacity of PBR material in a TopStitch @param _styleIndex: TopStitch index on Object Browser @param _lineIndex: Stitch index to set opacity 0~: [_lineIndex]th Stitch @param _opacityValue: opacity """ .. code-tab:: c++ SetTopStitchOpacity(int _styleIndex, int _opacityValue) /// @brief Set opacity of PBR material in a TopStitch /// @param _styleIndex: TopStitch index on Object Browser /// @param _lineIndex: Stitch index to set opacity /// 0~: [_lineIndex]th Stitch /// @param _opacityValue: opacity .. tabs:: .. code-tab:: python def SetTopStitchOpacity(_styleIndex : int, _colorwayIndex : int, _lineIndex : int, _opacityValue : int) -> None """ @brief Set opacity of PBR material in a TopStitch @param _styleIndex: TopStitch index [_colorwayIndex]th Colorway @param _colorwayIndex: Colorway Index to get Style @param _lineIndex: Stitch index to set opacity 0~: [_lineIndex]th Stitch @param _opacityValue: opacity """ .. code-tab:: c++ SetTopStitchOpacity(int _styleIndex, int _colorwayIndex, int _opacityValue) /// @brief Set opacity of PBR material in a TopStitch /// @param _styleIndex: TopStitch index [_colorwayIndex]th Colorway /// @param _colorwayIndex: Colorway Index to get Style /// @param _lineIndex: Stitch index to set opacity /// 0~: [_lineIndex]th Stitch /// @param _opacityValue: opacity .. tabs:: .. code-tab:: python def GetTopStitchColor(_styleIndex : int, _lineIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from TopStitch Style @param _styleIndex: TopStitch Style index on Object Browser to get Color @param _lineIndex: Stitch index to get Color 0~: [_lineIndex]th Stitch @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetTopStitchColor(int _styleIndex, int _lineIndex) /// @brief Get base color of PBR material from TopStitch Style /// @param _styleIndex: TopStitch Style index on Object Browser to get Color /// @param _lineIndex: Stitch index to get Color /// 0~: [_lineIndex]th Stitch /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def GetTopStitchColor(_styleIndex : int, _colorwayIndex : int, _lineIndex : int) -> CloApiRgba """ @brief Get base color of PBR material from TopStitch Style @param _styleIndex: TopStitch Style index [_colorwayIndex]th Colorway to get Color @param _colorwayIndex: Colorway Index to get Style @param _lineIndex: Stitch index to get Color 0~: [_lineIndex]th Stitch @return The color value in CloAgiRgba. """ .. code-tab:: c++ GetTopStitchColor(int _styleIndex, int _colorwayIndex, int _lineIndex) /// @brief Get base color of PBR material from TopStitch Style /// @param _styleIndex: TopStitch Style index [_colorwayIndex]th Colorway to get Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _lineIndex: Stitch index to get Color /// 0~: [_lineIndex]th Stitch /// @return The color value in CloAgiRgba. .. tabs:: .. code-tab:: python def SetTopStitchColor(_styleIndex : int, _lineIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a TopStitch Style using given RGBA values @param _styleIndex: TopStitch Style index on Object Browser to set Color @param _lineIndex: Stitch index to set Color -1: All 0~: [_lineIndex]th Stitch @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetTopStitchColor(int _styleIndex, int _lineIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a TopStitch Style using given RGBA values /// @param _styleIndex: TopStitch Style index on Object Browser to set Color /// @param _lineIndex: Stitch index to set Color /// -1: All /// 0~: [_lineIndex]th Stitch /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def SetTopStitchColor(_styleIndex : int, _lineIndex : int, _colorName : str) -> bool """ @brief Set base color of PBR material in a TopStitch Style using given Color name values @param _styleIndex: TopStitch Style index on Object Browser to set Color @param _lineIndex: Stitch index to set Color -1: All 0~: [_lineIndex]th Stitch /// /// @param _colorName: Color name """ .. code-tab:: c++ SetTopStitchColor(int _styleIndex, int _lineIndex, std::string _colorName) /// @brief Set base color of PBR material in a TopStitch Style using given Color name values /// @param _styleIndex: TopStitch Style index on Object Browser to set Color /// @param _lineIndex: Stitch index to set Color /// -1: All /// 0~: [_lineIndex]th Stitch /// /// /// @param _colorName: Color name .. tabs:: .. code-tab:: python def SetTopStitchColor(_styleIndex : int, _colorwayIndex : int, _lineIndex : int, _r : int, _g : int, _b : int, _a : int) -> None """ @brief Set base color of PBR material in a TopStitch Style using given RGBA values @param _styleIndex: TopStitch Style index [_colorwayIndex]th Colorway to set Color @param _colorwayIndex: Colorway Index to get Style @param _lineIndex: Stitch index to set Color -1: All 0~: [_lineIndex]th Stitch @param _r: Red channel @param _g: Green channel @param _b: Blue channel @param _a: Alpha channel """ .. code-tab:: c++ SetTopStitchColor(int _styleIndex, int _colorwayIndex, int _lineIndex, int _r, int _g, int _b, int _a) /// @brief Set base color of PBR material in a TopStitch Style using given RGBA values /// @param _styleIndex: TopStitch Style index [_colorwayIndex]th Colorway to set Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _lineIndex: Stitch index to set Color /// -1: All /// 0~: [_lineIndex]th Stitch /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel /// @param _a: Alpha channel .. tabs:: .. code-tab:: python def SetTopStitchColor(_styleIndex : int, _colorwayIndex : int, _lineIndex : int, _colorName : str) -> bool """ @ingroup UTILITY_API @brief Set base color of PBR material in a TopStitch Style using given color name @param _styleIndex: TopStitch Style index on [_colorwayIndex]th Colorway to set Color @param _colorwayIndex: Colorway Index to get Style @param _lineIndex: Stitch index to set Color (-1: All, 0~: [_lineIndex]th Stitch) @param _colorName: Name of color from the color palette @return true if successful, false otherwise """ .. code-tab:: c++ SetTopStitchColor(int _styleIndex, int _colorwayIndex, int _lineIndex, const std::string& _colorName) /// @ingroup UTILITY_API /// @brief Set base color of PBR material in a TopStitch Style using given color name /// @param _styleIndex: TopStitch Style index on [_colorwayIndex]th Colorway to set Color /// @param _colorwayIndex: Colorway Index to get Style /// @param _lineIndex: Stitch index to set Color (-1: All, 0~: [_lineIndex]th Stitch) /// @param _colorName: Name of color from the color palette /// @return true if successful, false otherwise .. tabs:: .. code-tab:: python def SetGraphicStyleToGraphic(_styleIndex : int, _graphicIndex : int, _assignOption : int) -> None """ @brief Set GraphicStyle of Graphic @param _styleIndex: Graphic Style index on the Object Browser @param _graphicIndex: Graphic index to change style @param _assignOption: _assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items. _assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors. _assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously """ .. code-tab:: c++ SetGraphicStyleToGraphic(int _styleIndex, int _colorwayIndex, int _graphicIndex, int _assignOption) /// @brief Set GraphicStyle of Graphic /// @param _styleIndex: Graphic Style index on the Object Browser /// @param _graphicIndex: Graphic index to change style /// @param _assignOption: /// _assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items. /// _assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors. /// _assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously .. tabs:: .. code-tab:: python def SetGraphicStyleToGraphic(_styleIndex : int, _colorwayIndex : int, _graphicIndex : int, _assignOption : int) -> None """ @brief Set GraphicStyle of Graphic @param _styleIndex: Graphic Style index on the [_colorwayIndex]th Colorway @param _colorwayIndex: Colorway index to get Graphic Style @param _graphicIndex: Graphic index to change Graphic Style @param _assignOption: _assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items. _assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors. _assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously """ .. code-tab:: c++ SetGraphicStyleToGraphic(int _styleIndex, int _colorwayIndex, int _graphicIndex, int _assignOption) /// @brief Set GraphicStyle of Graphic /// @param _styleIndex: Graphic Style index on the [_colorwayIndex]th Colorway /// @param _colorwayIndex: Colorway index to get Graphic Style /// @param _graphicIndex: Graphic index to change Graphic Style /// @param _assignOption: /// _assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items. /// _assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors. /// _assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously .. tabs:: .. code-tab:: python def GetSimulationQuality() -> std::pair[int, int] """ @return The Simulation type(0: Normal(Default), 1: Animation(Stable), 2: Fitting(Accurate Fabric)) and simulation mode (0: CPU, 1: FAST(GPU)) """ .. code-tab:: c++ GetSimulationQuality() /// @return The Simulation type(0: Normal(Default), 1: Animation(Stable), 2: Fitting(Accurate Fabric)) and simulation mode (0: CPU, 1: FAST(GPU)) .. tabs:: .. code-tab:: python def CheckZPRJForUnsavedChanges() -> bool """ @return Returns true if the file has been modified. """ .. code-tab:: c++ CheckZPRJForUnsavedChanges() /// @return Returns true if the file has been modified. .. tabs:: .. code-tab:: python def SetAvatarOpacityMapByIndex(_imageFilePath : str, _matShapeIndex : int) -> None """ @brief Set OpacityMap of Avatar @param _imageFilePath: The file path to be set for the Avatar Map @param _matShapeIndex: mat shape index (0: face, 1:body, 2:arm, 3:leg) """ .. code-tab:: c++ SetAvatarOpacityMapByIndex(const std::string _imageFilePath, int _matShapeIndex) /// @brief Set OpacityMap of Avatar /// @param _imageFilePath: The file path to be set for the Avatar Map /// @param _matShapeIndex: mat shape index (0: face, 1:body, 2:arm, 3:leg) .. tabs:: .. code-tab:: python def SetAvatarOpacityMap(_imageFilePath : str) -> None """ @brief Set OpacityMap of Avatar @param _imageFilePath: The file path to be set for the Avatar Map """ .. code-tab:: c++ SetAvatarOpacityMap(const std::string _imageFilePath) /// @brief Set OpacityMap of Avatar /// @param _imageFilePath: The file path to be set for the Avatar Map .. tabs:: .. code-tab:: python def GetAvatarOpacityMaps() -> list[str] """ @ingroup UTILITY_API @brief Get opacity maps Avatar @return Output file paths. """ .. code-tab:: c++ GetAvatarOpacityMaps() /// @ingroup UTILITY_API /// @brief Get opacity maps Avatar /// @return Output file paths. .. tabs:: .. code-tab:: python def SetTrimDisplaySettings(_option : int, _show : bool) -> None """ @ingroup UTILITY_API @brief Set Show/Hide Trim Properties @param _option: Option 0: Button, 1: Pipings, 2: Bond/Skive, 3: Puckering, 4: All Trims, 5: All @param _show: True/False. True is for show. False is for Hide """ .. code-tab:: c++ SetTrimDisplaySettings() /// @ingroup UTILITY_API /// @brief Set Show/Hide Trim Properties /// @param _option: Option 0: Button, 1: Pipings, 2: Bond/Skive, 3: Puckering, 4: All Trims, 5: All /// @param _show: True/False. True is for show. False is for Hide .. tabs:: .. code-tab:: python def SetViewControlDefaults(_xAngle : double, _yPosition : double, _cameraDistance : double) -> None """ @ingroup UTILITY_API @brief Set default setting for view controls @param _xAngle: Angle to set the Default X-Axis Angle @param _yPosition: Angle to set the Default Y-Axis Position @param _cameraDistance: Angle to set the Default Camera Distance for view point shortcuts """ .. code-tab:: c++ SetViewControlDefaults(double _xAngle, double _yPosition, double _cameraDistance) /// @ingroup UTILITY_API /// @brief Set default setting for view controls /// @param _xAngle: Angle to set the Default X-Axis Angle /// @param _yPosition: Angle to set the Default Y-Axis Position /// @param _cameraDistance: Angle to set the Default Camera Distance for view point shortcuts .. tabs:: .. code-tab:: python def SetFormat3DBackground(r : float, g : float, b : float) -> None """ @ingroup UTILITY_API @brief Set 3D Background color @param _r: Red channel @param _g: Green channel @param _b: Blue channel """ .. code-tab:: c++ SetFormat3DBackground(float r, float g, float b) /// @ingroup UTILITY_API /// @brief Set 3D Background color /// @param _r: Red channel /// @param _g: Green channel /// @param _b: Blue channel .. tabs:: .. code-tab:: python def SetGarmentDisplayProperties(_option : int, _show : bool) -> None """ @ingroup UTILITY_API @brief Set Show/Hide Garment Properties @param _option: Option 0: Garment, 1: Archived Pattern, 2: Seamlines, 3: Internal Lines, 4: ShowBaselines, 5: 3D Pen (Garment), 6: Threads, 7: Pins, 8: Garment Measurements, 9: 2D Measurements, 10: Garment Fitting Suit, 11: All @param _show: True/False. True is for show. False is for Hide """ .. code-tab:: c++ SetGarmentDisplayProperties() /// @ingroup UTILITY_API /// @brief Set Show/Hide Garment Properties /// @param _option: Option 0: Garment, 1: Archived Pattern, 2: Seamlines, 3: Internal Lines, 4: ShowBaselines, 5: 3D Pen (Garment), 6: Threads, 7: Pins, 8: Garment Measurements, 9: 2D Measurements, 10: Garment Fitting Suit, 11: All /// @param _show: True/False. True is for show. False is for Hide .. tabs:: .. code-tab:: python def SetEnvironmentDisplayProperties(_option : int, _show : bool) -> None """ @ingroup UTILITY_API @brief Set Show/Hide Environment Properties @param _option: Option 0: Light (3D), 1: Light (Render), 2: Wind Controller, 3: 3D Shadow, 4: Ground Grid, 5: Grid , 6: All @param _show: True/False. True is for show. False is for Hide """ .. code-tab:: c++ SetEnvironmentDisplayProperties() /// @ingroup UTILITY_API /// @brief Set Show/Hide Environment Properties /// @param _option: Option 0: Light (3D), 1: Light (Render), 2: Wind Controller, 3: 3D Shadow, 4: Ground Grid, 5: Grid , 6: All /// @param _show: True/False. True is for show. False is for Hide .. tabs:: .. code-tab:: python def SetShowHideColorOptions(_option : int, _show : bool) -> None """ @ingroup UTILITY_API @brief Set Show/Hide Color Options @param _option: Option 0: All, 1: Freeze, 2: Strengthen, 3: Solidify, 4: Layer, 5: All (Mesh) , 6: Subdivide (Mesh), 7: Freeze (Mesh), 8: Strengthen (Mesh), 9: Solidify (Mesh) @param _show: True/False. True is for show. False is for Hide """ .. code-tab:: c++ SetShowHideColorOptions() /// @ingroup UTILITY_API /// @brief Set Show/Hide Color Options /// @param _option: Option 0: All, 1: Freeze, 2: Strengthen, 3: Solidify, 4: Layer, 5: All (Mesh) , 6: Subdivide (Mesh), 7: Freeze (Mesh), 8: Strengthen (Mesh), 9: Solidify (Mesh) /// @param _show: True/False. True is for show. False is for Hide .. tabs:: .. code-tab:: python def SetAvatarTexureMap(_imageFilePath : str, _textureType : int) -> None """ @ingroup UTILITY_API @brief Set texture maps for Avatar @param _imageFilePath: The file path to be set for the Avatar Map @param _textureType: 0: BaseColorMap, 1: MetalnessMap, 2: NormalMap 3: GlossinessMap 4: AlphaMap 5: DisplacementMap @return Output file paths. """ .. code-tab:: c++ SetAvatarTexureMap(const std::string _imageFilePath, int _textureType) /// @ingroup UTILITY_API /// @brief Set texture maps for Avatar /// @param _imageFilePath: The file path to be set for the Avatar Map /// @param _textureType: 0: BaseColorMap, 1: MetalnessMap, 2: NormalMap 3: GlossinessMap 4: AlphaMap 5: DisplacementMap /// @return Output file paths. .. tabs:: .. code-tab:: python def GetAvatarTexureMap(_textureType : int) -> list[str] """ @ingroup UTILITY_API @brief Get texture maps for Avatar @param _textureType: 0: BaseColorMap, 1: MetalnessMap, 2: NormalMap 3: GlossinessMap 4: AlphaMap 5: DisplacementMap @return Output file paths. """ .. code-tab:: c++ GetAvatarTexureMap(int _textureType) /// @ingroup UTILITY_API /// @brief Get texture maps for Avatar /// @param _textureType: 0: BaseColorMap, 1: MetalnessMap, 2: NormalMap 3: GlossinessMap 4: AlphaMap 5: DisplacementMap /// @return Output file paths. .. tabs:: .. code-tab:: python def AlignAvatarsAndGarmentToCenter() -> None """ @ingroup UTILITY_API @brief Align Avatars and Garment to Center """ .. code-tab:: c++ AlignAvatarsAndGarmentToCenter() /// @ingroup UTILITY_API /// @brief Align Avatars and Garment to Center .. tabs:: .. code-tab:: python def AddGraphicStyleToPattern(_patternIndex : int, _graphicStyleIndex : int, _x : float, _y : float, _width : float, _height : float, _face : int, _zOffset : float, _fAngle : float) -> bool """ @ingroup UTILITY_API @brief Add Graphic Style to Pattern @param _patternIndex: pattern index to add graphic style @param _graphicStyleIndex: graphic style index to add to pattern @param _x: The values along the X-axis represent the horizontal position relative to this point, moving to the right. @param _y: The values along the Y-axis represent the vertical position relative to this point, moving downward. For example, in a 100x100 pattern, the bottom-right corner is located at (100, 100) Place the graphic so that its center aligns with the specified (X, Y) coordinates. @param _width: Width of the graphic @param _height: Height of the graphic @param _face: 0: Front, 1: Back 2: Both @param _zOffset: offset value @param _fAngle: angle value @return if it succeeds, return true. """ .. code-tab:: c++ AddGraphicStyleToPattern(int _textureType) /// @ingroup UTILITY_API /// @brief Add Graphic Style to Pattern /// @param _patternIndex: pattern index to add graphic style /// @param _graphicStyleIndex: graphic style index to add to pattern /// @param _x: The values along the X-axis represent the horizontal position relative to this point, moving to the right. /// @param _y: The values along the Y-axis represent the vertical position relative to this point, moving downward. /// For example, in a 100x100 pattern, the bottom-right corner is located at (100, 100) /// Place the graphic so that its center aligns with the specified (X, Y) coordinates. /// @param _width: Width of the graphic /// @param _height: Height of the graphic /// @param _face: 0: Front, 1: Back 2: Both /// @param _zOffset: offset value /// @param _fAngle: angle value /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def SetAvatarActivation(_avatarName : str, _bActivate : bool) -> bool """ @ingroup UTILITY_API @brief Set Avatar Activation/Deactivation @param _avatarName: Avatar name to activate or deactivate @param _bActivate: true for activate, false for deactivate @return if it succeeds, return true. """ .. code-tab:: c++ SetAvatarActivation(const std::string _avatarName, bool _bActivate) /// @ingroup UTILITY_API /// @brief Set Avatar Activation/Deactivation /// @param _avatarName: Avatar name to activate or deactivate /// @param _bActivate: true for activate, false for deactivate /// @return if it succeeds, return true. .. tabs:: .. code-tab:: python def GetUseSameMapAsFabricForGraphicOpacity(_colorwayIndex : int, _graphicItemIndex : int, _materialFace : int) -> bool """ @brief Returns whether the graphic's opacity map uses the same map as the fabric it is applied to. @param _colorwayIndex: Colorway Index to get Style @param _graphicItemIndex: The index of the graphic item within the list of graphics applied to the object in the Object Browser. @param _materialFace: 0 , back : 1 , side : 2 @return Returns True if 'Use Same Map as Fabric' is enabled for the graphic opacity map. """ .. code-tab:: c++ GetUseSameMapAsFabricForGraphicOpacity(graphic index) /// @brief Returns whether the graphic's opacity map uses the same map as the fabric it is applied to. /// @param _colorwayIndex: Colorway Index to get Style /// @param _graphicItemIndex: The index of the graphic item within the list of graphics applied to the object in the Object Browser. /// @param _materialFace: 0 , back : 1 , side : 2 /// @return Returns True if 'Use Same Map as Fabric' is enabled for the graphic opacity map. .. tabs:: .. code-tab:: python def SetUseSameMapAsFabricForGraphicOpacity(_colorwayIndex : int, _graphicItemIndex : int, _materialFace : int, _bUse : bool) -> None """ @brief Sets whether the graphic's opacity map uses the same map as the fabric. @param _colorwayIndex: Colorway Index to get Style @param _graphicItemIndex: The index of the graphic item within the list of graphics applied to the object in the Object Browser. @param _materialFace: 0 , back : 1 , side : 2 @param _bUse: True to use the fabric's opacity map, False to use a separate map. """ .. code-tab:: c++ void SetUseSameMapAsFabricForGraphicOpacity(graphic index, bool) /// @brief Sets whether the graphic's opacity map uses the same map as the fabric. /// @param _colorwayIndex: Colorway Index to get Style /// @param _graphicItemIndex: The index of the graphic item within the list of graphics applied to the object in the Object Browser. /// @param _materialFace: 0 , back : 1 , side : 2 /// @param _bUse: True to use the fabric's opacity map, False to use a separate map. .. tabs:: .. code-tab:: python def GetTrimStyleCount(_usedOnly : bool) -> int """ @ingroup UTILITY_API @brief Get the count of Trim Styles @param _usedOnly: If true, only count the Trim Styles that are currently used in the garment. else, count all available Trim Styles. @return The number of Trim Styles available. """ .. code-tab:: c++ GetTrimStyleCount(bool _usedOnly) /// @ingroup UTILITY_API /// @brief Get the count of Trim Styles /// @param _usedOnly: If true, only count the Trim Styles that are currently used in the garment. else, count all available Trim Styles. /// @return The number of Trim Styles available. .. tabs:: .. code-tab:: python def GetTopStitchCount(_usedOnly : bool) -> int """ @ingroup UTILITY_API @brief Get the count of Top Stitch Styles @param _usedOnly: If true, only count the Top Stitch Styles that are currently used in the garment. else, count all available Top Stitch Styles. @return The number of Top Stitch Styles available. """ .. code-tab:: c++ GetTopStitchCount(bool _usedOnly) /// @ingroup UTILITY_API /// @brief Get the count of Top Stitch Styles /// @param _usedOnly: If true, only count the Top Stitch Styles that are currently used in the garment. else, count all available Top Stitch Styles. /// @return The number of Top Stitch Styles available. .. tabs:: .. code-tab:: python def GetTrimStyleIndex(_trimStyleName : str) -> int """ @ingroup UTILITY_API @brief Get the index of a Trim Style by its name @param _trimStyleName: The name of the Trim Style to search for. @return The index of the Trim Style if found, otherwise -1. """ .. code-tab:: c++ GetTrimStyleIndex(const std::string _trimStyleName) /// @ingroup UTILITY_API /// @brief Get the index of a Trim Style by its name /// @param _trimStyleName: The name of the Trim Style to search for. /// @return The index of the Trim Style if found, otherwise -1. .. tabs:: .. code-tab:: python def GetTopStitchIndex(_stitchName : str) -> int """ @ingroup UTILITY_API @brief Get the index of a Top Stitch Style by its name @param _stitchName: The name of the Top Stitch Style to search for. @return The index of the Top Stitch Style if found, otherwise -1. """ .. code-tab:: c++ GetTopStitchIndex(const std::string _stitchName) /// @ingroup UTILITY_API /// @brief Get the index of a Top Stitch Style by its name /// @param _stitchName: The name of the Top Stitch Style to search for. /// @return The index of the Top Stitch Style if found, otherwise -1. .. tabs:: .. code-tab:: python def GetTrimStyleName(_trimStyleIndex : int) -> str """ @ingroup UTILITY_API @brief Get the name of a Trim Style by its index @param _trimStyleIndex: The index of the Trim Style to retrieve the name for. @return The name of the Trim Style if found, otherwise an empty string. """ .. code-tab:: c++ GetTrimStyleName(int _trimStyleIndex) /// @ingroup UTILITY_API /// @brief Get the name of a Trim Style by its index /// @param _trimStyleIndex: The index of the Trim Style to retrieve the name for. /// @return The name of the Trim Style if found, otherwise an empty string. .. tabs:: .. code-tab:: python def GetTopStitchName(_stitchIndex : int) -> str """ @ingroup UTILITY_API @brief Get the name of a Top Stitch Style by its index @param _stitchIndex: The index of the Top Stitch Style to retrieve the name for. @return The name of the Top Stitch Style if found, otherwise an empty string """ .. code-tab:: c++ GetTopStitchName(int _stitchIndex) /// @ingroup UTILITY_API /// @brief Get the name of a Top Stitch Style by its index /// @param _stitchIndex: The index of the Top Stitch Style to retrieve the name for. /// @return The name of the Top Stitch Style if found, otherwise an empty string .. tabs:: .. code-tab:: python def RegisterWidget(_widget : int64_t) -> None """ @brief A function to store the int64_t-casted address of a QtWidget in a list. @param _widget: A QtWidget’s address is cast to an int64_t using reinterpret_cast, then passed as an argument. reinterpret_cast(widget) """ .. code-tab:: c++ void RegisterWidget(int64_t _widget) /// @brief A function to store the int64_t-casted address of a QtWidget in a list. /// @param _widget: A QtWidget’s address is cast to an int64_t using reinterpret_cast, then passed as an argument. reinterpret_cast(widget) .. tabs:: .. code-tab:: python def DeleteWidgets() -> None """ @brief Removes and deletes all widgets that were registered using the RegisterWidget function. """ .. code-tab:: c++ void DeleteWidgets() /// @brief Removes and deletes all widgets that were registered using the RegisterWidget function. .. tabs:: .. code-tab:: python def ResetWidgetRegistry() -> None """ @brief Resets the list of registered widgets to an empty state. """ .. code-tab:: c++ void ResetWidgetRegistry() /// @brief Resets the list of registered widgets to an empty state. .. tabs:: .. code-tab:: python def GetUserHeadQuarterId() -> str """ @ingroup UTILITY_API @brief Get the logged in user's head quarter Id @return Logged in user's head quarter Id """ .. code-tab:: c++ GetUserHeadQuarterId() /// @ingroup UTILITY_API /// @brief Get the logged in user's head quarter Id /// @return Logged in user's head quarter Id .. tabs:: .. code-tab:: python def GetUserHeadQuarterIdW() -> str """ @ingroup UTILITY_API @brief Get the logged in user's head quarter Id @return Logged in user's head quarter Id """ .. code-tab:: c++ GetUserHeadQuarterIdW() /// @ingroup UTILITY_API /// @brief Get the logged in user's head quarter Id /// @return Logged in user's head quarter Id .. tabs:: .. code-tab:: python def SetWindControllerSettings(_index : int, _op : WindControllerOptions) -> bool """ @ingroup UTILITY_API @brief It is a function that sets the configuration values for the wind controller. @param _index : It is the index of the wincontroller list. @param _op : It is a parameter of the WindControllerOptions struct. @return It returns false if the index is invalid. """ .. code-tab:: c++ SetWindControllerSettings() /// @ingroup UTILITY_API /// @brief It is a function that sets the configuration values for the wind controller. /// @param _index : It is the index of the wincontroller list. /// @param _op : It is a parameter of the WindControllerOptions struct. /// @return It returns false if the index is invalid. .. tabs:: .. code-tab:: python def GetWindControllerSettings(_index : int) -> WindControllerOptions """ @ingroup UTILITY_API @brief It is a function that retrieves the option values set in the wind controller. @param _index : It is the index of the wincontroller list. @return It returns a WindControllerOptions. """ .. code-tab:: c++ GetWindControllerSettings() /// @ingroup UTILITY_API /// @brief It is a function that retrieves the option values set in the wind controller. /// @param _index : It is the index of the wincontroller list. /// @return It returns a WindControllerOptions. .. tabs:: .. code-tab:: python def LoadCustomViewIn3DWindow(_index : int) -> None """ @ingroup UTILITY_API @brief Selects a custom view from the list of custom views. @param _index: The index of the custom view to select. """ .. code-tab:: c++ LoadCustomViewIn3DWindow(int _index) /// @ingroup UTILITY_API /// @brief Selects a custom view from the list of custom views. /// @param _index: The index of the custom view to select. .. tabs:: .. code-tab:: python def ExportColorwayEditorImage(_filePath : str, _scale : int) -> bool """ @ingroup UTILITY_API @brief Exprot Colorway Editor as Image. @param _filePath: Image path to save _scale: Image scale (1-4) """ .. code-tab:: c++ ExportColorwayEditorImage(const std::string _trimStyleName, int _scale) /// @ingroup UTILITY_API /// @brief Exprot Colorway Editor as Image. /// @param _filePath: Image path to save /// _scale: Image scale (1-4) .. tabs:: .. code-tab:: python def SetZipperStyleName(_zipperStyleIndex : int, _name : str) -> None """ @ingroup UTILITY_API @brief Updates the zipper style name. @param _zipperStyleIndex: The zipper style index. @param _name: Name. """ .. code-tab:: c++ SetZipperStyleName(int _zipperStyleIndex, const std::string& _name) /// @ingroup UTILITY_API /// @brief Updates the zipper style name. /// @param _zipperStyleIndex: The zipper style index. /// @param _name: Name. .. tabs:: .. code-tab:: python def GetZipperStyleName(_zipperStyleIndex : int) -> str """ @ingroup UTILITY_API @brief Get the zipper style name. @param _zipperStyleIndex: The zipper style index. @return It returns the zipper style name. """ .. code-tab:: c++ GetZipperStyleName(int _zipperStyleIndex) /// @ingroup UTILITY_API /// @brief Get the zipper style name. /// @param _zipperStyleIndex: The zipper style index. /// @return It returns the zipper style name. .. tabs:: .. code-tab:: python def SetZipperStyleFunctionType(_zipperStyleIndex : int, _typeIndex : int) -> None """ @ingroup UTILITY_API @brief Update the zipper style function type. @param _zipperStyleIndex: The zipper style index. @param _typeIndex: The function type index. 0: One way 1: Two way(Bottom to bottom) 2: Two way(Head to head) """ .. code-tab:: c++ SetZipperStyleFunctionType(int _zipperStyleIndex, int _typeIndex) /// @ingroup UTILITY_API /// @brief Update the zipper style function type. /// @param _zipperStyleIndex: The zipper style index. /// @param _typeIndex: The function type index. /// 0: One way /// 1: Two way(Bottom to bottom) /// 2: Two way(Head to head) .. tabs:: .. code-tab:: python def GetZipperStyleFunctionType(_zipperStyleIndex : int) -> int """ @ingroup UTILITY_API @brief Get the zipper style function type. @param _zipperStyleIndex: The zipper style index. @return It returns the zipper style function type index. 0: One way 1: Two way(Bottom to bottom) 2: Two way(Head to head) """ .. code-tab:: c++ GetZipperStyleFunctionType(int _zipperStyleIndex) /// @ingroup UTILITY_API /// @brief Get the zipper style function type. /// @param _zipperStyleIndex: The zipper style index. /// @return It returns the zipper style function type index. /// 0: One way /// 1: Two way(Bottom to bottom) /// 2: Two way(Head to head) .. tabs:: .. code-tab:: python def SetZipperStyleAssetType(_zipperStyleIndex : int, _typeIndex : int) -> None """ @ingroup UTILITY_API @brief Update the zipper style asset type. @param _zipperStyleIndex: The zipper style index. @param _typeIndex: The asset type index. 0: Custom(No Change) 1: Plastic_01 2: Plastic_02 3: Metal 4: Nylon 5: Reverse_Nylon 6: Invisible """ .. code-tab:: c++ SetZipperStyleAssetType(int _zipperStyleIndex, int _typeIndex) /// @ingroup UTILITY_API /// @brief Update the zipper style asset type. /// @param _zipperStyleIndex: The zipper style index. /// @param _typeIndex: The asset type index. /// 0: Custom(No Change) /// 1: Plastic_01 /// 2: Plastic_02 /// 3: Metal /// 4: Nylon /// 5: Reverse_Nylon /// 6: Invisible .. tabs:: .. code-tab:: python def GetZipperStyleAssetType(_zipperStyleIndex : int) -> int """ @ingroup UTILITY_API @brief Get the zipper style asset type index. @param _zipperStyleIndex: The zipper style index. @return It returns the zipper style asset type index. 0: Custom(No Change) 1: Plastic_01 2: Plastic_02 3: Metal 4: Nylon 5: Reverse_Nylon 6: Invisible """ .. code-tab:: c++ GetZipperStyleAssetType(int _zipperStyleIndex) /// @ingroup UTILITY_API /// @brief Get the zipper style asset type index. /// @param _zipperStyleIndex: The zipper style index. /// @return It returns the zipper style asset type index. /// 0: Custom(No Change) /// 1: Plastic_01 /// 2: Plastic_02 /// 3: Metal /// 4: Nylon /// 5: Reverse_Nylon /// 6: Invisible .. tabs:: .. code-tab:: python def SetZipperStyleTeethType(_zipperStyleIndex : int, _typeIndex : int) -> None """ @ingroup UTILITY_API @brief Update the zipper style teeth type. @param _zipperStyleIndex: The zipper style index. @param _typeIndex: The teeth type index. 0: Texture 1: OBJ """ .. code-tab:: c++ SetZipperStyleTeethType(int _zipperStyleIndex, int _typeIndex) /// @ingroup UTILITY_API /// @brief Update the zipper style teeth type. /// @param _zipperStyleIndex: The zipper style index. /// @param _typeIndex: The teeth type index. /// 0: Texture /// 1: OBJ .. tabs:: .. code-tab:: python def GetZipperStyleTeethType(_zipperStyleIndex : int) -> int """ @ingroup UTILITY_API @brief Update the zipper style teeth type. @param _zipperStyleIndex: The zipper style index. @return It returns the teeth type index. 0: Texture 1: OBJ """ .. code-tab:: c++ GetZipperStyleTeethType(int _zipperStyleIndex, int _typeIndex) /// @ingroup UTILITY_API /// @brief Update the zipper style teeth type. /// @param _zipperStyleIndex: The zipper style index. /// @return It returns the teeth type index. /// 0: Texture /// 1: OBJ .. tabs:: .. code-tab:: python def SetZipperSliderStyle(_zipperStyleIndex : int, _filePath : str) -> None """ @ingroup UTILITY_API @brief Update the zipper slider style. @param _zipperStyleIndex: The zipper style index. @param _filePath: Slider file path. (.zsd, .zsl, .zss) """ .. code-tab:: c++ SetZipperSliderStyle(int _zipperStyleIndex, const std::string& _filePath) /// @ingroup UTILITY_API /// @brief Update the zipper slider style. /// @param _zipperStyleIndex: The zipper style index. /// @param _filePath: Slider file path. (.zsd, .zsl, .zss) .. tabs:: .. code-tab:: python def SetZipperPullerStyle(_zipperStyleIndex : int, _filePath : str) -> None """ @ingroup UTILITY_API @brief Update the zipper puller style. @param _zipperStyleIndex: The zipper style index. @param _filePath: Puller file path. (.zpl, .zpu) """ .. code-tab:: c++ SetZipperPullerStyle(int _zipperStyleIndex, const std::string& _filePath) /// @ingroup UTILITY_API /// @brief Update the zipper puller style. /// @param _zipperStyleIndex: The zipper style index. /// @param _filePath: Puller file path. (.zpl, .zpu) .. tabs:: .. code-tab:: python def SetZipperTopStopperStyle(_zipperStyleIndex : int, _filePath : str) -> None """ @ingroup UTILITY_API @brief Update the zipper top stopper style. @param _zipperStyleIndex: The zipper style index. @param _filePath: Top stopper file path. (.zsp, .zst) """ .. code-tab:: c++ SetZipperTopStopperStyle(int _zipperStyleIndex, const std::string& _filePath) /// @ingroup UTILITY_API /// @brief Update the zipper top stopper style. /// @param _zipperStyleIndex: The zipper style index. /// @param _filePath: Top stopper file path. (.zsp, .zst) .. tabs:: .. code-tab:: python def SetZipperBottomStopperStyle(_zipperStyleIndex : int, _filePath : str) -> None """ @ingroup UTILITY_API @brief Update the zipper bottom stopper style. @param _zipperStyleIndex: The zipper style index. @param _filePath: Bottom stopper file path (.zsp, .zst) """ .. code-tab:: c++ SetZipperBottomStopperStyle(int _zipperStyleIndex, const std::string& _filePath) /// @ingroup UTILITY_API /// @brief Update the zipper bottom stopper style. /// @param _zipperStyleIndex: The zipper style index. /// @param _filePath: Bottom stopper file path (.zsp, .zst) .. tabs:: .. code-tab:: python def SetZipperStyleTeethWidth(_zipperStyleIndex : int, _teethWidth : float) -> None """ @ingroup UTILITY_API @brief Update the zipper style teeth width. @param _zipperStyleIndex: The zipper style index. @param _teethWidth: Teeth width (mm) """ .. code-tab:: c++ SetZipperStyleTeethWidth(int _zipperStyleIndex, float _teethWidth) /// @ingroup UTILITY_API /// @brief Update the zipper style teeth width. /// @param _zipperStyleIndex: The zipper style index. /// @param _teethWidth: Teeth width (mm) .. tabs:: .. code-tab:: python def GetZipperStyleTeethWidth(_zipperStyleIndex : int) -> float """ @ingroup UTILITY_API @brief Get the zipper style teeth width. @param _zipperStyleIndex: The zipper style index. @return It returns the zipper style teeth width (mm) """ .. code-tab:: c++ GetZipperStyleTeethWidth(int _zipperStyleIndex) /// @ingroup UTILITY_API /// @brief Get the zipper style teeth width. /// @param _zipperStyleIndex: The zipper style index. /// @return It returns the zipper style teeth width (mm) .. tabs:: .. code-tab:: python def SetZipperStyleWeight(_zipperStyleIndex : int, _weight : float) -> None """ @ingroup UTILITY_API @brief Update the zipper style weight. @param _zipperStyleIndex: The zipper style index. @param _weight: Weight (g) """ .. code-tab:: c++ SetZipperStyleWeight(int _zipperStyleIndex, float _weight) /// @ingroup UTILITY_API /// @brief Update the zipper style weight. /// @param _zipperStyleIndex: The zipper style index. /// @param _weight: Weight (g) .. tabs:: .. code-tab:: python def GetZipperStyleWeight(_zipperStyleIndex : int) -> float """ @ingroup UTILITY_API @brief Get the zipper style weight. @param _zipperStyleIndex: The zipper style index. @return It returns the zipper style weight (g) """ .. code-tab:: c++ GetZipperStyleWeight(int _zipperStyleIndex) /// @ingroup UTILITY_API /// @brief Get the zipper style weight. /// @param _zipperStyleIndex: The zipper style index. /// @return It returns the zipper style weight (g) .. tabs:: .. code-tab:: python def SetZipperStyleTapeThickness(_zipperStyleIndex : int, _tapeThickness : float) -> None """ @ingroup UTILITY_API @brief Update the zipper style tape thickness. @param _zipperStyleIndex: The zipper style index. @param _tapeThickness: Tape thickness (mm) """ .. code-tab:: c++ SetZipperStyleTapeThickness(int _zipperStyleIndex, float _tapeThickness) /// @ingroup UTILITY_API /// @brief Update the zipper style tape thickness. /// @param _zipperStyleIndex: The zipper style index. /// @param _tapeThickness: Tape thickness (mm) .. tabs:: .. code-tab:: python def GetZipperStyleTapeThickness(_zipperStyleIndex : int) -> float """ @ingroup UTILITY_API @brief Get the zipper style tape thickness. @param _zipperStyleIndex: The zipper style index. @return It returns the zipper style tape thickness (mm) """ .. code-tab:: c++ GetZipperStyleTapeThickness(int _zipperStyleIndex) /// @ingroup UTILITY_API /// @brief Get the zipper style tape thickness. /// @param _zipperStyleIndex: The zipper style index. /// @return It returns the zipper style tape thickness (mm) .. tabs:: .. code-tab:: python def SetAvatarSmooth(_avatarIndex : int, _smoothlevel : int) -> None """ @ingroup UTILITY_API @brief Set the maximum subdivision level for avatar smoothing. @param _avatarIndex: The index of the avatar to apply smoothing to. @param _smoothlevel: The maximum subdivision level to set for avatar smoothing. (1-3) """ .. code-tab:: c++ SetAvatarSmooth(unsigned int _avatarIndex, unsigned int _smoothlevel) /// @ingroup UTILITY_API /// @brief Set the maximum subdivision level for avatar smoothing. /// @param _avatarIndex: The index of the avatar to apply smoothing to. /// @param _smoothlevel: The maximum subdivision level to set for avatar smoothing. (1-3) .. tabs:: .. code-tab:: python def GetAvatarSubdivisionLevel(_avatarIndex : int) -> int """ @ingroup UTILITY_API @brief Get the current subdivision level for avatar smoothing. @param _avatarIndex: The index of the avatar to query. @return The current subdivision level for avatar smoothing. (1-3, 0 means no subdivision). If 0 to uncheck/unselect DivideMesh. """ .. code-tab:: c++ GetAvatarSubdivisionLevel(unsigned int _avatarIndex) /// @ingroup UTILITY_API /// @brief Get the current subdivision level for avatar smoothing. /// @param _avatarIndex: The index of the avatar to query. /// @return The current subdivision level for avatar smoothing. (1-3, 0 means no subdivision). If 0 to uncheck/unselect DivideMesh. .. tabs:: .. code-tab:: python def SetAvatarProperties(_avatarIndex : int, avatarPropertyMap : map[str, str]) -> None """ @ingroup UTILITY_API @brief Set multiple properties for the avatar at the specified index. @param _avatarIndex: The index of the avatar to set properties for. @param avatarPropertyMap: A map containing property names and their corresponding values to set for the avatar. Such as {'KineticFriction': '0.050000', 'SkinOffsetMM': '3.000000', 'StaticFriction': '0.800000'} """ .. code-tab:: c++ SetAvatarProperties(unsigned int _avatarIndex, const std::map& avatarPropertyMap) /// @ingroup UTILITY_API /// @brief Set multiple properties for the avatar at the specified index. /// @param _avatarIndex: The index of the avatar to set properties for. /// @param avatarPropertyMap: A map containing property names and their corresponding values to set for the avatar. Such as {'KineticFriction': '0.050000', 'SkinOffsetMM': '3.000000', 'StaticFriction': '0.800000'} .. tabs:: .. code-tab:: python def GetAvatarProperties(_avatarIndex : int) -> map[str, str] """ @ingroup UTILITY_API @brief Get multiple properties for the avatar at the specified index. @param _avatarIndex: The index of the avatar to get properties for. @return A map containing property names and their corresponding values for the avatar. Such as {'DivideMesh': 'true/false', 'KineticFriction': '0.050000', 'SkinOffsetMM': '3.000000', 'SoftBodySimulation': 'true/false', 'StaticFriction': '0.800000'} """ .. code-tab:: c++ GetAvatarProperties(unsigned int _avatarIndex) /// @ingroup UTILITY_API /// @brief Get multiple properties for the avatar at the specified index. /// @param _avatarIndex: The index of the avatar to get properties for. /// @return A map containing property names and their corresponding values for the avatar. Such as {'DivideMesh': 'true/false', 'KineticFriction': '0.050000', 'SkinOffsetMM': '3.000000', 'SoftBodySimulation': 'true/false', 'StaticFriction': '0.800000'} .. tabs:: .. code-tab:: python def SetAvatarSoftBodyStiffness(_avatarIndex : int, _stiffnessValue : float) -> None """ @ingroup UTILITY_API @brief Set the stiffness value for soft body simulation of the avatar at the specified @param _avatarIndex: The index of the avatar to set the stiffness value for. @param _stiffnessValue: The value to set for soft body stiffness. (5000.0 - 10000.0). If 0.0f to uncheck/unselect SoftBodySimulation. """ .. code-tab:: c++ SetAvatarSoftBodyStiffness(unsigned int _avatarIndex, float _stiffnessValue) /// @ingroup UTILITY_API /// @brief Set the stiffness value for soft body simulation of the avatar at the specified /// @param _avatarIndex: The index of the avatar to set the stiffness value for. /// @param _stiffnessValue: The value to set for soft body stiffness. (5000.0 - 10000.0). If 0.0f to uncheck/unselect SoftBodySimulation. .. tabs:: .. code-tab:: python def GetAvatarSoftBodyStiffness(_avatarIndex : int) -> float """ @ingroup UTILITY_API @brief Get the stiffness value for soft body simulation of the avatar at the specified @param _avatarIndex: The index of the avatar to get the stiffness value for. @return The current stiffness value for soft body simulation of the avatar. (5000.0 - 10000.0, 0.0f means no soft body simulation). """ .. code-tab:: c++ GetAvatarSoftBodyStiffness(unsigned int _avatarIndex) /// @ingroup UTILITY_API /// @brief Get the stiffness value for soft body simulation of the avatar at the specified /// @param _avatarIndex: The index of the avatar to get the stiffness value for. /// @return The current stiffness value for soft body simulation of the avatar. (5000.0 - 10000.0, 0.0f means no soft body simulation). .. tabs:: .. code-tab:: python def SetPatternSnapShotImageOption(_op : PatternSnapShotImageOption, _mode : int) -> None """ @ingroup UTILITY_API @brief Sets the Image option for the PatternSnapshot. @param PatternSnapShotImageOption _op : Controls display of fabric, pattern, and graphic textures, and fabric texture opacity. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. """ .. code-tab:: c++ SetPatternSnapShotImageOption(Marvelous::PatternSnapShotImageOption _op, int _mode) /// @ingroup UTILITY_API /// @brief Sets the Image option for the PatternSnapshot. /// @param PatternSnapShotImageOption _op : Controls display of fabric, pattern, and graphic textures, and fabric texture opacity. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. .. tabs:: .. code-tab:: python def GetPatternSnapShotImageOption(_mode : int) -> PatternSnapShotImageOption """ @ingroup UTILITY_API @brief Retrieves the currently set PatternSnapShotImageOption. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. Preset A4 = 0 A3 = 1 B5 = 2 B4 = 3 Letter = 4 Legal = 5 Tabloid = 6 WideFormat_24 = 7 WideFormat_36 = 8 WideFormat_44 = 9 oneToOne = 10 Custom = 11 Orientation Portrait = 0 Landscape = 1 Unit Pixels = 0 Inches = 1 Milimeters = 2 Centimeters = 3 @return The currently set PatternSnapShotImageOption value. """ .. code-tab:: c++ GetPatternSnapShotImageOption(int _mode) /// @ingroup UTILITY_API /// @brief Retrieves the currently set PatternSnapShotImageOption. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. /// Preset /// A4 = 0 /// A3 = 1 /// B5 = 2 /// B4 = 3 /// Letter = 4 /// Legal = 5 /// Tabloid = 6 /// WideFormat_24 = 7 /// WideFormat_36 = 8 /// WideFormat_44 = 9 /// oneToOne = 10 /// Custom = 11 /// Orientation /// Portrait = 0 /// Landscape = 1 /// Unit /// Pixels = 0 /// Inches = 1 /// Milimeters = 2 /// Centimeters = 3 /// @return The currently set PatternSnapShotImageOption value. .. tabs:: .. code-tab:: python def SetPatternSnapShotSizeOption(_op : PatternSnapShotSizeOption, _mode : int) -> None """ @ingroup UTILITY_API @brief Sets the Size option for the PatternSnapshot. @param PatternSnapShotSizeOption _op : Defines paper preset, orientation, unit, width/height (always in mm), and resolution. Preset A4 = 0 A3 = 1 B5 = 2 B4 = 3 Letter = 4 Legal = 5 Tabloid = 6 WideFormat_24 = 7 WideFormat_36 = 8 WideFormat_44 = 9 oneToOne = 10 Custom = 11 Orientation Portrait = 0 Landscape = 1 Unit Pixels = 0 Inches = 1 Milimeters = 2 Centimeters = 3 @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. """ .. code-tab:: c++ SetPatternSnapShotSizeOption(Marvelous::PatternSnapShotSizeOption _op, int _mode) /// @ingroup UTILITY_API /// @brief Sets the Size option for the PatternSnapshot. /// @param PatternSnapShotSizeOption _op : Defines paper preset, orientation, unit, width/height (always in mm), and resolution. /// Preset /// A4 = 0 /// A3 = 1 /// B5 = 2 /// B4 = 3 /// Letter = 4 /// Legal = 5 /// Tabloid = 6 /// WideFormat_24 = 7 /// WideFormat_36 = 8 /// WideFormat_44 = 9 /// oneToOne = 10 /// Custom = 11 /// Orientation /// Portrait = 0 /// Landscape = 1 /// Unit /// Pixels = 0 /// Inches = 1 /// Milimeters = 2 /// Centimeters = 3 /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. .. tabs:: .. code-tab:: python def GetPatternSnapShotSizeOption(_mode : int) -> PatternSnapShotSizeOption """ @ingroup UTILITY_API @brief Retrieves the currently set PatternSnapShotSizeOption. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. @return The currently set PatternSnapShotSizeOption value. """ .. code-tab:: c++ GetPatternSnapShotSizeOption(int _mode) /// @ingroup UTILITY_API /// @brief Retrieves the currently set PatternSnapShotSizeOption. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. /// @return The currently set PatternSnapShotSizeOption value. .. tabs:: .. code-tab:: python def SetPatternSnapShotLineOption(_op : PatternSnapShotLineOption, _mode : int) -> None """ @ingroup UTILITY_API @brief Sets the Line option for the PatternSnapshot. @param PatternSnapShotLineOption _op : Controls visibility, color, and line type of outlines, internal lines, graphics, baseline, notches, seam allowance, symmetry lines, and reference lines. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. """ .. code-tab:: c++ SetPatternSnapShotLineOption(Marvelous::PatternSnapShotLineOption _op, int _mode) /// @ingroup UTILITY_API /// @brief Sets the Line option for the PatternSnapshot. /// @param PatternSnapShotLineOption _op : Controls visibility, color, and line type of outlines, internal lines, graphics, baseline, notches, seam allowance, symmetry lines, and reference lines. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. .. tabs:: .. code-tab:: python def GetPatternSnapShotLineOption(_mode : int) -> PatternSnapShotLineOption """ @ingroup UTILITY_API @brief Retrieves the currently set PatternSnapShotLineOption. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. @return The currently set PatternSnapShotLineOption value. """ .. code-tab:: c++ GetPatternSnapShotLineOption(int _mode) /// @ingroup UTILITY_API /// @brief Retrieves the currently set PatternSnapShotLineOption. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. /// @return The currently set PatternSnapShotLineOption value. .. tabs:: .. code-tab:: python def SetPatternSnapShotColorwayOption(_op : PatternSnapShotColorwayOption, _mode : int) -> None """ @ingroup UTILITY_API @brief Sets the Colorway option for the PatternSnapshot. @param PatternSnapShotColorwayOption _op : Defines which colorway(s) to apply, including custom selections. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. """ .. code-tab:: c++ SetPatternSnapShotColorwayOption(Marvelous::PatternSnapShotColorwayOption _op, int _mode) /// @ingroup UTILITY_API /// @brief Sets the Colorway option for the PatternSnapshot. /// @param PatternSnapShotColorwayOption _op : Defines which colorway(s) to apply, including custom selections. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. .. tabs:: .. code-tab:: python def GetPatternSnapShotColorwayOption(_mode : int) -> PatternSnapShotColorwayOption """ @ingroup UTILITY_API @brief Retrieves the currently set PatternSnapShotColorwayOption. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. @return The currently set PatternSnapShotColorwayOption value. """ .. code-tab:: c++ GetPatternSnapShotColorwayOption(int _mode) /// @ingroup UTILITY_API /// @brief Retrieves the currently set PatternSnapShotColorwayOption. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. /// @return The currently set PatternSnapShotColorwayOption value. .. tabs:: .. code-tab:: python def SetPatternSnapShotInformationOption(_op : PatternSnapShotInformationOption, _mode : int) -> None """ @ingroup UTILITY_API @brief Sets the Information option for the PatternSnapshot. @param PatternSnapShotInformationOption _op : Controls visibility and type of metadata, including pattern name, annotations, line length, grain line, buttonholes, seam taping, 2D measurements, grading size name, and nest information. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. """ .. code-tab:: c++ SetPatternSnapShotInformationOption(Marvelous::PatternSnapShotInformationOption _op, int _mode) /// @ingroup UTILITY_API /// @brief Sets the Information option for the PatternSnapshot. /// @param PatternSnapShotInformationOption _op : Controls visibility and type of metadata, including pattern name, annotations, line length, grain line, buttonholes, seam taping, 2D measurements, grading size name, and nest information. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. .. tabs:: .. code-tab:: python def GetPatternSnapShotInformationOption(_mode : int) -> PatternSnapShotInformationOption """ @ingroup UTILITY_API @brief Retrieves the currently set PatternSnapShotInformationOption. @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. @return The currently set PatternSnapShotInformationOption value. """ .. code-tab:: c++ GetPatternSnapShotInformationOption(int _mode) /// @ingroup UTILITY_API /// @brief Retrieves the currently set PatternSnapShotInformationOption. /// @param int _mode : 0 = capture from PatternWindow, 1 = capture from PrintLayoutWindow. /// @return The currently set PatternSnapShotInformationOption value. .. tabs:: .. code-tab:: python def SetTrimMaterialProperties(_trimStyleIndex : int, _meshIndex : int, _props : map[str, str]) -> None """ @ingroup UTILITY_API @brief Sets multiple material properties for a specific trim style and mesh index. @param _trimStyleIndex: The index of the trim style to set properties for. @param _meshIndex: The index of the mesh within the trim style to set properties for. @param _props: A map containing property names and their corresponding values to set for the trim material. MaterialType 0 to 14, Such as {'MaterialType': '0', 'Metalness': '0.100000', 'NormalMapIntensity': '2', 'Opacity': '0.500000', 'ReflectionIntensity': '0.250000', 'Roughness': '0.550000', 'RoughnessMapIntensity': '1.600000', 'RoughnessMapInvert': 'true'} """ .. code-tab:: c++ SetTrimMaterialProperties(int _trimStyleIndex, int _meshIndex, const std::map& _props) /// @ingroup UTILITY_API /// @brief Sets multiple material properties for a specific trim style and mesh index. /// @param _trimStyleIndex: The index of the trim style to set properties for. /// @param _meshIndex: The index of the mesh within the trim style to set properties for. /// @param _props: A map containing property names and their corresponding values to set for the trim material. MaterialType 0 to 14, Such as {'MaterialType': '0', 'Metalness': '0.100000', 'NormalMapIntensity': '2', 'Opacity': '0.500000', 'ReflectionIntensity': '0.250000', 'Roughness': '0.550000', 'RoughnessMapIntensity': '1.600000', 'RoughnessMapInvert': 'true'} .. tabs:: .. code-tab:: python def GetTrimMaterialProperties(_trimStyleIndex : int, _meshIndex : int) -> map[str, str] """ @ingroup UTILITY_API @brief Gets multiple material properties for a specific trim style and mesh index. @param _trimStyleIndex: The index of the trim style to get properties for. @param _meshIndex: The index of the mesh within the trim style to get properties for. @return A map containing property names and their corresponding values for the trim material. Such as {'MaterialType': '0', 'Metalness': '0.100000', 'NormalMapIntensity': '2', 'Opacity': '0.500000', 'ReflectionIntensity': '0.250000', 'Roughness': '0.550000', 'RoughnessMapIntensity': '1.600000', 'RoughnessMapInvert': 'true'} """ .. code-tab:: c++ GetTrimMaterialProperties(int _trimStyleIndex, int _meshIndex) /// @ingroup UTILITY_API /// @brief Gets multiple material properties for a specific trim style and mesh index. /// @param _trimStyleIndex: The index of the trim style to get properties for. /// @param _meshIndex: The index of the mesh within the trim style to get properties for. /// @return A map containing property names and their corresponding values for the trim material. Such as {'MaterialType': '0', 'Metalness': '0.100000', 'NormalMapIntensity': '2', 'Opacity': '0.500000', 'ReflectionIntensity': '0.250000', 'Roughness': '0.550000', 'RoughnessMapIntensity': '1.600000', 'RoughnessMapInvert': 'true'} .. tabs:: .. code-tab:: python def SetNormalBlendingMethod(_index : int) -> None """ @ingroup UTILITY_API @brief Sets the normal blending method for given index. @param _index: The index of the normal blending method to set. """ .. code-tab:: c++ SetNormalBlendingMethod(int _index) /// @ingroup UTILITY_API /// @brief Sets the normal blending method for given index. /// @param _index: The index of the normal blending method to set. .. tabs:: .. code-tab:: python def GetNormalBlendingMethod() -> int """ @ingroup UTILITY_API @brief Gets the current normal blending method. @return The index of the current normal blending method. """ .. code-tab:: c++ GetNormalBlendingMethod() /// @ingroup UTILITY_API /// @brief Gets the current normal blending method. /// @return The index of the current normal blending method. .. tabs:: .. code-tab:: python def SetTopStitchName(_topStitchIndex : int, _name : str) -> None """ @ingroup UTILITY_API @brief Updates the top stitch style name. @param _topStitchIndex: The top stitch style index. @param _name: Name. """ .. code-tab:: c++ SetTopStitchName(int _topStitchIndex, const std::string& _name) /// @ingroup UTILITY_API /// @brief Updates the top stitch style name. /// @param _topStitchIndex: The top stitch style index. /// @param _name: Name. .. tabs:: .. code-tab:: python def SetTopStitchOffsetIndex(_topStitchIndex : int, _offsetIndex : int) -> None """ @ingroup UTILITY_API @brief Update the top stitch offset index. @param _topStitchIndex: The top stitch style index. @param _offsetIndex: The offset index. """ .. code-tab:: c++ SetTopStitchOffsetIndex(int _topStitchIndex, int _offsetIndex) /// @ingroup UTILITY_API /// @brief Update the top stitch offset index. /// @param _topStitchIndex: The top stitch style index. /// @param _offsetIndex: The offset index. .. tabs:: .. code-tab:: python def SetTopStitchNumberOfLines(_topStitchIndex : int, _stitchCountIndex : int, _numberOfLines : int) -> None """ @ingroup UTILITY_API @brief Update the top stitch number of lines. @param _topStitchIndex: The top stitch style index. @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line @param _numberOfLines: The number of lines. """ .. code-tab:: c++ SetTopStitchNumberOfLines(int _topStitchIndex, int _stitchCountIndex, int _numberOfLines) /// @ingroup UTILITY_API /// @brief Update the top stitch number of lines. /// @param _topStitchIndex: The top stitch style index. /// @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line /// @param _numberOfLines: The number of lines. .. tabs:: .. code-tab:: python def SetTopStitchWidthValue(_topStitchIndex : int, _stitchCountIndex : int, _widthValue : float) -> None """ @ingroup UTILITY_API @brief Update the top stitch width value. @param _topStitchIndex: The top stitch style index. @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line @param _widthValue: The width value. """ .. code-tab:: c++ SetTopStitchWidthValue(int _topStitchIndex, int _stitchCountIndex, float _widthValue) /// @ingroup UTILITY_API /// @brief Update the top stitch width value. /// @param _topStitchIndex: The top stitch style index. /// @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line /// @param _widthValue: The width value. .. tabs:: .. code-tab:: python def SetTopStitchDistanceValue(_topStitchIndex : int, _stitchCountIndex : int, _distanceValue : float) -> None """ @ingroup UTILITY_API @brief Update the top stitch distance value. @param _topStitchIndex: The top stitch style index. @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line @param _distanceValue: The distance value. Based on CLO unit (mm/inch). """ .. code-tab:: c++ SetTopStitchDistanceValue(int _topStitchIndex, int _stitchCountIndex, float _distanceValue) /// @ingroup UTILITY_API /// @brief Update the top stitch distance value. /// @param _topStitchIndex: The top stitch style index. /// @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line /// @param _distanceValue: The distance value. Based on CLO unit (mm/inch). .. tabs:: .. code-tab:: python def GetTopStitchOffsetIndex(_topStitchIndex : int) -> int """ @ingroup UTILITY_API @brief Get the top stitch offset index. @param _topStitchIndex: The top stitch style index. @return The offset index. """ .. code-tab:: c++ GetTopStitchOffsetIndex(int _topStitchIndex) /// @ingroup UTILITY_API /// @brief Get the top stitch offset index. /// @param _topStitchIndex: The top stitch style index. /// @return The offset index. .. tabs:: .. code-tab:: python def GetTopStitchNumberOfLines(_topStitchIndex : int, _stitchCountIndex : int) -> int """ @ingroup UTILITY_API @brief Get the top stitch number of lines. @param _topStitchIndex: The top stitch style index. @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line @return The number of lines. """ .. code-tab:: c++ GetTopStitchNumberOfLines(int _topStitchIndex, int _stitchCountIndex) /// @ingroup UTILITY_API /// @brief Get the top stitch number of lines. /// @param _topStitchIndex: The top stitch style index. /// @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line /// @return The number of lines. .. tabs:: .. code-tab:: python def GetTopStitchOffsetValue(_topStitchIndex : int) -> float """ @ingroup UTILITY_API @brief Get the top stitch stitch offset value. @param _topStitchIndex: The top stitch style index. @return The offset value. """ .. code-tab:: c++ GetTopStitchOffsetValue(int _topStitchIndex) /// @ingroup UTILITY_API /// @brief Get the top stitch stitch offset value. /// @param _topStitchIndex: The top stitch style index. /// @return The offset value. .. tabs:: .. code-tab:: python def GetTopStitchWidthValue(_topStitchIndex : int, _stitchCountIndex : int) -> float """ @ingroup UTILITY_API @brief Get the top stitch width value. @param _topStitchIndex: The top stitch style index. @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line @return The width value. """ .. code-tab:: c++ GetTopStitchWidthValue(int _topStitchIndex, int _stitchCountIndex) /// @ingroup UTILITY_API /// @brief Get the top stitch width value. /// @param _topStitchIndex: The top stitch style index. /// @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line /// @return The width value. .. tabs:: .. code-tab:: python def GetTopStitchDistanceValue(_topStitchIndex : int, _stitchCountIndex : int) -> float """ @ingroup UTILITY_API @brief Get the top stitch distance value. @param _topStitchIndex: The top stitch style index. @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line @return The distance value. """ .. code-tab:: c++ GetTopStitchDistanceValue(int _topStitchIndex, int _stitchCountIndex) /// @ingroup UTILITY_API /// @brief Get the top stitch distance value. /// @param _topStitchIndex: The top stitch style index. /// @param _stitchCountIndex: The stitch count index. Ex: for 3 count, 1:index for 1st line, 2:index for 2nd line, 3:index for 3rd line /// @return The distance value. .. tabs:: .. code-tab:: python def SetWindActive(_bActive : bool) -> None """ @ingroup UTILITY_API @brief It is a function that sets whether the wind is active or not. @param _bActive : True to activate wind, False to deactivate wind. """ .. code-tab:: c++ SetWindActive(bool _bActive) /// @ingroup UTILITY_API /// @brief It is a function that sets whether the wind is active or not. /// @param _bActive : True to activate wind, False to deactivate wind. .. tabs:: .. code-tab:: python def GetWindActive() -> bool """ @ingroup UTILITY_API @brief It is a function that gets whether the wind is active or not. @return It returns True if wind is active, False if wind is inactive. """ .. code-tab:: c++ GetWindActive() /// @ingroup UTILITY_API /// @brief It is a function that gets whether the wind is active or not. /// @return It returns True if wind is active, False if wind is inactive. .. tabs:: .. code-tab:: python def SetWindRotation(_xAngle : float, _yAngle : float, _zAngle : float) -> None """ @ingroup UTILITY_API @brief It is a function that sets the rotation of the wind. @param _xAngle : Rotation angle around the X-axis in degrees. @param _yAngle : Rotation angle around the Y-axis in degrees. @param _zAngle : Rotation angle around the Z-axis in degrees. """ .. code-tab:: c++ SetWindRotation(float _xAngle, float _yAngle, float _zAngle) /// @ingroup UTILITY_API /// @brief It is a function that sets the rotation of the wind. /// @param _xAngle : Rotation angle around the X-axis in degrees. /// @param _yAngle : Rotation angle around the Y-axis in degrees. /// @param _zAngle : Rotation angle around the Z-axis in degrees. .. tabs:: .. code-tab:: python def GetWindRotation() -> list[float] """ @ingroup UTILITY_API @brief It is a function that gets the rotation of the wind. @return It returns a vector of three floats representing the rotation angles around the X, Y, and Z axes in degrees. """ .. code-tab:: c++ GetWindRotation() /// @ingroup UTILITY_API /// @brief It is a function that gets the rotation of the wind. /// @return It returns a vector of three floats representing the rotation angles around the X, Y, and Z axes in degrees. .. tabs:: .. code-tab:: python def SetWindPosition(_xPos : float, _yPos : float, _zPos : float) -> None """ @ingroup UTILITY_API @brief It is a function that sets the position of the wind. @param _xPos : Position along the X-axis. @param _yPos : Position along the Y-axis. @param _zPos : Position along the Z-axis. """ .. code-tab:: c++ SetWindPosition(float _xPos, float _yPos, float _zPos) /// @ingroup UTILITY_API /// @brief It is a function that sets the position of the wind. /// @param _xPos : Position along the X-axis. /// @param _yPos : Position along the Y-axis. /// @param _zPos : Position along the Z-axis. .. tabs:: .. code-tab:: python def GetWindPosition() -> list[float] """ @ingroup UTILITY_API @brief It is a function that gets the position of the wind. @return It returns a vector of three floats representing the position along the X, Y, and Z axes. """ .. code-tab:: c++ GetWindPosition() /// @ingroup UTILITY_API /// @brief It is a function that gets the position of the wind. /// @return It returns a vector of three floats representing the position along the X, Y, and Z axes. .. tabs:: .. code-tab:: python def CopyGraphicStyle(_graphicStyleIndex : int) -> int """ @ingroup UTILITY_API @brief Creates an independent copy of the specified graphic style and adds it to the graphic style library. Use this before placing the same graphic on multiple pattern pieces so that resizing one does not affect the others. @param _graphicStyleIndex: Index of the graphic style to copy. @return Index of the newly created graphic style copy, or -1 on failure. """ .. code-tab:: c++ CopyGraphicStyle(int _graphicStyleIndex) /// @ingroup UTILITY_API /// @brief Creates an independent copy of the specified graphic style and adds it to the graphic style library. /// Use this before placing the same graphic on multiple pattern pieces so that resizing one does not affect the others. /// @param _graphicStyleIndex: Index of the graphic style to copy. /// @return Index of the newly created graphic style copy, or -1 on failure. .. tabs:: .. code-tab:: python def UnlinkGraphicStyleAllColorways(_graphicStyleIndex : int) -> bool """ @ingroup UTILITY_API @brief Unlinks the specified graphic style across all colorways so that each colorway holds an independent copy. After calling this, modifying the graphic style in one colorway will not affect other colorways. @param _graphicStyleIndex: Index of the graphic style to unlink. @return true if the unlink succeeded; otherwise false. """ .. code-tab:: c++ UnlinkGraphicStyleAllColorways(int _graphicStyleIndex) /// @ingroup UTILITY_API /// @brief Unlinks the specified graphic style across all colorways so that each colorway holds an independent copy. /// After calling this, modifying the graphic style in one colorway will not affect other colorways. /// @param _graphicStyleIndex: Index of the graphic style to unlink. /// @return true if the unlink succeeded; otherwise false. .. tabs:: .. code-tab:: python def SetGraphicStyleBaseColorMapTextureDesaturation(_graphicStyleIndex : int, _colorwayIndex : int, _bSetOnOff : bool) -> None """ @ingroup UTILITY_API @brief Turns the desaturation (grayscale) on or off for the base color map texture of the specified graphic style in the specified colorway @param _graphicStyleIndex: The graphic style index to apply the desaturation setting @param _colorwayIndex: The colorway index to apply the desaturation setting @param _bSetOnOff: true to enable desaturation, false to disable """ .. code-tab:: c++ SetGraphicStyleBaseColorMapTextureDesaturation(int _graphicStyleIndex, int _colorwayIndex, bool _bSetOnOff) /// @ingroup UTILITY_API /// @brief Turns the desaturation (grayscale) on or off for the base color map texture of the specified graphic style in the specified colorway /// @param _graphicStyleIndex: The graphic style index to apply the desaturation setting /// @param _colorwayIndex: The colorway index to apply the desaturation setting /// @param _bSetOnOff: true to enable desaturation, false to disable .. tabs:: .. code-tab:: python def AddGraphicStyleToPatternV2(_patternIndex : int, _graphicStyleIndex : int, _x : float, _y : float, _width : float, _height : float, _face : int, _zOffset : float, _fAngle : float) -> str """ @ingroup UTILITY_API @brief Add Graphic Style to Pattern and return result as JSON-like map @param _patternIndex: pattern index to add graphic style @param _graphicStyleIndex: graphic style index to add to pattern @param _x: The values along the X-axis represent the horizontal position relative to this point, moving to the right. @param _y: The values along the Y-axis represent the vertical position relative to this point, moving downward. For example, in a 100x100 pattern, the bottom-right corner is located at (100, 100) Place the graphic so that its center aligns with the specified (X, Y) coordinates. @param _width: Width of the graphic @param _height: Height of the graphic @param _face: 0: Front, 1: Back 2: Both @param _zOffset: offset value @param _fAngle: angle value @return A string containing "status" ("success" or "failure") and "message" with details """ .. code-tab:: c++ AddGraphicStyleToPatternV2(int _patternIndex, int _graphicStyleIndex, float _x, float _y, float _width, float _height, int _face, float _zOffset, float _fAngle) /// @ingroup UTILITY_API /// @brief Add Graphic Style to Pattern and return result as JSON-like map /// @param _patternIndex: pattern index to add graphic style /// @param _graphicStyleIndex: graphic style index to add to pattern /// @param _x: The values along the X-axis represent the horizontal position relative to this point, moving to the right. /// @param _y: The values along the Y-axis represent the vertical position relative to this point, moving downward. /// For example, in a 100x100 pattern, the bottom-right corner is located at (100, 100) /// Place the graphic so that its center aligns with the specified (X, Y) coordinates. /// @param _width: Width of the graphic /// @param _height: Height of the graphic /// @param _face: 0: Front, 1: Back 2: Both /// @param _zOffset: offset value /// @param _fAngle: angle value /// @return A string containing "status" ("success" or "failure") and "message" with details .. tabs:: .. code-tab:: python def RemoveGraphicStyle(_graphicIndex : int) -> str """ @ingroup UTILITY_API @brief Backward-compatible overload. Removes a graphic style from the current colorway's graphic list with no pattern removal. Equivalent to RemoveGraphicStyle(GetCurrentColorwayIndex(), _graphicIndex, -1, 0). @param _graphicIndex: The index of the graphic style to remove. @return JSON string containing "status" ("Success" or "Failed") and "message" with contextual details. """ .. code-tab:: c++ RemoveGraphicStyle(int _graphicIndex) /// @ingroup UTILITY_API /// @brief Backward-compatible overload. Removes a graphic style from the current colorway's graphic list with no pattern removal. /// Equivalent to RemoveGraphicStyle(GetCurrentColorwayIndex(), _graphicIndex, -1, 0). /// @param _graphicIndex: The index of the graphic style to remove. /// @return JSON string containing "status" ("Success" or "Failed") and "message" with contextual details. .. tabs:: .. code-tab:: python def RemoveGraphicStyle(_colorwayIndex : int, _graphicIndex : int, _styleChipIndex : int, _overrideMode : int) -> str """ @ingroup UTILITY_API @brief Removes a graphic style at the specified index with configurable deletion targets. @param _colorwayIndex: Target colorway index (0 to N-1 for specific colorway's graphic list, -1 for the all-colorways graphic list). @param _graphicIndex: The index into the selected graphic list. @param _styleChipIndex: Colorway context when _colorwayIndex is -1. Ignored when _colorwayIndex >= 0. @param _overrideMode: Deletion target mode (Marvelous::GraphicRemoveMode). 0 = GRAPHIC_REMOVE_BROWSER_ONLY (remove from Object Browser only; fails if graphic is applied to a pattern), 1 = GRAPHIC_REMOVE_PATTERN_ONLY (remove from pattern, retain in Object Browser), 2 = GRAPHIC_REMOVE_PATTERN_AND_BROWSER (delete from both pattern and Object Browser). @return JSON string containing "status" ("Success" or "Failed") and "message" with contextual details. """ .. code-tab:: c++ RemoveGraphicStyle(int _colorwayIndex, int _graphicIndex, int _styleChipIndex, int _overrideMode) /// @ingroup UTILITY_API /// @brief Removes a graphic style at the specified index with configurable deletion targets. /// @param _colorwayIndex: Target colorway index (0 to N-1 for specific colorway's graphic list, -1 for the all-colorways graphic list). /// @param _graphicIndex: The index into the selected graphic list. /// @param _styleChipIndex: Colorway context when _colorwayIndex is -1. Ignored when _colorwayIndex >= 0. /// @param _overrideMode: Deletion target mode (Marvelous::GraphicRemoveMode). /// 0 = GRAPHIC_REMOVE_BROWSER_ONLY (remove from Object Browser only; fails if graphic is applied to a pattern), /// 1 = GRAPHIC_REMOVE_PATTERN_ONLY (remove from pattern, retain in Object Browser), /// 2 = GRAPHIC_REMOVE_PATTERN_AND_BROWSER (delete from both pattern and Object Browser). /// @return JSON string containing "status" ("Success" or "Failed") and "message" with contextual details. .. tabs:: .. code-tab:: python def GenerateZippersFromObj(_outputFilePathWithExt : str, _options : ObjRegisterOptions, _zipperIndex : int) -> bool """ @ingroup UTILITY_API @brief Generates a zipper part asset file from one or two OBJ files, mirroring the full "Register OBJ" dialog (DialogRegisterZipperObject) without any UI interaction. Supports all 7 object types: - 0: ZIPPER_OBJECT_SLIDER → .zsl (single OBJ, single shape) - 1: ZIPPER_OBJECT_PULLER → .zpu (single OBJ, single shape) - 2: ZIPPER_OBJECT_SLIDER_PULLER → .zss (single OBJ, dual shape; mesh auto-assignment fallback) - 3: ZIPPER_OBJECT_TEETH → .zth (single OBJ, fixed internal axes) - 4: ZIPPER_OBJECT_TOP_STOPPER → .zst (dual OBJ, dual shape) - 5: ZIPPER_OBJECT_BOTTOM_OPEN_STOPPER → .zst (dual OBJ, dual shape) - 6: ZIPPER_OBJECT_BOTTOM_CLOSED_STOPPER → .zst (single OBJ, single shape) For ZIPPER_OBJECT_SLIDER_PULLER, mesh assignment follows this fallback hierarchy: 1. User Explicit: OBJ group names listed in ObjRegisterOptions::sliderMeshNames / pullerMeshNames. 2. CLO Default: mesh names containing "slider" or "puller" (case-insensitive). 3. Dimensional: the mesh with the larger bounding-box extent is classified as Puller. 4. Alphabetical: sorted names; index 0 = Slider, index 1 = Puller. NOTE: ZIPPER_OBJECT_TEETH ignores user-defined axis settings (axes are fixed internally). @param _outputFilePathWithExt: Full output file path including the extension matching the object type. @param _options: Full set of registration options (see ObjRegisterOptions). @param _zipperIndex: Index of the zipper style in the Object Browser to assign the registered file to after saving. -1 = do not assign. @return true on success; false if validation fails, OBJ loading fails, or saving fails. """ .. code-tab:: c++ GenerateZippersFromObj(const std::string& _outputFilePathWithExt, const Marvelous::ObjRegisterOptions& _options) /// @ingroup UTILITY_API /// @brief Generates a zipper part asset file from one or two OBJ files, mirroring the full /// "Register OBJ" dialog (DialogRegisterZipperObject) without any UI interaction. /// Supports all 7 object types: /// - 0: ZIPPER_OBJECT_SLIDER → .zsl (single OBJ, single shape) /// - 1: ZIPPER_OBJECT_PULLER → .zpu (single OBJ, single shape) /// - 2: ZIPPER_OBJECT_SLIDER_PULLER → .zss (single OBJ, dual shape; mesh auto-assignment fallback) /// - 3: ZIPPER_OBJECT_TEETH → .zth (single OBJ, fixed internal axes) /// - 4: ZIPPER_OBJECT_TOP_STOPPER → .zst (dual OBJ, dual shape) /// - 5: ZIPPER_OBJECT_BOTTOM_OPEN_STOPPER → .zst (dual OBJ, dual shape) /// - 6: ZIPPER_OBJECT_BOTTOM_CLOSED_STOPPER → .zst (single OBJ, single shape) /// For ZIPPER_OBJECT_SLIDER_PULLER, mesh assignment follows this fallback hierarchy: /// 1. User Explicit: OBJ group names listed in ObjRegisterOptions::sliderMeshNames / pullerMeshNames. /// 2. CLO Default: mesh names containing "slider" or "puller" (case-insensitive). /// 3. Dimensional: the mesh with the larger bounding-box extent is classified as Puller. /// 4. Alphabetical: sorted names; index 0 = Slider, index 1 = Puller. /// NOTE: ZIPPER_OBJECT_TEETH ignores user-defined axis settings (axes are fixed internally). /// @param _outputFilePathWithExt: Full output file path including the extension matching the object type. /// @param _options: Full set of registration options (see ObjRegisterOptions). /// @param _zipperIndex: Index of the zipper style in the Object Browser to assign the registered file to after saving. -1 = do not assign. /// @return true on success; false if validation fails, OBJ loading fails, or saving fails. .. tabs:: .. code-tab:: python def SetMaterialTextureTransformations(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, propertyEditorContextOptions : PropertyEditorContextOptions, transformOptions : TransformOptions) -> None """ @ingroup UTILITY_API @brief Sets the texture transformation of the targeted object's material map. Routes to the matching per-type implementation based on browserContextOptions.type. Currently backs OB_TYPE_FABRIC and OB_TYPE_GRAPHIC; other types are accepted but no-op until their per-type backend exists. @param colorwayIndex: target colorway index (0 to n-1; -1 uses the current colorway). @param objectIndex: index of the targeted object within its Object Browser category. @param browserContextOptions: Object Browser context (type, print vs base color, style-chip / sub-item, folder). @param propertyEditorContextOptions: Property Editor context (material side, target texture map). @param transformOptions: the texture transformation to apply. """ .. code-tab:: c++ SetMaterialTextureTransformations(int colorwayIndex, int objectIndex, const ObjectBrowserContextOptions& browserContextOptions, const PropertyEditorContextOptions& propertyEditorContextOptions, const TransformOptions& transformOptions) /// @ingroup UTILITY_API /// @brief Sets the texture transformation of the targeted object's material map. Routes to the matching /// per-type implementation based on browserContextOptions.type. Currently backs OB_TYPE_FABRIC and /// OB_TYPE_GRAPHIC; other types are accepted but no-op until their per-type backend exists. /// @param colorwayIndex: target colorway index (0 to n-1; -1 uses the current colorway). /// @param objectIndex: index of the targeted object within its Object Browser category. /// @param browserContextOptions: Object Browser context (type, print vs base color, style-chip / sub-item, folder). /// @param propertyEditorContextOptions: Property Editor context (material side, target texture map). /// @param transformOptions: the texture transformation to apply. .. tabs:: .. code-tab:: python def GetMaterialTextureTransformations(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, propertyEditorContextOptions : PropertyEditorContextOptions) -> TransformOptions """ @ingroup UTILITY_API @brief Gets the current texture transformation of the targeted object's material map. @return TransformOptions for the targeted texture. Returns an identity transform if it cannot be resolved. """ .. code-tab:: c++ GetMaterialTextureTransformations(int colorwayIndex, int objectIndex, const ObjectBrowserContextOptions& browserContextOptions, const PropertyEditorContextOptions& propertyEditorContextOptions) /// @ingroup UTILITY_API /// @brief Gets the current texture transformation of the targeted object's material map. /// @return TransformOptions for the targeted texture. Returns an identity transform if it cannot be resolved. .. tabs:: .. code-tab:: python def SetMaterialProperties(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, materialContextProperties : MaterialPropertyOptions, newValues : MaterialPropertyOptions) -> str """ @ingroup UTILITY_API @brief Applies newValues to the material of the target object. The object is located via colorwayIndex, objectIndex and browserContextOptions; the active component tab / mapping / type is taken from materialContextProperties.contextOptions. @param colorwayIndex: target colorway index (0 to n-1; -1 uses the current colorway). @param objectIndex: index of the targeted object within its Object Browser category. @param browserContextOptions: Object Browser context locating the object (type, sub-item, style-chip...). @param materialContextProperties: carries contextOptions (targetComponent / textureMappingType / printType / materialType) that selects which component tab the write applies to. @param newValues: the material property values to write. @return JSON string: {"status": "success"|"error", "message": "..."}. Context mismatches and invalid states are reported in the message rather than thrown across the binding boundary. @note Supported object types: Fabric (targetComponent Front/Back/Side) and Button (Button/Thread). All other supported types are single-faced with no component tabs (targetComponent = COMPONENT_NONE) and map onto the 'front' face stack: Graphic, Buttonhole and Puckering (subItemIndex unused); Trim (subItemIndex = trim mesh index); Top-stitch (subItemIndex = stitch line index); Zipper (subItemIndex = zipper mesh index). """ .. code-tab:: c++ SetMaterialProperties(int colorwayIndex, int objectIndex, const ObjectBrowserContextOptions& browserContextOptions, const MaterialPropertyOptions& materialContextProperties, const MaterialPropertyOptions& newValues) /// @ingroup UTILITY_API /// @brief Applies newValues to the material of the target object. The object is located via colorwayIndex, /// objectIndex and browserContextOptions; the active component tab / mapping / type is taken from /// materialContextProperties.contextOptions. /// @param colorwayIndex: target colorway index (0 to n-1; -1 uses the current colorway). /// @param objectIndex: index of the targeted object within its Object Browser category. /// @param browserContextOptions: Object Browser context locating the object (type, sub-item, style-chip...). /// @param materialContextProperties: carries contextOptions (targetComponent / textureMappingType / printType /// / materialType) that selects which component tab the write applies to. /// @param newValues: the material property values to write. /// @return JSON string: {"status": "success"|"error", "message": "..."}. Context mismatches and invalid /// states are reported in the message rather than thrown across the binding boundary. /// @note Supported object types: Fabric (targetComponent Front/Back/Side) and Button (Button/Thread). All other /// supported types are single-faced with no component tabs (targetComponent = COMPONENT_NONE) and map /// onto the 'front' face stack: Graphic, Buttonhole and Puckering (subItemIndex unused); Trim /// (subItemIndex = trim mesh index); Top-stitch (subItemIndex = stitch line index); Zipper /// (subItemIndex = zipper mesh index). .. tabs:: .. code-tab:: python def GetMaterialProperties(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, materialContextProperties : MaterialPropertyOptions) -> MaterialPropertyOptions """ @ingroup UTILITY_API @brief Returns the current material properties for the active context (e.g. a Button's "Thread" tab vs its "Button" tab). Only materialContextProperties.contextOptions is read from the input. @param colorwayIndex: target colorway index (0 to n-1; -1 uses the current colorway). @param objectIndex: index of the targeted object within its Object Browser category. @param browserContextOptions: Object Browser context locating the object. @param materialContextProperties: only its contextOptions is used, to select the component tab to read. @return MaterialPropertyOptions for the active context. On an unresolved or mismatched context a default MaterialPropertyOptions (echoing the requested contextOptions) is returned. @note Supported object types: Fabric (targetComponent Front/Back/Side) and Button (Button/Thread). All other supported types are single-faced with no component tabs (targetComponent = COMPONENT_NONE) and report on the 'front' face stack: Graphic, Buttonhole and Puckering (subItemIndex unused); Trim (subItemIndex = trim mesh index); Top-stitch (subItemIndex = stitch line index). """ .. code-tab:: c++ GetMaterialProperties(int colorwayIndex, int objectIndex, const ObjectBrowserContextOptions& browserContextOptions, const MaterialPropertyOptions& materialContextProperties) /// @ingroup UTILITY_API /// @brief Returns the current material properties for the active context (e.g. a Button's "Thread" tab vs its /// "Button" tab). Only materialContextProperties.contextOptions is read from the input. /// @param colorwayIndex: target colorway index (0 to n-1; -1 uses the current colorway). /// @param objectIndex: index of the targeted object within its Object Browser category. /// @param browserContextOptions: Object Browser context locating the object. /// @param materialContextProperties: only its contextOptions is used, to select the component tab to read. /// @return MaterialPropertyOptions for the active context. On an unresolved or mismatched context a default /// MaterialPropertyOptions (echoing the requested contextOptions) is returned. /// @note Supported object types: Fabric (targetComponent Front/Back/Side) and Button (Button/Thread). All other /// supported types are single-faced with no component tabs (targetComponent = COMPONENT_NONE) and report /// on the 'front' face stack: Graphic, Buttonhole and Puckering (subItemIndex unused); Trim /// (subItemIndex = trim mesh index); Top-stitch (subItemIndex = stitch line index). .. tabs:: .. code-tab:: python def GetMaterialPropertiesAsJson(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, materialContextProperties : MaterialPropertyOptions) -> str """ @ingroup UTILITY_API @brief JSON-returning duplicate of GetMaterialProperties. Resolves and reads the same material stack but returns it as a JSON string, so scripting clients can consume the full fabric material payload (base color, normal, displacement, opacity and reflection maps, each with their transformation) without binding the nested option structs. @param colorwayIndex: target colorway index (0 to n-1; -1 uses the current colorway). @param objectIndex: index of the targeted object within its Object Browser category. @param browserContextOptions: Object Browser context locating the object. @param materialContextProperties: only its contextOptions is used, to select the component tab to read. @return JSON string. On success: {"status":"success","properties":{...}} where "properties" mirrors the MaterialPropertyOptions struct (contextOptions, material_type, front/back/side stacks, physical_*). On an unresolved or mismatched context: {"status":"error","message":"..."}. """ .. code-tab:: c++ GetMaterialPropertiesAsJson(int colorwayIndex, int objectIndex, const ObjectBrowserContextOptions& browserContextOptions, const MaterialPropertyOptions& materialContextProperties) /// @ingroup UTILITY_API /// @brief JSON-returning duplicate of GetMaterialProperties. Resolves and reads the same material stack but /// returns it as a JSON string, so scripting clients can consume the full fabric material payload /// (base color, normal, displacement, opacity and reflection maps, each with their transformation) /// without binding the nested option structs. /// @param colorwayIndex: target colorway index (0 to n-1; -1 uses the current colorway). /// @param objectIndex: index of the targeted object within its Object Browser category. /// @param browserContextOptions: Object Browser context locating the object. /// @param materialContextProperties: only its contextOptions is used, to select the component tab to read. /// @return JSON string. On success: {"status":"success","properties":{...}} where "properties" mirrors the /// MaterialPropertyOptions struct (contextOptions, material_type, front/back/side stacks, physical_*). /// On an unresolved or mismatched context: {"status":"error","message":"..."}. .. tabs:: .. code-tab:: python def GetObjectBrowserContext() -> ObjectBrowserContextOptions """ @ingroup UTILITY_API @brief Reads the current Object Browser state into an ObjectBrowserContextOptions object. Aggregates the active tab (type), its scope (folderName), and the booleans (bIncludeUnusedObjects, bShowAllColorways) from the per-tab context store. In UI mode the active tab is resolved live; in headless mode it is the last tab applied via the setter. A never-set tab yields safe defaults. Callers should call this before mutating + re-applying. @return The aggregated ObjectBrowserContextOptions for the active tab (safe defaults if unset). """ .. code-tab:: c++ GetObjectBrowserContext() /// @ingroup UTILITY_API /// @brief Reads the current Object Browser state into an ObjectBrowserContextOptions object. /// Aggregates the active tab (type), its scope (folderName), and the booleans /// (bIncludeUnusedObjects, bShowAllColorways) from the per-tab context store. In UI mode the /// active tab is resolved live; in headless mode it is the last tab applied via the setter. /// A never-set tab yields safe defaults. Callers should call this before mutating + re-applying. /// @return The aggregated ObjectBrowserContextOptions for the active tab (safe defaults if unset). .. tabs:: .. code-tab:: python def SetObjectBrowserContext(options : ObjectBrowserContextOptions) -> None """ @ingroup UTILITY_API @brief Applies an Object Browser context. The state is always persisted per-tab (keyed by options.type) so subsequent getter calls return it; updating one tab never affects the other tabs' cached context. In UI mode the Object Browser additionally switches to the targeted tab. In headless mode no UI is touched (all UI access is guarded), preventing null-pointer crashes while still persisting the state internally. @param options: the Object Browser context to apply (type selects the target tab). """ .. code-tab:: c++ SetObjectBrowserContext(const ObjectBrowserContextOptions& options) /// @ingroup UTILITY_API /// @brief Applies an Object Browser context. The state is always persisted per-tab (keyed by /// options.type) so subsequent getter calls return it; updating one tab never affects the /// other tabs' cached context. In UI mode the Object Browser additionally switches to the /// targeted tab. In headless mode no UI is touched (all UI access is guarded), preventing /// null-pointer crashes while still persisting the state internally. /// @param options: the Object Browser context to apply (type selects the target tab). .. tabs:: .. code-tab:: python def SetAssetShareRoot(_shareRoot : str) -> None """ @ingroup UTILITY_API @brief Sets a FALLBACK base folder for resolving project-relative '///' paths, used only when no SetBasePath override is set AND no project is open. Resolution is a plain concatenation (NO directory search): '//Textures/texture.png' becomes '/Textures/texture.png', with the whole remainder appended (multi-level paths supported). Full/normal paths are unaffected. Pass an empty string to clear it. @param _shareRoot: the fallback base folder (a local folder or an already-mounted/UNC path). """ .. code-tab:: c++ SetAssetShareRoot(const std::string& _shareRoot) /// @ingroup UTILITY_API /// @brief Sets a FALLBACK base folder for resolving project-relative '///' paths, used only /// when no SetBasePath override is set AND no project is open. Resolution is a plain concatenation /// (NO directory search): '//Textures/texture.png' becomes '/Textures/texture.png', with /// the whole remainder appended (multi-level paths supported). Full/normal paths are unaffected. /// Pass an empty string to clear it. /// @param _shareRoot: the fallback base folder (a local folder or an already-mounted/UNC path). .. tabs:: .. code-tab:: python def GetAssetShareRoot() -> str """ @ingroup UTILITY_API @brief Returns the fallback base folder set by SetAssetShareRoot, or an empty string if none is set. """ .. code-tab:: c++ GetAssetShareRoot() /// @ingroup UTILITY_API /// @brief Returns the fallback base folder set by SetAssetShareRoot, or an empty string if none is set. .. tabs:: .. code-tab:: python def SetBasePath(_basePath : str) -> None """ @ingroup UTILITY_API @brief Sets the base folder used to resolve project-relative '///' paths on EXPORT/SAVE APIs. A path like '//USD/out.usd' then resolves to '/USD/out.usd' (the whole remainder is appended, so multi-level paths like '//A/B/C/out.usd' work too). Opening a project sets this automatically to the project's folder; call this to override it (e.g. in a headless script or to redirect output). Full/absolute paths are unaffected. Note: while a base is set, EVERY '//' path is treated as project-relative (never as a UNC server or home folder); pass a full/mounted path for those. '//' resolution applies to export/save paths only - IMPORT paths (e.g. ImportFile) are NOT resolved; pass a full path when importing. Pass an empty string to clear it. @param _basePath: the base folder, e.g. "C:/CLO/Test/Project". """ .. code-tab:: c++ SetBasePath(const std::string& _basePath) /// @ingroup UTILITY_API /// @brief Sets the base folder used to resolve project-relative '///' paths on EXPORT/SAVE /// APIs. A path like '//USD/out.usd' then resolves to '/USD/out.usd' (the whole remainder /// is appended, so multi-level paths like '//A/B/C/out.usd' work too). Opening a project sets this /// automatically to the project's folder; call this to override it (e.g. in a headless script or to /// redirect output). Full/absolute paths are unaffected. Note: while a base is set, EVERY '//' path /// is treated as project-relative (never as a UNC server or home folder); pass a full/mounted path /// for those. '//' resolution applies to export/save paths only - IMPORT paths (e.g. ImportFile) /// are NOT resolved; pass a full path when importing. Pass an empty string to clear it. /// @param _basePath: the base folder, e.g. "C:/CLO/Test/Project". .. tabs:: .. code-tab:: python def GetBasePath() -> str """ @ingroup UTILITY_API @brief Returns the base folder currently used for project-relative '//' path resolution, or an empty string if none is set. """ .. code-tab:: c++ GetBasePath() /// @ingroup UTILITY_API /// @brief Returns the base folder currently used for project-relative '//' path resolution, or an /// empty string if none is set. .. tabs:: .. code-tab:: python def GetAvatarMeasurements(_avatarIndex : int) -> list[CloApiAvatarMeasurement] """ @ingroup UTILITY_API @brief Gets all measurements (user measures and avatar-default resizing measurements) on the avatar at the given index. @param _avatarIndex: Zero-based index of the target avatar. @return List of measurements. Empty if no avatar is loaded or the index is out of range. """ .. code-tab:: c++ GetAvatarMeasurements(int _avatarIndex) /// @ingroup UTILITY_API /// @brief Gets all measurements (user measures and avatar-default resizing measurements) on the avatar at the given index. /// @param _avatarIndex: Zero-based index of the target avatar. /// @return List of measurements. Empty if no avatar is loaded or the index is out of range. .. tabs:: .. code-tab:: python def DrawInternalLinesAroundGraphic(_patternIndex : int, _placementPoints : CloApiGraphicPlacementPoints) -> CloApiInternalShape """ @ingroup UTILITY_API @brief Creates a closed internal shape tracing the boundary of a placed graphic, connecting _placementPoints' corners in order with straight internal lines (any polygon, not just rectangles). @param _patternIndex: The index of the pattern piece to draw the internal lines on. @param _placementPoints: Corners describing the boundary, in pattern-local 2D coordinates (e.g. from GetGraphicStylePlacementPoints with _is2D == true). At least 3 corners are required. @return The created boundary as GetInternalShapeInformation reports it — same name space, so the returned name can be passed straight to PlaceGraphicOnInternalShape — with its lines and their intersection points in pattern-local 2D coordinates. If the new boundary touches existing internal lines they are grouped into one shape, so the result can span more than the input corners. Empty CloApiInternalShape on failure. """ .. code-tab:: c++ DrawInternalLinesAroundGraphic(int _patternIndex, const Marvelous::CloApiGraphicPlacementPoints& _placementPoints) /// @ingroup UTILITY_API /// @brief Creates a closed internal shape tracing the boundary of a placed graphic, connecting /// _placementPoints' corners in order with straight internal lines (any polygon, not just rectangles). /// @param _patternIndex: The index of the pattern piece to draw the internal lines on. /// @param _placementPoints: Corners describing the boundary, in pattern-local 2D coordinates (e.g. from /// GetGraphicStylePlacementPoints with _is2D == true). At least 3 corners are required. /// @return The created boundary as GetInternalShapeInformation reports it — same name space, so the /// returned name can be passed straight to PlaceGraphicOnInternalShape — with its lines and their /// intersection points in pattern-local 2D coordinates. If the new boundary touches existing /// internal lines they are grouped into one shape, so the result can span more than the input /// corners. Empty CloApiInternalShape on failure. .. tabs:: .. code-tab:: python def PlaceTopstitchOnInternalLine(_colorwayIndex : int, _topStitchStyleIndex : int, _patternIndex : int, _line : CloApiLine, _anchorPoint : CloApiAnchorPoint) -> bool """ @ingroup UTILITY_API @brief Applies a topstitch style to the pattern's internal line located via _line and _anchorPoint. The internal line matching _line's endpoints is preferred; otherwise the one closest to _anchorPoint's reference point on _line is used, so this works whether the internal line exists yet or not. @param _colorwayIndex: Target colorway index (0 to colorway count - 1); topstitch geometry is shared across colorways (use SetTopStitchColor for per-colorway appearance). @param _topStitchStyleIndex: Index of the topstitch style in the Object Browser topstitch list. @param _patternIndex: The index of the pattern piece that owns the internal line. @param _line: The line geometry designating the target internal line, endpoints in pattern-local 2D coordinates (as returned by GetInternalShapeInformation / DrawInternalLinesAroundGraphic). @param _anchorPoint: Reference point on _line: corner anchors use the nearest endpoint, center/edge anchors use the midpoint. @return true if the topstitch was applied to an internal line, false otherwise. """ .. code-tab:: c++ PlaceTopstitchOnInternalLine(int _colorwayIndex, int _topStitchStyleIndex, int _patternIndex, const Marvelous::CloApiLine& _line, Marvelous::CloApiAnchorPoint _anchorPoint) /// @ingroup UTILITY_API /// @brief Applies a topstitch style to the pattern's internal line located via _line and _anchorPoint. /// The internal line matching _line's endpoints is preferred; otherwise the one closest to _anchorPoint's /// reference point on _line is used, so this works whether the internal line exists yet or not. /// @param _colorwayIndex: Target colorway index (0 to colorway count - 1); topstitch geometry is shared /// across colorways (use SetTopStitchColor for per-colorway appearance). /// @param _topStitchStyleIndex: Index of the topstitch style in the Object Browser topstitch list. /// @param _patternIndex: The index of the pattern piece that owns the internal line. /// @param _line: The line geometry designating the target internal line, endpoints in pattern-local 2D /// coordinates (as returned by GetInternalShapeInformation / DrawInternalLinesAroundGraphic). /// @param _anchorPoint: Reference point on _line: corner anchors use the nearest endpoint, center/edge /// anchors use the midpoint. /// @return true if the topstitch was applied to an internal line, false otherwise. .. tabs:: .. code-tab:: python def PlaceGraphicOnInternalShape(_colorwayIndex : int, _graphicStyleIndex : int, _shapeName : str, _face : int, _zOffset : float) -> bool """ @ingroup UTILITY_API @brief Places a graphic style so it fills the internal shape named _shapeName exactly, aligned to the shape's longest edge (aspect ratio is NOT preserved; works for irregular / non-rectangular shapes). @param _colorwayIndex: Target colorway index for resolving the graphic style. @param _graphicStyleIndex: Index of the graphic style in the Object Browser graphic list. @param _shapeName: Name of the internal shape to place the graphic on (e.g. "InternalShape_0", as returned by GetInternalShapeInformation / DrawInternalLinesAroundGraphic); the first pattern with a matching name is used, so names should be unique across the document. @param _face: 0: Front, 1: Back, 2: Both. @param _zOffset: Z offset value of the placed graphic. @return true if the graphic was placed successfully, false otherwise. """ .. code-tab:: c++ PlaceGraphicOnInternalShape(int _colorwayIndex, int _graphicStyleIndex, const std::string& _shapeName, int _face, float _zOffset) /// @ingroup UTILITY_API /// @brief Places a graphic style so it fills the internal shape named _shapeName exactly, aligned to the /// shape's longest edge (aspect ratio is NOT preserved; works for irregular / non-rectangular shapes). /// @param _colorwayIndex: Target colorway index for resolving the graphic style. /// @param _graphicStyleIndex: Index of the graphic style in the Object Browser graphic list. /// @param _shapeName: Name of the internal shape to place the graphic on (e.g. "InternalShape_0", as returned /// by GetInternalShapeInformation / DrawInternalLinesAroundGraphic); the first pattern with a matching /// name is used, so names should be unique across the document. /// @param _face: 0: Front, 1: Back, 2: Both. /// @param _zOffset: Z offset value of the placed graphic. /// @return true if the graphic was placed successfully, false otherwise. .. tabs:: .. code-tab:: python def GetIntersectionPoints(_lines : list[CloApiLine]) -> CloApiInternalShape """ @ingroup UTILITY_API @brief Finds the intersection point of every pair of the given lines. Parallel, collinear, and zero-length segments produce no intersection; touching endpoints count as one. Pure geometry computation; no scene data is read or modified. @param _lines: The line segments to evaluate. Renumbered from 0 if any lineNumber is negative or duplicated. @return A CloApiInternalShape with the (possibly renumbered) input lines and their intersection points. """ .. code-tab:: c++ GetIntersectionPoints(const std::vector& _lines) /// @ingroup UTILITY_API /// @brief Finds the intersection point of every pair of the given lines. Parallel, collinear, and /// zero-length segments produce no intersection; touching endpoints count as one. Pure geometry /// computation; no scene data is read or modified. /// @param _lines: The line segments to evaluate. Renumbered from 0 if any lineNumber is negative or duplicated. /// @return A CloApiInternalShape with the (possibly renumbered) input lines and their intersection points. .. tabs:: .. code-tab:: python def GetInternalShapeInformation(_patternIndex : int) -> list[CloApiInternalShape] """ @ingroup UTILITY_API @brief Groups a pattern's internal lines into disjoint shapes by connectivity: lines that intersect or touch within a small tolerance belong to the same shape. @param _patternIndex: The index of the pattern piece to analyze. @return Shapes named "InternalShape_0", "InternalShape_1", ... ordered by smallest contained line number, line endpoints in pattern-local 2D coordinates. Empty if the pattern is invalid or has no internal lines. """ .. code-tab:: c++ GetInternalShapeInformation(int _patternIndex) /// @ingroup UTILITY_API /// @brief Groups a pattern's internal lines into disjoint shapes by connectivity: lines that intersect or /// touch within a small tolerance belong to the same shape. /// @param _patternIndex: The index of the pattern piece to analyze. /// @return Shapes named "InternalShape_0", "InternalShape_1", ... ordered by smallest contained line number, /// line endpoints in pattern-local 2D coordinates. Empty if the pattern is invalid or has no internal lines. .. tabs:: .. code-tab:: python def GetObjectBrowserItems(objectBrowserContextOptions : ObjectBrowserContextOptions) -> str """ @brief Returns the Object Browser item list for a single asset type (one type per call), as a JSON string. The asset type is given by objectBrowserContextOptions.type; supported values are OB_TYPE_FABRIC, OB_TYPE_GRAPHIC, OB_TYPE_BUTTON, OB_TYPE_BUTTON_HOLE, OB_TYPE_TRIM, OB_TYPE_PUCKERING, OB_TYPE_ZIPPER, OB_TYPE_TOPSTITCH. The two filters are independent: showAllColorways (tri-state) scopes the "used" check - -1 (default) follows the app's UI "Show All Colorways" toggle, 0 forces the single colorway (colorwayIndex), 1 forces all colorways - and bIncludeUnusedObjects additionally keeps free/unused objects (not used by any colorway) when true. folderName is FABRIC-only: it scopes the result to one Object Browser folder. Empty = the primary/root folder; a non-empty name = that folder (an unknown name yields an empty list). It composes with the colorway filters and with bIncludePrints. bIncludePrints is FABRIC-only: when true the fabric response carries print info per fabric (see @return). @return JSON object string: { "ObjectType": "", "ObjectNameList": ["name", ...] }. An unsupported targetObjectType yields { "ObjectType": "", "ObjectNameList": [] }; an empty list is returned as []. FABRIC with bIncludePrints == true keeps the SAME top-level "ObjectNameList" key, but its entries are objects instead of plain names: { "ObjectType": "Fabric Prints", "ObjectNameList": [ { "Name": "" [, "PrintName": ""] }, ... ] }; the "PrintName" key is present only for fabrics that actually have a print. """ .. code-tab:: c++ GetObjectBrowserItems(const ObjectBrowserContextOptions& objectBrowserContextOptions) /// @brief Returns the Object Browser item list for a single asset type (one type per call), as a JSON string. /// The asset type is given by objectBrowserContextOptions.type; supported values are OB_TYPE_FABRIC, /// OB_TYPE_GRAPHIC, OB_TYPE_BUTTON, OB_TYPE_BUTTON_HOLE, OB_TYPE_TRIM, OB_TYPE_PUCKERING, OB_TYPE_ZIPPER, OB_TYPE_TOPSTITCH. The two filters are /// independent: showAllColorways (tri-state) scopes the "used" check - -1 (default) follows the app's UI /// "Show All Colorways" toggle, 0 forces the single colorway (colorwayIndex), 1 forces all colorways - and /// bIncludeUnusedObjects additionally keeps free/unused objects (not used by any colorway) when true. /// folderName is FABRIC-only: it scopes the result to one Object Browser folder. Empty = the primary/root /// folder; a non-empty name = that folder (an unknown name yields an empty list). It composes with the /// colorway filters and with bIncludePrints. /// bIncludePrints is FABRIC-only: when true the fabric response carries print info per fabric (see @return). /// @return JSON object string: { "ObjectType": "", "ObjectNameList": ["name", ...] }. An unsupported /// targetObjectType yields { "ObjectType": "", "ObjectNameList": [] }; an empty list is returned as []. /// FABRIC with bIncludePrints == true keeps the SAME top-level "ObjectNameList" key, but its entries are /// objects instead of plain names: { "ObjectType": "Fabric Prints", "ObjectNameList": [ { "Name": "" [, "PrintName": ""] }, ... ] }; /// the "PrintName" key is present only for fabrics that actually have a print.