create new scene.

scene.reset();

Delete scene node.

scene.remove(node);

import the requested file

var importFile = scene.importFile(fileName);

A function to import a SIM or ZIM file to the scene with its environment settings (Ver. 10.21+).

var importedFile = scene.importFileWithEnvironment(fileName);

scene.IsSaveAs(true);

open the requested file

scene.openFile(SimFilePath);

export the requested file

scene.exportFile(ExportPath);

export the requested file by given export file path,and by given array of scripting scene states that you want to export with file

var sceneStateArr = new Array(2);
sceneStateArr.push(sceneState_1);
sceneStateArr.push(sceneState_2);
scene.exportFile(ExportPath,sceneStateArr);

apply The requested replace rules file.

scene.applyReplaceRules(ReplaceRulesFilePath);

render the current view as shown in composer

scene.render(outputPath);
scene.render(outputPath,true); // true means that the output directory won't open after rendering

render the current view as shown in composer

scene.render(outputPath,2048,1024);

renders number of frames from startFrame to sendFrame

scene.renderAnimation(inputfile,outputPath,2,16);

packing the scene locally

scene.packTheScene(outputPath,".sim");

rendering packed file according to a text file specifies the number of frames should be rendered and where the results should be returned

scene.movieMaker(outputPath,"D:\\ImagesIwantToMakeAVideoFrom","high",30,"D:\\OutputMovie","D:\\audio\\babyCrying.mp3");

bake the current view as shown in composer

scene.bakeTexture(true);

bake the selected objects.

var nodesArr = new Array(2);
nodesArr.push(BoxNode);
nodesArr.push(SphereNode);

scene.bakeTexture(true,nodesArr);

bake object for animation will bake each selected sceneNode after isolate it

var nodesArr = new Array(2);
nodesArr.push(BoxNode);
nodesArr.push(SphereNode);

scene.bakeTextureForAnimation(true,nodesArr);

change the texture baking settings

scene.setTextureBakingSettings(1024,2048,1000,true,false,50000);

Import pattern (smd file) and automatically generate animation/Sequence

scene.createDoorAndCabinetsAnimation("D:/patternFile.smd");

capture a new scripting scene state from the current view that shown in composer

var mySceneState = new SceneState ();
mySceneState = scene.captureSceneState();

capture a new scripting scene state from the current view that shown in composer

var mySceneState = new SceneState ();
mySceneState = scene.captureSceneStateFromSelection();

Sets the template for PDF exporting

scene.setPDFTemplateFileName("D:\\Templets\\MyPDFTemplate.stf");

generate an image with passed width and height renderer

scene.captureSceneImage("Scene_1", 100,100);

create a new scripting camera and return it

var myCamera = scene.createCamera();

create instance of passed node and return new node created

var instanceOfBox = scene.createInstanceOf(BoxNode);

create a new scripting material and return it

var myMaterial = scene.createMaterial();

create a new scripting light and return it

var myLight = scene.createLight();

create round table animation for active camera

myActiveCamera.createRoundTableCameraAnimation(false);

compute the volume of the imported scene and bounding box then write it in text file

scene.exportSceneData("D:\\outputFile.sim");

isolate the selected nodes

scene.isolate(sphereNode);

unisolate the selected nodes

sphereNode.unisolate();

retain scene materials with their properties from files

scene.retainMaterialPalette("D:\\myMaterial.smp","mateial");

retain scene materials with their properties from files

var isCreated = scene.exportVrPackage("D:\\VR\\myVRModel.vrpackage","SimLab_Default","SimLab","THIS IS OUR DEFAULT MODEL","3d","D:\\VRPackageImage.png");

retain scene materials with their properties from files

var isAdded = scene.addAttribute("ViewerStartPostion","ViewerStart","","",""); // this is an example of setting viewerStartPosition attributes

this function takes list of the objects based on include and doesNotInclude strings, import the input file, then replace the objects in the selected list object with the importer file

scene.replaceObject("BoxNode","MySphere","D:\\model.sim");

Sets the field of view.

camera.fov = 60;
camera.setFov(60);

Return the field of view value.

var cameraFOV = camera.fov;
var cameraFOV= camera.getFov();

Return camera position value.

var cameraPosition = camera.position;
var cameraPosition= camera.getPosition();

Return camera target position.

var cameraTargetPosition = camera.targetPosition;
var cameraTargetPosition= camera.getTargetPosition();

Return camera up vector.

var cameraUp = camera.up;
var cameraUp = camera.getUp();

Return the field of view value.

var boundingBoxCenter = boundingBox.getCenter();
var boundingBoxCenter = boundingBox.center;

Return the field of view value.

var boundingBoxMax = boundingBox.getMax();
var boundingBoxMax = boundingBox.max;

Return camera position value.

var boundingBoxMin = boundingBox.getmin();
var boundingBoxMin = boundingBox.min;

Return the image path.

var sceneStateImage = sceneState.UpdateGetImage();

apply current scene state and view it in composer.

sceneState.apply();

Return the light brightness.

var lightBrightness = light.getBrightness();

Return the Inner Cone Angle.

var InnerAngle = light.getInnerConeAngle();

Return the Outer Cone Angle.

var OuterAngle = light.getOuterConeAngle();

Return light type.

var type = light.getType(); // return ies, spot,point or infinite

Set light brightness.

light.setBrightness(5000); 
light.brightness = 5000;

Set light inner Cone Angle .

light.setInnerConeAngle(100); 
light.innerConeAngle = 100;

Set light outer Cone Angle .

light.setOuterConeAngle(100); 
light.outerConeAngle = 100;

Set light type.

light.type("ies"); 
light.type = "point";

Set IES light file name.

light.setIESFileName("D:\\SimLab\\myIESLight.ies");

Return the red value of the color.

var redValue = color.red();

Return the green value of the color.

var greenValue = color.green();

Return the blue value of the color.

var blueValue = color.blue();

Sets the Blue value.

color.setBlue(0.57);  
color.b = 0.58;

Sets the Green value.

color.setGreen(0.7);  
color.g = 0.2;

Sets the Red value.

color.setRed(1);  
color.r = 0.8;

Return the Color.

var color = material.get_diffuseColor();

Set diffuse color.

var color = new Color();
color.r = 1;
color.b = 1;
color.g = 1;

material.set_diffuseColor(color);

Return the inverse of the matrix.

var inverseMatrix = new Matrix4x4();
inverseMatrix = myMatrix.getInverse();
inverseMatrix = myMatrix.inverse();

scales the current matrix and return the result as a new matrix.

var scalledMatrix = myMatrix.scale(2,2,2);

changes the value of this matrix, by scaling it with x,y, and z values.

myMatrix.scale(2,2,2);

returns a new matrix, which is the result of multiplication of this matrix with inMatrix

newMatrix = myMatrix.multiply(simLabMatrix);

Multiplies the current matrix by the specified matrix, and updates the current matrix with the resulting value

myMatrix.multiply(simLabMatrix);

transforms the input vector as a point, and retruns the result in a new vector object

var vector_1 = new Vector3();
vector_2 = myMatrix.transformPosition(vector_1);

compute a new matrix that would be the result of rotating the current matrix by the rotation

var vector = new Vector3();
var matrix = new Matrix4x4();
matrix = myMatrix.translate(vector);

rotate the current matrix by the rotation bwtween the spciified vectors

var vector = new Vector3();
myMatrix.translate(vector);

compute a new matrix that would be the result of rotating the current matrix by the rotation

var vector_1 = new Vector3();
var vector_2 = new Vector3();
var matrix = new Matrix4x4();

matrix = myMatrix.rotate(vector_1,vector_2);

rotate the current matrix by the rotation bwtween the spciified vectors

var vector_1 = new Vector3();
var vector_2 = new Vector3();

myMatrix.rotateInPlace(vector_1,vector_2);

rotate the current matrix around passed vector by specified angle ( angle in radian)

var vector_1 = new Vector3();

myMatrix.rotateAboutVectorInPlace(1.5,vector_1);

set node visibility.

sceneNode.setVisibility(true);
sceneNode.visible = true;

get node visibility.

bool isVisible = sceneNode.getVisibility();
bool isVisible = sceneNode.visible;

get node parent.

var parent = sceneNode.getParent();
var parent = sceneNode.parent;

Compute node bounding box.

var node = sceneNode.computeBoundingBox();

set property name.

renderSettings.set("envColor",red);
renderSettings.set("envPath","D:\\MyHDR.hdr");
renderSettings.set("sunAlbedo",blue);
renderSettings.set("renderMode",1);
renderSettings.set("backgroundType",2); // 1-> HDR , 2-> Sun
renderSettings.set("sphericalBackPlateImage","D:\\MyBackPlateImage.png"); // background image
renderSettings.set("solarHorizontalAngle",32.5);
renderSettings.set("solarElevation",180.0);
renderSettings.set("skyStrength",2);
renderSettings.set("previewRatio",2);
renderSettings.set("turbidity",1);
renderSettings.set("renderSolarDisc",true);
renderSettings.set("spp",1000);
renderSettings.set("showStatistics",true);
renderSettings.set("sphericalBackplateColor",green);
renderSettings.set("sphericalBackplateRadius",2);
renderSettings.set("enableGroundShadow",true);
renderSettings.set("groundShadowColor",black);
renderSettings.set("groundShadowStrength",2);
renderSettings.set("groundReflectionColor",black);
renderSettings.set("colorBackground",black);
renderSettings.set("ambientColor",white);
renderSettings.set("enableAmbientLight",true);
renderSettings.set("ambientLightStrength",1);
renderSettings.set("SpecularDepth",1);
renderSettings.set("lightDepth",1);
renderSettings.set("groundReflectionStrength",1);
renderSettings.set("groundReflectionRoughness",0.5);
renderSettings.set("groundReflectionEnableFresnel",false);
renderSettings.set("groundReflectsEnvironment",true);
renderSettings.set("sunStrength",0.5);
renderSettings.set("enableHemisphericalBackplate",true);
renderSettings.set("sphericalBackplateRadius",2);
renderSettings.set("backplateType",1); // 0-planar backplat 1-spherical backplate 2-from environment 3-color
renderSettings.set("envColor",red);
renderSettings.set("brightness",1.2);

get property name.

var brightnessValue = renderSettings.get("brightness");

set scene object name.

object.PerformSetName("SimLabObject");
object.name = "SimLabObject";

get scene object name.

var objectName = object.PerformGetName();
var objectName = object.name;

get scene object.

var node = scene.node.getByIndex(0);

get scene object Node.

var node = scene.node.getByName("Box");

get scene object Node.

var node = scene.node.getByGuid("SomeGuid");

manually update scene.

scene.update();

set texture path.

texture.setPath("D:\\SimLab\\WoodTexture.png");

diffuseTexture.setScaleU(6);

diffuseTexture.setScalev(6);

diffuseTexture.setOffsetU(6);

diffuseTexture.setOffsetV(6);

get Scale U.

var value = diffuseTexture.getScaleU();

get Scale U.

var value = diffuseTexture.getScaleV();

get Offset U.

var value = diffuseTexture.getOffsetU();

get Offset V.

var value = diffuseTexture.getOffsetV();

set image path.

image.setPath("D:\\SimLab\\WoodTexture.png");

get image path.

var imagePath = image.getPath();

set vector x value.

vector.setX(10); 
vector.x = 10;

set vector Y value.

vector.setY(2); 
vector.y = 2;

set vector Z value.

vector.setZ(5); 
vector.Z = 5;

get vector x value.

var xValue = vector.getX(); 
var xValue = vector.x;

get vector Y value.

var yValue = vector.getY(); 
var yValue = vector.y;

get vector Z value.

var zValue = vector.getZ(); 
var zalue = vector.z;

get vector length.

var length = vector.getLength(); 
var length = vector.length;

normalize current vector vector.

vector.normalize();

Subtracts the passed Vector3 from the current one and return new Vector3.

vector_2 = vector.subtract(vector_1);

scale the current Vector3 by passed number and return new vector.

vector_2 = vector.subtract(2);

Calculates the dot product between the specified Vector3 and the current one.

var dotProdValue = vector.dot(vector_1);

Calculates the cross product between the specified Vector3 and the current one.

var crossProdVector = vector.dot(vector_1);

change current displayed view.

// setView can get a camera as parameter or one of the properties.
runTime.setView(activeCamera); 
runTime.setView(STANDARD_VIEW_TOP);

change its position and lookAt target to make it focused on the nodes.

runTime.fitAll(200,200,0);

show user dialog that contain checkBox so he can make decision.

runtime.UI.getBool("Do you want to import a new model?","Yes"); // ask user if the user wants to import a new model or change current scene view.

show user dialog to get file name user want to save, filter specify type of file to save , If you want multiple filters, separate them with ';;'.

var fileName= runtime.UI.getOpenFileName("Please select a file to import:");

show user dialog to allow him to enter string.

var objectName= runtime.UI.getString("set object name : ");

show user dialog to allow him to enter string.

var brightness= runtime.UI.getValue("Please enter render settings brightness value","Brightness:");

show user dialog to get file name user want to save, filter specify type of file to save , If you want multiple filters, separate them with ';;'.

var path= runtime.UI.getSaveFileName("Exported rendered image location:","","*.jpg;;*.png");

show user color picker dialog and return user selected color

var newColor= runtime.ui.getColor("Pick color to set it to material:"); // return color

show user dialog to inform him to select node.

var light = runtime.ui.getNode("Pick light to change its properties : ");

show user dialog to inform him to select node.

var data = runtime.ui.getData("Filled Cone Copying Settings",  
[ 
{type: runtime.ui.DATA_TYPE_NODE, label : "Node "},
{type: runtime.ui.DATA_TYPE_RAY3, label : "Cone center",init : Ray3(Vector3(0,0,0),   Vector3(0,0,1))},
{type: runtime.ui.DATA_TYPE_VECTOR3, label : "Start point"}
]);

show user dialog to select nodes.

var nodesArray= runtime.ui.getNodeArray("Select the nodes that you want to bake it:");

Add to dictionary map the key and its value

set the value of any named data member.

get the value of any named data member.