Skip to content

habx/client-orbital

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
.cargo
.cargo
 
 
.github/workflows
.github/workflows
 
 
data
data
 
 
public
public
 
 
scripts
scripts
 
 
sources
sources
 
 
tests
tests
 
 
Cargo.lock
Cargo.lock
 
 
Cargo.toml
Cargo.toml
 
 
Trunk.toml
Trunk.toml
 
 
index.html
index.html
 
 
readme.md
readme.md
 
 

Repository files navigation

3D orbit viewer

Preview of the viewer

3D orbits are nothing more than a succession of rendered images captured from a set of cameras rotating around a 3D model of a real-estate operation. The generated images are referenced in a single JSON file, called a manifest. This manifest also contains additional metadata in order to represent and interact with the operation's units.

Usage

The viewer accepts a few query parameters to personalize the user-experience:

  • manifest (required) the URL to the orbit manifest of a given project
  • interactive a boolean value enabling interactions with lots and the display of the overlay (optional, default to false)
  • redirection a template URL used to redirect a visitor upon choosing a lot (optional, the feature is deactivated if omitted). Beware of special characters that might need to be encoded (see here for details). This template supports a few placeholders, they are replaced by their corresponding value to make dynamic links:
    • %ID% the identifier of a lot (usually a randomly generated one, for internal usage, e.g. 83765-232)
    • %SLUG% the commercial slug of a lot (most likely a combination of a lot's building, floor and index, e.g. A201)
  • redirection_label the text label displayed on the lot redirection button (optional, defaults to Voir les détails)

Availability

The viewer itself is hosted on GitHub Pages at this address: https://habx.github.io/client-orbital. It should remain publicly available as long as GitHub keeps providing its services for free for open-source projects.

The assets are temporarily stored on AWS S3 and served through AWS CloudFront to help you during the transition. You must take actions to host the data on your cloud infrastructure, if you want to avoid an interruption of service.

Migration

Assets

  1. Download and extract the archives along with the manifest of your project. You should receive the links from us.
  2. Upload all files to your hosting solution. The files do not have to be served from the root directory. However, the assets being referenced relatively, the internal structure must remain untouched. The resources must be accessible from the domain where the viewer is hosted. Remember to review your security policies.
  3. Replace the manifest query parameters of your links with the absolute URL to the manifest.json file.

Viewer

The source code for the viewer is available on this repository. The project has been developed in Rust and is compiled down to a single Wasm binary loaded with a few other resources to an HTML file. You can download the latest version here.

Projects

The default links to 3D orbits (interaction enabled and redirection set when applicable) are listed below. You can edit the query parameters to adapt the viewer to your needs.

Manifest format updates (from version 2.0.0 to 3.0.0)

  • Reorder the fields given the jq transformation '{ meta, lots, views }'
  • Added field meta.path that defines the location of the folder containing all images assets
  • Added fields lots[].exteriorSurfaceArea, lots[].images, lots[].levels, lots[].name, lots[].slug, lots[].surfaceArea, lots[].typology, lots[].vat

About

habx.github.io/client-orbital/

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 1

1.0.0 Latest
Feb 15, 2023

Languages