real_api_bbl v1.0.71

real_api_bbl

Render babylon.js scene at run time

Installation

npm install real_api_bbl

Documentation

Render a job

Requirements:

• Signup free account at https://realistic3.com (You will need this for API Key Authorization)
• App Key
• Product Key
• Instance ID (Optional, default is 0)
• Kindly check the details at https://docs.realistic3.com/getting-started

Getting started

Import:

import * as REAL from "real_api_bbl";

Step 3: Create new job

• Details: https://docs.realistic3.com/using-rest-api-calls/new-job

import * as REAL from "real_api_bbl";

const uri = `https://${REAL.Domain}/rapi/ask_service`;

const params = {
    "prodCred": {
        "insID": 0,
        "appKey": "ABC",
        "prodKey": "XYZ"
    },
    "ask": "new_job",
    "renderParams": {
        "expFrom": "3js"
    }
}

const response = await axios.post(uri, params);

Step 4: Upload scene

• Details: https://docs.realistic3.com/using-rest-api-calls/upload-job

const renderScene = await REAL.Scene(scene, camera);
const request = await axios.put(uploadUri, renderScene);

Step 5: Submit job

• Details: https://docs.realistic3.com/using-rest-api-calls/submit-job

import * as REAL from "real_api_bbl";

const uri = `https://${REAL.Domain}/rapi/ask_service`;

const params = {
    "prodCred": {
        "insID": 0,
        "appKey": "ABC",
        "prodKey": "XYZ"
    },
    "ask": "submit",
    "service": {
        "jobID": jobID
    }
}

const response = await axios.post(uri, params);

Check job status

• Using SOCKET: https://docs.realistic3.com/using-socket
• Using REST API: https://docs.realistic3.com/using-rest-api-calls

More features:

Area light

• Details: https://realistic3.com/docs/bbl/area-light

const options = {
    width: 1,
    height: 2,
    intensity: 2,
    diffuse: new BABYLON.Color3(0.66, 0.56, 0.2)
}
const light = new REAL.AreaLight(scene, options);

Sunlight

• Details: https://realistic3.com/docs/bbl/sun-light

const options = {
    intensity: 2,
    shadowEnabled: true,
    diffuse: new BABYLON.Color3(0.66, 0.56, 0.2)
}
const light = new REAL.SunLight(scene, options);

Point Light

• Details: https://realistic3.com/docs/bbl/point-light

const options = {
    range: 20,
    intensity: 2,
    shadowEnabled: true,
    diffuse: new BABYLON.Color3(0.66, 0.56, 0.2)
}
const light = new REAL.PointLight(scene, options);

Spotlight

• Details: https://realistic3.com/docs/bbl/spot-light

const options = {
    range: 20,
    angle: 1.5,
    intensity: 2,
    shadowEnabled: true,
    diffuse: new BABYLON.Color3(0.66, 0.56, 0.2)
}
const light = new REAL.SpotLight(scene, options);