API List
EXPORT_API
def ExportZPac() -> str
"""
@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
"""
@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
"""
@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
"""
@brief Export ZPrj file
@return Output file path; output files will be created in MD temporary folder.
"""
def ExportZPrj(_filePath : str) -> str
"""
@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
"""
@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
"""
@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]
"""
@brief Export OBJ file
@param options If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportOBJ(_filePath : str) -> list[str]
"""
@brief Export OBJ file
@param _filePath: output file path
@return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportOBJ(_options : ImportExportOption) -> list[str]
"""
@brief Export OBJ file
@param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportOBJ(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@brief Export OBJ file
@param _filePath: output file path
@param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportOBJW(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@brief Export OBJ file
@param _filePath: output file path
@param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty wstring. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportAlembic(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@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]
"""
@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
"""
@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
"""
@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
"""
@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 ExportSnapshot3D(_filePath : str) -> list[ list [ str ] ]
"""
@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 path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportSnapshot3D() -> list[ list [ str ] ]
"""
@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 path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportSnapshot3DW(_filePath : str) -> list[ list [ str ] ]
"""
@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 path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportCustomViewSnapshot(_targetFolderPath : str, _width : int, _height : int, _outputPrefix : str) -> list [ str ]
"""
@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 ]
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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 ExportAnimationVideoW(_filePath : str) -> str
"""
@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 GetAvatarCount() -> int
"""
@brief Get the number of avatars loaded in MD
@return total count of avatars
"""
def GetAvatarNameList() -> list[str]
"""
@brief Get all the names of avatars loaded in MD
@return the list of name of all avatars
"""
def GetAvatarNameListW() -> list[str]
"""
@brief Get all the names of avatars loaded in MD
@return the list of name of all avatars
"""
def GetAvatarGenderList() -> list[int]
"""
@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]
"""
@brief Export turntable images for current colorway.
@param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
@return Output file path list; output files will be created in MD temporary folder. If an error occurs, return empty string.
"""
def ExportTurntableImages(_filePath : str, _numberOfImages : int, _width : int, _height : int, _startIndex : int) -> list[str]
"""
@brief Export turntable images for current colorway.
@param _filePath: the output file path to export the turntable snapshots
@param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
@param _width: image width for the snapshots
@param _height: image height for the snapshots
@param _startIndex: pecifies the starting index position of the turntable.
@return Output file path list. If an error occurs, return empty string.
"""
def ExportTurntableImagesW(_filePath : str, _numberOfImages : int, _width : int, _height : int, _startIndex : int) -> list[str]
"""
@brief Export turntable images for current colorway.
@param _filePath: the output file path to export the turntable snapshots
@param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
@param _width: image width for the snapshots
@param _height: image height for the snapshots
@param _startIndex: pecifies the starting index position of the turntable.
@return Output file path list. If an error occurs, return empty string.
"""
def ExportPose() -> str
"""
@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 ExportPose(_filePath : str) -> str
"""
@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 ExportPoseW(_filePath : str) -> str
"""
@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 ExportFBX(_options : ImportExportOption) -> list[str]
"""
@brief Export FBX file
@param options: It exports FBX according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportFBX(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@brief Export FBX file
@param options: It exports FBX according to options, not allowing user for selecting options in Export Dialog.
@param string _filePath : target file path in ASCII
@return Output file paths.
"""
def ExportFBXW(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@brief Export FBX file
@param options: It exports FBX according to options, not allowing user for selecting options in Export Dialog.
@param string _filePath : target file path in UNICODE
@return Output file paths.
"""
def ExportAVT(_filePath : str) -> str
"""
@brief Export AVT
@param _filePath: output file path
@return Output file path. If an error occurs, return empty string.
"""
def ExportAVTW(_filePath : str) -> str
"""
@brief Export AVT
@param _filePath: output file path
@return Output file path. If an error occurs, return empty string.
"""
def ExportUSD(_options : ImportExportOption, _usdOptions : ExportUSDOption) -> list[str]
"""
@brief Export USD file
@param options: It exports USD according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths. If filePath parameter is not given, output files will be created in MD temporary folder.
"""
def ExportUSD(_filePath : str, _options : ImportExportOption, _usdOptions : ExportUSDOption) -> list[str]
"""
@brief Export USD file
@param options: It exports USD according to options, not allowing user for selecting options in Export Dialog.
@param string _filePath : target file path in ASCII
@return Output file paths.
"""
def ExportUSDW(_filePath : str, _options : ImportExportOption, _usdOptions : ExportUSDOption) -> list[str]
"""
@brief Export USD file
@param options: It exports USD according to options, not allowing user for selecting options in Export Dialog.
@param string _filePath : target file path in UNICODE
@return Output file paths.
"""
def ExportZCMR(_folderPath : str) -> list[str]
"""
@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]
"""
@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]
"""
"""
IMPORT_API
def ImportFile(filePath : str) -> bool
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Import OBJ file
@param _filePath: input file path
@param options: If "options" is given, it imports OBJ according to options, not allowing user for selecting options in Import Dialog.
@return if it succeeds, return true.
"""
def ImportOBJW(_filePath : str, _options : ImportExportOption) -> bool
"""
@brief Import OBJ file
@param _filePath: input file path
@param options: If "options" is given, it imports OBJ according to options, not allowing user for selecting options in Import Dialog.
@return if it succeeds, return true.
"""
def ImportGraphicStyleFromImage(_filePath : str) -> bool
"""
@brief Import DXF file
@param _filePath: input file path
@return if it succeeds, return true.
"""
def ImportGraphicStyleFromImage(_filePath : str) -> bool
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Import SMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
def ImportSMPW(_filePath : str) -> bool
"""
@brief Import SMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
def ImportAsGraphic(_filePath : str) -> None
"""
@brief Import an image file as Graphic.
@param _filePath: input file path
"""
def ImportAsGraphicW(_filePath : str) -> None
"""
@brief Import an image file as Graphic.
@param _filePath: input file path
"""
def ImportTrim(_filePath : str, _bTranslateToOrigin : bool) -> None
"""
@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
"""
@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
"""
@brief Import Avatar
@param _avtPath : input Avatar file path, _opt : input load options
"""
def ImportMeasurement(_csvPath : str) -> bool
"""
@brief Import Avatar Measurement CSV file
@param _csvPath: input CSV file path
"""
def ImportPose(_filePath : str) -> bool
"""
@brief Import a pose/hand pose file.
@param _filePath: input file path
"""
def ImportPoseW(_filePath : str) -> bool
"""
@brief Import a pose/hand pose file.
@param _filePath: input file path
"""
def ImportAlembic(filePath : str, option : ImportAlembicOption) -> bool
"""
@brief Import an alembic (.abc) file.
@param _filePath: input file path
@param options:
"""
def ImportZpac(filePath : str, loadOption : ImportExportOption) -> bool
"""
@brief Import Zpac file
@param _filePath: input file path
@param options: If "options" 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
"""
@brief Get the number of patterns
@return return the number of patterns on the pattern editor and avatar window
"""
def GetPatternIndex(patternName : str) -> int
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Get the number of patterns
@return return the number of patterns on the pattern editor and avatar window
"""
def GetPatternInputInformation(_patternIndex : int) -> str
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Get the pattern piece area which is using for pattern index
@return return pattern piece
"""
def GetLineLength(_patternIndex : int, _lineIndex : int) -> float
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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]
"""
@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]
"""
@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]
"""
@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]
"""
@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]
"""
@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]
"""
@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]]
"""
@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]
"""
@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]
"""
@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]
"""
@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
"""
@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
"""
@brief Set patterns particle distance using length
@param length: the length value to determine particle distance
"""
def SetMeshType(_patternIndex : int, _meshType : str) -> None
"""
@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
"""
@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
"""
@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
"""
@brief Set Height Shrinkage Percentage using pattern index, height
@param patternIndex: the pattern index to set the pattern height shrinkage percentage,
height: the height value to determine width shrinkage percentage
"""
def GetArrangementList() -> list[map[str, str]]
"""
@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]]
"""
@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]
"""
@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]
"""
@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]
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Copy Pattern using the pattern index and x,y offset distance
@param patternIndex: the pattern index for copying pattern
_offsetX, _offsetY : the value to determine pattern copy offset distance,
@return return copy pattern index
"""
def DeletePatternPiece(_patternIndex : int) -> None
"""
@brief Delete Pattern using the pattern index
@param patternIndex: the pattern index for delete pattern
@return return copy pattern index
"""
def DeleteLine(_patternIndex : int, _lineIndex : int) -> None
"""
@brief Delete Pattern using the pattern index
@param patternIndex: the pattern index for delete pattern
@param lineIndex: the line index for delete line
"""
def DeletePoint(_patternIndex : int, _poinIndex : int) -> None
"""
@brief Delete Pattern using the pattern index
@param patternIndex: the pattern index for delete pattern
@param poinIndex: the point index for delete point
"""
def FlipPatternPiece(_patternIndex : int, _bHorizontally : bool, _bEach : bool) -> None
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Instance Pattern using the pattern index
@param patternIndex: this pattern index for instance pattern
"""
def SymmetryPatternPieceWithPatternName(_patternName : str, _bWithSewing : bool) -> None
"""
@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
"""
@brief Instance Pattern using the pattern name
@param _patternName: the pattern name for instance pattern
"""
def GetPatternPieceName(_patternIndex : int) -> str
"""
@brief Get Pattern name using the pattern index
@param _patternIndex: the pattern index for get name
"""
def SetPatternPieceName(_patternIndex : int, _patternName : str) -> None
"""
@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
"""
@brief Get Pattern fabric index using the pattern index
@param _patternIndex: the pattern index to get
"""
def SetPatternPieceFabricIndex(_patternPieceIndex : int, _fabricIndex : int) -> None
"""
@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
"""
@brief Get Pattern Grain direction info using the pattern index
@param _patternIndex: the pattern index to get
"""
def SetPatternPieceGrainDirection(_patternPieceIndex : int, _degree : float) -> None
"""
@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 GetPatternPieceCategory(_patternPieceIndex : int) -> int
"""
@brief Get Pattern category number using the pattern index
@param _patternPieceIndex: the pattern index to get
"""
def SetPatternPieceCategory(_patternPieceIndex : int, _category : int) -> None
"""
@brief Set Pattern category number using the pattern index
@param _patternPieceIndex: the pattern index to get
_category: the value to set category value
"""
def GetPatternPieceClassification(_patternPieceIndex : int) -> str
"""
@brief Get Pattern classification using the pattern index
@param _patternPieceIndex: the pattern index to get
"""
def SetPatternPieceClassification(_patternPieceIndex : int, _classification : str) -> None
"""
@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
"""
@brief Check if Pattern Solidify using the pattern index
@param _patternPieceIndex: the pattern index to get
"""
def SetPatternPieceSolidify(_patternPieceIndex : int, _isOn : bool) -> None
"""
@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
"""
@brief Get Pattern Solidify using the pattern index
@param _patternPieceIndex: the pattern index to get
"""
def SetPatternPieceSolidifyStrengthen(_patternPieceIndex : int, _strengthen : float) -> None
"""
@brief Get Pattern Solidify using the pattern index
@param _patternPieceIndex: the pattern index to get
_strengthen : strengthen value to set
"""
def ConvertToBaseLine(_patternIndex : int, _childrenIndex : int) -> None
"""
@brief Convert To BaseLine using the pattern index and children index
@param patternIndex: the pattern index for convert pattern
children Index: the children index for convert children
"""
def ConvertToInternalLine(_patternIndex : int, _childrenIndex : int) -> None
"""
@brief Convert To InternalLine using the pattern index and children index
@param patternIndex: the pattern index for convert pattern
children Index: the children index for convert children
"""
def DistribueInternalLinesbetweenSegments(_patternIndex : int, _lineIndexs : list[int], _number : int, _bStraightLine : bool, _bPerpendicularDirection : bool, _bGraduateSegmentLengths : bool) -> None
"""
@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
_x: The X position offset of pattern want to move
_y: 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 SetPatternPieceShirring(_patternIndex : int, _lineIndex : int, _bShirring : bool) -> None
"""
@brief Set Pattern piece's shirring. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line
@param _patternIndex: The pattern index to apply shirring
_lineIndex: The line index to apply shirring. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line
_bShirring: Whether to apply shirring
"""
def SetPatternPieceShirringInterval(_patternIndex : int, _lineIndex : int, _interval : float) -> None
"""
@brief Set Pattern piece's shirring interval. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line
@param _patternIndex: The pattern index to apply shirring interval
_lineIndex: The line index to apply shirring interval. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line
_interval: The interval of shirring
"""
def SetPatternPieceShirringHeight(_patternIndex : int, _lineIndex : int, _height : float) -> None
"""
@brief Set Pattern piece's shirring height. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line
@param _patternIndex: The pattern index to apply shirring height
_lineIndex: The line index to apply shirring height. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line
_height: The height of shirring
"""
def SetPatternPieceShirringExtend(_patternIndex : int, _lineIndex : int, _bExtend : bool) -> None
"""
@brief Set Pattern piece's shirring extend. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line
@param _patternIndex: The pattern index to apply shirring extend
_lineIndex: The line index to apply shirring extend. When _lineIndex == -1, apply to all line, 0 <= _lineIndex, apply to line
_bExtend: Whether to apply shirring extend
"""
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 CreateBaseShapeWithPoints(_patternIndex : int, _points : list[tuple[float, float, int]], _isClosed : bool) -> int
"""
@brief Create a pattern's base shape using a set of vertices.
@param _patternIndex: Parent Pattern Index
_points: set of vertices.
tuple --> postion X, postion Y, VertexType
VertexType : 0, 2, 3
0 : Straight Point
2 : Spline Curve Point
3 : Bezier Curve Point
_isClosed: If true, connect the last vertex to the first vertex.
@return InternalShapeIndex
"""
def SetPatternLayer(_patternIndex : int, _layer : int) -> None
"""
@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
"""
@brief Get Pattern Layer using pattern index
@param patternIndex: the pattern index to get the pattern layer,
"""
def SetPatternFreeze(_patternIndex : int, _bFreeze : bool) -> None
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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]]
"""
@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
"""
@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]]
"""
@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]]
"""
@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
"""
@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
"""
@brief Set Pattern Assigned Topstitch Style
@param patternIndex: the pattern index for Set Topstitch Style
"""
def IsPatternAssignedTopstitchExtendStart(_patternIndex : int, _segmentStitchIndex : int) -> bool
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Import TopStitch Style from file path
@param filePath: the .sst file path for Import TopStitch Style
"""
def GetLinkedPatternIndex(patternIndex : int) -> list[int]
"""
@brief Get the pattern index information connected to the pattern.
@param patternIndex: Tartget Pattern Index
"""
def GetTopstitchStyleModelType(_topStitchStyleIndex : int) -> int
"""
@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
"""
@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
"""
@brief Get the material name used in the garment
@return json string for pattern input information
"""
def GetPinListSize() -> int
"""
@brief Count the number of pins from patterns
@return number of pins
"""
def RemovePin() -> bool
"""
@brief Removes Pin one by one
"""
def RemoveAllPins() -> bool
"""
@brief Removes all active pins
"""
def GetSeamlinePairGroupListInPattern(_patternIndex : int) -> list[ int]
"""
@brief Gets a list of the seamlinePairGroup associated with the pattern.
@return Index List of seamlinePairGroup
@param _patternIndex: pattern index
"""
def GetSeamlinePairGroupCount() -> int
"""
@brief Gets the number of seamlinePairGroup that exist in the scene.
@return Number of seamlinePairGroup
"""
def GetSeamlinePairGroupName(_seamlinePiarGroupIndex : int) -> str
"""
@brief Get name from seamline pair group index
@return name of seamline Pair Group
@param _seamlinePiarGroupIndex : seamlinePairGroup index
"""
def GetSeamlinePairGroupNameW(_seamlinePiarGroupIndex : int) -> str
"""
@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
"""
@brief Get index from seamline pair group name
@return name of sewing group(wide string)
@param _seamlinePairGroupName : seamlinePairGroup name
"""
def GetSeamlinePairGroupIndexFromNameW(_seamlinePairGroupNameW : str) -> int
"""
@brief Get index from seamline pair group name
@return name of sewing group(wide string)
@param _seamlinePairGroupNameW : seamlinePairGroup name
"""
def ExportPatternJSON(_path : str) -> bool
"""
@brief Export pattern information by JSON format
@return boolean result of exporting json file
"""
def ImportPatternJSON(_path : str) -> bool
"""
@brief Import pattern information of JSON file
@return boolean result of importing json file
"""
def GetAllStitchProperty() -> str
"""
@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
"""
@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
"""
@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
"""
@brief Add InnerShape and Sewing between InnerShape
@return name of sewing group(wide string)
@param _patternAIndex : A pattern index
@param _childAIndex : The index of the innershape that belongs to the A pattern.
@param _lineAIndex : The index of the line that belongs to the innerShape.
@param _patternBIndex : B pattern index
@param _childBIndex : The index of the innershape that belongs to the B pattern.
@param _lineBIndex : The index of the line that belongs to the innerShape.
@param _directionA : The direction of the stitching, true : forward, false : backward
@param _directionB : The direction of the stitching, true : forward, false : backward
"""
def GetSelectedPattern() -> list[str]
"""
@brief Get the selected pattern name
@return returns the selected pattern name
"""
def GetSelectedPatternViaIndex(patternIndex : int) -> bool
"""
@brief Check if the paatern is selected via pattern index
@param patternIndex : The index of the pattern to select.
@return returns true if the pattern is selected.
"""
def SelectPatternViaIndex(patternIndex : int, keepPreviousSelection : bool) -> None
"""
@brief Select patterns via name
@param patternIndex : The index of the pattern to select.
@param keepPreviousSelection : True if you want to keep the previous selection. False will clrear the previous selection.
"""
def SelectPatternViaName(_patternName : str, keepPreviousSelection : bool) -> None
"""
@brief Select patterns via name
@param _patternName : The name of the pattern to select.
@param keepPreviousSelection : True if you want to keep the previous selection. False will clrear the previous selection.
"""
def GetBackUVExpansion(_patternIndex : int) -> bool
"""
@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
"""
@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
"""
@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
"""
@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 SetAddlThicknessCollision(_patternIndex : int, _value : float) -> None
"""
@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
"""
@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
"""
@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.
"""
FABRIC_API
def GetFabricCount(_bCurrentColorway : bool) -> int
"""
@brief Get the number of fabrics
@param _bCurrentColorway: If this value is true, counting only Fabrics that are used in current Colorway (Default: true)
@return the number of fabric in object browser for the current project.
"""
def GetCurrentFabricIndex() -> int
"""
@brief Get the index of the selected Fabric
@return the index of selected fabric in object browser for the current project..
"""
def ExportZFab() -> str
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Assign a fabric to a pattern.
@param _fabricIndex: the source fabric index in the object browser to apply to the target pattern
@param _patternIndex: the tagert pattern index to apply the fabric in the fabricIndex
@param _assignOption:
_assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items.
_assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors.
_assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously
@return if it succeeds, return true.
"""
def DeleteFabric(fabricIndex : int) -> bool
"""
@brief Delete a fabric. If the fabric was assigned on Patterns, the patterns will have the default fabric
@return if it succeeds, return true.
"""
def GetFabricIndexForPattern(patternIndex : int) -> int
"""
@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
"""
@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
"""
@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
"""
@brief Get the fabric name of the fabric in the fabricIndex on the object browser
@parm fabricIndex: the fabric index on the Object Browser to get the name
@return fabric name
"""
def GetFabricNameW(fabricIndex : int) -> str
"""
@brief Get the fabric name of the fabric in the fabricIndex on the object browser
@parm fabricIndex: the fabric index on the Object Browser to get the name
@return fabric name
"""
def GetFabricInfo(fabricIndex : int) -> str
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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]
"""
@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]
"""
@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
"""
@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
"""
@brief Set Custom Image to fabric
@param _fabricIndex: the fabricIndex for the fabric
@param _filePath: filepath (.png / .jpeg)
"""
def GetPrimaryFabric() -> int
"""
@brief Return the fabric index used for a major number of the patterns
"""
def SetFabricName(index : int, str : str) -> None
"""
@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
"""
@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 SetFabricName(_index : int, _str : str, _bRefreshTab : bool) -> None
"""
@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]
"""
@brief Return all fabric style name
"""
def ImportSubstanceFile(fabricIndex : int, substanceFilePath : str) -> bool
"""
@brief Import substance to a fabric.
@parm fabricIndex: the target fabric index in the object browser to import substance file onto
@parm substanceFilePath: the substance file path to import
@return if it succeeds, return true.
"""
def ImportSubstanceFileW(fabricIndex : int, substanceFilePath : str) -> bool
"""
@brief Import substance to a fabric.
@parm fabricIndex: the target fabric index in the object browser to import substance file onto
@parm substanceFilePath: the substance file path to import
@return if it succeeds, return true.
"""
def GetFabricLength(fabricIndex : int) -> float
"""
@brief Get Fabric Length (mm)
@parm fabricIndex: the target fabric index in the object browser
@return Fabric Length
"""
def SetTextureMapping(fabricIndex : int, mappingType : int) -> None
"""
@brief Set Texture Mapping Type (Repeat or Unified)
@parm fabricIndex: the target fabric index in the object browser
@parm mapping type: the target mapping type to set. 0: "Repeat", 1: "Unified"
@return void
"""
def SetSubstancePreset(fabricIndex : int, materialFace : int, presetIndex : int) -> None
"""
@brief Set Texture Mapping Type (Repeat or Unified)
@parm fabricIndex: the target fabric index in the object browser
@parm materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@parm presetIndex: the preset index to set
@return void
"""
def SetSubstanceResolution(fabricIndex : int, materialFace : int, resolutionIndex : int) -> None
"""
@brief Set Texture Mapping Type (Repeat or Unified)
@parm fabricIndex: the target fabric index in the object browser
@parm materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@parm resolutionIndex: the resolution index to set
@return void
"""
def ImportSubstanceFileAsFaceType(_fabricIndex : int, _substanceFilePath : str, _faceType : str) -> bool
"""
@brief Import substance to a fabric as facetype.
@parm _fabricIndex: the target fabric index in the object browser to import substance file onto
@parm _substanceFilePath: the substance file path to import
@parm _facetype :“Front”, “Back”, “Side”
@return if it succeeds, return true.
"""
def ImportSubstanceFileAsFaceTypeW(_fabricIndex : int, _substanceFilePath : str, _faceType : str) -> bool
"""
@brief Import substance to a fabric.
@parm _fabricIndex: the target fabric index in the object browser to import substance file onto
@parm _substanceFilePath: the substance file path to import
@parm _facetype :“Front”, “Back”, “Side”
@return if it succeeds, return true.
"""
def SetUseSameMaterialAsFront(fabricIndex : int, materialFace : int, _useSameMaterial : bool) -> None
"""
@brief Set use same material as front.
@parm fabricIndex: the target fabric index in the object browser
@parm materialFace: the target material index in the property editor. 1: "Back", 2: "Side"
@parm _useSameMaterial: use same material as front
@return void
"""
def GetUseSameMaterialAsFront(fabricIndex : int, materialFace : int) -> bool
"""
@brief Set use same material as front.
@parm fabricIndex: the target fabric index in the object browser
@parm 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
"""
@brief Set use same color as front.
@parm fabricIndex: the target fabric index in the object browser
@parm materialFace: the target material index in the property editor. 1: "Back", 2: "Side"
@parm _useSameColor: use same color as front
@return void
"""
def GetUseSameColorAsFront(fabricIndex : int, materialFace : int) -> bool
"""
@brief Set use same color as front.
@parm fabricIndex: the target fabric index in the object browser
@parm 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
"""
@brief Set a base color of PBR material in a fabric using given RGBA values.
@parm fabricIndex: the target fabric index in the object browser to import substance file onto
@parm materialFace :“Front”, “Back”, “Side”
@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 SetFabricPBRMaterialBaseColor(fabricIndex : int, materialFace : int, _colorName : str) -> bool
"""
@brief Set a base color of PBR material in a fabric using given name of color.
@parm fabricIndex: the target fabric index in the object browser to import substance file onto
@parm materialFace :“Front”, “Back”, “Side”
@parm _colorName: Name of color
@return if it succeeds, return true.
"""
def GetFabricPBRMaterialBaseColor(fabricIndex : int, materialFace : int) -> tuple[float, float, float, float]
"""
@brief Get a base color of PBR material in a fabric.
@parm fabricIndex: the target fabric index in the object browser to import substance file onto
@parm materialFace :“Front”, “Back”, “Side”
@return RGBA float tuple
"""
def SetCurrentFabricIndex(_index : int) -> bool
"""
@brief Set Current Fabric Index
@parm _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
"""
@brief Create Zfab From Textures
@param _filePath: created filepath (.zfab)
@parm _baseTexturePath: the baseTexture file path to create zfab
@parm _normalTexturePath: the normalTexturePath file path to create zfab
@parm _disPlacementTexturePath :the disPlacementTexturePath file path to create zfab
@parm _opacityTexturePath :the opacityTexturePath file path to create zfab
@parm _roughnessTexturePath :the roughnessTexturePath file path to create zfab
@parm _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
"""
@brief Combining two zfab files into one
@param _filePath: created filepath (.zfab)
@parm _baseZfabPath: the Path to the zfab file on which the physical properties will be based
@parm _targetZfabPath: the path to the zfab file on which the image will be based
"""
def GetRoughnessType(_index : int, _materialFace : int) -> int
"""
@brief Get Material RoughnessType
@parm _index: Fabric Index, _materialFace : Fabric Material Face Type (0 : Front , 1 : BACK , 2 : SIDE)
@return Return fabric's mateiral Roughness Type. ( 0 : Intensity, 1 : Map )
"""
def SetRoughnessType(_index : int, _materialFace : int, _roughnessType : int) -> None
"""
@brief Set Current Fabric's mateiral roughnessType
@parm _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
"""
@brief Get fabric material's Roughness Intensity values.
@parm _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
"""
@brief Set fabric material's Roughness Intensity values.
@parm _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
"""
@brief Get fabric material's map type roughness intensity values.
@parm _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
"""
@brief Set fabric material's map type roughness intensity values.
@parm _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
"""
@brief Return whether roughness map is inverted.
@parm _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
"""
@brief SetS whether roughness map is inverted
@parm _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
"""
@brief Set fabric's displacement map using given image path.
@parm _fabricIndex: index of fabric
@parm _path: path of the image file
@Return true if succeed, false othrewise.
"""
def GetPBRMaterialDisplacementMapValue(_fabricIndex : int) -> tuple[float, float, float, float, bool]
"""
@brief Get fabric's displacement map values.
@parm _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
"""
@brief Set fabric's displacement map values.
@parm _fabricIndex: index of fabric
@parm _amount: Amount value to be set (mm)
@parm _shift: Shift value to be set (mm)
@parm _clipping: Clipping value to be set (mm)
@parm _particleDist: Particle distance value to be set (mm)
@parm _keep: Keep Continuity value to be set
@Return true if succeed, false othrewise.
"""
def GetReflectionRoughness(_fabricIndex : int, _materialFace : int) -> float
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Set materal 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 _normalMapIntensity: normal map intensity value
@return void
"""
def GetOpacityIntensity(_fabricIndex : int, _materialFace : int) -> float
"""
@brief Get opacity intensity in percent
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@return opaicty intensity value
"""
def SetOpacityIntensity(_fabricIndex : int, _materialFace : int, _opacityIntensity : float) -> None
"""
@brief Set opaicty intensity in percent
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@param _opacityIntensity: opaicty intensity value
@return void
"""
def GetBaseTextureMapImageFilePath() -> str
"""
"""
def GetNormalMapImageFilePath() -> str
"""
"""
def GetDisplacementMapImageFilePath() -> str
"""
"""
def GetOpacityMapImageFilePath() -> str
"""
"""
def GetRoughnessMapImageFilePath() -> str
"""
"""
def GetMetalnessMapImageFilePath() -> str
"""
"""
def GetBaseTextureMapImageFilePathW() -> str
"""
"""
def GetNormalMapImageFilePathW() -> str
"""
"""
def GetDisplacementMapImageFilePathW() -> str
"""
"""
def GetOpacityMapImageFilePathW() -> str
"""
"""
def GetRoughnessMapImageFilePathW() -> str
"""
"""
def GetMetalnessMapImageFilePathW() -> str
"""
"""
def GetBaseTextureMapImageFilePath(_fabricIndex : int) -> str
"""
"""
def GetNormalMapImageFilePath(_fabricIndex : int) -> str
"""
"""
def GetDisplacementMapImageFilePath(_fabricIndex : int) -> str
"""
"""
def GetOpacityMapImageFilePath(_fabricIndex : int) -> str
"""
"""
def GetRoughnessMapImageFilePath(_fabricIndex : int) -> str
"""
"""
def GetMetalnessMapImageFilePath(_fabricIndex : int) -> str
"""
"""
def GetBaseTextureMapImageFilePathW(_fabricIndex : int) -> str
"""
"""
def GetNormalMapImageFilePathW(_fabricIndex : int) -> str
"""
"""
def GetDisplacementMapImageFilePathW(_fabricIndex : int) -> str
"""
"""
def GetOpacityMapImageFilePathW(_fabricIndex : int) -> str
"""
"""
def GetRoughnessMapImageFilePathW(_fabricIndex : int) -> str
"""
"""
def GetMetalnessMapImageFilePathW(_fabricIndex : int) -> str
"""
"""
def SetBaseTextureMapImageGivenFilePath(_imageFilePath : str) -> None
"""
"""
def SetNormalMapImageGivenFilePath(_imageFilePath : str) -> None
"""
"""
def SetDisplacementMapImageGivenFilePath(_imageFilePath : str) -> None
"""
"""
def SetOpacityMapImageGivenFilePath(_imageFilePath : str) -> None
"""
"""
def SetRoughnessMapImageGivenFilePath(_imageFilePath : str) -> None
"""
"""
def SetMetalnessMapImageGivenFilePath(_imageFilePath : str) -> None
"""
"""
def SetBaseTextureMapImageGivenFilePathW(_imageFilePath : str) -> None
"""
"""
def SetNormalMapImageGivenFilePathW(_imageFilePath : str) -> None
"""
"""
def SetDisplacementMapImageGivenFilePathW(_imageFilePath : str) -> None
"""
"""
def SetOpacityMapImageGivenFilePathW(_imageFilePath : str) -> None
"""
"""
def SetRoughnessMapImageGivenFilePathW(_imageFilePath : str) -> None
"""
"""
def SetMetalnessMapImageGivenFilePathW(_imageFilePath : str) -> None
"""
"""
def SetBaseTextureMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetNormalMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetDisplacementMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetOpacityMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetRoughnessMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetMetalnessMapImageGivenFilePath(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetBaseTextureMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetNormalMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetDisplacementMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetOpacityMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetRoughnessMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def SetMetalnessMapImageGivenFilePathW(_imageFilePath : str, _fabricIndex : int) -> None
"""
"""
def GetFabricTextureMappingType(_fabricIndex : int) -> int
"""
@param _fabricIndex: the target fabric index in the object browser
@return it return 0: "Repeat" or 1: "Unified".
"""
UTILITY_API
def DisplayMessageBox(str : str) -> None
"""
@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
"""
@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
"""
@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
"""
@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 GetProjectFilePath() -> str
"""
@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
"""
@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
"""
@brief Get the major version of the MD software
@return Major version of SW. ex) 5 of 5.0.72
"""
def GetMinorVersion() -> int
"""
@brief Get the minor version of the MD software
@return Minor version of SW. ex) 0 of 5.0.72
"""
def GetPatchVersion() -> int
"""
@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
"""
@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 GetCustomViewInformation() -> str
"""
@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
"""
@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
"""
@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
"""
@brief Restore the shape of cloth to when the cloth was loaded
"""
def SaveCLOFileThumbnail(filePath : str, outputPath : str, thumbnailIndex : int) -> bool
"""
@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
"""
@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
"""
@brief Get Meta data for the current Garment
@return the meta data for the current garment
"""
def GetMetaDataForCurrentGarmentW() -> str
"""
@brief Get Meta data for the current Garment
@return the meta data for the current garment
"""
def SetMetaDataForCurrentGarment(metaDataStr : str) -> None
"""
@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
"""
@brief Change Meta Data Value for the current Garment
@metaDataKey: target Key
@metaDataValue: the new value for the key
"""
def CreateProgressBar() -> None
"""
@brief Create Progress Bar to show progress. This function should be called before using SetProgress function
"""
def SetProgress(title : str, progress : int) -> None
"""
@brief Set progress on the Progress Bar
"""
def SetProgressW(title : str, progress : int) -> None
"""
@brief Set progress on the Progress Bar
"""
def DeleteProgressBar(bForce : bool) -> None
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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]
"""
@brief Get the list of color swatch library tab names
@return the list of color swatch library tab names
"""
def GetColorSwatchLibraryTabListW() -> list[str]
"""
@brief Get the list of color swatch library tab names as wstring
@return the list of color swatch library tab names as wstring
"""
def NewProject() -> None
"""
@brief Clear the current garment and begin a new garment
"""
def IsReadableImageFormat(filePath : str) -> bool
"""
- 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.
@fn IsReadableImageFormat(const string& filePath)
@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
"""
@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 GetAPIMetaData(filePath : str) -> str
"""
@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
"""
@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
"""
@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
"""
@brief Set API meta data to the file
@param filePath: target file path
@param jsonStr: api meta data in string format
@return if it succeeds, return true
"""
def Set3DWindowTitle(title : str) -> bool
"""
@brief Set 3D Window Title
@param title: desired text in 3D window
@return if it succeeds, return true
"""
def Set3DWindowTitleW(title : str) -> bool
"""
@brief Set 3D Window Title
@param title: desired text in 3D window
@return if it succeeds, return true
"""
def SetShowHideAvatar(_bShow : bool) -> None
"""
@brief Set all avatars' show/hide status
@param _bShow: true for show, false for hide
"""
def SetShowHideAvatar(_bShow : bool, _avatarIdex : int) -> None
"""
@brief Set show/hide status of avatar that matches the index
@param _bShow: true for show, false for hide
"""
def IsShowAvatar(_avatarIndex : int) -> bool
"""
@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
"""
@brief Set Schematic Render status
@param _bSet: true for enable, false for disable
"""
def ReplaceGraphicStyleFromImage(_graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool
"""
@brief replace graphic style in index
@param _imagePath: input file path
@param _graphicstyleindex: index of the style to be replaced
@param _anchor: position that will be fixed when replacing. (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
@return if it succeeds, return true.
"""
def ReplaceGraphicStyleFromImage(_graphicstyleIndex : int, _imagePath : str, _anchor : int) -> bool
"""
@brief replace graphic style in index
@param _imagePath: input file path
@param _graphicstyleindex: index of the style to be replaced
@param _anchor: position that will be fixed when replacing. (0: center, 1: up, 2: right-up, 3: right, 4: right-down, 5: down, 6: left-down, 7: left, 8: left-up)
@return if it succeeds, return true.
"""
def Simulate(_steps : int) -> bool
"""
@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
"""
@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
"""
@brief Set simulation time step
@param _timeStep: time step in second (Default : 0.03333, Min value: 0.001)
"""
def SetSimulationNumberOfSimulation(_numberOfSimulation : int) -> None
"""
@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
"""
@brief Set simulation finish condition
@param _cgFinishCondition : Conjugate Gradient finish condition (0: iteration, 1: residual)
"""
def SetSimulationCGIterationCount(_cgIterationCount : int) -> None
"""
@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
"""
@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
"""
@brief Set self collision iteration count
@param _selfCollisionIterationCount : self collision iteration count (Default: 1)
"""
def SetSimulationAirDamping(_airDamping : float) -> None
"""
@brief Set air damping value
@param _airDamping : air damping(Default: 1.0)
"""
def SetSimulationGravity(_gravity : float) -> None
"""
@brief Set gravity value in y-axis
@param _gravity : gravity (Default: -9800.0 mm/s^2)
"""
def SetSimulationNumberOfCPUInUse(_numberOfSimulationInUse : int) -> None
"""
@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
"""
@brief Set nonlinear simulation
@param _bNonlinearSimulation : true for enable, false for disable
"""
def SetSimulationGroundCollision(_bGroundCollision : bool) -> None
"""
@brief Set ground collision
@param _bGroundCollision : true for enable, false for disable
"""
def SetSimulationGroundHeight(_groundHeight : float) -> None
"""
@brief Set ground height value
@param _groundHeight : ground height in y-axis (Default: 0.0)
"""
def SetSimulationSelfCollisionAvoidanceStiffness(_avoidanceStiffness : float) -> None
"""
@brief Set stiffness of the inserted spring to avoid self collision
@param _avoidanceStiffness : (Default: 0.001)
"""
def SetSimulationLayerBasedCollisionDetection(_bUseLayer : bool) -> None
"""
@brief Set layer based collision detection
@param _bUseLayer : true for enable, false for disable
"""
def SetAvatarMeshTexture(_matShapeName : str, _matMeshIndex : int, _textureImagePath : str) -> bool
"""
@brief Import AvtarTexture Body Part(face, body, arm, leg)
@param _bodyShapeName: input avatar shape name(find object browser)
@param _matShapeIndex: mat shape index (0: face, 1:body, 2:arm, 3:leg)
@param _textureImagePath: change texture full path
@return if it succeeds, return true.
"""
def SetAnimationRecording(_bStart : bool) -> None
"""
@brief set animation recording
@param _bStart: true for recording start, false for recording stop
"""
def SetCurrentAnimationFrame(_frame : double) -> None
"""
@brief set current animation frame
@param _frame: Value for setting current frame
"""
def GetCurrentAnimationFrame() -> double
"""
@brief get current animation frame
"""
def SetStartAnimationFrame(_frame : double) -> None
"""
@brief set start animation frame
@param _frame: Value for setting start frame
"""
def GetStartAnimationFrame() -> double
"""
@brief get start animation frame
"""
def SetEndAnimationFrame(_frame : double) -> None
"""
@brief set end animation frame
@param _frame: Value for setting end frame
"""
def GetEndAnimationFrame() -> double
"""
@brief get end animation frame
"""
def GetTotalEndAnimationFrame() -> double
"""
@brief Returns the last frame from the animation list.
@return end animation frame value type Double. Returns -FLT_MAX if the value is invalid.
"""
def GetAnimationLayerFrameRange(_layerIndex : int) -> std::pair[double, double]
"""
@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
"""
@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
"""
@brief Move the animation to a specific frame.
@param _frame The target frame to move the animation to.
"""
def CopyFromFirstClothCache() -> None
"""
@brief Copy the first cloth cache to current frame
"""
def GetSchematicRender() -> bool
"""
@brief Get Show Schematic Render Status
"""
def SetCamViewPoint(_viewPointIndex : int) -> None
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief set schematic silhouette line width
@param _value: Value for setting schematic silhouette line width
"""
def SetSchematicSeamLineWidth(_value : int) -> None
"""
@brief set schematic seamline width
@param _value: Value for setting schematic seamline width
"""
def SetSchematicInternalLineWidth(_value : int) -> None
"""
@brief set schematic internal line width
@param _value: Value for setting chematic internal line width
"""
def SetSchematicTopstitchLineScalePercent(_value : int) -> None
"""
@brief set schematic topstitch line scale percent
@param _value: Value for setting schematic topstitch line scale percent
"""
def SetSchematicBrightness(_value : int) -> None
"""
@brief set schematic brightness
@param _value: Value for setting schematic brightness
"""
def SetShowSchematicSilhouetteLine(_bOn : bool) -> None
"""
@brief set show schematic silhouetteline
@param _bOn: Value for setting showschematic silhouetteline
"""
def SetShowSchematicSeamLine(_bOn : bool) -> None
"""
@brief set show schematic seamline
@param _bOn: Value for setting show schematic seamline
"""
def SetShowSchematicInternalLine(_bOn : bool) -> None
"""
@brief set show schematic internal line
@param _bOn: Value for setting show schematic internalline
"""
def SetShowSchematicTopstitchLine(_bOn : bool) -> None
"""
@brief set show schematic topstitch line
@param _bOn: Value for setting show schematic topstitchline
"""
def SetSchematicClothRenderType(_bTexture : bool) -> None
"""
@brief set schematic cloth render type
@param _bTexture: Value for setting schematic cloth render type
"""
def SetSchematicClothColor(_r : int, _g : int, _b : int) -> None
"""
@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
"""
@brief Set Quality Render status
@param _bSet: true for enable, false for disable
"""
def GetQualityRenderStatus() -> bool
"""
@brief Get Current Quality Render Status
"""
def BakeUVTexture(_filePath : str, _options : ImportExportOption, _bAll : bool) -> list[str]
"""
@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]
"""
@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
"""
@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
"""
@brief Reset UV islands to the 2D arrangement.
"""
def Refresh3DWindow() -> None
"""
@brief Refresh 3D Garment Window
"""
def Set3DGarmentRenderingStyle(_surfaceTextureTypeIndex : int) -> None
"""
@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
"""
@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
"""
@brief Returns the total quantity of all graphic items
@return If valid, returns the total quantity; otherwise, -1.
"""
def GetGraphicStyleCount() -> int
"""
@brief Returns the number of graphic styles in the current colorway
@return If valid, returns the number of graphic styles; otherwise, -1.
"""
def GetGraphicStylePosition(_graphicIndex : int, _is2D : bool) -> map[int, list[list[float]]]
"""
@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 GetGraphicStyleName(_index : int) -> str
"""
@brief Returns the name of the graphic style
@param _index: Graphic style index to use the plugin
@return If valid, returns the name; otherwise, an empty string.
"""
def GetGraphicStyleDimensions(_index : int) -> CloApiGraphicDimensions
"""
@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
"""
@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
"""
@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 SetGraphicStyleWidth(_index : int, _width : float, _bOnly : bool) -> None
"""
@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
"""
@brief Sets the height of the graphic style
@param _index: Graphic style index to use the plugin
@param _height: The height to be set for the graphic style
@param _bOnly: If true, the ratio is ignored, if false, the height is set according to the ratio.
"""
def UpdateCloStyleForPlugIn(_pWidget : QWidget*) -> None
"""
@brief Set MD style-sheet code to QWidget.
@param _pWidget: Root widget pointer of Plug-In Window.
ex> QWidget, QDialog, QFrame, etc...
"""
def UpdateCloStyleForPlugIn(_pWidget : QWidget*, _type : CloWidgetType) -> None
"""
@brief Set the style-sheet code corresponding to the CloWidgetType.
@param _pWidget: Widget pointer to set style-sheet code
@param _type: CloWidgetType of widget pointer
ex> TitleBar, ComboBox, Slider, ScrollArea, Dialog, Frame, etc...
"""
def GetStyleSheetCodeForWidget(_type : CloWidgetType) -> str
"""
@brief Returns the style-sheet code for CloWidgetType
@param _type: CloWidgetType of widget pointer
@return Style-sheet code for CloWidgetType
"""
def GetStyleSheetCodeForWidgetW(_type : CloWidgetType) -> str
"""
@brief Returns the style-sheet code for CloWidgetType
@param _type: CloWidgetType of widget pointer
@return Style-sheet code for CloWidgetType
"""
def CurrentlyThemeInCLO() -> CloTheme
"""
@brief Returns the currently Theme information used in MD
@return currently Theme type
"""
def SetCropBackground(_bToggle : bool) -> None
"""
@brief Set crop status.
@param _bToggle: change crop background as _bToggle
"""
def SetZoomView() -> None
"""
@brief Zoom cloth
"""
def SetViewPoint(_index : int) -> None
"""
@brief Set View Point in render property window
@param _index: View Point index to set (0: Current View, 1: Custom View)
"""
def GetViewPoint() -> int
"""
@brief Get current view point
@return View Point index (0: Current View, 1: Custom View)
@note If the view point is not set, it returns -1.
"""
def ReDrape3DArrangement(_options : ImportExportOption) -> None
"""
@brief Redrape all patterns 3D Arrangement
"""
def SetAPF(_path : str) -> None
"""
@brief Set APF file path
@param _path: APF file path
"""
def ABPNetworkAuth(id : str, pw : str, _APFpath : str) -> None
"""
@brief Regist Alvanon ID and Password
@param id: Alvanon ID
@param pw: Alvanon Password
@param _APFpath : APF File path
"""
def SetGraphicBaseColorMapTexture(_imageFilePath : str, _graphicStyleIndex : int) -> None
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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 SetGraphicNormalMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None
"""
@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
"""
@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
"""
@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 SetGraphicRoughnessMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None
"""
@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 SetGraphicMetalnessMapTexture(_GraphicIndex : int, _imageFilePath : str) -> None
"""
@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 GetGraphicNormalMapTexture() -> str
"""
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
def GetGraphicDisplacementMapTexture() -> str
"""
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
def GetGraphicOpacityMapTexture() -> str
"""
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
def GetGraphicRoughnessMapTexture() -> str
"""
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
def GetGraphicMetalnessMapTexture() -> str
"""
@brief Gets the texture map for the graphic style
@return _imageFilePath: The file path of the graphic style
"""
def GetGraphicNormalMapTexture(_GraphicIndex : int) -> str
"""
@brief Gets the texture map for the graphic style
@param GraphicIndex: Graphic style index to use the plugin
@return imageFilePath: The file path to be set for the graphic style
"""
def GetGraphicDisplacementMapTexture(_GraphicIndex : int) -> str
"""
@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
"""
@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
"""
@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
"""
@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]
"""
@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
"""
@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
"""
@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
"""
@brief Set a base color of PBR material in a Graphic using given color name values. (default index = 0)
@param _styleIndex: Graphic style index
@param _colorName: name of color
@return RGBA float tuple
"""
def AutoHang(_garmentPath : str, _hangerPath : str, _hangerType : int, _hangerImportOption : ImportExportOption) -> bool
"""
@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 AddPinsForFabricValidation(size1 : float, size2 : float, size3 : float, size4 : float) -> bool
"""
@brief Adjust lengths and adjust pin locations
"""
def UpdatePropertyWindow() -> None
"""
@brief Update the PropertyWindow
"""
def FitAllUV(x_coordinate : int, y_coordinate : int, _bIsRelative : bool, _marginValue : float) -> None
"""
@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
"""
@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 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 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 SetGraphicStyleToGraphic(_styleIndex : int, _graphicIndex : int, _assignOption : int) -> None
"""
@brief Set GraphicStyle of Graphic
@param _styleIndex: Graphic Style index on the Object Browser
@param _graphicIndex: Graphic index to change style
@param _assignOption:
_assignOption = 1 (Current Colorway): An item is only applied to the current colorway, while the other colorways retain the existing items.
_assignOption = 2 (All Colorways unlinked Materials): Each colorway is applied its own materials, such as textures and colors.
_assignOption = 3 (All Colorways linked): All colorways share the same item with linked properties, allowing any changes to be applied across all colorways simultaneously
"""
def GetSimulationQuality() -> std::pair[int, int]
"""
@return The Simulation type(0: Normal(Default), 1: Animation(Stable), 2: Fitting(Accurate Fabric)) and simulation mode (0: CPU, 1: FAST(GPU))
"""
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]
"""
@brief Get opacity maps Avatar
@return Output file paths.
"""
def SetTrimDisplaySettings(_option : int, _show : bool) -> None
"""
@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
"""
@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
"""
@brief Set 3D Background color
@param _r: Red channel
@param _g: Green channel
@param _b: Blue channel
"""
def SetGarmentDisplayProperties(_option : int, _show : bool) -> None
"""
@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
"""
@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
"""
@brief Set Show/Hide Color Options
@param _option: Option 0: All, 1: Freeze, 2: Strengthen, 3: Solodify, 4: Layer, 5: All (Mesh) , 6: Subdivide (Mesh), 7: Freeze (Mesh), 8: Strengthen (Mesh), 9: Solodify (Mesh)
@param _show: True/False. True is for show. False is for Hide
"""
def SetAvatarTexureMap(_imageFilePath : str, _textureType : int) -> None
"""
@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]
"""
@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
"""
@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
"""
@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 100×100 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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Get the name of a Trim Style by its index
@param _trimStyleIndex: The index of the Trim Style to retrieve the name for.
@return The name of the Trim Style if found, otherwise an empty string.
"""
def GetTopStitchName(_stitchIndex : int) -> str
"""
@brief Get the name of a Top Stitch Style by its index
@param _stitchIndex: The index of the Top Stitch Style to retrieve the name for.
@return The name of the Top Stitch Style if found, otherwise an empty string
"""
def RegisterWidget(_widget : int64_t) -> None
"""
@brief A function to store the int64_t-casted address of a QtWidget in a list.
@param _widget: A QtWidget’s address is cast to an int64_t using reinterpret_cast, then passed as an argument. reinterpret_cast<int64_t>(widget)
"""
def DeleteWidgets() -> None
"""
@brief Removes and deletes all widgets that were registered using the RegisterWidget function.
"""
def ResetWidgetRegistry() -> None
"""
@brief Resets the list of registered widgets to an empty state.
"""
def GetUserHeadQuarterId() -> str
"""
@brief Get the logged in user's head quarter Id
@return Logged in user's head quarter Id
"""
def GetUserHeadQuarterIdW() -> str
"""
@brief Get the logged in user's head quarter Id
@return Logged in user's head quarter Id
"""
def SetWindControllerSettings(_index : int, _op : WindControllerOptions) -> bool
"""
@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
"""
@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
"""
@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
"""
@brief Updates the zipper style name.
@param _zipperStyleIndex: The zipper style index.
@param _name: Name.
"""
def GetZipperStyleName(_zipperStyleIndex : int) -> str
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@brief Update the zipper style teeth width.
@param _zipperStyleIndex: The zipper style index.
@param _teethWidth: Teeth width (mm)
"""
def GetZipperStyleTeethWidth(_zipperStyleIndex : int) -> float
"""
@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
"""
@brief Update the zipper style weight.
@param _zipperStyleIndex: The zipper style index.
@param _weight: Weight (g)
"""
def GetZipperStyleWeight(_zipperStyleIndex : int) -> float
"""
@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
"""
@brief Update the zipper style tape thickness.
@param _zipperStyleIndex: The zipper style index.
@param _tapeThickness: Tape thickness (mm)
"""
def GetZipperStyleTapeThickness(_zipperStyleIndex : int) -> float
"""
@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
"""
@brief Set the maximum subdivision level for avatar smoothing.
@param _smoothlevel: The maximum subdivision level to set for avatar smoothing. (1-3)
"""
def GetAvatarSubdivisionLevel(_avatarIndex : int) -> int
"""
@brief Get the current subdivision level for avatar smoothing.
@return The current subdivision level for avatar smoothing. (1-3, 0 means no subdivision). If 0 to uncheck/unselect DivideMesh.
"""
def SetAvatarProperties(_avatarIndex : int, avatarPropertyMap : map[str, str]) -> None
"""
@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]
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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
"""
@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]
"""
@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
"""
@brief Sets the normal blending method for given index.
@param _index: The index of the normal blending method to set.
"""
def GetNormalBlendingMethod() -> int
"""
@brief Gets the current normal blending method.
@return The index of the current normal blending method.
"""
REST_API
def CallbackRestRequest(restRequest : CloApiRestRequest, callbackFunc : std::function[None (CloApiRestResponse)]) -> None
"""
@brief It makes an Http request with a CloApiRestRequest structure and then triggers a callbackFunc when the server responds
@param restRequest : It is the request with header, body, url and attachements
@param callbackFunc : When the server responds, a callback function is called with CloApiRestResponse.
"""
def CallbackRestMultiRequest(restRequests : list[CloApiRestRequest], callbackFunc : std::function[None (CloApiRestResponse)], callbackFinished : std::function[None()]) -> None
"""
@brief It uses the CloApiRestRequest structure to make multiple Http requests and then trigger each callbackFunc when each server responds. The callbackFinished is trrigered after all requests have been responded to.
@param restRequests : Request list with header, body, url and attachements
@param callbackFunc : When the server responds, a callback function is called with CloApiRestResponse.
@param callbackFinished : The callbackFinished function is called last after all requests have been responded to.
"""
def CallRESTPut(restReq : CloApiRestRequest, progressBarText : str) -> str
"""
@brief HTTP PUT Method
@param restRequests : Request list with header, body, url and attachements
@param progressBarText : text for the progress bar
@return string = HTTP Response header + "\r\n\r\n" + HTTP Response body
"""