24.4.3

Apr 18, 2024

General

24.4.1

Apr 4, 2024

General

  • Minor bug fixes

Bundle

  • Updated Showcase base to 24.4.1

24.3.1

Mar 13, 2024

General

  • Fixed an error with bundle erroneously trying to load plugins
  • Updated return type for IObservable.waitUntil

24.2.2

Feb 22, 2024

General

  • Stability and bug fixes

24.2.1

Feb 14, 2024

General

  • Fixed an issue where Conversion.worldToScreen would return negative values whenever the input’s z coordinate was also negative.
  • Fixed an issue where Room.current could throw errors when encountering invalid room data.

24.1.2

Jan 31, 2024

General

  • Fixed various cases where transient Tags created through the SDK were mapped to the wrong View

24.1.1

Jan 18, 2024

General

  • Added the ability to set a Tag’s icon to one from Matterport’s Tag icon pack using the existing Tag.editIcon.
  • Added a .toggled state on each Layer
  • Added an option to return to the start location when switching Views using View.setActive.
  • Fixed various cases where transient Tags created through the SDK could be added to the wrong Layer.

23.12.1

Dec 13, 2023

General

  • Documented that enabling effect composer in scene configuration disables antialiasing
  • Fixed an issue where a Tag would not open on mobile when the Tag’s navigation was disabled
  • Added a force option to the legacy method Mattertag.navigateToTag
  • Changed iteration of the collection of Tags to be in the same order as the UI when editing the space

23.11.1 hot fix 1

Nov 20, 2023

General

  • Fixed SDK connection failures when Views and Layers are unsupported.

23.11.1

Nov 16, 2023

General

  • Fixed Tag.toggleSharing to now remove sharing icons from docked Tags.
  • Fixed various issues with transient Tags not showing at the correct times by adding them to a single, common layer.

23.10.2

Oct 26, 2023

General

23.10.1

Oct 12, 2023

General

  • Views are now available as View objects rather than the previous {id, name} format
  • Layers are now available in the layers collection.
  • Tag sandboxes now have the sandbox attribute, creating a more isolated sandbox environment

23.9.1

Sep 20, 2023

General

  • Added conversion routines to convert between legacy and current id schemes for Sweeps, Floors, and Rooms.
  • Added more data to measurements data including human readable labels, total lengths, and segment lengths.
  • Added a method to open links to other Matterport spaces directly instead of loading them in the current application (see: Link.setModelLinkPolicy).
  • Added fontId containing the custom icon set on a Tag by Workshop (see: Tag.TagData).

Bundle

  • Fixed an issue where large-sized meshes could be clipped by Showcase’s skybox.

23.8.2

Aug 31, 2023

General

  • Disabling navigation via Tag.allowAction prevents the tag from showing up in overlay navigation UI

23.8.1

Aug 16, 2023

General

  • Fix issues with Link OpenPolicyOptions interpolation.
  • Minor updates to examples in types for Link and Tag.
  • Fix for missing application key when linking between models
  • Safari: fixes for power-of-two texture resizing and minor memory leak
  • Fixed issues with dollhouse/floorplan mesh texture streaming
  • Improved mesh quality for small spaces

Bundle

  • Updated Three.js to r151

23.6.2

Jun 29, 2023

General

23.6.1

Jun 15, 2023

General

Early Access

  • Added View.current to observe which view is active and when it changes.
  • Added View.views to enumerate all views currently associated with the space.

23.5.1

May 18, 2023

General

  • improved zooming and panning in Dollhouse mode

23.4.2

May 4, 2023

General

  • Added a “sharing” option to Tag.allowAction to show or hide the share button on specific tags.
  • Added the ability to toggle settings with respect to the dock (Tag.toggleDocking) and share (Tag.toggleSharing) buttons in Tags.
  • Updated share links in Tags to follow the rules set by the Link namespace.

23.4.1

Apr 20, 2023

General

  • Fixed Showcase crashes in Safari 16.4+ related to non-power-of-two textures

23.3.3

Apr 11, 2023

General

  • Fixed an issue where Mattertag.preventAction would always disable docking. Since the option is not supported, the docking option is left as is.

Bundle

  • Added the ability to enable, disable, and trigger events and emits from EventPaths and EmitPaths

23.3.2

Mar 16, 2023

General

  • All of 23.3.1 fixes are now available for the Embed SDK
  • Fixed the ability to have wide Tag Sandboxes. Providing a width greater than 350px will allot a wider Tag billboard instead of truncating the Sandbox.

23.3.1

Mar 9, 2023

General

  • Added the ability to toggle the overhead navigation controls using Tag.toggleNavControls that are shown when selecting tags.
  • Removed the “button bar” in a Tag’s billboard when it doesn’t have share and dock buttons.
  • Fixed a race condition in Tag.editIcon when called too early.

23.2.2

Mar 2, 2023
  • Added the ability to set the Tag’s icon immediately when calling Tag.add.
  • If a Tag was docked and its dock ability was removed, it will now close.
  • When moving Tags with Tag.editPosition or Tag.ediStem, if their billboard was open, it will now close.

23.2.1-hotfix1

Feb 22, 2023

General

  • Fixed a pinch to zoom issue in Dollhouse mode

23.2.1

Feb 16, 2023

General

  • Added the ability to open and close Tags using Tag.open, Tag.close, Tag.dock.
  • Added the ability to set the id of Tag when calling Tag.add.
  • Added a docking option to disable docking when using Tag.allowAction.
  • Added Tag.openTags that reports the hovered, selected (clicked/opened), and docked state of Tags.
  • Added the extra properties to each Tag: Tag.keywords, Tag.stemHeight, Tag.discPosition.
  • Fixed thrown errors for .svg in Asset.registerTexture.
  • Added a delay to the SDK loading screen message and changed the messaging to remove mention of the SDK.

23.1.2

Feb 1, 2023

General

  • Added the ability add sizes to sandboxes created through Tag.registerSandbox.
  • Fixed a race condition in Tag.editOpacity. Opacity can now be set much sooner.
  • Fixed the media properties in Mattertag.getData.
  • Addressed some performance issues when adding numerous tags at once using Tag.add.
  • Removed “share” buttons from transient Tags created through the SDK temporarily since the links created weren’t always valid.
  • Updated the type definition of Mattertag.getDiscPosition to accept both data from Mattertag.getData and Mattertag.data.

23.1.1

Jan 19, 2023

General

  • Added an initial SDK loading screen while Showcase “awaits an SDK connection” that is now displayed instead of a blank gray screen.
  • Fixed Measurement.getData now properly reports data for single segment measurement and the final segments of multi-segment measurements.
  • Added the ability to catch errors when setting the volume of a Source or Sensor. commit now reports its status through a returned a promise.

22.12.1

Dec 15, 2022

General

Bundle

  • Fixed an issue where ISceneObjectSpy would trigger on all events instead of just the ones it was registered to.

22.11.2

Dec 1, 2022

General

  • Allow for function calls made before doing a disconnect to be resolved after the call to disconnect.

22.11.1

Nov 10, 2022

Bundle

  • Added the ability for ISceneObjectSpy to spy on incoming events to an IComponent
  • Fixed issues with serializing an INode[].
  • Breaking Change deserializing now always returns an IObject.
    • Depending on the asset format being deserialized, either an INode[] or IObject was being returned. For consistency, we have opted to only return the latter.
    • To get references to the nodes after deserialization 
      const sceneObject = mpSdk.Scene.deserialize(/* ... */);
const nodes = [...sceneObject.nodeIterator()];
// from here continue using the nodes as usual

22.10.3

Oct 27, 2022

General

  • Fixed issues where the subscription to a Collection or Observable could be undefined in their callbacks.

22.10.2

Oct 13, 2022

General

  • Fixed an issue where signed URLs used in Tag.attachments were not refreshing
  • Removed deprecated Tag namespace functions

Bundle

  • Restored the THREE.FontLoader exposed through component contexts

22.10.1

Oct 4, 2022

General

  • Tags 2.0 Early Access is now considered Generally Available
    • Any features in the Tag namespace marked deprecated will be removed in the next release
    • All other features are considered stable and will continue to be supported

22.9.1

Sep 13, 2022

General If opted into Tags 2.0:

  • Fixed an issue where Tag.allowAction would throw an error if called to early
  • Fixed an issue with Mattertag.add when using a media type of MediaType.NONE
  • Fixed media.src returned in the items of Mattertag.data

22.8.2

Aug 24, 2022

General

  • Fixed issues with Tag.allowAction as well as backward compatibility with Mattetag.preventAction when using Tags 2.0
  • The tag billboard and/or dock now close when the tag is removed
  • Editing a tag now displays the changes immediately; no need to close and re-open the tag to display the new contents
  • Events from the Mattertag namespace now properly fire when using Tags 2.0

22.8.1

Aug 4, 2022

General

  • The default Mattertag/Tag implementation is “classic” Mattertags ignoring any external feature policies overrides. To use Tags 2.0, a manual opt-in is necessary using the newtags=1 URL parameter on Showcase’s iframe.

22.7.1

July 21, 2022

Bundle

22.6.1

Jun 30, 2022

General

Bundle

22.5.1

Jun 7, 2022

General

Bundle

  • Updated internal Three.js from r136 to r139

22.4.1

Apr 11, 2022

General

  • Fixed an issue with deep links not taking you to the correct pose in Tags

22.3.3

Mar 17, 2022

General The previous Early Access is now closed and all features are now available generally available.

  • Updated: Pointer now has ways to control the reticle that follows the mouse pointer. See the tutorial.
  • Updated: Graph namespace for pathfinding has improved watch-ability. See the tutorial.
  • Added: Link namespace to control how links are generated and how links are handled.

22.3.2

Mar 15, 2022

General

  • Fixed some issues with Space Search

22.3.1

Mar 11, 2022

General

Bundle

22.1.1

Jan 24, 2022

General Early Access features that were previously only available in our Bundle SDK are now available in the Embed SDK as well.

21.12.1

Dec 6, 2021

General

  • Fixed an issue where Mattertag.remove would not remove an array of mattertags.
  • Fixed an issue where Mattertag.registerIcon would not throw exceptions after an error occurred.
  • Fixed an issue where an interrupted inside mode navigation would display the model correctly.
  • Fixed an issue where a user could not navigate to a floor under a hidden floor.
  • Fixed an issue where Pointer.intersection would not return the correct type for a mattertag.

Bundle

21.9.1

Sep 23, 2021

General

21.8.2

Aug 25, 2021

General

  • Fix an issue where Sweep.moveTo would ignore the transitionTime option.

Bundle

  • Update threejs transform controls to version 129.

21.8.1

Aug 5, 2021

General

  • Fixed an issue where a share link would not link to matterport.com
  • Fixed an issue preventing the use of the my.matterportvr.cn api domain.

Bundle

  • Fixed an issue where Scene.serialize would return undefined
  • Fixed an issue where model loader components would not remove meshes from the scene when stopped.
  • Mobile redirects were removed. You can re-enable redirects by setting disableMobileRedirect to false in your app config.
  • Added the Scene namespace to the sdk type definitions.
  • Added scene objects. See Using scene objects and Scene.createobjects
  • Scene.serialize now serializes to version 2. Scene.deserialize takes both version 1 and 2 scene files.
  • Updated embedded three.js to version r128

21.6.2

Jun 17, 2021

General

  • Fixed missing App namespace enums

21.6.1

Jun 10, 2021

General

  • Added: Room.current observable.
  • Added: Typescript type declarations.
  • Fixed: Sweep.Alignment and Sweep.Placement are now properly under the Sweep namespace. Previously they were Mode.Alignment and Mode.Placement
  • Removed: An interface version no longer needs to be specified when calling connect.

21.5.1

May 27, 2021

General

  • Maintenance bug fixes and improvements.

21.4.3

Apr 21, 2021

Bundle

  • Fixed a CORS issue when using the bundle on a custom domain.

21.4.2

Apr 16, 2021

Bundle

  • Added scene parameter to ‘Scene.configure’ callback.
  • Added ‘INTERACTION.DRAG_BEGIN’ and ‘INTERACTION.DRAG_END’ events to scene node colliders.
  • Added ‘colliderEnabled` boolean to the gltf, fbx, dae and obj model loaders.

21.4.1

Apr 1, 2021

General

  • Added: Room.data collection.
  • Added: Cylinder sources for use with Sensors.
  • Added: Box sources now support orientation.
  • Fixed: Mattertag.add now properly sets its stem visible when undefined.
  • Fixed: Sweep.current is more resilient to missing floor info.

21.3.2

Mar 2, 2021

General

  • Fixed an issue with Mattertag.injectHTML

21.2.3

Feb 22, 2021

General

  • Added: Sensors
  • Fixed: Mattertag.editPosition always giving a stem length of 1 meter.

21.2.2

Feb 16, 2021

Bundle

  • Updated embedded three.js to version r124
  • Fixed an issue with disabling measurement mode.
  • Fixed an issue with password submission on password protected spaces.
  • Fixed an issue with drag gesture ending prior to pointer release(improves transform control and mesh dragging).
  • Added optional effect composer. You must set useEffectComposer: true in the application config object in showcase.html.
  • Added Scene.configure function.

21.2.1

Feb 3, 2021

General

  • Fixed an issue with the appearance of password protected spaces.
  • Fixed an issue with toggling measurement mode.

Bundle

  • Added input data to mesh CLICK, HOVER, and DRAG interactions.

21.1.1

Jan 19, 2021

General

20.12.3

Dec 21, 2020

General

  • Fix: Added enabled, stemVisible and floorIndex properties to ObservableMattertagData for backwards compatibility with Mattertag.getData
  • Fix: Fixed an issue where observable collections would not return initial data
  • Added: Floor.data observable collection, deprecate Floor.getData
  • Added: FloorInfo to Label and SweepData

20.12.2

Dec 11, 2020 General Availability

General

  • Fixed an issue with where Sweep.data would return no sweeps.

Bundle

  • Components: Added unfiltered property to mp.input component.
  • Additional setup instructions for application keys required for CORS, see Set your application key

20.12.1

Dec 1, 2020

General

  • Added: Mattertag.data observable collection, deprecate Mattertag.getData
  • Added: onCollectionUpdated to collection observers. onCollectionUpdated aggregates changes to a collection for more coarse, but less often updates
  • Added: views option to Renderer.takeScreenShot to hide 360 views
  • Fix: Failures to load replace tag icons via Mattertag.editIcon will now properly propagate errors
  • Fix: Fallback dimensions are now provided for svgs used in Mattertag.editIcon – this should help in some cases where Firefox determines the size is 0x0
  • Improved: More descriptive error messages around tagIds provided in most Mattertag calls

20.11.1

Nov 6, 2020

Bundle

  • Scene: Added support for creating arrays of components and nodes. See Scene.registerComponents and Scene.createNodes.
  • Components: Fixed an issue where mp.input would not dispatch a models INTERACTION.CLICK event.
  • General: Fixed an sdk connection issue on the oculus browser. You can now connect to the sdk while in xr immersive mode. See Using xr
  • Added the mp.xr component which provides an XRSession. See mp.xr

20.9.1

Sep 25, 2020

Bundle

  • General: Added support for a custom embedly key. Mattertag videos and images can now be viewed with bundle applications. See Setting up Embedly
  • Conversion: Fixed an issue where Conversion.worldToScreen returned stale screen coordinates.
  • Components: Added support for arrays as inputs.
  • Added showX, showY, showZ and size to mp.transformControls inputs.

20.8.2

Aug 13, 2020

Bundle

  • Added mp.input, mp.camera, and mp.transformControls components.
  • Inspector: added component list panel, 6DOF camera controls. Source code updated.
  • General: Includes SDK for embeds v3.5 features and bug fixes.
  • General: Fixed an issue where mattertags and labels were being loaded from localhost.
  • General: Fixed an issue where textures were not properly loaded on safari.

20.8.1

Aug 5, 2020

General

  • Added Mattertag.injectHTML which allows embedding of custom HTML and Javascript, with sandboxed iframe limitations.

20.7.1

Jul 31, 2020

Bundle

  • Models: Fixed an issue with loading OBJ models with a material.
  • Scenes: Fixed an issue with orphaned colliders from deleted scene nodes.

20.6.2

Jun 23, 2020

General

  • Added Camera.zoomBy, Camera.zoomTo, and Camera.zoomReset to manipulate the zoom level of the camera in Panorama modes.
  • Added Camera.zoom observable to get the zoom level of the camera while in Panorama mode.
  • Added Mattertag.editOpacity to control opacity of each Mattertag.
  • Added Mattertag.preventAction to disable Showcase’s default hover and click handlers allowing for the billboard to be hidden and/or the click to navigate to be suppressed.
  • Added Sweep.data as a replacement for the sweeps property of Model.getData.
  • Added IObserver support to IObservable for the more object-oriented programmer.
  • Added transitionTime to Sweep.moveTo options.
  • Fixed an issue with Camera.setRotation where certain orientations would rotate in the wrong direction.
  • Fixed a race condition between Mattertag.registerIcon and Mattertag.editIcon.

20.6.1

Jun 1, 2020

General

  • Added Measurements.data which allows you to detect when measurements are added, removed, and updated.
  • Added Mattertag.registerIcon and Mattertag.editIcon function which allows you to change image used as mattertag discs.
  • Added Mattertag.resetIcon to undo changes done by Mattertag.editIcon.

20.5.3

May 19, 2020

General

  • Added Measurements.mode which allows you to detect when measurements mode is activated and deactivated.
  • Added Measurements.toggleMode function which allows you to enable and disable showcase measurement mode.

20.5.2

May 13, 2020

General

  • Fixed a race condition with Camera.pose and Pointer.intersection initialization.

Bundle

20.5.1

May 11, 2020

General

  • Added optional floorId parameter to Mattertag.add and Mattertag.editPosition.
  • Added floorId to Pointer.intersection observable. This property can be used in with transient mattertags.

20.4.1

Apr 10, 2020

Bundle

  • Models: Web workers load textures in the background.
  • Models: Added loadingState property to the output of the gltf, dae, fbx, and obj loaders.
  • Models: Fixed an issue where reloading models would not release resources.
  • Scenes: Scene files support property and event bindings.
  • Scenes: Scene files support multiple components per node.
  • Components: Added most of the three/js/examples to the component context.
  • Fixed a startup race condition with createNode.

20.2.1

Feb 6, 2020

Bundle

  • Fixed an issue where transform controls interrupted camera motion.

20.1.1

Jan 30, 2020

General

  • Added Mattertag.LINK_OPEN event. This event fires when the user has clicked on an external mattertag link. See Mattertag Events
  • Added Camera.setRotation function. This function sets the absolute rotation of the camera in inside mode.

Bundle

  • Added light objects: mp.ambientLight, mp.directionalLight, and mp.pointLight.
  • Added support for objects as component inputs.
  • Fixed an issue where onInteraction would not fire if the collider was a Mesh object.
  • Fixed a bug with the github showcase-sdk-tutorial repo where the app would load the bundle twice. github showcase-sdk-tutorial link.

19.12.2

Dec 20, 2019

Bundle

  • First release

19.12.1

Dec 9, 2019
  • Transient Mattertags
    Support for creating, updating and deleting mattertags. Changes to mattertags disappear once the user leaves showcase. Added Mattertag.add, Mattertag.editColor, Mattertag.editBillboard, Mattertag.editPosition, and Mattertag.remove See Tutorials section for help on editing transient mattertag content.
  • Synchronous Functions
    We are adding support for synchronous functions. These functions compute and return your data immediately, no promise involved. In general, synchronous functions are more performant since they dont directly interact with the showcase. Use them when you can. To start, we have selected a function that is called frequently Renderer.getScreenPosition(). This function is now being deprecated, and the new synchronous function is Renderer.worldToScreen(). In order to use synchronous functions, you will need to update your sdk client reference to https://static.matterport.com/showcase-sdk/2.0.0-0-g7edd6b8/sdk.js
  • Added Mattertag.getDiscPosition synchronous function.
  • Deprecating window.SHOWCASE_SDK, use window.MP_SDK instead.
  • Update your iframe links. We are no longer using /showcase-beta in the iframe link, use /show e.g. https://my.matterport.com/show?m=SxQL3iGyoDo&play=1. See Installation

19.8.1

Aug 22, 2019
  • Added Camera.pose observable property.
  • Camera.getPose() is now deprecated. It will be removed in a future update.
  • Added Pointer namespace and Pointer.intersection observable property

19.5.1

May 3, 2019
  • Added colors and anchor points Mattertag.MattertagData

19.4.1

Apr 25, 2019
  • Added Measurements.getData(). You can now access measurements created from Workshop!
  • Added App.getLoadTimes(). You can now access app phase timing information!
  • Added transition type parameter to Mattertag.navigateToTag()
  • Removed Mattertag.ActiveMattertagData type
  • Removed Mattertag.Event.UPDATE
  • Added projection property to Camera.getPose()
  • Added optional includeHiddenFloors parameter to Renderer.getWorldPositionData()
  • Added Renderer.takeEquirectangular()

18.6.1

Jun 27, 2018

18.2.1

Feb 12, 2018
  • Renamed toggle() to setActive()
  • Renamed MattertagPositionData to ActiveMattertagData
  • Removed HoverState event, redundant with Event.HOVER
  • Removed SelectedState event, use Event.CLICK instead`
  • Renamed getMattertagData to getData
  • Removed BoardState enum.
  • Added MattertagData.isActive property
  • Added TagDescriptionChunkType enum
  • Added TagMediaType enum
  • Added LinkType enum
  • Removed MattertagData.floorIndex property
  • Removed MattertagData.mode property
  • Removed MattertagData.color property
  • Removed MattertagData.anchorPosition property
  • Removed MattertagData.stemVector property
  • Renamed SweepInfo.newPano to SweepInfo.newSweep
  • Renamed SweepInfo.oldPano to SweepInfo.oldSweep
  • Removed ModelData.panos property
  • Removed SweepData.modelSupportsVr property
  • Removed SweepData.neighbourUUIDs property
  • Removed SweepData.thumbnail property
  • Renamed getModelData() to getData()
  • Renamed getModelDetails() to getDetails()`
  • Renamed ModelDetails.contact_email to ModelDetails.contactEmail
  • Renamed ModelDetails.contact_name to ModelDetails.contactName
  • Renamed ModelDetails.formatted_address to ModelDetails.formattedAddress
  • Renamed ModelDetails.formatted_contact_phone to ModelDetails.formattedContactPhone
  • Renamed Pose.pano to Pose.sweep
  • Removed rotateInDirection() function
  • Removed Event.CHANGE event
  • Renamed Event.PLAYING to Event.PHASE_CHANGE

v3.0

Dec 4, 2017
  • New actions and events on floors, labels, and Mattertag™ Posts.
  • New set of reference content that covers all actions and events.
  • Version 1.x no longer supported. Version 2.0 skipped.
  • See a list of modified endpoints.

v1.1

Aug 10, 2017
  • Added getPose and takeScreenShot actions.
  • Added pano thumbnails from the default pose into the metadata.

v1.0

Feb 16, 2017
  • Initial release of SDK. Focus on movement and the user’s location in the space.