API Option & Type

WELD_TYPE

FULLY_UNWELDED = 0
DEFAULT_WELDED = 1
FULLY_WELDED = 2
SELECTED_WELDED = 3

OBJECT_BROWSER_CATEGORY

OB_FABRIC = 0
OB_BUTTON = 1
OB_TOPSTITCH = 2
OB_TRIM = 3
OB_ZIPPER = 4
OB_GRAPHIC = 5
OB_BUTTONHOLE = 6
OB_PUCKERING = 7

ObjectBrowserResult

success:bool
objectUid:int
message:str

WindControllerOptions

bWindActive:bool
windType:int
strength:float
decay:float
frequency:float
turbulence:float
x:float
y:float
z:float
rotationX:float
rotationY:float
rotationZ:float

AlembicUnit

MEASURE_UNIT_MM:float
MEASURE_UNIT_CM:float
MEASURE_UNIT_INCH:float
MEASURE_UNIT_FEET:float
MEASURE_UNIT_M:float
MEASURE_UNIT_8_FEET:float
MEASURE_UNIT_8_6_FEET:float
MEASURE_UNIT_AUTO:float

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
bSizeAndPoseFromAvatar:bool
bEmbedded:bool
bExportLight:bool
bExportFabric:bool
bSaveColorWaysSingleFile:bool
fbxSdkVersion:int
bIncludeAvatarShape:bool
m_AuthenticationKeyForAPI:str
ImportObjectType:int
bAutoTranslate:bool
bCreateCamera:bool
bCreateAvatarJointAnimation:bool
bCreateAvatarCacheAnimation:bool
bCreateAvatarBlendShapeAnimation:bool
bCreateClothCacheAnimation:bool
bMoveGarment:bool
bAddArrangementPoints:bool
bAutoCreateFittingSuit:bool
bAdd:bool
translationValueX:float
translationValueY:float
translationValueZ:float
bTrace2DPatternsUVMap:bool
bCreateMetallicRoughnessMap:bool
bClothUnifiedUVCoordinates:bool
bAvatarUnifiedUVCoordinates:bool

VideoExportOption

width:int
height:int
fps:int
startFrame:int
endFrame:int

CLO_API_UNIT

CLO_API_MILIMETER = 0
CLO_API_CENTIMETER = 1
CLO_API_INCH = 2
CLO_API_METER = 3
CLO_API_FEET = 4

ImportZPRJOption

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

ImportDxfOption

m_bAppend:bool
m_bAutoScale:bool
m_Scale:float
m_Angle:float
m_bImportPatternAnnotation:bool
m_bAutoTraceAsInternalLines:bool
m_SwapCuttingLineAndSewingLine:bool
m_bIncludeNotchs:bool
m_bAutoDistribute:bool
m_bOptimizeAllCurvePoints:bool
m_bImportAllDrawCurvePoint:bool
m_bRemoveNonGradingPoints:bool
m_bConvertToSeamAllowance:bool
m_bImportNotchTo:bool
m_eNotchImportPlacement:int

RenderImageVideoOptions

m_Colorway:int
m_ImageVideo:int
m_ViewPoint:int
m_ImageCount:int
m_RotationAngle:int
m_RotationAxis:int
m_RotationAxisX:float
m_RotationAxisZ:float
m_RotationDirection:int
m_bTurnTableSaveVideo:bool
m_TotalDuration:float
m_FrameDuration:float
m_bSaveGIF:bool
m_Region:int
m_bAnimationSaveVideo:bool
m_AnimationFPS:float
m_bAnimSaveGIF:bool
m_ImageSize:int
m_Orientation:int
m_Width:float
m_Height:float
m_bMaintainRatio:bool
m_Unit:int
m_Resolution:int
m_ColorHex:str
m_Texture:str
m_bTransparency:bool
m_bBackgroundCrop:bool
m_FileName:str
m_FilePath:str
m_ImageFormat:int
m_VideoFormat:int
m_bPanaromicCustomView:bool
m_bPanaromicColorways:bool
m_bSaveHtml:bool

RenderPropertyOptions

m_RenderEngineType:int
m_bCPUSupporting:bool
m_bLowGPUPriority:bool
m_NoiseThreshold:float
m_MaxRenderTime:int
m_SeamPuckeringIntensity:float
m_LightQuality:int
m_MaterialQuality:int
m_bKnitWearFrustumCulling:bool
m_bKnitWearLOD:bool
m_ColorMappingType:int
m_BurnValue:float
m_bLinearWorkFlow:bool
m_ImageFilterSize:float

ExportDxfOption

m_bDuplicateNotch:bool
m_bCheckedConvertCtoS:bool
m_bExportWithoutGrading:bool
m_bOptimizeCurvePoints:bool
m_bExportWithoutBaselines:bool
m_bExportSelectedPatterns:bool
m_ExportDXFFormatType:int
m_ExportBBType:int
m_fScale:float
m_RotateAngle:float
m_bMetric:bool

ExportUSDOption

m_upAxis:int
m_metersPerUnit:double
m_bAssignAvatar:bool
m_avatarPrimPath:str
m_bAssignGarment:bool
m_garmentPrimPath:str
m_bAssignSceneNProp:bool
m_sceneNPropPrimPath:str
m_bExportSimulationData:bool
m_bExportStrandData:bool

ExportTechPackType

CLO_TECH_PACK = 0
CLO_SET_TECH_PACK = 1
CLO_SET_SREST = 2
CLO_API_TECH_PACK = 3
CLO_DUMMY = 4

ExportTechpackOption

m_bSaveZpac:bool
m_bSaveZprj:bool
m_bCaptureSceneThumbnailWithoutAvatar:bool
m_bCaptureSceneThumbnailWithMark:bool
m_bCaptureSceneThumbnailWithAvatar:bool
m_bCaptureItemThumbnail:bool
m_bCaptureHighResolutionFrontThumbnail:bool
m_bCapturePatternLayoutThumbnail:bool
m_bCapturePatternLayoutThumbnailWithFabricMark:bool
m_bCapturePatternLayoutThumbnailWithTrimMark:bool
m_bCapturePatternLayoutThumbnailForCloset2DPatternWindow:bool
m_bCaptureTurntableThumbnail:bool
m_bExportTextures:bool
m_bUseAverageColor:bool
m_bShowModalProgressBar:bool
m_bUseCustomImageAsThumbnail:bool
m_ShowBaseLineFor3DCapturePerColorway:map[ int, bool]
m_AuthenticationKeyForAPI:str
m_ExportType:ExportTechPackType

CloApiRgb

R:int
G:int
B:int

CloGroundData

index:int
avg_pos:float
r:float
g:float
b:float
y:float

CloApiRgba

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

RenderColorwayType

SINGLE = 0
ALL = 1
USER_DEFINED = 2

AttachFileInfo

fileName:str
filePath:str

MimeData

mimeType:str
mimeNmae:str
mimeValue:str

HttpMethodType

HTTP_GET = 0
HTTP_POST = 1
HTTP_PUT = 2

CloApiRestRequest

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

CloApiRestResponse

header:str
buffer:str
responseCode:int

CloApiGraphicPosition

x:float
y:float

CloApiGraphicDimensions

width:float
height:float

CloApiGraphicPlacementPoints

center:CloApiGraphicPosition
corners:list[CloApiGraphicPosition]
edgeCenters:list[CloApiGraphicPosition]

CleanedPathResult

detected_type:str
universal_clean_path:str
windows_native_path:str
windows_long_path_variant:str
isolated_filename:str
http_safe_filename:str

CloApiAnchorPoint

CLOAPI_ANCHOR_CENTER = 0
CLOAPI_ANCHOR_UP = 1
CLOAPI_ANCHOR_RIGHT_UP = 2
CLOAPI_ANCHOR_RIGHT = 3
CLOAPI_ANCHOR_RIGHT_DOWN = 4
CLOAPI_ANCHOR_DOWN = 5
CLOAPI_ANCHOR_LEFT_DOWN = 6
CLOAPI_ANCHOR_LEFT = 7
CLOAPI_ANCHOR_LEFT_UP = 8

CloApiPoint

x:float
y:float

CloApiLine

lineNumber:int
start:CloApiPoint
end:CloApiPoint

CloApiIntersectionPoint

coordinate:CloApiPoint
lineANumber:int
lineBNumber:int

CloApiInternalShape

name:str
lines:list[CloApiLine]
intersections:list[CloApiIntersectionPoint]

ImportAlembicOption

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

PatternSnapShotPaperPreset

A4:int
A3:int
B5:int
B4:int
Letter:int
Legal:int
Tabloid:int
WideFormat_24:int
WideFormat_36:int
WideFormat_44:int
oneToOne:int
Custom:int

PatternSnapShotPaperUnit

Pixel:int
Inches:int
Milimeters:int
Centimeters:int

PatternSnapShotSizeOption

m_width:float
m_height:float
m_resolution:int
m_paperPreset:int
m_orientation:int
m_unit:int

PatternSnapShotLineType

DefualtLine:int
DottedLine:int
DashedLine:int

PatternSnapShotLineOption

ShowPatternOutline:bool
PatternOutlineColor:CloApiRgba
PatternOutLineType:int
ShowInternalLine:bool
InternalLineColor:CloApiRgba
InternalLineType:int
ShowGraphicOutline:bool
GraphicOutlineColor:CloApiRgba
GraphicOutlineType:int
ShowBaseline:bool
BaselineColor:CloApiRgba
BaselineType:int
ShowNotch:bool
NotchColor:CloApiRgba
NotchType:int
ShowSeamAllowance:bool
SeamAllowanceColor:CloApiRgba
SeamAllowanceType:int
ShowSymmetricInstanceLine:bool
SymmetricInstanceLineColor:CloApiRgba
SymmetricInstanceLineType:int
ShowReferenceLine:bool
ReferenceLineColor:CloApiRgba
ReferenceLineType:int

PatternSnapShotImageOption

ShowFabricTexture:bool
ShowPatternTexture:bool
ShowGraphicTexture:bool
FabricTextureOpacity:float

PatternSnapShotPrintType

ShrinkToFit:int
ActualSize:int

PatternSnapShotInformationOption

ShowPatternName:bool
PatternNameType:int
ShowPatternAnnotation:bool
PatternAnnotationType:int
ShowLineLength:bool
LineLengthType:int
ShowGrainLine:bool
GrainLineType:int
ShowButtonHole:bool
ButtonHoleType:int
ShowSeamTaping:bool
SeamTapingType:int
ShowMeasurement2D:bool
Measurement2DType:int
ShowGradingSizeName:bool
GradingSizeNameType:int
ShowNestInformation:bool
NestInformationType:int

PatternSnapShotColorwayOption

ColorwayOption:int
m_customSelectColorwayIndexes:list[ int]

TextureMapTarget

TEXTURE_MAP_BASE_COLOR = 0
TEXTURE_MAP_NORMAL = 1
TEXTURE_MAP_OPACITY = 2
TEXTURE_MAP_ROUGHNESS = 3
TEXTURE_MAP_METALNESS = 4
TEXTURE_MAP_DISPLACEMENT = 5

ObjectBrowserType

OB_TYPE_FABRIC = 0
OB_TYPE_GRAPHIC = 1
OB_TYPE_TRIM = 2
OB_TYPE_BUTTON = 3
OB_TYPE_BUTTON_HOLE = 4
OB_TYPE_PUCKERING = 5
OB_TYPE_ZIPPER = 6
OB_TYPE_POM = 7
OB_TYPE_GRADING = 8
OB_TYPE_PATTERN = 9
OB_TYPE_TOPSTITCH = 10

ObjectBrowserContextOptions

type:ObjectBrowserType
targetPrint:bool
styleChipIndex:int
subItemIndex:int
folderName:str
bIncludeUnusedObjects:bool
bShowAllColorways:bool
showAllColorways:int
colorwayIndex:int
bIncludePrints:bool

PropertyEditorContextOptions

materialSide:int
mapType:TextureMapTarget

TransformOptions

angle:float
widthMm:float
widthPercent:float
heightMm:float
heightPercent:float
aspectRatioFixed:bool
posX:float
posY:float

ZipperObjectType

ZIPPER_OBJECT_SLIDER = 0
ZIPPER_OBJECT_PULLER = 1
ZIPPER_OBJECT_SLIDER_PULLER = 2
ZIPPER_OBJECT_TEETH = 3
ZIPPER_OBJECT_TOP_STOPPER = 4
ZIPPER_OBJECT_BOTTOM_OPEN_STOPPER = 5
ZIPPER_OBJECT_BOTTOM_CLOSED_STOPPER = 6

ZipperScaleUnit

ZIPPER_SCALE_MM = 0
ZIPPER_SCALE_CM = 1
ZIPPER_SCALE_INCH = 2
ZIPPER_SCALE_FEET = 3
ZIPPER_SCALE_M = 4
ZIPPER_SCALE_8_FEET = 5
ZIPPER_SCALE_8_6_FEET = 6
ZIPPER_SCALE_AUTO = 7

GraphicRemoveMode

GRAPHIC_REMOVE_BROWSER_ONLY = 0
GRAPHIC_REMOVE_PATTERN_ONLY = 1
GRAPHIC_REMOVE_PATTERN_AND_BROWSER = 2

ObjRegisterOptions

objectType:ZipperObjectType
objFilePath:str
secondObjFilePath:str
sliderMeshNames:list[str]
pullerMeshNames:list[str]
scaleUnit:ZipperScaleUnit
scaleValue:double
axisX:int
axisY:int
axisZ:int
invertX:bool
invertY:bool
invertZ:bool
pullerPositionX:float
pullerPositionY:float
pullerPositionZ:float
teethSpace:double
addToObjectBrowser:bool

MaterialMapTransformationOptions

angle:float
width_mm:float
width_percent:float
height_mm:float
height_percent:float
aspect_ratio_on:bool
position_x_mm:float
position_y_mm:float

MaterialBaseColorMapOptions

has_map:bool
image_path:str
recolor_enabled:bool
desaturate_enabled:bool
switch_enabled:bool
shadow_intensity:int
shadow_brightness:int
transformation:MaterialMapTransformationOptions

MaterialBaseColorOptions

color_hex_or_name:str
map:MaterialBaseColorMapOptions

MaterialNormalMapOptions

has_normal_map:bool
image_path:str
intensity:int
transformation:MaterialMapTransformationOptions

MaterialDisplacementMapOptions

has_displacement_map:bool
image_path:str
amount_mm:float
shift_mm:float
clipping_mm:float
particle_distance_mm:float
keep_continuity:bool

MaterialOpacityMapOptions

has_map:bool
image_path:str
mode:str
transformation:MaterialMapTransformationOptions

MaterialOpacityOptions

opacity_value:int
map:MaterialOpacityMapOptions

MaterialRoughnessOptions

type:str
has_map:bool
image_path:str
map_intensity:int
invert:bool

MaterialMetalnessMapOptions

has_map:bool
image_path:str
transformation:MaterialMapTransformationOptions

MaterialReflectionOptions

roughness:MaterialRoughnessOptions
reflection_intensity:int
metalness:int
metalness_map:MaterialMetalnessMapOptions

MaterialFaceOptions

texture_mapping:str
type:str
base_color:MaterialBaseColorOptions
normal_map:MaterialNormalMapOptions
displacement_map:MaterialDisplacementMapOptions
opacity:MaterialOpacityOptions
reflection:MaterialReflectionOptions
base_color.map:MaterialBaseColorMapOptions GetBaseColorMap()     { return
normal_map:MaterialNormalMapOptions GetNormalMap()        { return
displacement_map:MaterialDisplacementMapOptions GetDisplacementMap()  { return
opacity.map:MaterialOpacityMapOptions GetOpacityMap()       { return
reflection.roughness:MaterialRoughnessOptions GetRoughnessMap()     { return
reflection.metalness_map:MaterialMetalnessMapOptions GetMetalnessMap()     { return

MaterialTargetComponent

COMPONENT_FRONT = 0
COMPONENT_BACK = 1
COMPONENT_SIDE = 2
COMPONENT_BUTTON = 3
COMPONENT_THREAD = 4
COMPONENT_NONE = -1

MaterialContextOptions

targetComponent:MaterialTargetComponent
textureMappingType:int
printType:int
materialType:str

MaterialPropertyOptions

contextOptions:MaterialContextOptions
material_type:str
front:MaterialFaceOptions
back:MaterialFaceOptions
side:MaterialFaceOptions
physical_type:str
physical_preset:str
physical_thickness_mm:float
contextOptions:MaterialContextOptions GetContext()  { return
front:MaterialFaceOptions GetFrontFaceOptions()  { return
back:MaterialFaceOptions GetBackFaceOptions()   { return
side:MaterialFaceOptions GetSideFaceOptions()   { return

CloApiAvatarMeasurement

measurementName:str
measurementType:str
value:float
basicLength:float
surfaceLength:float
unit:str