API List

EXPORT_API

  • python
  • c++
def ExportZPac() -> str
"""
@brief Export ZPac file in the CLO temporary folder
@return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
 ExportZPac()
/// @brief Export ZPac file in the CLO temporary folder
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportZPac(const string& _filePath)
/// @brief Export ZPac file
/// @param string _filePath : target file path in ASCII
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportZPacW(const wstring& _filePath)
/// @brief Export ZPac file
/// @param wstring _filePath : target file path in UNICODE
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
def ExportZPrj() -> str
"""
@brief Export ZPrj file
@return Output file path; output files will be created in CLO temporary folder.
"""
 ExportZPrj()
/// @brief Export ZPrj file
/// @return Output file path; output files will be created in CLO temporary folder.
  • python
  • c++
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.
"""
 ExportZPrj(const string& _filePath)
/// @brief Export ZPrj file
/// @param _filePath: output file path
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
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.
"""
 ExportZPrj(const string& _filePath, bool _bCreateThumbnail)
/// @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.
  • python
  • c++
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.
"""
 ExportZPrjW(const wstring& _filePath, bool _bCreateThumbnail)
/// @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.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportOBJ()
/// @brief Export OBJ file
/// @param options If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportOBJ()
/// @brief Export OBJ file
/// @param _filePath: output file path
/// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportOBJ(const Marvelous::ImportExportOption& _options)
/// @brief Export OBJ file
/// @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportOBJ(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @brief Export OBJ file
/// @param _filePath: output file path
/// @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportOBJW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @brief Export OBJ file
/// @param _filePath: output file path
/// @param options: If "options" is given, it exports OBJ according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths. It outputs the file paths of an OBJ file and multiple MTL files for colorways. If the value "bSaveInZip" in ImportExportOption is true, it outputs a file path of a zipped file. If an error occurs, return empty wstring. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
def ExportGLTF(_filePath : str, _options : ImportExportOption, _bGLBinary : bool) -> list[str]
"""
@brief Export GLTF
@param options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths.
"""
 ExportGLTF(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @brief Export GLTF
/// @param options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths.
  • python
  • c++
def ExportGLTFW(_filePath : str, _options : ImportExportOption, _bGLBinary : bool) -> list[str]
"""
@brief Export GLTFW
@param options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths.
"""
 ExportGLTFW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @brief Export GLTFW
/// @param options: If "options" is given, it exports GLTF according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths.
  • python
  • c++
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.
"""
 ExportAlembic(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
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.
"""
 ExportAlembicW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
def ExportDXF() -> str
"""
@brief Export DXF file. This api call will display the dialog to set options
@return Output file path. If an error occurs, return empty string. Output files will be created in CLO temporary folder.
"""
 ExportDXF()
/// @brief Export DXF file. This api call will display the dialog to set options
/// @return Output file path. If an error occurs, return empty string. Output files will be created in CLO temporary folder.
  • python
  • c++
def ExportDXF(_filePath : str) -> str
"""
@brief Export DXF file. This api call will display the dialog to set options
@param _filePath: output file path to export dxf
@return Output file path. If an error occurs, return empty string.
"""
 ExportDXF(const string& _filePath)
/// @brief Export DXF file. This api call will display the dialog to set options
/// @param _filePath: output file path to export dxf
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportDXF(_filePath : str, _exportOption : ExportDxfOption) -> str
"""
@brief Export DXF file without the option dialog. Param ExportDxfOption is applicable for the options.
@param _filePath: output file path to export dxf
@param _exportOption: options to export dxf file
@return Output file path. If an error occurs, return empty string.
"""
 ExportDXF(const string& _filePath, const Marvelous::ExportDxfOption& _exportOption)
/// @brief Export DXF file without the option dialog. Param ExportDxfOption is applicable for the options.
/// @param _filePath: output file path to export dxf
/// @param _exportOption: options to export dxf file
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportDXFW(_filePath : str, _exportOption : ExportDxfOption) -> str
"""
@brief Export DXF file without the option dialog. Param ExportDxfOption is applicable for the options.
@param _filePath: output file path
@param _exportOption: options to export dxf file
@return Output file path. If an error occurs, return empty wstring.
"""
 ExportDXF(const string& _filePath, const Marvelous::ExportDxfOption& _exportOption)
/// @brief Export DXF file without the option dialog. Param ExportDxfOption is applicable for the options.
/// @param _filePath: output file path
/// @param _exportOption: options to export dxf file
/// @return Output file path. If an error occurs, return empty wstring.
  • python
  • c++
def ExportTechPack(_filePath : str, _exportOption : ExportTechpackOption) -> None
"""
@brief Export Tech Pack data in json file and associated image files.
@param _filePath: output filepath; the filePath Should be given in "*.json" format
@param _exportOption: options to export techpack(.json) file
"""
 ExportTechPack(const string& _filePath, const Marvelous::ExportTechpackOption& _exportOption)
/// @brief Export Tech Pack data in json file and associated image files.
/// @param _filePath: output filepath; the filePath Should be given in "*.json" format
/// @param _exportOption: options to export techpack(.json) file
  • python
  • c++
def ExportTechPackW(_filepath : str, _exportOption : ExportTechpackOption) -> None
"""
@brief Export Tech Pack data in json file and associated image files.
@param _filePath: output filepath; the filePath Should be given in "*.json" format
@param _exportOption: options to export techpack(.json) file
"""
 ExportTechPackW(const wstring& _filepath, const Marvelous::ExportTechpackOption& _exportOption)
/// @brief Export Tech Pack data in json file and associated image files.
/// @param _filePath: output filepath; the filePath Should be given in "*.json" format
/// @param _exportOption: options to export techpack(.json) file
  • python
  • c++
def ExportTechPackToStream(_outputImageFolderPath : str) -> str
"""
@brief Export Tech Pack data in string and associated image files.
@param _outputImageFolderPath: get output folder path where the image files are located by ExportTechpack
@return Output stream for JSON data with the output folder path at the first line. If an error occurs, return empty string.
"""
 ExportTechPackToStream(string& _outputImageFolderPath)
/// @brief Export Tech Pack data in string and associated image files.
/// @param _outputImageFolderPath: get output folder path where the image files are located by ExportTechpack
/// @return Output stream for JSON data with the output folder path at the first line. If an error occurs, return empty string.
  • python
  • c++
def ExportTechPackToStreamW(_outputImageFolderPath : str) -> str
"""
@brief Export Tech Pack data in string and associated image files.
@param _outputImageFolderPath: get output folder path where the image files are located by ExportTechpack
@return Output stream for JSON data with the output folder path at the first line. If an error occurs, return empty wstring.
"""
 ExportTechPackToStreamW(wstring& _outputImageFolderPath)
/// @brief Export Tech Pack data in string and associated image files.
/// @param _outputImageFolderPath: get output folder path where the image files are located by ExportTechpack
/// @return Output stream for JSON data with the output folder path at the first line. If an error occurs, return empty wstring.
  • python
  • c++
def ExportThumbnail3D() -> str
"""
@brief Export thumbnail of the current scene
@return Output file path: output files will be created in CLO temporary folder.
"""
 ExportThumbnail3D()
/// @brief Export thumbnail of the current scene
/// @return Output file path: output files will be created in CLO temporary folder.
  • python
  • c++
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.
"""
 ExportThumbnail3D(const string& _filePath)
/// @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.
  • python
  • c++
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.
"""
 ExportThumbnail3D(const string& _filePath)
/// @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.
  • python
  • c++
def ExportSnapshot3D(_filePath : str) -> list[ list [ str ] ]
"""
@brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ...
@param _filePath: output file path to save the screenshot
@return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
 ExportSnapshot3D(const string& _filePath)
/// @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ...
/// @param _filePath: output file path to save the screenshot
/// @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
def ExportSnapshot3D() -> list[ list [ str ] ]
"""
@brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ...
@return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
 ExportSnapshot3D()
/// @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ...
/// @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
def ExportSnapshot3DW(_filePath : str) -> list[ list [ str ] ]
"""
@brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ...
@param _filePath: output file path to save the screenshot
@return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
 ExportSnapshot3DW(const wstring& _filePath)
/// @brief Export snapshot images. This function displays the same dialog as CLO so that users can configure the snapshots. If user turns on the option "Save Separate Images", then series of images will be saved with the name followed by the postfix "_01", "_02", ...
/// @param _filePath: output file path to save the screenshot
/// @return Return the list of the path of output files per colorway. The first item of each array is the file path of the unified image. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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
"""
 ExportCustomViewSnapshot(const string& _targetFolderPath, unsigned int _width, unsigned int _height, string _outputPrefix = "")
/// @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
  • python
  • c++
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
"""
 ExportCustomViewSnapshotW(const wstring& _targetFolderPath, unsigned int _width, unsigned int _height, wstring _outputPrefix = L"")
/// @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
  • python
  • c++
def ExportRenderingImage(_filePath : str) -> list[ list [ str ] ]
"""
@brief Export Rendering Image.
@param _filePath: output file path
@return Return the list of the path of output files per colorway.
"""
 ExportRenderingImage(const string& _filePath)
/// @brief Export Rendering Image.
/// @param _filePath: output file path
/// @return Return the list of the path of output files per colorway.
  • python
  • c++
def ExportRenderingImage(_filePath : str, _bRenderAllColorways : bool) -> list[ list [ str ] ]
"""
@brief Export Rendering Image.
@param _filePath: output file path
@param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user.
@return Return the list of the path of output files per colorway.
"""
 ExportRenderingImage(const string& _filePath, bool _bRenderAllColorways)
/// @brief Export Rendering Image.
/// @param _filePath: output file path
/// @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user.
/// @return Return the list of the path of output files per colorway.
  • python
  • c++
def ExportRenderingImage(_bRenderAllColorways : bool) -> list[ list [ str ] ]
"""
@brief Export Rendering Image.
@param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user.
@return Return the list of the path of output files per colorway.
"""
 ExportRenderingImage(bool _bRenderAllColorways)
/// @brief Export Rendering Image.
/// @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user.
/// @return Return the list of the path of output files per colorway.
  • python
  • c++
def ExportRenderingImageW(_filePath : str, _bRenderAllColorways : bool) -> list[ list [ str ] ]
"""
@brief Export Rendering Image.
@param _filePath: output file path
@param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user.
@return Return the list of the path of output files per colorway.
"""
 ExportRenderingImageW(const wstring& _filePath, bool _bRenderAllColorways)
/// @brief Export Rendering Image.
/// @param _filePath: output file path
/// @param _bRenderAllColorways: If true, output the images for all colorways. Otherwise, it returns the images for the current colorway specified by CLO user.
/// @return Return the list of the path of output files per colorway.
  • python
  • c++
def ExportSingleColorwayRenderingImage(_filePath : str, _colorwayIndex : int) -> list [ str ]
"""
@brief Export Rendering Image for the colorway
@param _filePath: output file path
@param _colorwayIndex: colorway index to render the image
@return Return the list of the path of output files
"""
 ExportSingleColorwayRenderingImage(const string& _filePath, unsigned int _colorwayIndex)
/// @brief Export Rendering Image for the colorway
/// @param _filePath: output file path
/// @param _colorwayIndex: colorway index to render the image
/// @return Return the list of the path of output files
  • python
  • c++
def ExportSingleColorwayRenderingImage(_colorwayIndex : int) -> list [ str ]
"""
@brief Export Rendering Image for the colorway
@param _colorwayIndex: colorway index to render the image
@return Return the list of the path of output files; output files will be created in CLO temporary folder.
"""
 ExportSingleColorwayRenderingImage(unsigned int _colorwayIndex)
/// @brief Export Rendering Image for the colorway
/// @param _colorwayIndex: colorway index to render the image
/// @return Return the list of the path of output files; output files will be created in CLO temporary folder.
  • python
  • c++
def ExportSingleColorwayRenderingImageW(_filePath : str, _colorwayIndex : int) -> list [ str ]
"""
@brief Export Rendering Image for the colorway
@param _filePath: output file path
@param _colorwayIndex: colorway index to render the image
@return Return the list of the path of output files
"""
 ExportSingleColorwayRenderingImageW(const wstring& _filePath, unsigned int _colorwayIndex)
/// @brief Export Rendering Image for the colorway
/// @param _filePath: output file path
/// @param _colorwayIndex: colorway index to render the image
/// @return Return the list of the path of output files
  • python
  • c++
def GetTotalRenderImagePaths() -> list [ str ]
"""
@brief Get File name list for all the exported rendering images
@return all the rendered image file paths
"""
 GetTotalRenderImagePaths()
/// @brief Get File name list for all the exported rendering images
/// @return all the rendered image file paths
  • python
  • c++
def GetTotalRenderImagePathsW() -> list [ str ]
"""
@brief Get File name list for all the exported rendering images
@return all the rendered image file paths
"""
 GetTotalRenderImagePathsW()
/// @brief Get File name list for all the exported rendering images
/// @return all the rendered image file paths
  • python
  • c++
def GetCurrentRenderImagePaths() -> list [ str ]
"""
@brief Current Render Image paths
@return all current renderded image files paths per colorways
"""
 GetCurrentRenderImagePaths()
/// @brief Current Render Image paths
/// @return all current renderded image files paths per colorways
  • python
  • c++
def GetCurrentRenderImagePathsW() -> list [ str ]
"""
@brief Current Render Image paths
@return all current renderded image files paths per colorways
"""
 GetCurrentRenderImagePathsW()
/// @brief Current Render Image paths
/// @return all current renderded image files paths per colorways
  • python
  • c++
def GetFileNameOnRenderingProperty() -> str
"""
@return the output file names set on the Rendering Property in CLO
"""
 GetFileNameOnRenderingProperty()
/// @return the output file names set on the Rendering Property in CLO
  • python
  • c++
def GetFileNameOnRenderingPropertyW() -> str
"""
@return the output file names set on the Rendering Property in CLO
"""
 GetFileNameOnRenderingPropertyW()
/// @return the output file names set on the Rendering Property in CLO
  • python
  • c++
def ExportGarmentInformation() -> str
"""
@brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO)
/@return Output file path. If an error occurs, return empty string; output files will be created in CLO temporary folder.
"""
 ExportGarmentInformation()
/// @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO)
//// @return Output file path. If an error occurs, return empty string; output files will be created in CLO temporary folder.
  • python
  • c++
def ExportGarmentInformation(_filePath : str) -> str
"""
@brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO)
@param _filePath output file path to export the garment information
/@return Output file path. If an error occurs, return empty string.
"""
 ExportGarmentInformation(const string& _filePath)
/// @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO)
/// @param _filePath output file path to export the garment information
//// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportGarmentInformationW(_filePath : str) -> str
"""
@brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO)
@param _filePath output file path to export the garment information
/@return Output file path. If an error occurs, return empty string.
"""
 ExportGarmentInformationW(const wstring& _filePath)
/// @brief Export garment information in json file. The information is the same as given in Garment Information Dialog in CLO (you can see this dialog by clicking File > Information > Garment menu in CLO)
/// @param _filePath output file path to export the garment information
//// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportGarmentInformationToStream() -> str
"""
@brief Export garment information in string
@return Garment Information stream in sstring
"""
 ExportGarmentInformationToStream()
/// @brief Export garment information in string
/// @return Garment Information stream in sstring
  • python
  • c++
def ExportGarmentInformationToStreamW() -> str
"""
@brief Export garment information in string as well as json file
@return Garment Information stream in wstring
"""
 ExportGarmentInformationToStreamW()
/// @brief Export garment information in string as well as json file
/// @return Garment Information stream in wstring
  • python
  • c++
def ExportGarmentInformationConfigData() -> str
"""
@brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference
@return Output file path; the output files will be created in CLO temporary folder. If an error occurs, return empty string.
"""
 ExportGarmentInformationConfigData()
/// @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference
/// @return Output file path; the output files will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
def ExportGarmentInformationConfigData(_filePath : str) -> str
"""
@brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference
@param _filePath output file path to export the garment information configuration data
@return Output file path. If an error occurs, return empty string.
"""
 ExportGarmentInformationConfigData(const string& _filePath)
/// @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference
/// @param _filePath output file path to export the garment information configuration data
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportGarmentInformationConfigDataW(_filePath : str) -> str
"""
@brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference
@param _filePath output file path to export the garment information configuration data
@return Output file path. If an error occurs, return empty string.
"""
 ExportGarmentInformationConfigDataW(const wstring& _filePath)
/// @brief Export garment information config data in json file. The information is the same as given in "Conf_Garment_Information.json" file via Preference
/// @param _filePath output file path to export the garment information configuration data
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportGarmentInformationConfigDataToStream() -> str
"""
Export garment information configuration data in string
@return Output stream for JSON data. If an error occurs, return empty string.
"""
 ExportGarmentInformationConfigDataToStream()
Export garment information configuration data in string
/// @return Output stream for JSON data. If an error occurs, return empty string.
  • python
  • c++
def ExportGarmentInformationConfigDataToStreamW() -> str
"""
Export garment information configuration data in string
@return Output stream for JSON data. If an error occurs, return empty string.
"""
 ExportGarmentInformationConfigDataToStreamW()
Export garment information configuration data in string
/// @return Output stream for JSON data. If an error occurs, return empty string.
  • python
  • c++
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 CLO temporary folder. If an error occurs, return empty string.
"""
 ExportTurntableVideo()
/// @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer.
/// @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
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 CLO temporary folder. If an error occurs, return empty string.
"""
 ExportTurntableVideo(const string& _filePath)
/// @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer.
/// @param _filePath
/// @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
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 CLO temporary folder. If an error occurs, return empty string.
"""
 ExportTurntableVideoW(const wstring& _filePath)
/// @brief Export turntable video. This function requires XVid Mpeg-4 codec installed on user's computer.
/// @return Output file path; output files will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportAnimationVideo()
/// @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer.
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportAnimationVideo()
/// @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer.
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportAnimationVideo()
/// @brief Export animation video. This function requires XVid Mpeg-4 codec installed on user's computer.
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
def GetColorwayCount() -> int
"""
///////////////////////////////////////////////////////////////////
@fn GetColorwayCount()
@brief Get the number of colorways in the current garment loaded in CLO
@return total count of colorways
"""
///////////////////////////////////////////////////////////////////
/// @fn GetColorwayCount()
/// @brief Get the number of colorways in the current garment loaded in CLO
/// @return total count of colorways
  • python
  • c++
def GetCurrentColorwayIndex() -> int
"""
@brief Get the index of the current colorway in CLO
@return the current colorway index
"""
 GetCurrentColorwayIndex()
/// @brief Get the index of the current colorway in CLO
/// @return the current colorway index
  • python
  • c++
def GetColorwayNameList() -> list[str]
"""
@brief Get all the colorway names for the current garment
@return the list of name of all colorways
"""
 GetColorwayNameList()
/// @brief Get all the colorway names for the current garment
/// @return the list of name of all colorways
  • python
  • c++
def GetColorwayNameListW() -> list[str]
"""
@brief Get all the colorway names for the current garment
@return the list of name of all colorways
"""
 GetColorwayNameListW()
/// @brief Get all the colorway names for the current garment
/// @return the list of name of all colorways
  • python
  • c++
def GetAvatarCount() -> int
"""
@brief Get the number of avatars loaded in CLO
@return total count of avatars
"""
 GetAvatarCount()
/// @brief Get the number of avatars loaded in CLO
/// @return total count of avatars
  • python
  • c++
def GetAvatarNameList() -> list[str]
"""
@brief Get all the names of avatars loaded in CLO
@return the list of name of all avatars
"""
 GetAvatarNameList()
/// @brief Get all the names of avatars loaded in CLO
/// @return the list of name of all avatars
  • python
  • c++
def GetAvatarNameListW() -> list[str]
"""
@brief Get all the names of avatars loaded in CLO
@return the list of name of all avatars
"""
 GetAvatarNameListW()
/// @brief Get all the names of avatars loaded in CLO
/// @return the list of name of all avatars
  • python
  • c++
def GetAvatarGenderList() -> list[int]
"""
@brief Get all the genders of avatars loaded in CLO repectively
@return the list of gender of all avatars. 0 : male, 1 : female, -1: unknown
"""
 GetAvatarGenderList()
/// @brief Get all the genders of avatars loaded in CLO repectively
/// @return the list of gender of all avatars. 0 : male, 1 : female, -1: unknown
  • python
  • c++
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 CLO temporary folder. If an error occurs, return empty string.
"""
 ExportTurntableImages(int _numberOfImages)
/// @brief Export turntable images for current colorway.
/// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
/// @return Output file path list; output files will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
def ExportTurntableImages(_filePath : str, _numberOfImages : int, _width : int, _height : 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
@return Output file path list. If an error occurs, return empty string.
"""
 ExportTurntableImages(const string& _filePath, int _numberOfImages, int _width = 2500, int _height = 2500)
/// @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
/// @return Output file path list. If an error occurs, return empty string.
  • python
  • c++
def ExportTurntableImagesW(_filePath : str, _numberOfImages : int, _width : int, _height : 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
@return Output file path list. If an error occurs, return empty string.
"""
 ExportTurntableImagesW(const wstring& _filePath, int _numberOfImages, int _width = 2500, int _height = 2500)
/// @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
/// @return Output file path list. If an error occurs, return empty string.
  • python
  • c++
def ExportGLB(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@brief Export GLB
@param options: If "options" is given, it exports GLB according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths.
"""
 ExportGLB(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @brief Export GLB
/// @param options: If "options" is given, it exports GLB according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths.
  • python
  • c++
def ExportGLBW(_filePath : str, _options : ImportExportOption) -> list[str]
"""
@brief Export GLBW
@param options: If "options" is given, it exports GLB according to options, not allowing user for selecting options in Export Dialog.
@return Output file paths.
"""
 ExportGLBW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @brief Export GLBW
/// @param options: If "options" is given, it exports GLB according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths.
  • python
  • c++
def ExportGLTFAsFabric() -> list[str]
"""
@brief Export gltf/glb which cotains the fabric data selected in the object browser
@return Output file path;output files will be created in CLO temporary folder. If an error occurs, return empty string.
"""
 ExportGLTFAsFabric()
/// @brief Export gltf/glb which cotains the fabric data selected in the object browser
/// @return Output file path;output files will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
def ExportGLTFAsFabric(_filePath : str) -> list[str]
"""
@brief Export gltf/glb 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.
"""
 ExportGLTFAsFabric(const string& _filePath)
/// @brief Export gltf/glb 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.
  • python
  • c++
def ExportGLTFAsFabric(_filePath : str, index : int) -> list[str]
"""
@brief Export gltf/glb 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.
"""
 ExportGLTFAsFabric(const string& _filePath, int index)
/// @brief Export gltf/glb 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.
  • python
  • c++
def ExportGLTFAsFabricW(_filePath : str, index : int) -> list[str]
"""
@brief Export gltf/glb 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.
"""
 ExportGLTFAsFabricW(const wstring& _filePath, int index)
/// @brief Export gltf/glb 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.
  • python
  • c++
def ExportPOM() -> str
"""
@brief Export POM
@return Output file path;output file will be created in CLO temporary folder. If an error occurs, return empty string.
"""
 ExportPOM(()
/// @brief Export POM
/// @return Output file path;output file will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
def ExportPOM(_filePath : str) -> str
"""
@brief Export POM
@param _filePath: output file path
@return Output file path. If an error occurs, return empty string.
"""
 ExportPOM(const string& _filePath)
/// @brief Export POM
/// @param _filePath: output file path
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportPOMW(_filePath : str) -> str
"""
@brief Export POM
@param _filePath: output file path
@return Output file path. If an error occurs, return empty string.
"""
 ExportPOM(const wstring& _filePath)
/// @brief Export POM
/// @param _filePath: output file path
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportPOM(_bInclude3DLength : bool) -> str
"""
@brief Export POM
@param _bInclude3DLength, true: include 3D info, false: exclude 3D info
@return Output file path;output file will be created in CLO temporary folder. If an error occurs, return empty string.
"""
 ExportPOM(()
/// @brief Export POM
/// @param _bInclude3DLength, true: include 3D info, false: exclude 3D info
/// @return Output file path;output file will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
def ExportPOM(_bInclude3DLength : bool, _filePath : str) -> str
"""
@brief Export POM
@param _filePath: output file path, _bInclude3DLength, true: include 3D info, false: exclude 3D info
@return Output file path. If an error occurs, return empty string.
"""
 ExportPOM(const string& _filePath)
/// @brief Export POM
/// @param _filePath: output file path, _bInclude3DLength, true: include 3D info, false: exclude 3D info
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportPOMW(_bInclude3DLength : bool, _filePath : str) -> str
"""
@brief Export POM
@param _filePath: output file path, _bInclude3DLength, true: include 3D info, false: exclude 3D info
@return Output file path. If an error occurs, return empty string.
"""
 ExportPOM(const wstring& _filePath)
/// @brief Export POM
/// @param _filePath: output file path, _bInclude3DLength, true: include 3D info, false: exclude 3D info
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportGLTFWithDialog(_filePath : str, _bGLBinary : bool) -> list[str]
"""
@brief Export GLTF with Dialog
@param _filePath: output file path
@return Output file paths.
"""
 ExportGLTFWithDialog(const string& _filePath)
/// @brief Export GLTF with Dialog
/// @param _filePath: output file path
/// @return Output file paths.
  • python
  • c++
def ExportGLBWithDialog(_filePath : str) -> list[str]
"""
@brief Export GLB with Dialog
@param _filePath: output file path
@return Output file paths.
"""
 ExportGLBWithDialog(const string& _filePath)
/// @brief Export GLB with Dialog
/// @param _filePath: output file path
/// @return Output file paths.
  • python
  • c++
def ExportThumbnail3DByColorwayIndex(_colorwayIndex : int) -> str
"""
@brief Export thumbnail of the current scene
@param _colorwayIndex: colorway index to render the image
@return Output file path: output files will be created in CLO temporary folder.
"""
 ExportThumbnail3DByColorwayIndex(unsigned int _colorwayIndex)
/// @brief Export thumbnail of the current scene
/// @param _colorwayIndex: colorway index to render the image
/// @return Output file path: output files will be created in CLO temporary folder.
  • python
  • c++
def ExportThumbnail3DByColorwayIndex(_filePath : str, _colorwayIndex : int) -> str
"""
@brief Export thumbnail of the current scene in the 3D Windows
@param _filePath: output file path to save the screenshot
@param _colorwayIndex: colorway index to render the image
@return Output file path. If an error occurs, return empty string.
"""
 ExportThumbnail3DByColorwayIndex(const string& _filePath, unsigned int _colorwayIndex)
/// @brief Export thumbnail of the current scene in the 3D Windows
/// @param _filePath: output file path to save the screenshot
/// @param _colorwayIndex: colorway index to render the image
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportThumbnail3DWByColorwayIndexW(_filePath : str, _colorwayIndex : int) -> str
"""
@brief Export thumbnail of the current scene in the 3D Windows
@param _filePath: output file path to save the screenshot
@param _colorwayIndex: colorway index to render the image
@return Output file path. If an error occurs, return empty wstring.
"""
 ExportThumbnail3DByColorwayIndexW(const wstring& _filePath, unsigned int _colorwayIndex)
/// @brief Export thumbnail of the current scene in the 3D Windows
/// @param _filePath: output file path to save the screenshot
/// @param _colorwayIndex: colorway index to render the image
/// @return Output file path. If an error occurs, return empty wstring.
  • python
  • c++
def ExportTurntableImagesByColorwayIndex(_numberOfImages : int, _colorwayIndex : int) -> list[str]
"""
@brief Export turntable images for colorway.
@param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
@param _colorwayIndex: colorway index to render the image
@return Output file path list; output files will be created in CLO temporary folder. If an error occurs, return empty string.
"""
 ExportTurntableImagesByColorwayIndex(int _numberOfImages, unsigned int _colorwayIndex)
/// @brief Export turntable images for colorway.
/// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
/// @param _colorwayIndex: colorway index to render the image
/// @return Output file path list; output files will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
def ExportTurntableImagesByColorwayIndex(_filePath : str, _numberOfImages : int, _colorwayIndex : int, _width : int, _height : int) -> list[str]
"""
@brief Export turntable images for colorway.
@param _filePath: the output file path to export the turntable snapshots
@param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
@param _colorwayIndex: colorway index to render the image
@param _width: image width for the snapshots
@param _height: image height for the snapshots
@return Output file path list. If an error occurs, return empty string.
"""
 ExportTurntableImagesByColorwayIndex(const string& _filePath, int _numberOfImages, unsigned int _colorwayIndex, int _width = 2500, int _height = 2500)
/// @brief Export turntable images for colorway.
/// @param _filePath: the output file path to export the turntable snapshots
/// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
/// @param _colorwayIndex: colorway index to render the image
/// @param _width: image width for the snapshots
/// @param _height: image height for the snapshots
/// @return Output file path list. If an error occurs, return empty string.
  • python
  • c++
def ExportTurntableImagesByColorwayIndexW(_filePath : str, _numberOfImages : int, _colorwayIndex : int, _width : int, _height : int) -> list[str]
"""
@brief Export turntable images for colorway.
@param _filePath: the output file path to export the turntable snapshots
@param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
@param _colorwayIndex: colorway index to render the image
@param _width: image width for the snapshots
@param _height: image height for the snapshots
@return Output file path list. If an error occurs, return empty string.
"""
 ExportTurntableImagesByColorwayIndexW(const wstring& _filePath, int _numberOfImages, unsigned int _colorwayIndex, int _width = 2500, int _height = 2500)
/// @brief Export turntable images for colorway.
/// @param _filePath: the output file path to export the turntable snapshots
/// @param _numberOfImages: the number of images in 360 turn table. The turn table will turn by (360 / _numberOfImages) per an image each by each.
/// @param _colorwayIndex: colorway index to render the image
/// @param _width: image width for the snapshots
/// @param _height: image height for the snapshots
/// @return Output file path list. If an error occurs, return empty string.
  • python
  • c++
def ExportPose() -> str
"""
@brief Export ZPac file in the CLO temporary folder
@return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
"""
 ExportPose()
/// @brief Export ZPac file in the CLO temporary folder
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportPose(const string& _filePath)
/// @brief Export ZPac file
/// @param string _filePath : target file path in ASCII
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportPoseW(const wstring& _filePath)
/// @brief Export ZPac file
/// @param wstring _filePath : target file path in UNICODE
/// @return Output file path. If an error occurs, return empty string. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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 CLO temporary folder.
"""
 ExportFBX(const Marvelous::ImportExportOption& _options)
/// @brief Export FBX file
/// @param options: It exports FBX according to options, not allowing user for selecting options in Export Dialog.
/// @return Output file paths. If filePath parameter is not given, output files will be created in CLO temporary folder.
  • python
  • c++
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.
"""
 ExportFBX(const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
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.
"""
 ExportFBX(const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
def ExportAVT(_filePath : str) -> str
"""
@brief Export AVT
@param _filePath: output file path
@return Output file path. If an error occurs, return empty string.
"""
 ExportAVT(const string& _filePath)
/// @brief Export AVT
/// @param _filePath: output file path
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportAVTW(_filePath : str) -> str
"""
@brief Export AVT
@param _filePath: output file path
@return Output file path. If an error occurs, return empty string.
"""
 ExportAVTW(const wstring& _filePath)
/// @brief Export AVT
/// @param _filePath: output file path
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def ExportTrim(_filePath : str, _trimStyleIndex : int) -> str
"""
@brief Export trim file
@param _filePath: the output file path to export trim
@param _trimStyleIndex: trimstyle index to export trim style
@return Output file path list. If an error occurs, return empty string.
"""
 ExportTrim(const std::string& _filePath, unsigned int _trimStyleIndex)
/// @brief Export trim file
/// @param _filePath: the output file path to export trim
/// @param _trimStyleIndex: trimstyle index to export trim style
/// @return Output file path list. If an error occurs, return empty string.
  • python
  • c++
def ExportStdViewImage(_viewIndex : int, _outputFolderPath : str, _colorwayIndex : int, _width : int, _height : int) -> str
"""
@brief ExportStdViewImage : Exports The Image based on the given Standard image view index for selected colorway.
@param :
@return Output file path along with the selected colorway name. If an error occurs, return error message string.
"""
 ExportStdViewImage(int _viewIndex, const std::string& _outputFolderPath, int _colorwayIndex, int _width, int _height)
/// @brief ExportStdViewImage : Exports The Image based on the given Standard image view index for selected colorway.
/// @param :
/// @return Output file path along with the selected colorway name. If an error occurs, return error message string.
  • python
  • c++
def ExportStdViewImageForAllColorways(_viewIndex : int, _outputFolderPath : str, _width : int, _height : int) -> str
"""
@brief ExportStdViewImageForAllColorways : Exports The Image based on the given Standard image view index for all Colorways.
@param :
@return Output file paths along with the colorway names. If an error occurs, return error message string.
"""
 ExportStdViewImageForAllColorways(int _viewIndex, const std::string& _outputFolderPath, int _width, int _height)
/// @brief ExportStdViewImageForAllColorways : Exports The Image based on the given Standard image view index for all Colorways.
/// @param :
/// @return Output file paths along with the colorway names. If an error occurs, return error message string.
  • python
  • c++
def ExportCustomViewImage(_zcmrFileUrl : str, _outputFolderPath : str, _colorwayIndex : int, _width : int, _height : int) -> str
"""
@brief ExportCustomViewImage : Exports The Custom image based on the given custom angles in ZCMR file for selected Colorway.
@param :
@return Output file path along with the selected colorway name. If an error occurs, return error message string.
"""
 ExportCustomViewImage((const std::string& _zcmrFileUrl, const std::string& _outputFolderPath, int _colorwayIndex, int _width, int _height)
/// @brief ExportCustomViewImage : Exports The Custom image based on the given custom angles in ZCMR file for selected Colorway.
/// @param :
/// @return Output file path along with the selected colorway name. If an error occurs, return error message string.
  • python
  • c++
def ExportCustomViewImageForAllColorways(_zcmrFileUrl : str, _outputFolderPath : str, _width : int, _height : int) -> str
"""
@brief ExportCustomViewImageForAllColorways : Exports The Custom image based on the given custom angles in ZCMR file for all Colorways.
@param :
@return Output file path along with the colorway names. If an error occurs, return error message string.
"""
 ExportCustomViewImageForAllColorways((const std::string& _zcmrFileUrl, const std::string& _outputFolderPath, int _width, int _height)
/// @brief ExportCustomViewImageForAllColorways : Exports The Custom image based on the given custom angles in ZCMR file for all Colorways.
/// @param :
/// @return Output file path along with the colorway names. If an error occurs, return error message string.
  • python
  • c++
def ExportMultiViewImages(_mvsFilePath : str, _outputFilePath : str, _colorwayIndex : int, _width : int, _height : int) -> str
"""
@brief ExportMultiViewImages : Exports The Multi View Images based on the given MVS File for selected Colorway.
@param :
@return Output file path along with the selected colorway name. If an error occurs, return error message string.
"""
 ExportMultiViewImages(const std::string& _mvsFilePath, const std::string& _outputFilePath, int _colorwayIndex, int _width, int _height)
/// @brief ExportMultiViewImages : Exports The Multi View Images based on the given MVS File for selected Colorway.
/// @param :
/// @return Output file path along with the selected colorway name. If an error occurs, return error message string.
  • python
  • c++
def ExportMultiViewImagesForAllColorways(_mvsFilePath : str, _outputFilePath : str, _width : int, _height : int) -> str
"""
@brief ExportMultiViewImagesForAllColorways : Exports The Multi View Images based on the given MVS File for all Colorways.
@param :
@return Output file path along with the colorway names. If an error occurs, return error message string.
"""
 ExportMultiViewImagesForAllColorways(const std::string& _mvsFilePath, const std::string& _outputFilePath, int _width, int _height)
/// @brief ExportMultiViewImagesForAllColorways : Exports The Multi View Images based on the given MVS File for all Colorways.
/// @param :
/// @return Output file path along with the colorway names. If an error occurs, return error message string.
  • python
  • c++
def ConvertZblcToZmod(_zblcFilePathList : list[str], _saveDirPath : str, _categoryName : str, _styleName : str) -> list[str]
"""
@brief Convert .zblc file to .zmod file
@param _zblcFilePathList: The path of the ZBLC files you want to convert
@param _saveDirPath: Where to save the converted file
@param _categoryName : Category name
@param _styleName : Style name
@return Returns the path list of failed files. Returns an empty list if all files are successful.
"""
 ConvertZblcToZmod(const std::vector<std::wstring>& _zblcFilePathList, const std::wstring& _saveDirPath, const std::wstring& _categoryName, const std::wstring& _styleName)
/// @brief Convert .zblc file to .zmod file
/// @param _zblcFilePathList: The path of the ZBLC files you want to convert
/// @param _saveDirPath: Where to save the converted file
/// @param _categoryName : Category name
/// @param _styleName : Style name
/// @return Returns the path list of failed files. Returns an empty list if all files are successful.
  • python
  • c++
def ExportMVSData(_mvsFilePath : str) -> str
"""
@brief ExportMVSData : Exports The MVS File data without creating any Images.
@param :
@return MVS file data and with custom angles. If an error occurs, return error message string.
"""
 ExportMVSData(const std::string& _mvsFilePath)
/// @brief ExportMVSData : Exports The MVS File data without creating any Images.
/// @param :
/// @return MVS file data and with custom angles. If an error occurs, return error message string.

IMPORT_API

  • python
  • c++
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.
"""
 ImportFile(const string& filePath)
/// @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.
  • python
  • c++
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.
"""
 ImportFileW(const wstring& filePath)
/// @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.
  • python
  • c++
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.
"""
 ImportZprj(const string& filePath, const Marvelous::ImportZPRJOption& loadOption)
/// @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.
  • python
  • c++
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.
"""
 ImportZprjW(const wstring& filePath, const Marvelous::ImportZPRJOption& loadOption)
/// @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.
  • python
  • c++
def ImportGarmentInformation(filePath : str) -> bool
"""
@brief Load Garment Information (json)
@param filePath: the input file to load the garment information (.json)
@return if it succeeds, return true.
"""
 ImportGarmentInformation(const string& filePath)
/// @brief Load Garment Information (json)
/// @param filePath: the input file to load the garment information (.json)
/// @return if it succeeds, return true.
  • python
  • c++
def ImportGarmentInformationW(filePath : str) -> bool
"""
@brief Load Garment Information (json)
@param filePath: the input file to load the garment information (.json)
@return if it succeeds, return true.
"""
 ImportGarmentInformationW(const wstring& filePath)
/// @brief Load Garment Information (json)
/// @param filePath: the input file to load the garment information (.json)
/// @return if it succeeds, return true.
  • python
  • c++
def ImportGarmentInformationConfigData(filePath : str) -> bool
"""
@brief Load Garment Information Configuration (json)
@param filePath: the input file to load the garment information configuration data(.json)
@return if it succeeds, return true.
"""
 ImportGarmentInformationConfigData(const string& filePath)
/// @brief Load Garment Information Configuration (json)
/// @param filePath: the input file to load the garment information configuration data(.json)
/// @return if it succeeds, return true.
  • python
  • c++
def ImportGarmentInformationConfigDataW(filePath : str) -> bool
"""
@brief Load Garment Information Configuration (json)
@param filePath: the input file to load the garment information configuration data(.json)
@return if it succeeds, return true.
"""
 ImportGarmentInformationConfigDataW(const wstring& filePath)
/// @brief Load Garment Information Configuration (json)
/// @param filePath: the input file to load the garment information configuration data(.json)
/// @return if it succeeds, return true.
  • python
  • c++
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.
"""
 ImportOBJ(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
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.
"""
 ImportOBJW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
def ImportVMP(_filePath : str) -> bool
"""
@brief Import VMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportVMP(const string& _filePath)
/// @brief Import VMP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportVMPW(_filePath : str) -> bool
"""
@brief Import VMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportVMP(const wstring& _filePath)
/// @brief Import VMP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportCPT(_filePath : str) -> bool
"""
@brief Import CPT file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportCPT(const string& _filePath)
/// @brief Import CPT file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportCPTW(_filePath : str) -> bool
"""
@brief Import CPT file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportCPT(const wstring& _filePath)
/// @brief Import CPT file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportVLP(_filePath : str) -> bool
"""
@brief Import VLP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportVLP(const string& _filePath)
/// @brief Import VLP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportVLPW(_filePath : str) -> bool
"""
@brief Import VLP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportVLP(const wstring& _filePath)
/// @brief Import VLP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportVRP(_filePath : str) -> bool
"""
@brief Import VRP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportVRP(const string& _filePath)
/// @brief Import VRP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportVRPW(_filePath : str) -> bool
"""
@brief Import VRP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportVRP(const wstring& _filePath)
/// @brief Import VRP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportDXF(_filePath : str, loadOption : ImportDxfOption) -> bool
"""
@brief Import DXF file
@param _filePath: input file path
@param loadOption: the options to load the file
@return if it succeeds, return true.
"""
 ImportDXF(const string& _filePath, const Marvelous::ImportDxfOption& loadOption)
/// @brief Import DXF file
/// @param _filePath: input file path
/// @param loadOption: the options to load the file
/// @return if it succeeds, return true.
  • python
  • c++
def ImportDXFW(_filePath : str, loadOption : ImportDxfOption) -> bool
"""
@brief Import DXF file
@param _filePath: input file path
@param loadOption: the options to load the file
@return if it succeeds, return true.
"""
 ImportDXF(const wstring& _filePath, const Marvelous::ImportDxfOption& loadOption)
/// @brief Import DXF file
/// @param _filePath: input file path
/// @param loadOption: the options to load the file
/// @return if it succeeds, return true.
  • python
  • c++
def ImportGraphicStyleFromImage(_filePath : str) -> bool
"""
@brief Import DXF file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportImageAsGraphicStyle(const string& _filePath)
/// @brief Import DXF file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportGraphicStyleFromImage(_filePath : str) -> bool
"""
@brief Import image file as graphic style
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportImageAsGraphicStyle(const wstring& _filePath)
/// @brief Import image file as graphic style
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportAVAC(_filePath : str, _apfFilePath : str) -> bool
"""
@brief Import avac avatar file
@param _filePath: input avatar file path
@param _apfFilePath: input apf File path
@return if it succeeds, return true.
"""
 ImportAvatar(const wstring& _filePath, const Marvelous::ImportExportOption& _importOption)
/// @brief Import avac avatar file
/// @param _filePath: input avatar file path
/// @param _apfFilePath: input apf File path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportAVAC(_filePath : str, _apfFilePath : str) -> bool
"""
"""

  • python
  • c++
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.
"""
 ImportFile(const string& filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
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.
"""
 ImportFileW(const wstring& filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
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.
"""
 ImportFBX(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
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.
"""
 ImportFBXW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
def ImportGLTF(_filePath : str, _options : ImportExportOption) -> bool
"""
@brief Import GLTF file
@param _filePath: input file path
@param options: If "options" is given, it imports GLTF according to options, not allowing user for selecting options in Import Dialog.
@return if it succeeds, return true.
"""
 ImportGLTF(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @brief Import GLTF file
/// @param _filePath: input file path
/// @param options: If "options" is given, it imports GLTF according to options, not allowing user for selecting options in Import Dialog.
/// @return if it succeeds, return true.
  • python
  • c++
def ImportGLTFW(_filePath : str, _options : ImportExportOption) -> bool
"""
@brief Import GLTF file
@param _filePath: input file path
@param options: If "options" is given, it imports GLTF according to options, not allowing user for selecting options in Import Dialog.
@return if it succeeds, return true.
"""
 ImportGLTFW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @brief Import GLTF file
/// @param _filePath: input file path
/// @param options: If "options" is given, it imports GLTF according to options, not allowing user for selecting options in Import Dialog.
/// @return if it succeeds, return true.
  • python
  • c++
def ImportSMP(_filePath : str) -> bool
"""
@brief Import SMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportSMP(const string& _filePath)
/// @brief Import SMP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportSMPW(_filePath : str) -> bool
"""
@brief Import SMP file
@param _filePath: input file path
@return if it succeeds, return true.
"""
 ImportSMPW(const wstring& _filePath)
/// @brief Import SMP file
/// @param _filePath: input file path
/// @return if it succeeds, return true.
  • python
  • c++
def ImportAsGraphic(_filePath : str) -> None
"""
@brief Import an image file as Graphic.
@param _filePath: input file path
"""
 ImportAsGraphic(const std::string& _filePath)
/// @brief Import an image file as Graphic.
/// @param _filePath: input file path
  • python
  • c++
def ImportAsGraphicW(_filePath : str) -> None
"""
@brief Import an image file as Graphic.
@param _filePath: input file path
"""
 ImportAsGraphicW(const std::wstring& _filePath)
/// @brief Import an image file as Graphic.
/// @param _filePath: input file path
  • python
  • c++
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
"""
 ImportTrim(const std::string& _filePath)
/// @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

UTILITY_API

  • python
  • c++
def GetCLOTemporaryFolderPath() -> str
"""
@brief Create and get the temporary folder path
@return Get the temporary folder path to store temporary files used when exporting to server
"""
 GetCLOTemporaryFolderPath()
/// @brief Create and get the temporary folder path
/// @return Get the temporary folder path to store temporary files used when exporting to server
  • python
  • c++
def GetCLOTemporaryFolderPathW() -> str
"""
@brief Create and get the temporary folder path
@return Get the temporary folder path to store temporary files used when exporting to server
"""
 GetCLOTemporaryFolderPathW()
/// @brief Create and get the temporary folder path
/// @return Get the temporary folder path to store temporary files used when exporting to server
  • python
  • c++
def DisplayMessageBox(str : str) -> None
"""
@brief Show a message with using the DialogBox implemented in CLO software
@param str: message
@return Display a message box to show input string on CLO. This can be used for debugging.
"""
 DisplayMessageBox(string str)
/// @brief Show a message with using the DialogBox implemented in CLO software
/// @param str: message
/// @return Display a message box to show input string on CLO. This can be used for debugging.
  • python
  • c++
def DisplayMessageBoxW(str : str) -> None
"""
@brief Show a message with using the DialogBox implemented in CLO software
@param str: message
@return Display a message box to show input string on CLO. This can be used for debugging.
"""
 DisplayMessageBoxW(wstring str)
/// @brief Show a message with using the DialogBox implemented in CLO software
/// @param str: message
/// @return Display a message box to show input string on CLO. This can be used for debugging.
  • python
  • c++
def GetProjectName() -> str
"""
@brief Get the current project name in CLO
@return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test"
"""
 GetProjectName()
/// @brief Get the current project name in CLO
/// @return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test"
  • python
  • c++
def GetProjectNameW() -> str
"""
@brief Get the current project name in CLO
@return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test"
"""
 GetProjectNameW()
/// @brief Get the current project name in CLO
/// @return The current project name. When you opening "test.zprj" file at last, then the project name is given as "test"
  • python
  • c++
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".
"""
 GetProjectFilePath()
/// @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".
  • python
  • c++
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".
"""
 GetProjectFilePathW()
/// @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".
  • python
  • c++
def GetMajorVersion() -> int
"""
@brief Get the major version of the CLO software
@return Major version of SW. ex) 5 of 5.0.72
"""
 GetMajorVersion()
/// @brief Get the major version of the CLO software
/// @return Major version of SW. ex) 5 of 5.0.72
  • python
  • c++
def GetMinorVersion() -> int
"""
@brief Get the minor version of the CLO software
@return Minor version of SW. ex) 0 of 5.0.72
"""
 GetMinorVersion()
/// @brief Get the minor version of the CLO software
/// @return Minor version of SW. ex) 0 of 5.0.72
  • python
  • c++
def GetPatchVersion() -> int
"""
@brief Get the patch version of the CLO software
@return Patch version of SW. ex) 72 of 5.0.72
"""
 GetPatchVersion()
/// @brief Get the patch version of the CLO software
/// @return Patch version of SW. ex) 72 of 5.0.72
  • python
  • c++
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
"""
 toUtf8(const std::wstring &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
  • python
  • c++
def GetColorwayCount() -> int
"""
@brief Get the number of colorways in the current project
@return The number of Colorways in the current project.
"""
 GetColorwayCount()
/// @brief Get the number of colorways in the current project
/// @return The number of Colorways in the current project.
  • python
  • c++
def GetCurrentColorwayIndex() -> int
"""
@brief Get the current colorway index
@return The current colorway index.
"""
 GetCurrentColorwayIndex()
/// @brief Get the current colorway index
/// @return The current colorway index.
  • python
  • c++
def SetCurrentColorwayIndex(index : int) -> None
"""
@brief Change the current colorway
@param index: the colorway index
"""
 SetCurrentColorwayIndex(unsigned int index)
/// @brief Change the current colorway
/// @param index: the colorway index
  • python
  • c++
def SetColorwayName(index : int, str : str) -> None
"""
@brief Change colorway name
@param index: the target colorway index to change the name
@param str: new name for the colorway
"""
 SetColorwayName(unsigned int index, const string& str)
/// @brief Change colorway name
/// @param index: the target colorway index to change the name
/// @param str: new name for the colorway
  • python
  • c++
def SetColorwayNameW(index : int, wstr : str) -> None
"""
@brief Change colorway name
@param index: the target colorway index to change the name
@param str: new name for the colorway
"""
 SetColorwayNameW(unsigned int index, const wstring& wstr)
/// @brief Change colorway name
/// @param index: the target colorway index to change the name
/// @param str: new name for the colorway
  • python
  • c++
def GetColorwayName(index : int) -> str
"""
@brief Get the colorway name for the colorway index
@param index: colorway index to get the name
@return the colorway name for the colorway index
"""
 GetColorwayName(unsigned int index)
/// @brief Get the colorway name for the colorway index
/// @param index: colorway index to get the name
/// @return the colorway name for the colorway index
  • python
  • c++
def GetColorwayNameW(index : int) -> str
"""
@brief Get the colorway name for the colorway index
@param index: colorway index to get the name
@return the colorway name for the colorway index
"""
 GetColorwayNameW(unsigned int index)
/// @brief Get the colorway name for the colorway index
/// @param index: colorway index to get the name
/// @return the colorway name for the colorway index
  • python
  • c++
def CopyColorway(index : int) -> int
"""
@brief Copy the colorway in the index and create a new one
@param index: the source colorway index to copy
@return index for the created colorway
"""
 CopyColorway(unsigned int index)
/// @brief Copy the colorway in the index and create a new one
/// @param index: the source colorway index to copy
/// @return index for the created colorway
  • python
  • c++
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.
"""
 GetCustomViewInformation()
/// @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.
  • python
  • c++
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.
"""
 GetCustomViewInformationW()
/// @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.
  • python
  • c++
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
"""
 GetClothPositions(vector<float>& positions)
/// @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
  • python
  • c++
def ResetClothArrangement() -> None
"""
@brief Restore the shape of cloth to when the cloth was loaded
"""
 ResetClothArrangement()
/// @brief Restore the shape of cloth to when the cloth was loaded
  • python
  • c++
def GetThumbnailInCLOFile(filePath : str, thumbnailIndex : int, fileSize : int) -> char*
"""
@brief Get Preview thumbnail file buffer(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on)
@param filePath: the source file path to retrieve the thumbnail buffer
@param thumbnailIndex: the index of the thumbnails in the CLO file format(the number of thumbnails differs by the format)
@param fileSize: get the size of the thumbnail buffer
@return thumbnail(png) buffer
"""
 GetThumbnailInCLOFile(std::string filePath, unsigned int thumbnailIndex, unsigned int& fileSize)
/// @brief Get Preview thumbnail file buffer(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on)
/// @param filePath: the source file path to retrieve the thumbnail buffer
/// @param thumbnailIndex: the index of the thumbnails in the CLO file format(the number of thumbnails differs by the format)
/// @param fileSize: get the size of the thumbnail buffer
/// @return thumbnail(png) buffer
  • python
  • c++
def GetAssetIconInCLOFile(filePath : str, fileSize : int) -> char*
"""
@brief Get Asset Icon thumbnail file buffer(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on)
@param filePath: the source file path to retrieve the thumbnail buffer
@param fileSize: get the size of the thumbnail buffer
@return thumbnail(png) buffer
"""
 GetAssetIconInCLOFile(std::string filePath, unsigned int& fileSize)
/// @brief Get Asset Icon thumbnail file buffer(png type) from the CLO file format(.zprj, .zpac, .zfab, .sst, and so on)
/// @param filePath: the source file path to retrieve the thumbnail buffer
/// @param fileSize: get the size of the thumbnail buffer
/// @return thumbnail(png) buffer
  • python
  • c++
def GetMetaDataForCurrentGarment() -> str
"""
@brief Get Meta data for the current Garment
@return the meta data for the current garment
"""
 GetMetaDataForCurrentGarment()
/// @brief Get Meta data for the current Garment
/// @return the meta data for the current garment
  • python
  • c++
def GetMetaDataForCurrentGarmentW() -> str
"""
@brief Get Meta data for the current Garment
@return the meta data for the current garment
"""
 GetMetaDataForCurrentGarmentW()
/// @brief Get Meta data for the current Garment
/// @return the meta data for the current garment
  • python
  • c++
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
"""
 SetMetaDataForCurrentGarment(const string& metaDataStr)
/// @brief Overwrite Meta data for the current Garment
/// @param metaDataStr: the new meata data to set to the current garment
  • python
  • c++
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
"""
 ChangeMetaDataValueForCurrentGarment(const string& metaDataKey, const string& metaDataValue)
/// @brief Change Meta Data Value for the current Garment
/// @metaDataKey: target Key
/// @metaDataValue: the new value for the key
  • python
  • c++
def CreateProgressBar() -> None
"""
@brief Create Progress Bar to show progress. This function should be called before using SetProgress function
"""
 CreateProgressBar()
/// @brief Create Progress Bar to show progress. This function should be called before using SetProgress function
  • python
  • c++
def SetProgress(title : str, progress : int) -> None
"""
@brief Set progress on the Progress Bar
"""
 SetProgress(const string& title, int progress)
/// @brief Set progress on the Progress Bar
  • python
  • c++
def SetProgressW(title : str, progress : int) -> None
"""
@brief Set progress on the Progress Bar
"""
 SetProgress(const string& title, int progress)
/// @brief Set progress on the Progress Bar
  • python
  • c++
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
"""
 DeleteProgressBar(bool bForce)
/// @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
  • python
  • c++
def stringToMD5(str : str) -> str
"""
@brief Create MD5 hashing string from string
@param str: the source string to hash
@return MD5 hashed string
"""
 stringToMD5(const string& str)
/// @brief Create MD5 hashing string from string
/// @param str: the source string to hash
/// @return MD5 hashed string
  • python
  • c++
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 CLO
"""
 AddColorSwatch(const map<string, string>& plmIDtoNameList, const map<string, Marvelous::CloApiRgb>& plmIDtoColorList, const map<string, string>& plmIDtoApiMetaDataList, const string& swatchName)
/// @brief Add Color Swatch
/// @param plmIDtoNameList: the list for map of PLM ID to Color Name
/// @param plmIDtoColorList: list for map of PLM ID to color name
/// @param plmIDtoApiMetaDataList: list for map of PLM ID to Api Meta Data
/// @param swatchName: swatchName which will be shown in the color palette and the swatch file name to save
/// @return added swatch file name(.aco) inside the asset folder for the current version of CLO
  • python
  • c++
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 CLO
"""
 AddColorSwatchW(const map<wstring, wstring>& plmIDtoNameList, const map<wstring, Marvelous::CloApiRgb>& plmIDtoColorList, const map<wstring, wstring>& plmIDtoApiMetaDataList, const wstring& swatchName)
/// @brief Add Color Swatch
/// @param plmIDtoNameList: the list for map of PLM ID to Color Name
/// @param plmIDtoColorList: list for map of PLM ID to color name
/// @param plmIDtoApiMetaDataList: list for map of PLM ID to Api Meta Data
/// @param swatchName: swatchName which will be shown in the color palette and the swatch file name to save
/// @return added swatch file name(.aco) inside the asset folder for the current version of CLO
  • python
  • c++
def LoadLibraryColorSwatchList(library : list[str]) -> None
"""
@brief
@param library: the list with multiple color swatch file paths
"""
 LoadLibraryColorSwatchList(const std::vector<std::string>& library)
/// @brief
/// @param library: the list with multiple color swatch file paths
  • python
  • c++
def NewProject() -> None
"""
@brief Clear the current garment and begin a new garment
"""
 NewProject()
/// @brief Clear the current garment and begin a new garment
  • python
  • c++
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.)
- IsCLOFileFormatWithThumbnailExtension / IsCLOFileFormatWithThumbnailExtensionW
: Check if the CLO file format has the thumbnail memory.

- IsCLOFileFormatWithTripleThumbnailExtension / IsCLOFileFormatWithTripleThumbnailExtensionW
: Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
@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
"""
- IsReadableImageFormatFromExtension / IsReadableImageFormatFromExtensionW
: Check if the file stream loaded from the filepath used in Library Windows Implementations can be displayed on Library Windows for item thumbnail and/or preview dialog.
(The files should not contain image data over 8bits per channel for 1 ~ 4 channels image.)
- IsCLOFileFormatWithThumbnailExtension / IsCLOFileFormatWithThumbnailExtensionW
: Check if the CLO file format has the thumbnail memory.

- IsCLOFileFormatWithTripleThumbnailExtension / IsCLOFileFormatWithTripleThumbnailExtensionW
: Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
/// @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
  • python
  • c++
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
"""
 IsReadableImageFormatW(const wstring& 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
  • python
  • c++
def IsCLOFileFormatWithThumbnail(filePath : str) -> bool
"""
@brief Check if the CLO file format has the thumbnail memory.
@return true if the file is the CLO format file and contains the thumbnail memory which can be displayed on Library Windows for item thumbnail and/or preview dialog
"""
 IsCLOFileFormatWithThumbnail(const string& filePath)
/// @brief Check if the CLO file format has the thumbnail memory.
/// @return true if the file is the CLO format file and contains the thumbnail memory which can be displayed on Library Windows for item thumbnail and/or preview dialog
  • python
  • c++
def IsCLOFileFormatWithThumbnailW(filePath : str) -> bool
"""
@brief Check if the CLO file format has the thumbnail memory.
@return true if the file is the CLO format file and contains the thumbnail memory which can be displayed on Library Windows for item thumbnail and/or preview dialog
"""
 IsCLOFileFormatWithThumbnailW(const wstring& filePath)
/// @brief Check if the CLO file format has the thumbnail memory.
/// @return true if the file is the CLO format file and contains the thumbnail memory which can be displayed on Library Windows for item thumbnail and/or preview dialog
  • python
  • c++
def IsCLOFileFormatWithTripleThumbnail(filePath : str) -> bool
"""
@brief Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
@return true if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
"""
 IsCLOFileFormatWithTripleThumbnail(const string& filePath)
/// @brief Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
/// @return true if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
  • python
  • c++
def IsCLOFileFormatWithTripleThumbnailW(filePath : str) -> bool
"""
@brief Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
@return true if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
"""
 IsCLOFileFormatWithTripleThumbnailW(const wstring& filePath)
/// @brief Check if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
/// @return true if the CLO file format has the three images memory for preview thumbnail for the Library Preview Dialog.
  • python
  • c++
def GetCLOExecutableFolderPath(bLinuxTypePathDelimeter : bool) -> str
"""
@brief Get the executable folder path where the current version of CLO is located
@param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\'
@return Get the executable folder path for the current version of CLO software
"""
 GetCLOExecutableFolderPath(bool bLinuxTypePathDelimeter = true)
/// @brief Get the executable folder path where the current version of CLO is located
/// @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\'
/// @return Get the executable folder path for the current version of CLO software
  • python
  • c++
def GetCLOExecutableFolderPathW(bLinuxTypePathDelimeter : bool) -> str
"""
@brief Get the executable folder path where the current version of CLO is located
@param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\'
@return Get the executable folder path for the current version of CLO software
"""
 GetCLOExecutableFolderPathW(bool bLinuxTypePathDelimeter = true)
/// @brief Get the executable folder path where the current version of CLO is located
/// @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\'
/// @return Get the executable folder path for the current version of CLO software
  • python
  • c++
def GetCLOAssetFolderPath(bLinuxTypePathDelimeter : bool) -> str
"""
@brief Get the folder path where the CLO asset files are distributed
@param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\'
@return Get the asset folder path where the CLO asset files are located in
"""
 GetCLOAssetFolderPath(bool bLinuxTypePathDelimeter = true)
/// @brief Get the folder path where the CLO asset files are distributed
/// @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\'
/// @return Get the asset folder path where the CLO asset files are located in
  • python
  • c++
def GetCLOAssetFolderPathW(bLinuxTypePathDelimeter : bool) -> str
"""
@brief Get the folder path where the CLO asset files are distributed
@param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\'
@return Get the asset folder path where the CLO asset files are located in
"""
 GetCLOAssetFolderPathW(bool bLinuxTypePathDelimeter = true)
/// @brief Get the folder path where the CLO asset files are distributed
/// @param bLinuxTypePathDelimeter: if true, set path delimiter to '/', false: set path delimiter to '\'
/// @return Get the asset folder path where the CLO asset files are located in
  • python
  • c++
def GetAPIMetaData(filePath : str) -> str
"""
@brief Get API meta data for the file
@param filePath: CLO file path
@return json string for meta data [key - value] list
"""
 GetAPIMetaData(const string& filePath)
/// @brief Get API meta data for the file
/// @param filePath: CLO file path
/// @return json string for meta data [key - value] list
  • python
  • c++
def GetAPIMetaDataW(filePath : str) -> str
"""
@brief Get API meta data for the file
@param filePath: CLO file path
@return json string for meta data [key - value] list
"""
 GetAPIMetaDataW(const wstring& filePath)
/// @brief Get API meta data for the file
/// @param filePath: CLO file path
/// @return json string for meta data [key - value] list
  • python
  • c++
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
"""
 SetAPIMetaData(const string& filePath, string jsonStr)
/// @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
  • python
  • c++
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
"""
 SetAPIMetaDataW(const wstring& filePath, wstring jsonStr)
/// @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
  • python
  • c++
def Set3DWindowTitle(title : str) -> bool
"""
@brief Set 3D Window Title
@param title: desired text in 3D window
@return if it succeeds, return true
"""
 Set3DWindowTitle(const string& title)
/// @brief Set 3D Window Title
/// @param title: desired text in 3D window
/// @return if it succeeds, return true
  • python
  • c++
def Set3DWindowTitleW(title : str) -> bool
"""
@brief Set 3D Window Title
@param title: desired text in 3D window
@return if it succeeds, return true
"""
 Set3DWindowTitleW(const wstring& title)
/// @brief Set 3D Window Title
/// @param title: desired text in 3D window
/// @return if it succeeds, return true
  • python
  • c++
def GetColorListForColorWay(_colorWayIndex : int) -> list[CloApiRgba]
"""
@brief Get Color List for ColorWay
@param _colorwayIndex: the colorway index to get the result
@return the color list in CloAgiRgba for the target ColorWay
"""
 GetColorListForColorWay(unsigned int _colorWayIndex)
/// @brief Get Color List for ColorWay
/// @param _colorwayIndex: the colorway index to get the result
/// @return the color list in CloAgiRgba for the target ColorWay
  • python
  • c++
def SetShowHideAvatar(_bShow : bool) -> None
"""
@brief Set all avatars' show/hide status
@param _bShow: true for show, false for hide
"""
 SetShowHideAvatar(bool _bShow)
/// @brief Set all avatars' show/hide status
/// @param _bShow: true for show, false for hide
  • python
  • c++
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
"""
 SetShowHideAvatar(bool _bShow, int _avatarIndex)
/// @brief Set show/hide status of avatar that matches the index
/// @param _bShow: true for show, false for hide
  • python
  • c++
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.
"""
 IsShowAvatar(int _avatarIndex)
/// @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.
  • python
  • c++
def SetSchematicRender(_bSet : bool) -> None
"""
@brief Set Schematic Render status
@param _bSet: true for enable, false for disable
"""
 SetSchematicRender(bool _bSet)
/// @brief Set Schematic Render status
/// @param _bSet: true for enable, false for disable
  • python
  • c++
def UpdateColorways(bUpdateSnapshot : bool) -> None
"""
@brief Update Colorways in the CLO software
@param bUpdateSnapshot: put the value to true to update the colorway's snapshot
"""
 UpdateColorways(bool bUpdateSnapshot = true)
/// @brief Update Colorways in the CLO software
/// @param bUpdateSnapshot: put the value to true to update the colorway's snapshot
  • python
  • c++
def DeleteColorwayItem(_index : int) -> None
"""
@brief Delete the colorway in the index
@param index: the source colorway index to delete
"""
 DeleteColorwayItem(unsigned int _index)
/// @brief Delete the colorway in the index
/// @param index: the source colorway index to delete
  • python
  • c++
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.
"""
 ReplaceGraphicTextureFromImage(int graphicstyleIndex, const string& _imagePath)
/// @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.
  • python
  • c++
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.
"""
 ReplaceGraphicTextureFromImage((int graphicstyleIndex, const wstring& _imagePath)
/// @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.
  • python
  • c++
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.
"""
 Simulate(unsigned int _steps)
/// @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.
  • python
  • c++
def SetSimulationQuality(_quality : 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))
"""
 SetSimulationQuality(int _quality)
/// @brief Set simulation quality preset
/// @param _quality: input simulation preset (0: Normal(Default), 1: Animation(Stable), 2: Fitting(Accurate Fabric), 3: FAST(GPU))
  • python
  • c++
def SetSimulationTimeStep(_timeStep : float) -> None
"""
@brief Set simulation time step
@param _timeStep: time step in second (Default : 0.03333, Min value: 0.001)
"""
 SetSimulationTimeStep(int _timeStep)
/// @brief Set simulation time step
/// @param _timeStep: time step in second (Default : 0.03333, Min value: 0.001)
  • python
  • c++
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)
"""
 SetSimulationNumberOfSimulation(int _numberOfSimulation)
/// @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)
  • python
  • c++
def SetSimulationCGFinishCondition(_cgFinishCondition : int) -> None
"""
@brief Set simulation finish condition
@param _cgFinishCondition : Conjugate Gradient finish condition (0: iteration, 1: residual)
"""
 SetSimulationCGFinishCondition(int _cgFinishCondition)
/// @brief Set simulation finish condition
/// @param _cgFinishCondition : Conjugate Gradient finish condition (0: iteration, 1: residual)
  • python
  • c++
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)
"""
 SetSimulationCGIterationCount(int _cgIterationCount)
/// @brief Set Conjugate Gradient iteration count per one step.
/// @param _cgIterationCount : iteration count (Default : 50, Min/Max Range 1~1000)
  • python
  • c++
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)
"""
 SetSimulationCGResidual(int _cgResidual)
/// @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)
  • python
  • c++
def SetSimulationSelfCollisionIterationCount(_selfCollisionIterationCount : int) -> None
"""
@brief Set self collision iteration count
@param _selfCollisionIterationCount : self collision iteration count (Default: 1)
"""
 SetSimulationSelfCollisionIterationCount(int _selfCollisionIterationCount)
/// @brief Set self collision iteration count
/// @param _selfCollisionIterationCount : self collision iteration count (Default: 1)
  • python
  • c++
def SetSimulationAirDamping(_airDamping : float) -> None
"""
@brief Set air damping value
@param _airDamping : air damping(Default: 1.0)
"""
 SetSimulationAirDamping(int _airDamping)
/// @brief Set air damping value
/// @param _airDamping : air damping(Default: 1.0)
  • python
  • c++
def SetSimulationGravity(_gravity : float) -> None
"""
@brief Set gravity value in y-axis
@param _gravity : gravity  (Default: -9800.0 mm/s^2)
"""
 SetSimulationGravity(int _gravity)
/// @brief Set gravity value in y-axis
/// @param _gravity : gravity  (Default: -9800.0 mm/s^2)
  • python
  • c++
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)
"""
 SetSimulationNumberOfCPUInUse(int _numberOfSimulationInUse)
/// @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)
  • python
  • c++
def SetSimulationNonlinearSimulation(_bNonlinearSimulation : bool) -> None
"""
@brief Set nonlinear simulation
@param _bNonlinearSimulation : true for enable, false for disable
"""
 SetSimulationNonlinearSimulation(int _bNonlinearSimulation)
/// @brief Set nonlinear simulation
/// @param _bNonlinearSimulation : true for enable, false for disable
  • python
  • c++
def SetSimulationGroundCollision(_bGroundCollision : bool) -> None
"""
@brief Set ground collision
@param _bGroundCollision : true for enable, false for disable
"""
 SetSimulationGroundCollision(int _bGroundCollision)
/// @brief Set ground collision
/// @param _bGroundCollision : true for enable, false for disable
  • python
  • c++
def SetSimulationGroundHeight(_groundHeight : float) -> None
"""
@brief Set ground height value
@param _groundHeight : ground height in y-axis (Default: 0.0)
"""
 SetSimulationGroundHeight(int _groundHeight)
/// @brief Set ground height value
/// @param _groundHeight : ground height in y-axis (Default: 0.0)
  • python
  • c++
def SetSimulationSelfCollisionAvoidanceStiffness(_avoidanceStiffness : float) -> None
"""
@brief Set stiffness of the inserted spring to avoid self collision
@param _avoidanceStiffness : (Default: 0.001)
"""
 SetSimulationSelfCollisionAvoidanceStiffness(int _avoidanceStiffness)
/// @brief Set stiffness of the inserted spring to avoid self collision
/// @param _avoidanceStiffness : (Default: 0.001)
  • python
  • c++
def SetSimulationLayerBasedCollisionDetection(_bUseLayer : bool) -> None
"""
@brief Set layer based collision detection
@param _bUseLayer : true for enable, false for disable
"""
 SetSimulationLayerBasedCollisionDetection(int _bUseLayer)
/// @brief Set layer based collision detection
/// @param _bUseLayer : true for enable, false for disable
  • python
  • c++
def StartNesting() -> None
"""
@brief Start Nesting Simulation
"""
 StartNesting()
/// @brief Start Nesting Simulation
  • python
  • c++
def GetNestingBufferSpacing() -> float
"""
@brief Get Nesting Buffer Space
"""
 GetNestingBufferSpacing()
/// @brief Get Nesting Buffer Space
  • python
  • c++
def SetNestingBufferSpacing(_mm : float) -> None
"""
@brief Set Nesting Buffer Space
@param _mm : Buffer Space
"""
 SetNestingBufferSpacing(float _mm)
/// @brief Set Nesting Buffer Space
/// @param _mm : Buffer Space
  • python
  • c++
def SetNestingTargetColorway(_colorwayList : list[int]) -> None
"""
@brief Colorway index to apply nesting result
@param _colorwayList : Colorway index to apply nesting result
"""
 SetNestingTargetColorway(std::vector<int> _colorwayList)
/// @brief Colorway index to apply nesting result
/// @param _colorwayList : Colorway index to apply nesting result
  • python
  • c++
def GetNestingTargetColorway() -> list[int]
"""
@brief Gets the colorway index to apply nesting to.
"""
 GetNestingTargetColorway()
/// @brief Gets the colorway index to apply nesting to.
  • python
  • c++
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.
"""
 SetAvatarBodyTexture(const wstring& _bodyShapeName, int _matShapeIndex, const wstring& _textureImagePath)
/// @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.
  • python
  • c++
def SetAnimationRecording(_bStart : bool) -> None
"""
@brief set animation recording
@param _bStart: true for recording start, false for recording stop
"""
 SetAnimationRecording(bool _bStart)
/// @brief set animation recording
/// @param _bStart: true for recording start, false for recording stop
  • python
  • c++
def SetCurrentAnimationFrame(_frame : double) -> None
"""
@brief set current animation frame
@param _frame: Value for setting current frame
"""
 SetCurrentAnimationFrame(double _frame)
/// @brief set current animation frame
/// @param _frame: Value for setting current frame
  • python
  • c++
def GetCurrentAnimationFrame() -> double
"""
@brief get current animation frame
"""
 GetCurrentAnimationFrame()
/// @brief get current animation frame
  • python
  • c++
def SetStartAnimationFrame(_frame : double) -> None
"""
@brief set start animation frame
@param _frame: Value for setting start frame
"""
 SetStartAnimationFrame(double _frame)
/// @brief set start animation frame
/// @param _frame: Value for setting start frame
  • python
  • c++
def GetStartAnimationFrame() -> double
"""
@brief get start animation frame
"""
 GetStartAnimationFrame()
/// @brief get start animation frame
  • python
  • c++
def SetEndAnimationFrame(_frame : double) -> None
"""
@brief set end animation frame
@param _frame: Value for setting end frame
"""
 SetEndAnimationFrame(double _frame)
/// @brief set end animation frame
/// @param _frame: Value for setting end frame
  • python
  • c++
def GetEndAnimationFrame() -> double
"""
@brief get end animation frame
"""
 GetEndAnimationFrame()
/// @brief get end animation frame
  • python
  • c++
def GetStressMapStatus() -> bool
"""
@brief return current rendered status of the stress map (false = Off | true = On)
"""
 GetStressMapStatus()
/// @brief return current rendered status of the stress map (false = Off | true = On)
  • python
  • c++
def SetStressMapStatus(_bOn : bool) -> None
"""
@brief set the rendered status of stress map
@param _bOn: false = Off | true = On
"""
 SetStressMapStatus(bool _bOn)
/// @brief set the rendered status of stress map
/// @param _bOn: false = Off | true = On
  • python
  • c++
def GetStrainMapStatus() -> bool
"""
@brief return current rendered status of the strain map (false = Off | true = On)
"""
 GetStrainMapStatus()
/// @brief return current rendered status of the strain map (false = Off | true = On)
  • python
  • c++
def SetStrainMapStatus(_bOn : bool) -> None
"""
@brief set the rendered status of strain map
@param _bOn: false = Off | true = On
"""
 SetStrainMapStatus(bool _bOn)
/// @brief set the rendered status of strain map
/// @param _bOn: false = Off | true = On
  • python
  • c++
def GetSchematicRender() -> bool
"""
@brief Get Show Schematic Render Status
"""
 GetSchematicRender(bool _bSet)
/// @brief Get Show Schematic Render Status
  • python
  • c++
def RefreshPlugIns() -> None
"""
@brief Refresh all PlugIns
"""
 RefreshPlugIns()
/// @brief Refresh all PlugIns
  • python
  • c++
def SetCamViewPoint(_viewPointIndex : int) -> None
"""
@brief set camera view point
@param _viewPointIndex: Value for setting camera view point index
"""
 SetCamViewPoint(int _viewPointIndex)
/// @brief set camera view point
/// @param _viewPointIndex: Value for setting camera view point index
  • python
  • c++
def StopNesting() -> None
"""
@brief Stop Nesting process
"""
 StopNesting()
/// @brief Stop Nesting process
  • python
  • c++
def CreateModularCategory(_title : str, _folderPath : str) -> None
"""
@brief create modular category
@param _title : category title, _folderPath: folder
"""
 CreateModularCategory(const std::wstring& _title, const std::wstring& _folderPath)
/// @brief create modular category
/// @param _title : category title, _folderPath: folder
  • python
  • c++
def DeleteModularCategory(_title : str) -> None
"""
@brief delete modular category
@param _title : category title
"""
 DeleteModularCategory(const std::wstring& _title, const std::wstring& _folderPath)
/// @brief delete modular category
/// @param _title : category title
  • python
  • c++
def GetNestingTime() -> int
"""
@brief Get Nesting duration Time (milliseconds)
"""
 GetNestingTime()
/// @brief Get Nesting duration Time (milliseconds)
  • python
  • c++
def SetSchematicSilhouetteLineWidth(_value : int) -> None
"""
@brief set schematic silhouette line width
@param _value: Value for setting schematic silhouette line width
"""
 SetSchematicSilhouetteLineWidth(int _value)
/// @brief set schematic silhouette line width
/// @param _value: Value for setting schematic silhouette line width
  • python
  • c++
def SetSchematicSeamLineWidth(_value : int) -> None
"""
@brief set schematic seamline width
@param _value: Value for setting schematic seamline width
"""
 SetSchematicSeamLineWidth(int _value)
/// @brief set schematic seamline width
/// @param _value: Value for setting schematic seamline width
  • python
  • c++
def SetSchematicInternalLineWidth(_value : int) -> None
"""
@brief set schematic internal line width
@param _value: Value for setting chematic internal line width
"""
 SetSchematicInternalLineWidth(int _value)
/// @brief set schematic internal line width
/// @param _value: Value for setting chematic internal line width
  • python
  • c++
def SetSchematicTopstitchLineScalePercent(_value : int) -> None
"""
@brief set schematic topstitch line scale percent
@param _value: Value for setting schematic topstitch line scale percent
"""
 SetSchematicTopstitchLineScalePercent(int _value)
/// @brief set schematic topstitch line scale percent
/// @param _value: Value for setting schematic topstitch line scale percent
  • python
  • c++
def SetSchematicBrightness(_value : int) -> None
"""
@brief set schematic brightness
@param _value: Value for setting schematic brightness
"""
 SetSchematicBrightness(int _value)
/// @brief set schematic brightness
/// @param _value: Value for setting schematic brightness
  • python
  • c++
def SetShowSchematicSilhouetteLine(_bOn : bool) -> None
"""
@brief set show schematic silhouetteline
@param _bOn: Value for setting showschematic silhouetteline
"""
 SetShowSchematicSilhouetteLine(bool _bOn)
/// @brief set show schematic silhouetteline
/// @param _bOn: Value for setting showschematic silhouetteline
  • python
  • c++
def SetShowSchematicSeamLine(_bOn : bool) -> None
"""
@brief set show schematic seamline
@param _bOn: Value for setting show schematic seamline
"""
 SetShowSchematicSeamLine(int _bOn)
/// @brief set show schematic seamline
/// @param _bOn: Value for setting show schematic seamline
  • python
  • c++
def SetShowSchematicInternalLine(_bOn : bool) -> None
"""
@brief set show schematic internal line
@param _bOn: Value for setting show schematic internalline
"""
 SetShowSchematicInternalLine(bool _bOn)
/// @brief set show schematic internal line
/// @param _bOn: Value for setting show schematic internalline
  • python
  • c++
def SetShowSchematicTopstitchLine(_bOn : bool) -> None
"""
@brief set show schematic topstitch line
@param _bOn: Value for setting show schematic topstitchline
"""
 SetShowSchematicTopstitchLine(bool _bOn)
/// @brief set show schematic topstitch line
/// @param _bOn: Value for setting show schematic topstitchline
  • python
  • c++
def SetSchematicClothRenderType(_bTexture : bool) -> None
"""
@brief set schematic cloth render type
@param _bTexture: Value for setting schematic cloth render type
"""
 SetSchematicClothRenderType(bool _bTexture)
/// @brief set schematic cloth render type
/// @param _bTexture: Value for setting schematic cloth render type
  • python
  • c++
def SetStyleLineColor(_r : int, _g : int, _b : int) -> None
"""
@brief set style line color
@param int _r, int _g, int _b: Value for setting style line color
Red: 0 ~ 255
Green: 0 ~ 255
Blue: 0 ~ 255
"""
 SetStyleLineColor(int _r, int _g, int _b)
/// @brief set style line color
/// @param int _r, int _g, int _b: Value for setting style line color
Red: 0 ~ 255
Green: 0 ~ 255
Blue: 0 ~ 255
  • python
  • c++
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
"""
 SetSchematicClothColor(int _r, int _g, int _b)
/// @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
  • python
  • c++
def SetQualityRender(_bSet : bool) -> None
"""
@brief Set Quality Render status
@param _bSet: true for enable, false for disable
"""
 SetQualityRender(bool _bSet)
/// @brief Set Quality Render status
/// @param _bSet: true for enable, false for disable
  • python
  • c++
def GetQualityRenderStatus() -> bool
"""
@brief Get Current Quality Render Status
"""
 GetQualityRenderStatus(bool _bSet)
/// @brief Get Current Quality Render Status
  • python
  • c++
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.
"""
 BakeUVTexture(const string& _filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
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.
"""
 BakeUVTextureW(const wstring& _filePath, const Marvelous::ImportExportOption& _options)
/// @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.
  • python
  • c++
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.
"""
 UVPacking(bool _bAll, float _textureFillSeam, int _imgSize)
/// @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.
  • python
  • c++
def ResetUVTo2DArrangement() -> None
"""
@brief Reset UV islands to the 2D arrangement.
"""
 ResetUVTo2DArrangement()
/// @brief Reset UV islands to the 2D arrangement.
  • python
  • c++
def SetTrimWeight(_trimStyleIndex : int, _mass : float) -> None
"""
@brief Change weight of the trim style
@param _trimStyleIndex: trimstyle index to change weight of trim style
@param _mass: value to set weight of trim
"""
 SetTrimWeight(unsigned int _trimStyleIndex, float _mass)
/// @brief Change weight of the trim style
/// @param _trimStyleIndex: trimstyle index to change weight of trim style
/// @param _mass: value to set weight of trim
  • python
  • c++
def Refresh3DWindow() -> None
"""
@brief Refresh 3D Garment Window
"""
 Refresh3DWindow()
/// @brief Refresh 3D Garment Window
  • python
  • c++
def SetColorwayColorItem(_colorwayIndex : int, _colorItemIndex : int, _plmId : str, _colorName : str, _rgb : CloApiRgb) -> None
"""
@brief Changes the color of the color item in colorway
@param _colorwayIndex: colorway index to change color of color item
@param _colorItemIndex: color item index to change color of colorway
@param _plmId: plm id of color
@param _colorName: name of color
@param _rgb: rgb value of color
"""
 SetColorwayColorItem(int _colorwayIndex, int _colorItemIndex, std::string _plmId, std::string _colorName, Marvelous::CloApiRgb _rgb)
/// @brief Changes the color of the color item in colorway
/// @param _colorwayIndex: colorway index to change color of color item
/// @param _colorItemIndex: color item index to change color of colorway
/// @param _plmId: plm id of color
/// @param _colorName: name of color
/// @param _rgb: rgb value of color
  • python
  • c++
def GetColorwayColorItemRGB(_colorwayIndex : int, _colorItemIndex : int) -> CloApiRgb
"""
@brief Get rgb color value of the color item in colorway
@param _colorwayIndex: colorway index to get rgb color value of color item
@param _colorItemIndex: color item index to get rgb color value color of colorway
@return a rgb color value if the indices are valid, (0, 0, 0) otherwise.
"""
 GetColorwayColorItemRGB(int _colorwayIndex, int _colorItemIndex)
/// @brief Get rgb color value of the color item in colorway
/// @param _colorwayIndex: colorway index to get rgb color value of color item
/// @param _colorItemIndex: color item index to get rgb color value color of colorway
/// @return a rgb color value if the indices are valid, (0, 0, 0) otherwise.
  • python
  • c++
def GetColorwayColorItemPlmId(_colorwayIndex : int, _colorItemIndex : int) -> str
"""
@brief Get plm id of the color item in colorway
@param _colorwayIndex: colorway index to get plm id of color item
@param _colorItemIndex: color item index to get plm id of colorway
@return a plm id if the indices are valid, empty string otherwise.
"""
 GetColorwayColorItemPlmId(int _colorwayIndex, int _colorItemIndex)
/// @brief Get plm id of the color item in colorway
/// @param _colorwayIndex: colorway index to get plm id of color item
/// @param _colorItemIndex: color item index to get plm id of colorway
/// @return a plm id if the indices are valid, empty string otherwise.
  • python
  • c++
def GetColorwayColorItemName(_colorwayIndex : int, _colorItemIndex : int) -> str
"""
@brief Get color name of the color item in colorway
@param _colorwayIndex: colorway index to get color name of color item
@param _colorItemIndex: color item index to get color name of colorway
@return color name if the indices are valid, empty string otherwise.
"""
 GetColorwayColorItemName(int _colorwayIndex, int _colorItemIndex)
/// @brief Get color name of the color item in colorway
/// @param _colorwayIndex: colorway index to get color name of color item
/// @param _colorItemIndex: color item index to get color name of colorway
/// @return color name if the indices are valid, empty string otherwise.
  • python
  • c++
def RemovePlugInFromList(_pluginListIndex : int) -> None
"""
@brief Remove Plug In From PluginList
@param _pluginListIndex: PluginList index to delete the plugin
"""
 RemovePlugInFromList(unsigned int _pluginListIndex)
/// @brief Remove Plug In From PluginList
/// @param _pluginListIndex: PluginList index to delete the plugin
  • python
  • c++
def AddPlugInFromFile(_filePath : str) -> None
"""
@brief Add Plug In From Filepath
@param _filePath: File path to be added plugin.
"""
 AddPlugInFromFile(const std::string& _filePath)
/// @brief Add Plug In From Filepath
/// @param _filePath: File path to be added plugin.
  • python
  • c++
def UsePlugInFromList(_pluginListIndex : int) -> None
"""
@brief Use Plug In From PluginList
@param _pluginListIndex: PluginList index to use the plugin
"""
 UsePlugInFromList(unsigned int _pluginListIndex)
/// @brief Use Plug In From PluginList
/// @param _pluginListIndex: PluginList index to use the plugin
  • python
  • c++
def TerminatePlugInFromList(_pluginListIndex : int) -> None
"""
@brief Terminate Plug In From PluginList
@param _pluginListIndex: PluginList index to use the plugin
"""
 TerminatePlugInFromList(unsigned int _pluginListIndex)
/// @brief Terminate Plug In From PluginList
/// @param _pluginListIndex: PluginList index to use the plugin
  • python
  • c++
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.
"""
 Set3DGarmentRenderingStyle()
/// @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.
  • python
  • c++
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.
"""
 Get3DGarmentRenderingStyle()
/// @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.
  • python
  • c++
def GetTotalGraphicItemQuantity() -> int
"""
@brief Returns the total quantity of all graphic items
@return If valid, returns the total quantity; otherwise, -1.
"""
 GetTotalGraphicItemQuantity()
/// @brief Returns the total quantity of all graphic items
/// @return If valid, returns the total quantity; otherwise, -1.
  • python
  • c++
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.
"""
 GetGraphicStyleCount()
/// @brief Returns the number of graphic styles in the current colorway
/// @return If valid, returns the number of graphic styles; otherwise, -1.
  • python
  • c++
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.
"""
 GetGraphicStyleName(int _index)
/// @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.
  • python
  • c++
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.
"""
 GetGraphicStyleDimensions(int _index)
/// @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.
  • python
  • c++
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
"""
 SetGraphicStyleName(int _index, std::string _name)
/// @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
  • python
  • c++
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
"""
 SetGraphicStyleDimensions(int _index, float _width, float _height)
/// @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
  • python
  • c++
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.
"""
 SetGraphicStyleWidth(int _index, float _width, bool _bOnly)
/// @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.
  • python
  • c++
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.
"""
 SetGraphicStyleHeight(int _index, float _height, bool _bOnly)
/// @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.
  • python
  • c++
def UpdateCloStyleForPlugIn(_pWidget : QWidget*) -> None
"""
@brief Set CLO style-sheet code to QWidget.
@param _pWidget: Root widget pointer of Plug-In Window.
eg> QWidget, QDialog, QFrame, etc...
"""
 UpdateCloStyleForPlugIn(QWidget* _pWidget)
/// @brief Set CLO style-sheet code to QWidget.
/// @param _pWidget: Root widget pointer of Plug-In Window.
eg> QWidget, QDialog, QFrame, etc...

FABRIC_API

  • python
  • c++
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.
"""
 GetFabricCount(bool _bCurrentColorway = true)
/// @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.
  • python
  • c++
def GetFabricCount(_colorwayIndex : int) -> int
"""
@brief Get the number of fabrics
@param _colorwayIndex:
_colorwayIndex = -2 : It counts all Fabrics for all the Colorways
_colorwayIndex = -1 : It counts the Fabrics of the current Colorway selected
_colorwayIndex >= 0 : It counts the Fabrics of the _colorwayIndex index given by parameter
@return the number of fabric in object browser for the current project.
"""
 GetFabricCount(int _colorwayIndex)
/// @brief Get the number of fabrics
/// @param _colorwayIndex:
_colorwayIndex = -2 : It counts all Fabrics for all the Colorways
_colorwayIndex = -1 : It counts the Fabrics of the current Colorway selected
_colorwayIndex >= 0 : It counts the Fabrics of the _colorwayIndex index given by parameter
/// @return the number of fabric in object browser for the current project.
  • python
  • c++
def GetCurrentFabricIndex() -> int
"""
@brief Get the index of the selected Fabric
@return the index of selected fabric in object browser for the current project..
"""
 GetCurrentFabricIndex()
/// @brief Get the index of the selected Fabric
/// @return the index of selected fabric in object browser for the current project..
  • python
  • c++
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 CLO temporary folder. If an error occurs, return empty string.
"""
 ExportZFab()
/// @brief Export ZFab which cotains the fabric data selected in the object browser
/// @return Output file path;output files will be created in CLO temporary folder. If an error occurs, return empty string.
  • python
  • c++
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.
"""
 ExportZFab(const string& filePath)
/// @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.
  • python
  • c++
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.
"""
 ExportZFab(const string& filePath, const int& index)
/// @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.
  • python
  • c++
def ExportZFab(_filePath : str, _colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Export ZFab which cotains the fabric data in the index of the object browser
@param _filePath: output file path
@param _colorwayIndex: target Colorway index
@param _fabricIndex: target Fabric index on the Colorway Editor to export
@return Output file path. If an error occurs, return empty string.
"""
 ExportZFab(const string& _filePath, const int& _colorwayIndex, const int& _fabricIndex)
/// @brief Export ZFab which cotains the fabric data in the index of the object browser
/// @param _filePath: output file path
/// @param _colorwayIndex: target Colorway index
/// @param _fabricIndex: target Fabric index on the Colorway Editor to export
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
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.
"""
 ExportZFabW(const wstring& filePath, const int& index)
/// @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.
  • python
  • c++
def ExportZFabW(_filePath : str, _colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Export ZFab file which cotains the fabric data in the index of the object browser
@param _filePath: output file path
@param _colorwayIndex: target Colorway index
@param _fabricIndex: target Fabric index on the Colorway Editor to export
@return Output file path. If an error occurs, return empty string.
"""
 ExportZFabW(const wstring& _filePath, const int& _colorwayIndex, const int& _fabricIndex)
/// @brief Export ZFab file which cotains the fabric data in the index of the object browser
/// @param _filePath: output file path
/// @param _colorwayIndex: target Colorway index
/// @param _fabricIndex: target Fabric index on the Colorway Editor to export
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
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.
"""
 ExportFabric(const string& filePath)
/// @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.
  • python
  • c++
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.
"""
 ExportFabric(const string& filePath, const int& index)
/// @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.
  • python
  • c++
def ExportFabric(_filePath : str, _colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Export the selected fabric to the file(.jfab or .zfab)
@param _filePath: output file path
@param _colorwayIndex: target Colorway index
@param _fabricIndex: target Fabric index on the Colorway Editor to export
@return Output file path. If an error occurs, return empty string.
"""
 ExportFabric(const string& _filePath, const int& _colorwayIndex, const int& _fabricIndex)
/// @brief Export the selected fabric to the file(.jfab or .zfab)
/// @param _filePath: output file path
/// @param _colorwayIndex: target Colorway index
/// @param _fabricIndex: target Fabric index on the Colorway Editor to export
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
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.
"""
 ExportFabricW(const wstring& filePath, const int& index)
/// @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.
  • python
  • c++
def ExportFabricW(_filePath : str, _colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Export the selected fabric to the file(.jfab or .zfab)
@param _filePath: output file path
@param _colorwayIndex: target Colorway index
@param _fabricIndex: target Fabric index on the Colorway Editor to export
@return Output file path. If an error occurs, return empty string.
"""
 ExportFabricW(const wstring& _filePath, const int& _colorwayIndex, const int& _fabricIndex)
/// @brief Export the selected fabric to the file(.jfab or .zfab)
/// @param _filePath: output file path
/// @param _colorwayIndex: target Colorway index
/// @param _fabricIndex: target Fabric index on the Colorway Editor to export
/// @return Output file path. If an error occurs, return empty string.
  • python
  • c++
def AddFabric(inputFilePath : str) -> int
"""
@brief Add Fabric into the Object Browser
@param inputFilePath: 'zfab'(clo file) path or 'jfab'(json) path
@return the index of added fabric in object browser for the current project. .
"""
 AddFabric(const string& inputFilePath)
/// @brief Add Fabric into the Object Browser
/// @param inputFilePath: 'zfab'(clo file) path or 'jfab'(json) path
/// @return the index of added fabric in object browser for the current project. .
  • python
  • c++
def AddFabricW(inputFilePath : str) -> int
"""
@brief Add Fabric into the Object Browser
@param inputFilePath: 'zfab'(clo file) path or 'jfab'(json) path
@return the index of added fabric in object browser for the current project. .
"""
 AddFabricW(const wstring& inputFilePath)
/// @brief Add Fabric into the Object Browser
/// @param inputFilePath: 'zfab'(clo file) path or 'jfab'(json) path
/// @return the index of added fabric in object browser for the current project. .
  • python
  • c++
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.
"""
 GetFirstFabricTextureName()
/// @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.
  • python
  • c++
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.
"""
 GetFirstFabricTextureNameW()
/// @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.
  • python
  • c++
def GetFirstFabricTextureName(_colorwayIndex : int) -> str
"""
@brief Get the main image file name for the first fabric in the object browser for a colorway index
@param _colorwayIndex: colorway index
@return the name of the image file name without folder path and extension.
"""
 GetFirstFabricTextureName(unsigned int _colorwayIndex)
/// @brief Get the main image file name for the first fabric in the object browser for a colorway index
/// @param _colorwayIndex: colorway index
/// @return the name of the image file name without folder path and extension.
  • python
  • c++
def GetFirstFabricTextureNameW(_colorwayIndex : int) -> str
"""
@brief Get the main image file name for the first fabric in the object browser for a colorway index
@param _colorwayIndex: colorway index
@return the name of the image file name without folder path and extension.
"""
 GetFirstFabricTextureNameW(unsigned int _colorwayIndex)
/// @brief Get the main image file name for the first fabric in the object browser for a colorway index
/// @param _colorwayIndex: colorway index
/// @return the name of the image file name without folder path and extension.
  • python
  • c++
def ChangeFabricWithJson(fabricIndex : int, inputJsonFilePath : str) -> bool
"""
@brief Overwrite all the properties of a fabric with json file(.jfab)
@param fabricIndex: target fabric index in the object browser
@param inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex
@return if it succeeds, return true.
"""
 ChangeFabricWithJson(unsigned int fabricIndex, const string& inputJsonFilePath)
/// @brief Overwrite all the properties of a fabric with json file(.jfab)
/// @param fabricIndex: target fabric index in the object browser
/// @param inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex
/// @return if it succeeds, return true.
  • python
  • c++
def ChangeFabricWithJsonW(fabricIndex : int, inputJsonFilePath : str) -> bool
"""
@brief Overwrite all the properties of a fabric with json file(.jfab)
@param fabricIndex: target fabric index in the object browser
@param inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex
@return if it succeeds, return true.
"""
 ChangeFabricWithJsonW(unsigned int fabricIndex, const wstring& inputJsonFilePath)
/// @brief Overwrite all the properties of a fabric with json file(.jfab)
/// @param fabricIndex: target fabric index in the object browser
/// @param inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex
/// @return if it succeeds, return true.
  • python
  • c++
def ChangeFabricWithJson(_colorwayIndex : int, _fabricIndex : int, _inputJsonFilePath : str) -> bool
"""
@brief Overwrite all the properties of a fabric with json file(.jfab)
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: target fabric index in the Colorway Editor
@param _inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex
@return if it succeeds, return true.
"""
 ChangeFabricWithJson(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::string& _inputJsonFilePath)
/// @brief Overwrite all the properties of a fabric with json file(.jfab)
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: target fabric index in the Colorway Editor
/// @param _inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex
/// @return if it succeeds, return true.
  • python
  • c++
def ChangeFabricWithJsonW(_colorwayIndex : int, _fabricIndex : int, _inputJsonFilePath : str) -> bool
"""
@brief Overwrite all the properties of a fabric with json file(.jfab)
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: target fabric index in the Colorway Editor
@param _inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex
@return if it succeeds, return true.
"""
 ChangeFabricWithJsonW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::wstring& _inputJsonFilePath)
/// @brief Overwrite all the properties of a fabric with json file(.jfab)
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: target fabric index in the Colorway Editor
/// @param _inputJsonFilePath: the jfab file path to load on to the fabric in the fabricIndex
/// @return if it succeeds, return true.
  • python
  • c++
def AssignFabricToPattern(_fabricIndex : int, _patternIndex : 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
@return if it succeeds, return true.
"""
 AssignFabricToPattern(unsigned int _fabricIndex, unsigned int _patternIndex)
/// @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
/// @return if it succeeds, return true.
  • python
  • c++
def AssignFabricToPattern(_colorwayIndex : int, _fabricIndex : int, _patternIndex : int) -> bool
"""
@brief Assign a fabric to a pattern.
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the source fabric index in the Colorway Editor to apply to the target pattern
@param _patternIndex: the tagert pattern index to apply the fabric in the fabricIndex
@return if it succeeds, return true.
"""
 AssignFabricToPattern(unsigned int _colorwayIndex, unsigned int _fabricIndex, unsigned int _patternIndex)
/// @brief Assign a fabric to a pattern.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the source fabric index in the Colorway Editor to apply to the target pattern
/// @param _patternIndex: the tagert pattern index to apply the fabric in the fabricIndex
/// @return if it succeeds, return true.
  • python
  • c++
def ImportXtexFile(fabricIndex : int, xTexFilePath : str) -> bool
"""
@brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric
@parm fabricIndex: the target fabric index in the object browser to import xTex file onto
@parm xTexFilePath: the xTex file path to import
@return if it succeeds, return true.
"""
 ImportXtexFile(unsigned int fabricIndex, const string& xTexFilePath)
/// @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric
/// @parm fabricIndex: the target fabric index in the object browser to import xTex file onto
/// @parm xTexFilePath: the xTex file path to import
/// @return if it succeeds, return true.
  • python
  • c++
def ImportXtexFileW(fabricIndex : int, xTexFilePath : str) -> bool
"""
@brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric
@parm fabricIndex: the target fabric index in the object browser to import xTex file onto
@parm xTexFilePath: the xTex file path to import
@return if it succeeds, return true.
"""
 ImportXtexFileW(unsigned int fabricIndex, const wstring& xTexFilePath)
/// @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric
/// @parm fabricIndex: the target fabric index in the object browser to import xTex file onto
/// @parm xTexFilePath: the xTex file path to import
/// @return if it succeeds, return true.
  • python
  • c++
def ImportXtexFile(_colorwayIndex : int, _fabricIndex : int, _xTexFilePath : str) -> bool
"""
@brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor to import xTex file onto
@parm _xTexFilePath: the xTex file path to import
@return if it succeeds, return true.
"""
 ImportXtexFile(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::string& _xTexFilePath)
/// @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor to import xTex file onto
/// @parm _xTexFilePath: the xTex file path to import
/// @return if it succeeds, return true.
  • python
  • c++
def ImportXtexFileW(_colorwayIndex : int, _fabricIndex : int, _xTexFilePath : str) -> bool
"""
@brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor to import xTex file onto
@parm _xTexFilePath: the xTex file path to import
@return if it succeeds, return true.
"""
 ImportXtexFileW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::wstring& _xTexFilePath)
/// @brief Import xtex to a fabric. Overwrite all the values described in the xtex file into the Fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor to import xTex file onto
/// @parm _xTexFilePath: the xTex file path to import
/// @return if it succeeds, return true.
  • python
  • c++
def ApplyXtexFile(fabricIndex : int, xTexFilePath : str) -> bool
"""
@brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric.
@parm fabricIndex: the target fabric index in the object browser to apply xTex file onto
@parm xTexFilePath: the xTex file path to apply
@return if it succeeds, return true.
"""
 ApplyXtexFile(unsigned int fabricIndex, const string& xTexFilePath)
/// @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric.
/// @parm fabricIndex: the target fabric index in the object browser to apply xTex file onto
/// @parm xTexFilePath: the xTex file path to apply
/// @return if it succeeds, return true.
  • python
  • c++
def ApplyXtexFileW(fabricIndex : int, xTexFilePath : str) -> bool
"""
@brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric.
@parm fabricIndex: the target fabric index in the object browser to apply xTex file onto
@parm xTexFilePath: the xTex file path to apply
@return if it succeeds, return true.
"""
 ApplyXtexFile(unsigned int fabricIndex, const string& xTexFilePath)
/// @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric.
/// @parm fabricIndex: the target fabric index in the object browser to apply xTex file onto
/// @parm xTexFilePath: the xTex file path to apply
/// @return if it succeeds, return true.
  • python
  • c++
def ApplyXtexFile(_colorwayIndex : int, _fabricIndex : int, _xTexFilePath : str) -> bool
"""
@brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric.
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor to apply xTex file onto
@parm _xTexFilePath: the xTex file path to apply
@return if it succeeds, return true.
"""
 ApplyXtexFile(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& xTexFilePath)
/// @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor to apply xTex file onto
/// @parm _xTexFilePath: the xTex file path to apply
/// @return if it succeeds, return true.
  • python
  • c++
def ApplyXtexFileW(_colorwayIndex : int, _fabricIndex : int, _xTexFilePath : str) -> bool
"""
@brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric.
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor to apply xTex file onto
@parm _xTexFilePath: the xTex file path to apply
@return if it succeeds, return true.
"""
 ApplyXtexFile(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& xTexFilePath)
/// @brief Apply xtex to a fabric. Only set the values described in the xtex file into the Fabric.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor to apply xTex file onto
/// @parm _xTexFilePath: the xTex file path to apply
/// @return if it succeeds, return true.
  • python
  • c++
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.
"""
 DeleteFabric(unsigned int fabricIndex)
/// @brief Delete a fabric. If the fabric was assigned on Patterns, the patterns will have the default fabric
/// @return if it succeeds, return true.
  • python
  • c++
def DeleteFabric(_colorwayIndex : int, _fabricIndex : int) -> bool
"""
@brief Delete a fabric. If the fabric was assigned on Patterns, the patterns will have the default fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor to delete
@return if it succeeds, return true.
"""
 DeleteFabric(unsigned int _colorwayIndex, unsigned int _fabricIndex)
/// @brief Delete a fabric. If the fabric was assigned on Patterns, the patterns will have the default fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor to delete
/// @return if it succeeds, return true.
  • python
  • c++
def GetAPIMetaData(fabricIndex : int) -> str
"""
@brief Get API meta data for the fabric
@parm fabricIndex: target fabric index on the Object Browser
@return json string for meta data [key - value] list
"""
 GetAPIMetaData(unsigned int fabricIndex)
/// @brief Get API meta data for the fabric
/// @parm fabricIndex: target fabric index on the Object Browser
/// @return json string for meta data [key - value] list
  • python
  • c++
def GetAPIMetaDataW(fabricIndex : int) -> str
"""
@brief Get API meta data for the fabric
@parm fabricIndex: target fabric index on the Object Browser
@return json string for meta data [key - value] list
"""
 GetAPIMetaDataW(unsigned int fabricIndex)
/// @brief Get API meta data for the fabric
/// @parm fabricIndex: target fabric index on the Object Browser
/// @return json string for meta data [key - value] list
  • python
  • c++
def GetAPIMetaData(_colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Get API meta data for the fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: target fabric index on the Colorway Editor
@return json string for meta data [key - value] list
"""
 GetAPIMetaData(unsigned int _colorwayIndex, unsigned int _fabricIndex)
/// @brief Get API meta data for the fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: target fabric index on the Colorway Editor
/// @return json string for meta data [key - value] list
  • python
  • c++
def GetAPIMetaDataW(_colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Get API meta data for the fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: target fabric index on the Colorway Editor
@return json string for meta data [key - value] list
"""
 GetAPIMetaDataW(unsigned int _colorwayIndex, unsigned int _fabricIndex)
/// @brief Get API meta data for the fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: target fabric index on the Colorway Editor
/// @return json string for meta data [key - value] list
  • python
  • c++
def SetAPIMetaData(fabricIndex : int, jsonStr : str) -> bool
"""
@brief Set API meta data for the fabric
@param fabricIndex: target fabric index on the Object Browser
@param jsonStr: api meta data in string format
@return if it succeeds, return true
"""
 SetAPIMetaData(unsigned int fabricIndex, string jsonStr)
/// @brief Set API meta data for the fabric
/// @param fabricIndex: target fabric index on the Object Browser
/// @param jsonStr: api meta data in string format
/// @return if it succeeds, return true
  • python
  • c++
def SetAPIMetaDataW(fabricIndex : int, jsonStr : str) -> bool
"""
@brief Set API meta data for the fabric
@param fabricIndex: target fabric index on the Object Browser
@param jsonStr: api meta data in string format
@return if it succeeds, return true
"""
 SetAPIMetaData(unsigned int fabricIndex, string jsonStr)
/// @brief Set API meta data for the fabric
/// @param fabricIndex: target fabric index on the Object Browser
/// @param jsonStr: api meta data in string format
/// @return if it succeeds, return true
  • python
  • c++
def SetAPIMetaData(_colorwayIndex : int, _fabricIndex : int, _jsonStr : str) -> bool
"""
@brief Set API meta data for the fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: target fabric index on the Colorway Editor
@param _jsonStr: api meta data in string format
@return if it succeeds, return true
"""
 SetAPIMetaData(unsigned int _colorwayIndex, unsigned int _fabricIndex, string jsonStr)
/// @brief Set API meta data for the fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: target fabric index on the Colorway Editor
/// @param _jsonStr: api meta data in string format
/// @return if it succeeds, return true
  • python
  • c++
def SetAPIMetaDataW(_colorwayIndex : int, _fabricIndex : int, _jsonStr : str) -> bool
"""
@brief Set API meta data for the fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: target fabric index on the Colorway Editor
@param _jsonStr: api meta data in string format
@return if it succeeds, return true
"""
 SetAPIMetaData(unsigned int _colorwayIndex, unsigned int _fabricIndex, string jsonStr)
/// @brief Set API meta data for the fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: target fabric index on the Colorway Editor
/// @param _jsonStr: api meta data in string format
/// @return if it succeeds, return true
  • python
  • c++
def ChangeMetaDataValueForFabric(fabricIndex : int, metaDataKey : str, metaDataValue : str) -> None
"""
@brief Change or add Meta Data Value for the fabric with the index
@param fabricIndex: target fabric index on the Object Browser
@param metaDataKey: target Key
@param metaDataValue: the new value for the key
"""
 ChangeMetaDataValueForFabric(unsigned int fabricIndex, const string& metaDataKey, const string& metaDataValue)
/// @brief Change or add Meta Data Value for the fabric with the index
/// @param fabricIndex: target fabric index on the Object Browser
/// @param metaDataKey: target Key
/// @param metaDataValue: the new value for the key
  • python
  • c++
def ChangeMetaDataValueForFabricW(fabricIndex : int, metaDataKey : str, metaDataValue : str) -> None
"""
@brief Change or add Meta Data Value for the fabric with the index
@param fabricIndex: target fabric index on the Object Browser
@param metaDataKey: target Key
@param metaDataValue: the new value for the key
"""
 ChangeMetaDataValueForFabric(unsigned int fabricIndex, const wstring& metaDataKey, const wstring& metaDataValue)
/// @brief Change or add Meta Data Value for the fabric with the index
/// @param fabricIndex: target fabric index on the Object Browser
/// @param metaDataKey: target Key
/// @param metaDataValue: the new value for the key
  • python
  • c++
def ChangeMetaDataValueForFabric(_colorwayIndex : int, _fabricIndex : int, _metaDataKey : str, _metaDataValue : str) -> None
"""
@brief Change or add Meta Data Value for the fabric with the index
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: target fabric index on the Colorway Editor
@param _metaDataKey: target Key
@param _metaDataValue: the new value for the key
"""
 ChangeMetaDataValueForFabric(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& metaDataKey, const string& metaDataValue)
/// @brief Change or add Meta Data Value for the fabric with the index
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: target fabric index on the Colorway Editor
/// @param _metaDataKey: target Key
/// @param _metaDataValue: the new value for the key
  • python
  • c++
def ChangeMetaDataValueForFabricW(_colorwayIndex : int, _fabricIndex : int, _metaDataKey : str, _metaDataValue : str) -> None
"""
@brief Change or add Meta Data Value for the fabric with the index
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: target fabric index on the Colorway Editor
@param _metaDataKey: target Key
@param _metaDataValue: the new value for the key
"""
 ChangeMetaDataValueForFabric(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& metaDataKey, const wstring& metaDataValue)
/// @brief Change or add Meta Data Value for the fabric with the index
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: target fabric index on the Colorway Editor
/// @param _metaDataKey: target Key
/// @param _metaDataValue: the new value for the key
  • python
  • c++
def GetFabricSize() -> int
"""
@brief Get the number of fabrics on the Object Browser
@return return the number of fabrics on the object browser
"""
 GetFabricSize()
/// @brief Get the number of fabrics on the Object Browser
/// @return return the number of fabrics on the object browser
  • python
  • c++
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
"""
 GetFabricIndexForPattern(int patternIndex)
/// @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
  • python
  • c++
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
"""
 GetFabricIndex(const string& fabricName)
/// @brief Get the fabric index which is using the fabric name
/// @param fabricName: the fabric name to get the fabric index
/// @return fabric index
  • python
  • c++
def GetFabricIndex(_colorwayIndex : int, _fabricName : str) -> int
"""
@brief Get the fabric index which is using the fabric name
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricName: the fabric name to get the fabric index
@return fabric index
"""
 GetFabricIndex(const string& fabricName)
/// @brief Get the fabric index which is using the fabric name
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricName: the fabric name to get the fabric index
/// @return fabric index
  • python
  • c++
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
"""
 GetFabricIndexW(const wstring& fabricName)
/// @brief Get the fabric index which is using the fabric name
/// @param fabricName: the fabric name to get the fabric index
/// @return fabric index
  • python
  • c++
def GetFabricIndexW(_colorwayIndex : int, _fabricName : str) -> int
"""
@brief Get the fabric index which is using the fabric name
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricName: the fabric name to get the fabric index
@return fabric index
"""
 GetFabricIndexW(const wstring& fabricName)
/// @brief Get the fabric index which is using the fabric name
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricName: the fabric name to get the fabric index
/// @return fabric index
  • python
  • c++
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
"""
 GetFabricName(int fabricIndex)
/// @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
  • python
  • c++
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
"""
 GetFabricNameW(int fabricIndex)
/// @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
  • python
  • c++
def GetFabricName(_colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Get the fabric name of the fabric in the fabricIndex on the object browser
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the fabric index on the Colorway Editor to get the name
@return fabric name
"""
 GetFabricName(int _colorwayIndex, int _fabricIndex)
/// @brief Get the fabric name of the fabric in the fabricIndex on the object browser
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the fabric index on the Colorway Editor to get the name
/// @return fabric name
  • python
  • c++
def GetFabricNameW(_colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Get the fabric name of the fabric in the fabricIndex on the object browser
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the fabric index on the Colorway Editor to get the name
@return fabric name
"""
 GetFabricNameW(int _colorwayIndex, int _fabricIndex)
/// @brief Get the fabric name of the fabric in the fabricIndex on the object browser
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the fabric index on the Colorway Editor to get the name
/// @return fabric name
  • python
  • c++
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
"""
 GetFabricInfo(int fabricIndex)
/// @brief Get a fabric information
/// @param fabricIndex: the fabricIndex for the fabric to get the fabric info
/// @return json string for fabric information
  • python
  • c++
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
"""
 GetFabricInfoW(int fabricIndex)
/// @brief Get a fabric information
/// @param fabricIndex: the fabricIndex for the fabric to get the fabric info
/// @return json string for fabric information
  • python
  • c++
def GetColorwayFabricInfo(_colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Get a fabric information for a colorway
@param _colorwayIndex: the colorway index for the fabric to get the fabric info
@param _fabricIndex: the fabricIndex for the fabric to get the fabric info
@return json string for fabric information
"""
 GetColorwayFabricInfo(int _colorwayIndex, int _fabricIndex)
/// @brief Get a fabric information for a colorway
/// @param _colorwayIndex: the colorway index for the fabric to get the fabric info
/// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info
/// @return json string for fabric information
  • python
  • c++
def GetColorwayFabricInfoW(_colorwayIndex : int, _fabricIndex : int) -> str
"""
@brief Get a fabric information for a colorway
@param _colorwayIndex: the colorway index for the fabric to get the fabric info
@param _fabricIndex: the fabricIndex for the fabric to get the fabric info
@return json string for fabric information
"""
 GetColorwayFabricInfoW(int _colorwayIndex, int _fabricIndex)
/// @brief Get a fabric information for a colorway
/// @param _colorwayIndex: the colorway index for the fabric to get the fabric info
/// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info
/// @return json string for fabric information
  • python
  • c++
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
"""
 GetAPIMetaDataFromFile(const string& filePath)
/// @brief Get API meta data for the fabric
/// @param filePath: filepath (.zfab / .jfab)
/// @return json string for meta data [key - value] list
  • python
  • c++
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
"""
 GetAPIMetaDataFromFileW(const wstring& filePath)
/// @brief Get API meta data for the fabric
/// @param filePath: filepath (.zfab / .jfab)
/// @return json string for meta data [key - value] list
  • python
  • c++
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)
"""
 SetFabricInformation(int _fabricIndex, const std::map<string, string> _infoMap)
/// @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)
  • python
  • c++
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)
"""
 SetFabricInformationW(int _fabricIndex, const std::map<wstring, wstring> _infoMap)
/// @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)
  • python
  • c++
def SetFabricInformation(_colorwayIndex : int, _fabricIndex : int, _infoMap : map[str, str]) -> None
"""
@brief Set Fabric Information to fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info
@param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner)
"""
 SetFabricInformation(int _colorwayIndex, int _fabricIndex, const std::map<string, string> _infoMap)
/// @brief Set Fabric Information to fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info
/// @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner)
  • python
  • c++
def SetFabricInformationW(_colorwayIndex : int, _fabricIndex : int, _infoMap : map[str, str]) -> None
"""
@brief Set Fabric Information to fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info
@param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner)
"""
 SetFabricInformationW(int _colorwayIndex, int _fabricIndex, const std::map<wstring, wstring> _infoMap)
/// @brief Set Fabric Information to fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info
/// @param _infoMap: Fabric Information (etc. Classification, Content, SupplierName, Owner)
  • python
  • c++
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
"""
 GetFabricInformation(int _fabricIndex)
/// @brief Get Fabric Information for fabric
/// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info
/// @return Fabric Information
  • python
  • c++
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
"""
 GetFabricInformationW(int _fabricIndex)
/// @brief Get Fabric Information for fabric
/// @param _fabricIndex: the fabricIndex for the fabric to get the fabric info
/// @return Fabric Information
  • python
  • c++
def GetFabricInformation(_colorwayIndex : int, _fabricIndex : int) -> map[str, str]
"""
@brief Get Fabric Information for fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info
@return Fabric Information
"""
 GetFabricInformation(int _colorwayIndex, int _fabricIndex)
/// @brief Get Fabric Information for fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info
/// @return Fabric Information
  • python
  • c++
def GetFabricInformationW(_colorwayIndex : int, _fabricIndex : int) -> map[str, str]
"""
@brief Get Fabric Information for fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info
@return Fabric Information
"""
 GetFabricInformationW(int _colorwayIndex, int _fabricIndex)
/// @brief Get Fabric Information for fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric to set the fabric info
/// @return Fabric Information
  • python
  • c++
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)
"""
 SetCustomImage(int _fabricIndex, const string& _filePath)
/// @brief Set Custom Image to fabric
/// @param _fabricIndex: the fabricIndex for the fabric
/// @param _filePath: filepath  (.png / .jpeg)
  • python
  • c++
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)
"""
 SetCustomImageW(int _fabricIndex, const wstring& _filePath)
/// @brief Set Custom Image to fabric
/// @param _fabricIndex: the fabricIndex for the fabric
/// @param _filePath: filepath  (.png / .jpeg)
  • python
  • c++
def SetCustomImage(_colorwayIndex : int, _fabricIndex : int, _filePath : str) -> None
"""
@brief Set Custom Image to fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric
@param _filePath: filepath  (.png / .jpeg)
"""
 SetCustomImage(int _colorwayIndex, int _fabricIndex, const string& _filePath)
/// @brief Set Custom Image to fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric
/// @param _filePath: filepath  (.png / .jpeg)
  • python
  • c++
def SetCustomImageW(_colorwayIndex : int, _fabricIndex : int, _filePath : str) -> None
"""
@brief Set Custom Image to fabric
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric
@param _filePath: filepath  (.png / .jpeg)
"""
 SetCustomImageW(int _colorwayIndex, int _fabricIndex, const wstring& _filePath)
/// @brief Set Custom Image to fabric
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the fabricIndex in the Colorway Editor for the fabric
/// @param _filePath: filepath  (.png / .jpeg)
  • python
  • c++
def GetPrimaryFabric() -> int
"""
@brief Return the fabric index used for a major number of the patterns
"""
 GetPrimaryFabric()
/// @brief Return the fabric index used for a major number of the patterns
  • python
  • c++
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
"""
 SetFabricName(unsigned int index, const string& str)
/// @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
  • python
  • c++
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
"""
 SetColorwayNameW(unsigned int index, const wstring& wstr)
/// @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
  • python
  • c++
def SetFabricName(_colorwayIndex : int, _fabricIndex : int, _str : str) -> None
"""
@brief Change fabric name
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the target fabric index on the object browser to change the name
@param str: new name for the fabric
"""
 SetFabricName(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& str)
/// @brief Change fabric name
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the target fabric index on the object browser to change the name
/// @param str: new name for the fabric
  • python
  • c++
def SetFabricNameW(_colorwayIndex : int, _fabricIndex : int, _wstr : str) -> None
"""
@brief Change fabric name
@param _colorwayIndex: target colorway index in the Colorway Editor
@param _fabricIndex: the target fabric index on the object browser to change the name
@param str: new name for the fabric
"""
 SetColorwayNameW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& wstr)
/// @brief Change fabric name
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @param _fabricIndex: the target fabric index on the object browser to change the name
/// @param str: new name for the fabric
  • python
  • c++
def GetFabricStyleNameList() -> list[str]
"""
@brief Return all fabric style name
"""
 GetFabricStyleNameList()
/// @brief Return all fabric style name
  • python
  • c++
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.
"""
 ImportSubstanceFile(unsigned int fabricIndex, const string& substanceFilePath)
/// @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.
  • python
  • c++
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.
"""
 ImportSubstanceFileW(unsigned int fabricIndex, const wstring& substanceFilePath)
/// @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.
  • python
  • c++
def ImportSubstanceFile(_colorwayIndex : int, _fabricIndex : int, _substanceFilePath : str) -> bool
"""
@brief Import substance to a fabric.
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor to import substance file onto
@parm _substanceFilePath: the substance file path to import
@return if it succeeds, return true.
"""
 ImportSubstanceFile(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& _substanceFilePath)
/// @brief Import substance to a fabric.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor to import substance file onto
/// @parm _substanceFilePath: the substance file path to import
/// @return if it succeeds, return true.
  • python
  • c++
def ImportSubstanceFileW(_colorwayIndex : int, _fabricIndex : int, _substanceFilePath : str) -> bool
"""
@brief Import substance to a fabric.
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor to import substance file onto
@parm _substanceFilePath: the substance file path to import
@return if it succeeds, return true.
"""
 ImportSubstanceFileW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& _substanceFilePath)
/// @brief Import substance to a fabric.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor to import substance file onto
/// @parm _substanceFilePath: the substance file path to import
/// @return if it succeeds, return true.
  • python
  • c++
def GetFabricWidth(fabricIndex : int) -> float
"""
@brief Get Fabric width (mm)
@parm fabricIndex: the target fabric index in the object browser
@return fabric width
"""
 GetFabricWidth(int fabricIndex)
/// @brief Get Fabric width (mm)
/// @parm fabricIndex: the target fabric index in the object browser
/// @return fabric width
  • python
  • c++
def GetFabricWidth(_colorwayIndex : int, _fabricIndex : int) -> float
"""
@brief Get Fabric width (mm)
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor
@return fabric width
"""
 GetFabricWidth(int _colorwayIndex, int _fabricIndex)
/// @brief Get Fabric width (mm)
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor
/// @return fabric width
  • python
  • c++
def SetFabricWidth(_fabricIndex : int, mm : float) -> None
"""
@brief Set Fabric width (mm)
@parm fabricIndex: the target fabric index in the object browser
@parm mm: Fabric width
@return void
"""
 SetFabricWidth(int fabricIndex, float mm)
/// @brief Set Fabric width (mm)
/// @parm fabricIndex: the target fabric index in the object browser
/// @parm mm: Fabric width
/// @return void
  • python
  • c++
def SetFabricWidth(_colorwayIndex : int, _fabricIndex : int, _mm : float) -> None
"""
@brief Set Fabric width (mm)
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor
@parm _mm: Fabric width
@return void
"""
 SetFabricWidth(unsigned int _colorwayIndex, int fabricIndex, float mm)
/// @brief Set Fabric width (mm)
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor
/// @parm _mm: Fabric width
/// @return void
  • python
  • c++
def GetFabricLength(fabricIndex : int) -> float
"""
@brief Get Fabric Length (mm)
@parm fabricIndex: the target fabric index in the object browser
@return Fabric Length
"""
 GetFabricLength(int fabricIndex)
/// @brief Get Fabric Length (mm)
/// @parm fabricIndex: the target fabric index in the object browser
/// @return Fabric Length
  • python
  • c++
def GetFabricLength(_colorwayIndex : int, _fabricIndex : int) -> float
"""
@brief Get Fabric Length (mm)
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the Colorway Editor
@return Fabric Length
"""
 GetFabricLength(int _colorwayIndex, int _fabricIndex)
/// @brief Get Fabric Length (mm)
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the Colorway Editor
/// @return Fabric Length
  • python
  • c++
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
"""
 SetTextureMapping(unsigned int fabricIndex, int materialFace, int mappingType)
/// @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
  • python
  • c++
def SetTextureMapping(_colorwayIndex : int, _fabricIndex : int, _mappingType : int) -> None
"""
@brief Set Texture Mapping Type (Repeat or Unified)
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _fabricIndex: the target fabric index in the ColorwayEditor
@parm _mappingType: the target mapping type to set. 0: "Repeat", 1: "Unified"
@return void
"""
 SetTextureMapping(unsigned int _colorwayIndex, unsigned int fabricIndex, int materialFace, int mappingType)
/// @brief Set Texture Mapping Type (Repeat or Unified)
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _fabricIndex: the target fabric index in the ColorwayEditor
/// @parm _mappingType: the target mapping type to set. 0: "Repeat", 1: "Unified"
/// @return void
  • python
  • c++
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
"""
 SetSubstancePreset(unsigned int fabricIndex, int materialFace, int preset)
/// @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
  • python
  • c++
def SetSubstancePreset(colorwayIndex : int, fabricIndex : int, materialFace : int, presetIndex : int) -> None
"""
@brief Set Texture Mapping Type (Repeat or Unified)
@param colorwayIndex: target colorway index in the Colorway Editor
@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
"""
 SetSubstancePreset(unsigned int colorwayIndex,unsigned int fabricIndex, int materialFace, int preset)
/// @brief Set Texture Mapping Type (Repeat or Unified)
/// @param colorwayIndex: target colorway index in the Colorway Editor
/// @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
  • python
  • c++
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
"""
 SetSubstanceResolution(unsigned int fabricIndex, int materialFace, int resolution)
/// @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
  • python
  • c++
def SetSubstanceResolution(colorwayIndex : int, fabricIndex : int, materialFace : int, resolutionIndex : int) -> None
"""
@brief Set Texture Mapping Type (Repeat or Unified)
@param colorwayIndex: target colorway index in the Colorway Editor
@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
"""
 SetSubstanceResolution(unsigned int colorwayIndex,unsigned int fabricIndex, int materialFace, int resolution)
/// @brief Set Texture Mapping Type (Repeat or Unified)
/// @param colorwayIndex: target colorway index in the Colorway Editor
/// @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
  • python
  • c++
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.
"""
 ImportSubstanceFileAsFaceType(unsigned int _fabricIndex, const string& _substanceFilePath, const string& _faceType)
/// @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.
  • python
  • c++
def ImportSubstanceFileAsFaceType(_colorwayIndex : int, _fabricIndex : int, _substanceFilePath : str, _faceType : str) -> bool
"""
@brief Import substance to a fabric as facetype.
@param _colorwayIndex: target colorway index in the Colorway Editor
@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.
"""
 ImportSubstanceFileAsFaceType(unsigned int _colorwayIndex, unsigned int _fabricIndex, const string& _substanceFilePath, const string& _faceType)
/// @brief Import substance to a fabric as facetype.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @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.
  • python
  • c++
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.
"""
 ImportSubstanceFileAsFaceTypeW(unsigned int _fabricIndex, const wstring& _substanceFilePath, const string& _faceType)
/// @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.
  • python
  • c++
def ImportSubstanceFileAsFaceTypeW(_colorwayIndex : int, _fabricIndex : int, _substanceFilePath : str, _faceType : str) -> bool
"""
@brief Import substance to a fabric.
@param _colorwayIndex: target colorway index in the Colorway Editor
@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.
"""
 ImportSubstanceFileAsFaceTypeW(unsigned int _colorwayIndex, unsigned int _fabricIndex, const wstring& _substanceFilePath, const string& _faceType)
/// @brief Import substance to a fabric.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @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.
  • python
  • c++
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
"""
 SetUseSameMaterialAsFront(unsigned int fabricIndex, int materialFace, bool _useSameMaterial)
/// @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
  • python
  • c++
def SetUseSameMaterialAsFront(colorwayIndex : int, fabricIndex : int, materialFace : int, _useSameMaterial : bool) -> None
"""
@brief Set use same material as front.
@param colorwayIndex: target colorway index in the Colorway Editor
@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
"""
 SetUseSameMaterialAsFront(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace, bool _useSameMaterial)
/// @brief Set use same material as front.
/// @param colorwayIndex: target colorway index in the Colorway Editor
/// @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
  • python
  • c++
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
"""
 SetUseSameColorAsFront(unsigned int fabricIndex, int materialFace, bool _useSameMaterial)
/// @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
  • python
  • c++
def SetUseSameColorAsFront(colorwayIndex : int, fabricIndex : int, materialFace : int, _useSameColor : bool) -> None
"""
@brief Set use same color as front.
@param colorwayIndex: target colorway index in the Colorway Editor
@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
"""
 SetUseSameColorAsFront(unsigned int colorwayIndex, unsigned int fabricIndex, int materialFace, bool _useSameMaterial)
/// @brief Set use same color as front.
/// @param colorwayIndex: target colorway index in the Colorway Editor
/// @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
  • python
  • c++
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.
"""
 SetFabricPBRMaterialBaseColor(unsigned int fabricIndex, unsigned int materialFace, float r, float g, float b, float a)
/// @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.
  • python
  • c++
def SetFabricPBRMaterialBaseColor(_colorwayIndex : int, _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 _colorwayIndex: the target colorway index
@parm _fabricIndex: the target fabric index in the object browser(Fabric index calculated assuming that the "Show All Colorways" option is turned off)
@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.
"""
 SetFabricPBRMaterialBaseColor(unsigned int _colorwayIndex, unsigned int _fabricIndex, unsigned int _materialFace, float _r, float _g, float _b, float _a)
/// @brief Set a base color of PBR material in a fabric using given RGBA values.
/// @parm _colorwayIndex: the target colorway index
/// @parm _fabricIndex: the target fabric index in the object browser(Fabric index calculated assuming that the "Show All Colorways" option is turned off)
/// @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.
  • python
  • c++
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.
"""
 SetFabricPBRMaterialBaseColor(unsigned int fabricIndex, unsigned int materialFace, const std::string& _colorName)
/// @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.
  • python
  • c++
def SetFabricPBRMaterialBaseColor(_colorwayIndex : int, _fabricIndex : int, _materialFace : int, _colorName : str) -> bool
"""
@brief Set a base color of PBR material in a fabric using given name of color.
@parm _colorwayIndex: the target colorway index
@parm _fabricIndex: the target fabric index in the object browser(Fabric index calculated assuming that the "Show All Colorways" option is turned off)
@parm _materialFace :��Front��, ��Back��, ��Side��
@parm _colorName: Name of color
@return if it succeeds, return true.
"""
 SetFabricPBRMaterialBaseColor(unsigned int _colorwayIndex, unsigned int _fabricIndex, unsigned int _materialFace, const std::string& _colorName)
/// @brief Set a base color of PBR material in a fabric using given name of color.
/// @parm _colorwayIndex: the target colorway index
/// @parm _fabricIndex: the target fabric index in the object browser(Fabric index calculated assuming that the "Show All Colorways" option is turned off)
/// @parm _materialFace :��Front��, ��Back��, ��Side��
/// @parm _colorName: Name of color
/// @return if it succeeds, return true.
  • python
  • c++
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
"""
 GetFabricPBRMaterialBaseColor(unsigned int fabricIndex, unsigned int materialFace)
/// @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
  • python
  • c++
def GetFabricPBRMaterialBaseColor(_colorwayIndex : int, _fabricIndex : int, _materialFace : int) -> tuple[float, float, float, float]
"""
@brief Get a base color of PBR material in a fabric.
@parm _colorwayIndex: the target colorway index
@parm _fabricIndex: the target fabric index in the object browser to import substance file onto
@parm _materialFace :��Front��, ��Back��, ��Side��
@return RGBA float tuple
"""
 GetFabricPBRMaterialBaseColor(unsigned int _colorwayIndex, unsigned int _fabricIndex, unsigned int _materialFace)
/// @brief Get a base color of PBR material in a fabric.
/// @parm _colorwayIndex: the target colorway index
/// @parm _fabricIndex: the target fabric index in the object browser to import substance file onto
/// @parm _materialFace :��Front��, ��Back��, ��Side��
/// @return RGBA float tuple
  • python
  • c++
def SetCurrentFabricIndex(_index : int) -> bool
"""
@brief Set Current Fabric Index
@parm _index: Fabric Index
@return Fabric setting success or failure return
"""
 SetCurrentFabricIndex(int _index)
/// @brief Set Current Fabric Index
/// @parm _index: Fabric Index
/// @return Fabric setting success or failure return
  • python
  • c++
def SetCurrentFabricIndex(_colorwayIndex : int, _index : int) -> bool
"""
@brief Set Current Fabric Index
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _index: Fabric Index
@return Fabric setting success or failure return
"""
 SetCurrentFabricIndex(unsigned int _colorwayIndex, int _index)
/// @brief Set Current Fabric Index
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _index: Fabric Index
/// @return Fabric setting success or failure return
  • python
  • c++
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
"""
 CreateZfabFromTextures(const std::string& _filePath, const std::string& _baseTexturePath, const std::string& _normalTexturePath, const std::string& _disPlacementTexturePath, const std::string& _opacityTexturePath)
/// @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
  • python
  • c++
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
"""
 CombineZfab(const std::string& _filePath, const std::string& _baseZfabPath, const std::string& _targetZfabPath)
/// @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
  • python
  • c++
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 )
"""
 int GetRoughnessType(int _index, int _materialFace)
/// @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 )
  • python
  • c++
def GetRoughnessType(_colorwayIndex : int, _index : int, _materialFace : int) -> int
"""
@brief Get Material RoughnessType
@param _colorwayIndex: target colorway index in the Colorway Editor
@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 )
"""
 int GetRoughnessType(unsigned int _colorwayIndex, int _index, int _materialFace)
/// @brief Get Material RoughnessType
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @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 )
  • python
  • c++
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
"""
 SetRoughnessType(int _index, int _materialFace, int _roughnessType)
/// @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
  • python
  • c++
def SetRoughnessType(_colorwayIndex : int, _index : int, _materialFace : int, _roughnessType : int) -> None
"""
@brief Set Current Fabric's mateiral roughnessType
@param _colorwayIndex: target colorway index in the Colorway Editor
@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
"""
 SetRoughnessType(unsigned int _colorwayIndex, int _index, int _materialFace, int _roughnessType)
/// @brief Set Current Fabric's mateiral roughnessType
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @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
  • python
  • c++
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.
"""
 float GetRoughnessValueIntensity(int _index, int _face)
/// @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.
  • python
  • c++
def GetRoughnessValueIntensity(_colorwayIndex : int, _index : int, _face : int) -> int
"""
@brief Get fabric material's Roughness Intensity values.
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE)
@return Fabric material's Roughness Intensity values.
"""
 float GetRoughnessValueIntensity(unsigned int _colorwayIndex, int _index, int _face)
/// @brief Get fabric material's Roughness Intensity values.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE)
/// @return Fabric material's Roughness Intensity values.
  • python
  • c++
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.
"""
 float GetRoughnessValueMapIntensity(int _index, int _face)
/// @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.
  • python
  • c++
def GetRoughnessValueMapIntensity(_colorwayIndex : int, _index : int, _face : int) -> int
"""
@brief Get fabric material's map type roughness intensity values.
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE)
@return Fabric material's map type roughness Intensity values.
"""
 float GetRoughnessValueMapIntensity(unsigned int _colorwayIndex, int _index, int _face)
/// @brief Get fabric material's map type roughness intensity values.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE)
/// @return Fabric material's map type roughness Intensity values.
  • python
  • c++
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.
"""
 SetRoughnessValueMapIntensity(int _index, int _face, int _value)
/// @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.
  • python
  • c++
def SetRoughnessValueMapIntensity(_colorwayIndex : int, _index : int, _face : int, _value : int) -> None
"""
@brief Set fabric material's map type roughness intensity values.
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _value : intensity value to be set.
"""
 SetRoughnessValueMapIntensity(unsigned int _colorwayIndex, int _index, int _face, int _value)
/// @brief Set fabric material's map type roughness intensity values.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), _value : intensity value to be set.
  • python
  • c++
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.
"""
 bool IsRoughnessValueMapInvert(int _index, int _face)
/// @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.
  • python
  • c++
def IsRoughnessValueMapInvert(_colorwayIndex : int, _index : int, _face : int) -> bool
"""
@brief Return whether roughness map is inverted.
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE)
@Return whether roughness map is inverted.
"""
 bool IsRoughnessValueMapInvert(unsigned int _colorwayIndex, int _index, int _face)
/// @brief Return whether roughness map is inverted.
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE)
/// @Return whether roughness map is inverted.
  • python
  • c++
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.
"""
 bool SetRoughnessValueMapInvert(int _index, int _face, bool _bInvert)
/// @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.
  • python
  • c++
def SetRoughnessValueMapInvert(_colorwayIndex : int, _index : int, _face : int, _bInvert : bool) -> None
"""
@brief SetS whether roughness map is inverted
@param _colorwayIndex: target colorway index in the Colorway Editor
@parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), bInvert : Whether roughness map is inverted.
"""
 bool SetRoughnessValueMapInvert(unsigned int _colorwayIndex, int _index, int _face, bool _bInvert)
/// @brief SetS whether roughness map is inverted
/// @param _colorwayIndex: target colorway index in the Colorway Editor
/// @parm _index: Fabric Index, _face : target material Face Type (0 : Front , 1 : BACK , 2 : SIDE), bInvert : Whether roughness map is inverted.
  • python
  • c++
def SetPBRMaterialDisplacementMap(_fabricIndex : int, _path : str) -> rtual 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.
"""
 bool SetFabricDisplacementMap(unsigned int _fabricIndex, const std::string &path)
/// @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.
  • python
  • c++
def SetPBRMaterialDisplacementMap(_colorwayIndex : int, _fabricIndex : int, _path : str) -> bool
"""
@brief Set fabric's displacement map using given image path.
@parm _colorwayIndex: index of colorway
@parm _fabricIndex: index of fabric
@parm _path: path of the image file
@Return true if succeed, false othrewise.
"""
 bool SetFabricDisplacementMap(unsigned int _colorwayIndex, unsigned int _fabricIndex, const std::string& _path)
/// @brief Set fabric's displacement map using given image path.
/// @parm _colorwayIndex: index of colorway
/// @parm _fabricIndex: index of fabric
/// @parm _path: path of the image file
/// @Return true if succeed, false othrewise.
  • python
  • c++
def GetPBRMaterialDisplacementMapValue(_fabricIndex : int) -> rtual 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.
"""
 std::tuple<float, float, float, float, bool> GetPBRMaterialDisplacementMapValue(unsigned int _fabricIndex)
/// @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.
  • python
  • c++
def GetPBRMaterialDisplacementMapValue(_colorwayIndex : int, _fabricIndex : int) -> tuple[float, float, float, float, bool]
"""
@brief Get fabric's displacement map values.
@parm _colorwayIndex: _colorwayIndex: index of colorway
@parm _fabricIndex: index of fabric
@Return [Amount, Shift, Clipping, Particle Distance, Keep(bool)] tuple if succeed, [0, 0, 0, 0, false] otherwise.
"""
 std::tuple<float, float, float, float, bool> GetPBRMaterialDisplacementMapValue(unsigned int _colorwayIndex, unsigned int _fabricIndex)
/// @brief Get fabric's displacement map values.
/// @parm _colorwayIndex: _colorwayIndex: index of colorway
/// @parm _fabricIndex: index of fabric
/// @Return [Amount, Shift, Clipping, Particle Distance, Keep(bool)] tuple if succeed, [0, 0, 0, 0, false] otherwise.
  • python
  • c++
def SetPBRMaterialDisplacementMapValue(_fabricIndex : int, _amount : float, _shift : float, _clipping : float, _particleDist : float, _keep : bool) -> rtual 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.
"""
 bool SetPBRMaterialDisplacementMapValue(unsigned int _fabricIndex, float _amount, float _shift, float _clipping, float _particleDist, bool _keep)
/// @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.
  • python
  • c++
def SetPBRMaterialDisplacementMapValue(_colorwayIndex : int, _fabricIndex : int, _amount : float, _shift : float, _clipping : float, _particleDist : float, _keep : bool) -> bool
"""
@brief Set fabric's displacement map values.
@parm _colorwayIndex: index of colorway
@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.
"""
 bool SetPBRMaterialDisplacementMapValue(unsigned int _colorwayIndex, unsigned int _fabricIndex, float _amount, float _shift, float _clipping, float _particleDist, bool _keep)
/// @brief Set fabric's displacement map values.
/// @parm _colorwayIndex: index of colorway
/// @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.
  • python
  • c++
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
"""
 GetReflectionRoughness(int _fabricIndex, int _materialFace)
/// @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
  • python
  • c++
def GetReflectionRoughness(_colorwayIndex : int, fabricIndex : int, _materialFace : int) -> float
"""
@brief Get reflection roughness value
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@return reflection roughness value
"""
 GetReflectionRoughness(unsigned int _colorwayIndex, int fabricIndex, int _materialFace)
/// @brief Get reflection roughness value
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the object browser
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @return reflection roughness value
  • python
  • c++
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
"""
 SetReflectionRoughness(int _fabricIndex, int _materialFace, float _reflectionRoughness)
/// @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
  • python
  • c++
def SetReflectionRoughness(_colorwayIndex : int, fabricIndex : int, _materialFace : int, _reflectionRoughness : float) -> None
"""
@brief Set reflection roughness value
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@param _reflectionRoughness roughness value
@return void
"""
 SetReflectionRoughness(unsigned int _colorwayIndex, int fabricIndex, int _materialFace, float _reflectionRoughness)
/// @brief Set reflection roughness value
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the object browser
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @param _reflectionRoughness roughness value
/// @return void
  • python
  • c++
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
"""
 GetReflectionIntensity(int _fabricIndex, int _materialFace)
/// @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
  • python
  • c++
def GetReflectionIntensity(_colorwayIndex : int, fabricIndex : int, _materialFace : int) -> float
"""
@brief Get reflection intensity
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@return reflection intensity value
"""
 GetReflectionIntensity(unsigned int _colorwayIndex, int fabricIndex, int _materialFace)
/// @brief Get reflection intensity
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the object browser
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @return reflection intensity value
  • python
  • c++
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
"""
 SetReflectionIntensity(int _fabricIndex, int _materialFace, float _reflectionIntensity)
/// @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
  • python
  • c++
def SetReflectionIntensity(_colorwayIndex : int, fabricIndex : int, _materialFace : int, _reflectionIntensity : float) -> None
"""
@brief Set reflection intensity
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@param _reflectionIntensity: reflection intensity value
@return void
"""
 SetReflectionIntensity(unsigned int _colorwayIndex, int fabricIndex, int _materialFace, float _reflectionIntensity)
/// @brief Set reflection intensity
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the object browser
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @param _reflectionIntensity: reflection intensity value
/// @return void
  • python
  • c++
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
"""
 GetMetalness(int _fabricIndex, int _materialFace)
/// @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
  • python
  • c++
def GetMetalness(_colorwayIndex : int, fabricIndex : int, _materialFace : int) -> float
"""
@brief Get metalness
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@return metalness value
"""
 GetMetalness(unsigned int _colorwayIndex, int fabricIndex, int _materialFace)
/// @brief Get metalness
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the object browser
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @return metalness value
  • python
  • c++
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
"""
 SetMetalness(int _fabricIndex, int _materialFace, float _metalness)
/// @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
  • python
  • c++
def SetMetalness(_colorwayIndex : int, fabricIndex : int, _materialFace : int, _metalness : float) -> None
"""
@brief Set metalness
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@param _metalness: metalness value
@return void
"""
 SetMetalness(unsigned int _colorwayIndex, int fabricIndex, int _materialFace, float _metalness)
/// @brief Set metalness
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the object browser
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @param _metalness: metalness value
/// @return void
  • python
  • c++
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
"""
 GetNormalMapIntensity(int _fabricIndex, int _materialFace)
/// @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
  • python
  • c++
def GetNormalMapIntensity(_colorwayIndex : int, fabricIndex : int, _materialFace : int) -> float
"""
@brief Get normal map intensity in percent
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@return normal map intensity value
"""
 GetNormalMapIntensity(unsigned int _colorwayIndex, int fabricIndex, int _materialFace)
/// @brief Get normal map intensity in percent
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the object browser
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @return normal map intensity value
  • python
  • c++
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
"""
 SetNormalMapIntensity(int _fabricIndex, int _materialFace, float _normalMapIntensity)
/// @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
  • python
  • c++
def SetNormalMapIntensity(_colorwayIndex : int, fabricIndex : int, _materialFace : int, _normalMapIntensity : float) -> None
"""
@brief Set normal map intensity in percent
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the object browser
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@param _normalMapIntensity: normal map intensity value
@return void
"""
 SetNormalMapIntensity(unsigned int _colorwayIndex, int fabricIndex, int _materialFace, float _normalMapIntensity)
/// @brief Set normal map intensity in percent
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the object browser
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @param _normalMapIntensity: normal map intensity value
/// @return void
  • python
  • c++
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
"""
 GetMaterialType(int _fabricIndex, int _materialFace)
/// @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
  • python
  • c++
def GetMaterialType(_colorwayIndex : int, _fabricIndex : int, _materialFace : int) -> int
"""
@brief Get material type
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the Colorway Editor
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@return material type
"""
 GetMaterialType(int _colorwayIndex, int _fabricIndex, int _materialFace)
/// @brief Get material type
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the Colorway Editor
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @return material type
  • python
  • c++
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
"""
 SetMaterialType(int _fabricIndex, int _materialFace, int _materialType)
/// @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
  • python
  • c++
def SetMaterialType(_colorwayIndex : int, _fabricIndex : int, _materialFace : int, _materialType : int) -> None
"""
@brief Set materal type
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the Colorway Editor
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@param _normalMapIntensity: normal map intensity value
@return void
"""
 SetMaterialType(int _colorwayIndex, int _fabricIndex, int _materialFace, int _materialType)
/// @brief Set materal type
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the Colorway Editor
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @param _normalMapIntensity: normal map intensity value
/// @return void
  • python
  • c++
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
"""
 GetOpacityIntensity(int _fabricIndex, int _materialFace)
/// @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
  • python
  • c++
def GetOpacityIntensity(_colorwayIndex : int, _fabricIndex : int, _materialFace : int) -> float
"""
@brief Get opacity intensity in percent
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the Colorway Editor
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@return opaicty intensity value
"""
 GetOpacityIntensity(int _colorwayIndex, int _fabricIndex, int _materialFace)
/// @brief Get opacity intensity in percent
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the Colorway Editor
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @return opaicty intensity value
  • python
  • c++
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
"""
 SetOpacityIntensity(int _fabricIndex, int _materialFace, float _normalMapIntensity)
/// @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
  • python
  • c++
def SetOpacityIntensity(_colorwayIndex : int, _fabricIndex : int, _materialFace : int, _opacityIntensity : float) -> None
"""
@brief Set opaicty intensity in percent
@parm _colorwayIndex: index of colorway
@param _fabricIndex: the target fabric index in the Colorway Editor
@param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
@param _opacityIntensity: opaicty intensity value
@return void
"""
 SetOpacityIntensity(int _colorwayIndex, int _fabricIndex, int _materialFace, float _opacityIntensity)
/// @brief Set opaicty intensity in percent
/// @parm _colorwayIndex: index of colorway
/// @param _fabricIndex: the target fabric index in the Colorway Editor
/// @param _materialFace: the target material index in the property editor. 0: "Front", 1: "Back", 2: "Side"
/// @param _opacityIntensity: opaicty intensity value
/// @return void

PATTERN_API

  • python
  • c++
def GetPatternSize() -> int
"""
@brief Get the number of patterns
@return return the number of patterns on the pattern editor and avatar window
"""
 GetPatternSize()
/// @brief Get the number of patterns
/// @return return the number of patterns on the pattern editor and avatar window
  • python
  • c++
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
"""
 GetPatternIndex(const string& patternName)
/// @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
  • python
  • c++
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
"""
 GetPatternIndexW(const wstring& patternName)
/// @brief Get the pattern index which is using the pattern name
/// @param patternName: the pattern name to get the pattern index
/// @return pattern index
  • python
  • c++
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
"""
 GetPatternInformation(int patternIndex)
/// @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
  • python
  • c++
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
"""
 GetPatternInformationW(int patternIndex)
/// @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
  • python
  • c++
def GetPatternCount() -> int
"""
@brief Get the number of patterns
@return return the number of patterns on the pattern editor and avatar window
"""
 GetPatternCount()
/// @brief Get the number of patterns
/// @return return the number of patterns on the pattern editor and avatar window
  • python
  • c++
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
"""
 GetPatternInputInformation(int patternIndex)
/// @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
  • python
  • c++
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
"""
 GetPatternInputInformationW(int patternIndex)
/// @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
  • python
  • c++
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
"""
 GetPatternInputInformation()
/// @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
  • python
  • c++
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
"""
 GetPatternInputInformationW()
/// @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
  • python
  • c++
def GetPatternPieceArea(_patternIndex : int) -> float
"""
@brief Get the pattern piece area which is using for pattern index
@return return pattern piece
"""
 GetPatternPieceArea()
/// @brief Get the pattern piece area which is using for pattern index
/// @return return pattern piece
  • python
  • c++
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
"""
 GetLineLength()
/// @brief Get the pattern line length which is using for pattern index and line index
/// @return return line length
  • python
  • c++
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
"""
 GetLineLengthForInnerShape()
/// @brief Get the pattern line length which is using for pattern index and children shape index and line index
/// @return return line length
  • python
  • c++
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.
"""
 GetParticleDistanceOfPattern(int _patternIndex)
/// @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.
  • python
  • c++
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.
"""
 GetParticleDistanceOfPattern(const string& _patternName)
/// @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.
  • python
  • c++
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.
"""
 GetParticleDistanceOfPatternW(const wstring& _patternName)
/// @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.
  • python
  • c++
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
"""
 GetMeshCountByType(int _patternIndex)
/// @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
  • python
  • c++
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
"""
 GetMeshCountByType(const string& _patternName)
/// @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
  • python
  • c++
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
"""
 GetMeshCountByTypeW(const wstring& _patternName)
/// @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
  • python
  • c++
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
"""
 GetShrinkagePercentage(int _patternIndex)
/// @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
  • python
  • c++
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
"""
 GetShrinkagePercentage(const string& _patternName)
/// @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
  • python
  • c++
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
"""
 GetShrinkagePercentageW(const wstring& _patternName)
/// @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
  • python
  • c++
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
"""
 GetBoundingBoxOfPattern()
/// @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
  • python
  • c++
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
"""
 GetBoundingBoxOfPattern(int _patternIndex)
/// @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
  • python
  • c++
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
"""
 GetBoundingBoxOfPattern(const string& _patternName)
/// @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
  • python
  • c++
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
"""
 GetBoundingBoxOfPatternW(const wstring& _patternName)
/// @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
  • python
  • c++
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
"""
 SetParticleDistanceOfPattern(int _patternIndex, float _length)
/// @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
  • python
  • c++
def SetParticleDistanceOfPatterns(_length : float) -> None
"""
@brief Set patterns particle distance using length
@param length: the length value to determine particle distance
"""
 SetParticleDistanceOfPatterns()
/// @brief Set patterns particle distance using length
/// @param length: the length value to determine particle distance
  • python
  • c++
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
"""
 SetMeshType(int _patternIndex, const string& _meshType)
/// @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
  • python
  • c++
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
"""
 SetMeshType(int _patternIndex, const wstring& _meshType)
/// @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
  • python
  • c++
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
"""
 SetWidthShrinkagePercentage (int _patternIndex, float _width)
/// @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
  • python
  • c++
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
"""
 SetHeightShrinkagePercentage (int _patternIndex, float _height)
/// @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
  • python
  • c++
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
"""
 GetArrangementList()
/// @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
  • python
  • c++
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
"""
 GetArrangementOfPattern()
/// @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
  • python
  • c++
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
"""
 GetArrangementOfPattern(int _patternIndex)
/// @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
  • python
  • c++
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
"""
 GetArrangementOfPattern(const string& _patternName)
/// @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
  • python
  • c++
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
"""
 GetArrangementOfPatternW(const wstring& _patternName)
/// @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
  • python
  • c++
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
"""
 SetArrangementShapeStyle(int _patternIndex, const string& _shapeStyle)
/// @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
  • python
  • c++
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
"""
 SetArrangementShapeStyleW(int _patternIndex, const wstring& _shapeStyle)
/// @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
  • python
  • c++
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
"""
 SetArrangementPosition(int _patternIndex, int _positionX, int _positionY, int _offset)
/// @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
  • python
  • c++
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
"""
 SetArrangementOrientation(int _patternIndex, int _orientation)
/// @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
  • python
  • c++
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
"""
 SetArrangement(int _patternIndex, int _arrangementIndex)
/// @brief Set Arrangement using arrangementlist Index
/// @param              patternIndex: the pattern index to set the arrangement
ArrangementIndex: the value to determine arrangement information
  • python
  • c++
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
"""
 CopyPatternPiecePos(int _patternPieceIndex, float _x, float _y)
/// @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
  • python
  • c++
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
"""
 CopyPatternPiecePos(int _patternPieceIndex, float _offsetX, float _offsetY)
/// @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
  • python
  • c++
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
"""
 DeletePatternPiece(int _patternPieceIndex)
/// @brief Delete Pattern using the pattern index
/// @param              patternIndex: the pattern index for delete pattern
/// @return return copy pattern index
  • python
  • c++
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
"""
 DeletePatternPiece(int _patternPieceIndex)
/// @brief Delete Pattern using the pattern index
/// @param              patternIndex: the pattern index for delete pattern
/// @param              lineIndex: the line index for delete line
  • python
  • c++
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
"""
 DeletePatternPiece(int _patternPieceIndex)
/// @brief Delete Pattern using the pattern index
/// @param              patternIndex: the pattern index for delete pattern
/// @param              poinIndex: the point index for delete point
  • python
  • c++
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
"""
 FlipPatternPiece(int _patternIndex, bool _bHorizontally, bool _bEach)
/// @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
  • python
  • c++
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
"""
 LayerClonePatternPiecePos(int _patternIndex, float _x, float _y, bool _bUnder)
/// @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
  • python
  • c++
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
"""
 LayerClonePatternPiecePos(int _patternIndex, float _offsetX, float _offsetY, bool _bUnder)
/// @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
  • python
  • c++
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,
"""
 OffsetAsInternalLine(int _patternIndex, int _lineIndex, int _number, float _distance, bool _bReverse, bool _bDirection, bool _bExtend)
/// @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,
  • python
  • c++
def UnfoldPatternPiece(_patternIndex : int, _lineIndex : int, _bHalfSymmetry : bool) -> None
"""
@brief Unfold Pattern using the pattern index and line index and halfSymmetry option
@param          patternIndex: the pattern index for delete pattern
lineIndex: the line index for unfold line
halfSymmetry: the value to make halfSymmetry pattern
"""
 UnfoldPatternPiece(int _patternIndex, int _lineIndex, bool _bHalfSymmetry)
/// @brief Unfold Pattern using the pattern index and line index and halfSymmetry option
/// @param              patternIndex: the pattern index for delete pattern
lineIndex: the line index for unfold line
halfSymmetry: the value to make halfSymmetry pattern
  • python
  • c++
def GetPatternPieceName(_patternIndex : int) -> str
"""
@brief Get Pattern name using the pattern index
@param          _patternIndex: the pattern index for get name
"""
 GetPatternPieceName(int _patternIndex)
/// @brief Get Pattern name using the pattern index
/// @param              _patternIndex: the pattern index for get name
  • python
  • c++
def SetPatternPieceName(_patternIndex : int, _patternName : str) -> None
"""
@brief Set Pattern name using the pattern index
@param          _patternIndex: the pattern index to set
_patternName: the value to set as pattern name
"""
 SetPatternPieceName(int _patternIndex)
/// @brief Set Pattern name using the pattern index
/// @param              _patternIndex: the pattern index to set
_patternName: the value to set as pattern name
  • python
  • c++
def GetPatternPieceFabricIndex(_patternPieceIndex : int) -> int
"""
@brief Get Pattern fabric index using the pattern index
@param          _patternIndex: the pattern index to get
"""
 GetPatternPieceFabricIndex(int _patternIndex)
/// @brief Get Pattern fabric index using the pattern index
/// @param              _patternIndex: the pattern index to get
  • python
  • c++
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
"""
 SetPatternPieceFabricIndex(int _patternPieceIndex, int _fabricIndex)
/// @brief Set Pattern fabric index using the pattern index
/// @param              _patternIndex: the pattern index to set
_fabricIndex: the value to set as gabric index
  • python
  • c++
def GetPatternPieceGrainDirection(_patternPieceIndex : int) -> float
"""
@brief Get Pattern Grain direction info using the pattern index
@param          _patternIndex: the pattern index to get
"""
 GetPatternPieceGrainDirection(int _patternPieceIndex)
/// @brief Get Pattern Grain direction info using the pattern index
/// @param              _patternIndex: the pattern index to get
  • python
  • c++
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
"""
 SetPatternPieceGrainDirection(int _patternPieceIndex, float _degree)
/// @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
  • python
  • c++
def IsPatternPieceGrainLinkAllColorways(_patternPieceIndex : int) -> bool
"""
@brief Check if Pattern link all color ways value using the pattern index
@param          _patternIndex: the pattern index to set
"""
 IsPatternPieceGrainLinkAllColorways(int patternPieceIndex)
/// @brief Check if Pattern link all color ways value using the pattern index
/// @param              _patternIndex: the pattern index to set
  • python
  • c++
def SetPatternPieceGrainLinkAllColorways(_patternPieceIndex : int, _isOn : bool) -> None
"""
@brief Set Pattern link all color ways value using the pattern index
@param          _patternIndex: the pattern index to set
_isOn: the value to set as link all color ways
"""
  SetPatternPieceGrainLinkAllColorways(int _patternPieceIndex, bool _isOn)
/// @brief Set Pattern link all color ways value using the pattern index
/// @param              _patternIndex: the pattern index to set
_isOn: the value to set as link all color ways
  • python
  • c++
def GetPatternPieceCategory(_patternPieceIndex : int) -> int
"""
@brief Get Pattern category number using the pattern index
@param          _patternPieceIndex: the pattern index to get
"""
 GetPatternPieceCategory(int _patternPieceIndex)
/// @brief Get Pattern category number using the pattern index
/// @param              _patternPieceIndex: the pattern index to get
  • python
  • c++
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
"""
 SetPatternPieceCategory(int _patternPieceIndex, int _category)
/// @brief Set Pattern category number using the pattern index
/// @param              _patternPieceIndex: the pattern index to get
_category: the value to set category value
  • python
  • c++
def GetPatternPieceClassification(_patternPieceIndex : int) -> str
"""
@brief Get Pattern classification using the pattern index
@param          _patternPieceIndex: the pattern index to get
"""
 GetPatternPieceClassification(int _patternPieceIndex)
/// @brief Get Pattern classification using the pattern index
/// @param              _patternPieceIndex: the pattern index to get
  • python
  • c++
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
"""
 SetPatternPieceClassification(int _patternPieceIndex, string _classificatio)
/// @brief Set Pattern classification using the pattern index
/// @param              _patternPieceIndex: the pattern index to get
_classification: the value to set classification
  • python
  • c++
def IsPatternPieceSolidify(_patternPieceIndex : int) -> bool
"""
@brief Check if Pattern Solidify using the pattern index
@param          _patternPieceIndex: the pattern index to get
"""
 IsPatternPieceSolidify(int _patternPieceIndex)
/// @brief Check if Pattern Solidify using the pattern index
/// @param              _patternPieceIndex: the pattern index to get
  • python
  • c++
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
"""
 SetPatternPieceSolidify(int _patternPieceIndex, bool _isOn);
/// @brief Set Pattern Solidify using the pattern index
/// @param              _patternPieceIndex: the pattern index to get
_isOn: the value to set Solidify On/Off
  • python
  • c++
def GetPatternPieceSolidifyStrengthen(_patternPieceIndex : int) -> float
"""
@brief Get Pattern Solidify using the pattern index
@param          _patternPieceIndex: the pattern index to get
"""
 GetPatternPieceSolidifyStrengthen(int _patternPieceIndex)
/// @brief Get Pattern Solidify using the pattern index
/// @param              _patternPieceIndex: the pattern index to get
  • python
  • c++
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
"""
  SetPatternPieceSolidifyStrengthen(int _patternPieceIndex, float _strengthen);
/// @brief Get Pattern Solidify using the pattern index
/// @param              _patternPieceIndex: the pattern index to get
_strengthen : strengthen value to set
  • python
  • c++
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
"""
 ConvertToBaseLine(int _patternIndex, int _childrenIndex)
/// @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
  • python
  • c++