API List
EXPORT_API
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.
"""
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.
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.
"""
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.
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.
"""
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.
def ExportZPrj() -> str
"""
@ingroup EXPORT_API
@brief Export ZPrj file
@return Output file path; output files will be created in CLO temporary folder.
"""
ExportZPrj()
/// @ingroup EXPORT_API
/// @brief Export ZPrj file
/// @return Output file path; output files will be created in CLO temporary folder.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def ExportOBJ() -> list[str]
"""
@ingroup EXPORT_API
@brief Export OBJ file
@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.
"""
ExportOBJ()
/// @ingroup EXPORT_API
/// @brief Export OBJ file
/// @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.
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.
"""
ExportOBJ(const std::string& _filePath)
/// @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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def ExportGLTF(_filePath : str, _options : ImportExportOption, _bGLBinary : bool) -> list[str]
"""
@ingroup EXPORT_API
@brief Export GLTF
@param _filePath: output file path
@param _options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog.
@param _bGLBinary: if true, exports as GLB (binary GLTF); if false, exports as GLTF
@return Output file paths.
"""
ExportGLTF(const std::string& _filePath, const Marvelous::ImportExportOption& _options, bool _bGLBinary)
/// @ingroup EXPORT_API
/// @brief Export GLTF
/// @param _filePath: output file path
/// @param _options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog.
/// @param _bGLBinary: if true, exports as GLB (binary GLTF); if false, exports as GLTF
/// @return Output file paths.
def ExportGLTFW(_filePath : str, _options : ImportExportOption, _bGLBinary : bool) -> list[str]
"""
@ingroup EXPORT_API
@brief Export GLTF (wide string variant)
@param _filePath: output file path
@param _options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog.
@param _bGLBinary: if true, exports as GLB (binary GLTF); if false, exports as GLTF
@return Output file paths.
"""
ExportGLTFW(const std::wstring& _filePath, const Marvelous::ImportExportOption& _options, bool _bGLBinary)
/// @ingroup EXPORT_API
/// @brief Export GLTF (wide string variant)
/// @param _filePath: output file path
/// @param _options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog.
/// @param _bGLBinary: if true, exports as GLB (binary GLTF); if false, exports as GLTF
/// @return Output file paths.
def ExportAlembic(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@ingroup EXPORT_API
@brief Export Alembic
@param _filePath: output file path
@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.
"""
ExportAlembic(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @ingroup EXPORT_API
/// @brief Export Alembic
/// @param _filePath: output file path
/// @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.
def ExportAlembicW(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@ingroup EXPORT_API
@brief Export Alembic (wide string variant)
@param _filePath: output file path
@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.
"""
ExportAlembicW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @ingroup EXPORT_API
/// @brief Export Alembic (wide string variant)
/// @param _filePath: output file path
/// @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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
ExportDXFW(const std::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.
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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.
"""
ExportThumbnail3D()
/// @ingroup EXPORT_API
/// @brief Export thumbnail of the current scene
/// @return Output file path: output files will be created in CLO temporary folder.
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.
"""
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.
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.
"""
ExportThumbnail3DW(const std::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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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.
"""
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.
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
"""
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
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
"""
GetTotalRenderImagePaths()
/// @ingroup EXPORT_API
/// @brief Get File name list for all the exported rendering images
/// @return all the rendered image file paths
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
"""
GetTotalRenderImagePathsW()
/// @ingroup EXPORT_API
/// @brief Get File name list for all the exported rendering images
/// @return all the rendered image file paths
def GetCurrentRenderImagePaths() -> list [ str ]
"""
@ingroup EXPORT_API
@brief Current Render Image paths
@return all current renderded image files paths per colorways
"""
GetCurrentRenderImagePaths()
/// @ingroup EXPORT_API
/// @brief Current Render Image paths
/// @return all current renderded image files paths per colorways
def GetCurrentRenderImagePathsW() -> list [ str ]
"""
@ingroup EXPORT_API
@brief Current Render Image paths
@return all current renderded image files paths per colorways
"""
GetCurrentRenderImagePathsW()
/// @ingroup EXPORT_API
/// @brief Current Render Image paths
/// @return all current renderded image files paths per colorways
def GetFileNameOnRenderingProperty() -> str
"""
@ingroup EXPORT_API
@return the output file names set on the Rendering Property in CLO
"""
GetFileNameOnRenderingProperty()
/// @ingroup EXPORT_API
/// @return the output file names set on the Rendering Property in CLO
def GetFileNameOnRenderingPropertyW() -> str
"""
@ingroup EXPORT_API
@return the output file names set on the Rendering Property in CLO
"""
GetFileNameOnRenderingPropertyW()
/// @ingroup EXPORT_API
/// @return the output file names set on the Rendering Property in CLO
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.
"""
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.
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.
"""
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.
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.
"""
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.
def ExportGarmentInformationToStream() -> str
"""
@ingroup EXPORT_API
@brief Export garment information in string
@return Garment Information stream in sstring
"""
ExportGarmentInformationToStream()
/// @ingroup EXPORT_API
/// @brief Export garment information in string
/// @return Garment Information stream in sstring
def ExportGarmentInformationToStreamW() -> str
"""
@ingroup EXPORT_API
@brief Export garment information in string as well as json file
@return Garment Information stream in wstring
"""
ExportGarmentInformationToStreamW()
/// @ingroup EXPORT_API
/// @brief Export garment information in string as well as json file
/// @return Garment Information stream in wstring
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
ExportGarmentInformationConfigDataToStream()
/// @ingroup EXPORT_API
/// Export garment information configuration data in string
/// @return Output stream for JSON data. If an error occurs, return empty string.
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 wstring.
"""
ExportGarmentInformationConfigDataToStreamW()
/// @ingroup EXPORT_API
/// Export garment information configuration data in string
/// @return Output stream for JSON data. If an error occurs, return empty wstring.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def ExportAnimationVideo(_filePath : str) -> 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.
"""
ExportAnimationVideo(const std::string& _filePath)
/// @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.
def ExportAnimationVideoW(_filePath : str) -> 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.
"""
ExportAnimationVideoW(const std::wstring& _filePath)
/// @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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def GetColorwayCount() -> int
"""
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
@ingroup EXPORT_API
@brief Get the number of colorways in the current garment loaded in CLO
@return total count of colorways
"""
GetColorwayCount()
/// ///////////////////////////////////////////////////////////////////
/// ///////////////////////////////////////////////////////////////////
/// @ingroup EXPORT_API
/// @brief Get the number of colorways in the current garment loaded in CLO
/// @return total count of colorways
def GetCurrentColorwayIndex() -> int
"""
@ingroup EXPORT_API
@brief Get the index of the current colorway in CLO
@return the current colorway index
"""
GetCurrentColorwayIndex()
/// @ingroup EXPORT_API
/// @brief Get the index of the current colorway in CLO
/// @return the current colorway index
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
"""
GetColorwayNameList()
/// @ingroup EXPORT_API
/// @brief Get all the colorway names for the current garment
/// @return the list of name of all colorways
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
"""
GetColorwayNameListW()
/// @ingroup EXPORT_API
/// @brief Get all the colorway names for the current garment
/// @return the list of name of all colorways
def GetAvatarCount() -> int
"""
@ingroup EXPORT_API
@brief Get the number of avatars loaded in CLO
@return total count of avatars
"""
GetAvatarCount()
/// @ingroup EXPORT_API
/// @brief Get the number of avatars loaded in CLO
/// @return total count of avatars
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
"""
GetAvatarNameList()
/// @ingroup EXPORT_API
/// @brief Get all the names of avatars loaded in CLO
/// @return the list of name of all avatars
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
"""
GetAvatarNameListW()
/// @ingroup EXPORT_API
/// @brief Get all the names of avatars loaded in CLO
/// @return the list of name of all avatars
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
"""
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
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.
"""
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.
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: pecifies the starting index position of the turntable.
@return Output file path list. If an error occurs, return empty string.
"""
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: pecifies the starting index position of the turntable.
/// @return Output file path list. If an error occurs, return empty string.
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: pecifies the starting index position of the turntable.
@return Output file path list. If an error occurs, return empty string.
"""
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: pecifies the starting index position of the turntable.
/// @return Output file path list. If an error occurs, return empty string.
def ExportGLB(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@ingroup EXPORT_API
@brief Export GLB
@param _filePath: output file path
@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.
"""
ExportGLB(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @ingroup EXPORT_API
/// @brief Export GLB
/// @param _filePath: output file path
/// @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.
def ExportGLBW(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@ingroup EXPORT_API
@brief Export GLB (wide string variant)
@param _filePath: output file path
@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.
"""
ExportGLBW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @ingroup EXPORT_API
/// @brief Export GLB (wide string variant)
/// @param _filePath: output file path
/// @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.
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.
"""
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.
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.
"""
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.
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.
"""
ExportPOMW(const std::wstring& _filePath)
/// @ingroup EXPORT_API
/// @brief Export POM
/// @param _filePath: output file path
/// @return Output file path. If an error occurs, return empty wstring.
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.
"""
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.
def ExportPOM(_bInclude3DLength : bool, _filePath : str) -> str
"""
@ingroup EXPORT_API
@brief Export POM
@param _filePath: output file path, _bInclude3DLength, true: include 3D info, false: exclude 3D info
@return Output file path. If an error occurs, return empty string.
"""
ExportPOM(bool _bInclude3DLength, const std::string& _filePath)
/// @ingroup EXPORT_API
/// @brief Export POM
/// @param _filePath: output file path, _bInclude3DLength, true: include 3D info, false: exclude 3D info
/// @return Output file path. If an error occurs, return empty string.
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.
"""
ExportPOMW(bool _bInclude3DLength, const std::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.
def ExportBOM(_filePath : str) -> bool
"""
@ingroup EXPORT_API
@brief Export BOM
@param _filePath: output file path
@return If an error occurs, return false.
"""
ExportBOM(const string& _filePath)
/// @ingroup EXPORT_API
/// @brief Export BOM
/// @param _filePath: output file path
/// @return If an error occurs, return false.
def ExportBOMW(_filePath : str) -> bool
"""
@ingroup EXPORT_API
@brief Export BOM
@param _filePath: output file path
@return If an error occurs, return false.
"""
ExportBOMW(const std::wstring& _filePath)
/// @ingroup EXPORT_API
/// @brief Export BOM
/// @param _filePath: output file path
/// @return If an error occurs, return false.
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.
"""
ExportGLTFWithDialog(const std::string& _filePath, bool _bGLBinary)
/// @ingroup EXPORT_API
/// @brief Export GLTF with Dialog
/// @param _filePath: output file path
/// @return Output file paths.
def ExportGLBWithDialog(_filePath : str) -> list[str]
"""
@ingroup EXPORT_API
@brief Export GLB with Dialog
@param _filePath: output file path
@return Output file paths.
"""
ExportGLBWithDialog(const string& _filePath)
/// @ingroup EXPORT_API
/// @brief Export GLB with Dialog
/// @param _filePath: output file path
/// @return Output file paths.
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.
"""
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.
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.
"""
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.
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.
"""
ExportThumbnail3DWByColorwayIndexW(const std::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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
ExportPose()
/// @ingroup EXPORT_API
/// @brief Export Pose 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.
def ExportPose(_filePath : str) -> str
"""
@ingroup EXPORT_API
@brief Export Pose file
@param _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.
"""
ExportPose(const string& _filePath)
/// @ingroup EXPORT_API
/// @brief Export Pose file
/// @param _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.
def ExportPoseW(_filePath : str) -> str
"""
@ingroup EXPORT_API
@brief Export Pose file
@param _filePath: target file path in UNICODE
@return Output file path. If an error occurs, return empty wstring. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
ExportPoseW(const wstring& _filePath)
/// @ingroup EXPORT_API
/// @brief Export Pose file
/// @param _filePath: target file path in UNICODE
/// @return Output file path. If an error occurs, return empty wstring. If filePath parameter is not given, output files will be created in CLO temporary folder.
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. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
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. If filePath parameter is not given, output files will be created in CLO temporary folder.
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.
"""
ExportFBX(const std::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.
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.
"""
ExportFBXW(const std::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.
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.
"""
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.
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 wstring.
"""
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 wstring.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
ConvertZblcToZmod(const std::vector<std::wstring>& _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.
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.
"""
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.
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. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
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. If filePath parameter is not given, output files will be created in CLO temporary folder.
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.
"""
ExportUSD(const std::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.
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.
"""
ExportUSDW(const std::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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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
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.
"""
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.
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.
"""
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.
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..
"""
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..
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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. .
"""
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. .
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.
"""
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.
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. .
"""
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. .
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
AssignFabricToPattern(unsigned int _fabricIndex, unsigned int _patternIndex, int _assignOption)
/// @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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
ApplyXtexFileW(unsigned int fabricIndex, const std::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.
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.
"""
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.
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.
"""
ApplyXtexFileW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::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.
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
@return if it succeeds, return true.
"""
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
/// @return if it succeeds, return true.
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.
"""
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.
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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 string format
@return if it succeeds, return true
"""
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 string format
/// @return if it succeeds, return true
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
"""
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
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 string format
@return if it succeeds, return true
"""
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 string format
/// @return if it succeeds, return true
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
"""
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
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
"""
ChangeMetaDataValueForFabric(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
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
"""
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
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
"""
ChangeMetaDataValueForFabric(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
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
"""
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
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
"""
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
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.
"""
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.
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
"""
GetFabricIndex(int _colorwayIndex, const std::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
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
"""
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
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
"""
GetFabricIndexW(int _colorwayIndex, const std::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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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)
"""
SetFabricInformation(int _fabricIndex, const std::map<string, string> _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)
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)
"""
SetFabricInformationW(int _fabricIndex, const std::map<std::wstring, std::wstring>& _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)
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)
"""
SetFabricInformation(int _colorwayIndex, int _fabricIndex, const std::map<string, string> _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)
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)
"""
SetFabricInformationW(int _colorwayIndex, int _fabricIndex, const std::map<std::wstring, std::wstring>& _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)
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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)
"""
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)
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)
"""
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)
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)
"""
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)
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)
"""
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)
def GetPrimaryFabric() -> int
"""
@ingroup FABRIC_API
@brief Return the fabric index used for a major number of the patterns
"""
GetPrimaryFabric()
/// @ingroup FABRIC_API
/// @brief Return the fabric index used for a major number of the patterns
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
"""
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
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
"""
SetFabricNameW(unsigned int index, const std::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
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
"""
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
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
"""
SetFabricNameW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::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
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
"""
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
def GetFabricStyleNameList() -> list[str]
"""
@ingroup FABRIC_API
@brief Return all fabric style name
"""
GetFabricStyleNameList()
/// @ingroup FABRIC_API
/// @brief Return all fabric style name
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
GetFabricWidth(int fabricIndex)
/// @ingroup FABRIC_API
/// @brief Get Fabric width (mm)
/// @param fabricIndex: the target fabric index in the object browser
/// @return fabric width
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
"""
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
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
"""
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
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
"""
SetFabricWidth(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
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
"""
GetFabricLength(int fabricIndex)
/// @ingroup FABRIC_API
/// @brief Get Fabric Length (mm)
/// @param fabricIndex: the target fabric index in the object browser
/// @return Fabric Length
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
"""
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
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"
@return void
"""
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"
/// @return void
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"
@return void
"""
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"
/// @return void
def SetSubstancePreset(fabricIndex : int, materialFace : int, presetIndex : int) -> None
"""
@ingroup FABRIC_API
@brief Set Substance preset for a fabric material face
@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
@return void
"""
SetSubstancePreset(unsigned int fabricIndex, int materialFace, int preset)
/// @ingroup FABRIC_API
/// @brief Set Substance preset for a fabric material face
/// @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
/// @return void
def SetSubstancePreset(colorwayIndex : int, fabricIndex : int, materialFace : int, presetIndex : int) -> None
"""
@ingroup FABRIC_API
@brief Set Substance preset for a fabric material face in a specific colorway
@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
@return void
"""
SetSubstancePreset(unsigned int colorwayIndex,unsigned int fabricIndex, int materialFace, int preset)
/// @ingroup FABRIC_API
/// @brief Set Substance preset for a fabric material face in a specific colorway
/// @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
/// @return void
def SetSubstanceResolution(fabricIndex : int, materialFace : int, resolutionIndex : int) -> None
"""
@ingroup FABRIC_API
@brief Set Substance texture resolution for a fabric material face
@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
@return void
"""
SetSubstanceResolution(unsigned int fabricIndex, int materialFace, int resolution)
/// @ingroup FABRIC_API
/// @brief Set Substance texture resolution for a fabric material face
/// @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
/// @return void
def SetSubstanceResolution(colorwayIndex : int, fabricIndex : int, materialFace : int, resolutionIndex : int) -> None
"""
@ingroup FABRIC_API
@brief Set Substance texture resolution for a fabric material face in a specific colorway
@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
@return void
"""
SetSubstanceResolution(unsigned int colorwayIndex,unsigned int fabricIndex, int materialFace, int resolution)
/// @ingroup FABRIC_API
/// @brief Set Substance texture resolution for a fabric material face in a specific colorway
/// @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
/// @return void
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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
@return void
"""
SetUseSameColorAsFront(unsigned int fabricIndex, int materialFace, bool _useSameMaterial)
/// @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
/// @return void
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
@return void
"""
SetUseSameColorAsFront(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace, bool _useSameMaterial)
/// @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
/// @return void
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
def SetCurrentFabricIndex(_index : int) -> bool
"""
@ingroup FABRIC_API
@brief Set Current Fabric Index
@param _index: Fabric Index
@return Fabric setting success or failure return
"""
SetCurrentFabricIndex(int _index)
/// @ingroup FABRIC_API
/// @brief Set Current Fabric Index
/// @param _index: Fabric Index
/// @return Fabric setting success or failure return
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
"""
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
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
"""
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
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
"""
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
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 mateiral Roughness Type. ( 0 : Intensity, 1 : Map )
"""
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 mateiral Roughness Type. ( 0 : Intensity, 1 : Map )
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 mateiral Roughness Type. ( 0 : Intensity, 1 : Map )
"""
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 mateiral Roughness Type. ( 0 : Intensity, 1 : Map )
def SetRoughnessType(_index : int, _materialFace : int, _roughnessType : int) -> None
"""
@ingroup FABRIC_API
@brief Set Current Fabric's mateiral 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
"""
SetRoughnessType(int _index, int _materialFace, int _roughnessType)
/// @ingroup FABRIC_API
/// @brief Set Current Fabric's mateiral 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
def SetRoughnessType(_colorwayIndex : int, _index : int, _materialFace : int, _roughnessType : int) -> None
"""
@ingroup FABRIC_API
@brief Set Current Fabric's mateiral 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
"""
SetRoughnessType(unsigned int _colorwayIndex, int _index, int _materialFace, int _roughnessType)
/// @ingroup FABRIC_API
/// @brief Set Current Fabric's mateiral 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
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def SetRoughnessValueMapInvert(_index : int, _face : int, _bInvert : bool) -> None
"""
@ingroup FABRIC_API
@brief SetS 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.
"""
void SetRoughnessValueMapInvert(int _index, int _face, bool _bInvert)
/// @ingroup FABRIC_API
/// @brief SetS 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.
def SetRoughnessValueMapInvert(_colorwayIndex : int, _index : int, _face : int, _bInvert : bool) -> None
"""
@ingroup FABRIC_API
@brief SetS 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.
"""
void SetRoughnessValueMapInvert(unsigned int _colorwayIndex, int _index, int _face, bool _bInvert)
/// @ingroup FABRIC_API
/// @brief SetS 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.
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.
"""
SetPBRMaterialDisplacementMap(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.
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.
"""
SetPBRMaterialDisplacementMap(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.
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.
"""
std::tuple<float, float, float, float, bool> 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.
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.
"""
std::tuple<float, float, float, float, bool> 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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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 to set
@return void
"""
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 to set
/// @return void
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 to set
@return void
"""
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 to set
/// @return void
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 opaicty intensity value
"""
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 opaicty intensity value
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 opaicty intensity value
"""
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 opaicty intensity value
def SetOpacityIntensity(_fabricIndex : int, _materialFace : int, _opacityIntensity : float) -> None
"""
@ingroup FABRIC_API
@brief Set opaicty 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: opaicty intensity value
@return void
"""
SetOpacityIntensity(int _fabricIndex, int _materialFace, float _opacityIntensity)
/// @ingroup FABRIC_API
/// @brief Set opaicty 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: opaicty intensity value
/// @return void
def SetOpacityIntensity(_colorwayIndex : int, _fabricIndex : int, _materialFace : int, _opacityIntensity : float) -> None
"""
@ingroup FABRIC_API
@brief Set opaicty 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: opaicty intensity value
@return void
"""
SetOpacityIntensity(int _colorwayIndex, int _fabricIndex, int _materialFace, float _opacityIntensity)
/// @ingroup FABRIC_API
/// @brief Set opaicty 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: opaicty intensity value
/// @return void
def GetBaseTextureMapImageFilePath() -> str
"""
@ingroup FABRIC_API
@brief Get base texture map image file path of current selected fabric
@return image file path string
"""
GetBaseTextureMapImageFilePath()
/// @ingroup FABRIC_API
/// @brief Get base texture map image file path of current selected fabric
/// @return image file path string
def GetNormalMapImageFilePath() -> str
"""
@ingroup FABRIC_API
@brief Get normal map image file path of current selected fabric
@return image file path string
"""
GetNormalMapImageFilePath()
/// @ingroup FABRIC_API
/// @brief Get normal map image file path of current selected fabric
/// @return image file path string
def GetDisplacementMapImageFilePath() -> str
"""
@ingroup FABRIC_API
@brief Get displacement map image file path of current selected fabric
@return image file path string
"""
GetDisplacementMapImageFilePath()
/// @ingroup FABRIC_API
/// @brief Get displacement map image file path of current selected fabric
/// @return image file path string
def GetOpacityMapImageFilePath() -> str
"""
@ingroup FABRIC_API
@brief Get opacity map image file path of current selected fabric
@return image file path string
"""
GetOpacityMapImageFilePath()
/// @ingroup FABRIC_API
/// @brief Get opacity map image file path of current selected fabric
/// @return image file path string
def GetRoughnessMapImageFilePath() -> str
"""
@ingroup FABRIC_API
@brief Get roughness map image file path of current selected fabric
@return image file path string
"""
GetRoughnessMapImageFilePath()
/// @ingroup FABRIC_API
/// @brief Get roughness map image file path of current selected fabric
/// @return image file path string
def GetMetalnessMapImageFilePath() -> str
"""
@ingroup FABRIC_API
@brief Get metalness map image file path of current selected fabric
@return image file path string
"""
GetMetalnessMapImageFilePath()
/// @ingroup FABRIC_API
/// @brief Get metalness map image file path of current selected fabric
/// @return image file path string
def GetBaseTextureMapImageFilePathW() -> str
"""
@ingroup FABRIC_API
@brief Get base texture map image file path of current selected fabric
@return image file path wstring
"""
GetBaseTextureMapImageFilePathW()
/// @ingroup FABRIC_API
/// @brief Get base texture map image file path of current selected fabric
/// @return image file path wstring
def GetNormalMapImageFilePathW() -> str
"""
@ingroup FABRIC_API
@brief Get normal map image file path of current selected fabric
@return image file path wstring
"""
GetNormalMapImageFilePathW()
/// @ingroup FABRIC_API
/// @brief Get normal map image file path of current selected fabric
/// @return image file path wstring
def GetDisplacementMapImageFilePathW() -> str
"""
@ingroup FABRIC_API
@brief Get displacement map image file path of current selected fabric
@return image file path wstring
"""
GetDisplacementMapImageFilePathW()
/// @ingroup FABRIC_API
/// @brief Get displacement map image file path of current selected fabric
/// @return image file path wstring
def GetOpacityMapImageFilePathW() -> str
"""
@ingroup FABRIC_API
@brief Get opacity map image file path of current selected fabric
@return image file path wstring
"""
GetOpacityMapImageFilePathW()
/// @ingroup FABRIC_API
/// @brief Get opacity map image file path of current selected fabric
/// @return image file path wstring
def GetRoughnessMapImageFilePathW() -> str
"""
@ingroup FABRIC_API
@brief Get roughness map image file path of current selected fabric
@return image file path wstring
"""
GetRoughnessMapImageFilePathW()
/// @ingroup FABRIC_API
/// @brief Get roughness map image file path of current selected fabric
/// @return image file path wstring
def GetMetalnessMapImageFilePathW() -> str
"""
@ingroup FABRIC_API
@brief Get metalness map image file path of current selected fabric
@return image file path wstring
"""
GetMetalnessMapImageFilePathW()
/// @ingroup FABRIC_API
/// @brief Get metalness map image file path of current selected fabric
/// @return image file path wstring
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
ImportGLTFAsFabric(const std::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
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
"""
ImportGLTFAsFabricW(const std::wstring& _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
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
"""
ImportGLTFAsFabricW(const std::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
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
"""
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
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
"""
GetSpecificColorwayFabricInfoW(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
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
"""
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
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)
"""
GetSpecificColorwayFabricInfoW(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)
def GetFabricItemNo(_fabricIndex : int) -> str
"""
@ingroup FABRIC_API
@brief Get a fabric item number
@param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser
@return Item No string
"""
GetFabricItemNo(int _fabricIndex)
/// @ingroup FABRIC_API
/// @brief Get a fabric item number
/// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser
/// @return Item No string
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
"""
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
def GetFabricItemNoW(_fabricIndex : int) -> str
"""
@ingroup FABRIC_API
@brief Get a Fabric item NO
@param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser
@return Item No string
"""
GetFabricItemNoW(int _fabricIndex)
/// @ingroup FABRIC_API
/// @brief Get a Fabric item NO
/// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info in Object Browser
/// @return Item No string
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
"""
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
def SetFabricItemNo(_fabricIndex : int, _itemNo : str) -> bool
"""
@ingroup FABRIC_API
@brief Set a Fabric item NO
@param _fabricIndex: the fabricIndex for the fabric in Object Browser
@param _itemNo: the item number string to set
@return if it succeeds, return true.
"""
SetFabricItemNo(int _fabricIndex, const std::string& _itemNo)
/// @ingroup FABRIC_API
/// @brief Set a Fabric item NO
/// @param _fabricIndex: the fabricIndex for the fabric in Object Browser
/// @param _itemNo: the item number string to set
/// @return if it succeeds, return true.
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.
"""
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.
def SetFabricItemNoW(_fabricIndex : int, _itemNo : str) -> bool
"""
@ingroup FABRIC_API
@brief Set a Fabric item NO
@param _fabricIndex: the fabricIndex for the fabric in Object Browser
@param _itemNo: the item number string to set
@return if it succeeds, return true.
"""
SetFabricItemNoW(int _fabricIndex, const std::wstring& _itemNo)
/// @ingroup FABRIC_API
/// @brief Set a Fabric item NO
/// @param _fabricIndex: the fabricIndex for the fabric in Object Browser
/// @param _itemNo: the item number string to set
/// @return if it succeeds, return true.
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.
"""
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.
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 extracted SBSAR input data as a JSON string; empty string if an error occurs
"""
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 extracted SBSAR input data as a JSON string; empty string if an error occurs
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".
"""
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".
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
IMPORT_API
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def ImportVMP(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import VMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportVMP(const string& _filePath)
/// @ingroup IMPORT_API
/// @brief Import VMP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportVMPW(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import VMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportVMPW(const std::wstring& _filePath)
/// @ingroup IMPORT_API
/// @brief Import VMP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportCPT(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import CPT file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportCPT(const string& _filePath)
/// @ingroup IMPORT_API
/// @brief Import CPT file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportCPTW(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import CPT file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportCPTW(const std::wstring& _filePath)
/// @ingroup IMPORT_API
/// @brief Import CPT file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportVLP(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import VLP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportVLP(const string& _filePath)
/// @ingroup IMPORT_API
/// @brief Import VLP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportVLPW(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import VLP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportVLPW(const std::wstring& _filePath)
/// @ingroup IMPORT_API
/// @brief Import VLP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportVRP(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import VRP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportVRP(const string& _filePath)
/// @ingroup IMPORT_API
/// @brief Import VRP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportVRPW(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import VRP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportVRPW(const std::wstring& _filePath)
/// @ingroup IMPORT_API
/// @brief Import VRP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
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.
"""
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.
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.
"""
ImportDXFW(const std::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.
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.
"""
ImportGraphicStyleFromImage(const std::string& _filePath)
/// @ingroup IMPORT_API
/// @brief Import image file as graphic style
/// @param _filePath: input file path
/// @return if it succeeds, return true.
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.
"""
ImportGraphicStyleFromImage(const std::wstring& _filePath)
/// @ingroup IMPORT_API
/// @brief Import image file as graphic style
/// @param _filePath: input file path
/// @return if it succeeds, return true.
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.
"""
ImportAVAC(const std::wstring& _filePath, const std::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.
def ImportAVAC(_filePath : str, _apfFilePath : str) -> bool
"""
"""
ImportAVAC(_filePath, _apfFilePath)
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def ImportSMP(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import SMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportSMP(const string& _filePath)
/// @ingroup IMPORT_API
/// @brief Import SMP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportSMPW(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import SMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
ImportSMPW(const wstring& _filePath)
/// @ingroup IMPORT_API
/// @brief Import SMP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
def ImportAsGraphic(_filePath : str) -> None
"""
@ingroup IMPORT_API
@brief Import an image file as Graphic.
@param _filePath: input file path
"""
ImportAsGraphic(const std::string& _filePath)
/// @ingroup IMPORT_API
/// @brief Import an image file as Graphic.
/// @param _filePath: input file path
def ImportAsGraphicW(_filePath : str) -> None
"""
@ingroup IMPORT_API
@brief Import an image file as Graphic.
@param _filePath: input file path
"""
ImportAsGraphicW(const std::wstring& _filePath)
/// @ingroup IMPORT_API
/// @brief Import an image file as Graphic.
/// @param _filePath: input file path
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
"""
ImportTrim(const std::string& _filePath, const bool _bTranslateToOrigin)
/// @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
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
"""
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
def ImportAvatar(_avtPath : str, _opt : ImportExportOption) -> bool
"""
@ingroup IMPORT_API
@brief Import Avatar
@param _avtPath : input Avatar file path, _opt : input load options
"""
ImportAvatar(std::string _avtPath, ImportExportOption _opt)
/// @ingroup IMPORT_API
/// @brief Import Avatar
/// @param _avtPath : input Avatar file path, _opt : input load options
def ImportMeasurement(_csvPath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import Avatar Measurement CSV file
@param _csvPath: input CSV file path
"""
ImportMeasurement(std::string _csvPath)
/// @ingroup IMPORT_API
/// @brief Import Avatar Measurement CSV file
/// @param _csvPath: input CSV file path
def ImportPose(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import a pose/hand pose file.
@param _filePath: input file path
"""
ImportPose(const std::string& _filePath)
/// @ingroup IMPORT_API
/// @brief Import a pose/hand pose file.
/// @param _filePath: input file path
def ImportPoseW(_filePath : str) -> bool
"""
@ingroup IMPORT_API
@brief Import a pose/hand pose file.
@param _filePath: input file path
"""
ImportPose(const std::wstring& _filePath)
/// @ingroup IMPORT_API
/// @brief Import a pose/hand pose file.
/// @param _filePath: input file path
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
"""
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
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
"""
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
def ImportAlembic(filePath : str, option : ImportAlembicOption) -> bool
"""
@ingroup IMPORT_API
@brief Import an alembic (.abc) file.
@param filePath: input file path
@param option: import options for the alembic file
"""
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: import options for the alembic file
def ImportZpac(filePath : str, loadOption : ImportExportOption) -> bool
"""
@ingroup IMPORT_API
@brief Import Zpac file
@param filePath: input file path
@param loadOption: If given, it imports zpac according to options, not allowing user for selecting options in Import Dialog.
@return if it succeeds, return true.
"""
ImportZpac(const string& filePath, const Marvelous::ImportExportOption& loadOption)
/// @ingroup IMPORT_API
/// @brief Import Zpac file
/// @param filePath: input file path
/// @param loadOption: If given, it imports zpac according to options, not allowing user for selecting options in Import Dialog.
/// @return if it succeeds, return true.
PATTERN_API
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
"""
GetPatternSize()
/// @ingroup PATTERN_API
/// @brief Get the number of patterns
/// @return return the number of patterns on the pattern editor and avatar window
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
GetPatternCount()
/// @ingroup PATTERN_API
/// @brief Get the number of patterns
/// @return return the number of patterns on the pattern editor and avatar window
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
"""
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
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
"""
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
def GetPatternInputInformation() -> str
"""
@ingroup PATTERN_API
@brief Get the pattern input information which is using for pattern index
@return json string for pattern input information
"""
GetPatternInputInformation()
/// @ingroup PATTERN_API
/// @brief Get the pattern input information which is using for pattern index
/// @return json string for pattern input information
def GetPatternInputInformationW() -> str
"""
@ingroup PATTERN_API
@brief Get the pattern input information which is using for pattern index
@return json string for pattern input information
"""
GetPatternInputInformationW()
/// @ingroup PATTERN_API
/// @brief Get the pattern input information which is using for pattern index
/// @return json string for pattern input information
def GetPatternPieceArea(_patternIndex : int) -> float
"""
@ingroup PATTERN_API
@brief Get the pattern piece area which is using for pattern index
@return return pattern piece
"""
GetPatternPieceArea(int _patternIndex)
/// @ingroup PATTERN_API
/// @brief Get the pattern piece area which is using for pattern index
/// @return return pattern piece
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
"""
GetLineLength(int _patternIndex, int _lineIndex)
/// @ingroup PATTERN_API
/// @brief Get the pattern line length which is using for pattern index and line index
/// @return return line length
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
"""
GetLineLength(int _patternIndex, int _childrenIndex, int _lineIndex)
/// @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
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
def SetParticleDistanceOfPatterns(_length : float) -> None
"""
@ingroup PATTERN_API
@brief Set patterns particle distance using length
@param length: the length value to determine particle distance
"""
SetParticleDistanceOfPatterns(float _length)
/// @ingroup PATTERN_API
/// @brief Set patterns particle distance using length
/// @param length: the length value to determine particle distance
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
"""
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
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
"""
SetMeshTypeW(int _patternIndex, const std::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
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
"""
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
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 width shrinkage percentage
"""
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 width shrinkage percentage
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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 patternIndex: the pattern index for copying pattern
_offsetX, _offsetY : the value to determine pattern copy offset distance,
@return return copy pattern index
"""
CopyPatternPiecePos(int _patternPieceIndex, float _offsetX, float _offsetY)
/// @ingroup PATTERN_API
/// @brief Copy Pattern using the pattern index and x,y offset distance
/// @param patternIndex: the pattern index for copying pattern
/// _offsetX, _offsetY : the value to determine pattern copy offset distance,
/// @return return copy pattern index
def DeletePatternPiece(_patternIndex : int) -> None
"""
@ingroup PATTERN_API
@brief Delete Pattern using the pattern index
@param patternIndex: the pattern index for delete pattern
@return return copy pattern index
"""
DeletePatternPiece(int _patternPieceIndex)
/// @ingroup PATTERN_API
/// @brief Delete Pattern using the pattern index
/// @param patternIndex: the pattern index for delete pattern
/// @return return copy pattern index
def DeleteLine(_patternIndex : int, _lineIndex : int) -> None
"""
@ingroup PATTERN_API
@brief Delete Pattern using the pattern index
@param patternIndex: the pattern index for delete pattern
@param lineIndex: the line index for delete line
"""
DeleteLine(int _patternIndex, int _lineIndex)
/// @ingroup PATTERN_API
/// @brief Delete Pattern using the pattern index
/// @param patternIndex: the pattern index for delete pattern
/// @param lineIndex: the line index for delete line
def DeletePoint(_patternIndex : int, _poinIndex : int) -> None
"""
@ingroup PATTERN_API
@brief Delete Pattern using the pattern index
@param patternIndex: the pattern index for delete pattern
@param poinIndex: the point index for delete point
"""
DeletePoint(int _patternIndex, int _poinIndex)
/// @ingroup PATTERN_API
/// @brief Delete Pattern using the pattern index
/// @param patternIndex: the pattern index for delete pattern
/// @param poinIndex: the point index for delete point
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
"""
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
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
"""
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
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
"""
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
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,
"""
OffsetAsInternalLine(int _patternIndex, int _lineIndex, int _number, float _distance, bool _bReverseDirection, 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,
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
"""
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
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 name 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
"""
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 name 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
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
"""
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
def InstancePatternPiece(_patternIndex : int) -> None
"""
@ingroup PATTERN_API
@brief Instance Pattern using the pattern index
@param patternIndex: this pattern index for instance pattern
"""
InstancePatternPiece(int _patternIndex)
/// @ingroup PATTERN_API
/// @brief Instance Pattern using the pattern index
/// @param patternIndex: this pattern index for instance pattern
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
"""
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
def InstancePatternPieceWithPatternName(_patternName : str) -> None
"""
@ingroup PATTERN_API
@brief Instance Pattern using the pattern name
@param _patternName: the pattern name for instance pattern
"""
InstancePatternPieceWithPatternName(std::wstring _patternName)
/// @ingroup PATTERN_API
/// @brief Instance Pattern using the pattern name
/// @param _patternName: the pattern name for instance pattern
def GetPatternPieceName(_patternIndex : int) -> str
"""
@ingroup PATTERN_API
@brief Get Pattern name using the pattern index
@param _patternIndex: the pattern index for get name
"""
GetPatternPieceName(int _patternIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern name using the pattern index
/// @param _patternIndex: the pattern index for get name
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
"""
SetPatternPieceName(int _patternIndex, std::string _patternName)
/// @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
def GetPatternPieceFabricIndex(_patternPieceIndex : int) -> int
"""
@ingroup PATTERN_API
@brief Get Pattern fabric index using the pattern index
@param _patternIndex: the pattern index to get
"""
GetPatternPieceFabricIndex(int _patternIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern fabric index using the pattern index
/// @param _patternIndex: the pattern index to get
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
"""
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
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
"""
GetPatternPieceGrainDirection(int _patternPieceIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern Grain direction info using the pattern index
/// @param _patternIndex: the pattern index to get
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
"""
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
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
"""
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
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
"""
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
def GetPatternPieceCategory(_patternPieceIndex : int) -> int
"""
@ingroup PATTERN_API
@brief Get Pattern category number using the pattern index
@param _patternPieceIndex: the pattern index to get
"""
GetPatternPieceCategory(int _patternPieceIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern category number using the pattern index
/// @param _patternPieceIndex: the pattern index to get
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
"""
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
def GetPatternPieceClassification(_patternPieceIndex : int) -> str
"""
@ingroup PATTERN_API
@brief Get Pattern classification using the pattern index
@param _patternPieceIndex: the pattern index to get
"""
GetPatternPieceClassification(int _patternPieceIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern classification using the pattern index
/// @param _patternPieceIndex: the pattern index to get
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
"""
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
def IsPatternPieceSolidify(_patternPieceIndex : int) -> bool
"""
@ingroup PATTERN_API
@brief Check if Pattern Solidify using the pattern index
@param _patternPieceIndex: the pattern index to get
"""
IsPatternPieceSolidify(int _patternPieceIndex)
/// @ingroup PATTERN_API
/// @brief Check if Pattern Solidify using the pattern index
/// @param _patternPieceIndex: the pattern index to get
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
"""
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
def GetPatternPieceSolidifyStrengthen(_patternPieceIndex : int) -> float
"""
@ingroup PATTERN_API
@brief Get Pattern Solidify using the pattern index
@param _patternPieceIndex: the pattern index to get
"""
GetPatternPieceSolidifyStrengthen(int _patternPieceIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern Solidify using the pattern index
/// @param _patternPieceIndex: the pattern index to get
def SetPatternPieceSolidifyStrengthen(_patternPieceIndex : int, _strengthen : float) -> None
"""
@ingroup PATTERN_API
@brief Set Pattern Solidify using the pattern index
@param _patternPieceIndex: the pattern index to get
_strengthen : strengthen value to set
"""
SetPatternPieceSolidifyStrengthen(int _patternPieceIndex, float _strengthen);
/// @ingroup PATTERN_API
/// @brief Set Pattern Solidify using the pattern index
/// @param _patternPieceIndex: the pattern index to get
/// _strengthen : strengthen value to set
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
"""
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
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
children Index: the children index for convert children
"""
ConvertToInternalLine(int _patternPieceIndex)
/// @ingroup PATTERN_API
/// @brief Convert To InternalLine using the pattern index and children index
/// @param patternIndex: the pattern index for convert pattern
/// children Index: the children index for convert children
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
"""
DistribueInternalLinesbetweenSegments(int _patternIndex, vector<int> _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
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
"""
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
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
@param _x: The X position of pattern want to move
@param _y: The Y position of pattern want to move
"""
SetPatternPiecePos(int _patternIndex, float _x, float _y)
/// @brief Set Pattern piece's world position to (_x, _y)
/// @param _patternIndex: The pattern index to move
/// @param _x: The X position of pattern want to move
/// @param _y: The Y position of pattern want to move
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
@param _offsetX: The X position offset of pattern want to move
@param _offsetY: The Y position offset of pattern want to move
"""
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
/// @param _offsetX: The X position offset of pattern want to move
/// @param _offsetY: The Y position offset of pattern want to move
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
SetPatternPieceSametapingWidth(int _patternIndex, int _lineIndex, int _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
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
"""
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
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
"""
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
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
"""
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
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
@param _layer: the layer value to determine pattern layer
"""
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
/// @param _layer: the layer value to determine pattern layer
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,
"""
GetPatternLayer(int _patternIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern Layer using pattern index
/// @param patternIndex: the pattern index to get the pattern layer,
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
"""
SetPatternFreeze(int _patternIndex, bool _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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
def GetPatternAssignedTopstitchCount(_patternIndex : int) -> int
"""
@ingroup PATTERN_API
@brief Get Pattern Assigned Topstitch Count
@param _patternIndex: the pattern index to get the topstitch count
@return Output int Count Pattern Assigned Topstitch Count; If an error occurs, return -1
"""
GetPatternAssignedTopstitchCount(int _patternIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern Assigned Topstitch Count
/// @param _patternIndex: the pattern index to get the topstitch count
/// @return Output int Count Pattern Assigned Topstitch Count; If an error occurs, return -1
def GetPatternAssignedTopstitchStyle(_patternIndex : int) -> list[map[str, str]]
"""
@ingroup PATTERN_API
@brief Get Pattern Assigned Topstitch style
@param _patternIndex: the pattern index to get the topstitch style
@return Output vector map string Pattern Assigned Topstitch Style (Topstitch style Name, Count); If an error occurs, return vector vMap
"""
GetPatternAssignedTopstitchStyle(int _patternIndex)
/// @ingroup PATTERN_API
/// @brief Get Pattern Assigned Topstitch style
/// @param _patternIndex: the pattern index to get the topstitch style
/// @return Output vector map string Pattern Assigned Topstitch Style (Topstitch style Name, Count); If an error occurs, return vector vMap
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
ImportTopStitchStyle(const string& _filePath)
/// @ingroup PATTERN_API
/// @brief Import TopStitch Style from file path
/// @param filePath: the .sst file path for Import TopStitch Style
def GetNestingPatternPieceGrainDirection(patternPieceIndex : int) -> int
"""
@ingroup PATTERN_API
@brief Returns the index of the graindirection option widget for the pattern.
@param patternPieceIndex: PatternIndex
"""
GetNestingPatternPieceGrainDirection(int patternPieceIndex)
/// @ingroup PATTERN_API
/// @brief Returns the index of the graindirection option widget for the pattern.
/// @param patternPieceIndex: PatternIndex
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
"""
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
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
"""
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
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
"""
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
def AddPatternAnnotation(patternIndex : int, posX : float, posY : float, annotation : str) -> None
"""
@ingroup PATTERN_API
@brief Add Annotation in pattern
@param patternIndex: PatternIndex
@param posX: annotation position x
@param posY: annotation position y
"""
AddPatternAnnotation(int patternIndex, float posX, float posY, std::string annotation)
/// @ingroup PATTERN_API
/// @brief Add Annotation in pattern
/// @param patternIndex: PatternIndex
/// @param posX: annotation position x
/// @param posY: annotation position y
def EditPatternAnnotation(patternIndex : int, posX : float, posY : float, annotationIndex : int, annotation : str) -> None
"""
@ingroup PATTERN_API
@brief Edit Annotation
@param patternIndex: PatternIndex
@param posX: annotation position x
@param posY: annotation position y
@param annotationIndex: annotation Index
"""
EditPatternAnnotation(int patternIndex, float posX, float posY, int annotationIndex, std::string annotation)
/// @ingroup PATTERN_API
/// @brief Edit Annotation
/// @param patternIndex: PatternIndex
/// @param posX: annotation position x
/// @param posY: annotation position y
/// @param annotationIndex: annotation Index
def GetPatternAnnotation(patternIndex : int) -> list[tuple[str, float, float]]
"""
@ingroup PATTERN_API
@brief Returns all annotations the pattern has.
@param patternIndex: PatternIndex
"""
GetPatternAnnotation(int patternIndex)
/// @ingroup PATTERN_API
/// @brief Returns all annotations the pattern has.
/// @param patternIndex: PatternIndex
def GetLinkedPatternIndex(patternIndex : int) -> list[int]
"""
@ingroup PATTERN_API
@brief Get the pattern index information connected to the pattern.
@param patternIndex: Tartget Pattern Index
"""
std::vector<int> GetLinkedPatternIndex(int patternIndex)
/// @ingroup PATTERN_API
/// @brief Get the pattern index information connected to the pattern.
/// @param patternIndex: Tartget Pattern Index
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
"""
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
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)
"""
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)
def ExportObjectBrowserMaterialsList() -> str
"""
@ingroup PATTERN_API
@brief Get the material name used in the garment
@return json string for pattern input information
"""
ExportObjectBrowserMaterialsList()
/// @ingroup PATTERN_API
/// @brief Get the material name used in the garment
/// @return json string for pattern input information
def GetPinListSize() -> int
"""
@ingroup PATTERN_API
@brief Count the number of pins from patterns
@return number of pins
"""
GetPinListSize()
/// @ingroup PATTERN_API
/// @brief Count the number of pins from patterns
/// @return number of pins
def RemovePin() -> bool
"""
@ingroup PATTERN_API
@brief Removes Pin one by one
"""
RemovePin()
/// @ingroup PATTERN_API
/// @brief Removes Pin one by one
def RemoveAllPins() -> bool
"""
@ingroup PATTERN_API
@brief Removes all active pins
"""
RemoveAllPins()
/// @ingroup PATTERN_API
/// @brief Removes all active pins
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
"""
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
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
"""
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
def GetGradingSizeGroupInformation() -> list[str]
"""
@ingroup PATTERN_API
@brief Get the names of all existing grading size groups.
@return names of the grading size groups
"""
GetGradingSizeGroupInformation()
/// @ingroup PATTERN_API
/// @brief Get the names of all existing grading size groups.
/// @return names of the grading size groups
def GetGradingSizeGroupCount() -> int
"""
@ingroup PATTERN_API
@brief Get the size of all existing grading size groups.
@return size of the grading size groups
"""
GetGradingSizeGroupCount()
/// @ingroup PATTERN_API
/// @brief Get the size of all existing grading size groups.
/// @return size of the grading size groups
def GetGradingSizeTotalCount() -> int
"""
@ingroup PATTERN_API
@brief Get the number of sizes/gradings
@return total count of sizes/gradings
"""
GetGradingSizeTotalCount()
/// @ingroup PATTERN_API
/// @brief Get the number of sizes/gradings
/// @return total count of sizes/gradings
def GetCurrentGradingSizeIndex() -> int
"""
@ingroup PATTERN_API
@brief Get the index of the current size/grading
@return the current index of size/grading
"""
GetCurrentGradingSizeIndex()
/// @ingroup PATTERN_API
/// @brief Get the index of the current size/grading
/// @return the current index of size/grading
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
"""
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
def GetGradingSizeListFromRuleTable(_gradingSizeGroupIndex : int) -> list[str]
"""
"""
GetGradingSizeListFromRuleTable(_gradingSizeGroupIndex)
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
"""
GetGradingSizeNameList()
/// @ingroup PATTERN_API
/// @brief Get the name of the current size/grading
/// @return the list of name of all sizes/gradings
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
"""
GetSizeNameListW()
/// @ingroup PATTERN_API
/// @brief Get the index of the current size/grading
/// @return the list of name of all sizes/gradings
def ChangeGradingSizeInformation(_gradingSizeGroupName : str, _gradingSizeName : str) -> bool
"""
@ingroup PATTERN_API
@brief Change Grading Size information
@return Successful grading size change
@param _gradingSizeGroupName: sizegroup name
@param _gradingSizeName: grading size name
"""
ChangeGradingSizeInformation(const std::wstring& _gradingSizeGroupName, const std::wstring& _gradingSizeName)
/// @ingroup PATTERN_API
/// @brief Change Grading Size information
/// @return Successful grading size change
/// @param _gradingSizeGroupName: sizegroup name
/// @param _gradingSizeName: grading size name
def ChangeGradingSizeInformation(_gradingSizeGroupIndex : int, _gradingSizeIndex : int) -> bool
"""
@ingroup PATTERN_API
@brief Change Grading Size information
@return Successful grading size change
@param _gradingSizeGroupIndex: sizegroup index
@param _gradingSizeIndex: grading size index
"""
ChangeGradingSizeInformation(unsigned int _gradingSizeGroupIndex, unsigned int _gradingSizeIndex)
/// @ingroup PATTERN_API
/// @brief Change Grading Size information
/// @return Successful grading size change
/// @param _gradingSizeGroupIndex: sizegroup index
/// @param _gradingSizeIndex: grading size index
def GetGradingPairedAvatar(_gradingIndex : int) -> str
"""
@ingroup PATTERN_API
@brief Get grading paired avatar's name
@return Paired avatar's name
@param grading index
"""
GetGradingPairedAvatar(unsigned int _gradingIndex)
/// @ingroup PATTERN_API
/// @brief Get grading paired avatar's name
/// @return Paired avatar's name
/// @param grading index
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
"""
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
def GetSeamlinePairGroupCount() -> int
"""
@ingroup PATTERN_API
@brief Gets the number of seamlinePairGroup that exist in the scene.
@return Number of seamlinePairGroup
"""
GetSeamlinePairGroupCount()
/// @ingroup PATTERN_API
/// @brief Gets the number of seamlinePairGroup that exist in the scene.
/// @return Number of seamlinePairGroup
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
"""
GetSeamlinePairGroupName(int _seamlinePiarGroupIndex)
/// @ingroup PATTERN_API
/// @brief Get name from seamline pair group index
/// @return name of seamline Pair Group
/// @param _seamlinePiarGroupIndex : seamlinePairGroup index
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
"""
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
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
"""
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
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
"""
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
def ExportPatternJSON(_path : str) -> bool
"""
@ingroup PATTERN_API
@brief Export pattern information by JSON format
@return boolean result of exporting json file
"""
ExportPatternJSON(std::string _path)
/// @ingroup PATTERN_API
/// @brief Export pattern information by JSON format
/// @return boolean result of exporting json file
def ImportPatternJSON(_path : str) -> bool
"""
@ingroup PATTERN_API
@brief Import pattern information of JSON file
@return boolean result of importing json file
"""
ImportPatternJSON(std::string _path)
/// @ingroup PATTERN_API
/// @brief Import pattern information of JSON file
/// @return boolean result of importing json file
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.
"""
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.
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
"""
AddSeamlinePairGroup(int _patternAIndex, int _lineAIndex, int _patternBIndex, int _lineBIndex, bool _directionA, bool _directionB)
/// @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
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
"""
AddSeamlinePairGroup(int _patternAIndex, int _lineAIndex, int _patternBIndex, int _childIndex, 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
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
"""
AddSeamlinePairGroup(int _patternAIndex, int _childAIndex, int _lineAIndex, int _patternBIndex, int _childBIndex, 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
def GetSelectedPattern() -> list[str]
"""
@ingroup PATTERN_API
@brief Get the selected pattern name
@return returns the selected pattern name
"""
GetSelectedPattern()
/// @ingroup PATTERN_API
/// @brief Get the selected pattern name
/// @return returns the selected pattern name
def GetSelectedPatternViaIndex(patternIndex : int) -> bool
"""
@ingroup PATTERN_API
@brief Check if the paatern is selected via pattern index
@param patternIndex : The index of the pattern to select.
@return returns true if the pattern is selected.
"""
GetSelectedPatternViaIndex(unsigned int patternIndex)
/// @ingroup PATTERN_API
/// @brief Check if the paatern is selected via pattern index
/// @param patternIndex : The index of the pattern to select.
/// @return returns true if the pattern is selected.
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 clrear the previous selection.
"""
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 clrear the previous selection.
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 clrear the previous selection.
"""
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 clrear the previous selection.
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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)
"""
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)
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
"""
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
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.
"""
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.
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)
"""
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)
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
"""
SetGradingSizeQuantityMix(int _groupIndex, const std::map<std::string, int>& _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
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
"""
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
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.
"""
AddGraphicStyleToPattern(int _patternIndex, int _graphicStyleIndex, const std::vector<float>& _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.
REST_API
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
"""
CallRESTGet(const string& url, const vector<pair<string, string>>& 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
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
"""
CallRESTPost(const string& url, string *postField, const vector<pair<string, string>>& 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
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
"""
CallRESTPost2(const string& url, unsigned char *postField, unsigned int& sizeInByte, const vector<pair<string, string>>& 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
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
"""
CallRESTPostWithMultipartFormData(const string& url, const string& filePath, const vector<pair<string, string>>& 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
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
"""
CallRESTPostWithMultipartFormData(const string& url, const vector<string>& filePathList, const vector<pair<string, string>>& 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
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.
"""
CallbackRestRequest(const Marvelous::CloApiRestRequest& restReq, const std::function<void (Marvelous::CloApiRestResponse)>& 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.
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.
"""
CallbackRestMultiRequest(const std::vector<Marvelous::CloApiRestRequest>& restRequests, const std::function<void (Marvelous::CloApiRestResponse)>& callbackFunc, const std::function<void()>& 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.
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
"""
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
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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"
"""
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"
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"
"""
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"
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".
"""
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".
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".
"""
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".
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
"""
GetMajorVersion()
/// @ingroup UTILITY_API
/// @brief Get the major version of the CLO software
/// @return Major version of SW. ex) 5 of 5.0.72
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
"""
GetMinorVersion()
/// @ingroup UTILITY_API
/// @brief Get the minor version of the CLO software
/// @return Minor version of SW. ex) 0 of 5.0.72
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
"""
GetPatchVersion()
/// @ingroup UTILITY_API
/// @brief Get the patch version of the CLO software
/// @return Patch version of SW. ex) 72 of 5.0.72
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
"""
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
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.
"""
GetColorwayCount()
/// @ingroup UTILITY_API
/// @brief Get the number of colorways in the current project
/// @return The number of Colorways in the current project.
def GetCurrentColorwayIndex() -> int
"""
@ingroup UTILITY_API
@brief Get the current colorway index
@return The current colorway index.
"""
GetCurrentColorwayIndex()
/// @ingroup UTILITY_API
/// @brief Get the current colorway index
/// @return The current colorway index.
def SetCurrentColorwayIndex(index : int) -> None
"""
@ingroup UTILITY_API
@brief Change the current colorway
@param index: the colorway index
"""
SetCurrentColorwayIndex(unsigned int index)
/// @ingroup UTILITY_API
/// @brief Change the current colorway
/// @param index: the colorway index
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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
"""
GetClothPositions(vector<float>& 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
def ResetClothArrangement() -> None
"""
@ingroup UTILITY_API
@brief Restore the shape of cloth to when the cloth was loaded
"""
ResetClothArrangement()
/// @ingroup UTILITY_API
/// @brief Restore the shape of cloth to when the cloth was loaded
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
"""
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
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
"""
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
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
"""
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
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
"""
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
def GetMetaDataForCurrentGarment() -> str
"""
@ingroup UTILITY_API
@brief Get Meta data for the current Garment
@return the meta data for the current garment
"""
GetMetaDataForCurrentGarment()
/// @ingroup UTILITY_API
/// @brief Get Meta data for the current Garment
/// @return the meta data for the current garment
def GetMetaDataForCurrentGarmentW() -> str
"""
@ingroup UTILITY_API
@brief Get Meta data for the current Garment
@return the meta data for the current garment
"""
GetMetaDataForCurrentGarmentW()
/// @ingroup UTILITY_API
/// @brief Get Meta data for the current Garment
/// @return the meta data for the current garment
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
"""
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
def ChangeMetaDataValueForCurrentGarment(metaDataKey : str, metaDataValue : str) -> None
"""
@ingroup UTILITY_API
@brief Change Meta Data Value for the current Garment
@metaDataKey: target Key
@metaDataValue: the new value for the key
"""
ChangeMetaDataValueForCurrentGarment(const string& metaDataKey, const string& metaDataValue)
/// @ingroup UTILITY_API
/// @brief Change Meta Data Value for the current Garment
/// @metaDataKey: target Key
/// @metaDataValue: the new value for the key
def CreateProgressBar() -> None
"""
@ingroup UTILITY_API
@brief Create Progress Bar to show progress. This function should be called before using SetProgress function
"""
CreateProgressBar()
/// @ingroup UTILITY_API
/// @brief Create Progress Bar to show progress. This function should be called before using SetProgress function
def SetProgress(title : str, progress : int) -> None
"""
@ingroup UTILITY_API
@brief Set progress on the Progress Bar
"""
SetProgress(const string& title, int progress)
/// @ingroup UTILITY_API
/// @brief Set progress on the Progress Bar
def SetProgressW(title : str, progress : int) -> None
"""
@ingroup UTILITY_API
@brief Set progress on the Progress Bar
"""
SetProgressW(const std::wstring& title, int progress)
/// @ingroup UTILITY_API
/// @brief Set progress on the Progress Bar
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
"""
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
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
"""
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
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 RGB color value
@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
"""
AddColorSwatch(const map<string, string>& plmIDtoNameList, const map<string, Marvelous::CloApiRgb>& plmIDtoColorList, const map<string, string>& 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 RGB color value
/// @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
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 RGB color value
@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
"""
AddColorSwatchW(const map<wstring, wstring>& plmIDtoNameList, const map<wstring, Marvelous::CloApiRgb>& plmIDtoColorList, const map<wstring, wstring>& 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 RGB color value
/// @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
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
"""
LoadLibraryColorSwatchList(const std::vector<std::string>& library, const std::string tabName)
/// @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
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
"""
AddLibraryColorSwatchList(const std::vector<std::string>& 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
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
"""
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
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
"""
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
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
"""
SetColorSwatchLibraryTabName(const std::string& tabName, const std::string& newTabName)
/// @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
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
"""
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
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
"""
GetColorSwatchLibraryTabList()
/// @ingroup UTILITY_API
/// @brief Get the list of color swatch library tab names
/// @return the list of color swatch library tab names
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
"""
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
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def NewProject() -> None
"""
@ingroup UTILITY_API
@brief Clear the current garment and begin a new garment
"""
NewProject()
/// @ingroup UTILITY_API
/// @brief Clear the current garment and begin a new garment
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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").
"""
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").
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").
"""
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").
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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 string format
@return if it succeeds, return true
"""
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 string format
/// @return if it succeeds, return true
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
"""
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
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
"""
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
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
"""
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
def SetShowHideAvatar(_bShow : bool) -> None
"""
@ingroup UTILITY_API
@brief Set all avatars' show/hide status
@param _bShow: true for show, false for hide
"""
SetShowHideAvatar(bool _bShow)
/// @ingroup UTILITY_API
/// @brief Set all avatars' show/hide status
/// @param _bShow: true for show, false for hide
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
"""
SetShowHideAvatar(bool _bShow, int _avatarIndex)
/// @ingroup UTILITY_API
/// @brief Set show/hide status of avatar that matches the index
/// @param _bShow: true for show, false for hide
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.
"""
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.
def SetSchematicRender(_bSet : bool) -> None
"""
@ingroup UTILITY_API
@brief Set Schematic Render status
@param _bSet: true for enable, false for disable
"""
SetSchematicRender(bool _bSet)
/// @ingroup UTILITY_API
/// @brief Set Schematic Render status
/// @param _bSet: true for enable, false for disable
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
"""
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
def DeleteColorwayItem(_index : int) -> None
"""
@ingroup UTILITY_API
@brief Delete the colorway in the index
@param index: the source colorway index to delete
"""
DeleteColorwayItem(unsigned int _index)
/// @ingroup UTILITY_API
/// @brief Delete the colorway in the index
/// @param index: the source colorway index to delete
def ReplaceGraphicStyleFromImage(_graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool
"""
@ingroup UTILITY_API
@brief replace graphic style in index
@param _graphicstyleIndex: index of the style to be replaced
@param _imagePath: input file path
@param _anchor: position that will be fixed when replacing. (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
@return if it succeeds, return true.
"""
ReplaceGraphicStyleFromImage(int _graphicstyleIndex, const std::string& _imagePath, int _anchor)
/// @ingroup UTILITY_API
/// @brief replace graphic style in index
/// @param _graphicstyleIndex: index of the style to be replaced
/// @param _imagePath: input file path
/// @param _anchor: position that will be fixed when replacing. (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
/// @return if it succeeds, return true.
def ReplaceGraphicStyleFromImage(_graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool
"""
@ingroup UTILITY_API
@brief replace graphic style in index
@param _graphicstyleIndex: index of the style to be replaced
@param _imagePath: input file path
@param _anchor: position that will be fixed when replacing. (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
@return if it succeeds, return true.
"""
ReplaceGraphicStyleFromImage(int _graphicstyleIndex, const std::wstring& _imagePath, int _anchor)
/// @ingroup UTILITY_API
/// @brief replace graphic style in index
/// @param _graphicstyleIndex: index of the style to be replaced
/// @param _imagePath: input file path
/// @param _anchor: position that will be fixed when replacing. (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
/// @return if it succeeds, return true.
def ReplaceGraphicStyleFromImage(_iColorwayIndex : int, _graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool
"""
@ingroup UTILITY_API
@brief Replace the graphic style image for a specific colorway only.
@param _iColorwayIndex: index of the colorway to target
@param _graphicstyleIndex: index within the colorway's graphic style list
@param _imagePath: input image file path
@param _anchor: position that will be fixed when replacing (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
@return true if successful, false if any index is out of range or the style is not found
"""
ReplaceGraphicStyleFromImage(int _iColorwayIndex, int _graphicstyleIndex, const string& _imagePath, int _anchor)
/// @ingroup UTILITY_API
/// @brief Replace the graphic style image for a specific colorway only.
/// @param _iColorwayIndex: index of the colorway to target
/// @param _graphicstyleIndex: index within the colorway's graphic style list
/// @param _imagePath: input image file path
/// @param _anchor: position that will be fixed when replacing (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
/// @return true if successful, false if any index is out of range or the style is not found
def ReplaceGraphicStyleFromImageW(_iColorwayIndex : int, _graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool
"""
@ingroup UTILITY_API
@brief Wide-string variant of the per-colorway graphic style replacement.
@param _iColorwayIndex: index of the colorway to target
@param _graphicstyleIndex: index within the colorway's graphic style list
@param _imagePath: input image file path (wide string)
@param _anchor: position that will be fixed when replacing (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
@return true if successful, false if any index is out of range or the style is not found
"""
ReplaceGraphicStyleFromImageW(int _iColorwayIndex, int _graphicstyleIndex, const std::wstring& _imagePath, int _anchor)
/// @ingroup UTILITY_API
/// @brief Wide-string variant of the per-colorway graphic style replacement.
/// @param _iColorwayIndex: index of the colorway to target
/// @param _graphicstyleIndex: index within the colorway's graphic style list
/// @param _imagePath: input image file path (wide string)
/// @param _anchor: position that will be fixed when replacing (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
/// @return true if successful, false if any index is out of range or the style is not found
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.
"""
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.
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))
"""
SetSimulationQuality(int _quality, int _simulationMode)
/// @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))
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)
"""
SetSimulationTimeStep(float _timeStep)
/// @ingroup UTILITY_API
/// @brief Set simulation time step
/// @param _timeStep: time step in second (Default : 0.03333, Min value: 0.001)
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)
"""
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)
def SetSimulationCGFinishCondition(_cgFinishCondition : int) -> None
"""
@ingroup UTILITY_API
@brief Set simulation finish condition
@param _cgFinishCondition : Conjugate Gradient finish condition (0: iteration, 1: residual)
"""
SetSimulationCGFinishCondition(int _cgFinishCondition)
/// @ingroup UTILITY_API
/// @brief Set simulation finish condition
/// @param _cgFinishCondition : Conjugate Gradient finish condition (0: iteration, 1: residual)
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)
"""
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)
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)
"""
SetSimulationCGResidual(float _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)
def SetSimulationSelfCollisionIterationCount(_selfCollisionIterationCount : int) -> None
"""
@ingroup UTILITY_API
@brief Set self collision iteration count
@param _selfCollisionIterationCount : self collision iteration count (Default: 1)
"""
SetSimulationSelfCollisionIterationCount(int _selfCollisionIterationCount)
/// @ingroup UTILITY_API
/// @brief Set self collision iteration count
/// @param _selfCollisionIterationCount : self collision iteration count (Default: 1)
def SetSimulationAirDamping(_airDamping : float) -> None
"""
@ingroup UTILITY_API
@brief Set air damping value
@param _airDamping : air damping(Default: 1.0)
"""
SetSimulationAirDamping(float _airDamping)
/// @ingroup UTILITY_API
/// @brief Set air damping value
/// @param _airDamping : air damping(Default: 1.0)
def SetSimulationGravity(_gravity : float) -> None
"""
@ingroup UTILITY_API
@brief Set gravity value in y-axis
@param _gravity : gravity (Default: -9800.0 mm/s^2)
"""
SetSimulationGravity(float _gravity)
/// @ingroup UTILITY_API
/// @brief Set gravity value in y-axis
/// @param _gravity : gravity (Default: -9800.0 mm/s^2)
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)
"""
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)
def SetSimulationNonlinearSimulation(_bNonlinearSimulation : bool) -> None
"""
@ingroup UTILITY_API
@brief Set nonlinear simulation
@param _bNonlinearSimulation : true for enable, false for disable
"""
SetSimulationNonlinearSimulation(int _bNonlinearSimulation)
/// @ingroup UTILITY_API
/// @brief Set nonlinear simulation
/// @param _bNonlinearSimulation : true for enable, false for disable
def SetSimulationGroundCollision(_bGroundCollision : bool) -> None
"""
@ingroup UTILITY_API
@brief Set ground collision
@param _bGroundCollision : true for enable, false for disable
"""
SetSimulationGroundCollision(int _bGroundCollision)
/// @ingroup UTILITY_API
/// @brief Set ground collision
/// @param _bGroundCollision : true for enable, false for disable
def SetSimulationGroundHeight(_groundHeight : float) -> None
"""
@ingroup UTILITY_API
@brief Set ground height value
@param _groundHeight : ground height in y-axis (Default: 0.0)
"""
SetSimulationGroundHeight(float _groundHeight)
/// @ingroup UTILITY_API
/// @brief Set ground height value
/// @param _groundHeight : ground height in y-axis (Default: 0.0)
def SetSimulationSelfCollisionAvoidanceStiffness(_avoidanceStiffness : float) -> None
"""
@ingroup UTILITY_API
@brief Set stiffness of the inserted spring to avoid self collision
@param _avoidanceStiffness : (Default: 0.001)
"""
SetSimulationSelfCollisionAvoidanceStiffness(float _avoidanceStiffness)
/// @ingroup UTILITY_API
/// @brief Set stiffness of the inserted spring to avoid self collision
/// @param _avoidanceStiffness : (Default: 0.001)
def SetSimulationLayerBasedCollisionDetection(_bUseLayer : bool) -> None
"""
@ingroup UTILITY_API
@brief Set layer based collision detection
@param _bUseLayer : true for enable, false for disable
"""
SetSimulationLayerBasedCollisionDetection(bool _bUseLayer)
/// @ingroup UTILITY_API
/// @brief Set layer based collision detection
/// @param _bUseLayer : true for enable, false for disable
def StartNesting() -> None
"""
@ingroup UTILITY_API
@brief Start Nesting Simulation
"""
StartNesting()
/// @ingroup UTILITY_API
/// @brief Start Nesting Simulation
def GetNestingBufferSpacing() -> float
"""
@ingroup UTILITY_API
@brief Get Nesting Buffer Space
"""
GetNestingBufferSpacing()
/// @ingroup UTILITY_API
/// @brief Get Nesting Buffer Space
def SetNestingBufferSpacing(_mm : float) -> None
"""
@ingroup UTILITY_API
@brief Set Nesting Buffer Space
@param _mm : Buffer Space
"""
SetNestingBufferSpacing(float _mm)
/// @ingroup UTILITY_API
/// @brief Set Nesting Buffer Space
/// @param _mm : Buffer Space
def SetNestingTargetColorway(_colorwayList : list[int]) -> None
"""
@ingroup UTILITY_API
@brief Colorway index to apply nesting result
@param _colorwayList : Colorway index to apply nesting result
"""
SetNestingTargetColorway(std::vector<int> _colorwayList)
/// @ingroup UTILITY_API
/// @brief Colorway index to apply nesting result
/// @param _colorwayList : Colorway index to apply nesting result
def GetNestingTargetColorway() -> list[int]
"""
@ingroup UTILITY_API
@brief Gets the colorway index to apply nesting to.
"""
GetNestingTargetColorway()
/// @ingroup UTILITY_API
/// @brief Gets the colorway index to apply nesting to.
def SetAvatarMeshTexture(_matShapeName : str, _matMeshIndex : int, _textureImagePath : str) -> bool
"""
@ingroup UTILITY_API
@brief Import AvtarTexture Body Part(face, body, arm, leg)
@param _matShapeName: input avatar shape name(find object browser)
@param _matMeshIndex: mat shape index (0: face, 1:body, 2:arm, 3:leg)
@param _textureImagePath: change texture full path
@return if it succeeds, return true.
"""
SetAvatarMeshTexture(const std::wstring& _matShapeName, int _matMeshIndex, const std::wstring& _textureImagePath)
/// @ingroup UTILITY_API
/// @brief Import AvtarTexture Body Part(face, body, arm, leg)
/// @param _matShapeName: input avatar shape name(find object browser)
/// @param _matMeshIndex: mat shape index (0: face, 1:body, 2:arm, 3:leg)
/// @param _textureImagePath: change texture full path
/// @return if it succeeds, return true.
def SetAnimationRecording(_bStart : bool) -> None
"""
@ingroup UTILITY_API
@brief set animation recording
@param _bStart: true for recording start, false for recording stop
"""
SetAnimationRecording(bool _bStart)
/// @ingroup UTILITY_API
/// @brief set animation recording
/// @param _bStart: true for recording start, false for recording stop
def SetCurrentAnimationFrame(_frame : double) -> None
"""
@ingroup UTILITY_API
@brief set current animation frame
@param _frame: Value for setting current frame
"""
SetCurrentAnimationFrame(double _frame)
/// @ingroup UTILITY_API
/// @brief set current animation frame
/// @param _frame: Value for setting current frame
def GetCurrentAnimationFrame() -> double
"""
@ingroup UTILITY_API
@brief get current animation frame
"""
GetCurrentAnimationFrame()
/// @ingroup UTILITY_API
/// @brief get current animation frame
def SetStartAnimationFrame(_frame : double) -> None
"""
@ingroup UTILITY_API
@brief set start animation frame
@param _frame: Value for setting start frame
"""
SetStartAnimationFrame(double _frame)
/// @ingroup UTILITY_API
/// @brief set start animation frame
/// @param _frame: Value for setting start frame
def GetStartAnimationFrame() -> double
"""
@ingroup UTILITY_API
@brief get start animation frame
"""
GetStartAnimationFrame()
/// @ingroup UTILITY_API
/// @brief get start animation frame
def SetEndAnimationFrame(_frame : double) -> None
"""
@ingroup UTILITY_API
@brief set end animation frame
@param _frame: Value for setting end frame
"""
SetEndAnimationFrame(double _frame)
/// @ingroup UTILITY_API
/// @brief set end animation frame
/// @param _frame: Value for setting end frame
def GetEndAnimationFrame() -> double
"""
@ingroup UTILITY_API
@brief get end animation frame
"""
GetEndAnimationFrame()
/// @ingroup UTILITY_API
/// @brief get end animation frame
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
MoveAnimationFrame()
/// @ingroup UTILITY_API
/// @brief Move the animation to a specific frame.
/// @param _frame The target frame to move the animation to.
def CopyFromFirstClothCache() -> None
"""
@ingroup UTILITY_API
@brief Copy the first cloth cache to current frame
"""
CopyFromFirstClothCache()
/// @ingroup UTILITY_API
/// @brief Copy the first cloth cache to current frame
def GetStressMapStatus() -> bool
"""
@ingroup UTILITY_API
@brief return current rendered status of the stress map (false = Off | true = On)
"""
GetStressMapStatus()
/// @ingroup UTILITY_API
/// @brief return current rendered status of the stress map (false = Off | true = On)
def SetStressMapStatus(_bOn : bool) -> None
"""
@ingroup UTILITY_API
@brief set the rendered status of stress map
@param _bOn: false = Off | true = On
"""
SetStressMapStatus(bool _bOn)
/// @ingroup UTILITY_API
/// @brief set the rendered status of stress map
/// @param _bOn: false = Off | true = On
def GetStrainMapStatus() -> bool
"""
@ingroup UTILITY_API
@brief return current rendered status of the strain map (false = Off | true = On)
"""
GetStrainMapStatus()
/// @ingroup UTILITY_API
/// @brief return current rendered status of the strain map (false = Off | true = On)
def SetStrainMapStatus(_bOn : bool) -> None
"""
@ingroup UTILITY_API
@brief set the rendered status of strain map
@param _bOn: false = Off | true = On
"""
SetStrainMapStatus(bool _bOn)
/// @ingroup UTILITY_API
/// @brief set the rendered status of strain map
/// @param _bOn: false = Off | true = On
def GetSchematicRender() -> bool
"""
@ingroup UTILITY_API
@brief Get Show Schematic Render Status
"""
GetSchematicRender()
/// @ingroup UTILITY_API
/// @brief Get Show Schematic Render Status
def RefreshPlugIns() -> None
"""
@ingroup UTILITY_API
@brief Refresh all PlugIns
"""
RefreshPlugIns()
/// @ingroup UTILITY_API
/// @brief Refresh all PlugIns
def RegisterPythonScript(pythonScriptPath : str, menuPath : str) -> bool
"""
@ingroup UTILITY_API
@brief Register one Python script under the target menu path.
"""
RegisterPythonScript(const std::string& pythonScriptPath, const std::string& menuPath)
/// @ingroup UTILITY_API
/// @brief Register one Python script under the target menu path.
def RegisterPythonScriptW(pythonScriptPath : str, menuPath : str) -> bool
"""
@ingroup UTILITY_API
@brief Register one Python script under the target menu path.
"""
RegisterPythonScriptW(const std::wstring& pythonScriptPath, const std::wstring& menuPath)
/// @ingroup UTILITY_API
/// @brief Register one Python script under the target menu path.
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.
"""
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.
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.
"""
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.
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)
"""
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)
def StopNesting() -> None
"""
@ingroup UTILITY_API
@brief Stop Nesting process
"""
StopNesting()
/// @ingroup UTILITY_API
/// @brief Stop Nesting process
def CreateModularCategory(_title : str, _folderPath : str) -> None
"""
@ingroup UTILITY_API
@brief create modular category
@param _title : category title,
@param _folderPath: groupFolderPath
"""
CreateModularCategory(const std::wstring& _title, const std::wstring& _folderPath)
/// @ingroup UTILITY_API
/// @brief create modular category
/// @param _title : category title,
/// @param _folderPath: groupFolderPath
def DeleteModularCategory(_categoryPath : str) -> None
"""
@ingroup UTILITY_API
@brief delete modular category
@param _categoryPath : category title
"""
DeleteModularCategory(const std::wstring& _categoryPath)
/// @ingroup UTILITY_API
/// @brief delete modular category
/// @param _categoryPath : category title
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
"""
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
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
"""
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
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
"""
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
def GetNestingTime() -> int
"""
@ingroup UTILITY_API
@brief Get Nesting duration Time (milliseconds)
"""
GetNestingTime()
/// @ingroup UTILITY_API
/// @brief Get Nesting duration Time (milliseconds)
def SetSchematicSilhouetteLineWidth(_value : int) -> None
"""
@ingroup UTILITY_API
@brief set schematic silhouette line width
@param _value: Value for setting schematic silhouette line width
"""
SetSchematicSilhouetteLineWidth(int _value)
/// @ingroup UTILITY_API
/// @brief set schematic silhouette line width
/// @param _value: Value for setting schematic silhouette line width
def SetSchematicSeamLineWidth(_value : int) -> None
"""
@ingroup UTILITY_API
@brief set schematic seamline width
@param _value: Value for setting schematic seamline width
"""
SetSchematicSeamLineWidth(int _value)
/// @ingroup UTILITY_API
/// @brief set schematic seamline width
/// @param _value: Value for setting schematic seamline width
def SetSchematicInternalLineWidth(_value : int) -> None
"""
@ingroup UTILITY_API
@brief set schematic internal line width
@param _value: Value for setting chematic internal line width
"""
SetSchematicInternalLineWidth(int _value)
/// @ingroup UTILITY_API
/// @brief set schematic internal line width
/// @param _value: Value for setting chematic internal line width
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
"""
SetSchematicTopstitchLineScalePercent(int _value)
/// @ingroup UTILITY_API
/// @brief set schematic topstitch line scale percent
/// @param _value: Value for setting schematic topstitch line scale percent
def SetSchematicBrightness(_value : int) -> None
"""
@ingroup UTILITY_API
@brief set schematic brightness
@param _value: Value for setting schematic brightness
"""
SetSchematicBrightness(int _value)
/// @ingroup UTILITY_API
/// @brief set schematic brightness
/// @param _value: Value for setting schematic brightness
def SetShowSchematicSilhouetteLine(_bOn : bool) -> None
"""
@ingroup UTILITY_API
@brief set show schematic silhouetteline
@param _bOn: Value for setting showschematic silhouetteline
"""
SetShowSchematicSilhouetteLine(bool _bOn)
/// @ingroup UTILITY_API
/// @brief set show schematic silhouetteline
/// @param _bOn: Value for setting showschematic silhouetteline
def SetShowSchematicSeamLine(_bOn : bool) -> None
"""
@ingroup UTILITY_API
@brief set show schematic seamline
@param _bOn: Value for setting show schematic seamline
"""
SetShowSchematicSeamLine(bool _bOn)
/// @ingroup UTILITY_API
/// @brief set show schematic seamline
/// @param _bOn: Value for setting show schematic seamline
def SetShowSchematicInternalLine(_bOn : bool) -> None
"""
@ingroup UTILITY_API
@brief set show schematic internal line
@param _bOn: Value for setting show schematic internalline
"""
SetShowSchematicInternalLine(bool _bOn)
/// @ingroup UTILITY_API
/// @brief set show schematic internal line
/// @param _bOn: Value for setting show schematic internalline
def SetShowSchematicTopstitchLine(_bOn : bool) -> None
"""
@ingroup UTILITY_API
@brief set show schematic topstitch line
@param _bOn: Value for setting show schematic topstitchline
"""
SetShowSchematicTopstitchLine(bool _bOn)
/// @ingroup UTILITY_API
/// @brief set show schematic topstitch line
/// @param _bOn: Value for setting show schematic topstitchline
def SetSchematicClothRenderType(_bTexture : bool) -> None
"""
@ingroup UTILITY_API
@brief set schematic cloth render type
@param _bTexture: Value for setting schematic cloth render type
"""
SetSchematicClothRenderType(bool _bTexture)
/// @ingroup UTILITY_API
/// @brief set schematic cloth render type
/// @param _bTexture: Value for setting schematic cloth render type
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
"""
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
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
"""
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
def SetQualityRender(_bSet : bool) -> None
"""
@ingroup UTILITY_API
@brief Set Quality Render status
@param _bSet: true for enable, false for disable
"""
SetQualityRender(bool _bSet)
/// @ingroup UTILITY_API
/// @brief Set Quality Render status
/// @param _bSet: true for enable, false for disable
def GetQualityRenderStatus() -> bool
"""
@ingroup UTILITY_API
@brief Get Current Quality Render Status
"""
GetQualityRenderStatus()
/// @ingroup UTILITY_API
/// @brief Get Current Quality Render Status
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.
"""
BakeUVTexture(const std::string& _filePath, const Marvelous::ImportExportOption& _options, bool _bAll)
/// @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.
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.
"""
BakeUVTextureW(const std::wstring& _filePath, const Marvelous::ImportExportOption& _options, bool _bAll)
/// @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.
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.
"""
UVPacking(bool _bAll, bool _bFixScaleRatio, bool _bAdvancedSearch, float _padding, int _fidelity, const std::vector<int>& _roationAngleOptions)
/// @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.
def ResetUVTo2DArrangement() -> None
"""
@ingroup UTILITY_API
@brief Reset UV islands to the 2D arrangement.
"""
ResetUVTo2DArrangement()
/// @ingroup UTILITY_API
/// @brief Reset UV islands to the 2D arrangement.
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
"""
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
def Refresh3DWindow() -> None
"""
@ingroup UTILITY_API
@brief Refresh 3D Garment Window
"""
Refresh3DWindow()
/// @ingroup UTILITY_API
/// @brief Refresh 3D Garment Window
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
"""
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
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.
"""
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.
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.
"""
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.
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.
"""
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.
def RemovePlugInFromList(_pluginListIndex : int) -> None
"""
@ingroup UTILITY_API
@brief Remove Plug In From PluginList
@param _pluginListIndex: PluginList index to delete the plugin
"""
RemovePlugInFromList(unsigned int _pluginListIndex)
/// @ingroup UTILITY_API
/// @brief Remove Plug In From PluginList
/// @param _pluginListIndex: PluginList index to delete the plugin
def AddPlugInFromFile(_filePath : str) -> None
"""
@ingroup UTILITY_API
@brief Add Plug In From Filepath
@param _filePath: File path to be added plugin.
"""
AddPlugInFromFile(const std::string& _filePath)
/// @ingroup UTILITY_API
/// @brief Add Plug In From Filepath
/// @param _filePath: File path to be added plugin.
def UsePlugInFromList(_pluginListIndex : int) -> None
"""
@ingroup UTILITY_API
@brief Use Plug In From PluginList
@param _pluginListIndex: PluginList index to use the plugin
"""
UsePlugInFromList(unsigned int _pluginListIndex)
/// @ingroup UTILITY_API
/// @brief Use Plug In From PluginList
/// @param _pluginListIndex: PluginList index to use the plugin
def TerminatePlugInFromList(_pluginListIndex : int) -> None
"""
@ingroup UTILITY_API
@brief Terminate Plug In From PluginList
@param _pluginListIndex: PluginList index to use the plugin
"""
TerminatePlugInFromList(unsigned int _pluginListIndex)
/// @ingroup UTILITY_API
/// @brief Terminate Plug In From PluginList
/// @param _pluginListIndex: PluginList index to use the plugin
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.
"""
Set3DGarmentRenderingStyle(unsigned int _surfaceTextureTypeIndex)
/// @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.
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.
"""
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.
def GetTotalGraphicItemQuantity() -> int
"""
@ingroup UTILITY_API
@brief Returns the total quantity of all graphic items
@return If valid, returns the total quantity; otherwise, -1.
"""
GetTotalGraphicItemQuantity()
/// @ingroup UTILITY_API
/// @brief Returns the total quantity of all graphic items
/// @return If valid, returns the total quantity; otherwise, -1.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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...
"""
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...
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...
"""
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...
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
"""
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
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
"""
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
def CurrentlyThemeInCLO() -> CloTheme
"""
@ingroup UTILITY_API
@brief Returns the currently Theme information used in CLO
@return currently Theme type
"""
CurrentlyThemeInCLO()
/// @ingroup UTILITY_API
/// @brief Returns the currently Theme information used in CLO
/// @return currently Theme type
def SetCropBackground(_bToggle : bool) -> None
"""
@ingroup UTILITY_API
@brief Set crop status.
@param _bToggle: change crop background as _bToggle
"""
SetCropBackground(bool _bToggle)
/// @ingroup UTILITY_API
/// @brief Set crop status.
/// @param _bToggle: change crop background as _bToggle
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.
"""
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.
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().
"""
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().
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} }
"""
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} }
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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
"""
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
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.
"""
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.
def SetRenderImageVideoProperties(_renderImageVideoOption : RenderImageVideoOptions) -> None
"""
@ingroup UTILITY_API
@brief Sets render image/video property values.
@param _renderImageVideoOption: render option values
"""
SetRenderImageVideoProperties()
/// @ingroup UTILITY_API
/// @brief Sets render image/video property values.
/// @param _renderImageVideoOption: render option values
def GetRenderImageVideoProperties() -> str
"""
@ingroup UTILITY_API
@brief Returns render image/video property values
"""
GetRenderImageVideoProperties()
/// @ingroup UTILITY_API
/// @brief Returns render image/video property values
def SetRenderingProperties(_renderPropertyOptions : RenderPropertyOptions) -> None
"""
@ingroup UTILITY_API
@brief Sets rendering property values.
@param _renderPropertyOptions: render property option values
"""
SetRenderingProperties(Marvelous::RenderPropertyOptions& _renderPropertyOptions)
/// @ingroup UTILITY_API
/// @brief Sets rendering property values.
/// @param _renderPropertyOptions: render property option values
def GetRenderingProperties() -> str
"""
@ingroup UTILITY_API
@brief Gets rendering property values
@return If valid, returns a string containing rendering property values.
"""
GetRenderingProperties()
/// @ingroup UTILITY_API
/// @brief Gets rendering property values
/// @return If valid, returns a string containing rendering property values.
def SetZoomView() -> None
"""
@ingroup UTILITY_API
@brief Zoom cloth
"""
SetZoomView()
/// @ingroup UTILITY_API
/// @brief Zoom cloth
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)
"""
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)
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.
"""
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.
def ReDrape3DArrangement(_options : ImportExportOption) -> None
"""
@ingroup UTILITY_API
@brief Redrape all patterns 3D Arrangement
"""
ReDrape3DArrangement()
/// @ingroup UTILITY_API
/// @brief Redrape all patterns 3D Arrangement
def SetAPF(_path : str) -> None
"""
@ingroup UTILITY_API
@brief Set APF file path
@param _path: APF file path
"""
SetAPF(std::string _path)
/// @ingroup UTILITY_API
/// @brief Set APF file path
/// @param _path: APF file path
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
"""
ABPNetworkAuth()
/// @ingroup UTILITY_API
/// @brief Regist Alvanon ID and Password
/// @param id: Alvanon ID
/// @param pw: Alvanon Password
/// @param _APFpath : APF File path
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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 _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the target fabric index in the Colorway Editor
@param _bSetOnOff: true to enable desaturation, false to disable
"""
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 _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the target fabric index in the Colorway Editor
/// @param _bSetOnOff: true to enable desaturation, false to disable
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
def SetGraphicNormalMapTexture(_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
"""
SetGraphicNormalMapTexture(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
def SetGraphicDisplacementMapTexture(_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
"""
SetGraphicDisplacementMapTexture(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
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
"""
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
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
"""
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
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
"""
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
def GetGraphicNormalMapTexture() -> str
"""
@ingroup UTILITY_API
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
GetGraphicNormalMapTexture()
/// @ingroup UTILITY_API
/// @brief Gets the texture map for the graphic style
/// @return _imageFilePath: The file path of the graphic style
def GetGraphicDisplacementMapTexture() -> str
"""
@ingroup UTILITY_API
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
GetGraphicDisplacementMapTexture()
/// @ingroup UTILITY_API
/// @brief Gets the texture map for the graphic style
/// @return _imageFilePath: The file path of the graphic style
def GetGraphicOpacityMapTexture() -> str
"""
@ingroup UTILITY_API
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
GetGraphicOpacityMapTexture()
/// @ingroup UTILITY_API
/// @brief Gets the texture map for the graphic style
/// @return _imageFilePath: The file path of the graphic style
def GetGraphicRoughnessMapTexture() -> str
"""
@ingroup UTILITY_API
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
GetGraphicRoughnessMapTexture()
/// @ingroup UTILITY_API
/// @brief Gets the texture map for the graphic style
/// @return _imageFilePath: The file path of the graphic style
def GetGraphicMetalnessMapTexture() -> str
"""
@ingroup UTILITY_API
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
GetGraphicMetalnessMapTexture()
/// @ingroup UTILITY_API
/// @brief Gets the texture map for the graphic style
/// @return _imageFilePath: The file path of the graphic style
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 imageFilePath: The file path to be set for the graphic style
"""
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 imageFilePath: The file path to be set for the graphic style
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
GetGraphicStyleColor()
/// @ingroup UTILITY_API
/// @brief Get a base color of PBR material in a Graphic. (default index = 0)
/// @return RGBA float tuple
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
@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.
"""
SetGraphicStyleColor(int _styleIndex, 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
/// @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.
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)
@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.
"""
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 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.
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 RGBA float tuple
"""
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 RGBA float tuple
def GetItemsCountsinColorway(_colorwayIndex : int) -> int
"""
@ingroup UTILITY_API
@brief Get the color count in a target colorway.
@param _colorwayIndex: the target colorway index
@return if it succeeds, return the color count in a colorway.
"""
GetItemsCountsinColorway(int _colorwayIndex)
/// @ingroup UTILITY_API
/// @brief Get the color count in a target colorway.
/// @param _colorwayIndex: the target colorway index
/// @return if it succeeds, return the color count in a colorway.
def AutoHang(_garmentPath : str, _hangerPath : str, _hangerType : int, _hangerImportOption : ImportExportOption) -> bool
"""
@ingroup UTILITY_API
@brief Auto-hang a garment to a hanger.
@param _garmentPath: path to a garment file. .zprj or .zpac is accepted. If .zprj is given, only the garment will be loaded.
@param _hangerPath: path to a hanger file. .obj or .avt is accepted.
@param _hangerType: type of the _hangerFIlePath hanger. 0 = top hanger, 1 = bottom hanger
@param _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.
"""
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.
/// @param _garmentPath: path to a garment file. .zprj or .zpac is accepted. If .zprj is given, only the garment will be loaded.
/// @param _hangerPath: path to a hanger file. .obj or .avt is accepted.
/// @param _hangerType: type of the _hangerFIlePath hanger. 0 = top hanger, 1 = bottom hanger
/// @param _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.
def AddPinsForFabricValidation(size1 : float, size2 : float, size3 : float, size4 : float) -> bool
"""
@ingroup UTILITY_API
@brief Adjust lengths and adjust pin locations
"""
AddPinsForFabricValidation(float size1, float size2, float size3, float size4)
/// @ingroup UTILITY_API
/// @brief Adjust lengths and adjust pin locations
def UpdatePropertyWindow() -> None
"""
@ingroup UTILITY_API
@brief Update the PropertyWindow
"""
UpdatePropertyWindow()
/// @ingroup UTILITY_API
/// @brief Update the PropertyWindow
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
"""
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
def DeleteAvatar(_avatarIndexList : list[int]) -> bool
"""
@ingroup UTILITY_API
@brief Delete Avatars
@param _avatarIndexList: List of indices for avatars to delete
"""
DeleteAvatar(std::vector<int> _avatarIndexList)
/// @ingroup UTILITY_API
/// @brief Delete Avatars
/// @param _avatarIndexList: List of indices for avatars to delete
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
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
"""
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
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
"""
SetGraphicStyleToGraphic(int _styleIndex, 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
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
"""
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
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))
"""
GetSimulationQuality()
/// @return The Simulation type(0: Normal(Default), 1: Animation(Stable), 2: Fitting(Accurate Fabric)) and simulation mode (0: CPU, 1: FAST(GPU))
def CheckZPRJForUnsavedChanges() -> bool
"""
@return Returns true if the file has been modified.
"""
CheckZPRJForUnsavedChanges()
/// @return Returns true if the file has been modified.
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)
"""
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)
def SetAvatarOpacityMap(_imageFilePath : str) -> None
"""
@brief Set OpacityMap of Avatar
@param _imageFilePath: The file path to be set for the Avatar Map
"""
SetAvatarOpacityMap(const std::string _imageFilePath)
/// @brief Set OpacityMap of Avatar
/// @param _imageFilePath: The file path to be set for the Avatar Map
def GetAvatarOpacityMaps() -> list[str]
"""
@ingroup UTILITY_API
@brief Get opacity maps Avatar
@return Output file paths.
"""
GetAvatarOpacityMaps()
/// @ingroup UTILITY_API
/// @brief Get opacity maps Avatar
/// @return Output file paths.
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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
"""
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
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: Solodify, 4: Layer, 5: All (Mesh) , 6: Subdivide (Mesh), 7: Freeze (Mesh), 8: Strengthen (Mesh), 9: Solodify (Mesh)
@param _show: True/False. True is for show. False is for Hide
"""
SetShowHideColorOptions()
/// @ingroup UTILITY_API
/// @brief Set Show/Hide Color Options
/// @param _option: Option 0: All, 1: Freeze, 2: Strengthen, 3: Solodify, 4: Layer, 5: All (Mesh) , 6: Subdivide (Mesh), 7: Freeze (Mesh), 8: Strengthen (Mesh), 9: Solodify (Mesh)
/// @param _show: True/False. True is for show. False is for Hide
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.
"""
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.
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.
"""
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.
def AlignAvatarsAndGarmentToCenter() -> None
"""
@ingroup UTILITY_API
@brief Align Avatars and Garment to Center
"""
AlignAvatarsAndGarmentToCenter()
/// @ingroup UTILITY_API
/// @brief Align Avatars and Garment to Center
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
@note Reference Point Definition: The reference point for the 2D shape is defined as the top-left corner of its bounding rectangle.
Example for a Triangle Pattern:
(min(x),max(y)) Reference Point
#------^------+ ---
| / \ | |
| / \ | | Y-axis ( _y moves downward)
| / \ | |
| / (X,Y)\ | | # Reference Point (Top left corner of the bounding Rectangle)
| / * \ | | * Center of the Graphic
|/___________\| |
+-------------+ ---
| |
|-- X-axis ( _x moves right)--|
Bounding Rectangle
@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.
"""
AddGraphicStyleToPattern(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
/// @note Reference Point Definition: The reference point for the 2D shape is defined as the top-left corner of its bounding rectangle.
/// Example for a Triangle Pattern:
/// (min(x),max(y)) Reference Point
/// #------^------+ ---
/// | / \ | |
/// | / \ | | Y-axis ( _y moves downward)
/// | / \ | |
/// | / (X,Y)\ | | # Reference Point (Top left corner of the bounding Rectangle)
/// | / * \ | | * Center of the Graphic
/// |/___________\| |
/// +-------------+ ---
/// | |
/// |-- X-axis ( _x moves right)--|
/// Bounding Rectangle
/// @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.
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.
"""
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.
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.
"""
GetUseSameMapAsFabricForGraphicOpacity(int _colorwayIndex, int _graphicItemIndex, int _materialFace)
/// @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.
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.
"""
SetUseSameMapAsFabricForGraphicOpacity(int _colorwayIndex, int _graphicItemIndex, int _materialFace, bool _bUse)
/// @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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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<int64_t>(widget)
"""
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<int64_t>(widget)
def DeleteWidgets() -> None
"""
@brief Removes and deletes all widgets that were registered using the RegisterWidget function.
"""
void DeleteWidgets()
/// @brief Removes and deletes all widgets that were registered using the RegisterWidget function.
def ResetWidgetRegistry() -> None
"""
@brief Resets the list of registered widgets to an empty state.
"""
void ResetWidgetRegistry()
/// @brief Resets the list of registered widgets to an empty state.
def GetUserHeadQuarterId() -> str
"""
@ingroup UTILITY_API
@brief Get the logged in user's head quarter Id
@return Logged in user's head quarter Id
"""
GetUserHeadQuarterId()
/// @ingroup UTILITY_API
/// @brief Get the logged in user's head quarter Id
/// @return Logged in user's head quarter Id
def GetUserHeadQuarterIdW() -> str
"""
@ingroup UTILITY_API
@brief Get the logged in user's head quarter Id
@return Logged in user's head quarter Id
"""
GetUserHeadQuarterIdW()
/// @ingroup UTILITY_API
/// @brief Get the logged in user's head quarter Id
/// @return Logged in user's head quarter Id
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.
"""
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.
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.
"""
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.
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.
"""
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.
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)
"""
ExportColorwayEditorImage(const std::string _filePath, int _scale)
/// @ingroup UTILITY_API
/// @brief Exprot Colorway Editor as Image.
/// @param _filePath: Image path to save
/// _scale: Image scale (1-4)
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.
"""
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.
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.
"""
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.
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)
"""
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)
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)
"""
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)
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
"""
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
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
"""
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
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
"""
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
def GetZipperStyleTeethType(_zipperStyleIndex : int) -> int
"""
@ingroup UTILITY_API
@brief Get the zipper style teeth type.
@param _zipperStyleIndex: The zipper style index.
@return It returns the teeth type index.
0: Texture
1: OBJ
"""
GetZipperStyleTeethType(int _zipperStyleIndex)
/// @ingroup UTILITY_API
/// @brief Get the zipper style teeth type.
/// @param _zipperStyleIndex: The zipper style index.
/// @return It returns the teeth type index.
/// 0: Texture
/// 1: OBJ
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)
"""
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)
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)
"""
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)
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)
"""
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)
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)
"""
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)
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)
"""
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)
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)
"""
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)
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)
"""
SetZipperStyleWeight(int _zipperStyleIndex, float _weight)
/// @ingroup UTILITY_API
/// @brief Update the zipper style weight.
/// @param _zipperStyleIndex: The zipper style index.
/// @param _weight: Weight (g)
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)
"""
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)
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)
"""
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)
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)
"""
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)
def SetAvatarSmooth(_avatarIndex : int, _smoothlevel : int) -> None
"""
@ingroup UTILITY_API
@brief Set the maximum subdivision level for avatar smoothing.
@param _avatarIndex: The avatar index to apply smoothing.
@param _smoothlevel: The maximum subdivision level to set for avatar smoothing. (1-3)
"""
SetAvatarSmooth(unsigned int _avatarIndex, unsigned int _smoothlevel)
/// @ingroup UTILITY_API
/// @brief Set the maximum subdivision level for avatar smoothing.
/// @param _avatarIndex: The avatar index to apply smoothing.
/// @param _smoothlevel: The maximum subdivision level to set for avatar smoothing. (1-3)
def GetAvatarSubdivisionLevel(_avatarIndex : int) -> int
"""
@ingroup UTILITY_API
@brief Get the current subdivision level for avatar smoothing.
@return The current subdivision level for avatar smoothing. (1-3, 0 means no subdivision). If 0 to uncheck/unselect DivideMesh.
"""
GetAvatarSubdivisionLevel(unsigned int _avatarIndex)
/// @ingroup UTILITY_API
/// @brief Get the current subdivision level for avatar smoothing.
/// @return The current subdivision level for avatar smoothing. (1-3, 0 means no subdivision). If 0 to uncheck/unselect DivideMesh.
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'}
"""
SetAvatarProperties(unsigned int _avatarIndex, const std::map<std::string, std::string>& 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'}
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'}
"""
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'}
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.
"""
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.
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).
"""
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).
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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'}
"""
SetTrimMaterialProperties(int _trimStyleIndex, int _meshIndex, const std::map<std::string, std::string>& _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'}
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'}
"""
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'}
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.
"""
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.
def GetNormalBlendingMethod() -> int
"""
@ingroup UTILITY_API
@brief Gets the current normal blending method.
@return The index of the current normal blending method.
"""
GetNormalBlendingMethod()
/// @ingroup UTILITY_API
/// @brief Gets the current normal blending method.
/// @return The index of the current normal blending method.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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).
"""
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).
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.
"""
GetTopStitchOffsetIndex(int _topStitchIndex)
/// @ingroup UTILITY_API
/// @brief Get the top stitch offset index.
/// @param _topStitchIndex: The top stitch style index.
/// @return The offset index.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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.
"""
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.
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
"""
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
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
"""
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
def RemoveGraphicStyle(_graphicIndex : int) -> str
"""
@ingroup UTILITY_API
@brief Removes a graphic style at the specified index.
@param _graphicIndex: The index of the graphic style to remove.
@return string message indicating success or failure of the remove operation.
"""
RemoveGraphicStyle(int _graphicIndex)
/// @ingroup UTILITY_API
/// @brief Removes a graphic style at the specified index.
/// @param _graphicIndex: The index of the graphic style to remove.
/// @return string message indicating success or failure of the remove operation.