API List

EXPORT_API

def ExportZPac() -> str
"""
    @ingroup EXPORT_API
    @brief Export ZPac file in the MD 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 MD 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 MD 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 MD temporary folder.
"""
def ExportZPrj() -> str
"""
    @ingroup EXPORT_API
    @brief Export ZPrj file
    @return Output file path; output files will be created in MD 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.
"""
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.
"""
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.
"""
def ExportOBJ() -> list[str]
"""
    @ingroup EXPORT_API
    @brief Export OBJ file
    @param options If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
    @return Output file paths. It outputs the file paths of an OBJ file and its MTL file. 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 MD 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 its MTL file. 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 MD 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 its MTL file. 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 MD 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 its MTL file. 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 MD 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 its MTL file. 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 MD temporary folder.
"""
def ExportAlembic(_filePath : str, _options : ImportExportOption) -> list[str]
"""
    @ingroup EXPORT_API
    @brief Export Alembic
    @param options: If "options" is given, it exports Alembic according to options, not allowing user for selecting options in Export Dialog.
    @return Output file paths.
"""
def ExportAlembicW(_filePath : str, _options : ImportExportOption) -> list[str]
"""
    @ingroup EXPORT_API
    @brief Export Alembic W
    @param options: If "options" is given, it exports Alembic according to options, not allowing user for selecting options in Export Dialog.
    @return Output file paths.
"""
def ExportThumbnail3D() -> str
"""
    @ingroup EXPORT_API
    @brief Export thumbnail of the current scene
    @return Output file path: output files will be created in MD 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.
"""
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.
"""
def ExportThumbnail2D(_filePath : str) -> str
"""
    @ingroup EXPORT_API
    @brief Capture the 2D window exactly as it is displayed (current camera, zoom and view size) and save it as an image. Unlike ExportSnapshot2D it does not enter the snapshot mode and does not re-frame the patterns, so the image matches what the user sees.
    @param _filePath: output file path to save the screenshot (PNG or JPEG chosen by the extension)
    @return Output file path. If an error occurs, return empty string. Needs the 2D window, so it returns an empty string in headless mode.
"""
def ExportSnapshot3D(_filePath : str) -> list[ list [ str ] ]
"""
    @ingroup EXPORT_API
    @brief Export snapshot images. This function displays the same dialog as MD 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 paths of the output files. 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 MD temporary folder.
"""
def ExportSnapshot3D() -> list[ list [ str ] ]
"""
    @ingroup EXPORT_API
    @brief Export snapshot images. This function displays the same dialog as MD 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 paths of the output files. 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 MD temporary folder.
"""
def ExportSnapshot3DW(_filePath : str) -> list[ list [ str ] ]
"""
    @ingroup EXPORT_API
    @brief Export snapshot images. This function displays the same dialog as MD 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 paths of the output files. 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 MD 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
"""
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
"""
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 MD 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 MD 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 MD 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 MD 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.
    @param _filePath: output file path
    @return Output file path. If an error occurs, return empty string.
"""
def ExportAnimationVideoW(_filePath : str) -> str
"""
    @ingroup EXPORT_API
    @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer.
    @param _filePath: output file path
    @return Output file path. If an error occurs, return empty wstring.
"""
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 MD 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.
"""
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.
"""
def GetAvatarCount() -> int
"""
    @ingroup EXPORT_API
    @brief Get the number of avatars loaded in MD
    @return total count of avatars
"""
def GetAvatarNameList() -> list[str]
"""
    @ingroup EXPORT_API
    @brief Get all the names of avatars loaded in MD
    @return the list of name of all avatars
"""
def GetAvatarNameListW() -> list[str]
"""
    @ingroup EXPORT_API
    @brief Get all the names of avatars loaded in MD
    @return the list of name of all avatars
"""
def GetAvatarGenderList() -> list[int]
"""
    @ingroup EXPORT_API
    @brief Get all the genders of avatars loaded in MD 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.
    @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 MD 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.
    @param _filePath: the output file path to export the turntable snapshots
    @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
    @param _width: image width for the snapshots
    @param _height: image height for the snapshots
    @param _startIndex: specifies the starting index position of the turntable.
    @return Output file path list. If an error occurs, return empty string.
"""
def ExportTurntableImagesW(_filePath : str, _numberOfImages : int, _width : int, _height : int, _startIndex : int) -> list[str]
"""
    @ingroup EXPORT_API
    @brief Export turntable images.
    @param _filePath: the output file path to export the turntable snapshots
    @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
    @param _width: image width for the snapshots
    @param _height: image height for the snapshots
    @param _startIndex: specifies the starting index position of the turntable.
    @return Output file path list. If an error occurs, return empty string.
"""
def ExportPose() -> str
"""
    @ingroup EXPORT_API
    @brief Export Pose file in the MD temporary folder
    @return Output file path. If an error occurs, return empty string. Output files will be created in MD temporary folder.
"""
def ExportPose(_filePath : str) -> str
"""
    @ingroup EXPORT_API
    @brief Export Pose file
    @param string _filePath : target file path in ASCII
    @return Output file path. If an error occurs, return empty string.
"""
def ExportPoseW(_filePath : str) -> str
"""
    @ingroup EXPORT_API
    @brief Export Pose file
    @param wstring _filePath : target file path in UNICODE
    @return Output file path. If an error occurs, return empty wstring.
"""
def ExportFBX(_options : ImportExportOption) -> list[str]
"""
    @ingroup EXPORT_API
    @brief Export FBX file
    @param _options: It exports FBX according to options, not allowing user for selecting options in Export Dialog.
    @return Output file paths. Output files will be created in MD 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.
"""
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.
"""
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.
"""
def ExportAVTW(_filePath : str) -> str
"""
    @ingroup EXPORT_API
    @brief Export AVT
    @param _filePath: output file path
    @return Output file path. If an error occurs, return empty string.
"""
def ExportStdViewImage(_viewIndex : int, _outputFolderPath : str, _colorwayIndex : int, _width : int, _height : int, _bFitAllObjects : bool) -> str
"""
    @ingroup EXPORT_API
    @brief ExportStdViewImage : Exports the image for the given standard view index with a framing choice. By default (and in the 5-argument overload) the camera is fitted to the garment patterns only; pass _bFitAllObjects=true to fit the whole scene including the avatar. Standard view indexes: 0=Bottom, 1=FrontRight, 2=Front, 3=FrontLeft, 4=Right, 5=Top, 6=Left, 7=Custom, 8=Back.
    @param _viewIndex: standard view index (0=Bottom, 1=FrontRight, 2=Front, 3=FrontLeft, 4=Right, 5=Top, 6=Left, 7=Custom, 8=Back)
    @param _outputFolderPath: output file path including the image extension
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _width: image width for the snapshot
    @param _height: image height for the snapshot
    @param _bFitAllObjects: true = frame the whole scene (avatar + garment); false = frame the garment patterns only (same as the 5-argument overload)
    @return JSON with the output file path. 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. Output files will be created in MD 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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""

FABRIC_API

def GetFabricCount(_bCurrentColorway : bool) -> int
"""
    @ingroup FABRIC_API
    @brief Get the number of fabrics
    @param _bCurrentColorway: has no effect in Marvelous Designer (Default: true)
    @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..
"""
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 MD 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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
def AddFabric(inputFilePath : str) -> int
"""
    @ingroup FABRIC_API
    @brief Add Fabric into the Object Browser
    @param inputFilePath: 'zfab'(MD 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'(MD 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'(MD 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.
"""
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.
"""
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: use 1. Marvelous Designer has no colorways, so 2 and 3 give the same result.
    @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
    @param fabricIndex: the target fabric index in the object browser to delete
    @return if it succeeds, return true.
"""
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
"""
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.
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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)
"""
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)
"""
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
"""
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
"""
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)
"""
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)
"""
def GetPrimaryFabric() -> int
"""
    @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
"""
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
"""
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
"""
def GetFabricStyleNameList() -> list[str]
"""
    @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.
"""
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.
"""
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
"""
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"
"""
def SetSubstancePreset(fabricIndex : int, materialFace : int, presetIndex : int) -> None
"""
    @ingroup FABRIC_API
    @brief Set Substance Preset
    @param fabricIndex: the target fabric index in the object browser
    @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
    @param presetIndex: the preset index to set
"""
def SetSubstanceResolution(fabricIndex : int, materialFace : int, resolutionIndex : int) -> None
"""
    @ingroup FABRIC_API
    @brief Set Substance Resolution
    @param fabricIndex: the target fabric index in the object browser
    @param materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
    @param resolutionIndex: the resolution index to set
"""
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.
"""
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.
"""
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
"""
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.
"""
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
"""
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.
"""
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.
"""
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.
"""
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
"""
def SetCurrentFabricIndex(_index : int) -> bool
"""
    @ingroup FABRIC_API
    @brief Set Current Fabric Index
    @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
"""
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
"""
def GetRoughnessType(_index : int, _materialFace : int) -> int
"""
    @ingroup FABRIC_API
    @brief Get Material RoughnessType
    @param _index: Fabric Index, _materialFace : Fabric Material Face Type (0 : Front , 1 : BACK , 2 : SIDE)
    @return Return fabric's material Roughness Type. ( 0 : Intensity, 1 : Map )
"""
def SetRoughnessType(_index : int, _materialFace : int, _roughnessType : int) -> None
"""
    @ingroup FABRIC_API
    @brief Set Current Fabric's material roughnessType
    @param _index: Fabric Index, _materialFace : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _roughnessType : roughnessType to be set ( 0 : Intensity, 1 : Map )
    @return Fabric setting success or failure return
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
def SetRoughnessValueMapInvert(_index : int, _face : int, _bInvert : bool) -> None
"""
    @ingroup FABRIC_API
    @brief Set whether roughness map is inverted
    @param _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), bInvert : Whether roughness map is inverted.
"""
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.
"""
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.
"""
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.
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def SetMaterialType(_fabricIndex : int, _materialFace : int, _materialType : int) -> None
"""
    @ingroup FABRIC_API
    @brief Set material type
    @param _fabricIndex: the target fabric index in the object browser
    @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
    @param _materialType: material type value
"""
def GetOpacityIntensity(_fabricIndex : int, _materialFace : int) -> float
"""
    @ingroup FABRIC_API
    @brief Get opacity intensity in percent
    @param _fabricIndex: the target fabric index in the object browser
    @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
    @return opacity intensity value
"""
def SetOpacityIntensity(_fabricIndex : int, _materialFace : int, _opacityIntensity : float) -> None
"""
    @ingroup FABRIC_API
    @brief Set opacity intensity in percent
    @param _fabricIndex: the target fabric index in the object browser
    @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
    @param _opacityIntensity: opacity intensity value
"""
def GetBaseTextureMapImageFilePath() -> str
"""
    @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
"""
def GetDisplacementMapImageFilePath() -> str
"""
    @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
"""
def GetRoughnessMapImageFilePath() -> str
"""
    @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
"""
def GetBaseTextureMapImageFilePathW() -> str
"""
    @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
"""
def GetDisplacementMapImageFilePathW() -> str
"""
    @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
"""
def GetRoughnessMapImageFilePathW() -> str
"""
    @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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def GetBaseTextureMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Get base texture map image file path of specified fabric and material face
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return image file path string. Returns empty string if parameters are invalid.
"""
def GetNormalMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Get normal map image file path of specified fabric and material face
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return image file path string. Returns empty string if parameters are invalid.
"""
def GetDisplacementMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Get displacement map image file path of specified fabric and material face
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return image file path string. Returns empty string if parameters are invalid.
"""
def GetOpacityMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Get opacity map image file path of specified fabric and material face
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return image file path string. Returns empty string if parameters are invalid.
"""
def GetRoughnessMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Get roughness map image file path of specified fabric and material face
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return image file path string. Returns empty string if parameters are invalid.
"""
def GetMetalnessMapImageFilePath(_colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Get metalness map image file path of specified fabric and material face
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return image file path string. Returns empty string if parameters are invalid.
"""
def SetBaseTextureMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Set base texture map image for specified fabric and material face. If an empty string is passed, the existing texture will be removed.
    @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return An empty string in Marvelous Designer.
"""
def SetNormalMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Set normal map image for specified fabric and material face. If an empty string is passed, the existing texture will be removed.
    @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return An empty string in Marvelous Designer.
"""
def SetDisplacementMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Set displacement map image for specified fabric and material face. If an empty string is passed, the existing texture will be removed.
    @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return An empty string in Marvelous Designer.
"""
def SetOpacityMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Set opacity map image for specified fabric and material face. If an empty string is passed, the existing texture will be removed.
    @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return An empty string in Marvelous Designer.
"""
def SetRoughnessMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Set roughness map image for specified fabric and material face. If an empty string is passed, the existing texture will be removed.
    @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return An empty string in Marvelous Designer.
"""
def SetMetalnessMapImageGivenFilePath(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _materialFace : int) -> str
"""
    @ingroup FABRIC_API
    @brief Set metalness map image for specified fabric and material face. If an empty string is passed, the existing texture will be removed.
    @param _imageFilePath: image file path to set. If empty, the applied texture map will be removed from the material face.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _materialFace: target material face (0: Front, 1: Back, 2: Side)
    @return An empty string in Marvelous Designer.
"""
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".
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
def TransformAOPOnFabric(_aopMode : int, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _transformOptions : TransformOptions, _materialSide : int) -> str
"""
    @ingroup FABRIC_API
    @brief Transform (rotate, scale, translate) an AOP texture on a fabric. Works for both Print and BaseColorMap modes.
    @param _aopMode: texture application mode: 0=Print, 1=BaseColorMap
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: target fabric index in the object browser
    @param _styleChipIndex: target AOP style chip index (>= 0 for specific style chip, -1 for all applicable style chips). Only used in Print mode (_aopMode=0)
    @param _transformOptions: transformation options containing angle, width/height (mm/percent), position, and aspect ratio settings
    @param _materialSide: which material face: 0=Front (default), 1=Back, 2=Side
    @return JSON string with "status" (success/failure) and "description" (details about the operation)
"""
def AddTextureToPatterns(_imageFilePath : str, _colorwayIndex : int, _fabricIndex : int, _styleChipIndex : int, _aopMode : int, _materialSide : int) -> str
"""
    @brief Apply an AOP texture to a specific fabric.
    @param _imageFilePath: path to the AOP texture image file (.png, .jpg, .sbsar, etc.)
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _fabricIndex: target fabric index in the object browser.
    @param _styleChipIndex: target AOP style chip index within the fabric's style chip list. Use -1 to target all style chips.
    @param _aopMode: how to apply the texture: 0=Print (default), 1=BaseColorMap
    @param _materialSide: which material face to apply to: 0=Front (default), 1=Back, 2=Side
    @return A JSON string with format: {\"status\": \"done\"|\"error\", \"description\": \"message\"}. Status is \"done\" on success, \"error\" on failure.
"""

IMPORT_API

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.
"""
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.
"""
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.
"""
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.
"""
def ImportOBJ(_filePath : str, _options : ImportExportOption) -> bool
"""
    @ingroup IMPORT_API
    @brief Import OBJ file
    @note Set `_options.ImportObjectType` to choose what the OBJ becomes:
    0 = Avatar (**the default**), 1 = Trim, 2 = Garment. Leaving it unset
    imports the mesh as an avatar, which does not move when you simulate -
    to import a simulatable garment, as the GUI's "Import (Add) - OBJ to
    Garment" does, set it to 2. Any other value returns false. A garment import
    shows no dialog, and when it fails it returns false with the scene untouched
    (even with bAdd = false). With bAdd = true it is moved by
    translationValueX/Y/Z, as an avatar or trim is (earlier versions ignored the
    translation for a garment). See ImportOBJ_Garment_Sample in the ExportPlugin
    sample. [DEV-21495]
    @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. See the note above for ImportObjectType.
    @return if it succeeds, return true.
"""
def ImportOBJW(_filePath : str, _options : ImportExportOption) -> bool
"""
    @ingroup IMPORT_API
    @brief Import OBJ file
    @note Set `_options.ImportObjectType`: 0 = Avatar (**the default**), 1 = Trim,
    2 = Garment. See ImportOBJ for the full note. [DEV-21495]
    @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. See the note above for ImportObjectType.
    @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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
def ImportSMP(_filePath : str) -> bool
"""
    @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.
"""
def ImportAsGraphic(_filePath : str) -> None
"""
    @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
"""
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
"""
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
"""
def ImportAvatar(_avtPath : str, _opt : ImportExportOption) -> bool
"""
    @ingroup IMPORT_API
    @brief Import Avatar
    @param _avtPath : input Avatar file path, _opt : input load options
"""
def ImportPose(_filePath : str) -> bool
"""
    @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
"""
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
"""
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
"""
def ImportAlembic(filePath : str, option : ImportAlembicOption) -> bool
"""
    @ingroup IMPORT_API
    @brief Import an alembic (.abc) file.
    @note Axis orientation is set through `option.axisX/Y/Z` and
    `option.bInvertX/Y/Z`, mirroring the Axis Conversion frame of the GUI
    Alembic import dialog. Defaults are identity (0/1/2, no inversion).
    Frame rate is not a per-import option: an API import uses the default
    30 fps.
    @note `option.loadObjectType` selects what the .abc becomes: 0 = Avatar (the
    default), 1 = Morph Target, i.e. vertex animation applied to the avatar
    already in the scene, using `option.morphingFrameCount` as the transition
    length. These are the two types Alembic supports; the GUI dialog offers
    both. [DEV-21494]
    @note Returns false, without importing, unless axisX/Y/Z are 0, 1 and 2 in some
    order, for a loadObjectType other than 0 or 1, or for a Morph Target
    morphingFrameCount outside 1..99. A Morph Target that does not match the
    avatar in the scene also returns false. No dialog is ever shown; the reason
    is printed and kept in MessageLogger.
    @param filePath: input file path
    @param option: alembic import options
"""
def ImportZpac(filePath : str, loadOption : ImportExportOption) -> bool
"""
    @ingroup IMPORT_API
    @brief Import Zpac file
    @param filePath: input file path
    @param loadOption: If "loadOption" is given, it imports zpac according to options, not allowing user for selecting options in Import Dialog.
    @return if it succeeds, return true.
"""

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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def GetPatternInputInformation() -> str
"""
    @ingroup PATTERN_API
    @brief Get the pattern input information which is using for pattern index
    @param patternIndex: the pattern index to get the pattern input information
    @return json string for pattern input information
"""
def GetPatternInputInformationW() -> str
"""
    @ingroup PATTERN_API
    @brief Get the pattern input information which is using for pattern index
    @param patternIndex: the pattern index to get the pattern input information
    @return json string for pattern input information
"""
def GetPatternPieceArea(_patternIndex : int) -> float
"""
    @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
"""
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
"""
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.
"""
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.
"""
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.
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def SetParticleDistanceOfPatterns(_length : float) -> None
"""
    @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
"""
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
"""
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
"""
def SetHeightShrinkagePercentage(_patternIndex : int, _height : float) -> None
"""
    @ingroup PATTERN_API
    @brief Set Height Shrinkage Percentage using pattern index, height
    @param  _patternIndex: the pattern index to set the pattern height shrinkage percentage,
    _height: the height value to determine height shrinkage percentage
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def CopyPatternPieceMove(_patternPieceIndex : int, _offsetX : float, _offsetY : float) -> int
"""
    @ingroup PATTERN_API
    @brief Copy Pattern using the pattern index and x,y offset distance
    @param  _patternPieceIndex: the pattern index for copying pattern
    _offsetX, _offsetY : the value to determine pattern copy offset distance,
    @return return copy pattern index
"""
def DeletePatternPiece(_patternIndex : int) -> None
"""
    @ingroup PATTERN_API
    @brief Delete Pattern using the pattern index
    @param  _patternIndex: the pattern index for delete pattern
"""
def DeleteLine(_patternIndex : int, _lineIndex : int) -> None
"""
    @ingroup PATTERN_API
    @brief Delete a line from a pattern
    @param  _patternIndex: the pattern index for delete pattern
    @param  _lineIndex: the line index for delete line
"""
def DeletePoint(_patternIndex : int, _pointIndex : int) -> None
"""
    @ingroup PATTERN_API
    @brief Delete a point from a pattern
    @param  _patternIndex: the pattern index for delete pattern
    @param  _pointIndex: the point index for delete point
"""
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
"""
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
"""
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
"""
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,
"""
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
"""
def UnfoldPatternPieceWithPatternName(_patternName : str, _lineIndex : int, _bHalfSymmetry : bool) -> bool
"""
    @ingroup PATTERN_API
    @brief Unfold Pattern using the pattern name and line index and halfSymmetry option
    @param  _patternName: the pattern index for unfold pattern
    @param  _lineIndex: the line index for unfold line
    @param  _bHalfSymmetry: the value to make halfSymmetry pattern
    @return return true if success, false otherwise
"""
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
"""
def InstancePatternPiece(_patternIndex : int) -> None
"""
    @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
"""
def InstancePatternPieceWithPatternName(_patternName : str) -> None
"""
    @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
"""
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
"""
def GetPatternPieceFabricIndex(_patternPieceIndex : int) -> int
"""
    @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
"""
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
"""
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
"""
def GetPatternPieceClassification(_patternPieceIndex : int) -> str
"""
    @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
"""
def IsPatternPieceSolidify(_patternPieceIndex : int) -> bool
"""
    @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
"""
def GetPatternPieceSolidifyStrengthen(_patternPieceIndex : int) -> float
"""
    @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 Strengthen using the pattern index
    @param  _patternPieceIndex: the pattern index to set
    _strengthen : strengthen value to set
"""
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
"""
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
"""
def SetPatternPiecePos(_patternIndex : int, _x : float, _y : float) -> None
"""
    @brief  Set Pattern piece's world position to (_x, _y)
    @param  _patternIndex: The pattern index to move
    _x: The X position of pattern want to move
    _y: The Y position of pattern want to move
"""
def SetPatternPieceMove(_patternIndex : int, _offsetX : float, _offsetY : float) -> None
"""
    @brief  Set Pattern piece's world position to (CurrentPosition.x + _offsetX, CurrentPosition.y + _offsetY)
    @param  _patternIndex: The pattern index to move
    _offsetX: The X position offset of pattern want to move
    _offsetY: The Y position offset of pattern want to move
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def SetPatternLayer(_patternIndex : int, _layer : int) -> None
"""
    @ingroup PATTERN_API
    @brief Set Pattern Layer using pattern index, layer
    @param  patternIndex: the pattern index to set the pattern layer,
    layer: the layer value to determine pattern layer
    @return BaseShapeIndex
"""
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,
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def GetPatternAssignedTopstitchCount(_patternIndex : int) -> int
"""
    @ingroup PATTERN_API
    @brief Get Pattern Assigned Topstitch Count
    @param  none
    @return Output int Count Pattern Assigned Topstitch Count; If an error occurs, return -1
"""
def GetPatternAssignedTopstitchStyle(_patternIndex : int) -> list[map[str, str]]
"""
    @ingroup PATTERN_API
    @brief Get Pattern Assigned Topstitch style
    @param  none
    @return Output vector map string Pattern Assigned Topstitch Style (Topstitch style Name, Count); If an error occurs, return vector vMap
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def GetLinkedPatternIndex(patternIndex : int) -> list[int]
"""
    @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
"""
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)
"""
def ExportObjectBrowserMaterialsList() -> str
"""
    @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
"""
def RemovePin() -> bool
"""
    @ingroup PATTERN_API
    @brief Removes Pin one by one
"""
def RemoveAllPins() -> bool
"""
    @ingroup PATTERN_API
    @brief Removes all active pins
"""
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
"""
def GetSeamlinePairGroupCount() -> int
"""
    @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
"""
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
"""
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
"""
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
"""
def ExportPatternCPX(_path : str) -> bool
"""
    @ingroup PATTERN_API
    @brief Export pattern information in binary .cpx (MD Pattern eXchange) format.
    Returns false on hosts without MD_HAS_PATTERN_API_CPX support
    (e.g. WASM builds).
    @return boolean result of exporting cpx file
"""
def ImportPatternCPX(_path : str) -> bool
"""
    @ingroup PATTERN_API
    @brief Import pattern information from a .cpx binary file.
    Returns false on hosts without MD_HAS_PATTERN_API_CPX support.
    @return boolean result of importing cpx file
"""
def ConvertPatternJSONToCPX(_jsonPath : str, _cpxPath : str) -> bool
"""
    @ingroup PATTERN_API
    @brief Convert a .json pattern file to a .cpx binary. Replaces the
    current scene with the JSON content while converting - call
    this only on a document you don't need to keep, not mid-session
    on a document with unsaved work.
    Useful for batch conversion / vendor pipelines.
    Returns false on hosts without MD_HAS_PATTERN_API_CPX support.
    @return boolean result of conversion
"""
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.
"""
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
"""
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
"""
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
"""
def AddSeamlinePairGroupPartial(_patternAIndex : int, _lineAIndex : int, _startRatioA : float, _endRatioA : float, _directionA : bool, _patternBIndex : int, _lineBIndex : int, _startRatioB : float, _endRatioB : float, _directionB : bool) -> int
"""
    @ingroup PATTERN_API
    @brief Add sewing between sub-segments of two pattern outline lines (pattern A line <-> pattern B line).
    Unlike AddSeamlinePairGroup, which always sews the whole line, each side here sews only the
    portion of its line between the given ratios, so a seam can cover part of an edge.
    The resulting stitch is identical to a manually created one and simulates the same way.
    @return Marvelous::SeamlinePairGroupResult - SEAMLINE_PAIR_SUCCESS (0) on success, a negative code on failure.
    Test against SEAMLINE_PAIR_SUCCESS rather than for truthiness, because 0 is falsy in Python.
    @param _patternAIndex : A pattern index
    @param _lineAIndex : The index of the line that belongs to the A pattern.
    @param _startRatioA : Where the seam starts along the A line, normalized to the line length. 0.0 is the line start, 1.0 the line end.
    @param _endRatioA : Where the seam ends along the A line. Must be strictly greater than _startRatioA.
    @param _directionA : The direction of the stitching, true : forward, false : backward
    @param _patternBIndex : B pattern index
    @param _lineBIndex : The index of the line that belongs to the B pattern.
    @param _startRatioB : Where the seam starts along the B line, normalized to the line length.
    @param _endRatioB : Where the seam ends along the B line. Must be strictly greater than _startRatioB.
    @param _directionB : The direction of the stitching, true : forward, false : backward
    @remark Ratios are used verbatim; notch snapping is not applied. Call from the thread that owns the
    scene, as with the other pattern-editing APIs.
    @remark This call reports only a status code. To act on the new seam afterwards, diff
    GetSeamlinePairGroupListInPattern(_patternAIndex) across the call to get its index.
"""
def AddSeamlinePairGroupPartial(_patternAIndex : int, _lineAIndex : int, _startRatioA : float, _endRatioA : float, _directionA : bool, _patternBIndex : int, _childBIndex : int, _lineBIndex : int, _startRatioB : float, _endRatioB : float, _directionB : bool) -> int
"""
    @ingroup PATTERN_API
    @brief Add sewing between a sub-segment of a pattern outline line and a sub-segment of an inner shape line
    (pattern A outline <-> pattern B inner shape).
    @return Marvelous::SeamlinePairGroupResult - SEAMLINE_PAIR_SUCCESS (0) on success, a negative code on failure.
    @param _patternAIndex : A pattern index
    @param _lineAIndex : The index of the line that belongs to the A pattern.
    @param _startRatioA : Where the seam starts along the A line, normalized to the line length.
    @param _endRatioA : Where the seam ends along the A line. Must be strictly greater than _startRatioA.
    @param _directionA : The direction of the stitching, true : forward, false : backward
    @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 _startRatioB : Where the seam starts along the B line, normalized to the line length.
    @param _endRatioB : Where the seam ends along the B line. Must be strictly greater than _startRatioB.
    @param _directionB : The direction of the stitching, true : forward, false : backward
    @remark This call reports only a status code. To act on the new seam afterwards, diff
    GetSeamlinePairGroupListInPattern(_patternAIndex) across the call to get its index.
"""
def AddSeamlinePairGroupPartial(_patternAIndex : int, _childAIndex : int, _lineAIndex : int, _startRatioA : float, _endRatioA : float, _directionA : bool, _patternBIndex : int, _childBIndex : int, _lineBIndex : int, _startRatioB : float, _endRatioB : float, _directionB : bool) -> int
"""
    @ingroup PATTERN_API
    @brief Add sewing between sub-segments of two inner shape lines (pattern A inner shape <-> pattern B inner shape).
    @return Marvelous::SeamlinePairGroupResult - SEAMLINE_PAIR_SUCCESS (0) on success, a negative code on failure.
    @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 _startRatioA : Where the seam starts along the A line, normalized to the line length.
    @param _endRatioA : Where the seam ends along the A line. Must be strictly greater than _startRatioA.
    @param _directionA : The direction of the stitching, true : forward, false : backward
    @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 _startRatioB : Where the seam starts along the B line, normalized to the line length.
    @param _endRatioB : Where the seam ends along the B line. Must be strictly greater than _startRatioB.
    @param _directionB : The direction of the stitching, true : forward, false : backward
    @remark This call reports only a status code. To act on the new seam afterwards, diff
    GetSeamlinePairGroupListInPattern(_patternAIndex) across the call to get its index.
"""
def GetSelectedPattern() -> list[str]
"""
    @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 pattern 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 clear 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 clear 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
"""
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
"""
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
"""
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
"""
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
"""
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)
"""
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
"""
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.
"""
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.
    @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.
"""
def GetLinkedPatternLists() -> str
"""
    @ingroup PATTERN_API
    @brief Get all linked pattern group lists (e.g., Layer Clone)
    @return json string containing all linked pattern group information, If an error occurs or no linked patterns exist, return empty string
"""
def GetPatternComponents(_patternIndex : int, _types : list[str]) -> str
"""
    @ingroup PATTERN_API
    @brief Enumerate the components applied to pattern pieces — everything mounted on the fabric rather than the
    fabric itself: buttons, buttonholes, graphics, prints, zippers and trims (buckles, rings, beads, ...).
    @param _patternIndex: target pattern index (RealPatternList order, as used by GetPatternCount /
    MovePatternsToUVSpace). Pass -1 for every pattern in the scene.
    @param _types: component types to report — any of "button", "buttonhole", "graphic", "print", "zipper",
    "trim". Pass an empty list to report every type. An unknown name fails the call. Both arguments are required.
    @return JSON: {"status","patterns":[{"patternIndex","patternName","components":[...]}]}. The response shape is
    the same whether one pattern or all were requested — a single pattern comes back as a one-element
    "patterns" array. Patterns with nothing applied have an empty "components" array.
    "status" is one of "success" or "failed" (the complete set); on "failed" a "message" explains why and
    "patterns" is absent.

    Component field schema. Every field listed for a type is ALWAYS present on components of that type -
    there are no conditional fields - so consumers can read them directly without membership checks.
    "Unset" values are signalled in-band (see the field notes) rather than by omitting the key:

    type          | fields (in addition to the common four)
    --------------+-----------------------------------------------------------------------
    (every type)  | type, name, uid, patternIndex
    button        | styleIndex, position{x,y}, angle
    buttonhole    | styleIndex, position{x,y}, angle
    graphic       | styleIndex, styleName, position{x,y}, angle, width, height
    print         | styleIndex, styleName, position{x,y}, angle, width, height
    zipper        | (none - the common four only)
    trim          | trimType, styleName

    Field notes:
    "type"        one of "button", "buttonhole", "graphic", "print", "zipper", "trim".
    "uid"         runtime handle, regenerated on load - never persist it between sessions.
    "styleIndex"  index into that type's style library (button head / buttonhole / graphic style list,
    the same ordering as GetGraphicStyleListWithIndex for graphics). -1 when no style is
    assigned or it cannot be resolved.
    "styleName"   JSON null when no style is assigned.
    "position"    millimetres. NOTE: buttons/buttonholes report 2D-window world coordinates while
    graphics/prints report pattern-local coordinates - do not compare the two directly.
    "trimType"    e.g. "Buckle", "Ring", "Bead"; "None" when the trim has no type set.
    A zipper relates to both patterns its tapes are stitched to, so it is reported under each of them.
"""
def GetPatternGroupsBySeamlineConnectivity(_bIncludeAttachments : bool, _bIncludeComponents : bool) -> str
"""
    @ingroup PATTERN_API
    @brief Split the scene's pattern pieces into garment groups by connectivity, so e.g. a shirt and a pant
    loaded in one project come back as two separate groups. Pieces are treated as belonging to the same
    garment when they are joined by ANY of: a seamline (sewing), glue (a gluing shape copied from a shape
    on the other piece), a zipper (its two tapes), or a lacing (one lace threading holes on several
    pieces). Groups are the connected components of that combined graph.
    @param _bIncludeAttachments: when true, patterns fastened by a locked button-buttonhole pair are also merged.
    This is opt-in because, unlike sewing/glue/zipper/lacing, a button can be unfastened by the wearer
    and may join two garments that should stay separate (default false)
    @param _bIncludeComponents: when true, each group also carries a "components" array with the non-fabric
    component instances (buttons, buttonholes, graphics/prints, zippers, trims) applied to its patterns,
    deduplicated by uid (a zipper spanning two patterns of the group is reported once). Same per-component
    fields as GetNonFabricComponentsOnPattern. Default false.
    @return JSON: {"status","groupCount","groups":[{"groupIndex","patternIndices":[int...],"patternNames":[string...],"patterns":[{"index","name"}...],"components":[...]}]}
    "patterns" pairs each index with its piece name so callers can map one to the other directly;
    "patternIndices" stays a plain int list because MovePatternsToUVSpace / ExportGLTF take it as is.
    ("components" present only when _bIncludeComponents is true). Groups are ordered largest first.
    Indices are RealPatternList order (as used by GetPatternCount / MovePatternsToUVSpace).
    On failure: {"status":"failed","message"}.
"""
def GetPatternsAttachedToAvatarMeasures() -> list[map[str, str]]
"""
    @ingroup PATTERN_API
    @brief Retrieve all patterns that are currently attached (pinned/tacked) to avatar measures,
    grouped by avatar measure. Each entry in the returned vector represents one avatar measure
    and contains the following keys:
    "avatarMeasureName" - name of the avatar measure,
    "patternNames"      - comma-separated names of all patterns attached to that measure.
    @return Vector of maps. Each map represents one avatar measure. Returns an empty vector when
    no patterns are attached to any avatar measure.
"""
def GetPatternArchiveState(_patternIndex : int) -> bool
"""
    @brief Get the archive state of a pattern using the pattern index
    @param _patternIndex: the pattern index to get the archive state
    @return true if the pattern is archived, false otherwise
"""
def SetPatternArchiveState(_patternIndex : int, _archiveState : bool) -> None
"""
    @ingroup PATTERN_API
    @brief Set the archive state of a pattern using the pattern index
    @param _patternIndex: the pattern index to set the archive state
    @param _archiveState: true to archive the pattern, false to unarchive
"""
def GetPatternUVSpace(_patternIndex : int) -> str
"""
    @ingroup PATTERN_API
    @brief Query which UV tile a pattern currently occupies (its origin tile).
    @param _patternIndex: target pattern index (RealPatternList order)
    @return JSON: {"status","patternIndex","uvSpace","tile":{"x","y"},"bbox":{"x","y","width","height"}} or {"status":"failed","message"}
"""
def MovePatternToUVSpace(_patternIndex : int, _uvTileX : int, _uvTileY : int, _offsetX : float, _offsetY : float, _bAllowRotation : bool, _scale : float, _padding : float) -> str
"""
    @ingroup PATTERN_API
    @brief Pack a pattern into the target UV tile (via the nesting engine), with optional in-tile placement.
    @param _patternIndex: target pattern index (RealPatternList order)
    @param _uvTileX: target UV tile column (>= 0)
    @param _uvTileY: target UV tile row (>= 0)
    @param _offsetX: post-pack X offset, normalized 0..1 of the tile (default 0)
    @param _offsetY: post-pack Y offset, normalized 0..1 of the tile (default 0)
    @param _bAllowRotation: allow the nester to rotate patterns to fit, like the UV Packing dialog Rotation option ({0,90,180,270} when true, {0} when false). Default false
    @param _scale: uniform pre-scale about the pattern's UV center, must be > 0 (default 1)
    @param _padding: spacing kept around each pattern while packing, normalized 0..1 of the tile (default 0)
    @return JSON: {"status","results":[{"patternIndex","ok","fromTile":{"x","y"},"toTile":{"x","y"},"bbox"}],"message"}
"""
def MovePatternsToUVSpace(_patternIndices : list[int], _uvTileX : int, _uvTileY : int, _offsetX : float, _offsetY : float, _bAllowRotation : bool, _scale : float, _padding : float) -> str
"""
    @ingroup PATTERN_API
    @brief Batch-pack multiple patterns into the target UV tile (one undo step; per-item success/failure reported).
    @param _patternIndices: target pattern indices (RealPatternList order)
    @param _uvTileX: target UV tile column (>= 0)
    @param _uvTileY: target UV tile row (>= 0)
    @param _offsetX: post-pack X offset, normalized 0..1 of the tile (default 0)
    @param _offsetY: post-pack Y offset, normalized 0..1 of the tile (default 0)
    @param _bAllowRotation: allow the nester to rotate patterns to fit, like the UV Packing dialog Rotation option ({0,90,180,270} when true, {0} when false). Default false
    @param _scale: uniform pre-scale about each pattern's UV center, must be > 0 (default 1)
    @param _padding: spacing kept around each pattern while packing, normalized 0..1 of the tile (default 0)
    @return JSON: {"status","results":[{"patternIndex","ok","fromTile":{"x","y"},"toTile":{"x","y"},"bbox"}],"message"}
"""
def MoveNonFabricObjectsToUVSpace(_patternIndices : list[int], _uvTileX : int, _uvTileY : int, _offsetX : float, _offsetY : float, _bAllowRotation : bool, _scale : float, _padding : float, _componentTypes : list[str]) -> str
"""
    @ingroup PATTERN_API
    @brief Pack the UV islands of the non-fabric objects attached to the given patterns into the target UV tile —
    the companion of MovePatternsToUVSpace for hardware: buttons sitting on the patterns, the zipper
    tape(s) stitched to them, the zipper hardware (obj teeth/slider/puller/stoppers), and the trims
    (buckles, rings, beads, ...) glued to them. Note that button, zipper-hardware and trim islands are
    STYLE-level in the UV editor (one island per style, shared by every instance of that style) — moving
    them also affects other garments using the same style. Graphics/prints are not handled here because
    they follow their pattern's island automatically. Islands are deduplicated across the call.
    The objects are placed in the FREE part of the target tile: whatever is already in that tile and is not
    being moved (in practice the garment's pattern islands, put there by an earlier MovePatternsToUVSpace
    call) is measured first, the largest strip left over around it is chosen, and the nested objects are
    shrunk to fit that strip. So calling MovePatternsToUVSpace and then this function on the same tile
    does not make the objects land on top of the patterns.
    @return JSON: {"status","movedIslands","fitScale","freeBand":{"x","y","width","height"},"bbox",
    "results":[{"patternIndex","ok","objectIslands","message"}],"message"}. "objectIslands" is the number
    of attached-object islands contributed by that pattern (0 with ok=true means its objects were already
    packed via an earlier pattern in the same call). "fitScale" is the extra shrink applied to make the
    objects fit the free band (1 = none). On failure: {"status":"failed","message"}.
    @param _componentTypes: which object types to move — any of "button", "zipper", "trim". Empty (default) moves
    every type. Pass a single type to give e.g. all zippers one tile and all buttons another.
"""
def GetPatternOnBodyDetails() -> str
"""
    @ingroup PATTERN_API
    @brief Get details of all patterns and their position on the human body with semantic labels and body region grouping.
    Returns a JSON string with two top-level arrays, "upperBody" and "lowerBody", each
    containing the pattern objects that belong to that body section.
    Each pattern object includes:
    - patternName: name of the pattern piece
    - patternIndex: index in the real pattern list
    - arrangementPosition: internal body region ID (e.g. "Arm_Front_2_L")
    - semanticLabel: fine-grained garment part label (e.g. "sleeve", "bodice_front")
    - bodyRegion: high-level anatomical region (e.g. "torso_front", "arm_full", "leg_back")
    - patternPosition: front/back orientation derived from bodyRegion
    ("front", "back", "full", "side", "center", or "unknown")

    Arrangement position naming convention: {Region}_{Facing}_{Zone}_{Side}
    Region : body area        (Arm, Body, Leg, Wrist, Ankle, Neck, Head, Shoulder)
    Facing : orientation       (Front, Back, Inside, Outside, Center, Skirt, Calf)
    Zone   : vertical segment (1 = closest to torso, 2 = mid, 3 = distal)
    Side   : laterality        (L = Left, R = Right; omitted for center-line positions)

    Supported semantic labels:
    "bodice_front"      - front torso patterns (set-in, raglan, legacy, Adidas)
    "bodice_back"       - back torso patterns (set-in, raglan, legacy, Adidas)
    "bodice_full"       - full wrap-around torso patterns
    "sleeve"            - arm/sleeve patterns (set-in, raglan, dummy)
    "cuff"              - wrist cuff patterns
    "collar"            - collar/neck patterns (set-in, raglan, Adidas)
    "hem"               - bottom hem band of the top
    "placket"           - front placket (button/zipper strip)
    "waistband"         - waist transition patterns
    "pants_front"       - front pants panels
    "pants_back"        - back pants panels
    "pants_left"        - outer left leg panels
    "pants_right"       - outer right leg panels
    "pants_front_left"  - front left leg panel
    "pants_front_right" - front right leg panel
    "pants_back_left"   - back left leg panel
    "pants_back_right"  - back right leg panel
    "pants_full"        - full leg panel
    "skirt_front"       - front skirt patterns
    "skirt_back"        - back skirt patterns
    "skirt_full"        - full skirt patterns
    "cuff_leg"          - ankle cuff patterns
    "pocket"            - pocket patterns
    "unknown"           - unrecognized or unassigned

    Supported body regions:
    "torso_front" - front bodice, placket, front jacket pocket blocks
    "torso_back"  - back bodice blocks (set-in, raglan, legacy)
    "torso_full"  - full wrap-around bodice, hem, Adidas full body, body dummy blocks
    "arm_front"   - sleeve blocks (set-in, raglan, dummy)
    "arm_full"    - wrist cuff blocks (wraps around)
    "leg_front"   - front pants, front-left/right pants, front skirt, pants pocket blocks
    "leg_back"    - back pants, back-left/right pants, back skirt blocks
    "leg_side"    - outer seam leg panels (left/right)
    "leg_full"    - full pants, full skirt, ankle cuff, pants dummy blocks
    "neck"        - all collar blocks
    "waist"       - waistband blocks

    Patterns connected through seamline pairs form a single garment piece; each piece is
    classified by majority vote (torso/arm/neck -> upper body, leg/waist -> lower body,
    ties default to upper body) and every member is placed in the matching array.

    @return JSON string with two array keys, "upperBody" and "lowerBody", each containing
    the pattern detail objects for that section. On failure (no pattern editor),
    both arrays are empty so the response is always valid, parseable JSON.
"""
def GetPatternLineInfo(_patternIndex : int) -> str
"""
    @ingroup PATTERN_API
    @brief List a pattern's outline lines to help pick the _lineIndex for AttachPatternToAvatarMeasure.
    lineIndex matches GetLineLength / DeleteLine ordering. Coordinates are 2D pattern-window units.
    @param _patternIndex: target pattern index (RealPatternList order)
    @return JSON: {"status","patternIndex","patternName","lineCount",
    "boundingBox":{"minX","minY","maxX","maxY","width","height"},
    "lines":[{"lineIndex","length"(mm),"orientation"("horizontal"|"vertical"|"diagonal"),
    "location"("top"|"bottom"|"left"|"right"|"top-left"|...|"center"),
    "start":{x,y},"end":{x,y},"mid":{x,y},"midNorm":{x,y}(0..1 in bbox)}]}.
    On failure: {"status":"failed","message"}.
"""
def AttachPatternToAvatarMeasure(_patternIndex : int, _lineIndex : int, _avatarMeasureName : str) -> str
"""
    @ingroup PATTERN_API
    @brief Attach a pattern line to an avatar measure (Line Pin) - the programmatic equivalent of the manual
    "Attach to Measure (Avatar)" workflow. Runs the cloth solver afterwards so the result is visible
    without a separate Simulate() call. Registered as one undo step.
    @param _patternIndex: target pattern index (RealPatternList order)
    @param _lineIndex: outline line index to pin (see GetPatternLineInfo)
    @param _avatarMeasureName: avatar measure name (height/linear measures are rejected)
    @return JSON: {"status","message","patternIndex","patternName","lineIndex","lineLength",
    "avatarMeasureIndex","avatarMeasureName","measureBasicLength","measureSurfaceLength"}
    (lengths in mm). On failure: {"status":"failed","message"}.
"""
def GetUnusedSinglePatterns() -> str
"""
    @brief Identify "unused" single pattern pieces in the current project - garment pieces that are not
    connected to any other pattern by ANY assembly mechanism. A piece is flagged only when it is
    simultaneously unsewed AND unbonded/unglued AND unzipped AND unlaced. Trim pieces and internal/
    linked helper pieces (already excluded by the real-pattern list) are not considered.
    @note Detection of unused MULTIPLE patterns (pieces connected to other pieces but not part of a larger
    garment assembly such as tops or bottoms) is out of scope and not reported here.
    @return JSON array string: [{"patternIndex":<int>,"patternName":<string>}, ...], one entry per unused
    single pattern. patternIndex is the real-pattern-list index shared with the other pattern APIs
    (e.g. GetPatternPieceName). Returns an empty array [] when there is no open project / no match.
"""
def GetHiResTolerance(_toleranceType : int) -> list[double]
"""
    @ingroup PATTERN_API
    @brief Get one Tolerance min/max range of the Hi-Res Properties window (3D Garment > Hi-Res Garment). The Tolerance range decides which pieces a Hi-Res apply touches: only patterns (or avatars, for Skin Offset) whose current value is inside [min, max] are changed. The values are the ones the window last stored, so this reads exactly what the window shows when it is opened next.
    @param _toleranceType: which Tolerance row to read, one of Marvelous::HI_RES_TOLERANCE_TYPE (0 = Particle Distance, 1 = Additional Thickness - Collision, 2 = Skin Offset)
    @return [min, max] of that Tolerance row in millimeters, as double - the type of the window's spin boxes (QDoubleSpinBox) and of the stored value. The window defaults are returned when it has never been used. Empty list when _toleranceType is not a valid HI_RES_TOLERANCE_TYPE.
"""
def SetHiResTolerance(_toleranceType : int, _min : double, _max : double) -> bool
"""
    @ingroup PATTERN_API
    @brief Set one Tolerance min/max range of the Hi-Res Properties window (3D Garment > Hi-Res Garment), so the next Hi-Res apply only touches pieces whose current value is inside [min, max]. Values are normalized the way the window's spin boxes normalize typed input - rounded to 1 decimal, then clamped to that row's spin box range (Particle Distance 1.0 to 700.0 on both bounds; Additional Thickness - Collision min 0.0 to 99.99, max 0.0 to 999999999.0; Skin Offset min 0.0 to 99.99, max 0.0 to 100.0) - so a later GetHiResTolerance returns exactly what the window will display. This writes the window's stored value only; it does not itself re-apply Hi-Res settings to the garment.
    @param _toleranceType: which Tolerance row to write, one of Marvelous::HI_RES_TOLERANCE_TYPE (0 = Particle Distance, 1 = Additional Thickness - Collision, 2 = Skin Offset)
    @param _min: lower bound of the Tolerance range, in millimeters (double, matching the window's spin box)
    @param _max: upper bound of the Tolerance range, in millimeters (double, matching the window's spin box)
    @return true when the range was stored; false when _toleranceType is not a valid HI_RES_TOLERANCE_TYPE or _min is greater than _max after normalization (nothing is written in that case)
"""
def GetAllPatternToAvatarMeasures() -> list[tuple[str, str]]
"""
    @ingroup PATTERN_API
    @brief Retrieve every attached (pattern, avatar measure) pair in the project - the read companion to
    AttachPatternToAvatarMeasure. Both attachment kinds are reported: "Attach to Measure (Avatar)"
    Line Pins and TackOnAvatar point tacks.
    @note Differs from GetPatternsAttachedToAvatarMeasures, which groups patterns into one comma-joined
    string per measure. This returns one flat pair per attachment, so pattern names that themselves
    contain a comma stay unambiguous.
    @return one (patternName, avatarMeasureName) pair per attachment, de-duplicated and sorted by pattern
    name then measure name. Empty when no project is open, no avatar is loaded, or nothing is attached.
    @note The pairs are keyed by name, so two pattern pieces that share a name and are attached to the
    same measure collapse into a single pair. Use GetPatternLineInfo / the pattern indices if you
    need to tell same-named pieces apart.
"""
def GetPatternToAvatarMeasureByAvatar(_avatarIndex : int) -> list[tuple[str, str]]
"""
    @ingroup PATTERN_API
    @brief Retrieve the attached (pattern, avatar measure) pairs whose measure belongs to one avatar.
    @param _avatarIndex: avatar index (0-based, the avatar order of GetAvatarNameList / GetAvatarCount)
    @return the matching (patternName, avatarMeasureName) pairs, de-duplicated and sorted like
    GetAllPatternToAvatarMeasures. Empty when _avatarIndex is out of range, that avatar has no
    measures, or none of its measures has a pattern attached.
"""
def GetPatternToAvatarMeasureByPatterns(_patternList : list[str]) -> list[tuple[str, str]]
"""
    @ingroup PATTERN_API
    @brief Retrieve the attached (pattern, avatar measure) pairs for the named patterns only.
    @param _patternList: pattern names to keep (as returned by GetPatternPieceName). Names are matched
    exactly; unknown names simply contribute nothing. An empty list selects nothing, so the result
    is empty - it does NOT mean "all patterns".
    @return the matching (patternName, avatarMeasureName) pairs, de-duplicated and sorted like
    GetAllPatternToAvatarMeasures. Empty when none of the named patterns is attached.
"""
def GetPatternToAvatarMeasureByMeasures(_avatarMeasureList : list[str]) -> list[tuple[str, str]]
"""
    @ingroup PATTERN_API
    @brief Retrieve the attached (pattern, avatar measure) pairs for the named avatar measures only.
    @param _avatarMeasureList: avatar measure names to keep. Names are matched exactly across every loaded
    avatar, so a measure name shared by two avatars reports the attachments of both. Unknown names
    contribute nothing. An empty list selects nothing, so the result is empty - it does NOT mean
    "all measures".
    @return the matching (patternName, avatarMeasureName) pairs, de-duplicated and sorted like
    GetAllPatternToAvatarMeasures. Empty when none of the named measures has a pattern attached.
"""
def SetPatternEdgeToAvatarMeasure(_patternIndex : int, _lineIndex : int, _avatarMeasure : str, _attach : bool) -> bool
"""
    @ingroup PATTERN_API
    @brief Attach or detach a specific pattern edge (outline line) to/from an avatar measure (Line Pin) -
    the programmatic equivalent of the manual "Attach to Measure (Avatar)" / "Detach from Measure (Avatar)"
    workflow. Runs the cloth solver afterwards so the result is visible without a separate Simulate() call.
    @param _patternIndex: target pattern index (RealPatternList order)
    @param _lineIndex: outline line index to attach/detach (same ordering as GetPatternLineInfo)
    @param _avatarMeasure: avatar measure name, or its index given as a decimal string (height/linear measures are rejected)
    @param _attach: true = attach the edge to the measure, false = detach the edge from the measure
    @return true on success; false when the pattern/line index is out of bounds, the avatar measure does not
    exist (or does not support attachment), or on detach the edge is not attached to that measure
"""
def GetPatternEdgeToAvatarMeasureAttachment(_patternIndex : int, _avatarMeasure : str) -> str
"""
    @ingroup PATTERN_API
    @brief Query whether any edge (outline line) of a pattern is attached (Line Pin) to an avatar measure.
    @param _patternIndex: target pattern index (RealPatternList order)
    @param _avatarMeasure: avatar measure name, or its index given as a decimal string
    @return JSON: {"is_attached":true,"line_index":N} when an attachment exists (N = lowest attached line index,
    same ordering as GetPatternLineInfo / SetPatternEdgeToAvatarMeasure);
    {"is_attached":false,"line_index":-1} when no attachment exists, the pattern index is out of
    bounds, or the avatar measure does not exist
"""
def FlipPatternNormal(_patternIndexList : list[int]) -> bool
"""
    @ingroup PATTERN_API
    @brief Flip the mesh surface normal of the given pattern pieces - the API equivalent of the GUI 'Flip Normal' right-click menu (3D/2D). Each pattern is mirrored about its own vertical center axis and its mesh winding is reversed, so the fabric side that faced outwards now faces inwards (graphics and topstitches keep their visible side). Connected bindings are flipped together and the draping of connected sewing lines is reset, like the GUI.
    @param _patternIndexList: pattern indices to flip (0-based, real pattern list order - the same index space as the other pattern APIs). A duplicated index flips its pattern once.
    @note Validated as a whole: one out-of-range index makes the call a no-op rather than a half-flipped garment.
    @note The given patterns are left selected afterwards (recorded on the undo stack), like the GUI.
    @note Mesh-level change - run the simulation afterwards to let the garment settle.
    @return true when at least one pattern was flipped; false when no pattern editor is loaded, the list is empty, or any index is out of range
"""
def PlaceButtonPairsOnEdge(_buttonPatternIndex : int, _buttonLineIndex : int, _buttonholePatternIndex : int, _buttonholeLineIndex : int, _edgeOffset : float, _distancesAlongEdge : list[float], _option : ButtonPairPlacementOption) -> str
"""
    @ingroup PATTERN_API
    @brief Place button / buttonhole pairs along the edges of two seam-paired patterns (e.g. the left and right
    placket of a shirt) at explicit positions - the API equivalent of creating each button with the GUI 2D
    'Button' tool and each buttonhole with the 'Buttonhole' tool at matching distances from the edge. For every
    entry of _distancesAlongEdge one button head is created on the button pattern and one buttonhole on the
    buttonhole pattern. Each item sits _edgeOffset mm inside its own edge, measured perpendicular to the edge
    (curved edges use the local normal), at that arc-length distance from the edge corner selected by
    _option.edgeOrigin. Pick the line indices with GetPatternLineInfo. The two patterns must belong to the same
    sewn garment (connected through seamline pair groups), otherwise nothing is created. Validation is
    all-or-nothing: one bad distance fails the whole call. Re-running the same call is safe: a pair whose
    button or buttonhole would land within half a button width of an existing one on that pattern is reported
    as skipped instead of duplicated. The whole call is one undo step.
    @param _buttonPatternIndex: pattern that receives the button heads (0-based, real pattern list order)
    @param _buttonLineIndex: outline line of that pattern to measure from (0-based, order of GetPatternLineInfo / GetLineLength)
    @param _buttonholePatternIndex: pattern that receives the buttonholes (0-based, real pattern list order). Must differ from _buttonPatternIndex
    @param _buttonholeLineIndex: outline line of the buttonhole pattern to measure from (0-based)
    @param _edgeOffset: perpendicular distance in mm from each edge into its pattern. Must be greater than 0 and smaller than the pattern extent behind the edge
    @param _distancesAlongEdge: one entry per pair - arc length in mm from the origin corner of the edge (see _option.edgeOrigin). Each must lie within both edge lengths
    @param _option: styles, buttonhole size, rotation and the edge origin corner. Default-constructed = current styles, style size, no rotation, TOP origin
    @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API.
    @return JSON string {"status","reason","message","buttonPatternIndex","buttonLineIndex","buttonholePatternIndex","buttonholeLineIndex",
    "edgeOffset","edgeLength","buttonholeEdgeLength","createdCount","skippedCount","placements":[...]}. status is "success" or "failed".
    Each placements[] entry has index, distanceAlongEdge, status ("created" or "skipped"), button{x,y,worldX,worldY,buttonIndex} and
    buttonhole{x,y,worldX,worldY,buttonholeIndex}: x,y are mm from the pattern bounding-box top-left with Y down (the frame of
    GetPatternOutlinePoints / AddButtonToPattern), worldX,worldY are 2D-window coordinates (the frame of GetPatternComponents), and
    the indices are scene-order button / buttonhole indices for the grading APIs (-1 when skipped). On failure placements is empty,
    nothing is created, and reason is one of INVALID_PATTERN, SAME_PATTERN, CURVED_PATTERN_NOT_SUPPORTED, INVALID_LINE, NOT_SEAM_PAIRED,
    INVALID_STYLE_INDEX, NO_BUTTON_STYLE, INVALID_BUTTONHOLE_SIZE, EDGE_OFFSET_OUT_OF_BOUNDS, EMPTY_DISTANCE_LIST, DISTANCE_OUT_OF_RANGE,
    POSITION_OFF_PATTERN, NOT_FINITE_ARGUMENT, NO_EDITOR. On success reason is "OK".
"""
def DistributeButtonPairsOnEdge(_buttonPatternIndex : int, _buttonLineIndex : int, _buttonholePatternIndex : int, _buttonholeLineIndex : int, _edgeOffset : float, _buttonCount : int, _startMargin : float, _endMargin : float, _option : ButtonPairPlacementOption) -> str
"""
    @ingroup PATTERN_API
    @brief Distribute _buttonCount button / buttonhole pairs evenly along the edges of two seam-paired patterns -
    the auto-spacing counterpart of PlaceButtonPairsOnEdge with the same placement rules, validation, duplicate
    skipping, undo behaviour and return payload. The positions are computed on the button pattern edge as
    spacing = (edgeLength - _startMargin - _endMargin) / (_buttonCount - 1), starting _startMargin from the origin
    corner; a single pair is placed at the midpoint of that span. The same distances are applied on the
    buttonhole edge, so both edges must be long enough for them.
    @param _buttonPatternIndex: pattern that receives the button heads (0-based, real pattern list order)
    @param _buttonLineIndex: outline line of that pattern to measure from (0-based, order of GetPatternLineInfo / GetLineLength)
    @param _buttonholePatternIndex: pattern that receives the buttonholes (0-based, real pattern list order). Must differ from _buttonPatternIndex
    @param _buttonholeLineIndex: outline line of the buttonhole pattern to measure from (0-based)
    @param _edgeOffset: perpendicular distance in mm from each edge into its pattern. Must be greater than 0 and smaller than the pattern extent behind the edge
    @param _buttonCount: number of pairs to create. Must be 1 or more
    @param _startMargin: padding in mm from the origin corner (see _option.edgeOrigin) before the first pair. 0 or more
    @param _endMargin: padding in mm from the opposite corner after the last pair. 0 or more. _startMargin + _endMargin must be smaller than both edge lengths
    @param _option: styles, buttonhole size, rotation and the edge origin corner. Default-constructed = current styles, style size, no rotation, TOP origin
    @note In a GUI session the 2D/3D views and related widgets are not refreshed automatically by this API.
    @return Same JSON payload as PlaceButtonPairsOnEdge; placements[].distanceAlongEdge reports the computed positions.
    Additional failure reasons: INVALID_BUTTON_COUNT (_buttonCount below 1) and MARGINS_EXCEED_EDGE (negative margin or
    _startMargin + _endMargin not smaller than an edge length).
"""

UTILITY_API

def DisplayMessageBox(str : str) -> None
"""
    @ingroup UTILITY_API
    @brief Show a message with using the DialogBox implemented in MD software
    @param str: message
    @return Display a message box to show input string on MD. This can be used for debugging.
"""
def DisplayMessageBoxW(str : str) -> None
"""
    @ingroup UTILITY_API
    @brief Show a message with using the DialogBox implemented in MD software
    @param str: message
    @return Display a message box to show input string on MD. This can be used for debugging.
"""
def GetProjectName() -> str
"""
    @ingroup UTILITY_API
    @brief Get the current project name in MD
    @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 MD
    @return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test"
"""
def GetActiveWorkspaceFileName() -> str
"""
    @ingroup UTILITY_API
    @brief Get the name of the file currently active in the MD workspace, of any file type
    @return The active file's name with extension, e.g. "test.zprj", "test.zpac" or "test.avt". Returns "NULL" if no file is active.
"""
def GetActiveWorkspaceFileNameW() -> str
"""
    @ingroup UTILITY_API
    @brief Get the name of the file currently active in the MD workspace, of any file type
    @return The active file's name with extension, e.g. "test.zprj", "test.zpac" or "test.avt". Returns "NULL" if no file is active.
"""
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".
"""
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".
"""
def GetMajorVersion() -> int
"""
    @ingroup UTILITY_API
    @brief Get the major version of the MD 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 MD 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 MD 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
"""
def CleanFilePath(_filePath : str) -> CleanedPathResult
"""
    @ingroup UTILITY_API
    @brief Sanitize a file name or full file path for safe cross-platform / cloud / web use.
    @param _filePath: the raw file name or path (UTF-8). The input is auto-detected as a standalone
    file name or a full path (it is a path when it contains a slash or a drive letter such as
    "C:"). Processing per component: NFC Unicode normalization; stripping of characters that
    conflict with Windows / cloud clients / HTTP-FTP
    (< > : " | ? * # % & { } \ $ ! ' @ + = and ASCII control characters); spaces become '_';
    leading/trailing spaces and periods are trimmed; "." and ".." segments are dropped; Windows
    reserved device names (CON, PRN, AUX, NUL, COM1..9, LPT1..9) get a trailing '_' on the stem;
    each component is truncated to 255 bytes on a UTF-8 boundary. Drive letters (e.g. "C:") and
    UNC / POSIX roots are preserved, and mixed slashes are collapsed.
    @return a CleanedPathResult holding the path in universal ('/'), Windows native ('\') and Windows
    long-path (\\?\ / \\?\UNC\) forms, plus the isolated and percent-encoded file name.
"""
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.
"""
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.
"""
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
"""
def ResetClothArrangement() -> None
"""
    @ingroup UTILITY_API
    @brief Restore the shape of cloth to when the cloth was loaded
"""
def SaveCLOFileThumbnail(filePath : str, outputPath : str, thumbnailIndex : int) -> bool
"""
    @ingroup UTILITY_API
    @brief Save Preview thumbnail image file(png type) from the MD 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 MD 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 MD 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 MD file format(the number of thumbnails differs by the format)
    @return save result
"""
def GetMetaDataForCurrentGarment() -> str
"""
    @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
"""
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
"""
def ChangeMetaDataValueForCurrentGarment(metaDataKey : str, metaDataValue : str) -> None
"""
    @ingroup UTILITY_API
    @brief Change Meta Data Value for the current Garment
    @param metaDataKey: target Key
    @param metaDataValue: the new value for the key
"""
def CreateProgressBar() -> None
"""
    @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
"""
def SetProgressW(title : str, progress : int) -> None
"""
    @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
"""
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
"""
def AddColorSwatch(plmIDtoNameList : map[str, str], plmIDtoColorList : map[str, CloApiRgb], plmIDtoApiMetaDataList : map[str, str], swatchName : str) -> str
"""
    @ingroup UTILITY_API
    @brief Add Color Swatch
    @param plmIDtoNameList: the list for map of PLM ID to Color Name
    @param plmIDtoColorList: list for map of PLM ID to color name
    @param plmIDtoApiMetaDataList: list for map of PLM ID to Api Meta Data
    @param swatchName: swatchName which will be shown in the color palette and the swatch file name to save
    @return added swatch file name(.aco) inside the asset folder for the current version of MD
"""
def AddColorSwatchW(plmIDtoNameList : map[str, str], plmIDtoColorList : map[str, CloApiRgb], plmIDtoApiMetaDataList : map[str, str], swatchName : str) -> str
"""
    @ingroup UTILITY_API
    @brief Add Color Swatch
    @param plmIDtoNameList: the list for map of PLM ID to Color Name
    @param plmIDtoColorList: list for map of PLM ID to color name
    @param plmIDtoApiMetaDataList: list for map of PLM ID to Api Meta Data
    @param swatchName: swatchName which will be shown in the color palette and the swatch file name to save
    @return added swatch file name(.aco) inside the asset folder for the current version of MD
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def CreateUserCustomLibrary(name : str) -> int
"""
    @ingroup UTILITY_API
    @brief Create a new empty User Custom Library tab in the Library window. Add folders to it with AddUserCustomLibraryFolder. GUI only: returns -1 in MDHeadless.
    @param name: Display name (tab title) of the new library. When empty, the default "My Library" is used. The name is saved with the library and restored on the next launch.
    @return 0-based index among User Custom Library tabs in current visual order, or -1 on failure.
"""
def CreateUserCustomLibraryW(name : str) -> int
"""
    @ingroup UTILITY_API
    @brief Create a new empty User Custom Library tab in the Library window. Add folders to it with AddUserCustomLibraryFolderW. GUI only: returns -1 in MDHeadless.
    @param name: Display name (tab title) of the new library. When empty, the default "My Library" is used. The name is saved with the library and restored on the next launch.
    @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.
"""
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.
"""
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.
"""
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.
"""
def GetUserCustomLibraryCount() -> int
"""
    @ingroup UTILITY_API
    @brief Get the number of User Custom Library tabs in the Library window. Use it with GetUserCustomLibraryName to find an existing library by name before creating one. GUI only: returns 0 in MDHeadless.
    @return Number of User Custom Library tabs, 0 when there is none.
"""
def GetUserCustomLibraryName(libraryIndex : int) -> str
"""
    @ingroup UTILITY_API
    @brief Get the display name (tab title) of a User Custom Library. GUI only: returns an empty string in MDHeadless.
    @param libraryIndex: 0-based index among User Custom Library tabs in current visual order.
    @return The display name, or an empty string when the index is out of range.
"""
def GetUserCustomLibraryNameW(libraryIndex : int) -> str
"""
    @ingroup UTILITY_API
    @brief Get the display name (tab title) of a User Custom Library. GUI only: returns an empty string in MDHeadless.
    @param libraryIndex: 0-based index among User Custom Library tabs in current visual order.
    @return The display name, or an empty string when the index is out of range.
"""
def SetUserCustomLibraryName(libraryIndex : int, name : str) -> bool
"""
    @ingroup UTILITY_API
    @brief Rename a User Custom Library: set the display name (tab title) of an existing library. The new name is saved with the library and restored on the next launch. GUI only: returns false in MDHeadless.
    @param libraryIndex: 0-based index among User Custom Library tabs in current visual order.
    @param name: New display name. Must not be empty.
    @return true on success, false when the index is out of range or the name is empty.
"""
def SetUserCustomLibraryNameW(libraryIndex : int, name : str) -> bool
"""
    @ingroup UTILITY_API
    @brief Rename a User Custom Library: set the display name (tab title) of an existing library. The new name is saved with the library and restored on the next launch. GUI only: returns false in MDHeadless.
    @param libraryIndex: 0-based index among User Custom Library tabs in current visual order.
    @param name: New display name. Must not be empty.
    @return true on success, false when the index is out of range or the name is empty.
"""
def GetUserCustomLibraryFolderList(libraryIndex : int) -> list[str]
"""
    @ingroup UTILITY_API
    @brief Get the absolute paths of the root folders of a User Custom Library, in display order. The position in this list is the folder index used by DeleteUserCustomLibraryFolder. GUI only: returns an empty list in MDHeadless.
    @param libraryIndex: 0-based index among User Custom Library tabs in current visual order.
    @return The folder paths (path delimiter '/'), or an empty list when the index is out of range.
"""
def GetUserCustomLibraryFolderListW(libraryIndex : int) -> list[str]
"""
    @ingroup UTILITY_API
    @brief Get the absolute paths of the root folders of a User Custom Library, in display order. The position in this list is the folder index used by DeleteUserCustomLibraryFolder. GUI only: returns an empty list in MDHeadless.
    @param libraryIndex: 0-based index among User Custom Library tabs in current visual order.
    @return The folder paths (path delimiter '/'), or an empty list when the index is out of range.
"""
def NewProject() -> None
"""
    @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.)
    - IsMDFileFormatWithThumbnailExtension / IsMDFileFormatWithThumbnailExtensionW
    : Check if the MD file format has the thumbnail memory.

    - IsMDFileFormatWithTripleThumbnailExtension / IsMDFileFormatWithTripleThumbnailExtensionW
    : Check if the MD 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
"""
def ValidateCLOFile(filePath : str) -> map[str, str]
"""
    @ingroup UTILITY_API
    @brief Validate whether the given file is a MD 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., "MD Fabric", "MD Button").
"""
def ValidateCLOFileW(filePath : str) -> map[str, str]
"""
    @ingroup UTILITY_API
    @brief Validate whether the given file is a MD 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., "MD Fabric", "MD Button").
"""
def GetAPIMetaData(filePath : str) -> str
"""
    @ingroup UTILITY_API
    @brief Get API meta data for the file
    @param filePath: MD 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: MD 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
"""
def SetAPIMetaDataW(filePath : str, jsonStr : str) -> bool
"""
    @ingroup UTILITY_API
    @brief Set API meta data to the file
    @param filePath: target file path
    @param jsonStr: api meta data in wstring format
    @return if it succeeds, return true
"""
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
"""
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
"""
def SetShowHideAvatar(_bShow : bool) -> None
"""
    @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
    @param _avatarIdex: the target avatar index
"""
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.
"""
def SetSchematicRender(_bSet : bool) -> None
"""
    @ingroup UTILITY_API
    @brief Set Schematic Render status
    @param _bSet: true for enable, false for disable
"""
def ReplaceGraphicStyleFromImage(_graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool
"""
    @ingroup UTILITY_API
    @brief Replace the image on a graphic style.
    The chosen anchor point on the original graphic stays fixed in world space after replacement.

    @param _graphicstyleIndex: index of the style to replace
    @param _imagePath: path to the new image file
    @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values:
    0=Center  1=Up  2=RightUp  3=Right  4=RightDown
    5=Down  6=LeftDown  7=Left  8=LeftUp
    @return true if successful

    @example anchor = MDAPI_ANCHOR_LEFT_UP — wide logo replaced by tall logo, top-left pinned:

    BEFORE                        AFTER
    8─────────────────2           8──2  <- top-left (8) same world position
    │                 │           │  │
    │    OLD LOGO     │    -->    │  │
    │                 │           │  │
    6─────────────────4           │  │
    6──4

    @example anchor = MDAPI_ANCHOR_CENTER (0) — also preserves original display size:

    BEFORE                        AFTER
    ┌─────────────────┐           ┌─────────────────┐
    │    OLD LOGO     │    -->    │    NEW LOGO     │  <- same size, center unmoved
    └─────────────────┘           └─────────────────┘

    @example anchor = MDAPI_ANCHOR_RIGHT_DOWN — bottom-right corner pinned:

    BEFORE                        AFTER
    8─────────────────2                  8──2
    │                 │                  │  │
    │    OLD LOGO     │    -->            │  │
    │                 │                  │  │
    6─────────────────4           ───────6──4  <- bottom-right (4) same world position

"""
def ReplaceGraphicStyleFromImageW(_graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool
"""
    @ingroup UTILITY_API
    @brief Wide-string variant of ReplaceGraphicStyleFromImage(index, string, anchor).
    See the string overload for full documentation and diagrams.
    @param _graphicstyleIndex: index of the style to replace
    @param _imagePath: path to the new image file (wide string)
    @param _anchor: anchor point to hold fixed. Accepts plain integers or Marvelous::CloApiAnchorPoint enum values:
    0=Center  1=Up  2=RightUp  3=Right  4=RightDown
    5=Down  6=LeftDown  7=Left  8=LeftUp
    @return true if successful
"""
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.
"""
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))
"""
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)
"""
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)
"""
def SetSimulationCGFinishCondition(_cgFinishCondition : int) -> None
"""
    @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)
"""
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)
"""
def SetSimulationSelfCollisionIterationCount(_selfCollisionIterationCount : int) -> None
"""
    @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)
"""
def SetSimulationGravity(_gravity : float) -> None
"""
    @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)
"""
def SetSimulationNonlinearSimulation(_bNonlinearSimulation : bool) -> None
"""
    @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
"""
def SetSimulationGroundHeight(_groundHeight : float) -> None
"""
    @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)
"""
def SetSimulationLayerBasedCollisionDetection(_bUseLayer : bool) -> None
"""
    @ingroup UTILITY_API
    @brief Set layer based collision detection
    @param _bUseLayer : true for enable, false for disable
"""
def SetAvatarMeshTexture(_matShapeName : str, _matMeshIndex : int, _textureImagePath : str) -> bool
"""
    @ingroup UTILITY_API
    @brief Import AvatarTexture Body Part(face, body, arm, leg)
    @param _matShapeName: input avatar shape name(find object browser)
    @param _matMeshIndex: mat mesh index (0: face, 1:body, 2:arm, 3:leg)
    @param _textureImagePath: change texture full path
    @return if it succeeds, return true.
"""
def SetAnimationRecording(_bStart : bool) -> None
"""
    @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
"""
def GetCurrentAnimationFrame() -> double
"""
    @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
"""
def GetStartAnimationFrame() -> double
"""
    @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
"""
def GetEndAnimationFrame() -> double
"""
    @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.
"""
def GetAnimationLayerFrameRange(_layerIndex : int) -> tuple[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.
"""
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.
"""
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.
"""
def CopyFromFirstClothCache() -> None
"""
    @ingroup UTILITY_API
    @brief Copy the first cloth cache to current frame
"""
def GetSchematicRender() -> bool
"""
    @ingroup UTILITY_API
    @brief Get Show Schematic Render Status
"""
def RegisterPythonScript(pythonScriptPath : str, menuPath : str) -> bool
"""
    @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.
"""
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.
"""
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.
"""
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)
"""
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
"""
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
"""
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
"""
def SetSchematicSilhouetteLineWidth(_value : int) -> None
"""
    @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
"""
def SetSchematicInternalLineWidth(_value : int) -> None
"""
    @ingroup UTILITY_API
    @brief set schematic internal line width
    @param _value: Value for setting schematic 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
"""
def SetSchematicBrightness(_value : int) -> None
"""
    @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
"""
def SetShowSchematicSeamLine(_bOn : bool) -> None
"""
    @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
"""
def SetShowSchematicTopstitchLine(_bOn : bool) -> None
"""
    @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
"""
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
"""
def SetQualityRender(_bSet : bool) -> None
"""
    @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
"""
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.
"""
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.
"""
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.
"""
def ResetUVTo2DArrangement() -> None
"""
    @ingroup UTILITY_API
    @brief Reset UV islands to the 2D arrangement.
"""
def Refresh3DWindow() -> None
"""
    @ingroup UTILITY_API
    @brief Refresh 3D Garment Window
"""
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.
"""
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.
"""
def GetTotalGraphicItemQuantity() -> int
"""
    @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
    @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.
"""
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.
    @param _graphicIndex: The index corresponding to the graphic style list.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @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.
"""
def SetGraphicStyleLocked(_graphicIndex : int, _bLocked : bool) -> None
"""
    @ingroup UTILITY_API
    @brief Sets the lock state of the graphic style (style-level: affects size, map size/scale)
    @param _graphicIndex: Graphic style index's style list
    @param _bLocked: If true, locks the style; if false, unlocks it
"""
def IsGraphicStyleLocked(_graphicIndex : int) -> bool
"""
    @ingroup UTILITY_API
    @brief Returns whether the graphic style is locked (style-level)
    @param _graphicIndex: Graphic style index's style list
    @return true if the style is locked, false otherwise or if index is invalid
"""
def SetGraphicInstanceLocked(_patternIndex : int, _graphicIndex : int, _bLocked : bool) -> None
"""
    @ingroup UTILITY_API
    @brief Sets the lock state of the graphic instance placed on a specific pattern piece (instance-level: affects angle, position, Z-offset, configuration)
    @param _patternIndex: Pattern piece index in the PatternEditor's pattern list
    @param _graphicIndex: Graphic style index's style list
    @param _bLocked: If true, locks the instance; if false, unlocks it
"""
def IsGraphicInstanceLocked(_patternIndex : int, _graphicIndex : int) -> bool
"""
    @ingroup UTILITY_API
    @brief Returns whether the graphic instance placed on a specific pattern piece is locked (instance-level)
    @param _patternIndex: Pattern piece index in the PatternEditor's pattern list
    @param _graphicIndex: Graphic style index's style list
    @return true if the instance is locked, false otherwise or if not found
"""
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.
"""
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
"""
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
"""
def SetGraphicStyleDimensions(_colorwayIndex : int, _index : int, _width : float, _height : float) -> None
"""
    @ingroup UTILITY_API
    @brief Sets the dimensions of the graphic style
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @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.
"""
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.
"""
def GetGraphicStylePatternPieceIndices(_graphicIndex : int) -> list[int]
"""
    @ingroup UTILITY_API
    @brief Returns the list of pattern piece indices that a graphic style is placed on
    @param _graphicIndex: The index corresponding to the graphic style list.
    @return A deduplicated vector of pattern piece indices.
    @note Use the returned indices as _patternIndex in the other OnPattern APIs (GetGraphicStyleDimensionsOnPattern, SetGraphicStylePositionOnPattern, etc.).
"""
def GetGraphicStylePatternPieceIndices(_colorwayIndex : int, _graphicIndex : int) -> list[int]
"""
    @ingroup UTILITY_API
    @brief Returns the list of pattern piece indices that a graphic style is placed on
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _graphicIndex: The index corresponding to the graphic style list.
    @return A deduplicated vector of pattern piece indices.
    @note Use the returned indices as _patternIndex in the other OnPattern APIs (GetGraphicStyleDimensionsOnPattern, SetGraphicStylePositionOnPattern, etc.).
"""
def GetGraphicStyleDimensionsOnPattern(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int) -> CloApiGraphicDimensions
"""
    @ingroup UTILITY_API
    @brief Returns the dimensions of a graphic placement on a specific pattern piece
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _graphicIndex: The index corresponding to the graphic style list.
    @param _patternIndex: The index of the pattern piece.
    @return If valid, returns a Dimension object filled with the graphic's dimension information.
    @note Width and height are measured from the graphic's center outward. Each pattern piece placement stores its own independent size.
"""
def SetGraphicStylePositionOnPattern(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int, _x : float, _y : float) -> bool
"""
    @ingroup UTILITY_API
    @brief Sets the 2D position of a graphic on a specific pattern piece
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _graphicIndex: The index corresponding to the graphic style list.
    @param _patternIndex: The index of the pattern piece.
    @param _x: The X coordinate of the graphic's center in 2D pattern-local space.
    @param _y: The Y coordinate of the graphic's center in 2D pattern-local space.
    @return true if the position was set successfully, false otherwise.
    @note (_x, _y) targets the graphic's center point, not its corner.
"""
def SetGraphicStyleDimensionsOnPattern(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int, _width : float, _height : float) -> bool
"""
    @ingroup UTILITY_API
    @brief Sets the dimensions of a graphic on a specific pattern piece
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _graphicIndex: The index corresponding to the graphic style list.
    @param _patternIndex: The index of the pattern piece.
    @param _width: The width to be set for the graphic. Must be > 0 to take effect.
    @param _height: The height to be set for the graphic. Must be > 0 to take effect.
    @return true if the dimensions were set successfully, false otherwise.
    @note Resizes the graphic outward from its center. No aspect ratio lock is applied (width and height are set independently).
    @note Only affects this pattern piece placement. To resize all placements at once, use SetGraphicStyleDimensions instead.
"""
def GetGraphicStylePlacementPoints(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int, _is2D : bool) -> CloApiGraphicPlacementPoints
"""
    @ingroup UTILITY_API
    @brief Returns the center, corner, and edge center points of a graphic placement on a pattern piece
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _graphicIndex: The index corresponding to the graphic style list.
    @param _patternIndex: The index of the pattern piece.
    @param _is2D: If true, returns 2D pattern-local coordinates; if false, returns 3D world coordinates.
    @return A CloApiGraphicPlacementPoints struct containing center, corners, and edge center points.
"""
def RepositionGraphicByAnchor(_colorwayIndex : int, _graphicIndex : int, _patternIndex : int, _anchorPoint : CloApiAnchorPoint, _x : float, _y : float) -> bool
"""
    @ingroup UTILITY_API
    @brief Repositions a graphic so the specified anchor point lands at (_x, _y).
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _graphicIndex: The index corresponding to the graphic style list.
    @param _patternIndex: The index of the pattern piece.
    @param _anchorPoint: Anchor point to pin (int value or CloApiAnchorPoint enum both accepted) -- see table below.
    @param _x: Target X coordinate for the anchor point in 2D pattern-local space.
    @param _y: Target Y coordinate for the anchor point in 2D pattern-local space.
    @return true if the position was updated successfully, false otherwise.
    @code
    Anchor layout (Y increases upward):

    8---1---2
    |       |
    7   0   3
    |       |
    6---5---4

    Value | Enum                      | Position
    ------+---------------------------+---------------------
    0   | MDAPI_ANCHOR_CENTER      | center
    1   | MDAPI_ANCHOR_UP          | top edge midpoint
    2   | MDAPI_ANCHOR_RIGHT_UP    | top-right corner
    3   | MDAPI_ANCHOR_RIGHT       | right edge midpoint
    4   | MDAPI_ANCHOR_RIGHT_DOWN  | bottom-right corner
    5   | MDAPI_ANCHOR_DOWN        | bottom edge midpoint
    6   | MDAPI_ANCHOR_LEFT_DOWN   | bottom-left corner
    7   | MDAPI_ANCHOR_LEFT        | left edge midpoint
    8   | MDAPI_ANCHOR_LEFT_UP     | top-left corner

    The graphic is translated so the chosen anchor point lands
    exactly at (_x, _y). Size and rotation are unchanged.
    Same convention as ReplaceGraphicStyleFromImage _anchor.
    @endcode
"""
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.
"""
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.
"""
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.
"""
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
"""
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
"""
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
"""
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.
"""
def SetZoomView() -> None
"""
    @ingroup UTILITY_API
    @brief Zoom cloth
"""
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
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def SetBaseTextureMapImageDesaturation(_fabricIndex : int, _colorwayIndex : int, _bSetOnOff : bool) -> None
"""
    @ingroup UTILITY_API
    @brief Set desaturation on/off for base texture map image of fabric.
    @param _fabricIndex: the target fabric index in the Object Browser
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
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: Marvelous Designer has no colorways: pass 0.
"""
def SetGraphicNormalMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None
"""
    @ingroup UTILITY_API
    @brief Sets the texture map for the graphic style
    @param _index: Graphic style index to use the plugin
    @param _imageFilePath: The file path to be set for the graphic style
"""
def SetGraphicDisplacementMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None
"""
    @ingroup UTILITY_API
    @brief Sets the texture map for the graphic style
    @param _index: Graphic style index to use the plugin
    @param _imageFilePath: The file path to be set for the graphic style
"""
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
"""
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
"""
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
"""
def GetGraphicNormalMapTexture() -> str
"""
    @ingroup UTILITY_API
    @brief Gets the texture map for the graphic style
    @return 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
"""
def GetGraphicOpacityMapTexture() -> str
"""
    @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
"""
def GetGraphicMetalnessMapTexture() -> str
"""
    @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 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
"""
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
"""
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
"""
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
"""
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
"""
def SetGraphicStyleColor(_styleIndex : int, r : float, g : float, b : float, a : float) -> bool
"""
    @ingroup UTILITY_API
    @brief Set a base color of PBR material in a Graphic using given RGBA values. (default index = 0)
    @param _styleIndex: Graphic style index
    @parm r : To be set as red value
    @parm g : To be set as green value
    @parm b : To be set as blue value
    @parm a : To be set as alpha value
    @return if it succeeds, return true.
"""
def SetGraphicStyleColor(r : float, g : float, b : float, a : float) -> bool
"""
    @ingroup UTILITY_API
    @brief Set a base color of PBR material in a Graphic using given RGBA values. (default index = 0)
    @parm r : To be set as red value
    @parm g : To be set as green value
    @parm b : To be set as blue value
    @parm a : To be set as alpha value
    @return if it succeeds, return true.
"""
def SetGraphicStyleColor(_styleIndex : int, _colorName : str) -> bool
"""
    @ingroup UTILITY_API
    @brief Set a base color of PBR material in a Graphic using given color name values. (default index = 0)
    @param _styleIndex: Graphic style index
    @param _colorName: name of color
    @return if it succeeds, return true.
"""
def AutoHang(_garmentPath : str, _hangerPath : str, _hangerType : int, _hangerImportOption : ImportExportOption) -> bool
"""
    @ingroup UTILITY_API
    @brief Auto-hang a garment to a hanger.
    @parm _garmentPath : path to a garment file. .zprj or .zpac is accepted. If .zprj is given, only the garment will be loaded.
    @parm _hangerPath : path to a hanger file. .obj or .avt is accepted.
    @parm _hangerType : type of the _hangerFIlePath hanger. 0 = top hanger, 1 = bottom hanger
    @parm _hangerImportOption : if .obj is given for _hangerFIlePath, specify the import option. Especially, specify the scale. For example, if the file is in cm, scale should be 10.
    @return if it succeeds, return true.
"""
def UpdatePropertyWindow() -> None
"""
    @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
"""
def DeleteAvatar(_avatarIndexList : list[int]) -> bool
"""
    @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.
"""
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
"""
def SetGraphicStyleColor(_styleIndex : int, _colorwayIndex : int, _colorName : str) -> bool
"""
    @ingroup UTILITY_API
    @brief  Set base color of PBR material in a Graphic Style using given color name
    @param  _styleIndex: Graphic Style index to set Color
    @param  _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param  _colorName: Name of color from the color palette
    @return true if successful, false otherwise
"""
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.
"""
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
"""
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.
"""
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
"""
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.
"""
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
"""
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
"""
def SetTrimStyleColor(_styleIndex : int, _colorwayIndex : int, _meshIndex : int, _colorName : str) -> bool
"""
    @ingroup UTILITY_API
    @brief  Set base color of PBR material in a Trim Style using given color name
    @param  _styleIndex: Trim Style index to set Color
    @param  _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param  _meshIndex: Mesh index to set color
    @param  _colorName: Name of color from the color palette
    @return true if successful, false otherwise
"""
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
"""
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
"""
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.
"""
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
"""
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
"""
def SetTopStitchColor(_styleIndex : int, _colorwayIndex : int, _lineIndex : int, _colorName : str) -> bool
"""
    @ingroup UTILITY_API
    @brief  Set base color of PBR material in a TopStitch Style using given color name
    @param  _styleIndex: TopStitch Style index to set Color
    @param  _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param  _lineIndex: Stitch index to set Color (-1: All, 0~: [_lineIndex]th Stitch)
    @param  _colorName: Name of color from the color palette
    @return true if successful, false otherwise
"""
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: use 1. Marvelous Designer has no colorways, so 2 and 3 give the same result.
"""
def GetSimulationQuality() -> tuple[int, int]
"""
    @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.
"""
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)
"""
def SetAvatarOpacityMap(_imageFilePath : str) -> None
"""
    @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.
"""
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
"""
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
"""
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
"""
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
"""
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
"""
def SetShowHideColorOptions(_option : int, _show : bool) -> None
"""
    @ingroup UTILITY_API
    @brief Set Show/Hide Color Options
    @param _option: Option 0: All, 1: Freeze, 2: Strengthen, 3: Solidify, 4: Layer, 5: All (Mesh) , 6: Subdivide (Mesh), 7: Freeze (Mesh), 8: Strengthen (Mesh), 9: Solidify (Mesh)
    @param _show: True/False. True is for show. False is for Hide
"""
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.
"""
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.
"""
def AlignAvatarsAndGarmentToCenter() -> None
"""
    @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
    @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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
def ConvertTrimsToButtons(_trimStyleIndex : int, _bButtonHead : bool) -> int
"""
    @ingroup UTILITY_API
    @brief Convert placed trim objects into real Button-tool items (button heads or buttonholes) at each trim's position on its glued pattern, then delete the source trims. Use this to migrate "fake buttons" that were built with the trim/sewing tools into proper Button-tool objects, so the FDT trim library stays clean.
    @param _trimStyleIndex: Index of the trim style whose instances to convert. Pass -1 to convert every trim object in the scene. Trim indices match GetTrimStyleListWithIndex().
    @param _bButtonHead: true creates Button heads; false creates Buttonholes. The project's current button-head / buttonhole style is used for the new items.
    @return The number of trim objects successfully converted.
"""
def CreateButtonholesForButtonHeads() -> int
"""
    @ingroup UTILITY_API
    @brief For every button head in the scene, ray-cast through the placket (in the direction the head is attached) to find the underlap layer and create a buttonhole there (the "find the pattern itself" step). Uses the project's current buttonhole style.
    @note Safe to call more than once: it will not add a second hole to a head that already has one. A button head is skipped when (a) it has no second layer beneath it, (b) it is already fastened to a buttonhole, or (c) a buttonhole already sits within half a buttonhole width of the point where this call would place one.
    @return The number of buttonholes created. Heads skipped by any of the rules above are not counted, so a second call on an unchanged garment returns 0.
"""
def FastenButtons(_maxDistance : float) -> int
"""
    @ingroup UTILITY_API
    @brief Fasten button heads into buttonholes: each unfastened buttonhole is paired with the nearest unfastened button head (by 3D distance) and a fastener is created, which also pulls the head onto the hole. Buttons already fastened are left untouched.
    @param _maxDistance: Maximum 3D distance (in MD units) allowed between a head and a hole to pair them. Pass 0 or a negative value for no distance limit.
    @return The number of head/hole pairs fastened.
"""
def UnfastenAllButtons() -> int
"""
    @ingroup UTILITY_API
    @brief Remove every button fastener in the scene and spring the freed button heads back to their resting position. Inverse of FastenButtons. The button heads and holes themselves are kept.
    @return The number of fasteners removed.
"""
def GetButtonPairInfoAsJson(_maxDistance : float, _misalignmentTolerance : float) -> str
"""
    @ingroup UTILITY_API
    @brief Return a JSON report of every Button head / Buttonhole pair in the current garment: whether each pair is fastened, whether FastenButtons would fasten it, each item's distance from its pattern edge, and whether a pair is misaligned relative to the majority (median) edge distance. Intended for QC validation of button placement. Read-only; does not modify the scene.
    @param _maxDistance: The same distance gate FastenButtons uses. A pair is reported fastenable only when its 3D separation is below this value. Pass 0 or negative for no distance limit.
    @param _misalignmentTolerance: Maximum allowed deviation (in MD units) of a pair's edge distance from the median before it is flagged misaligned. Pass 0 or negative to use a relative default (25% of the median).
    @return JSON string: { status, reason, buttonHeadCount, buttonHoleCount, maxDistance, standardEdgeDistance, misalignmentTolerance, pairs[], unpairedHeads[], unpairedHoles[] }. Top-level status is one of "NO_PAIRS_AVAILABLE", "MISALIGNED", "PAIRS_NOT_FASTENABLE", "OK". Each pairs[] entry has headUid, headName, holeUid, holeName, fastened, fastenable, reason, separation, headEdgeDistance, holeEdgeDistance, deviation, misaligned. Per-pair reason is one of "OK", "ALREADY_FASTENED", "TOO_FAR". unpairedHeads[] and unpairedHoles[] entries have uid and name. Reported maxDistance is -1 when no distance limit was requested.
"""
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
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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)
"""
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)
"""
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
"""
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
"""
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
"""
def GetZipperStyleTeethType(_zipperStyleIndex : int) -> int
"""
    @ingroup UTILITY_API
    @brief Update the zipper style teeth type.
    @param _zipperStyleIndex: The zipper style index.
    @return It returns the teeth type index.
    0: Texture
    1: OBJ
"""
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)
"""
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)
"""
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)
"""
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)
"""
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)
"""
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)
"""
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)
"""
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)
"""
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)
"""
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)
"""
def SetAvatarSmooth(_avatarIndex : int, _smoothlevel : int) -> None
"""
    @ingroup UTILITY_API
    @brief Set the maximum subdivision level for avatar smoothing.
    @param _avatarIndex: The index of the avatar to apply smoothing to.
    @param _smoothlevel: The maximum subdivision level to set for avatar smoothing. (1-3)
"""
def GetAvatarSubdivisionLevel(_avatarIndex : int) -> int
"""
    @ingroup UTILITY_API
    @brief Get the current subdivision level for avatar smoothing.
    @param _avatarIndex: The index of the avatar to query.
    @return The current subdivision level for avatar smoothing. (1-3, 0 means no subdivision). If 0 to uncheck/unselect DivideMesh.
"""
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'}
"""
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'}
"""
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.
"""
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).
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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'}
"""
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'}
"""
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.
"""
def GetNormalBlendingMethod() -> int
"""
    @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.
"""
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.
"""
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.
"""
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.
"""
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 MD 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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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.
"""
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
    @param _graphicStyleIndex: The graphic style index to apply the desaturation setting
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @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
"""
def RemoveGraphicStyle(_graphicIndex : int) -> str
"""
    @ingroup UTILITY_API
    @brief Backward-compatible overload. Removes a graphic style from the graphic list with no pattern removal.
    Equivalent to RemoveGraphicStyle(0, _graphicIndex, -1, 0).
    @param _graphicIndex: The index of the graphic style to remove.
    @return JSON string containing "status" ("Success" or "Failed") and "message" with contextual details.
"""
def RemoveGraphicStyle(_colorwayIndex : int, _graphicIndex : int, _styleChipIndex : int, _overrideMode : int) -> str
"""
    @ingroup UTILITY_API
    @brief Removes a graphic style at the specified index with configurable deletion targets.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _graphicIndex: The index into the selected graphic list.
    @param _styleChipIndex: not used in Marvelous Designer; pass 0
    @param _overrideMode: Deletion target mode (Marvelous::GraphicRemoveMode).
    0 = GRAPHIC_REMOVE_BROWSER_ONLY (remove from Object Browser only; fails if graphic is applied to a pattern),
    1 = GRAPHIC_REMOVE_PATTERN_ONLY (remove from pattern, retain in Object Browser),
    2 = GRAPHIC_REMOVE_PATTERN_AND_BROWSER (delete from both pattern and Object Browser).
    @return JSON string containing "status" ("Success" or "Failed") and "message" with contextual details.
"""
def GenerateZippersFromObj(_outputFilePathWithExt : str, _options : ObjRegisterOptions, _zipperIndex : int) -> bool
"""
    @ingroup UTILITY_API
    @brief Generates a zipper part asset file from one or two OBJ files, mirroring the full
    "Register OBJ" dialog (DialogRegisterZipperObject) without any UI interaction.
    Supports all 7 object types:
    - 0: ZIPPER_OBJECT_SLIDER                → .zsl (single OBJ, single shape)
    - 1: ZIPPER_OBJECT_PULLER                → .zpu (single OBJ, single shape)
    - 2: ZIPPER_OBJECT_SLIDER_PULLER         → .zss (single OBJ, dual shape; mesh auto-assignment fallback)
    - 3: ZIPPER_OBJECT_TEETH                 → .zth (single OBJ, fixed internal axes)
    - 4: ZIPPER_OBJECT_TOP_STOPPER           → .zst (dual OBJ, dual shape)
    - 5: ZIPPER_OBJECT_BOTTOM_OPEN_STOPPER   → .zst (dual OBJ, dual shape)
    - 6: ZIPPER_OBJECT_BOTTOM_MDSED_STOPPER → .zst (single OBJ, single shape)
    For ZIPPER_OBJECT_SLIDER_PULLER, mesh assignment follows this fallback hierarchy:
    1. User Explicit: OBJ group names listed in ObjRegisterOptions::sliderMeshNames / pullerMeshNames.
    2. MD Default: mesh names containing "slider" or "puller" (case-insensitive).
    3. Dimensional: the mesh with the larger bounding-box extent is classified as Puller.
    4. Alphabetical: sorted names; index 0 = Slider, index 1 = Puller.
    NOTE: ZIPPER_OBJECT_TEETH ignores user-defined axis settings (axes are fixed internally).
    @param _outputFilePathWithExt: Full output file path including the extension matching the object type.
    @param _options: Full set of registration options (see ObjRegisterOptions).
    @param _zipperIndex: Index of the zipper style in the Object Browser to assign the registered file to after saving. -1 = do not assign.
    @return true on success; false if validation fails, OBJ loading fails, or saving fails.
"""
def SetMaterialTextureTransformations(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, propertyEditorContextOptions : PropertyEditorContextOptions, transformOptions : TransformOptions) -> None
"""
    @ingroup UTILITY_API
    @brief Sets the texture transformation of the targeted object's material map. Routes to the matching
    per-type implementation based on browserContextOptions.type. Currently backs OB_TYPE_FABRIC and
    OB_TYPE_GRAPHIC; other types are accepted but no-op until their per-type backend exists.
    @param colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param objectIndex: index of the targeted object within its Object Browser category.
    @param browserContextOptions: Object Browser context (type, print vs base color, style-chip / sub-item, folder).
    @param propertyEditorContextOptions: Property Editor context (material side, target texture map).
    @param transformOptions: the texture transformation to apply.
"""
def GetMaterialTextureTransformations(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, propertyEditorContextOptions : PropertyEditorContextOptions) -> TransformOptions
"""
    @ingroup UTILITY_API
    @brief Gets the current texture transformation of the targeted object's material map.
    @return TransformOptions for the targeted texture. Returns an identity transform if it cannot be resolved.
"""
def SetMaterialProperties(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, materialContextProperties : MaterialPropertyOptions, newValues : MaterialPropertyOptions) -> str
"""
    @ingroup UTILITY_API
    @brief Applies newValues to the material of the target object. The object is located via
    objectIndex and browserContextOptions; the active component tab / mapping / type is taken from
    materialContextProperties.contextOptions.
    @param colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param objectIndex: index of the targeted object within its Object Browser category.
    @param browserContextOptions: Object Browser context locating the object (type, sub-item, style-chip...).
    @param materialContextProperties: carries contextOptions (targetComponent / textureMappingType / printType
    / materialType) that selects which component tab the write applies to.
    @param newValues: the material property values to write.
    @return JSON string: {"status": "success"|"error", "message": "..."}. Context mismatches and invalid
    states are reported in the message rather than thrown across the binding boundary.
    @note Supported object types: Fabric (targetComponent Front/Back/Side) and Button (Button/Thread). All other
    supported types are single-faced with no component tabs (targetComponent = COMPONENT_NONE) and map
    onto the 'front' face stack: Graphic, Buttonhole and Puckering (subItemIndex unused); Trim
    (subItemIndex = trim mesh index); Top-stitch (subItemIndex = stitch line index); Zipper
    (subItemIndex = zipper mesh index).
"""
def GetMaterialProperties(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, materialContextProperties : MaterialPropertyOptions) -> MaterialPropertyOptions
"""
    @ingroup UTILITY_API
    @brief Returns the current material properties for the active context (e.g. a Button's "Thread" tab vs its
    "Button" tab). Only materialContextProperties.contextOptions is read from the input.
    @param colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param objectIndex: index of the targeted object within its Object Browser category.
    @param browserContextOptions: Object Browser context locating the object.
    @param materialContextProperties: only its contextOptions is used, to select the component tab to read.
    @return MaterialPropertyOptions for the active context. On an unresolved or mismatched context a default
    MaterialPropertyOptions (echoing the requested contextOptions) is returned.
    @note Supported object types: Fabric (targetComponent Front/Back/Side) and Button (Button/Thread). All other
    supported types are single-faced with no component tabs (targetComponent = COMPONENT_NONE) and report
    on the 'front' face stack: Graphic, Buttonhole and Puckering (subItemIndex unused); Trim
    (subItemIndex = trim mesh index); Top-stitch (subItemIndex = stitch line index).
"""
def GetMaterialPropertiesAsJson(colorwayIndex : int, objectIndex : int, browserContextOptions : ObjectBrowserContextOptions, materialContextProperties : MaterialPropertyOptions) -> str
"""
    @ingroup UTILITY_API
    @brief JSON-returning duplicate of GetMaterialProperties. Resolves and reads the same material stack but
    returns it as a JSON string, so scripting clients can consume the full fabric material payload
    (base color, normal, displacement, opacity and reflection maps, each with their transformation)
    without binding the nested option structs.
    @param colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param objectIndex: index of the targeted object within its Object Browser category.
    @param browserContextOptions: Object Browser context locating the object.
    @param materialContextProperties: only its contextOptions is used, to select the component tab to read.
    @return JSON string. On success: {"status":"success","properties":{...}} where "properties" mirrors the
    MaterialPropertyOptions struct (contextOptions, material_type, front/back/side stacks, physical_*).
    On an unresolved or mismatched context: {"status":"error","message":"..."}.
"""
def GetObjectBrowserContext() -> ObjectBrowserContextOptions
"""
    @ingroup UTILITY_API
    @brief Reads the current Object Browser state into an ObjectBrowserContextOptions object.
    Aggregates the active tab (type), its scope (folderName), and the booleans
    (bIncludeUnusedObjects) from the per-tab context store. In UI mode the
    active tab is resolved live; in headless mode it is the last tab applied via the setter.
    A never-set tab yields safe defaults. Callers should call this before mutating + re-applying.
    @return The aggregated ObjectBrowserContextOptions for the active tab (safe defaults if unset).
"""
def SetObjectBrowserContext(options : ObjectBrowserContextOptions) -> None
"""
    @ingroup UTILITY_API
    @brief Applies an Object Browser context. The state is always persisted per-tab (keyed by
    options.type) so subsequent getter calls return it; updating one tab never affects the
    other tabs' cached context. In UI mode the Object Browser additionally switches to the
    targeted tab. In headless mode no UI is touched (all UI access is guarded), preventing
    null-pointer crashes while still persisting the state internally.
    @param options: the Object Browser context to apply (type selects the target tab).
"""
def GetAvatarMeasurements(_avatarIndex : int) -> list[CloApiAvatarMeasurement]
"""
    @ingroup UTILITY_API
    @brief Gets all measurements (user measures and avatar-default resizing measurements) on the avatar at the given index.
    @param _avatarIndex: Zero-based index of the target avatar.
    @return List of measurements. Empty if no avatar is loaded or the index is out of range.
"""
def DrawInternalLinesAroundGraphic(_patternIndex : int, _placementPoints : CloApiGraphicPlacementPoints) -> CloApiInternalShape
"""
    @ingroup UTILITY_API
    @brief Creates a closed internal shape tracing the boundary of a placed graphic, connecting
    _placementPoints' corners in order with straight internal lines (any polygon, not just rectangles).
    @param _patternIndex: The index of the pattern piece to draw the internal lines on.
    @param _placementPoints: Corners describing the boundary, in pattern-local 2D coordinates (e.g. from
    GetGraphicStylePlacementPoints with _is2D == true). At least 3 corners are required.
    @return The created boundary as GetInternalShapeInformation reports it — same name space, so the
    returned name can be passed straight to PlaceGraphicOnInternalShape — with its lines and their
    intersection points in pattern-local 2D coordinates. If the new boundary touches existing
    internal lines they are grouped into one shape, so the result can span more than the input
    corners. Empty CloApiInternalShape on failure.
"""
def PlaceTopstitchOnInternalLine(_colorwayIndex : int, _topStitchStyleIndex : int, _patternIndex : int, _line : CloApiLine, _anchorPoint : CloApiAnchorPoint) -> bool
"""
    @ingroup UTILITY_API
    @brief Applies a topstitch style to the pattern's internal line located via _line and _anchorPoint.
    The internal line matching _line's endpoints is preferred; otherwise the one closest to _anchorPoint's
    reference point on _line is used, so this works whether the internal line exists yet or not.
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _topStitchStyleIndex: Index of the topstitch style in the Object Browser topstitch list.
    @param _patternIndex: The index of the pattern piece that owns the internal line.
    @param _line: The line geometry designating the target internal line, endpoints in pattern-local 2D
    coordinates (as returned by GetInternalShapeInformation / DrawInternalLinesAroundGraphic).
    @param _anchorPoint: Reference point on _line: corner anchors use the nearest endpoint, center/edge
    anchors use the midpoint.
    @return true if the topstitch was applied to an internal line, false otherwise.
"""
def PlaceGraphicOnInternalShape(_colorwayIndex : int, _graphicStyleIndex : int, _shapeName : str, _face : int, _zOffset : float) -> bool
"""
    @ingroup UTILITY_API
    @brief Places a graphic style so it fills the internal shape named _shapeName exactly, aligned to the
    shape's longest edge (aspect ratio is NOT preserved; works for irregular / non-rectangular shapes).
    @param _colorwayIndex: Marvelous Designer has no colorways: pass 0.
    @param _graphicStyleIndex: Index of the graphic style in the Object Browser graphic list.
    @param _shapeName: Name of the internal shape to place the graphic on (e.g. "InternalShape_0", as returned
    by GetInternalShapeInformation / DrawInternalLinesAroundGraphic); the first pattern with a matching
    name is used, so names should be unique across the document.
    @param _face: 0: Front, 1: Back, 2: Both.
    @param _zOffset: Z offset value of the placed graphic.
    @return true if the graphic was placed successfully, false otherwise.
"""
def GetIntersectionPoints(_lines : list[CloApiLine]) -> CloApiInternalShape
"""
    @ingroup UTILITY_API
    @brief Finds the intersection point of every pair of the given lines. Parallel, collinear, and
    zero-length segments produce no intersection; touching endpoints count as one. Pure geometry
    computation; no scene data is read or modified.
    @param _lines: The line segments to evaluate. Renumbered from 0 if any lineNumber is negative or duplicated.
    @return A CloApiInternalShape with the (possibly renumbered) input lines and their intersection points.
"""
def GetInternalShapeInformation(_patternIndex : int) -> list[CloApiInternalShape]
"""
    @ingroup UTILITY_API
    @brief Groups a pattern's internal lines into disjoint shapes by connectivity: lines that intersect or
    touch within a small tolerance belong to the same shape.
    @param _patternIndex: The index of the pattern piece to analyze.
    @return Shapes named "InternalShape_0", "InternalShape_1", ... ordered by smallest contained line number,
    line endpoints in pattern-local 2D coordinates. Empty if the pattern is invalid or has no internal lines.
"""
def GetObjectBrowserItems(objectBrowserContextOptions : ObjectBrowserContextOptions) -> str
"""
    @brief Returns the Object Browser item list for a single asset type (one type per call), as a JSON string.
    The asset type is given by objectBrowserContextOptions.type; supported values are OB_TYPE_FABRIC,
    OB_TYPE_GRAPHIC, OB_TYPE_BUTTON, OB_TYPE_BUTTON_HOLE, OB_TYPE_TRIM, OB_TYPE_PUCKERING, OB_TYPE_ZIPPER, OB_TYPE_TOPSTITCH.
    bIncludeUnusedObjects keeps free/unused objects (not used by any pattern) when true.
    folderName is FABRIC-only: it scopes the result to one Object Browser folder. Empty = the primary/root
    folder; a non-empty name = that folder (an unknown name yields an empty list). It composes with the
    "used" filter and with bIncludePrints.
    bIncludePrints is FABRIC-only: when true the fabric response carries print info per fabric (see @return).
    @return JSON object string: { "ObjectType": "<type>", "ObjectNameList": ["name", ...] }. An unsupported
    targetObjectType yields { "ObjectType": "", "ObjectNameList": [] }; an empty list is returned as [].
    FABRIC with bIncludePrints == true keeps the SAME top-level "ObjectNameList" key, but its entries are
    objects instead of plain names: { "ObjectType": "Fabric Prints", "ObjectNameList": [ { "Name": "<fabric>" [, "PrintName": "<print>"] }, ... ] };
    the "PrintName" key is present only for fabrics that actually have a print.
"""