Skip to content

Commit

Permalink
Merge branch 'gh-pages'
Browse files Browse the repository at this point in the history
Conflicts:
	README.md
  • Loading branch information
pshaw committed Oct 18, 2015
2 parents db23fc8 + 250bc66 commit af47af8
Show file tree
Hide file tree
Showing 92 changed files with 2,218 additions and 82 deletions.
43 changes: 28 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,36 @@ This is a customizable application built on three.js that allows users to design

![3d_design](https://s3.amazonaws.com/furnishup/design.png)

## Get started
## Developing and Running Locally

To get started, run:
To get started, clone the repository and ensure you npm installed, then run:

npm update
npm run-script build

The latter command generates `build/blueprint3d.js` and also copies it to `example/js`
The latter command generates `example/js/blueprint3d.js` from `src`.

## /src directory
The easiest way to run locally is to run a local server from the `example` directory. There are plenty of options. One uses Python's built in webserver:

cd example

# Python 2.x
python -m SimpleHTTPServer

# Python 3.x
python -m http.server

Then, visit `http://localhost:8000` in your browser.

## Contribute!

This project requires a lot more work. In general, it was rushed through various prototype stages, and never refactored as much as it probably should be. We need your help!

Please contact us if you are interested in contributing.

## Directory Structure

### `src/` Directory

The `src` directory contains the core of the project. Here is a description of the various sub-directories:

Expand All @@ -43,18 +63,11 @@ The `src` directory contains the core of the project. Here is a description of t

`utils` - some shared functions that are mostly deprecated in favor of functionality provided by various npm modules

## License

This project is open-source! See LICENSE.txt for more information.
### `example/` Directory

## TODO
The example directory contains an application built using the core blueprint3d javascript building blocks. It adds html, css, models, textures, and more javascript to tie everything together.

This project requires a lot more work. In general, it was rushed through various prototype stages, and never refactored as much as it probably should be. Here are some things that clearly need attention:
## License

- Better documentation
- Test suite
- Make it easier to build a complete application using blueprint3d (cleaner API, more inclusive base, easier integration with a backend)
- Better serialization format for saving/loading "designs"
- Remove the dependency on jquery from the core source!
- Better use of npm conventions and packaging
- Various bug fixes
This project is open-source! See LICENSE.txt for more information.
Binary file removed example/images/lightmap.png
Binary file not shown.
Binary file removed example/images/macbook_air_cropped_room.psd
Binary file not shown.
16 changes: 8 additions & 8 deletions example/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@
<div class="panel-body" style="color: #333333">

<div class="col-sm-6" style="padding: 3px">
<a href="#" class="thumbnail texture-select-thumbnail" texture-url="https://blueprint-dev.s3.amazonaws.com/uploads/floor_wall_texture/file/light_fine_wood.jpg" texture-stretch="false" texture-scale="300">
<img alt="Thumbnail light fine wood" src="https://blueprint-dev.s3.amazonaws.com/uploads/floor_wall_texture/file/thumbnail_light_fine_wood.jpg" />
<a href="#" class="thumbnail texture-select-thumbnail" texture-url="rooms/textures/light_fine_wood.jpg" texture-stretch="false" texture-scale="300">
<img alt="Thumbnail light fine wood" src="rooms/thumbnails/thumbnail_light_fine_wood.jpg" />
</a>
</div>
</div>
Expand All @@ -110,18 +110,18 @@
<div class="panel-heading">Adjust Wall</div>
<div class="panel-body" style="color: #333333">
<div class="col-sm-6" style="padding: 3px">
<a href="#" class="thumbnail texture-select-thumbnail" texture-url="https://blueprint-dev.s3.amazonaws.com/uploads/floor_wall_texture/file/marbletiles.jpg" texture-stretch="false" texture-scale="300">
<img alt="Thumbnail marbletiles" src="https://blueprint-dev.s3.amazonaws.com/uploads/floor_wall_texture/file/thumbnail_marbletiles.jpg" />
<a href="#" class="thumbnail texture-select-thumbnail" texture-url="rooms/textures/marbletiles.jpg" texture-stretch="false" texture-scale="300">
<img alt="Thumbnail marbletiles" src="rooms/thumbnails/thumbnail_marbletiles.jpg" />
</a>
</div>
<div class="col-sm-6" style="padding: 3px">
<a href="#" class="thumbnail texture-select-thumbnail" texture-url="https://blueprint-dev.s3.amazonaws.com/uploads/floor_wall_texture/file/wallmap_yellow.png" texture-stretch="true" texture-scale="">
<img alt="Thumbnail wallmap yellow" src="https://blueprint-dev.s3.amazonaws.com/uploads/floor_wall_texture/file/thumbnail_wallmap_yellow.png" />
<a href="#" class="thumbnail texture-select-thumbnail" texture-url="rooms/textures/wallmap_yellow.png" texture-stretch="true" texture-scale="">
<img alt="Thumbnail wallmap yellow" src="rooms/thumbnails/thumbnail_wallmap_yellow.png" />
</a>
</div>
<div class="col-sm-6" style="padding: 3px">
<a href="#" class="thumbnail texture-select-thumbnail" texture-url="https://blueprint-dev.s3.amazonaws.com/uploads/floor_wall_texture/file/light_brick.jpg" texture-stretch="false" texture-scale="100">
<img alt="Thumbnail light brick" src="https://blueprint-dev.s3.amazonaws.com/uploads/floor_wall_texture/file/thumbnail_light_brick.jpg" />
<a href="#" class="thumbnail texture-select-thumbnail" texture-url="rooms/textures/light_brick.jpg" texture-stretch="false" texture-scale="100">
<img alt="Thumbnail light brick" src="rooms/thumbnails/thumbnail_light_brick.jpg" />
</a>
</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions example/js/blueprint3d.js
Original file line number Diff line number Diff line change
Expand Up @@ -46201,7 +46201,7 @@ var Room = function(floorplan, corners) {
this.customTexture = false;

var defaultTexture = {
url: "images/hardwood.png",
url: "rooms/textures/hardwood.png",
scale: 400
}

Expand Down Expand Up @@ -46467,7 +46467,7 @@ var Wall = function(start, end) {
var action_callbacks = JQUERY.Callbacks();

var defaultTexture = {
url: "images/wallmap.png",
url: "rooms/textures/wallmap.png",
stretch: true,
scale: 0
}
Expand Down Expand Up @@ -47587,7 +47587,7 @@ var ThreeEdge = function(scene, edge, controls) {
var basePlanes = []; // always visible
var texture = null;

var lightMap = THREE.ImageUtils.loadTexture("images/walllightmap.png");
var lightMap = THREE.ImageUtils.loadTexture("rooms/textures/walllightmap.png");
var fillerColor = 0xdddddd;
var sideColor = 0xcccccc;
var baseColor = 0xdddddd;
Expand Down
4 changes: 2 additions & 2 deletions example/js/example.js

Large diffs are not rendered by default.

100 changes: 50 additions & 50 deletions example/js/items.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,152 +4,152 @@ $(document).ready(function() {
var items = [
{
"name" : "Closed Door",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/646/thumbnail_Screen_Shot_2014-10-27_at_8.04.12_PM.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/617/closed-door28x80_baked.js",
"image" : "models/thumbnails/thumbnail_Screen_Shot_2014-10-27_at_8.04.12_PM.png",
"model" : "models/js/closed-door28x80_baked.js",
"type" : "7"
},
{
"name" : "Open Door",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/617/thumbnail_Screen_Shot_2014-10-27_at_8.22.46_PM.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/174/open_door.js",
"image" : "models/thumbnails/thumbnail_Screen_Shot_2014-10-27_at_8.22.46_PM.png",
"model" : "models/js/open_door.js",
"type" : "7"
},
{
"name" : "Window",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/618/thumbnail_window.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/165/whitewindow.js",
"image" : "models/thumbnails/thumbnail_window.png",
"model" : "models/js/whitewindow.js",
"type" : "3"
},
{
"name" : "Chair",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/182/thumbnail_Church-Chair-oak-white_1024x1024.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/132/gus-churchchair-whiteoak.js",
"image" : "models/thumbnails/thumbnail_Church-Chair-oak-white_1024x1024.jpg",
"model" : "models/js/gus-churchchair-whiteoak.js",
"type" : "1"
},
{
"name" : "Red Chair",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/739/thumbnail_tn-orange.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/723/ik-ekero-orange_baked.js",
"image" : "models/thumbnails/thumbnail_tn-orange.png",
"model" : "models/js/ik-ekero-orange_baked.js",
"type" : "1"
},
{
"name" : "Blue Chair",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/740/thumbnail_ekero-blue3.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/722/ik-ekero-blue_baked.js",
"image" : "models/thumbnails/thumbnail_ekero-blue3.png",
"model" : "models/js/ik-ekero-blue_baked.js",
"type" : "1"
},
{
"name" : "Dresser - Dark Wood",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/240/thumbnail_matera_dresser_5.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/189/DWR_MATERA_DRESSER2.js",
"image" : "models/thumbnails/thumbnail_matera_dresser_5.png",
"model" : "models/js/DWR_MATERA_DRESSER2.js",
"type" : "1"
},
{
"name" : "Dresser - White",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/500/thumbnail_img25o.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/478/we-narrow6white_baked.js",
"image" : "models/thumbnails/thumbnail_img25o.jpg",
"model" : "models/js/we-narrow6white_baked.js",
"type" : "1"
},
{
"name" : "Bedside table - Shale",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/386/thumbnail_Blu-Dot-Shale-Bedside-Table.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/357/bd-shalebedside-smoke_baked.js",
"image" : "models/thumbnails/thumbnail_Blu-Dot-Shale-Bedside-Table.jpg",
"model" : "models/js/bd-shalebedside-smoke_baked.js",
"type" : "1"
},
{
"name" : "Bedside table - White",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/382/thumbnail_arch-white-oval-nightstand.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/353/cb-archnight-white_baked.js",
"image" : "models/thumbnails/thumbnail_arch-white-oval-nightstand.jpg",
"model" : "models/js/cb-archnight-white_baked.js",
"type" : "1"
},
{
"name" : "Wardrobe - White",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/735/thumbnail_TN-ikea-kvikine.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/717/ik-kivine_baked.js",
"image" : "models/thumbnails/thumbnail_TN-ikea-kvikine.png",
"model" : "models/js/ik-kivine_baked.js",
"type" : "1"
},
{
"name" : "Full Bed",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/72/thumbnail_nordli-bed-frame__0159270_PE315708_S4.JPG",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/39/ik_nordli_full.js",
"image" : "models/thumbnails/thumbnail_nordli-bed-frame__0159270_PE315708_S4.JPG",
"model" : "models/js/ik_nordli_full.js",
"type" : "1"
},
{
"name" : "Bookshelf",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/419/thumbnail_kendall-walnut-bookcase.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/388/cb-kendallbookcasewalnut_baked.js",
"image" : "models/thumbnails/thumbnail_kendall-walnut-bookcase.jpg",
"model" : "models/js/cb-kendallbookcasewalnut_baked.js",
"type" : "1"
},
{
"name" : "Media Console - White",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/434/thumbnail_clapboard-white-60-media-console-1.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/400/cb-clapboard_baked.js",
"image" : "models/thumbnails/thumbnail_clapboard-white-60-media-console-1.jpg",
"model" : "models/js/cb-clapboard_baked.js",
"type" : "1"
},
{
"name" : "Media Console - Black",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/435/thumbnail_moore-60-media-console-1.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/404/cb-moore_baked.js",
"image" : "models/thumbnails/thumbnail_moore-60-media-console-1.jpg",
"model" : "models/js/cb-moore_baked.js",
"type" : "1"
},
{
"name" : "Sectional - Olive",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/547/thumbnail_img21o.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/526/we-crosby2piece-greenbaked.js",
"image" : "models/thumbnails/thumbnail_img21o.jpg",
"model" : "models/js/we-crosby2piece-greenbaked.js",
"type" : "1"
},
{
"name" : "Sofa - Grey",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/627/thumbnail_rochelle-sofa-3.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/596/cb-rochelle-gray_baked.js",
"image" : "models/thumbnails/thumbnail_rochelle-sofa-3.jpg",
"model" : "models/js/cb-rochelle-gray_baked.js",
"type" : "1"
},
{
"name" : "Wooden Trunk",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/372/thumbnail_teca-storage-trunk.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/343/cb-tecs_baked.js",
"image" : "models/thumbnails/thumbnail_teca-storage-trunk.jpg",
"model" : "models/js/cb-tecs_baked.js",
"type" : "1"
},
{
"name" : "Floor Lamp",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/641/thumbnail_ore-white.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/614/ore-3legged-white_baked.js",
"image" : "models/thumbnails/thumbnail_ore-white.png",
"model" : "models/js/ore-3legged-white_baked.js",
"type" : "1"
},
{
"name" : "Coffee Table - Wood",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/104/thumbnail_stockholm-coffee-table__0181245_PE332924_S4.JPG",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/68/ik-stockholmcoffee-brown.js",
"image" : "models/thumbnails/thumbnail_stockholm-coffee-table__0181245_PE332924_S4.JPG",
"model" : "models/js/ik-stockholmcoffee-brown.js",
"type" : "1"
},
{
"name" : "Side Table",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/188/thumbnail_Screen_Shot_2014-02-21_at_1.24.58_PM.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/138/GUSossingtonendtable.js",
"image" : "models/thumbnails/thumbnail_Screen_Shot_2014-02-21_at_1.24.58_PM.png",
"model" : "models/js/GUSossingtonendtable.js",
"type" : "1"
},
{
"name" : "Dining Table",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/369/thumbnail_scholar-dining-table.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/340/cb-scholartable_baked.js",
"image" : "models/thumbnails/thumbnail_scholar-dining-table.jpg",
"model" : "models/js/cb-scholartable_baked.js",
"type" : "1"
},
{
"name" : "Dining table",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/143/thumbnail_Screen_Shot_2014-01-28_at_6.49.33_PM.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/100/BlakeAvenuejoshuatreecheftable.js",
"image" : "models/thumbnails/thumbnail_Screen_Shot_2014-01-28_at_6.49.33_PM.png",
"model" : "models/js/BlakeAvenuejoshuatreecheftable.js",
"type" : "1"
},
{
"name" : "Blue Rug",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/467/thumbnail_cb-blue-block60x96.png",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/440/cb-blue-block-60x96.js",
"image" : "models/thumbnails/thumbnail_cb-blue-block60x96.png",
"model" : "models/js/cb-blue-block-60x96.js",
"type" : "8"
},
{
"name" : "NYC Poster",
"image" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_picture/image/111/thumbnail_nyc2.jpg",
"model" : "https://blueprint-dev.s3.amazonaws.com/uploads/item_model/model/77/nyc-poster2.js",
"image" : "models/thumbnails/thumbnail_nyc2.jpg",
"model" : "models/js/nyc-poster2.js",
"type" : "2"
}
/*
Expand Down
Loading

0 comments on commit af47af8

Please sign in to comment.