ApiTypes

API Option Types

Marvelous Designer API provides several Option Type classes that allow you to control various Import and Export behaviors. Each Option Type contains detailed parameters required for specific operations such as Import, Export, ZPRJ, or USD.

Option Usage Example

To use API options, set them as follows:

import ApiTypes

# Create ImportExportOption instance
option = ApiTypes.ImportExportOption()

# Enable garment export
option.bExportGarment = True

# Enable unified texture baking
option.bCreateUnifiedTexture = True

# Export as a single object
option.bSingleObject = True

# Adjust scale
option.scale = 1.0

# Example: apply the option when exporting
import export_api
export_api.ExportOBJ("C:/output/file.obj", option)

ImportExportOption

bExportGarment:bool
bExportAvatar:bool
bSingleObject:bool
weldType:WELD_TYPE
bThin:bool
bUnifiedUVCoordinates:bool
bCreateUnifiedTexture:bool
unifiedTextureSize:float
unifiedTextureFillSeamSize:int
bUseInifinteSeams:bool
unifiedTextureBakeMargin:float
unifiedTextureBakeRelateive:bool
bUnifiedDiffuseMap:bool
bUnifiedNormalMap:bool
bUnifiedMetalnessMap:bool
bUnifiedRoughnessMap:bool
bUnifiedOpacityMap:bool
bUnifiedDisplacementMap:bool
bIncludeHiddenObject:bool
bIncludeInnerShape:bool
scale:float
axisX:int
axisY:int
axisZ:int
bInvertX:bool
bInvertY:bool
bInvertZ:bool
bSaveColorWays:bool
bSaveInZip:bool
bDiffuseColorCombined:bool
bExcludeAmbient:bool
bOpacityMap:bool
bMetaData:bool
bEmbedded:bool
bExportLight:bool
bExportFabric:bool
bExportAnimation:bool
bSaveColorWaysSingleFile:bool
m_AuthenticationKeyForAPI:str
ImportObjectType:int
bAutoTranslate:bool
bCreateCamera:bool
bCreateAnimation:bool
bCreateCacheAnimation:bool
bMoveGarment:bool
bAddArrangementPoints:bool
bAutoCreateFittingSuit:bool
bAdd:bool
translationValueX:float
translationValueY:float
translationValueZ:float
bTrace2DPatternsUVMap:bool
bCreateMetallicRoughnessMap:bool

ImportZPRJOption

bAppend:bool
bLoadGarment:bool
bLoadAvatar:bool
translationValueX:float
translationValueY:float
translationValueZ:float
bLoadSceneAndProps:bool
bLoadRenderProperties:bool
bLoadCustomView:bool

ImportUSDOption

m_upAxis:int
m_metersPerUnit:double
m_bAssignShape:bool
m_shapePrimPath:str
m_bAssignMaterial:bool
m_materialPrimPath:str
m_bExportSimulationData:bool

ImportAlembicOption

aLoadType:bool
aScale:float
boolAddArrangementPoints:bool
boolAutoCreateFittingSuit:bool
morphingFrameCount:int
boolMoveGarmentToStartPosition:bool
boolTrace2DPatternsFromUVMap:bool
boolAlignBottonToGround:bool
translationValueX:float
translationValueY:float
translationValueZ:float

ApiRgb

R:int
G:int
B:int

ApiRgba

R:int
G:int
B:int
A:int

AttachFileInfo

fileName:str
filePath:str

MimeData

mimeType:str
mimeNmae:str
mimeValue:str

ApiRestRequest

header:list[std::pair[str, str]]
method:HttpMethodType
payload:str
url:str
attachements:list[AttachFileInfo]
formData:list[MimeData]

ApiRestResponse

header:str
buffer:str
responseCode:int

ApiGraphicDimensions

width:float
height:float