Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[3.22.0] - 2025.1.1
Changed
Edges
BwApiEdgePropertiesGet - Add support for grid refinement properties.
BwApiEdgePropertiesSet - Add support for grid refinement properties.
Lines
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.
Render
BwApiRenderImage - Add support for new schematic rendering parameters.
[3.21.0] - 2025.1.0
Changed
MaterialContainer
BwApiMaterialContainerCreate - transformation is now relative from (0, 0).
Garment
BwApiGarmentExportEx_v2 - added dxf_format setting to export in astm dxf format.
Added
Avatar
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.
Shoes
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] - 2024.1.0
Changed
Edges
BwApiLineMaterialIdSet - Support removing a material.
Shapes
BwApiShapeMaterialIdSet - Support removing a material.
Lines
BwApiLineMaterialIdSet - Support removing a material.
Added
Render
BwApiRenderExport3DObject - Added option to separate garment details.
Outfit
BwApiOutfitCreate - Create a new outfit.
BwApiOutfitReadGarmentProperties - Get the properties of garment to be used for outfit creation.
Avatar
BwApiAvatarExportVSA - Added support to export avatars as VSA.
[3.18.0] - 2023.3.0
Changed
Pleat
BwApiPleatVertexPositionGet - Support knife pleat as well.
BwApiPleatVertexPositionSet - Support knife pleat as well.
Edges
BwApiEdgePropertiesGet - Get edge's properties.
BwApiEdgePropertiesSet - Set edge's properties.
[3.17.0] - 2023.2.1
Added
Lines
BwApiLineFillMaterialIdGet - Get line's fill material.
BwApiLineFillMaterialIdSet - Set line's fill material.
Environment
BwApiEnvironmentLightSetDefault - Set Default HDRI Light.
BwApiEnvironmentLightLoadDefault - Load Default HDRI Light.
BwApiEnvironmentLightImport - Import HDRI Light from file.
BwApiEnvironmentLightDelete - Delete imported HDRI Light.
Changed
Edges
BwApiEdgePropertiesGet - Get edge's properties.
BwApiEdgePropertiesSet - Set edge's properties.
Removed
Edges
BwApiEdgeForceMultipllerPropertiesGet
BwApiEdgeForceMultipllerPropertiesSet
[3.16.0] - 2023.2.0
Added
Material
BwApiMaterialContainerAutoPositionsGet - Get if MaterialContainer positions are linked (by group)
BwApiMaterialContainerAutoPositionsSet - Set if MaterialContainer positions are linked (by group)
Clusters
BwApiClusterShapeOffsetGetEx - Given existing shape id and size id return cluster offset.
BwApiClusterShapeOffsetSetEx - Given existing shape id and size id set cluster offset.
Changed
Edges
BwApiEdgePropertiesGet - Get edge's properties.
BwApiEdgePropertiesSet - Set edge's properties.
Removed
Edges
BwApiEdgeForceMultipllerPropertiesGet
BwApiEdgeForceMultipllerPropertiesSet
[3.15.0] - 2022.2.1
Added
Render
BwApiRenderExportByPreset - Export by a render preset.
Changed
Render
BwApiRenderImage - Add support for auto crop.
Material
BwApiMaterialContainerAutoPositionsSet - Set if MaterialContainer positions are linked (by group)
Avatar
BwApiAvatarPropertiesGet - Add new properties.
Edge
EdgePropertiesSet - Add support for corner seam allowance.
EdgePropertiesGet - Add support for corner seam allowance.
[3.14.0] - 2022.2.0
Fixed
Fix issue with load snapshot
Fix 3d feedback shown when exporting techpack
Added
Button
BwApiButtonGradeIdGet - Get button's Grade ID.
BwApiButtonGradeIdSet - Set button's Grade ID.
Render
BwApiRenderExport3DObject - Added option to pack UV.
BwApiRenderExport3DObject - Add "weld_stitches" to set weather to weld the geometries in the garment.
Changed
Avatar
BwApiAvatarPropertiesGet - Added support for "body_resolution" for imported avatars
BwApiAvatarPropertiesUpdate - Added support for "body_resolution" for imported avatars
[3.13.0] - 2021.3.2
Changed
Garment
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] - 2021.3.1
Added
Render
BwApiRenderImageEx - Render image and return render job id for async rendering
BwApiRenderJobStatusGet - Query async render job status
Shape
BwApiShapeTextureOffsetSet - Set the texture's offset on the given shape.
Edge
BwApiEdgeTextureOffsetSet - Set the texture's offset on the given edge.
Line
BwApiLineTextureOffsetSet - Set the texture's offset on the given line.
InternalPoint
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).
Deprecated
BwApiRenderImage
[3.11.0] - 2021.3.0
Added
Shape
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.
Stitch
BwApiStitchMultiCreateEx - Create new multi stitch with support for internal point.
Relate
BwApiRelateMultiCreateEx - Create new multi relate with support for internal point.
Fixed
BwApi.AnimationSettingsUpdate - fix "avatar_animation_id" field.
[3.10.0] - 2021.2.0
Changed
Render
BwApiRenderImage - Add support to change background when rendering in ray-trace
BwApiRenderRayTrace - Add support to change background when rendering in ray-trace
BwApiRenderExport3DObject - Export 3D object to udatasmith file
Added
Garment
BwApiGarmentSnapshotIdsEx - Get the snapshot ids for automatic and manual snapshots.
Avatar
BwApiAvatarPropertiesGet - Add "prepare_pose" for imported avatars
BwApiAvatarPropertiesUpdate - Add "prepare_pose" for imported avatars
Changed
BwApiSnapshotInfoGet - Add "name" field to the output.
Snapshot
BwApiSnapshotRename - Rename snapshot.
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] - 2021.1.2
Added
Avatar
BwApiAvatarTemplatesEx - Get all the avatar templates in the system (with template info)
Changed
Avatar
BwApiAvatarPropertiesGet - Add the template information to the properties.
[3.8.0] - 2021.1.1
Added
Colorway
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.
Clip
BwApiClipInfoGet - Get information of a given clip.
BwApiClipLoad - Load a clip.
BwApiClipClone - Clones a clip.
BwApiClipDelete - Delete a clip.
BwApiClipRename - Rename a clip.
Environment
BwApiEnvironmentCameraViewImport - Import camera view.
BwApiEnvironmentCameraViewExport - Export camera view.
Render
BwApiRenderExport3DObject - Allow export glTF as original textures.
[3.7.1] - 2021.1.0
Fixed
Fixed "use_gpu" field.
[3.7.0] - 2021.1.0
Added
Colorway
BwApiColorwayColorsInUse - Get the colors in use in the given colorway.
Dart
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.
Animation
BwApiAnimationSettingsUpdate - Update the current animation settings
BwApiAnimationSettingsGet - Get the current animmation settings.
BwApiAnimationPause - Pause the animation preview.
Environment
BwApiEnvironmentAvatarVisibilitySet - Set the visibility of the current avatar.
BwApiEnvironmentAvatarVisibilityGet - Get the visibility of the current avatar.
Render
BwApiRenderExport3DObject - Support roughness metallic pbr.
Changed
Garment
BwApiGarmentWorkspaceSet - Add support to switch to animation workspace.
Fixed
Fix symmetry issues
Deprecated
BwApiColorwayColorsInUseGet
[3.6.0] - 2020-12-10
Added
Garment
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] - 2020-10-14
Added
General
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.
Garment
BwApiGarmentSaveAsFinalDesign - Save garment as final design.
BwApiGarmentVisibleIn3D - Check whether the garment is visible in 3D or not.
MaterialContainer
Replace ArtworkContainerAPI with MaterialContainerAPI.
Add support for piece assignable.
Shape
BwApiShapeInnerSymmetryCancel - Cancel inner symmetry (keep half/keep both).
Added - experimental
Animation
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] - 2020-08-15
Added
Button
BwApiButtonMaterialIdGet - Get the group material id of the button
BwApiButtonMaterialIdSet - Set the group material id of the button
Zipper
BwApiZipperMaterialIdGet - Get the group material id of the zipper
BwApiZipperMaterialIdSet - Set the group material id of the zipper
Changed
Render
BwApiRenderImage - Add support for setting vray quality.
Snapshot
BwApiSnapshotLoadEx - Add
sync_snapshotproperty.
Fixed
Keep material after moving internal line.
Fix crash in BwApiRenderExport3DObject.
LineAPI - Fix symmetry issues.
[3.3.0] - 2020-07-15
Added
Button
BwApiButtonCreate - Create new button
BwApiButtonDelete - Delete button
Zipper
BwApiZipperCreate - Create new zipper
BwApiZipperDelete - Delete zipper
BwApiZipperConnectedElementsSet - Set the connected elements of a given zipper.
Snapshot
BwApiSnapshotLoadEx - Load a snapshot with properties.
Changed
Render
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
line_properties.json - Add
symmetryandwash_effectproperties.
Plugin.json
Change
api_versiontype to string.api_versionis 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_typein 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] - 2020-05-31
Added
Guidelines
BwApiGuidelineCreate - Create new guideline.
BwApiGuidelineDelete - Delete guideline.
BwApiGuidelinePropertiesGet - Get the guideline properties.
BwApiGarmentGuidelineIds - Get the ids of guidelines in the garment.
Workspace
BwApiGarmentWorkspaceGet - Gets the current workspace name.
BwApiGarmentWorkspaceSet - Sets the current workspace.
Colorway
BwApiColorwayThumbnailExtract - Extract thumbnail of the given colorway id.
BwApiColorwayThumbnailGenerate - Generate thumbnail if not exists or update an existing thumbnail.
General
BwApiInternalLineConvertToEdge - Convert internal lines to edge.
BwApiGarmentUpdateMaterialsFromSourceFiles - Update the garment materials to match source files, if available