BuildIn3D Documentation

1 Creating a 3D model and instruction

To create a new 3D model and instruction

  1. Visit "Dashboard"
  2. Select "Instructions->New"
  3. Upload a file from a supported type

After uploading, BuildIn3D will start converting you 3D file into a BuildIn3D model and building instruction that could be delivered over the Internet. It could take some time, generally up to 10 minutes, but when complex instructions are uploaded and a lot of pictures for the parts list should be rendered it might take more time.

2 Cover video and Cover picture

When a 3D model or building instruction is visualized, BuildIn3D shows the 3D model directly to the user by default. When there are 3D animations they are played by default. When there are no animations we might play a default animation. Users could select the "Instructions" button and will see the instruction in a step-by-step view.

In some cases when the 3D model does not look "realistic enough" or the 3D animation can not be played we allow authors to upload a rendered video or picture of the instruction. This picture or video will be the first thing the users see when they visit the instructions.

    IMPORTANT:

    We do NOT recommend the use of Cover pictures and Cover videos, but only the use of Thumbnail Pictures and Thumbnail videos. Cover pictures and videos are only for the cases where it would be too expensive to develop a good looking 3D model and animation.
    IMPORTANT: 

    Cover Videos and Cover Pictures would also incur additional charges for the sites visualizing the instruction as these are additional assets that should be delivered to the end user browser.

When an instruction is visualized we look for videos and pictures in order and we visualize the first video or picture that is provided by the author.

  • Full access – when the user has full access to the instruction the order is:
1. Cover video
2. Cover picture
3. 3D model
  • Preview access – when the user has only preview access to the instruction the order is:
1. Cover video
2. Thumbnail video
3. Cover picture
4. Thumbnail picture
5. 3D model

Below you can find details and examples along with information about how to configure Cover pictures and Cover videos.

2.1 As a 3D model

The following example shows how 3D model and building instructions are visualized by default. There are no pictures or videos. This is the preffered default behaviour.

Example: Visualized as 3D model

Visualized as 3D model

2.2 As an Instruction

When the 3D model and building instruction is visualized, the users see the model assembled. When the model supports it, BuildIn3D can visualize a step-by-step instruction. To see the step-by-step building instruction the users should select the "Instruction" button.

Example: Visualized as 3D model. Users should select 'Instruction' to see a step-by-step view

Visualized as 3D model

2.3 Thumbnail picture

When a BuildIn3D model and building instruction is shown on the index page and along with other instructions we show a picture of the model. By default we show the "Thumbnail" picture of the instruction.

    IMPORTANT:

    When an instruction does not have a Thumbnail or a Cover picture it will not appear on the index page. Make sure your instructions have at least a Thumbnail picture.

To set a Thumbnail picture:

  1. Visit Dashboard->Instructions
  2. Select the instruction you would like to edit
  3. Select "Pictures" from the instruction sidebar
  4. Select "Add" to add a new picture to the instruction or Select "Actions->Edit" to edit an existing picture
  5. Select "Thumbnail" from the dropdown.
  6. Select "Update"

This picture would appear for this instruction on pages that show an index for BuildIn3D models and instructions.

Example: The instruction index page of BuildIn3D shows the thumbnails

image

2.4 Thumbnail video

Thumbnail videos are used for showing a video when the users have only preview access to the instruction. When they have full access the Thumbnail video will not be shown.

To set a Thumbnail video:

  1. Visit Dashboard->Instructions
  2. Select the instruction you would like to edit
  3. Select "Videos" from the instruction sidebar
  4. Select "Add" to add a new video to the instruction or Select "Actions->Edit" to edit an existing video
  5. Select "Thumbnail" from the dropdown.
  6. Select "Update"

The instructions below has a Thumbnail video. You should see the video if you have no access to instruction (because you have no registration or subscription to FLLCasts).

Example: Instruction with Thumbnail Video at FLLCasts

Visualized as 3D model

2.5 Cover picture

As an author you can decide that you would like to show a cover picture instead of the 3D model when the instruction is initially visualized. In this way you have enough artistic freedom to upload any picture.

  1. Visit Dashboard->Instructions
  2. Select the instruction you would like to edit
  3. Select "Picture" from the instruction sidebar
  4. Select "Add" to add a new picture to the instruction or Select "Actions->Edit" to edit an existing picture
  5. Select "Cover" from the dropdown.
  6. Select "Update"

In this way every time a user visits the instruction a picture covering the model and the instruction will be initially shown.

The following example shows how this works. The instruction is visualized and the users see the Cover picture instead of the 3D model. When they select "Start Building" they see the step-by-step instructions. When they select "Model" they will again see the Cover picture.

When a Cover picture is selected it also acts as a Thumbnail.

2.6 Cover video

When a BuildIn3D model and building instruction is visualized to users all the animations in the 3D model are played. Sometimes it is difficult to develop animations that can be played in the browser as 3D animations. BuildIn3D provides authors with the artistic freedom to provide a rendered video for the 3D model and building instruction.

The "Cover video" will be played when the 3D model and building instructions is visualized.

To select a Cover video visit:

  1. Visit Dashboard->Instructions
  2. Select the instruction you would like to edit
  3. Select "Videos" from the instruction sidebar
  4. Select "Add" to add a new video to the instruction or Select "Actions->Edit" to edit an existing video
  5. Select "Cover" from the dropdown.
  6. Select "Update"

In this way every time a user visits the instruction the Cover video will be played.

The following example shows how this works. The instruction is visualized and the users see the Cover video instead of the 3D model. When they select "Start Building" they see the step-by-step instructions. When they select "Model" they will again see the Cover video.

When there is both a Cover picture and Cover video then the Cover video takes precedence and will be visualized.

2.7 Preview 3D model and building instruction

BuildIn3D can show the full 3D model and building instruction only to users registered or subscribed to your platform. Users without access will see only a "Preview" of the model and building instruction.

When a preview is shown only the first 11 steps from the instruction are shown by default. (11 is a prime number, we are nerds, and we've found it is just enough for users to see how the instruction looks like).

Here is an example of a preview for a 3D model and building instruction visualized only to subscribed users at FLLCasts. (If you are logged in at FLLCasts and have a subscription please log out to see the preview of the instruction)

2.8 'Thumbnail' and 'Cover' pictures and videos for a preview model

When a preview is shown by BuildIn3D, the full geometry of the 3D model uploaded by the author is not delivered. Only part of the geometry reaches the user browser. Because of this we always try show a video or a picture when we show a preview of the BuildIn3D instruction.

The order is specified in the beginning of this chapter.

Here are few examples of how a preview of an instrution will be shown when there are different settings for Cover/Thumbnail video and pictures.

  1. Cover video and visualized on FLLCasts – has Cover video so we choose to show cover video

    1.1 You should SEE the Cover video when you are LOGGED OUT from FLLCasts

    Example of a Preview with Cover Video on FLLCasts

    box robot from fllcasts

    1.2 You should SEE the Cover video when you are LOGGED IN at FLLCasts

    Example of a Preview with Cover Video on FLLCasts

    box robot from fllcasts

  2. Cover video and embedded from FLLCasts

    2.1 You should SEE the Cover video when you are LOGGED OUT from FLLCasts

    Embedded Example of a Preview with Cover Video

    box robot from fllcasts

    2.2 You should SEE the Cover video when you are LOGGED IN at FLLCasts

    Embedded Example of a Preview with Cover Video

    box robot from fllcasts

  3. Thumbnail video and visualized on FLLCasts

    3.1 You should SEE the Thumbnail video when you are LOGGED OUT from FLLCasts

    Instruction with Thumbnail video at FLLCasts

    Visualized as 3D model

    3.2 You should NOT SEE the Thumbnail video when you are LOGGED IN at FLLCasts

    Instruction with Thumbnail video at FLLCasts

    Visualized as 3D model

  4. Thumbnail video and embedded from FLLCasts

    4.1 You should SEE the Thumbnail video when you are LOGGED OUT from FLLCasts

    Embedded instruction with Thumbnail video from FLLCasts

    Visualized as 3D model

    4.2 You should NOT SEE the Thumbnail video when you are LOGGED IN at FLLCasts

    Embedded instruction with Thumbnail video from FLLCasts

    Visualized as 3D model

  5. Cover picture and visualized on FLLCasts – does not have Cover video, but has Cover picture so we choose to show Cover picture

    5.1 You should SEE the Cover picture when you are LOGGED OUT from FLLCasts

    Example of a Preview with a Cover picture

    box robot

    5.2 You should SEE the Cover picture when you are LOGGED IN at FLLCasts

    Example of a Preview with a Cover picture

    box robot

  6. Cover picture and embedded from FLLCasts

    6.1 You should SEE the Cover picture when you are logged OUT from FLLCasts

    Embedded Example of a Preview with a Cover picture

    box robot

    6.2 You should SEE the Cover picture when you are logged IN at FLLCasts

    Embedded Example of a Preview with a Cover picture

    box robot

  7. Thumbnail picture and visualized on FLLCasts as Preview – has no cover video, thumbnail video or cover picture and you are in preview. Open the browser in private mode to make sure you are not logged in at FLLCasts

    7.1 You should SEE the Thumbnail picture when you are LOGGED OUT from FLLCasts

    Еxample of a Preview with a Thumbnail Picture

    FLL Picture for mission model

    7.2 You should SEE the Thumbnail picture when you are LOGGED IN at FLLCasts

    Еxample of a Preview with a Thumbnail Picture

    FLL Picture for mission model

  8. Thumbnail picture and embedded from FLLCasts as Preview

    8.1 You should SEE the Thumbnail picture when you are LOGGED OUT from FLLCasts

    Embedded Еxample of a Preview with a Thumbnail Picture

    FLL Picture for mission model

    8.2 You should SEE the Thumbnail picture when you are LOGGED IN at FLLCasts

    Embedded Еxample of a Preview with a Thumbnail Picture

    FLL Picture for mission model

  9. Thumbnail picture and visualized on FLLCasts (full access) Log in at FLLCasts and make sure you have an active subscription.

    9.1 You should SEE the Thumbnail picture when you are LOGGED OUT from FLLCasts

    Еxample of an instruction with just Thumbnail picture

    FLL Picture for mission model

    9.2 You should NOT SEE the Thumbnail picture when you HAVE ACCESS at FLLCasts

    Еxample of an instruction with just Thumbnail picture

    FLL Picture for mission model

  10. Thumbnail picture and embedded from FLLCasts (full access)

    10.1 You should SEE the Thumbnail picture when you are LOGGED OUT from FLLCasts

    Embedded example of an instructions with just Thumbnail Picture

    FLL Picture for mission model

    10.2 You should NOT SEE the Thumbnail picture when you are LOGGED IN at FLLCasts

    Embedded example of an instructions with just Thumbnail Picture

    FLL Picture for mission model

  11. No Cover or Thumbnail and visualized on FLLCasts – the instruction has no Cover or Thumbnail picture or videos. We can not show anything for a cover about this instruction so we just show it as it is.

    11.1 You should NOT SEE a picture or video, when you are LOGGED OUT – just part of the 3D model for the instruction

    Еxample of a Preview without picture or video

    11.2 You should NOT SEE picture or video, when you are LOGGED IN – just part of the 3D model for the instruction

    Еxample of a Preview without picture or video

  12. No cover or thumbnail and embedded from FLLCasts

    12.1 You should NOT SEE a picture or video, when you are LOGGED OUT – just part of the 3D model for the instruction.

    Embedded example of a Preview without picture or video

    12.2 You should NOT SEE a picture or video, when you are LOGGED IN – just part of the 3D model for the instruction.

    Embedded example of a Preview without picture or video

3 Editing a 3D model and instruction with IS Editor

IS Editor stands for "Instructions Steps Editor". It allows you to edit a lot of details about the 3D models and instructions like the order of steps, background, camera rotations for each step and many more.

To access the IS Editor

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"

3.1 Configure the background color for an instruction

As an author you can change the background of the scene using the Instructions Steps (IS) editor. To do this:

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"
  4. Select the button for changing background.

Choose the background color and select "Save".

A demo could be seen at: https://youtu.be/2n6pRSKnIIQ

3.2 Configure the primary color for an instruction

The primary color is the color applied to navigation buttons, parts list, step info and other information that is part of the way instructions are visualized. To change the primary color:

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"
  4. Select the button for changing primary color.

Choose the primary color and select "Save".

A demo could be found at: https://youtu.be/2n6pRSKnIIQ

3.3 Configure the camera rotation for a step

IS Editor allows you to edit the angle from which users see a specific step. In this way you can make it more clear how they should follow the step. To configure the rotation. We support two types of rotations – LDR style and freestyle

3.3.1 Rotation

The 'rotation' is specified with three digits like "23 45 0". This means the rotation by the x axis is 23 degrees, the rotation by the y axis is 45 degrees and the rotation by the z axis is 0 degrees. Values should be separated by a space. Float numbers like "23.5 45.1 0.1" are also supported.

To set the 'Rotation'

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"
  4. Select "Instruction" to enter instruction mode
  5. In the Tree Viewer select the step you would like to edit
  6. In the Properties view change the value for
rotation

By using LDR rotation you can not change the position of the camera. The camera is always position on a sphere around the bounding box of the model. The sphere is large enough to see the whole model.

To change how close the camera is you must use the camera position option.

3.3.2 Camera Position

The 'camera position' property is a more fine grainded and allows more freedom when setting the position of the camera on the step compared to the Rotation property. It allows you specific the exact position of the camera with the mouse.

To set the camera position

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"
  4. Select "Instruction" to enter instruction mode
  5. Rotation and more the camera with the mouse. Select "Set as camera position" button. The current position of the camera will be saved.

3.3.3 Default camera position for a step

When visualizing a ste the camera position for a step is determined in the following way.

  1. Check if there is 'camera position' and apply it.
  2. Check if there is 'rotation' and apply it
  3. Find the position/rotation applied from previous steps and apply it to the current step

By default when entering a module the rotation is set as "23 45 0". In

3.3.4 Clear 'camera position' and 'rotation'

You can clear the "camera position" and "rotation" for a step. In this way the step will take the "rotation" and "camera position" from the previous steps.

To clear the 'camera position' and 'rotation'

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"
  4. Select "Instruction" to enter instruction mode
  5. In the Tree Viewer select the step you would like to edit
  6. In the Scene Editor select "Clear position"

3.3.5 Set default rotation

You can set default rotation for a step. The default rotation is "23 45 0". The difference between "Default" and no rotation is that the default rotation is "23 45 0" while when no 'rotation' or 'camera position' is set we would visualize the step from the same angled as the previous step. And the previous step my not be in a 'default' rotation

To set default rotation

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"
  4. Select "Instruction" to enter instruction mode
  5. In the Tree Viewer select the step you would like to edit
  6. In the Scene Editor select "Set default rotation"

3.4 Configure "Step info" for a step – explanation in textual form about the step.

You can add custom explanation of what should happen on each step. This explanation is in a text form and it will be displayed appropriately on the scene when the instruction is followed by the user.

To configure the step info

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"
  4. Select "Instruction" to enter instruction mode
  5. In the Tree Viewer select the step you would like to edit
  6. In the Properties view edit "step info" property

3.5 Configure "Step confirmation"

As an author you could ask users to confirm certain steps. There are different forms of confirmation

3.5.1 Required step confirmation

With "Required" step confirmation the user following the instruction is "Required" to explicitly confirm that they've completed the step. Users are not allowed to continue forward with the instruction until they confirm the step was completed.

If the user does not confirm the step, they stay on the same step until they confirm they've completed it.

An instruction can have more than one step for which step confirmation is required.

To configure a step as required:

  1. Visit "Dashboard"
  2. Select the instruction you would like to edit
  3. Select "IS Editor"
  4. Select "Instruction" to enter instruction mode
  5. In the Tree Viewer select the step you would like to edit
  6. In the Properties view edit "confirmation" property and set the value "required"

4. Collaborating on an Instruction

Author could add other authors to work on the same instruction. To add an author

  1. Visit Dashboard->Instructions
  2. Select the instruction you would like to edit
  3. Select "Authors"
  4. Search for an author you would like to add to the instruction. 4.1 When the user has registration with buildin3d.com then you should be able to find them by username, email, or full name. 4.2 When the user has no registration with buildin3d.com then you can invite them by selecting "Create/Invite a new account" and following the steps on the screen.