### Configure Installed Help Location

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Preferences_Help_Preferences

Examples of valid file system paths or URLs for the Installed Help location setting.

```text
/CDROM/html
file:///c:/Docs/VRED/Help
http://webserver/docs/VRED/help
```

--------------------------------

### Start VRED Core on Linux

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Reference_Material_VRED_Core

Commands to navigate to the installation directory and launch VRED Core with a specific VPB file.

```bash
# Go to the bin folder of your VRED Core installation
cd {VRED-Cluster-Root}/bin

# Run VRED Core and pass your VPB file as the first argument
./VREDCore example.vpb
```

--------------------------------

### Cluster Configuration Syntax Examples

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=Clusters_The_Cluster_Dialog_Box

Examples of valid configuration strings for defining render nodes and masters in the Cluster Config dialog.

```text
PC1 PC2 PC3 PC4

PC1, PC2, PC3, PC4

PC1 - PC4

Master1 {PC1 PC2 PC3}

Master1[forwards=PC1|PC2|PC3]

Master1 {C1PC01 - C1PC50} Master2 {C2PC00 - C2PC50}
```

--------------------------------

### Initialize VR Setup Menu and UI Widget

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_reconfiguring_the_VR_menu

Initializes the VR setup menu and adds a custom label widget to the VRED plugin layout.

```python
menuSetup = VRSetupMenu()

label = QtWidgets.QLabel(VREDPluginWidget)
label.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter);
label.setScaledContents(True)
label.setText("Python VR menu configure tool\n" + __file__)
VREDPluginWidget.layout().addWidget(label)
```

--------------------------------

### JavaScript Client Library URI Example

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Basics_Media_VRED_Web_API

Example URI for loading the VRED JavaScript client library.

```text
http://localhost:8888/api.js
```

--------------------------------

### getVREDExamplesDir()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrFileIO_module_html

Returns the VRED examples directory.

```APIDOC
## getVREDExamplesDir()

### Description
Returns the VRED examples directory.

### Returns
- **string** - The examples directory.
```

--------------------------------

### Starting and Stopping a Raytracing Cluster

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrClusterService_html

Configures the cluster with a list of hostnames or IP addresses, starts the cluster service, and subsequently stops it.

```python
vrClusterService.setConfig("pc1 pc2 192.168.178.46")
vrClusterService.start()
# raytracing is done on pc1 pc2 and 192.168.178.46
vrClusterService.stop()
```

--------------------------------

### Start Qt Quick Application via Command Line

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Scene_Interaction_Using_QtQuickStreaming

Launch a Qt application with WebGL streaming enabled on a specific port.

```bash
$ ./your-qt-application -platform webgl:port=8998
```

--------------------------------

### VRED Core Initialization Output

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Reference_Material_VRED_Core_Docker

Example console output showing the startup sequence and environment configuration of VRED Core.

```text
--- command line options start ---

    import files:
        /data/Automotive_Genesis.vpb

--- command line options end ---

Best Matching DPI: 96
Threadstack set to 102400 KByte
running rpc interface on port -1
vrPlatform::init: stack size is 8388608 Kbyte.
VRED_ROOT=/opt/VREDCluster-15.31
VRED_DATA=/opt/VREDCluster-15.31/data
VRED_WRITABLE_DATA=/root/.VREDCore-15.31/data/
VRED_EXAMPLES=/opt/VREDCluster-15.31/examples
PYTHONHOME=/opt/VREDCluster-15.31/lib/python
...
VRED kernel service is running.
Initializing geometries took 0.624483 milliseconds
Initializing lightsources took 0.000460 milliseconds
sh: 1: nvidia-smi: not found
Loading file '/data/Automotive_Genesis.vpb' ...
loading geometry '/data/Automotive_Genesis.vpb' ...
loading ...
Skipping checksum test.
Started web interface
```

--------------------------------

### Initialize Substance Example Plugin

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_plugins_vrSubstanceExample

Instantiates the substance material query result form.

```python
# Create one instance from substance material query result form
substanceExample = vrSubstanceExample(VREDPluginWidget)
```

--------------------------------

### vrdRenderSettings Methods

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

The vrdRenderSettings class exposes numerous methods to get and set rendering configurations. Below are examples of the available interface methods.

```APIDOC
## vrdRenderSettings Methods

### Description
Methods for managing render settings such as image dimensions, animation parameters, and raytracing quality.

### Methods
- **getUseTimeStamp()** -> bool
- **getUseTwoSampleImportanceSampling()** -> bool
- **getUseVariantSets()** -> bool
- **getUseVariantSetViewpoints()** -> bool
- **getVariantSetGroups()** -> List[vrdRenderAutomationVariantSetGroup]
- **getView()** -> vrdNode
- **getVolumeEvaluationMode()** -> vrRenderSettingsTypes.VolumeEvaluationMode
- **getWidth()** -> integer
- **isCameraTrackUsed()** -> bool
- **isExportingToCameraTrackDirectory()** -> bool
- **isExportingVariantSetViewpoints()** -> bool
- **isMovie()** -> bool
- **removeVariantSetGroup(groupName)** -> bool
- **reorderVariantSetGroups(groupNames)** -> bool
- **setAaThresholdQuality(aaThresholdQuality)**
- **setAllowShaderExecutionReordering(allowShaderExecutionReordering)**
- **setAnimationClip(clip)**
- **setAnimationFormat(animationFormat)**
- **setAnimationFps(fps)**
- **setAnimationFrameStep(stepFrame)**
- **setAnimationStartFrame(startFrame)**
- **setAnimationStopFrame(stopFrame)**
- **setAnimationType(animationType)**
- **setAutomaticPhotonMapUpdate(autoUpdate)**
- **setBackgroundColor(backgroundColor)**
- **setBrdfMode(brdfMode)**
- **setClampValue(clampValue)**
- **setDenoiseAlpha(denoiseAlpha)**
- **setDenoiserInput(denoiserInput)**
- **setDenoiserMode(denoiseFilter)**
- **setDenoiserType(denoiserType)**
- **setDisplayLuminance(displayLuminance)**
- **setEnableCostVisualization(enableCostVisualization)**
- **setEnableNURBSRaytracing(nurbsMode)**
- **setEnablePhotometricParameters(enablePhotometricParameters)**
- **setEnablePhotometricParametersWithoutValueAdjustment(enablePhotometricParameters)**
- **setEnableSpectralRaytracing(enableSpectralRaytracing)**
- **setExportAlphaChannel(alpha)**
- **setExportExrHalf(exrHalf)**
- **setExportMultiLayerImageForRenderpasses(multiLayer)**
- **setExportTiffInHDR(tiffHDR)**
- **setFilename(filename)**
- **setFinalGatherRadius(finalGatherRadius)**
- **setGlobalVolumeMaxQuality(globalVolumeQuality)**
- **setIccProfile(iccProfile)**
- **setIgnoreOverrideIblSampling(ignoreOverrideIblSampling)**
- **setIgnoreOverrideIllumination(ignoreOverrideIllumination)**
- **setIgnoreOverrideReflectionSampling(ignoreOverrideReflectionSampling)**
- **setIgnoreOverrideTraceDepth(ignoreOverrideTraceDepth)**
- **setIlluminant(illuminant)**
- **setImageSamples(imageSamples)**
- **setImageSamplingMode(imageSamplingMode)**
- **setIndirectPhotonRadius(indirectPhotonRadius)**
- **setInteractiveFinalGatherQuality(interactiveFinalGatherQuality)**
- **setInteractiveIblSamplingQuality(samplingQuality)**
- **setInteractiveIlluminationMode(interactiveIlluminationMode)**
- **setInteractivePhotonCount(interactivePhotonCount)**
- **setInteractiveReflectionSamplingQuality(interactiveQuality)**
- **setInteractiveTextureSharpness(interactiveTextureSharpness)**
- **setInteractiveTraceDepth(traceDepth)**
- **setInteractiveVolumeScatterDepth(interactiveVolumeScatterDepth)**
- **setKeepUndenoisedImage(keepUndenoisedImage)**
- **setLightOptimizationMode(lightOptimizationMode)**
- **setMetaDataFlags(metaDataFlags)**
- **setPhotonLookupCount(photonLookupCount)**
- **setPhotonMapRefreshMode(photonMapRefreshMode)**
- **setPhotonMode(photonMode)**
- **setPhotonTraceDepth(photonTraceDepth)**
- **setPixelFilterHeight(filterHeight)**
- **setPixelFilterType(filterType)**
- **setPixelFilterWidth(pixelWidth)**
- **setPixelHeight(pixelHeight)**
- **setPixelWidth(pixelWidth)**
- **setPremultiplyAlpha(premultiplyAlpha)**
- **setPrintingHeight(printHeight)**
- **setPrintingResolution(ppi)**
- **setPrintingWidth(printingWidth)**
- **setRealtimeEnvironmentShadowsMode(mode)**
- **setRegionEndX(regionEndX)**
- **setRegionEndY(regionEndY)**
- **setRegionStartX(regionStartX)**
- **setRegionStartY(regionStartY)**
- **setRenderAnimation(renderAnimation)**
- **setRenderingColorspace(renderingColorspace)**
- **setRenderPasses(renderPasses)**
- **setRenderTimeLimit(timeLimit)**
- **setSampleOffset(sampleOffset)**
- **setStillFrameFinalGatherQuality(stillFrameFinalGatherQuality)**
- **setStillFrameIblSamplingQuality(samplingQuality)**
- **setStillFrameIlluminationMode(stillFrameIlluminationMode)**
- **setStillFramePhotonCount(stillFramePhotonCount)**
- **setStillFrameReflectionSamplingQuality(stillFrameQuality)**
- **setStillFrameTextureSharpness(stillFrameTextureSharpness)**
- **setStillFrameTraceDepth(traceDepth)**
- **setStillFrameVolumeScatterDepth(stillFrameVolumeScatterDepth)**
- **setTonemapHDR(tonemapHdr)**
- **setTransparencyMode(mode)**
- **setUpdateRenderSamplesThreshold(samplesThreshold)**
- **setUseAnimationClipRange(useClipRange)**
- **setUseAutomaticPhotonRadius(photonUseAutomaticRadius)**
- **setUseClamping(useClamping)**
- **setUseCurrentView()**
- **setUseFinalGatherForGlossy(useFinalGatherForGlossy)**
- **setUseInfiniteRendering(useInfiniteRendering)**
- **setUseRaySplitting(useRaySplitting)**
- **setUseRaytracedReflections(b)**
- **setUseRealtimeEnvironmentShadows(b)**
- **setUseRenderRegion(useRenderRegion)**
- **setUseRenderTimeLimit(useRenderTimeLimit)**
- **setUseScreenSpaceRefractions(b)**
- **setUseSupersampling(supersampling)**
- **setUseTimeStamp(useTimeStamp)**
- **setUseTwoSampleImportanceSampling(useTwoSampleImportanceSampling)**
- **setUseVariantSets(variantSetsUsed)**
```

--------------------------------

### Sidebar Menu Example Code

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Reference_Material_VRED_Go

Example code for the sidebar menu functionality in VRED Go.

```html
<li><a onclick="c4()" href="#">
                    <img class="image" 
```

--------------------------------

### Initialize UI and Process Management

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_plugins_QtQuickStreaming

Sets up UI icons, context menus, and initial state for the process management interface.

```python
# UI setup
        self.actionAdd.setIcon(getIcon("CreateNew"))
        self.actionStartAll.setIcon(getIcon("Run"))
        self.actionStopAll.setIcon(getIcon("Stop"))
        self.actionDeleteAll.setIcon(getIcon("Delete"))
        self.actionLoad.setIcon(getIcon("FileOpen"))
        self.actionSave.setIcon(getIcon("Save"))
        self.QuickActionBar.setContextMenuPolicy(QtCore.Qt.ActionsContextMenu);
        self.updateUI();
```

--------------------------------

### OpenAPI Specification URI Example

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Basics_Media_VRED_Web_API

Example URI for accessing the OpenAPI specification JSON file.

```text
http://localhost:8888/api.json
```

--------------------------------

### Launch VRED Core via Command Line

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Reference_Material_VRED_Core

Navigate to the installation bin directory and execute the VREDCore binary with a VPB file as an argument.

```bash
# Go to the bin folder of your VRED Core installation which is usually
cd C:\Program Files\Autodesk\VREDCore-13.1\bin\WIN64

# Run VRED Core and pass your VPB file as the first argument
VREDCore.exe example.vpb
```

--------------------------------

### Extract VRED Cluster Installer

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=Clusters_Rendering_with_Clusters

Run the self-extracting binary to install VRED cluster files to the current directory.

```shell
sh VREDCluster-2016-SP4-8.04-Linux64-Build20150930.sh
```

--------------------------------

### Create and Assign a Web Engine

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrWebEngineService_html

Demonstrates how to instantiate a new web engine, configure its URL and texture slot, and apply it to a material on a scene object.

```python
#create a geometry in the scene to assign a web engine
box = createBox(1000, 1000, 1000, 2, 2, 2, 1, 1, 1)

#create a web engine with a given url
webEngine = vrWebEngineService.createWebEngine("autodeskEngine")
webEngine.setTextureSlot(vrdWebEngine.TextureSlotType.Diffuse)
webEngine.setUrl("www.autodesk.com")

#assign web engine to the box material
webEngine.setMaterial(box.getMaterial())
```

--------------------------------

### Install Python modules using pip

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_html

Use the VRED Python executable to install third-party packages from the official repository.

```bash
python.exe -m pip install numpy
```

--------------------------------

### vrTimer and vrAEBase Scripting Example

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_speed

Initializes multiple vrAEBase and vrTimer objects, connecting them to keyboard triggers for testing.

```python
# © 2026 Autodesk, Inc. All rights reserved.

newScene()

from random import *

print("Executing speed script!")

# vrAEBase Test    

n = 3

def end_msg():
    print("end")

ae_list = []
for i in range(n):
    ae = vrAEBase()
    ae_list.append(ae)

keyZ = vrKey(Key_Z)

keyZ.connect("print \"begin\"")
for i in range(n):
    keyZ.connect(ae_list[i], SWITCH_ON)
keyZ.connect(end_msg)

# vrTimer Test

def printIsActive(timer):
    print("Timer state: ", timer.isActive())

timer_list = []
for i in range(n):
    t = vrTimer(1)
    t.connect(printIsActive, t)
    t.setActive(true)
    timer_list.append(t)

keyT = vrKey(Key_T)
for i in range(n):
    keyT.connect(timer_list[i], SWITCH_TOGGLE)

print("End")
```

--------------------------------

### Web API Endpoint URI Example

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Basics_Media_VRED_Web_API

Example URI for accessing a specific service procedure via the VRED Web API.

```text
http://localhost:8888/api/vrAnnotationService/getAnnotations
```

--------------------------------

### Start Qt Quick Application via Python Scripting

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Scene_Interaction_Using_QtQuickStreaming

Use QProcess to programmatically launch a Qt executable with WebGL streaming arguments.

```python
from PySide2.QtCore import QProcess

process = QProcess()
cmd = "\"C:/qtquick_examples/bin/calendar.exe\" -platform webgl:port=9000"
process.start(cmd)
```

--------------------------------

### Create Virtual Hands with Python

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_vr_virtualHands

Demonstrates how to initialize virtual controllers, simulate button inputs, and update tracking matrices using a loop.

```python
# © 2026 Autodesk, Inc. All rights reserved.

from PySide6 import QtGui

menuButton = vrKey(Key_M)
touchpadButton = vrKey(Key_T)
pressButton = vrKey(Key_P)

class VirtualHands(vrAEBase):
    def __init__(self):
        vrAEBase.__init__(self)
        self.createHandles()
        # create right hand
        self.rightHand = vrDeviceService.createVRDevice("right-controller")
        # create left hand
        self.leftHand = vrDeviceService.createVRDevice("left-controller")
        # simulate keys
        self.touched = False
        self.pressed = False
        menuButton.connect(self.toggleMenu,SWITCH_TOGGLE)
        touchpadButton.connect(self.toggleTouched,SWITCH_TOGGLE)
        pressButton.connect(self.togglePressed,SWITCH_ON)
        self.addLoop()
    def loop(self):
        # Use the sphere transformations as tracking values
        leftPos = self.leftTrans.getWorldTransform()
        leftPos.translate(40,-90,-200)
        rightPos = self.rightTrans.getWorldTransform()
        rightPos.translate(-40,-90,-200)
        self.rightHand.setTrackingMatrix(rightPos)
        self.leftHand.setTrackingMatrix(leftPos)
    def toggleMenu(self,value):
        self.leftHand.setButtonPressed(True,"menu")
        self.leftHand.setButtonPressed(False,"menu")
    def toggleTouched(self,value):
        self.touched = not self.touched
        self.rightHand.setButtonTouched(self.touched,"trigger")
    def togglePressed(self,value):
        self.rightHand.setButtonPressed(True,"trigger")
        self.rightHand.setButtonPressed(False,"trigger")
    def createHandles(self):
        # create two spheres that can be used to
        # transform the hands
        node = findNode("RightHandle")
        if node.isValid():
            deleteNode(node)
        self.rightTrans = createSphere(3, 30, .7, .7, 1)
        self.rightTrans.setName("RightHandle")
        setTransformNodeTranslation(self.rightTrans,-280,90,200,True)
        setTransformNodeRotation(self.rightTrans,0,180,0)
        self.rightTrans = vrNodeService.getNodeFromId(self.rightTrans.getID())
        node = findNode("LeftHandle")
        if node.isValid():
            deleteNode(node)
        self.leftTrans = createSphere(3, 30, .7, .7, 1)
        self.leftTrans.setName("LeftHandle")
        setTransformNodeTranslation(self.leftTrans,280,90,200,True)
        setTransformNodeRotation(self.leftTrans,0,180,0)
        self.leftTrans = vrNodeService.getNodeFromId(self.leftTrans.getID())

hands = VirtualHands()

print("Use key M to open the VR Menu")
print("Use T to simulate trigger touched")
print("Use P to simulate trigger pressed")
```

--------------------------------

### Compile UserPluginDemo with Visual Studio

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Custom_Interface_Plugin

Use the Developer command prompt to compile the example plugin using nmake.

```bash
nmake
```

--------------------------------

### vrdVariantState.getOptions()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdVariantState

Gets the options.

```APIDOC
## vrdVariantState.getOptions()

### Description
Gets the options.

### Returns
- **string** - The options.
```

--------------------------------

### Configuring and Executing Render Settings

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrRenderSettingsService_html

Demonstrates how to modify image samples, configure render passes, set output paths, and trigger the rendering process.

```python
# Changing the image samples
vrRenderSettingsService.getSettings().setImageSamples(512)

# Configure render passes
vrRenderSettingsService.getSettings().getRenderPasses().setExportRenderpasses(True)
vrRenderSettingsService.getSettings().getRenderPasses().setBeautyPass(False)
vrRenderSettingsService.getSettings().getRenderPasses().setDiffuseColorPass(True)

# Setting the file name
vrRenderSettingsService.getSettings().setFilename("c:/vred-snapshots/rendering.png")

# Check the statistics, how many images will be rendered
print("Writing " + str(vrRenderSettingsService.getRenderStatistic().getTotalFilesCount()) + " files.")

# Add the current settings as a preset (for later use)
vrRenderSettingsService.savePreset("OnlyDiffuseColorPass")

# Start the rendering
vrRenderSettingsService.render()
```

--------------------------------

### playCAnimation

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Reference_Material_About_the_Sequencer

Starts an animation clip.

```APIDOC
## playCAnimation(name, startFrame, endFrame)

### Description
Starts an animation clip.

### Parameters
- **name** (string) - The animation clip’s name to be executed.
- **startFrame** (integer) - The start frame of the animation.
- **endFrame** (integer) - The end frame of the animation.
```

--------------------------------

### startVredClient(serverIP, port)

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrConnector_module_html

Starts a VRED client instance that executes navigation and Python commands received from the server.

```APIDOC
## startVredClient(serverIP, port)

### Description
Starts a client. The client can be used like an ordinary instance but will execute all navigation and Python commands from the server.

### Parameters
- **serverIP** (string) - Required - The IP address of the server.
- **port** (integer) - Required - The port number.

### Returns
- **bool** - Returns true on success, false otherwise.
```

--------------------------------

### beginDissection()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrVariantSets_module_html

Starts the dissection process.

```APIDOC
## beginDissection()

### Description
Starts the dissection process.

### Returns
- **bool** - True on success, False otherwise.
```

--------------------------------

### vrdRenderSettings.getPixelWidth

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Gets the pixel width.

```APIDOC
## vrdRenderSettings.getPixelWidth()

### Description
Returns the pixel width as a floating point value.

### Returns
- **float** - The pixel width.
```

--------------------------------

### Managing Lights and Lens Flares with vrLightService

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrLightService

Demonstrates common operations such as creating light groups, finding light nodes, copying lens flare effects, and removing nodes.

```python
# add a group node
groupNode = vrLightService.createLightGroup("group node")

# create a point light below the group
pointLight = vrLightService.createLight("point light", vrLightTypes.LightType.Point, groupNode)

# find a light node in the main scene graph
pointLight = vrNodeService.findNode("point light")

# find a light node in the light graph
pointLight = vrLightService.findLight("point light")

# copy lens flares from pointLightNode1 to pointLightNode2
# this creates an actual copy of the vrdLensFlareEffect and stores it
vrLightService.copyLensFlare(pointLightNode1.getLensFlareEffect())
vrLightService.pasteLensFlare([pointLightNode2])

# delete the pointlight and the group
vrNodeService.removeNode([pointLight, groupNode])
```

--------------------------------

### setUp(index, vector)

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrOSGWidget_module_html

Sets the camera 'up' vector for a render widget.

```APIDOC
## setUp(index, vector)

### Description
Sets the camera "up" vector.

### Parameters
- **index** (integer) - Required - The index of the render widget (-1 for the main widget).
- **vector** (Vec3f) - Required - The "up" vector.
```

--------------------------------

### vrdRenderSettings.getPixelHeight

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Gets the pixel height.

```APIDOC
## vrdRenderSettings.getPixelHeight()

### Description
Returns the pixel height as a floating point value.

### Returns
- **float** - The pixel height.
```

--------------------------------

### Initialize VRED Server Instance

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_Connect_two_VRED_instances_server

Starts a VRED server on port 1040 and loads sample geometry into the scene.

```python
# © 2026 Autodesk, Inc. All rights reserved.

# script to demonstrate how 2 vred instances can be linked together
# this is the script on the host
print("Executing connection script!")

# start host on port 1040
startVredServer(1040)

# load some geometry
newScene()
loadGeometry("$VRED_EXAMPLES/geo/cloth.osb")
loadGeometry("$VRED_EXAMPLES/geo/car.osb")
updateScene()
calcVertexNormals()
```

--------------------------------

### vrdRenderSettings.getPixelFilterWidth

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Gets the filter width.

```APIDOC
## vrdRenderSettings.getPixelFilterWidth()

### Description
Gets the filter width.

### Returns
- **float** - The filter width.
```

--------------------------------

### vrdRenderSettings.getPixelFilterType

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Gets the filter type.

```APIDOC
## vrdRenderSettings.getPixelFilterType()

### Description
Gets the filter type.

### Returns
- **vrRenderSettingsTypes.PixelFilterType** - The filter type.
```

--------------------------------

### vrRenderSettingsService.render()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrRenderSettingsService_html

Starts rendering to file using current settings.

```APIDOC
## vrRenderSettingsService.render()

### Description
Starts rendering to file using the current render settings. Existing files are overwritten without warning.
```

--------------------------------

### vrdRenderSettings.getPixelFilterHeight

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Gets the filter height.

```APIDOC
## vrdRenderSettings.getPixelFilterHeight()

### Description
Gets the filter height.

### Returns
- **float** - The filter height.
```

--------------------------------

### Set Startup Renderer via Command Line

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=Visualization_Menu_Adjusting_Render_Settings_and

Use the --renderer parameter to specify the rendering engine at startup, overriding preference defaults.

```bash
VREDPro.exe --renderer vk
```

--------------------------------

### vrdRenderSettings.getPhotonMode

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Gets the photon mode.

```APIDOC
## vrdRenderSettings.getPhotonMode()

### Description
Gets the photon mode.

### Returns
- **vrRenderSettingsTypes.PhotonMode** - The photon mode.
```

--------------------------------

### Docker Build Output

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Reference_Material_VRED_Core_Docker

Example output showing the successful completion of the Docker build process.

```text
[+] Building 89.8s (13/13) FINISHED
 => [internal] load build definition from Dockerfile                                                                  0.0s
 => => transferring dockerfile: 32B                                                                                   0.0s
 => [internal] load .dockerignore                                                                                     0.1s
 => => transferring context: 2B                                                                                       0.0s
 => [internal] load metadata for docker.io/library/ubuntu:22.04                                                       3.3s
 => [1/8] FROM docker.io/library/ubuntu:22.04@sha256:67211c14fa74f070d27cc59d69a7fa9aeff8e28ea118ef3babc295a0428a6d2  4.5s
 => => resolve docker.io/library/ubuntu:22.04@sha256:67211c14fa74f070d27cc59d69a7fa9aeff8e28ea118ef3babc295a0428a6d2  0.0s
 => => sha256:67211c14fa74f070d27cc59d69a7fa9aeff8e28ea118ef3babc295a0428a6d21 1.13kB / 1.13kB                        0.0s
 => => sha256:7a57c69fe1e9d5b97c5fe649849e79f2cfc3bf11d10bbd5218b4eb61716aebe6 424B / 424B                            0.0s
 => => sha256:08d22c0ceb150ddeb2237c5fa3129c0183f3cc6f5eeb2e7aa4016da3ad02140a 2.30kB / 2.30kB                        0.0s
 => => sha256:2ab09b027e7f3a0c2e8bb1944ac46de38cebab7145f0bd6effebfe5492c818b6 29.53MB / 29.53MB                      3.7s
 => => extracting sha256:2ab09b027e7f3a0c2e8bb1944ac46de38cebab7145f0bd6effebfe5492c818b6                             0.6s
 => [internal] load build context                                                                                     2.4s
 => => transferring context: 575.88MB                                                                                 2.3s
 => [2/8] RUN apt-get update && apt-get clean                                                                         4.4s
 => [3/8] RUN apt-get install bzip2                                                                                   1.6s
 => [4/8] WORKDIR /opt/                                                                                               0.1s
 => [5/8] COPY install/VREDCluster-2023.3.1Hotfix.sh /opt/                                                            0.6s
 => [6/8] RUN /opt/VREDCluster-2023.3.1Hotfix.sh                                                                     68.6s
 => [7/8] COPY install/libopenh264-2.3.1-linux64.7.so /opt/VREDCluster-15.31/bin/Linux64/                             0.1s
 => [8/8] WORKDIR /opt/VREDCluster-15.31/bin                                                                          0.1s
 => exporting to image                                                                                                6.4s
 => => exporting layers                                                                                               6.4s
 => => writing image sha256:988f8ad865c157b227f82d6ee2afa0ef096c38549ce99b50a84b0ac3f7e88caf                          0.0s
 => => naming to docker.io/library/vredcore.ubuntu                                                                    0.0s
```

--------------------------------

### vrClusterService.start()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrClusterService_html

Starts the raytracing cluster using the current configuration.

```APIDOC
## start()

### Description
Initializes and starts the raytracing cluster process.

### Returns
- **bool** - Returns True if the cluster started successfully, False otherwise.
```

--------------------------------

### vrdRenderSettings.getBackgroundColor()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Gets the background color.

```APIDOC
## vrdRenderSettings.getBackgroundColor()

### Description
Gets the background color.

### Returns
- **QVector3D** - The background color as a QVector3D.
```

--------------------------------

### vrdSkylightSkyAndSun.getSunScale()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdSkylightSkyAndSun_html

Gets the size of the sun.

```APIDOC
### vrdSkylightSkyAndSun.getSunScale()

**Returns:** `float` — Current used value for the size of the sun.
```

--------------------------------

### Initialize and Configure VR Flashlight Tool

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_vr_plugins_VRFlashlightModule

Sets up the flashlight tool in the immersive UI, including icons, checkable state, and signal connections.

```python
offIcon = "iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAe1BMVEWwsbWwsrO1triwsbOur7Gmp6men6GdnqCcnp64ubu1t7ump6mkpKavr7GkpaenqKqmpqm7u72kpaesrK+jpKa0tbeztbeztLWgoaOfoKGoqaurrK+5ury6vL2vsLKnqKqcnZ+trrCbm6CjpKaxsrSmqKi6ur2ioqS5ubt/L2nWAAAAKXRSTlMAI//+/v/+/DFcLkOGZ5KkE6/qHNfsTLP9Ylbq3e7d2sTrM7jMYbN2V7lTpSMAAAAJcEhZcwAAJOkAACTpAVAk5/gAAAMoSURBVFgJ7Zh7c6MgEMBxEVPFJIh4tbVec73n9/+EtzxWc0mrNnAz/aM708AY+LkvdkkZu10yIOE8z4WVYnc7DnfezUBwvFggKz2R86qS9V4cyqKI0pAxbzXn7CilOmaHSJNnq1lT7msm83hg8KNSUgt2FNtNbtVbzpEC0GSDQVGmWNawrVuitAATsa0reuzGrAMuNabN3qxo2IChnV8A7mhuxD1N/VjllIb9soYPAKTLI0AWKK0Q5b9AJrucEnsxbSqAOmyVs4ZNLtQFkFWC28TuVzRkDXTXQM4vLLZLKmGPXr92UvAg7D0RNQwm7wFkeMv5IDsEFmsasgEOEzAExcBwDprmFQLXi8M9gM+cyYeYP0HpCRUmlV73IcPtPiwI9ORmsv0SyOSAXlwrX0+g3cYScp9BHTRXJHpQ6WK3BnwE4UAyjBim10ISkBKJRH9jVKN20cXRraj4dHhe2yH1GvC1XUvPpH/v0pJ3frfgEEtqxrEzX587YzptumdtjNb6pN75knk5VgdqGlhPODU2OuDzwq2zCQiAQM/DkndZbLbiGHPAEWBE6YZvw4AGa727Hbj91RtXqlah4EdVqSyIajO1cfv1MqzTk4SQ2Ipyu8lYEibBmLioYMlbybVrxeYnEw7gLMrUXeZ1m2cmEPmUNr0Qi6d5BY3FhZCkYS8iLGbsiYBosvdhEaMgY+oMGGIS4UHrjxci0tmLMtgS6TxjHtpUvL0wWJgTbEsoGGe8SMNRhacRg6oblKOVwyEBj1RJiCr3Zen+6jI6Ik4970T0Y14cSd+okYBYaE5RINocwmzvQt/pWdToga6lnKJAtDkArYZJgXhMimTApxfFpBF9KuDordd9qrQJXUkm82H4taKS+VB5k1kyIP2eShYUxcrGYGFIB8Tul2O3S2aywv6cYz9OB2yw0YuTSpY2Ei85QkiZrtoo+cP8ZDqZhgCP+F8Kk77aJNTQRvlD10Pb8lDBZHlo7yIWmOjo/bI8Jx8byPECm8iH3uSEffm3858LSoLrpi3+mcS7e57rP5HX69BI7ID34jxPpJ7DqodxSMk70/Vz+umB/+GBv9HkI1uzfxLJAAAAAElFTkSuQmCC"
        self.tool = vrImmersiveUiService.createTool("vrFlashlightTool")
        self.tool.setText("Flashlight")
        self.tool.setCheckable(True)
        self.tool.setOnOffIconData(onIcon,offIcon)
        self.tool.signal().checked.connect(self.switchOn)
        self.tool.signal().unchecked.connect(self.switchOff)
        self.tool.hideAway(True)
```

--------------------------------

### vrdSheen.getColor()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdSheen_html

Gets the color of the sheen.

```APIDOC
### vrdSheen.getColor()

**Description:** Gets the color of the sheen.

**Returns:** `QVector3D` - Current used value of sheen color.
```

--------------------------------

### Full custom interaction implementation

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_vr_customInteraction

Complete example demonstrating the class-based implementation of a custom VR interaction.

```python
# © 2026 Autodesk, Inc. All rights reserved.

# Define actions as python functions
class MyCustomInteraction:
    def __init__(self):
        # Create new interaction
        self.customInteraction = vrDeviceService.createInteraction("CustomInteraction")
        # Limit the interaction to a new mode to not interfere with other interactions
        self.customInteraction.setSupportedInteractionGroups(["CustomGroup"])

        # Create action objects that a triggered by some input
        self.grabAction = self.customInteraction.createControllerAction("left-trigger-pressed")
        self.releaseAction = self.customInteraction.createControllerAction("left-trigger-released")        

        # Connect these actions to the actual python functions
        self.grabAction.signal().triggered.connect(self.press)
        self.releaseAction.signal().triggered.connect(self.release)        

        # Activate the mode that supports the new interaction
        vrDeviceService.setActiveInteractionGroup("CustomGroup")

    def press(self, action, device):
        print("press")
        device.signal().moved.connect(self.move)

    def release(self, action, device):
        print("release")
        device.signal().moved.disconnect(self.move)

    def move(self, device):
        print("move")

myCustomInteraction = MyCustomInteraction()
```

--------------------------------

### getIntensity()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRaytracedAmbientOcclusionSettings_html

Gets the intensity of the shadow.

```APIDOC
## vrdRaytracedAmbientOcclusionSettings.getIntensity()

### Description
Gets the intensity of the shadow. The greater the value, the darker the shadows.

### Returns
- **float** - Intensity of the shadow.
```

--------------------------------

### getGroupName()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderAutomationVariantSetGroup_html

Gets the name of the group.

```APIDOC
## vrdRenderAutomationVariantSetGroup.getGroupName()

### Description
Gets the name of the group.

### Returns
- **string** - The name of the group.
```

--------------------------------

### vrdMDLMaterial.getMaterialCount()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdMDLMaterial_html

Gets the number of all materials.

```APIDOC
### vrdMDLMaterial.getMaterialCount()

**Returns:** `integer` — The number of all materials.
```

--------------------------------

### Create a VR Menu with Buttons and Checkboxes

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_menu

Initializes a scene with geometry and sets up a vrMenu instance with interactive checkboxes and push buttons.

```python
# © 2026 Autodesk, Inc. All rights reserved.

print("Executing demo script!")

newScene()

loadGeometry("$VRED_EXAMPLES/geo/car.osb")
loadGeometry("$VRED_EXAMPLES/geo/teddy.osb")

updateScene()
calcVertexNormals()

teddy = findNode("Teddy_Bear", True);
teddy.makeTransform()

axis = createLine(0,0,0,0,0,1,0,0,0)
hideNode(axis)

# define interpolator that will be activated over a menu entry
cubeInt = vrInterpolator()
cubeSlide = vrRotationAxisSlide(teddy, axis, 0, 359, 8.0)
cubeInt.add(cubeSlide)

# define menu with entries and respective functions to be called
menu1 = vrMenu(0.05, 1, 1)
menu1.setTransform(-1.5, 0, -10, 0, 45 , 0)
menu1.addLabel("<font color=red>Menu</font>")
menu1.addCheckBox("Rotate teddy", cubeInt)
menu1.addCheckBox("Show scenegraph", "showScenegraph(item_state)")
menu1.addPushButton("Update Scene", "updateScene()")
menu1.setAlpha(0.3)

timer = vrTimer(0.2, true)
timer.setActive(true)
timer.connect("menu1.show()")

print("Press Shift and click onto each menu entry")
```

--------------------------------

### vrdFlakeLayer.getFlakeColor()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdFlakeLayer_html

Gets the color of the flakes.

```APIDOC
## vrdFlakeLayer.getFlakeColor()

### Description
Gets the color of the flakes.

### Returns
- **QVector3D** - Current used color of the flakes.
```

--------------------------------

### Create Perspective Cameras with Constraints

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_create-cameras

Demonstrates creating standard perspective cameras, aim-constrained cameras, and aim-plus-up-constrained cameras. Disables GUI updates during execution to improve performance.

```python
# © 2026 Autodesk, Inc. All rights reserved.

# disable GUI updates
enableScenegraph(False)
try:

    # create a Perspective Camera, at the same position as the current active camera
    cameraName = "Perspective Camera"
    camera = vrCameraService.createCamera(cameraName)


    # create a Perspective Camera with aim constraint
    cameraName = "Perspective Aim Camera"
    aimName = "aim_1"
    camera = vrCameraService.createCamera(cameraName, 
                                          vrCameraTypes.ProjectionPerspective, 
                                          vrCameraTypes.ConstraintAim)
    aimNode = camera.getAimConstraintSources()[0]
    aimNode.setName(aimName)
    setTransformNodeTranslation(camera, 0,0,0, True)
    setTransformNodeTranslation(aimNode, 0,100,0, True)


    # create a Perspective Camera with aim and up vector constraint
    cameraName = "Perspective Aim+Up Camera"
    aimName = "aim_2"
    upName = "up_2"
    camera = vrCameraService.createCamera(cameraName, 
                                          vrCameraTypes.ProjectionPerspective, 
                                          vrCameraTypes.ConstraintAimUp)
    aimNode = camera.getAimConstraintSources()[0]
    aimNode.setName(aimName)    
    upNode = camera.getUpVectorConstraintSources()[0]
    upNode.setName(upName)
    setTransformNodeTranslation(camera, 0,0,0, True)
    setTransformNodeTranslation(aimNode, 0,100,0, True)
    setTransformNodeTranslation(upNode, 0,0,100, True)

finally:
    # reenable GUI updates
    enableScenegraph(True)
    updateScenegraph(True)
```

--------------------------------

### getAspect()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrOSGWidget_module_html

Gets the aspect ratio.

```APIDOC
## getAspect()

### Description
Gets the aspect ratio.

### Returns
- **float** - The aspect ratio.
```

--------------------------------

### Create and configure a movie player

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_movie

Initializes a plane geometry and attaches a video file using the vrMoviePlayer2 class. Ensure the video path is correct for your local environment.

```python
# © 2026 Autodesk, Inc. All rights reserved.

screen = createPlane(2000, 1000, 1, 1, 0,0,0)
screen.setRotation(90,0,0)
screen.setTranslation(0, 0, 500)

mp = vrMoviePlayer2(screen.getMaterial(), "$VRED_EXAMPLES/video/demo.m1v")
mp.setLoop(true)
mp.setActive(true)
```

--------------------------------

### Set Environment Image

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdSphereEnvironmentMaterial_html

Example showing how to load an environment image using the vrImageService before setting it on the material.

```python
envImage = vrImageService.loadImage(filename, vrImageTypes.LoadType.Environment)
..
```

--------------------------------

### getFov()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrOSGWidget_module_html

Gets the field of view.

```APIDOC
## getFov()

### Description
Gets the field of view.

### Returns
- **float** - The field of view value.
```

--------------------------------

### getName()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrAnnotationPtr_module_html

Gets the name of the annotation.

```APIDOC
### getName()

**Returns:** `string` — name
```

--------------------------------

### Create a VRED Menu with WebGL Content

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_menu3d_webgl

Initializes a box and a vrMenu, sets the menu position and size, and loads a WebGL URL.

```python
# © 2026 Autodesk, Inc. All rights reserved.

box = createBox(1000, 1000, 1000, 1, 1, 1, 1, 1, 1)

menu = vrMenu(1,1,1)
menu.setPosition2D(10,10)
menu.setAutoResize(0.0010)
menu.setUrl("http://webglsamples.org/electricflower/electricflower.html")
#menu.setUrl("http://webglsamples.org/fishtank/fishtank.html")
menu.setAlpha(0.5)
menu.show()
```

--------------------------------

### Automate Cluster Service Startup on Linux

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=Clusters_Rendering_with_Clusters

Scripts for configuring the cluster service to run automatically on system startup via rc.local.

```shell
#!/bin/sh -e

killall -9 VREDClusterService

/opt/VREDCluster-8.04/bin/clusterService &

exit 0
```

```shell
#!/bin/sh -e

killall -9 VREDClusterService

su - vreduser '/opt/VREDCluster-8.04/bin/clusterService &'

exit 0
```

--------------------------------

### Initialize Scatter Tool Widget

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_plugins_ScatterTool

Main widget class setup, including UI styling and window flag configuration for VRED integration.

```python
class ScatterTool(ScatterTool_base, ScatterTool_form):
    """
    Main widget for the Scatter Tool plugin.
    Provides UI for configuring scatter settings and controlling placement mode.
    """
    def __init__(self, parent=None):
        super(ScatterTool, self).__init__(parent)
        parent.layout().addWidget(self)
        self.parent = parent
        self.setupUi(self)
        self._initialFitApplied = False

        # Apply SingleColumnButton style from Theme.qss to all buttons
        self.setSourceObjectsButton.setObjectName("SingleColumnButton")
        self.setTargetGroupButton.setObjectName("SingleColumnButton")
        self.clearTargetGroupButton.setObjectName("SingleColumnButton")
        self.resetSeedButton.setObjectName("SingleColumnButton")
        self.togglePlacementButton.setObjectName("SingleColumnButton")

        # Remove Window flag to embed into VRED plugin widget
        self.setWindowFlags(self.windowFlags() & ~QtCore.Qt.Window)
```

--------------------------------

### getVREDDir()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrFileIO_module_html

Returns the VRED installation directory.

```APIDOC
## getVREDDir()

### Description
Returns the VRED installation directory.

### Returns
- (string) - The installation directory.
```

--------------------------------

### vrdRenderSettings.setRegionStartY

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Sets the region start Y coordinate.

```APIDOC
## vrdRenderSettings.setRegionStartY(regionStartY)

### Parameters
- **regionStartY** (integer) - The region start Y coordinate.
```

--------------------------------

### vrImmersiveInteractionService.activateGroundCalibrationMode

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrImmersiveInteractionService

Starts the ground calibration process.

```APIDOC
### activateGroundCalibrationMode(rightHand)

**Parameters:**
- **rightHand** (bool) - Required - Specifies if the right hand is used for calibration.
```

--------------------------------

### Create and Configure a Front Plate

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_Examples_simple

Demonstrates the initialization of a front plate node and the modification of its text content, color, and alignment properties.

```python
# © 2026 Autodesk, Inc. All rights reserved.
#
# Example to show how to insert one front plate
#
# vrSceneplateService is used to create new scene plates
# vrdSceneplateNode is used to change scene plate properties
#

# Query parent object for all scene plate creation
theRoot = vrSceneplateService.getRootNode()

# Create text front plates attached to windows sides
theNode = vrSceneplateService.createNode(theRoot, vrSceneplateTypes.Frontplate, "Plate")

# Cast it to a scene plate object
thePlate = vrdSceneplateNode(theNode)

# Set scene plate type
thePlate.setContentType(vrSceneplateTypes.Text)

# Set some properties from scene plate 
thePlate.setText("The Plate")
theFontColor = QVector3D(0.0, 0.2, 1.0)
thePlate.setFontColor(theFontColor)
thePlate.setPosition(vrSceneplateTypes.Center)
```

--------------------------------

### vrClusterService.started()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrClusterService_html

Signal emitted after a cluster has been started.

```APIDOC
## vrClusterService.started()

### Description
Signal is emitted after a cluster has been started.
```

--------------------------------

### startAnimation(name)

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V1_vrAnimation_module_html

Starts the specified animation.

```APIDOC
## startAnimation(name)

### Description
Starts the animation identified by the provided name.

### Parameters
- **name** (string) - Required - The name of the animation.
```

--------------------------------

### Start VRED Cluster Service

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=Clusters_Rendering_with_Clusters

Manually execute the cluster service binary.

```shell
VREDCluster-8.04/bin/clusterService
```

--------------------------------

### vrdRenderSettings.getVolumeEvaluationMode()

Source: https://help.autodesk.com/view/VREDPRODUCTS/2027/ENU?guid=VRED_Python_Documentation_Python_API_V2_class_vrdRenderSettings_html

Gets the volume evaluation mode.

```APIDOC
## vrdRenderSettings.getVolumeEvaluationMode()

### Description
Gets the volume evaluation mode.

### Returns
- **vrRenderSettingsTypes.VolumeEvaluationMode** - The volume evaluation mode.
```