API Reference
Complete reference documentation for all SimLab Python API classes and methods.
Methods
A function to check if a key is found in the command.
Parameters
key |
str |
The key to look for. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
found = arguments.isFound(key)
runtime.ui.alert(str(found))
A function to retrieve the value of the key as float.
Parameters
key |
str |
The key to get its value. |
Returns
float – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
numVar = arguments.getAsNumber(key)
runtime.ui.alert(str(numVar))
A function to retrieve the value of the key as string.
Parameters
key |
str |
The key to get its value. |
Returns
str – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
strVar = arguments.getAsString(key)
runtime.ui.alert(strVar)
A function to retrieve the value of the key as color.
Parameters
key |
str |
The key to get its value. |
Returns
Color – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
colorVar = arguments.getAsColor(key)
runtime.ui.alert(str(colorVar.red()))
A function to retrieve the value of the key as vector.
Parameters
key |
str |
The key to get its value. |
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
vec = arguments.getAsVector3(key)
runtime.ui.alert(str(vec.getX()))
A function to retrieve the value of the key as float.
Parameters
key |
str |
The key to get its value. |
Returns
float – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
numArray = arguments.getAsNumberArray(key)
runtime.ui.alert(str(numArray[0]))
A function to retrieve the value of the key as a list of string.
Parameters
key |
str |
The key to get its value. |
Returns
str – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
stringArray = arguments.getAsStringArray(key)
runtime.ui.alert(stringArray[0])
A function to retrieve the value of the key as a list of color.
Parameters
key |
str |
The key to get its value. |
Returns
Color – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
colorArray = arguments.getAsColorArray(key)
runtime.ui.alert(str(colorArray[0].red()))
A function to retrieve the value of the key as a list of vectors.
Parameters
key |
str |
The key to get its value. |
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
arguments = runtime.args
key = "ie"
vectorList = arguments.getAsVector3Array(key)
runtime.ui.alert(str(vectorList[0].getX()))
Methods
A function that retrieves the center of the bounding box of a scene node.
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneNode = scene.getSelectedNode()
sceneNodeBoundingBox = BoundingBox(sceneNode)
sceneNodeBoundingBoxCenter = sceneNodeBoundingBox.getCenter()
sceneNodeBoundingBoxCenterX = sceneNodeBoundingBoxCenter.getX()
runtime = RunTime()
runtime.ui.alert(str(sceneNodeBoundingBoxCenterX))
A function that retrieves the maximum X, the maximum Y, and the maximum Z of the bounding box.
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
sceneNode = Scene()
sceneNode = scene.getSelectedNode()
sceneNodeBoundingBox = BoundingBox(sceneNode)
sceneNodeBoundingBoxMax = sceneNodeBoundingBox.getMax()
sceneNodeBoundingBoxMaxX = sceneNodeBoundingBoxMax.getX()
runtime = RunTime()
runtime.ui.alert(str(sceneNodeBoundingBoxMaxX))
A function that retrieves the minimum X, the minimum Y, and the minimum Z of the bounding box.
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneNode = scene.getSelectedNode()
sceneNodeBoundingBox = BoundingBox(sceneNode)
sceneNodeBoundingBoxMin = sceneNodeBoundingBox.getMin()
sceneNodeBoundingBoxMinX = sceneNodeBoundingBoxMin.getX()
runtime = RunTime()
runtime.ui.alert(str(sceneNodeBoundingBoxMinX))
Methods
A getter function to get the Field of View of a camera.
Returns
float – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
fieldOfView = newCamera.getFov()
runtime = RunTime()
runtime.ui.alert(str(fieldOfView))
A getter function to get the roll of a camera in degrees (Ver. 12.2+).
Returns
float – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
cameraRoll = newCamera.getRoll()
runtime = RunTime()
runtime.ui.alert(str(cameraRoll))
A getter function to get the Position of a camera.
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
cameraPosition = newCamera.getPosition()
cameraPositionX = cameraPosition.getX()
runtime = RunTime()
runtime.ui.alert(str(cameraPositionX))
A getter function to get the target position of a camera.
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
targetPosition = newCamera.getTargetPosition()
targetPositionX = targetPosition.getX()
runtime = RunTime()
runtime.ui.alert(str(targetPositionX))
A getter function to get the up vector of a camera.
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
cameraUpVector = newCamera.getUp()
cameraUpVectorX = cameraUp.getX()
runtime = RunTime()
runtime.ui.alert(str(cameraUpVectorX))
A setter function that sets a new value for the Field of View of a camera.
Parameters
fieldOfView |
float |
The new value of Field of View for the camera. |
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
fieldOfView = 60
newCamera.setFov(fieldOfView)
newFieldOfView = newCamera.getFov()
runtime = RunTime()
runtime.ui.alert(str(newFieldOfView))
A setter function that sets a new value for the roll (in degrees) of a camera (Ver. 12.2+).
Parameters
roll |
float |
The new roll value for the camera. |
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
cameraRoll = 45.0 # Unit is in degrees
newCamera.setRoll(cameraRoll)
newCameraRoll = newCamera.getRoll()
runtime = RunTime()
runtime.ui.alert(str(newCameraRoll))
A setter function that sets a new vector for the position of a camera.
Parameters
newPosition |
Vector3 |
The new vector of the position for the camera. |
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
newPosition = Vector3()
newCamera.setPosition(newPosition)
A setter function that sets a new vector for the target position of a camera.
Parameters
newTargetPosition |
Vector3 |
The new vector of the target position for the camera. |
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
newTargetPosition = Vector3()
newCamera.setTargetPosition(newTargetPosition)
A setter function that sets a new up vector for a camera.
Parameters
newUpVector |
Vector3 |
The new up vector for the camera. |
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
newUpVector = Vector3()
newCamera.setUp(newUpVector)
Methods
A getter function to get the value of the red channel of the color.
Returns
float – The data type of the returned variable.
from simlabpy import *
newColor = Color(.5, .5, .5)
runtime = RunTime()
runtime.ui.alert(str(newColor.red()))
A getter function to get the value of the green channel of the color.
Returns
float – The data type of the returned variable.
from simlabpy import *
newColor = Color(.5, .5, .5)
runtime = RunTime()
runtime.ui.alert(str(newColor.green()))
A getter function to get the value of the blue channel of the color.
Returns
float – The data type of the returned variable.
from simlabpy import *
newColor = Color(.5, .5, .5)
runtime = RunTime()
runtime.ui.alert(str(newColor.blue()))
A setter function to set a new value for the red channel of the color.
Parameters
newR |
float |
The new value for the red channel of the color. |
from simlabpy import *
newColor = Color()
runtime = RunTime()
newR = 0.4
newColor.setRed(newR)
A setter function to set a new value for the green channel of the color.
Parameters
newG |
float |
The new value for the red channel of the color. |
from simlabpy import *
newColor = Color()
runtime = RunTime()
newG = 0.4
newColor.setGreen(newG)
A setter function to set a new value for the blue channel of the color.
Parameters
newB |
float |
The new value for the red channel of the color. |
from simlabpy import *
newColor = Color()
runtime = RunTime()
newB = 0.4
newColor.setBlue(newB)
Methods
A function to check whether the key is found in the dictionary map or not.
Parameters
key |
str |
The key to look for. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
key = "Author"
value = "SimLab"
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, value)
found = dictionary.isFound(key)
runtime.ui.alert(str(found))
A function to retrieve the value of a key as float from the dictionary map.
Parameters
key |
str |
The key to get its value. |
Returns
float – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
dictionary = runtime.dictionary
key = "Length"
value = 12
dictionary.set(key, value)
lengthValue = dictionary.getAsNumber(key)
newLengthValue = lengthValue + 3;
runtime.ui.alert(str(newLengthValue))
A function to retrieve the value of a key as string from the dictionary map.
Parameters
key |
str |
The key to get its value. |
Returns
str – The data type of the returned variable.
from simlabpy import *
key = "Author"
value = "SimLab"
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, value)
authorValue = dictionary.getAsString(key)
runtime.ui.alert(authorValue)
A function to retrieve the value of a key as Color from the dictionary map.
Parameters
key |
str |
The key to get its value. |
Returns
Color – The data type of the returned variable.
from simlabpy import *
key = "Button"
value = Color()
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, value)
colorValue = dictionary.getAsColor(key)
runtime.ui.alert(str(colorValue.red()))
A function to retrieve the value of a key as vector from the dictionary map.
Parameters
key |
str |
The key to get its value. |
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
key = "Forward"
value = Vector3()
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, value)
vectorValue = dictionary.getAsVector3(key)
runtime.ui.alert(str(vectorValue.getX()))
A function to retrieve the value of a key as a list of floats from the dictionary map.
Parameters
key |
str |
The key to get its value. |
Returns
List – The data type of the returned variable.
from simlabpy import *
key = "Dimensions"
values = []
values.append(10)
values.append(20)
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, values)
numbersList = dictionary.getAsNumberArray(key)
runtime.ui.alert(str(numbersList[1]))
A function to retrieve the value of a key as a list of strings from the dictionary map.
Parameters
key |
str |
The key to get its value. |
Returns
List – The data type of the returned variable.
from simlabpy import *
key = "Authers"
values = []
values.append("John")
values.append("Doe")
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, values)
stringsList = dictionary.getAsStringArray(key)
runtime.ui.alert(stringsList[1])
A function to retrieve the value of a key as a list of colors from the dictionary map.
Parameters
key |
str |
The key to get its value. |
Returns
List – The data type of the returned variable.
from simlabpy import *
key = "Contrast"
values = []
values.append(Color(0, 0, 0))
values.append(Color(1, 1, 1))
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, values)
colorsList = dictionary.getAsColorArray(key)
runtime.ui.alert(str(colorsList[1].red()))
A function to retrieve the value of a key as a list of vectors from the dictionary map.
Parameters
key |
str |
The key to get its value. |
Returns
List – The data type of the returned variable.
from simlabpy import *
key = "Contrast"
values = []
values.append(Vector3())
values.append(Vector3(1, 1, 1))
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, values)
vectorsList = dictionary.getAsVector3Array(key)
runtime.ui.alert(str(vectorsList[1].getX()))
A function to set a new float value for a key in the dictionary map.
Parameters
key |
str |
The key of the dictionay pair to add or to update. |
floatValue |
float |
The new value for the key. |
from simlabpy import *
key = "Width"
floatValue = 200.5
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, floatValue)
A function to set a new string value for a key in the dictionary map.
Parameters
key |
str |
The key of the dictionay pair to add or to update. |
stringValue |
str |
The new value for the key. |
from simlabpy import *
key = "Author"
stringValue = "SimLab"
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, stringValue)
A function to set a new Color value for a key in the dictionary map.
Parameters
key |
str |
The key of the dictionay pair to add or to update. |
colorValue |
Color |
The new value for the key. |
from simlabpy import *
key = "Author"
colorValue = Color()
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, colorValue)
A function to set a new vector value for a key in the dictionary map.
Parameters
key |
str |
The key of the dictionay pair to add or to update. |
vectorValue |
Vector3 |
The new value for the key. |
from simlabpy import *
key = "Author"
vectorValue = Vector3()
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, vectorValue)
A function to set multiple float values for a key in the dictionary map.
Parameters
key |
str |
A list of string keys to add or to update. |
floatValues |
List |
The float values list. |
from simlabpy import *
key = "Dimensions"
floatValues = []
floatValues.append(200.5)
floatValues.append(300.5)
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, floatValues)
A function to set multiple string values for a key in the dictionary map.
Parameters
key |
str |
A list of string keys to add or to update. |
stringValues |
List |
A string values list. |
from simlabpy import *
key = "Authors"
stringValues = []
stringValues.append("John")
stringValues.append("Doe")
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, stringValues)
A function to set multiple color values for a key in the dictionary map.
Parameters
key |
str |
A list of string keys to add or to update. |
colorValues |
List |
A list of color objects. |
from simlabpy import *
key = "Colors"
colorValues = []
colorValues.append(Color())
colorValues.append(Color(1, 1, 1))
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, colorValues)
A function to set multiple vector values for a key in the dictionary map.
Parameters
key |
str |
A list of string keys to add or to update. |
vectorValues |
List |
A list of vector objects. |
from simlabpy import *
key = "Vectors"
vectorValues = []
vectorValues.append(Vector3())
vectorValues.append(Vector3(0.5, 0.5, 0.5))
runtime = RunTime()
dictionary = runtime.dictionary
dictionary.set(key, vectorValues)
Methods
A function that returns the path of the Image object that has a reference to the preview image of a scene state.
Returns
str – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
image = Image(sceneState)
imageFilePath = image.getPath()
runtime = RunTime()
runtime.ui.alert(imageFilePath)
A function to change the path of the preview image of the referenced scene state.
Parameters
imageFilePath |
str |
The path of the preview image of the referenced scene state. |
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
image = Image(sceneState)
imageFilePath = "D:\\Users\\SimLab\\Desktop\\preview.png"
image.setPath(imageFilePath)
newImagePath = image.getPath()
runtime = RunTime()
runtime.ui.alert(newImagePath)
Methods
A getter function to retrieve the brightness of the light.
Returns
float – The data type of the returned variable.
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
brightness = lightNode.getBrightness()
runtime = RunTime()
runtime.ui.alert(str(brightness))
Return the Inner Cone Angle.
Returns
float – The data type of the returned variable.
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
innerConeAngle = lightNode.getInnerConeAngle()
runtime = RunTime()
runtime.ui.alert(str(innerConeAngle))
A getter function to retrieve the angle of the outer cone of the light.
Returns
float – The data type of the returned variable.
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
outerConeAngle = lightNode.getOuterConeAngle()
runtime = RunTime()
runtime.ui.alert(str(outerConeAngle))
A getter function to retrieve the color of the light.
Returns
Color – The data type of the returned variable.
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
color = lightNode.getColor()
colorR = color.red()
runtime = RunTime()
runtime.ui.alert(str(colorR))
A getter function to retrieve the type of the light.
Returns
str – The data type of the returned variable.
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
lightType = lightNode.getType()
runtime = RunTime()
runtime.ui.alert(lightType)
A getter function to retrieve the path of the used IES file of the light.
Returns
str – The data type of the returned variable.
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newLightType = "ies"
lightNode.setType(newLightType)
iesFilePath = "C:\\Users\\SimLab\\AppData\\Roaming\\SimLab\\SimLab Composer 10\\data\\IES lights\\FCACFB81-8D57-4FF2-AE7A-CF14A1AB9C67.ies"
lightNode.setIESFileName(iesFilePath)
iesFilePath = lightNode.getIESFileName()
runtime = RunTime()
runtime.ui.alert(iesFilePath)
A getter function to determine whether a light source object in your scene will cast a shadow or not (Ver. 12.2+).
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newLightType = "spot"
lightNode.setType(newLightType)
bCastShadow = lightNode.getCastShadow()
runtime = RunTime()
runtime.ui.alert(str(bool(bCastShadow)))
A getter function to get the blend value of a spot light source object (Ver. 12.2+).
Returns
float – The data type of the returned variable.
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newLightType = "spot"
lightNode.setType(newLightType)
lightBlend = lightNode.getBlend()
runtime = RunTime()
runtime.ui.alert(str(lightBlend))
A setter function to set a new value for the brightness of the light.
Parameters
newBrightness |
float |
The new value for the brightness. |
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newBrightness = 100
lightNode.setBrightness(newBrightness)
brightness = lightNode.getBrightness()
runtime = RunTime()
runtime.ui.alert(str(brightness))
A setter function to set the the inner cone angle for the light.
Parameters
newInnerConeAngle |
float |
The new value for the inner cone angle. |
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
lightType = "spot"
lightNode.setType(lightType)
newInnerConeAngle = 100
lightNode.setInnerConeAngle(newInnerConeAngle)
innerConeAngle = lightNode.getInnerConeAngle()
runtime = RunTime()
runtime.ui.alert(str(innerConeAngle))
A setter function to set the the outer cone angle for the light.
Parameters
newOuterConeAngle |
float |
The new value for the outer cone angle. |
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
lightType = "spot"
lightNode.setType(lightType)
newOuterConeAngle = 100
lightNode.setOuterConeAngle(newOuterConeAngle)
outerConeAngle = lightNode.getOuterConeAngle()
runtime = RunTime()
runtime.ui.alert(str(outerConeAngle))
A setter function to set a color for the light.
Parameters
newColor |
Color |
The new color for the light. |
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newColor = Color(0, 1, 0)
lightNode.setColor(newColor)
color = lightNode.getColor()
colorR = color.red()
runtime = RunTime()
runtime.ui.alert(str(colorR))
A setter function to set a light type for the light.
Parameters
lightType |
str |
The new light type for the light (point, spot, infinite, or ies). |
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newLightType = "spot"
lightNode.setType(newLightType)
lightType = lightNode.getType()
runtime = RunTime()
runtime.ui.alert(lightType)
A setter function to set the path of the IES file for the IES light.
Parameters
iesFilePath |
str |
The path of the desired IES file. |
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newLightType = "ies"
lightNode.setType(newLightType)
iesFilePath = "C:\\Users\\SimLab\\AppData\\Roaming\\SimLab\\SimLab Composer 10\\data\\IES lights\\FCACFB81-8D57-4FF2-AE7A-CF14A1AB9C67.ies"
lightNode.setIESFileName(iesFilePath)
A setter function allows you to specify whether a light object in your scene will cast a shadow or not (Ver. 12.2+).
Parameters
bNewCastShadowStatus |
bool |
The new boolean value representing the status of the shadow cast property of the light object. |
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newLightType = "spot"
lightNode.setType(newLightType)
bNewCastShadowStatus = False
lightNode.setCastShadow(bNewCastShadowStatus)
runtime = RunTime()
runtime.ui.alert(str(lightNode.getCastShadow()))
A setter function to set a new blend value for a spot light source object (Ver. 12.2+).
Parameters
newLightBlend |
float |
The new float value for the spot light source object. |
from simlabpy import *
scene = Scene()
lightNode = scene.createLight()
newLightType = "spot"
lightNode.setType(newLightType)
newLightBlend = 0.62
lightNode.setBlend(newLightBlend)
runtime = RunTime()
runtime.ui.alert(str(lightNode.getBlend()))
Methods
A getter function that returns the name of the material.
Returns
str – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
materialName = newMaterial.getName()
runtime = RunTime()
runtime.ui.alert(materialName)
A getter function that returns the diffuse color of the material.
Returns
Color – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
diffuseColor = newMaterial.getDiffuseColor()
diffuseColorR = diffuseColor.red()
runtime = RunTime()
runtime.ui.alert(str(diffuseColorR))
A getter function that returns the ambient color of the material.
Returns
Color – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
ambientColor = newMaterial.getAmbientColor()
ambientColorR = ambientColor.red()
runtime = RunTime()
runtime.ui.alert(str(ambientColorR))
A getter function that returns the emissive color of the material.
Returns
Color – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
emissiveColor = newMaterial.getEmissiveColor()
emissiveColorR = emissiveColor.red()
runtime = RunTime()
runtime.ui.alert(str(emissiveColorR))
A getter function that returns the specular color of the material.
Returns
Color – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
specularColor = newMaterial.getSpecularColor()
specularColorR = specularColor.red()
runtime = RunTime()
runtime.ui.alert(str(specularColorR))
A getter function that returns Eta value of the material if it is plastic, shiny metal, or thin dielectric.
Returns
float – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newMaterial.setMaterialType("plastic");
eta = newMaterial.getEta()
runtime = RunTime()
runtime.ui.alert(str(eta))
A getter function that returns the diffuse texture of the material.
Returns
Texture – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
diffuseTexture = newMaterial.getDiffuseTexture()
diffuseScaleU = diffuseTexture.getScaleU()
runtime = RunTime()
runtime.ui.alert(str(diffuseScaleU))
A getter function that returns the bump texture of the material.
Returns
Texture – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
bumpTexture = newMaterial.getBumpTexture()
bumpScaleU = bumpTexture.getScaleU()
runtime = RunTime()
runtime.ui.alert(str(bumpScaleU))
A getter function that returns the opacity texture of the material.
Returns
Texture – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
opacityTexture = newMaterial.getOpacityTexture()
opacityScaleU = opacityTexture.getScaleU()
runtime = RunTime()
runtime.ui.alert(str(opacityScaleU))
A getter function that returns the reflection texture of the material.
Returns
Texture – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
reflectionTexture = newMaterial.getReflectionTexture()
reflectionScaleU = reflectionTexture.getScaleU()
runtime = RunTime()
runtime.ui.alert(str(reflectionScaleU))
A getter function that returns the normal texture of the material.
Returns
Texture – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
normalTexture = newMaterial.getNormalTexture()
normalScaleU = normalTexture.getScaleU()
runtime = RunTime()
runtime.ui.alert(str(normalScaleU))
A getter function that returns the roughness texture of the material.
Returns
Texture – The data type of the returned variable.
from simlabpy import *
scene = Scene()
material = scene.getMaterialByName("Material-1")
newTexture = Texture()
textureMapPath = "D:\\Users\\SimLab\\Desktop\\roughnessMap.png"
newTexture.setPath(textureMapPath)
material.setRoughnessTexture(newTexture)
roughnessTexture = material.getRoughnessTexture()
runtime = RunTime()
runtime.ui.alert(str(roughnessTexture.getPath()))
A getter function that returns the type of the material.
Returns
str – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
materialType = newMaterial.getMaterialType()
runtime = RunTime()
runtime.ui.alert(materialType)
A setter function that sets a new name for the material.
Parameters
newMaterialName |
str |
The new name for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newMaterialName = "Wall"
newMaterial.setName(newMaterialName)
runtime = RunTime()
runtime.ui.alert(newMaterial.getName())
A function that applies a new diffuse color for the material.
Parameters
newdiffuseColor |
Color |
The new diffuse color for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newdiffuseColor = Color(.5, .5, .5)
newMaterial.setDiffuseColor(newdiffuseColor)
diffuseColor = newMaterial.getDiffuseColor()
diffuseColorR = diffuseColor.red()
runtime = RunTime()
runtime.ui.alert(str(diffuseColorR))
A function that applies a new ambient color for the material.
Parameters
newAmbientColor |
Color |
The new ambient color for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newAmbientColor = Color(.5, .5, .5)
newMaterial.setAmbientColor(newAmbientColor)
ambientColor = newMaterial.getAmbientColor()
ambientColorR = ambientColor.red()
runtime = RunTime()
runtime.ui.alert(str(ambientColorR))
A function that applies a new emissive color for the material.
Parameters
newEmissiveColor |
Color |
The new emissive color for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newEmissiveColor = Color(.5, .5, .5)
newMaterial.setEmissiveColor(newEmissiveColor)
emissiveColor = newMaterial.getEmissiveColor()
emissiveColorR = emissiveColor.red()
runtime = RunTime()
runtime.ui.alert(str(emissiveColorR))
A function that applies a new specular color for the material.
Parameters
newSpecularColor |
Color |
The new specular color for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newSpecularColor = Color(.5, .5, .5)
newMaterial.setSpecularColor(newSpecularColor)
specularColor = newMaterial.getSpecularColor()
specularColorR = specularColor.red()
runtime = RunTime()
runtime.ui.alert(str(specularColorR))
A function that applies a new Eta value for the material if its type is plastic, shiny metal, or thin dielectric.
Parameters
newEtaValue |
float |
The new Eta value for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newMaterial.setMaterialType("plastic");
newEta = 1.5
newMaterial.setEta(newEta)
runtime = RunTime()
runtime.ui.alert(str(newMaterial.getEta()))
A function that applies a new diffuse texture for the material.
Parameters
newDiffuseTexture |
Texutre |
The new diffuse texture for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newDiffuseTexture = Texture()
newDiffuseTexture.setPath("D:\\Users\\SimLab\\Desktop\\diffuseTexture.jpg")
newMaterial.setDiffuseTexture(newDiffuseTexture)
A function that applies a new bump texture for the material.
Parameters
newBumpTexture |
Texutre |
The new bump texture for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newBumpTexture = Texture()
newBumpTexture.setPath("D:\\Users\\SimLab\\Desktop\\bumpTexture.jpg")
newMaterial.setBumpTexture(newBumpTexture)
A function that applies a new opacity texture for the material.
Parameters
newOpacityTexture |
Texutre |
The new opacity texture for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newOpacityTexture = Texture()
newBumpTexture.setPath("D:\\Users\\SimLab\\Desktop\\opacityTexture.jpg")
newMaterial.setOpacityTexture(newOpacityTexture)
A function that applies a new reflection texture for the material.
Parameters
newOpacityTexture |
Texutre |
The new reflection texture for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newReflectionTexture = Texture()
newReflectionTexture.setPath("D:\\Users\\SimLab\\Desktop\\reflectionTexture.jpg")
newMaterial.setReflectionTexture(newReflectionTexture)
A function that applies a new normal texture for the material.
Parameters
newOpacityTexture |
Texutre |
The new normal texture for the material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newNormalTexture = Texture()
newNormalTexture.setPath("D:\\Users\\SimLab\\Desktop\\normalTexture.jpg")
newMaterial.setNormalTexture(newNormalTexture)
A function that applies a new roughness texture for the material.
Parameters
newRoughnessTexture |
Texutre |
The new roughness texture for the material. |
from simlabpy import *
scene = Scene()
material = scene.getMaterialByName("Material-1")
newTexture = Texture()
textureMapPath = "D:\\Users\\SimLab\\Desktop\\roughnessMap.png"
newTexture.setPath(textureMapPath)
material.setRoughnessTexture(newTexture)
roughnessTexture = material.getRoughnessTexture()
runtime = RunTime()
runtime.ui.alert(str(roughnessTexture.getPath()))
A function that sets a new type for the material.
Parameters
newMaterial |
str |
The new type for the material (glass, emitter, matte, metal, metallic, mirror, plastic, shinyMetal, thinGlass, thinSSS, velvet, or default). |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newMaterial.setMaterialType("plastic");
A function that assigns a material to another.
Parameters
newMaterial |
Material |
The new material. |
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
newNormalTexture = Texture()
newNormalTexture.setPath("D:\\Users\\SimLab\\Desktop\\normalTexture.jpg")
newMaterial.setNormalTexture(newNormalTexture)
material = scene.createMaterial()
material.set(newMaterial)
Methods
A functions to set the elements of the matrix.
Returns
Matrix4x4 – The data type of the returned variable.
from simlabpy import *
matrix = Matrix4x4()
matrix.set(1, 0, 0, 2, 0, 1, 0, 2, 0, 0, 1, 2, 0, 0, 0, 1)
A function that returns the inverse of the matrix.
Returns
Matrix4x4 – The data type of the returned variable.
from simlabpy import *
newMatrix = Matrix4x4()
inverseMatrix = newMatrix.getInverse()
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(inverseMatrix)
A function to scale the matrix and return the result in a new matrix.
Parameters
scaleX |
float |
The scale X. |
scaleY |
float |
The scale Y. |
scaleZ |
float |
The scale Z. |
Returns
Matrix4x4 – The data type of the returned variable.
from simlabpy import *
newMatrix = Matrix4x4()
scaleX = 10
scaleY = 10
scaleZ = 10
scaleMatrix = newMatrix.scale(scaleX, scaleY, scaleZ)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(scaleMatrix)
A function for performing in-place scaling for the matrix with X, Y, and Z values.
Parameters
scaleX |
float |
The scale X. |
scaleY |
float |
The scale Y. |
scaleZ |
float |
The scale Z. |
from simlabpy import *
newMatrix = Matrix4x4()
scaleX = 10
scaleY = 10
scaleZ = 10
newMatrix.scaleInPlace(scaleX, scaleY, scaleZ)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(newMatrix)
A function to multiple the matrix with another and return the result in a new matrix.
Parameters
multiplyMatrix |
Matrix4x4 |
The matrix to perform multiplacaiton with. |
Returns
Matrix4x4 – The data type of the returned variable.
from simlabpy import *
multiplyMatrix = Matrix4x4()
multipliedMatrix = newMatrix.multiply(multiplyMatrix)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(multipliedMatrix)
A function for performing in-place multiplication for the current matrix with the specified matrix, where the resulting matrix will be stored in the current matrix.
Parameters
multiplyMatrix |
Matrix4x4 |
The matrix to perform multiplication with. |
from simlabpy import *
newMatrix = Matrix4x4()
newMatrix.set(1, 0, 0, 2, 0, 1, 0, 2, 0, 0, 1, 2, 0, 0, 0, 1)
multiplyMatrix = Matrix4x4()
newMatrix.multiplyInPlace(multiplyMatrix)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(newMatrix)
A function to translate the matrix by a vector.
Parameters
inputVector |
Vector3 |
The vector used to translate the matrix. |
Returns
Matrix4x4 – The data type of the returned variable.
from simlabpy import *
newMatrix = Matrix4x4()
inputVector = Vector3()
newMatrix.translate(inputVector)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(newMatrix)
A function for performing in-place translation for the matrix by a vector.
Parameters
inputVector |
Vector3 |
The vector to be used in translating the matrix. |
from simlabpy import *
newMatrix = Matrix4x4()
inputVector = Vector3()
newMatrix.translateInPlace(inputVector)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(newMatrix)
A function to compute the result matrix of rotating the matrix by the rotation.
Parameters
inputFromVector |
Vector3 |
The vector to be used in rotating the matrix from. |
inputToVector |
Vector3 |
The vector to be used in rotating the matrix to. |
Returns
Matrix4x4 – The data type of the returned variable.
from simlabpy import *
newMatrix = Matrix4x4()
inputFromVector = Vector3()
inputToVector = Vector3()
resultMatrix = newMatrix.rotate(inputFromVector, inputToVector)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(resultMatrix)
A function to rotate the matrix by the rotation between two vectors.
Parameters
inputVector1 |
Vector3 |
The 1st vector specified for rotation. |
inputVector2 |
Vector3 |
The 2nd vector specified for rotation. |
from simlabpy import *
newMatrix = Matrix4x4()
inputVector1 = Vector3()
inputVector2 = Vector3()
newMatrix.rotateInPlace(inputVector1, inputVector2)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(newMatrix)
A function to rotate the matrix around the provided vector and by the provided angle.
Parameters
angle |
float |
The angle to be used in rotation (in radian) |
aroundVector |
Vector3 |
The vector to rotate about. |
from simlabpy import *
newMatrix = Matrix4x4()
aroundVector = Vector3()
angle = 1.5
newMatrix.rotateAboutVectorInPlace(angle, aroundVector)
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setTransform(newMatrix)
Methods
A getter function to get the name of the scene node.
Returns
str – The data type of the returned variable.
from simlabpy import *
newSceneNode = Node()
nodeName = newSceneNode.getName()
runtime = RunTime()
runtime.ui.alert(nodeName)
A setter function to set a new name of the scene node.
Parameters
newName |
str |
The new name for the scene node. |
from simlabpy import *
newSceneNode = Node()
newName = "Box"
newSceneNode.setName(newName)
nodeName = newSceneNode.getName()
runtime = RunTime()
runtime.ui.alert(nodeName)
A getter function to get the visibility of the scene node.
Returns
bool – The data type of the returned variable.
from simlabpy import *
newSceneNode = Node()
visibility = newSceneNode.getVisibility()
runtime = RunTime()
runtime.ui.alert(str(visibility))
A setter function to set the visibility of the scene node.
Parameters
newVisibility |
bool |
The new visibility for the scene node. |
from simlabpy import *
newSceneNode = Node()
newVisibility = False
newSceneNode.setVisibility(newVisibility)
visibility = newSceneNode.getVisible()
runtime = RunTime()
runtime.ui.alert(str(visibility))
A getter function to get the parent of the scene node.
Returns
node – The data type of the returned variable.
from simlabpy import *
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
parentNode = selectedSceneNode.getParent()
parentName = parentNode.getName()
runtime = RunTime()
runtime.ui.alert(str(parentName))
A setter function to set a new parent scene node for the scene node.
Parameters
newParent |
node |
The new parent scene node to be passed. |
from simlabpy import *
scene = Scene()
sphereNode = scene.getNodeByName("Sphere")
selectedSceneNode = scene.getSelectedNode()
selectedSceneNode.setParent(sphereNode)
newParentNode = selectedSceneNode.getParent()
newParentName = newParentNode.getName()
runtime = RunTime()
runtime.ui.alert(str(newParentName))
A function to compute the bounding box of the scene node.
Returns
BoundingBox – The data type of the returned variable.
from simlabpy import *
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
boundingBox = selectedSceneNode.computeBoundingBox()
boundingBoxCenter = boundingBox.getCenter()
boundingBoxCenterX = boundingBoxCenter.getX()
runtime = RunTime()
runtime.ui.alert(str(boundingBoxCenterX))
A function that adds a new attribute to the scene node in the scene (Ver. 10.21+).
Parameters
attributeName |
str |
The key of the new attribute. |
attributeValue |
str |
The value of the new attribute. |
attributeCategory |
str |
The category of the new attribute. |
attributeSortingKey |
str |
The sorting key of the new attribute. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
nodesArray = RunTime().ui.getNodeArray("Select nodes from the scene:")
attributeName = "Name"
attributeCategory = ""
attributeSortingKey = ""
for node in nodesArray:
attributeValue = node.getName()
succeeded = node.addAttribute(attributeName, attributeValue, attributeCategory, attributeSortingKey)
A function that adds a scene node as a new attribute to the scene node in the scene (Ver. 14.1+).
Parameters
attributeName |
str |
The key of the new attribute. |
attributeValue |
Node |
The value of the new attribute. |
attributeCategory |
str |
The category of the new attribute. |
attributeSortingKey |
str |
The sorting key of the new attribute. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
sceneNode = runtime.ui.getNode("Pick source node:")
attributeValue = runtime.ui.getNode("Pick attribute node:")
attributeName = "Name"
attributeCategory = "NewCategory"
attributeSortingKey = ""
sceneNode.addAttribute(attributeName, attributeValue, attributeCategory, attributeSortingKey)
A function that adds a scene state as a new attribute to the scene node in the scene (Ver. 14.1+).
Parameters
attributeName |
str |
The key of the new attribute. |
attributeValue |
SceneState |
The value of the new attribute. |
attributeCategory |
str |
The category of the new attribute. |
attributeSortingKey |
str |
The sorting key of the new attribute. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
sceneNode = runtime.ui.getNode("Pick source node:")
sceneStateName = "Scene1"
scene = Scene()
attributeValue = scene.getSceneStateByName(sceneStateName)
attributeName = "Name"
attributeCategory = "NewCategory"
attributeSortingKey = ""
sceneNode.addAttribute(attributeName, attributeValue, attributeCategory, attributeSortingKey)
A function that adds a sequence as a new attribute to the scene node in the scene (Ver. 14.1+).
Parameters
attributeName |
str |
The key of the new attribute. |
attributeValue |
Sequence |
The value of the new attribute. |
attributeCategory |
str |
The category of the new attribute. |
attributeSortingKey |
str |
The sorting key of the new attribute. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
sceneNode = runtime.ui.getNode("Pick source node:")
sequenceName = "Sequence1"
scene = Scene()
attributeValue = scene.getSequenceByName(sequenceName)
attributeName = "Name"
attributeCategory = "NewCategory"
attributeSortingKey = ""
sceneNode.addAttribute(attributeName, attributeValue, attributeCategory, attributeSortingKey)
A function that retrieves the attribute value from the scene node by it's name and category (Ver. 11.0+).
Parameters
attributeName |
str |
The key of the scene node attribute. |
attributeCategory |
str |
The category of the scene node attribute. |
Returns
str – The data type of the returned variable.
from simlabpy import *
scene = Scene()
node = scene.getNodeByName("Box")
attributeName = "Name"
attributeCategory = ""
attributeValue = node.readAttribute(attributeName, attributeCategory)
A function to remove a scene node attribute by it's name. (Ver. 11.0+).
Parameters
attributeName |
str |
The key of the scene node attribute to be removed. |
from simlabpy import *
scene = Scene()
node = scene.getNodeByName("Box")
attributeName = "Name"
node.removeAttribute(attributeName)
A function to update a scene node attribute value for the given attribute name. (Ver. 11.0+).
Parameters
attributeName |
str |
The key of the scene node attribute. |
attributeValue |
str |
The new value of the scene node attribute. |
from simlabpy import *
scene = Scene()
node = scene.getNodeByName("Box")
attributeName = "Name"
newAttributeValue = "New Value"
node.updateAttributeValue(attributeName, newAttributeValue)
Retrieves a list of all category names associated with the node's attributes. (Ver. 14.1+).
Returns
List – The data type of the returned variable.
from simlabpy import *
scene = Scene()
node = scene.getNodeByName("Box")
categoryNames = node.getAllCategoryNames()
Finds all attributes—each represented by a name and value pair—that are associated with the specified category name. (Ver. 14.1+).
Parameters
categoryName |
str |
The name of the category to query for attributes. |
Returns
List – The data type of the returned variable.
from simlabpy import *
scene = Scene()
node = scene.getNodeByName("Box")
CategoryName = "Dimensions"
pairsList = node.findAttriubtesByCategoryName(CategoryName)
A function that retrieves the scene node children. (Ver. 11.0+).
Returns
List – The data type of the returned variable.
from simlabpy import *
scene = Scene()
node = scene.getNodeByName("Box")
nodeChildren = node.getChildren()
A function that rotate the scene node by the given degree. (Ver. 11.1+).
Parameters
angleX |
float |
The rotation angle about x-axis. |
angleY |
float |
The rotation angle about y-axis. |
angleZ |
float |
The rotation angle about z-axis. |
from simlabpy import *
scene = Scene()
node = scene.getNodeByName("Box")
node.rotateByDegree(45,45,45)
A setter function that sets a new global location for the node (Ver. 14.1+).
Parameters
newLocation |
Vector3 |
The vector for the new location of the node. |
from simlabpy import *
runtime = RunTime()
selectedNode = runtime.ui.getNode("Pick a scene node:")
newLocation = Vector3()
newX = 1
newY = 2
newZ = 3
newLocation.setX(newX)
newLocation.setY(newY)
newLocation.setZ(newZ)
selectedNode.setGlobalLocation(newLocation)
Methods
A function that finds the point on path that match the provided ratio (Ver. 14.1+).
Parameters
ratio |
float |
The ratio value between 0 and 1. |
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
selectedPath = runtime.ui.getNode("Pick a path:")
ratio = 0.5
pointLocationVector = selectedPath.getPointOnPath(ratio)
x = pointLocationVector.getX()
y = pointLocationVector.getY()
z = pointLocationVector.getZ()
runtime.ui.alert(str(x))
runtime.ui.alert(str(y))
runtime.ui.alert(str(z))
A function to detemine whether the path is closed or not (Ver. 14.1+).
Returns
bool – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
selectedPath = runtime.ui.getNode("Pick a path:")
bClosedPath = selectedPath.isPathClosed()
runtime.ui.alert(str(bool(bClosedPath)))
A function to detemine whether the path type is circular or not (Ver. 14.1+).
Returns
bool – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
selectedPath = runtime.ui.getNode("Pick a path:")
bCirularPath = selectedPath.isPathCircular()
runtime.ui.alert(str(bool(bCirularPath)))
Methods
A function that retrieves the value of a boolean preference property from the application references of SimLab Composer.
Parameters
preferenceName |
str |
The name of the desired preference property. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
prefs = runtime.preferences
preferenceName = "ShowIconsOnly"
value = prefs.getBool(preferenceName)
runtime.ui.alert(str(value))
A function that retrieves the value of a string preference property from the application references of SimLab Composer.
Parameters
preferenceName |
str |
The name of the desired preference property. |
Returns
str – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
prefs = runtime.preferences
preferenceName = "ContentDirectory"
value = prefs.getString(preferenceName)
runtime.ui.alert(str(value))
A function that retrieves the value of a float preference property from the application references of SimLab Composer.
Parameters
preferenceName |
str |
The name of the desired preference property. |
Returns
float – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
prefs = runtime.preferences
preferenceName = "RotationSpeed"
value = prefs.getFloat(preferenceName)
runtime.ui.alert(str(value))
A function that sets a new value for a boolean preference property in the application references of SimLab Composer.
Parameters
preferenceName |
str |
The name of the desired preference property. |
newBooleanValue |
bool |
The new boolean value for a preference property. |
from simlabpy import *
runtime = RunTime()
prefs = runtime.preferences
preferenceName = "ShowIconsOnly"
newBooleanValue = False
value = prefs.set(preferenceName, newBooleanValue)
runtime.ui.alert(str(prefs.getBool(preferenceName)))
A function that sets a new value for a string preference property in the application references of SimLab Composer.
Parameters
preferenceName |
str |
The name of the desired preference property. |
newStringValue |
str |
The new string value for a preference property. |
from simlabpy import *
runtime = RunTime()
prefs = runtime.preferences
preferenceName = "ContentDirectory"
newStringValue = "E:\\Users\\SimLab\\AppData\\Roaming\\SimLab\\SimLab Composer 10\\data"
value = prefs.set(preferenceName, newStringValue)
runtime.ui.alert(prefs.getString(preferenceName))
A function that sets a new value for a float preference property in the application references of SimLab Composer.
Parameters
preferenceName |
str |
The name of the desired preference property. |
newFloatValue |
float |
The new float value for a preference property. |
from simlabpy import *
runtime = RunTime()
prefs = runtime.preferences
preferenceName = "ContentDirectory"
newFloatValue = "2.6"
value = prefs.set(preferenceName, newFloatValue)
runtime.ui.alert(str(prefs.getFloat(preferenceName)))
Methods
A function to refresh the user interface of render settings (Ver. 11.0+).
from simlabpy import *
scene = Scene()
renderSettings = scene.getRenderSettings()
renderSettings.updateGUI()
A function to stop updating the user interface of render settings with new information. The function should be followed by resumeUpdate() function (Ver. 11.0+).
from simlabpy import *
scene = Scene()
renderSettings = scene.getRenderSettings()
renderSettings.stopUpdate()
A function to resume updating the user interface of render settings with new information. The function should be called after stopUpdate() function. It should be called in scripts before the last call of the Set function to enable the user interface of render settings to be updated (Ver. 11.0+).
from simlabpy import *
scene = Scene()
renderSettings = scene.getRenderSettings()
renderSettings.resumeUpdate()
Parameters
strSecondArgument |
str |
The new value for the key or property. |
from simlabpy import *
scene = Scene()
renderSettings = scene.getRenderSettings()
color = Color(0.57,0.57,0.57)
renderSettings.set("colorBackground", color) # The type of 2nd argument is color.
renderSettings.set("backgroundType", 3) # The type of 2nd argument is int.
renderSettings.set("enableGroundReflection", False) # The type of 2nd argument is bool.
renderSettings.set("groundShadowStrength", 0.8) # The type of 2nd argument is float.
renderSettings.set("envPath", "C:\\Users\\SimLab\\AppData\\Roaming\\SimLab\\SimLab Composer 10\\data\\hdrs\\5516F55C-FE6C-41EB-8465-A19A1C9E482E.exr") # The type of 2nd argument is string.
Methods
A function to set the active view as a camera's view.
Parameters
newCamera |
Camera |
The camera that has the desired view. |
rom simlabpy import
scene = Scene()
newCamera = scene.createCamera()
runtime = RunTime()
runtime.setView(newCamera)
A function to set the active view to some predefined view.
Parameters
topView |
str |
The predefined view. |
rom simlabpy import
runtime = RunTime()
topView = runtime.STANDARD_VIEW_TOP
runtime.setView(topView)
A function to make all scene content to fit in the active view.
Parameters
drawingAreaWidth |
int |
The width of the drawing area. |
drawingAreaHeight |
int |
The height of the drawing area. |
zoomOutFactor |
float |
The factor of the zoom. |
from simlabpy import *
runtime = RunTime()
drawingAreaWidth = 200
drawingAreaHeight = 200
zoomOutFactor = 0
runtime.fitAll(drawingAreaWidth, drawingAreaHeight, zoomOutFactor)
A getter function to get the references object of the application (Ver. 11.0+).
Parameters
topView |
str |
The predefined view. |
from simlabpy import *
runtime = RunTime()
preferences = runtime.getPreferences()
Adds a resource file (e.g., .jpg, .mp3, .mp4) to the saved .zim archive (version 14.1+).
Parameters
fileName |
str |
The name of the resource file to include in the package. |
packWithVRPackage |
bool |
If True, also includes the resource in the VR package. |
from simlabpy import *
runtime = RunTime()
fileName = "C:\Users\SimLab\Desktop\image.jpg"
packWithVRPackage = False
selectedNodes = runtime.addReferenceFile(fileName, packWithVRPackage)
Removes a resource file (e.g., .jpeg, .mp3, .mp4) from being included in the .zim and VR package files (version 14.1+).
Parameters
fileName |
str |
The name of the resource file to exclude from packaging. |
basedShortName |
bool |
If True, uses the file's short name (e.g., "image.png") for removal. |
from simlabpy import *
runtime = RunTime()
fileName = "C:\Users\SimLab\Desktop\image.jpg"
basedShortName = False
selectedNodes = runtime.removeReferenceFile(fileName, basedShortName)
Methods
A function to reset and empty the scene.
from simlabpy import *
scene = Scene()
scene.reset()
A function to delete a scene node from the scene.
Parameters
sceneNode |
Node |
The scene node to be deleted. |
from simlabpy import *
scene = Scene()
sceneNode = scene.getSelectedNode()
scene.remove(sceneNode)
A function to import a supported file format to the scene.
Parameters
filePath |
str |
The path of the file to be imported. |
from simlabpy import *
filePath = "D:\\Users\\SimLab\\Desktop\\geometry.fbx"
scene = Scene()
node = scene.importFile(filePath)
runtime = RunTime()
runtime.ui.alert(node.name)
A function to import a SIM or ZIM file to the scene with its environment settings.
Parameters
filePath |
str |
The path of the file to be imported (only works for SIM and ZIM file extensions). |
from simlabpy import *
filePath = "D:\\Users\\SimLab\\Desktop\\geometry_with_environment.sim"
scene = Scene()
node = scene.importFileWithEnvironment(filePath)
runtime = RunTime()
runtime.ui.alert(node.name)
A function to toggle the saving mode between save and save as.
Parameters
saveAsBool |
bool |
Set to True for save as mode, or False for save mode. |
from simlabpy import *
saveAsBool = False
scene = Scene()
scene.setSavingModeToSaveAs(saveAsBool)
runtime = RunTime()
runtime.ui.alert(str(bool(saveAsBool)))
A function to open a supported file format in the scene.
Parameters
filePath |
str |
The path of the file to be opened in the scene. |
from simlabpy import *
filePath = "D:\\Users\\SimLab\\Desktop\\geometry.sim"
scene = Scene()
scene.openFile(filePath)
A function for exporting the scene to a supported file format.
Parameters
filePath |
str |
The path of the exported file. |
from simlabpy import *
filePath = "D:\\Users\\SimLab\\Desktop\\geometry.fbx"
scene = Scene()
scene.exportFile(filePath)
A function for exporting the scene to a supported file format with scene states.
Parameters
filePath |
str |
The path of the exported file. |
sceneStates |
List |
A list container storing multiple scene states. |
from simlabpy import *
sceneStates = []
scene = Scene()
sceneState1 = scene.getSceneStateByName("Scene1")
sceneState2 = scene.getSceneStateByName("Scene2")
sceneStates.append(sceneState1)
sceneStates.append(sceneState2)
filePath = "D:\\Users\\SimLab\\Desktop\\geometry.pdf"
scene.exportFile(filePath, sceneStates)
A function to save the scene as SIM or ZIM file format (Ver. 11.0+).
Parameters
filePath |
str |
The path of the saved file. |
from simlabpy import *
filePath = "C:\\Users\\SimLab\\Desktop\\Box.sim"
scene = Scene()
scene.saveFile(filePath)
A function for rendering the scene to an image.
Parameters
imagePath |
str |
The path of the output image. |
width |
int |
The width of the output image. |
height |
int |
The height of the output image. |
skipOpenFolder |
bool |
Skip opening the folder containing the output image in the explorer after the rendering process is finished. |
from simlabpy import *
imagePath = "D:\\Users\\SimLab\\Desktop\\render.jpg"
skipOpenFolder = False
width = 1920
height = 1080
scene = Scene()
scene.render(imagePath, width, height, skipOpenFolder)
A function for rendering an animation to a sequence of images.
Parameters
outputDir |
str |
The output folder that will contain the generated images. |
beginFrame |
int |
The number of the beginning frame. |
endFrame |
int |
The number of the ending frame. |
from simlabpy import *
outputFolderPath = "D:\\Users\\SimLab\\Desktop\\AnimationOutput"
beginFrame = 0
endFrame = 100
scene = Scene()
scene.renderAnimation(outputFolderPath, beginFrame, endFrame)
A getter function to retrieve the rendering setting object property.
Returns
RenderSettings – The data type of the returned variable.
from simlabpy import *
scene = Scene()
renderSettings = scene.getRenderSettings()
spp = renderSettings.spp
runtime = RunTime()
runtime.ui.alert(str(spp))
A getter function to retrieve the VR setting object property (Ver. 11.0+).
Returns
VRSettings – The data type of the returned variable.
from simlabpy import *
scene = Scene()
vrSettings = scene.getVrSettings()
vrSettings.setEnableNightMode(True)
A function to pack the scene and its resource files into a zipped file.
Parameters
outputFilePath |
str |
The path of the packed file. |
baseFileFormat |
str |
The extension of the base file (sim, fbx, obj, or collada). |
from simlabpy import *
scene = Scene()
outputFilePath = "D:\\Users\\SimLab\\Desktop\\pack.zip"
baseFileFormat = "sim"
scene.packTheScene(outputFilePath, baseFileFormat)
A function to convert a sequence of images to a video file.
Parameters
outputFolderPath |
str |
The path of the output folder that will contain the generated video file. |
inputImagesFolderPath |
str |
The path of the folder containing the input images. |
videoQuality |
str |
The quality level for the generated video file (low, maximum, medium, or high). |
frameRate |
float |
Frames per second. |
outputFormat |
str |
The type of the output video file (avi, mp4, flv, ogv, or webm). |
audioFilePath |
str |
The path of the audio file path that will be embedded in generated video file. |
from simlabpy import *
inputImagesFolderPath = "D:\\Users\\SimLab\\Desktop\\images"
outputFolderPath = "D:\\Users\\SimLab\\Desktop\\output"
videoQuality = "maximum"
frameRate = 30
outputFormat = "mp4"
audioFilePath = "D:\\Users\\Simlab\\Music\\Soundtracks\\300\\300 Come And Get Them.mp3"
scene = Scene()
scene.movieMaker(outputFolderPath, inputImagesFolderPath, videoQuality, frameRate, outputFormat, audioFilePath)
Retrieves a Node object using its unique GUID identifier.
Parameters
guid |
str |
The globally unique identifier of the target scene node. |
Returns
Node – The data type of the returned variable.
from simlabpy import *
scene = Scene()
guid = "00000000-0000-0000-0000-000000000000"
scenenode = scene.getNodeByGUID(guid)
Returns the current state of a scene state based on its GUID (Ver. 14.1+).
Parameters
guid |
str |
The globally unique identifier of the target scene state. |
Returns
SceneState – The data type of the returned variable.
from simlabpy import *
scene = Scene()
guid = "00000000-0000-0000-0000-000000000000"
scenestate = scene.getSceneStateByGUID(guid)
Fetches a Sequence object corresponding to the specified GUID (Ver. 14.1+).
Parameters
guid |
str |
The globally unique identifier of the target sequence. |
Returns
Sequence – The data type of the returned variable.
from simlabpy import *
scene = Scene()
guid = "00000000-0000-0000-0000-000000000000"
sequence = scene.getSequenceByGUID(guid)
A function to bake textures of a list of scene nodes from the scene.
Parameters
nodes |
List |
A list container storing multiple scene nodes. |
smart |
bool |
A flag to enable or disable smart baking by detecting and using the correct normals of faces. |
from simlabpy import *
scene = Scene()
boxNode = scene.getNodeByName("Box")
sphereNode = scene.getNodeByName("Sphere")
nodes = []
nodes.append(boxNode)
nodes.append(sphereNode)
smart = True
scene.bakeTexture(nodes, smart)
A function to bake the textures of the scene nodes in the scene that have some animation, where each scene nodes's texture gets baked individually by isolating the it in order to avoid shadows casted from any other scene node.
Parameters
nodes |
List |
A list container storing multiple scene nodes. |
smart |
bool |
A flag to enable or disable smart baking by detecting and using the correct normals of faces. |
from simlabpy import *
scene = Scene()
boxNode = scene.getNodeByName("Box")
sphereNode = scene.getNodeByName("Sphere")
nodes = []
nodes.append(boxNode)
nodes.append(sphereNode)
smart = True
scene.bakeTextureForAnimation(nodes, smart)
A setter function that allows altering the settings of texture baking process.
Parameters
minSize |
int |
The minimum texture size. |
maxSize |
int |
The maximum texture size. |
spp |
int |
Samples per pixel. |
qualityLevelTop |
bool |
A flag to enable or disable top level quality. |
optimizeBakingTime |
bool |
A flag to enable or disable optimization for texture baking time. |
maxPolygonsPerObject |
int |
The maximum number of polygons per object. |
from simlabpy import *
minSize = 1024
maxSize = 2048
spp = 1000
qualityLevelTop = True
optimizeBakingTime = False
maxPolygonsPerObject = 50000
scene = Scene()
scene.setTextureBakingSettings(minSize, maxSize, spp, qualityLevelTop, optimizeBakingTime, maxPolygonsPerObject)
A function to bake light and shadow maps of the selected scene nodes in the scene (Ver. 12.0+).
Parameters
smart |
bool |
A flag to enable or disable smart baking by detecting and using the correct normals of faces. |
from simlabpy import *
smart = True
scene = Scene()
scene.selectAllNodes()
scene.bakeLight(smart)
A function to bake light and shadow maps of a list of scene nodes from the scene (Ver. 12.0+).
Parameters
nodes |
List |
A list container storing multiple scene nodes. |
smart |
bool |
A flag to enable or disable smart baking by detecting and using the correct normals of faces. |
from simlabpy import *
scene = Scene()
boxNode = scene.getNodeByName("Box")
sphereNode = scene.getNodeByName("Sphere")
nodes = []
nodes.append(boxNode)
nodes.append(sphereNode)
smart = True
scene.bakeLight(nodes, smart)
A function that handle automatic animation creation for doors and cabinets as sequences, the functions requires a pattern file (.simlabaa).
Parameters
inputFilePath |
str |
The path of the pattern file (.simlabaa) |
from simlabpy import *
inputFilePath = "D:\\Users\\SimLab\\Desktop\\pattern.simlabaa"
scene = Scene()
scene.createDoorAndCabinetsAnimation(inputFilePath)
A function that retrieves a reference to a scene node that has a particuler name.
Parameters
nodeName |
str |
The name of the scene node. |
Returns
Node – The data type of the returned variable.
from simlabpy import *
nodeName = "Box"
scene = Scene()
boxNode = scene.getNodeByName(nodeName)
A function that retrieves a reference to the first scene node that matches the substring.
Parameters
subString |
str |
A substring of the scene node's name. |
Returns
Node – The data type of the returned variable.
from simlabpy import *
subString = "box-"
scene = Scene()
boxSceneNode = scene.getNodeBySubString(subString)
sceneNodeName = boxSceneNode.getName()
runtime = RunTime()
runtime.ui.alert(str(sceneNodeName))
A function that retrieves a list of all scene nodes matching the substring.
Parameters
subString |
str |
A substring of the scene node's name. |
Returns
List – The data type of the returned variable.
from simlabpy import *
subString = "box-"
scene = Scene()
boxSceneNodes = scene.getNodesBySubString(subString)
sceneNodeName = boxSceneNodes[0].getName()
runtime = RunTime()
runtime.ui.alert(str(sceneNodeName))
A function that retrieves a reference to a scene state that has a particuler name.
Parameters
sceneStateName |
str |
The name of the scene state. |
Returns
SceneState – The data type of the returned variable.
from simlabpy import *
sceneStateName = "Scene1"
scene = Scene()
sceneState = scene.getSceneStateByName(sceneStateName)
A function that retrieves a reference to a sequence that has a particuler name (Ver. 14.1).
Parameters
sequenceName |
str |
The name of the sequence. |
Returns
Sequence – The data type of the returned variable.
from simlabpy import *
sequenceName = "Sequence1"
scene = Scene()
sequence = scene.getSequenceByName(sequenceName)
A function that retrieves a reference to a material that has a particuler name.
Parameters
materialName |
str |
The name of the material. |
Returns
Material – The data type of the returned variable.
from simlabpy import *
materialName = "Material-1"
scene = Scene()
mat = scene.getMaterialByName(materialName)
diffuseColor = mat.getDiffuseColor()
redChannel = diffuseColor.red()
runtime = RunTime()
runtime.ui.alert(str(redChannel))
A function to get all materials from the scene (Ver. 11.1+).
Returns
List – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneMaterialsList = scene.getMaterialsFromScene()
runtime = RunTime()
for sceneMaterial in sceneMaterialsList:
materialName = sceneMaterial.getName()
runtime.ui.alert(materialName)
A function to get a material from the given library name (Ver. 11.1+).
Parameters
libraryName |
str |
The name of the materials library. |
materialName |
str |
The name of the material. |
Returns
Material – The data type of the returned variable.
from simlabpy import *
libraryName = "SimLabMTL"
materialName = "Blocks Red"
scene = Scene()
boxMaterial = scene.getMaterialByName("Box-Material")
materialFromLibrary = scene.getMaterialFromLibrary(libraryName, materialName)
boxMaterial.set(materialFromLibrary)
A function that captures a new scene state for the scene.
Returns
SceneState – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneState = scene.captureSceneState()
A function that captures a new scene state for the selected scene nodes.
Returns
SceneState – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneState = scene.captureSceneStateFromSelection()
A setter function to set the page template for 3D PDF export.
Parameters
pdfTemplateFilePath |
str |
The path of the page templete for 3D PDF (.stf). |
from simlabpy import *
scene = Scene()
pdfTemplateFilePath = "C:\\Users\\SimLab\\AppData\\Roaming\\SimLab\\SimLab Composer
10\\data\\templates\\General\\Interior.stf"
scene.setPDFTemplateFileName(pdfTemplateFilePath)
output ="D:\\Users\\SimLab\\Desktop\\example.pdf"
scene.exportFile(output)
A function to generate a preview image for the scene.
Parameters
outputImagePath |
str |
The path of the generated preview image. |
outputImageWidth |
int |
The width of the output preview image. |
outputImageHeight |
int |
The height of the output preview image. |
from simlabpy import *
scene = Scene()
outputImagePath = "D:\\Users\\SimLab\\Desktop\\output.jpg"
outputImageWidth = 100
outputImageHeight = 120
scene.captureSceneImage(outputImagePath, outputImageWidth, outputImageHeight)
A function to create a new material in the scene.
Returns
Material – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newMaterial = scene.createMaterial()
A function to create a new camera in the scene.
Returns
Camera – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newCamera = scene.createCamera()
A function to create a new light in the scene.
Returns
Light – The data type of the returned variable.
from simlabpy import *
scene = Scene()
newLight = scene.createLight()
A function to create an instance of a scene node in the scene.
Parameters
sceneNode |
Node |
The scene node to create an instance of. |
Returns
Node – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneNode = scene.getNodeByName("Box")
boxInstance = scene.createInstanceOf(sceneNode)
A function to create a copy of a scene node in the scene (Ver. 11.0+).
Parameters
sceneNode |
Node |
The scene node to create a copy of. |
Returns
Node – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneNode = scene.getNodeByName("Box")
boxCopy = scene.createCopyOf(sceneNode)
A function to create round table animation for the active camera.
Parameters
rotateClockWise |
bool |
A flag to determine the direction of the animation (False by default). |
from simlabpy import *
scene = Scene()
rotateClockWise = True
scene.createRoundTableCameraAnimation(rotateClockWise)
A function that computes the volume and the bounding box of the scene, then writes them in a text file (.txt).
Parameters
txtfilePath |
str |
The path of the text file. |
from simlabpy import *
scene = Scene()
txtfilePath = "D:\\Users\\SimLab\\Desktop\\data.txt"
scene.exportSceneData(txtfilePath)
A function to isolate a scene node in the scene.
Parameters
sceneNode |
Node |
The scene node to be isolated. |
from simlabpy import *
scene = Scene()
sceneNode = scene.getNodeByName("Box")
scene.isolate(sceneNode)
A function to unisolate the scene.
from simlabpy import *
scene = Scene()
scene.unisolate()
A function to snap a scene node that has a particular name to Ground.
Parameters
nodeName |
str |
The name of the scene node to be snapped to Ground. |
from simlabpy import *
scene = Scene()
nodeName = "Box"
scene.snapToGround(nodeName)
A function to retain scene materials with their properties from a file (.smp).
Parameters
materialPaletteFilePath |
str |
The path of the material pallete file (.smp) |
retainType |
str |
The retain type for the materials (either "material" or "object") |
from simlabpy import *
materialPaletteFilePath = "D:\\Users\\SimLab\\Desktop\\palette.smp"
retainType = "material"
scene = Scene()
scene.retainMaterialPalette(materialPaletteFilePath, retainType)
A function to export the scene to a SimLab VR package (.vrpackage)
Parameters
outputFile |
str |
The path of the output file (.vrpackage) |
packageTitle |
str |
The title for the exported VR package. |
packagePublisher |
str |
The Publisher of the exported VR package. |
packageDescription |
str |
The description for the exported VR package. |
packageType |
str |
The type of the experience (either "3d" or "360"). |
packageImage |
str |
The path of the preview image for the exported VR package. |
optimize |
bool |
If the value is True, then VR Optimization will be set to on for this export. The default value is False. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
outputFile = "D:\\Users\\SimLab\\Desktop\\level.vrpackage"
packageTitle = "Tower Building"
packagePublisher = "SimLab Soft"
packageDescription = "A walkthrough experience in a tower building"
packageType = "3d"
packageImage = "D:\\Users\\SimLab\\Desktop\\thumbnail.jpg"
optimize = True
scene = Scene()
createdSuccessfully = scene.exportVrPackage(outputFile, packageTitle, packagePublisher,packageDescription, packageType, packageImage, optimize)
A function that adds a new attribute to the scene node in the scene.
Parameters
sceneNodeName |
str |
The name of the scene node to add the new attribute to. |
attributeName |
str |
The key of the new attribute. |
attributeValue |
str |
The value of the new attribute. |
attributeCategory |
str |
The category of the new attribute; a string of your choice. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
sceneNodeName = "Box"
attributeName = "height"
attributeValue = "200"
attributeCategory = ""
scene = Scene()
succeeded = scene.addAttribute(sceneNodeName, attributeName, attributeValue, attributeCategory)
A function overload to replace all scene nodes in the scene that match certain string criteria by an imported file.
Parameters
includes |
str |
The text to be included in the search for a match. |
doesNotInclude |
str |
The text to be excluded in the search for a match. |
inputFilePath |
str |
The path of the import file to repace all matched scene nodes with. |
from simlabpy import *
includes = "Sphere"
doesNotInclude = ""
inputFilePath = "D:\\Users\\SimLab\\Desktop\\box.fbx"
scene = Scene()
scene.replaceObject(includes, doesNotInclude, inputFilePath)
A function overload to replace a scene nodes in the scene that match certain string criteria with other nodes in the scene that match other string criteria (Ver. 11.0+).
Parameters
objectNameToReplace |
str |
The text to be included in the search to find the object(s) to replace in scene. |
objectNameToReplaceObjectsWith |
str |
The text to be included in the search to find the object(s) to replace with in scene. |
deleteReplaceWithObjects |
bool |
Whether to delete replace with objects after the replace is finished. |
useOldName |
bool |
Whether to maintain original names of the replaced objects in scene. |
from simlabpy import *
objectNameToReplace = "Box"
objectNameToReplaceObjectsWith = "Sphere"
deleteReplaceWithObjects = False
useOldName = False
scene = Scene()
scene.replaceObject(objectNameToReplace, objectNameToReplaceObjectsWith, deleteReplaceWithObjects, useOldName)
A function overload to replace scene node with another (Ver. 11.0+).
Parameters
nodeToReplace |
Node |
The scene node to be replaced. |
nodeToBeReplacedWith |
Node |
The other scene node to be replaced with in the scene. |
deleteReplaceWithObjects |
bool |
Whether to delete replace with object after the replace is finished. |
useOldName |
bool |
Whether to maintain original name of the replaced object in scene. |
from simlabpy import *
objectNameToReplace = "Box"
objectNameToReplaceObjectsWith = "Sphere"
deleteReplaceWithObjects = False
useOldName = False
scene = Scene()
box = scene.getNodeByName(objectNameToReplace)
sphere = scene.getNodeByName(objectNameToReplaceObjectsWith)
scene.replaceObject(box, sphere, deleteReplaceWithObjects, useOldName)
A function to detemine whether SimLab Composer is running in the GUI mode or not.
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
guiMode = scene.isGUIMode()
runtime = RunTime()
runtime.ui.alert(str(guiMode))
A function to retrieve the selected scene node in the scene.
Returns
Node – The data type of the returned variable.
from simlabpy import *
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
selectedSceneNodeName = selectedSceneNode.getName()
runtime = RunTime()
runtime.ui.alert(selectedSceneNodeName)
A function to retrieve the selected scene nodes in the scene (Ver. 14.1+).
Returns
List – The data type of the returned variable.
from simlabpy import *
scene = Scene()
selectedNodes = scene.getSelectedNodes()
runtime = RunTime()
for selectedNode in selectedNodes:
>> selectedSceneNodeName = selectedNode.getName()
>> runtime.ui.alert(selectedSceneNodeName)
A function that finds scene nodes with a matching attribute name (Ver. 14.1+).
Returns
List – The data type of the returned variable.
from simlabpy import *
scene = Scene()
attributeName = "description"
matchedNodes = scene.findNodesByAttribute(attributeName)
A function giving the ability to apply replace rules that replace geometries, materials, visual effects, lights, water, Viewer Start, cameras, and/or VR cameras in a scene.
from simlabpy import *
filePath = "C:\\Users\\SimLab\\Desktop\\replaceRules.simlabrr"
scene = Scene()
scene.applyReplaceRules(filePath)
A function to merge identical materials in the scene.
from simlabpy import *
scene = Scene()
scene.mergeIdenticalMaterials()
A function to merge scene nodes on material.
Parameters
sceneNodes |
List |
A list of scene nodes to be merged on material. |
from simlabpy import *
scene = Scene()
boxSceneNode1 = scene.getNodeByName("box1")
boxSceneNode2 = scene.getNodeByName("box2")
sceneNodes = [boxSceneNode1, boxSceneNode2]
scene.mergeNodesOnMaterial(sceneNodes)
A function to decimate mesh(es), where it combines vertices, decimate the mesh(es), and generate normals.
Parameters
sceneNodes |
List |
A list of scene nodes to be decimated. |
decimationPercentage |
float |
The reduction percentage for mesh(es) decimation. |
from simlabpy import *
scene = Scene()
boxSceneNode1 = scene.getNodeByName("box1")
boxSceneNode2 = scene.getNodeByName("box2")
sceneNodes = [boxSceneNode1, boxSceneNode2]
decimationPercentage = 80.0
scene.decimateMeshes(sceneNodes, decimationPercentage)
A function to smooth normals of geometries, where it combines vertices and generates normals.
Parameters
sceneNodes |
List |
A list of scene nodes to have their normals smoothed. |
from simlabpy import *
scene = Scene()
boxSceneNode1 = scene.getNodeByName("box1")
boxSceneNode2 = scene.getNodeByName("box2")
sceneNodes = [boxSceneNode1, boxSceneNode2]
scene.smoothNormals(sceneNodes)
A function to optimize textures of the scene, it collects maps in one directory, optionally removes duplicated maps, optionally scales maps based on a maximum size, optionally scales environment map based on a maximum size, and optionally optimizes textures based on the VR device.
Parameters
compressMaps |
bool |
Whether to enable compression for maps or not. |
removeDuplicatedMaps |
bool |
Allow or disallow removal of duplicated maps. |
maxMapWidth |
int |
The maximum scale width for maps' size. |
maxMapHeight |
int |
The maximum scale height for maps' size. |
maxEnvironmentWidth |
int |
The maximum scale width for environment map's size. |
maxEnvironmentHeight |
int |
The maximum scale height for environment map's size. |
outputDirectory |
str |
A directory path to place the textures in. |
Returns
bool – The data type of the returned variable, where it returns True if all the of the arguments passed by the user to the functions are accepted and utilized, and True also indicates that the function successfully performed all of its operations completely.
from simlabpy import *
scene = Scene()
scene.optimizeTextures() # Optimize textures using the default settings, where compressMaps = True, removeDuplicatedMaps = False, maxMapWidth = 1024, maxMapHeight = 1024, maxEnvironmentWidth = 1024, maxEnvironmentHeight = 512, outputDirectory = "")
A function to optimize the scene for VR devices by merging identical materials and objects based-on identical materials. The VR optimization is applicable for the file formats: OBJ, FBX, GLTF, USDZ, and VRPackage. Note: Bear in mind that the VR optimization excludes the follow from the operation: scene states, animation/sequences, and attiributes (Ver. 12.0+).
from simlabpy import *
scene = Scene()
scene.optimizeForVR()
A function to replace material of a scene node (basic shape or 3D object) with another material.
Parameters
sceneNode |
Node |
The scene node to replace its material. |
newMaterial |
Material |
The new material to be replace with. |
from simlabpy import *
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
newMaterial = scene.createMaterial()
scene.replaceMaterial(selectedSceneNode, newMaterial)
A function that retrieves a list of integers containing of 4 elements representing the number of objects, vertices, polygons, and lines, respectively, for a scene node (Ver. 10.22+).
Parameters
sceneNode |
Node |
The scene node to find its geometrical information. |
Returns
List – The data type of the returned variable.
from simlabpy import *
scene = Scene()
selectedSceneNode = scene.getSelectedNode()
infoList = scene.findGeometricalInfo(selectedSceneNode)
numberOfObjects = infoList[0] # The 1st element represents number of objects.
numberOfVertices = infoList[1] # The 2nd element represents number of vertices.
numberOfPolygons = infoList[2] # The 3rd element represents number of polygons.
numberOfLines = infoList[3] # The 4th element represents number of lines.
runtime = RunTime()
runtime.ui.alert(str(numberOfObjects))
runtime.ui.alert(str(numberOfVertices))
runtime.ui.alert(str(numberOfPolygons))
runtime.ui.alert(str(numberOfLines))
A function to select given scene nodes in the scene (Ver. 11.1+).
Parameters
sceneNodes |
List |
The list of scene nodes to be selected. |
from simlabpy import *
scene = Scene()
sceneNodes = scene.getNodesBySubString("Box")
scene.selectNodes(sceneNodes)
A function to select all scene nodes in the scene (Ver. 12.0+).
from simlabpy import *
scene = Scene()
scene.selectAllNodes()
A function to select then delete all scene nodes in the scene (Ver. 12.0+).
from simlabpy import *
scene = Scene()
scene.removeAllNodes()
A function to create a bounding box for the given node (Ver. 12.0+).
Parameters
sceneNode |
Node |
The scene node to create a bounding box of. |
Returns
Node – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneNode = scene.getNodeByName("Boxes")
boundingBox = scene.createBoundingBox(sceneNode)
An interactive simulation function to update a range controller that corresponds to the given indentifier with the new value, returns True if the controller was updated. (Ver. 14.0+).
Parameters
identifier |
str |
The string identifier of the state controller. |
newValue |
float |
The new float value for the physics channel controller to apply. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
identifier = "motorEnabledState_44621c41-b084-4366-86e1-8dc764638a8d"
newValue = 3.0
bControllerUpdatedSuccessfully = scene.ControlInteractiveChannelFunction(identifier, newValue)
An interactive simulation function to update a state controller that corresponds to the given indentifier with the new state, returns True if the controller was updated. (Ver. 14.0+).
Parameters
identifier |
str |
The string identifier of the state controller. |
bNewState |
bool |
The new boolen value for the physics channel controller to apply. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
identifier = "motorEnabledState_e22e86ae-dbec-4174-96fd-62441e839a4f"
bNewState = True
bControllerUpdatedSuccessfully = scene.ControlInteractiveChannelState(identifier, bNewState)
Methods
A function to apply a scene state.
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
sceneState.apply()
A function to inquire if the scene state considers the material(s) state.
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
materialIncluded = sceneState.isMaterialIncluded()
runtime = RunTime()
runtime.ui.alert(str(materialIncluded))
A function to inquire if the scene state considers the camera state.
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
cameraIncluded = sceneState.isCameraIncluded()
runtime = RunTime()
runtime.ui.alert(str(cameraIncluded))
A function to inquire if the scene state considers the visibility(s) state.
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
visibilityIncluded = sceneState.isVisibilityIncluded()
runtime = RunTime()
runtime.ui.alert(str(visibilityIncluded))
A function to inquire if the scene state considers the light(s) state.
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
lightIncluded = sceneState.isLightIncluded()
runtime = RunTime()
runtime.ui.alert(str(lightIncluded))
A function to inquire if the scene state considers the environment state.
Returns
bool – The data type of the returned variable.
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
EnvironmentIncluded = sceneState.isEnvironmentIncluded()
runtime = RunTime()
runtime.ui.alert(str(EnvironmentIncluded))
A function to set a scene state to include the material(s) state.
Parameters
includeMaterialState |
bool |
A flag to include or exclude material state in the scene state. |
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
includeMaterialState = False
sceneState.setMaterialIncluded(includeMaterialState)
A function to set a scene state to include the camera state.
Parameters
includeCameraState |
bool |
A flag to include or exclude camera state in the scene state. |
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
includeCameraState = False
sceneState.setCameraIncluded(includeCameraState)
A function to set a scene state to include the visibility state.
Parameters
includeVisibilityState |
bool |
A flag to include or exclude visibility state in the scene state. |
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
includeVisibilityState = False
sceneState.setVisibilityIncluded(includeVisibilityState)
A function to set a scene state to include the light(s) state.
Parameters
includeLightState |
bool |
A flag to include or exclude light state in the scene state. |
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
includeLightState = False
sceneState.setLightIncluded(includeLightState)
A function to set a scene state to include the environment state.
Parameters
includeEnvironmentState |
bool |
A flag to include or exclude environment state in the scene state. |
from simlabpy import *
scene = Scene()
sceneState = scene.getSceneStateByName("Scene1")
includeEnvironmentState = False
sceneState.setEnvironmentIncluded(includeEnvironmentState)
This class has no public methods.
Methods
A getter function to get the scale U value of the texture UV coordinates in a material.
Returns
float – The data type of the returned variable.
from simlabpy import *
newTexture = Texture()
scaleU = newTexture.getScaleU()
runtime = RunTime()
runtime.ui.alert(str(scaleU))
A getter function to get the scale V value of the texture UV coordinates in a material.
Returns
float – The data type of the returned variable.
from simlabpy import *
newTexture = Texture()
scaleV = newTexture.getScaleV()
runtime = RunTime()
runtime.ui.alert(str(scaleV))
A getter function to get the offset U value of the texture UV coordinates in a material.
Returns
float – The data type of the returned variable.
from simlabpy import *
newTexture = Texture()
offsetU = newTexture.getOffsetU()
runtime = RunTime()
runtime.ui.alert(str(offsetU))
A getter function to get the offset V value of the texture UV coordinates in a material.
Returns
float – The data type of the returned variable.
from simlabpy import *
newTexture = Texture()
offsetV = newTexture.getOffsetV()
runtime = RunTime()
runtime.ui.alert(str(offsetV))
A getter function to get the path of the used texture map of the texture.
Returns
str – The data type of the returned variable.
from simlabpy import *
newTexture = Texture()
newTextureMapPath = "D:\\Users\\SimLab\\Desktop\\diffuse.png"
newTexture.setPath(newTextureMapPath)
textueMapPath = newTexture.getPath()
runtime = RunTime()
runtime.ui.alert(textueMapPath)
A setter function to set the scale U value for the texture UV coordinates in a material.
Parameters
newScaleU |
float |
The new value for scale U. |
from simlabpy import *
newTexture = Texture()
newScaleU = 2
newTexture.setScaleU(newScaleU)
scaleU = newTexture.getScaleU()
runtime = RunTime()
runtime.ui.alert(str(scaleU))
A setter function to set the scale V value for the texture UV coordinates in a material.
Parameters
newScaleV |
float |
The new value for scale V. |
from simlabpy import *
newTexture = Texture()
newScaleV = 2
newTexture.setScaleV(newScaleV)
scaleV = newTexture.getScaleV()
runtime = RunTime()
runtime.ui.alert(str(scaleV))
A setter function to set the offset U value for the texture UV coordinates in a material.
Parameters
newOffsetU |
float |
The new value for offset U. |
from simlabpy import *
newTexture = Texture()
newOffsetU = 2
newTexture.setOffsetU(newOffsetU)
offsetU = newTexture.getOffsetU()
runtime = RunTime()
runtime.ui.alert(str(offsetU))
A setter function to set the scale V value for the texture UV coordinates in a material.
Parameters
newOffsetV |
float |
The new value for offset V. |
from simlabpy import *
newTexture = Texture()
newOffsetV = 2
newTexture.setOffsetV(newOffsetV)
offsetV = newTexture.getOffsetV()
runtime = RunTime()
runtime.ui.alert(str(offsetV))
A function to set a new map from a file system for the texture.
Parameters
textureMapPath |
str |
The path of the texture map. |
from simlabpy import *
newTexture = Texture()
textureMapPath = "D:\\Users\\SimLab\\Desktop\\diffuse.png"
newTexture.setPath(textureMapPath)
Methods
A function that shows, for the user, a dialog box that contain a checkbox to let him/her make a decision.
Parameters
message |
str |
The text of the question. |
label |
str |
The text for the label of the checkbox. |
init |
bool |
The initial state of the checkbox that determines whether it is checked or not by default. |
Returns
bool – The data type of the returned variable.
from simlabpy import *
message = "Do you want to import a new model?"
label = "Yes"
init = False
runtime = RunTime()
answer = runtime.ui.getBool(message, label, init)
runtime.ui.alert(str(answer))
A function that shows, for the user, a dialog box to allow the user to enter a string.
Parameters
message |
str |
The text of the question. |
label |
str |
The text for the label of the text field. |
init |
str |
The initial text for the text field. |
Returns
str – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
message = "Enter object name:"
newObjectName = runtime.ui.getString(message)
runtime.ui.alert(newObjectName)
A function that shows, for the user, a dialog box to allow the user to select a value from a spinner.
Parameters
fromInt |
bool |
A flag that enables interger values for the spinner. |
message |
str |
The text of the question. |
label |
str |
The text for the label of the spinner. |
init |
float |
The initial value for the spinner. |
Returns
Union[int, float] – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
fromInt = False
message = "Please enter a new brightness value for the render settings"
label = "Brightness"
init = 3.1
brightness = runtime.ui.getValue(fromInt, message, label, init)
runtime.ui.alert(str(brightness))
A function that shows, for the user, a dialog box to allow the user to select a color from a color picker.
Parameters
title |
str |
The title of the dialog box. |
init |
Color |
The initial color for the color picker. |
Returns
str – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
title = "Please pick a color for the material:"
newColor = runtime.ui.getColor(title)
newColorR = newColor.red()
runtime.ui.alert(str(newColorR))
A function that shows, for the user, a dialog box to allow the user to select a scene node from the scene.
Parameters
message |
str |
The text of the question. |
label |
str |
The text for the label of the text field. |
Returns
Node – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
lightNode = runtime.ui.getNode("Pick a light to change its properties:")
lightNodeName = lightNode.getName()
runtime.ui.alert(lightNodeName)
A function that shows, for the user, a dialog box that has a list to allow the user to select multiple scene nodes from the scene.
Parameters
message |
str |
The text of the question. |
label |
str |
The text for the label of the list. |
Returns
List – The data type of the returned container.
from simlabpy import *
runtime = RunTime()
message = "Select the nodes that you want to bake it:"
nodes = runtime.ui.getNodeArray(message)
nodeName1 = nodes[0].getName()
nodeName2 = nodes[1].getName()
runtime.ui.alert(nodeName1)
runtime.ui.alert(nodeName2)
A function to show an open dialog box to the user.
Parameters
title |
str |
The title of the dialog box. |
init |
str |
The default directory for the dialog box. |
filter |
str |
The filter list determine what file formats are enabled for open. Multiple filters must be separated with ' '. |
Returns
str – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
title = "Please select a file to import."
fileName= runtime.ui.getOpenFileName(title)
runtime.ui.alert(fileName)
A function to show a save dialog box to the user.
Parameters
title |
str |
The title of the dialog box. |
init |
str |
The default directory for the dialog box. |
filter |
str |
The filter list determine what file formats are enabled for save. Multiple filters must be separated with ' '. |
Returns
str – The data type of the returned variable.
from simlabpy import *
runtime = RunTime()
outputPath = runtime.ui.getSaveFileName("Exported rendered image location:", "" ,"*.jpg *.png")
runtime.ui.alert(outputPath)
This class has no public methods.
Methods
A getter function to get the value of X element of the vector.
Returns
float – The data type of the returned variable.
from simlabpy import *
vector = Vector3()
x = vector.getX()
runtime = RunTime()
runtime.ui.alert(str(x))
A getter function to get the value of Y element of the vector.
Returns
float – The data type of the returned variable.
from simlabpy import *
vector = Vector3()
y = vector.getY()
runtime = RunTime()
runtime.ui.alert(str(y))
A getter function to get the value of Z element of the vector.
Returns
float – The data type of the returned variable.
from simlabpy import *
vector = Vector3()
z = vector.getZ()
runtime = RunTime()
runtime.ui.alert(str(z))
A function to get the length of the vector.
Returns
float – The data type of the returned variable.
from simlabpy import *
vector = Vector3()
length = vector.getLength()
runtime = RunTime()
runtime.ui.alert(str(length))
A setter function to set a new value for the X element of the vector.
Parameters
newX |
float |
The new value for the X element of the vector. |
from simlabpy import *
vector = Vector3()
newX = 4
vector.setX(newX)
x = vector.getX()
runtime = RunTime()
runtime.ui.alert(str(x))
A setter function to set a new value for the Y element of the vector.
Parameters
newY |
float |
The new value for the Y element of the vector. |
from simlabpy import *
vector = Vector3()
newY = 4
vector.setY(newY)
y = vector.getY()
runtime = RunTime()
runtime.ui.alert(str(y))
A setter function to set a new value for the Z element of the vector.
Parameters
newZ |
float |
The new value for the Z element of the vector. |
from simlabpy import *
vector = Vector3()
newZ = 4
vector.setZ(newZ)
z = vector.getZ()
runtime = RunTime()
runtime.ui.alert(str(z))
A function to normalize the vector.
from simlabpy import *
vector = Vector3()
vector.normalize()
vectorX = vector.getX()
runtime = RunTime()
runtime.ui.alert(str(vectorX))
A function to substract a vector from the vector and return the result in a new vector.
Parameters
vector |
Vector3 |
The vector to be substracted from the vector. |
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
vectorA = Vector3()
vector = Vector3()
resultVector = vectorA.subtract(vector)
resultVectorX = resultVector.getX()
runtime = RunTime()
runtime.ui.alert(str(resultVectorX))
A function to perform in-place scaling for the vector.
Parameters
scale |
float |
The data type of the returned variable. |
from simlabpy import *
vector = Vector3()
scale = 2
vector.scaleInPlace(scale)
vectorX = vector.getX()
runtime = RunTime()
runtime.ui.alert(str(vectorX))
A function to scale the vector by the specified number and return the result in a new vector.
Parameters
scale |
float |
The data type of the returned variable. |
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
vector = Vector3()
scale = 2
resultVector = vector.scale(scale)
resultVectorX = resultVector.getX()
runtime = RunTime()
runtime.ui.alert(str(resultVectorX))
A function to calculate the dot product for two vectors.
Parameters
vector |
Vector3 |
The vector to be used in dot product operation. |
Returns
float – The data type of the returned variable.
from simlabpy import *
vectorA = Vector3()
vector = Vector3()
dotProductValue = vectorA.dot(vector)
runtime = RunTime()
runtime.ui.alert(str(dotProductValue))
A function to calculate the cross product for two vectors.
Parameters
vector |
Vector3 |
The vector to be used in cross product operation. |
Returns
Vector3 – The data type of the returned variable.
from simlabpy import *
vectorA = Vector3()
vector = Vector3()
crossProductVector = vectorA.cross(vector)
crossProductVectorX = crossProductVector.getX()
runtime = RunTime()
runtime.ui.alert(str(crossProductVectorX))
