Applet Instructions: Color Loom

Press down arrow to see instructions!

Capture an Image

• Take a photo with your webcam, OR
• Drag and drop a photo from your computer

Adjust colors

• Pick additional colors by clicking on the image
• Adjust color swatches using the HSV sliders on the left

Build colormap

• Drag and drop color swatches to the right panel
• Adjust vertically
• Delete clicking and using the 'del' key

Upload to library

Click "Save to Library"

• Family (leave unchanged): your internet ID
• Class: name of your gradient

  Name it anything you like, we suggest gradient1... gradientN to correspond with your physical copy

• Tag: leave blank for colormaps, since the VisAsset is the entire colormap

If you see "successfully uploaded", you're done!

Uploading another colormap

Just click "Take a snap with webcam" again!

Applet Instructions: Infinite Line

Press down arrow to see instructions!

Capture an Image

• Take a photo with your webcam

  Line up your line with the dotted guides

  Use the black/white slider to make sure your line shows up

  Use the aspect ratio slider to match your line

• Drag and drop a photo from your computer

Adjust parameters

• If your line matches at the top and bottom nicely, leave it on "just repeat it"
• If not, use the three sliders to adjust how it looks

Upload to library

Click "Save to Library"

• Family (leave unchanged): your internet ID
• Class: name of your gradient

  Name it anything you like, we suggest gradient1... gradientN to correspond with your physical copy

• Tag: the percentage through your gradient that you labeled on paper (e.g., 50%)

If you see "successfully uploaded", you're done!

Uploading another line

Just click "Take a snap with webcam" again!

Applet Instructions: Texture Mapper

Press down arrow to see instructions!

Capture an Image

• Take a photo with your webcam, or
• Drag and drop a photo from your computer

Crop image

• Crop image so the focus is where you want it

Upload to library

Click "Save to Library"

• Family (leave unchanged): your internet ID
• Class: name of your gradient

  Name it anything you like, we suggest gradient1... gradientN to correspond with your physical copy

• Tag: the percentage through your gradient that you labeled on paper (e.g., 50%)

If you see "successfully uploaded", you're done!

Uploading another texture

Just click "Take a snap with webcam" again!

Vis Manager

Option 1 (preferred): Docker

If you're comfortable with Python and/or don't want to install Docker,
    follow the Python instructions instead.

If you're using a CSE Labs computer or don't want to use Docker on Windows,
   use the embedded vis manager instructions.

Hit the down arrow to see install details

Download Docker

Follow the instructions for your operating system (Windows, Mac, or Linux)

Download vis manager installer

• Download the Install-SculptingVis.zip file into your "SculptingVis" folder
• Unzip the file into the "SculptingVis" folder

  Your SculptingVis folder should now have these files:

Install Vis Manager (Windows and MacOS)

At the end of this process, verify that you have two new folders,
"media", and "logs" in the SculptingVis folder.

• Make sure Docker is running (open the Docker Desktop app)
• Double-click the installer file

  On Windows, you may need to click "More Info" > "Allow Anyway"

  On MacOS, you may need to right click, cmd+click "Open", then click "Open"

• Wait for the vis manager to download and install

  this may take a while

Test Vis Manager (Windows and MacOS)

• Open the Docker Desktop app
• Verify that sculpting-vis-app shows up as a Container
• Click the play button on sculpting-vis-app to start the Vis Manager
• In a browser, go to http://localhost:8000

  You should see the design interface:

Install Vis Manager (Linux)

At the end of this process, verify that you have two new folders,
"media", and "logs" in the same folder you downloaded the installer to.

• Open a terminal to your SculptingVis folder
• Run the installer: ./Install-SculptingVis-Linux.sh
• Wait for the vis manager to download and install

  this may take a while

Test Vis Manager (Linux)

• In a terminal, run docker start sculpting-vis-app
• In a browser, go to http://localhost:8000

  You should see the design interface:

Option 2: Python

This install is advanced and requires command-line usage.
We recommend using the Docker option if you can.

Install Python

The Vis Manager requires Python version 3.8.10.

It may work with 3.9 and 3.10 but hasn't been tested.

Download the code

Clone or download the ABR Server GitHub repository to a memorable place

We suggest a folder named "SculptingVis"

Install requirements

Open a terminal to the abr_server folder, and run:

            python3 -m pip install -r requirements.txt
            python3 manage.py collectstatic --no-input
            python3 manage.py migrate
          

Test the Vis Manager

In a terminal within your abr_server folder, run:

            python3 manage.py runserver
          

Then, in a browser, go to http://localhost:8000

If you see the design interface, like this, you're done!

Embedded Vis Manager

• Download the embedded Vis Manager and unzip it to your SculptingVis folder
• Double-click the RunVisManager.bat file

Your SculptingVis folder should look like this now:

Graphics Engine (ABR)

The Artifact-Based Rendering engine uses the Unity Game Engine.

Install Unity

• Install Unity Hub
• Then, go to 'Installs' > 'Add' > '2020.3.27f1'
• You can uncheck all of the build support options to save space

Get the code

1. Download the support code zip file
2. Unzip it in your "SculptingVis" folder

or, clone the git repository to your SculptingVis folder and checkout the csci5609 branch

Open the project from Unity Hub

1. Under "Projects", click "Add"
2. Select the SculptingVisApp folder you unzipped

   it may be named SculptingVisApp-csci5609

3. Click on the SculptingVisApp project to open it in Unity

Open the 'Main' Scene

1. In the 'Project' tab, click 'Scenes'
2. Double-click 'Main'

Make sure the Vis Manager is running

Check out the install instructions for the Vis Manager

In a browser, go to http://localhost:8000

Start Unity

Press the 'Play' button

Check and make sure there are no errors in the console

One about 'unable to parse color' is normal

If you see something like the following, you're done!