Introduction

Lmonix is a desktop application for creating webVR prototype's, the tool consist's of a simple design editor for creating the static scene and a prototype editor for creating animation's and adding logic using script's. The following scene can been exported out as aframe component's, with all the necessary script's and asset's. The main goal of this project was to create a simple prototyping tool for designers and developers. The current build only support macOS.

Design

The design editor is used for building the static scene, you can add entities such as basic 3D objects, lighting, environments, images / videos, 3D models etc. After adding the entities they will be displayed under the scene section where you can group multiple entities and create a hierarchy in between entites. On the right hand side the properties of each individual entity will appear when you select them. You can edit different form of properties associated with the entity you selected, Mesh based entities will generally will be having properties such as geometry, material etc., whereas with light based entities it will be intensity, angle etc.

Scene

The scene represent the entities you added inside your render, over here you can interact with each individual object or a group of objects. Over here you can copy/paste, delete, rename them, group with other entites etc. note: These options appear when you right click on the active entity inside the scene. The naming for each individual object needs to be unique because the name for each object can be used during prototyping individually.

Drag/Drop	Copy/Paste	Group In

Entity Properties

You can edit each individual entity properties, which are displayed on the right hand side of the application window. Over here we can edit common properties such as rotation, scale, position, change material based attributes, add assets, add shadow's etc.

Adding Assets

Currently the type of assets which are being supported are images(jpg, png, jpeg, webp), video(mp4, webm), sound(mp3), 3D models(gtlf & obj) only. Assets are available on mesh based entities as Texture or 3D Model. To add a new asset you would get the option on the properties section as Add Texture or Add Models. Google Poly Models can be accessed by clicking on the poly logo, which provides you whole bunch of low poly models.

`Add Texture`

We can add textures to basic models by selecting them from the local directory, the supported formats are .png, .jpg, .jpeg, .webp, .webm, & .mp4. Textures can be added by selecting the texture option inside the properties panel.

`Add Models`

To add 3D models inside the scene, we can select the directory containing the model as well as the texture's and other files related to that particular model, the supported formats are gtlf models & obj models. Models can be added by selecting the model option inside the properties panel.

Prototype

The prototype editor is used for adding animations and interactions to our static scene, over here each individual element can be added multiple animation properties at the very same time. We can build also build a timeline across the animations we have added, inside prototype we also have a code editor where we can add our logic and interactions for each individual entity.

Animation

By adding animations it helps us to make the scene a bit more lively, especially when interacting with them or other entities . You can add multiple animation instances to a single entity ( i.e the entity can rotate and scale at the same time) . The animations of a entity will appear on the right-hand side of the editor. To add a new animation right-click on the entity under scene -> Add animations -> select your property.

Under the animation panel the available options will be:

Property : Assign from - animation starting point & to animation end point.
Timing : Change the duration for animation or delay.
Order : Control which way the animation should flow such as direction or looping.
Easing : Apply Easing functions (i.e specify the rate of change of a parameter over time) to the animation.
Trigger Event : Mention Start, Resume or Pause events for the animation. ( Note: if start event is mentioned the animation will not start on scene load.)

Code

Inside the code editor we can write our logic for interactions. As the final render produces a Aframe based components, each entity can be accessed by their name ( Note: The name of each entity under the scene panel will be used as DOM "id" for Aframe components) . It will be better if you rename the one's you are going to be using inside the code editor . You can use usual javascript API's and Aframe API's over here too .

Adding Snippets

Snippet's consists of event listeners for entities, entity object & other methods. To add a new snippet right-click on entity under scene -> Add Snippet.

The options available are:

Cursor : Cursor events occured on the entity such as click,mouseEnter & mouseLeave,Note: To enable cursor go to the settings .
Object : Gives the entity DOM node.
Emit : Used for trigger animation events such as start, pause, resume or any other custom events.
Set Attribute: Used for changing DOM entity attribute's.
Get Attribute: Used for getting DOM entity attribute's value.

Project Directory Structure

When we create a new project, a folder directory will be created which will consist of index.html, data.json, scripts and Assets folder. It has been set up in such a way that you can just. To run the project you can run a local host server inside the project directory.

📁my-app
├── index.html
├── data.json // Data of the whole scene and project
├── 📁scripts // Script's are added over here
│   └──index.js
└── 📁Assets // All the assets will be present under Assets
    ├── image.png
    ├── video.mp4
    ├── 📁gltfModel
    │   ├── scene.gltf
    │   ├── scene.bin
    │   └── 📁textures
    │       └── image0.png
    ├── image2.jpeg
    └── 📁objModel
        ├── model.obj
        └── model.mtl

Open project in any editor

Preview

You can start the local server by clicking on the play button logo on the top right corner of the, and then click on Start Server. It will display the url which you can access on any device through the web browser, connected on the same wifi network.

Available Scripts

In the project directory, you can run:

`yarn start`

Runs the app in the development mode.

`yarn build`

Builds the react app for production to the build folder.
Bundles the final distribution inside the dist folder.

pizza3 / lmonix Goto Github PK

lmonix's Introduction