Change log
[3.29.0]
Changed
BwApiSnapshotInfoGet - Added avatar_type property.
[3.28.0]
Changed
BwApiSettingsGet / BwApiSettingsUpdate - Add support for the session-only `high_precision_textures_3d` rendering setting.
[3.26.0]
Added
BwApiMaterialTrim3d - Checks if a material is a Trim 3D material or not.
BwApiMaterialTrim3dSectionsCount - Gets the amount of sections in Trim 3D.
BwApiMaterialTrim3dSectionNameGet - Gets the name of section in Trim 3D.
BwApiMaterialTrim3dSectionDiffuseColorGet - Gets the diffuse color of section in Trim 3D.
BwApiMaterialTrim3dSectionDiffuseColorSet - Sets the diffuse color of section in Trim 3D.
BwApiMaterialGroupItemTrim3d - Checks if a material in the group is a Trim 3D.
BwApiMaterialGroupItemTrim3dSectionsCount - Gets the amount of sections in Trim 3D of the material in a group.
BwApiMaterialGroupItemTrim3dSectionNameGet - Gets the name of the section in Trim 3D of the material in the group.
BwApiMaterialGroupItemTrim3dSectionDiffuseColorGet - Gets the deiffuse color of the section in Trim 3D of the material in the group.
BwApiMaterialGroupItemTrim3dSectionDiffuseColorSet - Sets the deiffuse color of the section in Trim 3D of the material in the group.
BwApiOutfitGet - Get if loaded garment is an Outfit
Changed
BwApiGarmentSaveAs - Update the garment save as function to support .vsgx files.
[3.25.0]
Added
BwApiPrintLayoutWidthGet - Get Print Layout width.
BwApiPrintLayoutLengthGet- Get Print Layout length.
BwApiPrintLayoutWidthSet - Set Print Layout width.
BwApiPrintLayoutLengthSet - Set Print Layout length.
BwApiPrintLayoutInfoDelete - Reset Print Layout info.
BwApiPrintLayoutPiecePositionGet - Get Print Layout shape position.
BwApiPrintLayoutPieceRotationGet - Get Print Layout shape rotation.
BwApiPrintLayoutPiecePositionSet - Set Print Layout shape position.
BwApiPrintLayoutPieceRotationSet - Set Print Layout shape rotation.
BwApiPrintLayoutApply - Apply automatic layout.
[3.24.0]
Added
BwApiGarmenIdsHistoryGet - Get the history of garment ids as Json string
Fixed
Fix issue with BwInternalLineType where BW_API_INTERNAL_LINE_TYPE_CUTMARK enum flag
Changed
BwApiRenderExport3DObject - Add specular extension support for gltf/glb export
BwApiRenderExport3DObject - Add support for v-ray displacement quality.
BwApiRenderImage - Add support for v-ray displacement quality and texture map dpi.
BwApiRenderRayTrace - Add support for v-ray displacement quality and texture map dpi.
[3.23.0]
Added
BwApiMaterialImportEx - Add support for importing with extra options
[3.22.0]
Changed
BwApiEdgePropertiesGet - Add support for grid refinement properties.
BwApiEdgePropertiesSet - Add support for grid refinement properties.
BwApiLinePropertiesGet - Add support for grid refinement properties.
BwApiLinePropertiesSet - Add support for grid refinement properties.
BwApiLineCreateAsPolyline - Add support for grid refinement properties.
BwApiLineCreateAsBezier - Add support for grid refinement properties.
BwApiRenderImage - Add support for new schematic rendering parameters.
[3.21.0]
Changed
BwApiMaterialContainerCreate - transformation is now relative from (0, 0).
BwApiGarmentExportEx_v2 - added dxf_format setting to export in astm dxf format.
Added
BwApiAvatarJointIds - Get the list of joint IDs of the current avatar pose.
BwApiAvatarJointPropertiesGet - Get the properties of a joint of the current avatar pose.
BwApiAvatarJointPropertiesUpdate - Set the properties of a joint of the current avatar pose.
BwApiShoesIds - Get the list of shoes ids in the system.
BwApiShoesGetAvatars - Get the ids of the avatars that configured by a certain shoes.
BwApiShoesWear - Wear shoes.
BwApiShoesCurrentRemove - Remove shoes from 3d.
BwApiShoesCurrentShow - Show shoes on 3d.
BwApiShoesCurrentHide - Hide shoes from 3d.
BwApiShoesGetCurrentTransformation - Get the current transformation of the left or right shoe.
BwApiShoesSetCurrentTransformation - Set the current transformation of the left or right shoe.
[3.20.0]
Changed
BwApiLineMaterialIdSet - Support removing a material.
BwApiShapeMaterialIdSet - Support removing a material.
BwApiLineMaterialIdSet - Support removing a material.
Added
BwApiOutfitCreate - Create a new outfit.
BwApiOutfitReadGarmentProperties - Get the properties of garment to be used for outfit creation.
BwApiAvatarExportVSA - Added support to export avatars as vsa
BwApiMaterialNameGet - Return the name of the material
BwApiMaterialModeGet - Return the mode of the material
BwApiRenderExport3DObject - Added option to separate garment details.
[3.18.0]
Changed
BwApiPleatVertexPositionGet - Support knife pleat as well.
BwApiPleatVertexPositionSet - Support knife pleat as well.
BwApiEdgePropertiesGet - Get edge's properties.
BwApiEdgePropertiesSet - Set edge's properties.
[3.17.0]
Deprecated
BwApiRenderExport3DObject - Bwo is no longer supported in any version.
Added
BwApiLineFillMaterialIdGet - Get line's fill material.
BwApiLineFillMaterialIdSet - Set line's fill material.
BwApiEnvironmentLightSetDefault - Set Default HDRI Light.
BwApiEnvironmentLightLoadDefault - Load Default HDRI Light.
BwApiEnvironmentLightImport - Import HDRI Light from file.
BwApiEnvironmentLightDelete - Delete imported HDRI Light.
Changed
BwApiEdgePropertiesGet - Get edge's properties.
BwApiEdgePropertiesSet - Set edge's properties.
BwApiGarmentDressEx - Added simulationInfo parameters: 'symmetric_simulation' & 'symmetric_sim_strong'.
Removed
BwApiEdgeForceMultipllerPropertiesGet
BwApiEdgeForceMultipllerPropertiesSet
[3.16.0]
Added
BwApiMaterialContainerAutoPositionsGet - Get if MaterialContainer positions are linked (by group)
BwApiMaterialContainerAutoPositionsSet - Set if MaterialContainer positions are linked (by group)
BwApiClusterShapeOffsetGetEx - Given existing shape id and size id return cluster offset.
BwApiClusterShapeOffsetSetEx - Given existing shape id and size id set cluster offset.
Changed
BwApiEdgePropertiesGet - Get edge's properties.
BwApiEdgePropertiesSet - Set edge's properties.
[3.15.0]
Added
BwApiRenderExportByPreset - Export by a render preset
Changed
BwApiRenderImage - Add support for auto crop.
BwApiMaterialContainerAutoPositionsSet - Set if MaterialContainer positions are linked (by group)
BwApiAvatarPropertiesGet - Add new properties.
EdgePropertiesSet - Add support for corner seam allowance.
EdgePropertiesGet - Add support for corner seam allowance.
[3.14.0]
Fixed
Fix issue with load snapshot
Fix 3d feedback shown when exporting techpack
Added
BwApiButtonGradeIdGet - Get button's Grade ID.
BwApiButtonGradeIdSet - Set button's Grade ID.
BwApiRenderExport3DObject - Added option to pack UV.
BwApiRenderExport3DObject - Add "weld_stitches" to set weather to weld the geometries in the garment.
Changed
BwApiAvatarPropertiesGet - Added support for "body_resolution" for imported avatars
BwApiAvatarPropertiesUpdate - Added support for "body_resolution" for imported avatars
[3.13.0]
Changed
BwApiGarmentSettingsGet - Retrieve "enhanced_layer_blending" to indicate whether the enhanced layer blending is on or off.
BwApiGarmentSettingsUpdate - Add "enhanced_layer_blending" to set the enhanced layer blending.
[3.12.0]
Added
BwApiRenderImageEx - Render image and return render job id for async rendering
BwApiRenderJobStatusGet - Query async render job status
BwApiShapeTextureOffsetSet - Set the texture's offset on the given shape.
BwApiEdgeTextureOffsetSet - Set the texture's offset on the given edge.
BwApiLineTextureOffsetSet - Set the texture's offset on the given line.
Add Drill type to BwApiPointType (only for a point which is neither on an edge nor an internal line).
Fixed
Fix incorrect results when exporting garment with 3D trims (e.g: buttons).
DartAPI - Fix empty results in certain functions (Mac issue).
[3.11.0]
Added
BwApiShapeConvertInternalLineToHole - Convert an internal line to a hole.
BwApiShapeHoleIds - Given existing shape id return all its hole ids.
BwApiShapePropertiesGet - Get shape properties.
BwApiShapePropertiesSet - Set shape properties.
BwApiStitchMultiCreateEx - Create new multi stitch with support for internal point.
BwApiRelateMultiCreateEx - Create new multi relate with support for internal point.
Fixed
BwApi.AnimationSettingsUpdate - fix "avatar_animation_id" field.
[3.10.0]
Changed
BwApiSnapshotInfoGet - Add "name" field to the output.
BwApiSnapshotRename - Rename snapshot.
Added
BwApiGarmentSnapshotIdsEx - Get the snapshot ids for automatic and manual snapshots.
BwApiAvatarPropertiesGet - Add "prepare_pose" for imported avatars
BwApiAvatarPropertiesUpdate - Add "prepare_pose" for imported avatars
Fixed
BwApiAvatarDelete - Fix incorrect return value.
BwApiRenderExport3DObject - Fix "export_thickness" field.
BwApiAvatarIds - Includes all new parametric avatars (Lily, Gabrielle, etc.)
Deprecated
BwApiGarmentSnapshotIds
[3.9.0]
Added
BwApiAvatarTemplatesEx - Get all the avatar templates in the system (with template info)
Changed
BwApiAvatarPropertiesGet - Add the template information to the properties.
[3.8.0]
Added
BwApiColorwayMaterialIdsEx - Get a list of face/back materials in a given colorway.
BwApiColorwayUsedMaterialIdsEx - Get a list of used face/back materials in a given colorway.
BwApiClipInfoGet - Get information of a given clip.
BwApiClipLoad - Load a clip.
BwApiClipClone - Clones a clip.
BwApiClipDelete - Delete a clip.
BwApiClipRename - Rename a clip.
BwApiEnvironmentCameraViewImport - Import camera view.
BwApiEnvironmentCameraViewExport - Export camera view.
BwApiRenderExport3DObject - Allow export glTF as original textures.
[3.7.1]
Fixed
Fixed "use_gpu" field.
[3.7.0]
Added
BwApiColorwayColorsInUse - Get the colors in use in the given colorway.
BwApiDartCreate - Create a new dart.
BwApiDartGet - Get the dart properties.
BwApiDartUpdate - Update the dart properties.
BwApiDartDelete - Deletes the dart but keeps the edges and stiches.
BwApiDartIds - Rreturns a list of all darts in the given shape.
BwApiAnimationSettingsUpdate - Update the current animation settings
BwApiAnimationSettingsGet - Get the current animmation settings.
BwApiAnimationPause - Pause the animation preview.
BwApiEnvironmentAvatarVisibilitySet - Set the visibility of the current avatar.
BwApiEnvironmentAvatarVisibilityGet - Get the visibility of the current avatar.
BwApiRenderExport3DObject - Support roughness metallic pbr.
Fixed
Fix symmetry issues
Deprecated
BwApiColorwayColorsInUseGet
[3.6.0]
Added
BwApiGarmentImport - Import files with parameters (currently we support .dxf only).
BwApiGarmentExportEx_v2 - Export files with parameters (currently we support .dxf only).
Deprecated
BwApiGarmentExport
BwApiGarmentExportEx
[3.5.0]
Added
BwApiVersion - Get the api version used by the plugin and the latest api version supported by the host application.
plugin_manifest.json schema - Update schema to support api version range (dependencies / bw-api) according to npm semver (https://docs.npmjs.com/misc/semver)
settings.json schema - Add support to get and set ray-trace settings information.
BwApiGarmentSaveAsFinalDesign - Save garment as final design.
BwApiGarmentVisibleIn3D - Check whether the garment is visible in 3D or not.
Replace ArtworkContainerAPI with MaterialContainerAPI.
Add support for piece assignable.
BwApiShapeInnerSymmetryCancel - Cancel inner symmetry (keep half/keep both).
Added - experimental
BwApiAnimationDurationGet - Get total animation time.
BwApiAnimationTimeIntervalGet - Get time of one interval.
BwApiAnimationCurrentTimeGet - Get current time.
BwApiAnimationSeek - Seek to time.
BwApiAnimationPlay - Play animation preview.
BwApiAnimationStop - Stop animation preview.
BwApiAnimationExport - Export animation (FBX/OBJ).
Fixed
BwApiGarmentDress, BwApiGarmentDressEx - Finish the simulation if it's not complete.
BwApiGarmentDress, BwApiGarmentDressEx - Add errors in case of failure.
Deprecated
ArtworkContainerAPI
[3.4.0]
Added
BwApiButtonMaterialIdGet - Get the group material id of the button
BwApiButtonMaterialIdSet - Set the group material id of the button
BwApiZipperMaterialIdGet - Get the group material id of the zipper
BwApiZipperMaterialIdSet - Set the group material id of the zipper
Changed
BwApiRenderImage - Add support for setting vray quality.
BwApiSnapshotLoadEx - Add `sync_snapshot` property.
Fixed
Keep material after moving internal line.
Fix crash in BwApiRenderExport3DObject.
LineAPI - Fix symmetry issues.
[3.3.0]
Added
BwApiButtonCreate - Create new button
BwApiButtonDelete - Delete button
BwApiZipperCreate - Create new zipper
BwApiZipperDelete - Delete zipper
BwApiZipperConnectedElementsSet - Set the connected elements of a given zipper.
BwApiSnapshotLoadEx - Load a snapshot with properties.
Changed
BwApiRenderExport3DObject - Export 3d object with option to export VRscene in CPU or GPU.
BwApiRenderImage - Add support to activate tension and pressure map in normal rendering.
line_properties.json - Add `symmetry` and `wash_effect` properties.
Change `api_version` type to string.
`api_version` is a mandatory field.
Fixed
Fix arrangement of patterns after importing dxf file.
Update BwApiSnapshotLoad to work in synchronous mode.
Fix default value of `stitch_construction_type` in line_properties.json schema.
EdgeAPI - Update BwApiEdgeMaterialIdGet and BwApiEdgeMaterialIdSet to support group material.
LineAPI - Update BwApiLineMaterialIdGet and BwApiLineMaterialIdSet to support group material.
[3.2.0]
Added
BwApiGuidelineCreate - Create new guideline.
BwApiGuidelineDelete - Delete guideline.
BwApiGuidelinePropertiesGet - Get the guideline properties.
BwApiGarmentGuidelineIds - Get the ids of guidelines in the garment.
BwApiGarmentWorkspaceGet - Gets the current workspace name.
BwApiGarmentWorkspaceSet - Sets the current workspace.
BwApiColorwayThumbnailExtract - Extract thumbnail of the given colorway id.
BwApiColorwayThumbnailGenerate - Generate thumbnail if not exists or update an existing thumbnail.
BwApiInternalLineConvertToEdge - Convert internal lines to edge.
BwApiGarmentUpdateMaterialsFromSourceFiles - Update the garment materials to match source files, if available