Trees       Indices       Help   
VRED Python API v1
Module vrOSGWidget
[frames] | no frames]

Module vrOSGWidget

The OpenSG Widget module.

Example:

       See also example dock-window.py
Functions
float
getHeightAboveGround(index)
Returns the height above the ground.
float
getHeightAboveGround(index, node)
Returns the height above the ground.
tuple of vrNodePtr, Pnt3f, Vec3f, Vec2f
getSceneIntersection(index, rayOrigin, rayDirection)
Returns the intersection of the given ray with the scene.
tuple of vrNodePtr, Pnt3f, Vec3f, Vec2f
getSceneIntersection(index, xCoord, yCoord)
Returns the intersection of the view ray of the active camera through the given pixel coordinates in the render window.
vector of floats
getUserCameraMatrix(userId, cameraName)
Gets the user projection camera world matrix (column-wise).
vector of floats
getUserCameraMatrix(userId, windowId)
Gets the user projection camera world matrix (column-wise).
 
setCameraHeightAboveGround(index, relativeHeight)
Set camera "relativeHeight" above the ground
 
setCameraHeightAboveGround(index, relativeHeight, keepAt)
Set camera "relativeHeight" above the ground
 
setCameraHeightAboveGround(index, relativeHeight, groundNode)
Set camera "relativeHeight" above the ground.
 
zoomTo(node)
Zooms to node.
 
zoomTo(node, use_at)
Zooms to node.
 
setBackplate(state)
Deprecated.
 
setBackplate(state, index)
Deprecated.
bool
getBackplatesEnabled(index)
Returns if backplate rendering is enabled for the active render window.
 
enableBackplates(state)
Enables or disables backplate rendering for the active render window.
 
enableBackplates(state, index)
Enables or disables backplate rendering for the given render window.
bool
getFrontplatesEnabled(index)
Returns if frontplate rendering is enabled for the active render window.
 
enableFrontplates(state)
Enables or disables frontplate rendering for the active render window.
 
enableFrontplates(state, index)
Enables or disables frontplate rendering for the given render window.
bool
getSceneplatesEnabled(index)
Returns if sceneplate rendering is enabled for the active render window.
 
enableSceneplates(state)
Enables or disables sceneplate rendering for the active render window.
 
enableSceneplates(state, index)
Enables or disables sceneplate rendering for the given render window.
 
adaptZeroParallaxDistance(index)
Automatically adjusts the zero parallax distance.
 
addRenderOverlay()
 
cancelAntialiasing()
Cancels the still anti-aliasing.
 
clearRecordedStatistics(index)
Deletes all recorded statistics of the given render window.
 
compressTextures()
Deprecated.
 
createBackplate()
Deprecated.
 
createRenderWindow()
Creates a new render window.
 
createScreenshot(filename)
Creates a screenshot of the render window and writes out a image file.
 
deleteBackplate()
Deprecated.
 
destroyRenderWindow(index)
Destroys a render window.
 
enableAntialiasing(switch)
Sets anti-aliasing.
 
enableDrawAction(index, state)
Enables draw action.
 
enableHeadlight(switch)
Sets the headlight state.
boolean
enablePowerwall(window, state)
Enables local powerwall mode.
 
enableRaytracing(state)
Enables or disables raytracing.
 
enableRaytracingDownscale(switch)
Sets raytracing downscale.
 
enableRender(switch)
Sets rendering state.
 
enableRenderRegion(s)
Sets region rendering.
boolean
enableStereo(window, state, passive, mode, es, zp)
Enables stereo.
bool
getAntialiasingEnabled()
Checks, if anti-aliasing is enabled.
float
getAspect()
Gets the aspect ratio.
Pnt3f
getAt(index)
Returns "at" point.
bool
getAuxiliaryNodesVisibleDuringAntialiasing()
Returns the visibility state of the auxiliary nodes during antialiasing.
float (64bit)
getAverageFPS()
Returns the average number of frames per second.
 
getBackplateMaterial()
Deprecated.
vrNodePtr
getCamNode(index)
Gets the camera node.
bool
getCameraPivotAlwaysVisible()
Returns the visibility state of the the camera pivot while not navigating.
bool
getCameraPivotVisible()
Returns the visibility state of the the camera pivot .
integer
getDLSSQuality()
Returns the current deep learning supersampling quality.
bool
getDepthPeeling()
Returns whether depth peeling is enabled in OpenGL.
int
getDepthPeelingLayers()
Returns the number of layers that are peeled for depth peeling in OpenGL.
 
getDollySpeed()
Get the scalefactor of the navigator dolly speed.
float (64bit)
getFPS()
Returns the current number of frames per second.
float
getFar()
Gets the far clipping plane.
float
getFov()
Gets the field of view.
Pnt3f
getFrom(index)
Returns "from" point.
unsigned int
getGenlockingFrameCount()
Returns current genlocking frame count.
 
getInteractionMode()
Get the interaction mode.
 
getInternalBackplateMaterial()
Deprecated.
vrMaterialPtr
getLastPickingMaterial()
Returns the last picked material.
vrNodePtr
getLastPickingNode()
Returns the last picked node.
Pnt3f
getLastPickingPosition()
Returns the last picked position.
boolean
getLightmapGPUTextureCompression()
Returns whether GPU texture compression is enabled for lightmaps in OpenGL rendering.
float
getMotionFactor()
Returns the current motion factor.
list of 2 integers
getMousePosition(index)
Returns the current pixel coordinates of the mouse over the given render window.
Pnt3f
getNavigationPivot(index)
Returns navigation pivot.
 
getNavigationSpeedMode()
Get the navigation speed mode.
float
getNear()
Gets the near clipping plane.
MaterialPtr
getNodeMaterial(node)
Returns the temporary override material a node uses in OpenGL.
Pnt3f
getOculusRiftTrackingOrigin()
Returns the Oculus Rift tracking reference origin.
int
getOculusRiftTrackingOriginType()
Windows only: Retrieves the tracking origin type for the oculus rift.
 
getPanningSpeed()
Get the scalefactor of the navigator panning speed.
integer
getRaytracingDownscaleFactor()
Returns the raytracing downscale factor.
bool
getRaytracingEnabled()
Checks, if raytracing is enabled.
vrNodePtr
getRenderRoot(index)
Gets the render root.
list of vrNodePtrs
getRenderRoots(index)
Gets the render roots.
unsigned int
getRenderWindowCount()
Returns number of render windows.
int
getRenderWindowHeight(i)
Returns the render window height.
int
getRenderWindowWidth(i)
Returns the render window width.
Real32
getRoll(index)
Get navigator roll.
int
getSAAWindow()
Returns the still anti-aliasing window.
Color3f
getSeparateBakeColor()
Returns color multiplier for the baked separate illumination in 3D rendering.
float
getSeparateBakeIntensity()
Returns intensity multiplier for the baked separate illumination in 3D rendering.
bool
getShadowMapUpdates()
Returns whether shadow map updates are enabled or disabled.
 
getShadowPlane(rootNode, shadowPlaneNameRegexp)
Get the Shadow Plane given a regexp.
bool
getShowASides()
Returns the state of the A Side rendering flag.
bool
getShowBSides()
Returns the state of the B Side rendering flag.
bool
getSuperSampling()
Checks, if super sampling is enabled (Visualization > Realtime Antialiasing).
unsigned int
getSuperSamplingQuality()
Returns the current realtime antialiasing quality.
Vec3f
getUp(index)
Returns "up" vector.
boolean
getUseBake(bakeComponent)
Returns whether individual baking components are enabled to be used by 3D rendering.
bool
getUseBindless()
Returns whether bindless graphics should be used or not.
bool
getUseCommandList()
Deprecated: Commandlists are not supported.
bool
getUseMulticastSLI()
Returns whether multicast SLI should be used or not.
 
getUsePivotBasedPanning()
Get the panning mode of the navigator.
bool
getUseSinglePassStereo()
Returns whether single pass stereo is activated for stereo rendering or not
 
getUseVariableRateShading()
vector of floats
getUserMatrix(id)
Gets the user projection transform matrix (column-wise).
 
getUserNode()
Deprecated.
 
getVariableRateShadingMode()
 
getVariableRateShadingQuality()
Pnt3f
getViewAt(index)
Returns "ViewAt" point.
tuple of Pnt3f and Vec3f
getViewRay(index, xCoord, yCoord)
Returns a ray that starts at the active camera and goes through the pixel at the given coordinates (x, y) in the render window.
 
hideBanner()
Hides a banner.
bool
isDLSSSupported()
Returns True, if deep learning supersampling is supported.
bool
isRaytracingDownscaleEnabled()
Checks, if raytracing downscale is enabled.
 
moveRenderWindow(index, xPos, yPos)
Moves a render window.
 
moveStatistic(x, y)
Sets the position of the render statistic.
 
refreshAllGLObjects()
Refreshs all existing GL objects.
 
reinitializeAllGLObjects()
Reinitialize all OpenGL objects to speed up rendering.
 
resetGenlockingFrameCount()
Resets genlocking frame count.
 
resetHMDPose()
While using a HMD display mode, resets the tracking to the current pose of the headset.
 
resetIsolateView(index)
Resets the isolate view on the render window.
 
resetNodeMaterial(node)
Resets the temporary node material override.
 
resetNodeMaterials()
Resets all temporary node material overrides.
 
resetOculusRiftOrientation()
Resets the tracking origin according to the current headset location and sets the yaw orientation to the current headset yaw value.
 
resetRenderRoots()
Resets render root.
 
resizeRenderWindow(index, width, height)
Resizes a render window.
 
setAORendering(state)
Enables or disables ambient occlusion rendering.
 
setAOShadowsVisible(state)
Enables or disables ambient occlusion shadows for OpenGL.
 
setActiveRenderPass(passID, index)
Sets the renderpass for the specified window.
 
setAllGradientBackgrounds(colors, ints)
Sets gradient background for all render windows.
 
setAllNavigationsEnabled(state)
Activates Navigation for all MGLW.
 
setAnalyticRendering(state)
Enables or disables analytic rendering.
 
setAspect(aspect)
Sets the aspect ratio.
 
setAt(index, point, x, y, z)
Set camera "at" point.
 
setAutoFrustum(switch)
Sets the auto frustum.
 
setAuxiliaryNodesVisibleDuringAntialiasing(state)
Enable/disable display of auxiliary nodes during antialiasing.
 
setBackfaceCulling(switch)
Renders the whole scene with backface culling.
 
setCameraBeacon()
Deprecated.
 
setCameraConstraint(camera_constraint, min_dist)
Sets camera constraint and optionally the minimum distance.
 
setCameraPanning(x, y)
Panning of the camera.
 
setCameraPivotAlwaysVisible(state)
Enable/disable display of the camera pivot while not navigating.
 
setCameraPivotVisible(state)
Enable/disable display of the camera pivot during navigation.
 
setCameraRotation(x, y)
Rotates the camera.
 
setCameraScale(x, y, z)
Scales the camera, e.g for vertical flipping (1, -1, 1).
 
setCameraZUp(state)
Sets camera z up.
 
setCameraZoom(distance)
Zooms the camera.
 
setClusterCameraConnection(state)
Sets the connection of the cameras in a cluster.
 
setCorrectDoubleSidedLighting()
Deprecated.
 
setDLSSQuality(quality)
Sets the deep learning supersampling quality.
 
setDefaultCameraBeacons()
Deprecated.
 
setDepthOnlyPass(switch)
Sets the depth only pass state.
 
setDepthPeeling(state)
Enables or disables depth peeling in OpenGL.
 
setDepthPeelingLayers(layers)
Sets the number of layers to peel for depth peeling in OpenGL.
 
setDiscontinuityRendering(state)
Enables or disables surface analysis rendering.
 
setDisplayMode(mode)
Sets the display mode.
 
setDistance(index, distance)
Set camera distance.
 
setDollySpeed(scalefactor)
Set the scalefactor for the navigator dolly speed.
 
setDoubleSidedLighting()
Deprecated.
 
setEvaluateClipping(state)
Enables or disables clipping plane evaluation in OpenGL.
 
setEyeSeparation(es)
Sets eye separation factor.
 
setFaceNormalRendering(state)
Enables or disables face normal rendering.
 
setFar(far)
Sets the far clipping plane.
 
setFixedRenderWindowSize(width, height)
Set a fixed size for the main render window.
 
setFlyMode(switch)
Switches between virtual trackball and fly navigation.
 
setForceTransparentObjectSelection(mode)
Enables/diables the selection of objects with a 100% transparent material in the render window.
 
setFov(fov)
Sets the field of view.
 
setFreezeOcclusionCulling(freezeCulling)
Freezes the current state of the occlusion culling for debugging purposes.
 
setFrom(index, point, x, y, z)
Set camera "from" point.
 
setFromAtUp(index, from, at, up, fx, fy, fz, ax, ay, az, ux, uy, uz)
Set camera "from", "at" and "up".
 
setFrustum(index, left, right, bottom, top)
Set camera frustum
 
setFrustumCulling(switch)
Sets the frustum culling.
 
setGenlocking(state)
Enables or disables genlocking.
 
setGradientBackground(index, colors, ints)
Sets gradient background for a given render window.
 
setGrainSize()
Deprecated.
 
setHighQualityAntialiasing(state)
Enables or disables high quality anti-aliasing.
 
setIndirectRendering(state)
Deprecated.
 
setInteractionMode(mode)
Set the interaction mode.
 
setIsolateView(index, roots)
Sets the isolate view on the provided objects.
 
setKeepRaytracingStructure(switch)
Enables or disables keeping of the raytracing structure.
 
setLightmapGPUTextureCompression(on)
Enables/disables GPU texture compression for lightmaps to reduce memory consumption on the GPU for OpenGL rendering.
 
setLocalLights(switch)
Sets local light source mode.
 
setMono(index, state)
Disable stereo.
 
setMotionFactor(factor)
Sets motion factor.
 
setNavMode(mode)
Switches between different navigation modi.
 
setNavOrbitMode(enabled)
Sets navigation orbit mode to on/off.
 
setNavigationSpeedMode(mode)
Set the navigator speed mode for two axis and trackball navigation modes.
 
setNear(near)
Sets the near clipping plane.
 
setNodeMaterial(node, mat)
Sets a temporary override for the material a node uses for rendering in OpenGL.
 
setOcclusionCulling(switch)
Sets the occlusion culling state.
 
setOcclusionCullingMode(mode)
Sets the occlusion culling mode.(experimental)
 
setOculusRiftHmdCaps()
Deprectated
 
setOculusRiftTracking(s)
Windows only: Enables/Disables tracking of the oculus rift.
 
setOculusRiftTrackingOrigin(position)
Sets the tracking reference origin for oculus rift tracking.
 
setOculusRiftTrackingOriginType(originType)
Windows only: Sets the tracking origin type for the oculus rift.
 
setOpenGLDebugging(s)
Enables/Disables OpenGL Debugging.
 
setPanningSpeed(scalefactor)
Set the scalefactor for the navigator panning speed when pivot based panning or linear navigation is turned on.
 
setPivot(index, point, x, y, z)
Set navigator rotation pivot.
 
setPostprocessAntialiasingMode(on)
Enables/Disables postprocessing antialiasing.
 
setPowerwallWindow()
Sets the size of the virtual powerwall window in world coordinates.
 
setPrecomputedRendering(state)
Enables or disables precomputed illumination rendering.
 
setRaytracingDownscaleFactor(factor)
Sets the raytracing downscale factor.
 
setRealisticRendering(state)
Enables or disables realistic rendering.
 
setRenderFullscreen(state)
Maximizes/minimizes the render widget.
 
setRenderQuality(quality)
Sets the render quality.
 
setRenderRegion(on, startX, startY, endX, endY)
Sets render region parameters.
 
setRenderRoot(index, root)
Sets render root.
 
setRenderRoots(index, roots)
Sets render roots.
 
setRenderWindowDocked(index, state, flags)
Docks a render window.
 
setRoll(index, roll)
Set navigator roll.
 
setSAAWindow(id)
Sets the still anti-aliasing window, -1 means use window with focus.
 
setScreenspaceAO(state)
Enables or disables screen space ambient occlusion in OpenGL.
 
setSelectionMode(mode)
Sets the selection mode.
 
setSeparateBakeColor(color)
Sets color multiplier for the baked separate illumination in 3D rendering.
 
setSeparateBakeIntensity(intensity)
Sets intensity multiplier for the baked separate illumination in 3D rendering.
 
setShadeTileSize()
Deprecated.
 
setShadow(switch)
Sets shadow state.
 
setShadowMapUpdates(on)
Enables/Disables updates to the shadow map.
 
setShowABSides(showASides, showBSides)
Enable/disable the rendering of A and B Sides.
 
setSnapshotFrame(state, width, height)
Show snapshot frame.
 
setSortTrans(switch)
Sets transparent sorting.
 
setSpaceMouseHeight(height)
Sets a fixed height in spacemouse mode.
 
setSpaceMousePivotMode(i)
Sets the spacemouse pivot mode.
 
setSpaceMouseTwoAxis(s)
Sets the two axis mode for the spacemouse.
 
setSpaceMouseViewMode(i)
Sets the spacemouse view mode.
 
setSpecTexLighting()
Deprecated.
 
setStillDOF(state, radius, focaldistance)
Enables depth of field.
 
setSuperSampling(state)
Enables or disables super sampling (Visualization > Realtime Antialiasing).
 
setSuperSamplingOnCameraMovement(state)
Enables/Disables super sampling (realtime antialiasing) on camera movements.
 
setSuperSamplingQuality(quality)
Sets the super sampling quality (Visualization > Realtime Antialiasing).
 
setTextureCompression(switch)
Sets the opengl texture compression state.
 
setTransformNodeSelectionPressed(node)
Select a transform node by mouse press event.
 
setTransformNodeSelectionReleased(node)
Deselect of a transform node by mouse release event.
 
setTwoSidedLighting()
Deprecated.
 
setUp(index, vector, x, y, z)
Set camera "up" vector.
 
setUseBake(bakeComponent, state)
Enables/Disables individual baking components to be used by 3D rendering.
 
setUseBindless(bindlessEnable)
Windows only, Experimental: Enables/Disables the use of bindless graphics extension if available.
 
setUseCommandList(commandlistEnable)
Deprecated: Commandlists are not supported.
 
setUseLastDrawTree(s)
Re-use old draw tree.
 
setUseMulticastSLI(multicastEnable)
Windows only: Enables/Disables use of multicast SLI for stereo rendering if present.
 
setUsePivotBasedPanning(on)
Set the navigator panning mode to be based on the pivot.
 
setUseSinglePassStereo(on)
Windows only: Enables/Disables use of single pass stereo if supported.
 
setUseSpaceMouseHeight(value)
Sets whether a fixed height is used or not.
 
setUseVariableRateShading(state)
Enable or disable variable rate shading.
 
setUserMatrix(id, matrix)
Sets the user projection transform matrix (column-wise).
 
setVSyncInterval(interval)
Sets the V-Sync swap interval.
 
setVariableRateShadingMode(mode)
Set shading rate mode.
 
setVariableRateShadingQuality(quality)
Set a predefined shading quality for uniform and foveated rendering.
 
setViewportCamera(index, cameraNode)
Sets the active camera for the given render window to the camera of the given camera node.
 
setVolumeDrawing(switch)
Sets volume drawing mode.
 
setWireframe(switch)
Sets wireframe rendering mode.
 
setWireframeSelection(switch)
Sets wireframe selection mode.
 
setZWriteTrans(switch)
Sets z write transparency.
 
setZeroParallaxDistance(zp)
Sets zero parallax distance.
 
showADSKLogo(state)
Enable/disable Autodesk logo.
 
showBanner(text, t, bcolor, width, height)
Shows a banner on all render widgets.
 
showCoordinateSystem(switch)
Sets display of the render coordinate systems.
 
showInitialView()
Show initial view.
 
showOculusRiftPerformanceHUD(mode)
Sets oculus rift performance HUD .
 
showPIVRLogo(state)
Enable/disable Autodesk logo.
 
showProgressCursor(s)
Show progress cursor.
 
showStatistic(switch)
Sets display of the render statistic.
 
showVRECLogo(state)
Enable/disable Autodesk logo.
 
showViewCube(s)
Show view cube.
 
showWholeScene()
Shows the whole scene.
 
startStatisticsRecording(index)
Starts (resumes) recording statistical data of the given render window.
 
stopStatisticsRecording(index)
Stops (pauses) recording statistical data of the given render window.
 
subRenderOverlay()
 
toggleFullscreen(index, multiDisplayFullscreen)
switched between fullscreen and normal mode.
 
toggleRaytracing(state)
Toggle RayTracing on/off
 
updateAllMGLW()
Updates all MGLW.
 
updateAllMGLWAll()
Updates all MGLW.
 
writeRecordedStatistics(index, path)
Write all recorded statistics of the given render window to a csv file.
Variables
  BACKGROUND_MATERIAL_COLOR_LAYER = 15
  BACKPLATE_LAYER = 29
  BEAUTY_PASS = 0
  DEPTH_LAYER = 34
  DIFFUSE_IBL_ILLUMINATION_LAYER = 16
  DIFFUSE_IBL_LAYER = 1
  DIFFUSE_INDIRECT_ILLUMINATION_LAYER = 22
  DIFFUSE_INDIRECT_LIGHT_LAYER = 8
  DIFFUSE_LIGHT_COLOR_LAYER = 2
  DIFFUSE_LIGHT_ILLUMINATION_LAYER = 19
  DIFFUSE_MATERIAL_COLOR_LAYER = 10
  ENV_OCCLUSION_LAYER = 31
  FOG_LAYER = 27
  FRONTPLATE_LAYER = 30
  GLOSSY_IBL_ILLUMINATION_LAYER = 17
  GLOSSY_IBL_LAYER = 3
  GLOSSY_INDIRECT_ILLUMINATION_LAYER = 23
  GLOSSY_INDIRECT_LIGHT_LAYER = 9
  GLOSSY_LIGHT_COLOR_LAYER = 4
  GLOSSY_LIGHT_ILLUMINATION_LAYER = 20
  GLOSSY_MATERIAL_COLOR_LAYER = 11
  INCANDESCENCE_LAYER = 7
  LENS_FLARE_LAYER = 28
  MASK_LAYER = 42
  MATERIAL_ID_LAYER = 41
  NORMAL_LAYER = 33
  OcclusionCullingAccurate = 0
  OcclusionCullingFast = 1
  OcclusionHierarchicalMultiFrame = 0
  OcclusionMultiFrame = 0
  OcclusionStopAndWait = 0
  POSITION_LAYER = 43
  SPECULAR_IBL_LAYER = 5
  SPECULAR_INDIRECT_ILLUMINATION_LAYER = 24
  SPECULAR_MATERIAL_COLOR_LAYER = 12
  SPECULAR_REFLECTION_LAYER = 5
  TRANSLUCENCY_IBL_ILLUMINATION_LAYER = 18
  TRANSLUCENCY_INDIRECT_ILLUMINATION_LAYER = 25
  TRANSLUCENCY_LAYER = 6
  TRANSLUCENCY_LIGHT_ILLUMINATION_LAYER = 21
  TRANSLUCENCY_MATERIAL_COLOR_LAYER = 13
  TRANSPARENCY_MATERIAL_COLOR_LAYER = 14
  VIEW_VECTOR_LAYER = 44
  VOLUME_COLOR_LAYER = 26
  VR_BAKED_BASE_ILLUMINATION = 2
  VR_BAKED_SEPARATE_ILLUMINATION = 4
  VR_BAKED_SHADOWS = 1
  VR_DISPLAY_HDR10 = 5
  VR_DISPLAY_OCULUS_RIFT = 1
  VR_DISPLAY_OPEN_VR = 4
  VR_DISPLAY_OPEN_XR = 9
  VR_DISPLAY_SIM2_HDR = 3
  VR_DISPLAY_SONY_10BIT = 2
  VR_DISPLAY_STANDARD = 0
  VR_DISPLAY_VARJO = 8
  VR_DLSS_BALANCED = 3
  VR_DLSS_OFF = 0
  VR_DLSS_PERFORMANCE = 2
  VR_DLSS_QUALITY = 4
  VR_DLSS_ULTRA_PERFORMANCE = 5
  VR_DOWNSCALE_FACTOR_HIGH = 8
  VR_DOWNSCALE_FACTOR_LOW = 2
  VR_DOWNSCALE_FACTOR_MEDIUM = 4
  VR_QUALITY_ANALYTIC_HIGH = 2
  VR_QUALITY_ANALYTIC_LOW = 1
  VR_QUALITY_NPR = 32
  VR_QUALITY_RAYTRACING = 16
  VR_QUALITY_REALISTIC_HIGH = 8
  VR_QUALITY_REALISTIC_LOW = 4
  VR_SELECT_ADJACENT = 4
  VR_SELECT_BY_MATERIAL = 3
  VR_SELECT_COMPONENT = 1
  VR_SELECT_GROUP = 2
  VR_SELECT_OBJECT = 0
  VR_SS_QUALITY_HIGH = 8
  VR_SS_QUALITY_LOW = 2
  VR_SS_QUALITY_MEDIUM = 4
  VR_SS_QUALITY_OFF = 0
  VR_SS_QUALITY_ON = 1
  VR_SS_QUALITY_ULTRA_HIGH = 16
  VR_STEREO_5VIEWS = 6
  VR_STEREO_BLUEYELLOW = 2
  VR_STEREO_DOUBLEBUFFER = 0
  VR_STEREO_GREENMAGENTA = 3
  VR_STEREO_HORIZONTALINTERLACED = 4
  VR_STEREO_LEFT_EYE = 2
  VR_STEREO_REDCYAN = 1
  VR_STEREO_RIGHT_EYE = 3
  VR_STEREO_SPLIT_LEFT_RIGHT = 1
  VR_STEREO_SPLIT_TOP_BOTTOM = 0
  VR_STEREO_VERTICALINTERLACED = 5
Function Details

getHeightAboveGround(index)

 

Returns the height above the ground.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
Returns: float
The height above the ground.

getHeightAboveGround(index, node)

 

Returns the height above the ground.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • node (NodePtr) - The ground node.
Returns: float
The height above the ground.

getSceneIntersection(index, rayOrigin, rayDirection)

 

Returns the intersection of the given ray with the scene.

Parameters:
  • index (integer) - The index of the render window (-1 for the main render window) in which the intersection should be computed.
  • rayOrigin (Pnt3f) - Origin of the ray in world coordinates.
  • rayDirection (Vec3f) - Direction vector of the ray in world coordinates.
Returns: tuple of vrNodePtr, Pnt3f, Vec3f, Vec2f
intersection result (hit object, intersection point in world coordinates, intersection normal in world coordinates and uv coordinates).

getSceneIntersection(index, xCoord, yCoord)

 

Returns the intersection of the view ray of the active camera through the given pixel coordinates in the render window.

Parameters:
  • index (integer) - The index of the render window (-1 for the main render window) in which the intersection should be computed.
  • xCoord (integer) - x-coordinate in pixels, (0,0) is in the upper left corner of the render window.
  • yCoord (integer) - y-coordinate in pixels, (0,0) is in the upper left corner of the render window.
Returns: tuple of vrNodePtr, Pnt3f, Vec3f, Vec2f
intersection result (hit object, intersection point in world coordinates, intersection normal in world coordinates and uv coordinates).

getUserCameraMatrix(userId, cameraName)

 

Gets the user projection camera world matrix (column-wise).

Parameters:
  • userId (int) - The tracking user id.
  • cameraName (string) - The name of the camera.
Returns: vector of floats
The user projection camera world matrix.

getUserCameraMatrix(userId, windowId)

 

Gets the user projection camera world matrix (column-wise).

Parameters:
  • userId (int) - The tracking user id.
  • windowId (int) - The render window index.
Returns: vector of floats
The user projection camera world matrix.

setCameraHeightAboveGround(index, relativeHeight)

 

Set camera "relativeHeight" above the ground

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • relativeHeight (float) - The relative height.

setCameraHeightAboveGround(index, relativeHeight, keepAt)

 

Set camera "relativeHeight" above the ground

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • relativeHeight (float) - The relative height.
  • keepAt (bool) - If true, the at point is not changed.

setCameraHeightAboveGround(index, relativeHeight, groundNode)

 

Set camera "relativeHeight" above the ground. Primarily checking for the ground plane specified (if it has a Shadow material)

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • relativeHeight (float) - The relative height.
  • groundNode (NodePtr) - The ground node.

zoomTo(node)

 

Zooms to node.

Parameters:
  • node (NodePtr) - The node.

zoomTo(node, use_at)

 

Zooms to node.

Parameters:
  • node (NodePtr) - The node.
  • use_at (bool) - use at.

setBackplate(state)

 

Deprecated. See enableBackplates

setBackplate(state, index)

 

Deprecated. See enableBackplates

getBackplatesEnabled(index)

 

Returns if backplate rendering is enabled for the active render window. See also getSceneplatesEnabled for the global switch if sceneplates should be rendered at all.

Returns: bool
The state of backplate rendering (enabled or disabled)

enableBackplates(state)

 

Enables or disables backplate rendering for the active render window. See also enableSceneplates for the global switch if sceneplates should be rendered at all.

Parameters:
  • state (bool) - Switch backplate rendering on or off.

enableBackplates(state, index)

 

Enables or disables backplate rendering for the given render window. See also enableSceneplates for the global switch if sceneplates should be rendered at all.

Parameters:
  • state (bool) - Switch backplate rendering on or off.
  • index (integer) - Index of render window.

getFrontplatesEnabled(index)

 

Returns if frontplate rendering is enabled for the active render window. See also getSceneplatesEnabled for the global switch if sceneplates should be rendered at all.

Returns: bool
The state of frontplate rendering (enabled or disabled)

enableFrontplates(state)

 

Enables or disables frontplate rendering for the active render window. See also enableSceneplates for the global switch if sceneplates should be rendered at all.

Parameters:
  • state (bool) - Switch frontplate rendering on or off.

enableFrontplates(state, index)

 

Enables or disables frontplate rendering for the given render window. See also enableSceneplates for the global switch if sceneplates should be rendered at all.

Parameters:
  • state (bool) - Switch frontplate rendering on or off.
  • index (integer) - Index of render window.

getSceneplatesEnabled(index)

 

Returns if sceneplate rendering is enabled for the active render window. This works as a master-off for all sceneplate types, e.g. in order to render frontplates, sceneplate and frontplate rendering has to be enabled. See also getFrontplatesEnabled and getBackplatesEnabled.

Returns: bool
The state of sceneplate rendering (enabled or disabled)

enableSceneplates(state)

 

Enables or disables sceneplate rendering for the active render window. This works as a master-off for all sceneplate types, e.g. in order to render frontplates, sceneplate and frontplate rendering has to be enabled. See also enableFrontplates and enableBackplates.

Parameters:
  • state (bool) - Switch sceneplates rendering on or off.

enableSceneplates(state, index)

 

Enables or disables sceneplate rendering for the given render window. This works as a master-off for all sceneplate types, e.g. in order to render frontplates, sceneplate and frontplate rendering has to be enabled. See also enableFrontplates and enableBackplates.

Parameters:
  • state (bool) - Switch sceneplates rendering on or off.
  • index (integer) - Index of render window.

adaptZeroParallaxDistance(index)

 

Automatically adjusts the zero parallax distance.

Parameters:
  • index (integer) - The index of the render widget.

clearRecordedStatistics(index)

 

Deletes all recorded statistics of the given render window.

Parameters:
  • index (integer) - The index of the render window (-1 for the focused window).

compressTextures()

 

Deprecated. Compresses all the textures.

createScreenshot(filename)

 

Creates a screenshot of the render window and writes out a image file.

Note: It's best to call updateRender(True) before this to make sure the created screenshot is really up to date.

Parameters:
  • filename (string) - path of the image file.

destroyRenderWindow(index)

 

Destroys a render window.

Parameters:
  • index (integer) - The index of the render window.

enableAntialiasing(switch)

 

Sets anti-aliasing.

Parameters:
  • switch (integer) - Anti-aliasing: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

enableDrawAction(index, state)

 

Enables draw action.

Parameters:
  • index (integer) - The index of render window.
  • state (boolean) - Draw action: On/Off.

enableHeadlight(switch)

 

Sets the headlight state.

Parameters:
  • switch (integer) - Headlight: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

enablePowerwall(window, state)

 

Enables local powerwall mode.

Parameters:
  • window (integer) - The window index.
  • state (boolean) - Powerwall mode: Enable/Disable.
Returns: boolean
True on success, false otherwise.

enableRaytracing(state)

 

Enables or disables raytracing.

Parameters:
  • state (bool) - Enable Raytracing: On/Off.

enableRaytracingDownscale(switch)

 

Sets raytracing downscale.

Parameters:
  • switch (integer) - Raytracing downscale: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

enableRender(switch)

 

Sets rendering state.

Parameters:
  • switch (boolean) - Rendering: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

enableRenderRegion(s)

 

Sets region rendering.

Parameters:
  • s (integer) - Enabling render region, true, false.

enableStereo(window, state, passive, mode, es, zp)

 

Enables stereo.

Split stereo modi (passive = True):

VR_STEREO_SPLIT_TOP_BOTTOM = 0,

VR_STEREO_SPLIT_LEFT_RIGHT = 1,

VR_STEREO_LEFT_EYE = 2,

VR_STEREO_RIGHT_EYE = 3,

VR_STEREO_SPLIT_LEFT_RIGHT_HALF = 4.

Stereo modi (passive = False):

VR_STEREO_DOUBLEBUFFER = 0,

VR_STEREO_REDCYAN = 1,

VR_STEREO_BLUEYELLOW = 2,

VR_STEREO_GREENMAGENTA = 3,

VR_STEREO_HORIZONTALINTERLACED = 4,

VR_STEREO_VERTICALINTERLACED = 5.

Parameters:
  • window (integer) - The window index.
  • state (boolean) - Stereo: On/Off.
  • passive (boolean) - Passive stereo: On/Off.
  • mode (integer) - The stereo mode.
  • es (float) - The eye separation factor.
  • zp (float) - The zero parallax distance.
Returns: boolean
True on success, false otherwise.

getAntialiasingEnabled()

 

Checks, if anti-aliasing is enabled.

Returns: bool
True, if anti-aliasing is enabled.

getAspect()

 

Gets the aspect ratio.

Returns: float
The aspect ratio.

getAt(index)

 

Returns "at" point.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
Returns: Pnt3f
The "at" point.

getAuxiliaryNodesVisibleDuringAntialiasing()

 

Returns the visibility state of the auxiliary nodes during antialiasing.

Returns: bool
The visibility of auxiliary nodes during antialiasing.

getAverageFPS()

 

Returns the average number of frames per second.

Returns: float (64bit)
The average frames per second.

getCamNode(index)

 

Gets the camera node.

Parameters:
  • index (integer) - The index of render window.
Returns: vrNodePtr
The camera node.

getCameraPivotAlwaysVisible()

 

Returns the visibility state of the the camera pivot while not navigating.

Returns: bool
The camera pivot visibility while not navigating.

getCameraPivotVisible()

 

Returns the visibility state of the the camera pivot .

Returns: bool
The camera pivot visibility during navigation.

getDLSSQuality()

 

Returns the current deep learning supersampling quality.

Returns: integer
DLSS Quality: VR_DLSS_OFF, VR_DLSS_PERFORMANCE, VR_DLSS_BALANCED, VR_DLSS_QUALITY, VR_DLSS_ULTRA_PERFORMANCE.

getDepthPeeling()

 

Returns whether depth peeling is enabled in OpenGL.

Returns: bool
Depth Peeling: On/Off.

getDepthPeelingLayers()

 

Returns the number of layers that are peeled for depth peeling in OpenGL.

Returns: int
The number of layers.

getFPS()

 

Returns the current number of frames per second.

Returns: float (64bit)
The frames per second.

getFar()

 

Gets the far clipping plane.

Returns: float
distance to the far plane

getFov()

 

Gets the field of view.

Returns: float
The field of view value.

getFrom(index)

 

Returns "from" point.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
Returns: Pnt3f
The "from" point.

getGenlockingFrameCount()

 

Returns current genlocking frame count.

Returns: unsigned int
The frame count.

getLastPickingMaterial()

 

Returns the last picked material.

Returns: vrMaterialPtr
last picked material.

getLastPickingNode()

 

Returns the last picked node.

Returns: vrNodePtr
last picked node.

getLastPickingPosition()

 

Returns the last picked position.

Returns: Pnt3f
last picked position.

getLightmapGPUTextureCompression()

 

Returns whether GPU texture compression is enabled for lightmaps in OpenGL rendering.

Returns: boolean
Enable state.

getMotionFactor()

 

Returns the current motion factor.

Returns: float
Returns the current motion factor.

getMousePosition(index)

 

Returns the current pixel coordinates of the mouse over the given render window.

Parameters:
  • index (integer) - The index of the render window (-1 for the main render window).
Returns: list of 2 integers
pixel coordinates, range: 0..width, 0..height of the render window. [-1,-1] if the mouse is not over the render window.

getNavigationPivot(index)

 

Returns navigation pivot.

See also setPivot.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
Returns: Pnt3f
The navigation pivot.

getNear()

 

Gets the near clipping plane.

Returns: float
The distance to the near plane.

getNodeMaterial(node)

 

Returns the temporary override material a node uses in OpenGL.

Parameters:
  • node (NodePtr) - The node.
Returns: MaterialPtr
The material.

getOculusRiftTrackingOrigin()

 

Returns the Oculus Rift tracking reference origin. Default is (0, 0, 0). Can be changed with setOculusRiftTrackingOrigin.

Returns: Pnt3f
the Oculus Rift tracking reference origin.

getOculusRiftTrackingOriginType()

 

Windows only: Retrieves the tracking origin type for the oculus rift.

Returns: int
0 = Seated, 1 = Standing.

getRaytracingDownscaleFactor()

 

Returns the raytracing downscale factor.

Returns: integer
raytracing downscale factor.

getRaytracingEnabled()

 

Checks, if raytracing is enabled.

Returns: bool
True, if raytracing is enabled.

getRenderRoot(index)

 

Gets the render root.

Parameters:
  • index (integer) - The index of render window.
Returns: vrNodePtr
The render root.

getRenderRoots(index)

 

Gets the render roots.

Parameters:
  • index (integer) - The index of render window.
Returns: list of vrNodePtrs
The list of roots.

getRenderWindowCount()

 

Returns number of render windows.

Returns: unsigned int
The number of render windows.

getRenderWindowHeight(i)

 

Returns the render window height.

Parameters:
  • i (int) - The render window index.
Returns: int
The render window height.

getRenderWindowWidth(i)

 

Returns the render window width.

Parameters:
  • i (int) - The render window index.
Returns: int
The render window width.

getRoll(index)

 

Get navigator roll.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
Returns: Real32
Roll in degrees.

getSAAWindow()

 

Returns the still anti-aliasing window.

Returns: int
The still anti-aliasing window id.

getSeparateBakeColor()

 

Returns color multiplier for the baked separate illumination in 3D rendering.

Returns: Color3f
The color multiplier.

getSeparateBakeIntensity()

 

Returns intensity multiplier for the baked separate illumination in 3D rendering.

Returns: float
The intensity multiplier.

getShadowMapUpdates()

 

Returns whether shadow map updates are enabled or disabled.

Returns: bool
state of the shadow map updates.

getShadowPlane(rootNode, shadowPlaneNameRegexp)

 

Get the Shadow Plane given a regexp. Will check so that the node is active and has a shadow material:

Parameters:
  • rootNode (NodePtr) - The root.
  • shadowPlaneNameRegexp (const char*) - Name of the node to measure against.

getShowASides()

 

Returns the state of the A Side rendering flag.

Returns: bool
Whether rendering of A Sides is enabled or not.

getShowBSides()

 

Returns the state of the B Side rendering flag.

Returns: bool
Whether rendering of B Sides is enabled or not.

getSuperSampling()

 

Checks, if super sampling is enabled (Visualization > Realtime Antialiasing).

Returns: bool
True, if super sampling is enabled.

getSuperSamplingQuality()

 

Returns the current realtime antialiasing quality. See setSuperSamplingQuality

Returns: unsigned int
Super sampling quality.

getUp(index)

 

Returns "up" vector.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
Returns: Vec3f
The "up" vector.

getUseBake(bakeComponent)

 

Returns whether individual baking components are enabled to be used by 3D rendering.

Parameters:
  • bakeComponent (unsigned int) - VR_BAKED_SHADOWS, VR_BAKED_BASE_ILLUMINATION, or VR_BAKED_SEPARATE_ILLUMINATION
Returns: boolean
True if enabled, False otherwise.

getUseBindless()

 

Returns whether bindless graphics should be used or not.

Returns: bool
bindless graphics enabled or disabled.

getUseCommandList()

 

Deprecated: Commandlists are not supported.

Returns: bool
command list extension enabled or disabled.

getUseMulticastSLI()

 

Returns whether multicast SLI should be used or not.

Returns: bool
multicast SLI enabled or disabled.

getUseSinglePassStereo()

 

Returns whether single pass stereo is activated for stereo rendering or not

Returns: bool
single pass stereo enabled or disabled.

getUserMatrix(id)

 

Gets the user projection transform matrix (column-wise).

Parameters:
  • id (int) - The render window index.
Returns: vector of floats
The user projection transform matrix.

getUserNode()

 

Deprecated. Please use get/setUserMatrix instead.

getViewAt(index)

 

Returns "ViewAt" point.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
Returns: Pnt3f
The "ViewAt" point.

getViewRay(index, xCoord, yCoord)

 

Returns a ray that starts at the active camera and goes through the pixel at the given coordinates (x, y) in the render window.

Parameters:
  • index (integer) - The index of the render window (-1 for the main render window).
  • xCoord (int) - x-coordinate in pixels, (0,0) is in the upper left corner of the render window.
  • yCoord (int) - y-coordinate in pixels, (0,0) is in the upper left corner of the render window.
Returns: tuple of Pnt3f and Vec3f
ray origin and direction in world coordinates.

isDLSSSupported()

 

Returns True, if deep learning supersampling is supported.

Returns: bool
True, if DLSS is supported.

isRaytracingDownscaleEnabled()

 

Checks, if raytracing downscale is enabled.

Returns: bool
True, if raytracing downscale is enabled.

moveRenderWindow(index, xPos, yPos)

 

Moves a render window.

Parameters:
  • index (integer) - The index of the render window.
  • xPos (integer) - The x position.
  • yPos (integer) - The y position.

moveStatistic(x, y)

 

Sets the position of the render statistic.

Parameters:
  • x (integer) - x position.
  • y (integer) - y position.

resetIsolateView(index)

 

Resets the isolate view on the render window.

Parameters:
  • index (integer) - The index of render window.

resetNodeMaterial(node)

 

Resets the temporary node material override.

Parameters:
  • node (NodePtr) - The node.

resetOculusRiftOrientation()

 

Resets the tracking origin according to the current headset location and sets the yaw orientation to the current headset yaw value.

In 'Standing' mode, the tracking origin is set to the position on the floor below the HMD.

resizeRenderWindow(index, width, height)

 

Resizes a render window.

Parameters:
  • index (integer) - The index of the render window.
  • width (integer) - The width.
  • height (integer) - The height.

setAORendering(state)

 

Enables or disables ambient occlusion rendering.

Parameters:
  • state (int) - Ambient occlusion rendering: On/Off.

setAOShadowsVisible(state)

 

Enables or disables ambient occlusion shadows for OpenGL.

Parameters:
  • state (int) - Ambient occlusion shadows: On/Off.

setActiveRenderPass(passID, index)

 

Sets the renderpass for the specified window.

Parameters:
  • passID - The renderpass id: BEAUTY_PASS, DIFFUSE_IBL_LAYER, DIFFUSE_LIGHT_COLOR_LAYER, GLOSSY_IBL_LAYER, GLOSSY_LIGHT_COLOR_LAYER, SPECULAR_REFLECTION_LAYER, TRANSLUCENCY_LAYER, INCANDESCENCE_LAYER, DIFFUSE_INDIRECT_LIGHT_LAYER, GLOSSY_INDIRECT_LIGHT_LAYER, DIFFUSE_MATERIAL_COLOR_LAYER, GLOSSY_MATERIAL_COLOR_LAYER, SPECULAR_MATERIAL_COLOR_LAYER, TRANSLUCENCY_MATERIAL_COLOR_LAYER, TRANSPARENCY_MATERIAL_COLOR_LAYER, BACKGROUND_MATERIAL_COLOR_LAYER, DIFFUSE_IBL_ILLUMINATION_LAYER, GLOSSY_IBL_ILLUMINATION_LAYER, TRANSLUCENCY_IBL_ILLUMINATION_LAYER, DIFFUSE_LIGHT_ILLUMINATION_LAYER, GLOSSY_LIGHT_ILLUMINATION_LAYER, TRANSLUCENCY_LIGHT_ILLUMINATION_LAYER, DIFFUSE_INDIRECT_ILLUMINATION_LAYER, GLOSSY_INDIRECT_ILLUMINATION_LAYER, SPECULAR_INDIRECT_ILLUMINATION_LAYER, TRANSLUCENCY_INDIRECT_ILLUMINATION_LAYER, VOLUME_COLOR_LAYER, FOG_LAYER, LENS_FLARE_LAYER, FRONTPLATE_LAYER, BACKPLATE_LAYER, ENV_OCCLUSION_LAYER, NORMAL_LAYER, DEPTH_LAYER, MATERIAL_ID_LAYER, MASK_LAYER, POSITION_LAYER, VIEW_VECTOR_LAYER
  • index (integer) - The index of render window.

setAllGradientBackgrounds(colors, ints)

 

Sets gradient background for all render windows.

Parameters:
  • colors (list of Color3fs) - The color list.
  • ints (list of floats) - The interval list.

setAllNavigationsEnabled(state)

 

Activates Navigation for all MGLW.

Parameters:
  • state (bool) - Navigation: On/Off.

setAnalyticRendering(state)

 

Enables or disables analytic rendering.

Parameters:
  • state (int) - Analytic rendering: On/Off.

setAspect(aspect)

 

Sets the aspect ratio.

Parameters:
  • aspect (float) - The aspect ratio.

setAt(index, point, x, y, z)

 

Set camera "at" point. Actually there are two functions:

setAt(index,x,y,z) sets the "at" point with the widget index and three float parameters.

setAt(index,point) sets the "at" point with the widget index and a point parameter.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • point (Pnt3f) - The "at" point.
  • x (float) - The x coordinate of the "at" point.
  • y (float) - The y coordinate of the "at" point.
  • z (float) - The z coordinate of the "at" point.

setAutoFrustum(switch)

 

Sets the auto frustum.

Parameters:
  • switch (integer) - Auto frustum: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setAuxiliaryNodesVisibleDuringAntialiasing(state)

 

Enable/disable display of auxiliary nodes during antialiasing.

Parameters:
  • state (bool) - Show auxiliary nodes: On/Off.

setBackfaceCulling(switch)

 

Renders the whole scene with backface culling.

Parameters:
  • switch (integer) - Backface culling: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setCameraBeacon()

 

Deprecated. Move the camera node instead.

setCameraConstraint(camera_constraint, min_dist)

 

Sets camera constraint and optionally the minimum distance.

Parameters:
  • camera_constraint (NodePtr) - The constraint node.
  • min_dist (float (32bit)) - The minimum distance (Optional).

setCameraPanning(x, y)

 

Panning of the camera.

Parameters:
  • x (float) - The horizontal panning.
  • y (float) - The vertical panning.

setCameraPivotAlwaysVisible(state)

 

Enable/disable display of the camera pivot while not navigating.

Parameters:
  • state (bool) - Show pivot: On/Off.

setCameraPivotVisible(state)

 

Enable/disable display of the camera pivot during navigation.

Parameters:
  • state (bool) - Show pivot: On/Off.

setCameraRotation(x, y)

 

Rotates the camera.

Parameters:
  • x (float) - The rotation angle around the up vector.
  • y (float) - The rotation angle around the right vector.

setCameraScale(x, y, z)

 

Scales the camera, e.g for vertical flipping (1, -1, 1).

Parameters:
  • x (float) - The horizontal scale.
  • y (float) - The vertical scale.
  • z (float) - The depth scale.

setCameraZUp(state)

 

Sets camera z up.

Parameters:
  • state (boolean) - Camera z up: Enable/Disable.

setCameraZoom(distance)

 

Zooms the camera.

Parameters:
  • distance (float) - The distance to move from at point.

setClusterCameraConnection(state)

 

Sets the connection of the cameras in a cluster.

Parameters:
  • state (bool) - Camera connection: Enable/Disable.

setDLSSQuality(quality)

 

Sets the deep learning supersampling quality.

Parameters:
  • quality (integer) - VR_DLSS_OFF, VR_DLSS_PERFORMANCE, VR_DLSS_BALANCED, VR_DLSS_QUALITY, VR_DLSS_ULTRA_PERFORMANCE.

setDefaultCameraBeacons()

 

Deprecated. Move the camera node instead.

setDepthOnlyPass(switch)

 

Sets the depth only pass state. If enabled the scene is rendered without shaders first to fill the depth buffer and then again to execute the shaders on the visible pixel.

Parameters:
  • switch (integer) - SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setDepthPeeling(state)

 

Enables or disables depth peeling in OpenGL. Default is off.

Parameters:
  • state (bool) - Depth Peeling: On/Off.

setDepthPeelingLayers(layers)

 

Sets the number of layers to peel for depth peeling in OpenGL.

Parameters:
  • layers (int) - The number of layers

setDiscontinuityRendering(state)

 

Enables or disables surface analysis rendering.

Parameters:
  • state (int) - Surface analysis rendering: On/Off.

setDisplayMode(mode)

 

Sets the display mode.

Parameters:
  • mode (unsigned int) - Display mode: VR_DISPLAY_STANDARD, VR_DISPLAY_OCULUS_RIFT, VR_DISPLAY_SONY_10BIT, VR_DISPLAY_SIM2_HDR, VR_DISPLAY_OPEN_VR, VR_DISPLAY_VARJO, VR_DISPLAY_OPEN_XR, VR_DISPLAY_HDR10.

setDistance(index, distance)

 

Set camera distance.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • distance (float) - The distance.

setDollySpeed(scalefactor)

 

Set the scalefactor for the navigator dolly speed.

Parameters:
  • scalefactor (float) - dolly speed scaling factor

setEvaluateClipping(state)

 

Enables or disables clipping plane evaluation in OpenGL. Default is on.

Parameters:
  • state (bool) - OpenGL Clipping: On/Off.

setEyeSeparation(es)

 

Sets eye separation factor.

Parameters:
  • es (float) - The eye separation factor.

setFaceNormalRendering(state)

 

Enables or disables face normal rendering.

Parameters:
  • state (int) - Face normal rendering: On/Off.

setFar(far)

 

Sets the far clipping plane.

Parameters:
  • far (float) - The distance to the far plane.

setFixedRenderWindowSize(width, height)

 

Set a fixed size for the main render window.

Pass -1, -1 for dynamic resolution.

Parameters:
  • width (integer) - The width.
  • height (integer) - The height.

setFlyMode(switch)

 

Switches between virtual trackball and fly navigation.

Parameters:
  • switch (integer) - Fly mode: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setForceTransparentObjectSelection(mode)

 

Enables/diables the selection of objects with a 100% transparent material in the render window.

Parameters:
  • mode - state: On/Off.
  • state (bool)

setFov(fov)

 

Sets the field of view.

Parameters:
  • fov (float) - The field of view value.

setFreezeOcclusionCulling(freezeCulling)

 

Freezes the current state of the occlusion culling for debugging purposes.

Parameters:
  • freezeCulling (bool) - On/Off.

setFrom(index, point, x, y, z)

 

Set camera "from" point. Actually there are two functions:

setFrom(index,x,y,z) sets the "from" point with the widget index and three float parameters.

setFrom(index,point) sets the "from" point with the widget index and a point parameter.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • point (Pnt3f) - The "from" point.
  • x (float) - The x coordinate of the "from" point.
  • y (float) - The y coordinate of the "from" point.
  • z (float) - The z coordinate of the "from" point.

setFromAtUp(index, from, at, up, fx, fy, fz, ax, ay, az, ux, uy, uz)

 

Set camera "from", "at" and "up". Actually there are two functions:

setFromAtUp(index,fx,fy,fz,ax,ay,az,ux,uy,uz) sets the camera parameters with the widget index and nine float parameters.

setFromAtUp(index,from,at,up) sets the camera parameters with the widget index and two point and one vector parameter.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • from (Pnt3f) - The "from" point.
  • at (Pnt3f) - The "at" point.
  • up (Vec3f) - The "up" vector.
  • fx (float) - The x coordinate of the "from" point.
  • fy (float) - The y coordinate of the "from" point.
  • fz (float) - The z coordinate of the "from" point.
  • ax (float) - The x coordinate of the "at" point.
  • ay (float) - The y coordinate of the "at" point.
  • az (float) - The z coordinate of the "at" point.
  • ux (float) - The x coordinate of the "up" vector.
  • uy (float) - The y coordinate of the "up" vector.
  • uz (float) - The z coordinate of the "up" vector.

setFrustum(index, left, right, bottom, top)

 

Set camera frustum

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • left (float) - The left value.
  • right (float) - The right value.
  • bottom (float) - The bottom value.
  • top (float) - The top value.

setFrustumCulling(switch)

 

Sets the frustum culling.

Parameters:
  • switch (integer) - Frustum culling: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setGenlocking(state)

 

Enables or disables genlocking.

Parameters:
  • state (bool) - Genlocking: On/Off.

setGradientBackground(index, colors, ints)

 

Sets gradient background for a given render window.

Parameters:
  • index (integer) - The index of render window.
  • colors (list of Color3fs) - The color list.
  • ints (list of floats) - The interval list.

setHighQualityAntialiasing(state)

 

Enables or disables high quality anti-aliasing.

Parameters:
  • state (bool) - High quality anti-aliasing: On/Off.

setIndirectRendering(state)

 

Deprecated. Enables or disables precomputed illumination rendering.

Parameters:
  • state (int) - Precomputed illumination rendering: On/Off.

setInteractionMode(mode)

 

Set the interaction mode.

Parameters:
  • mode (integer) - 0 means VRED mode, 1 means Alias mode and 2 means Maya mode.

setIsolateView(index, roots)

 

Sets the isolate view on the provided objects.

Parameters:
  • index (integer) - The index of render window.
  • roots (list of vrNodePtrs) - The list of nodes.

setKeepRaytracingStructure(switch)

 

Enables or disables keeping of the raytracing structure.

Parameters:
  • switch (integer) - Keep raytracing structure: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setLightmapGPUTextureCompression(on)

 

Enables/disables GPU texture compression for lightmaps to reduce memory consumption on the GPU for OpenGL rendering. Currently, only separate lightmaps are compressed. Default is on. Disable in case you see compression artifacts in 3D rendering.

Please note, activating the compression can take a while depending on number of separate lightmaps and their size, as textures are compressed and uploaded to the GPU.

Parameters:
  • on (boolean) - True to enable, False to disable.

setLocalLights(switch)

 

Sets local light source mode.

Parameters:
  • switch (integer) - Local light source mode: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setMono(index, state)

 

Disable stereo.

Parameters:
  • index (int) - The index of the gl window.
  • state (bool) - Mono: On/Off.

setMotionFactor(factor)

 

Sets motion factor.

Parameters:
  • factor (float) - The motion factor.

setNavMode(mode)

 

Switches between different navigation modi.

Parameters:
  • mode (integer) - The navigation mode: 0 = NavigatorTrackball, 1 = NavigatorFly, 2 = NavigatorWalk, 3 = NavigatorAxis, 4 = NavigatorOrientation, 5 = Disable Navigation.

setNavOrbitMode(enabled)

 

Sets navigation orbit mode to on/off.

Parameters:
  • enabled (bool) - true or false.

setNavigationSpeedMode(mode)

 

Set the navigator speed mode for two axis and trackball navigation modes.

Parameters:
  • mode (int) - 0 = unconstrained, 1 = limited, 2 = linear.

setNear(near)

 

Sets the near clipping plane.

Parameters:
  • near (float) - The distance to the near plane.

setNodeMaterial(node, mat)

 

Sets a temporary override for the material a node uses for rendering in OpenGL. Use resetNodeMaterial to reset the override to its original state.

Parameters:
  • node (NodePtr) - The node.
  • mat (MaterialPtr) - The material.

setOcclusionCulling(switch)

 

Sets the occlusion culling state.

Parameters:
  • switch (integer) - Occlusion culling: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setOcclusionCullingMode(mode)

 

Sets the occlusion culling mode.(experimental)

OcclusionCullingAccurate renders all objects visible in the current frame.

OcclusionCullingFast renders all objects visible in the previous frame.

Parameters:
  • mode (integer) - Occlusion culling mode: OcclusionCullingAccurate or 0, OcclusionCullingFast or 1

setOculusRiftTracking(s)

 

Windows only: Enables/Disables tracking of the oculus rift.

Parameters:
  • s (bool) - On/Off.

setOculusRiftTrackingOrigin(position)

 

Sets the tracking reference origin for oculus rift tracking. Use it to correct any offsets in the scene. This function always assumes Y-Up, even if Z-up is set in the scene.

If the tracking origin should be at pos = (x_scene, y_scene, z_scene) in the VRED scene, call setOculusRiftTrackingOrigin(Pnt3f(-x_scene, -z_scene, y_scene)).

Parameters:
  • position (Pnt3f) - Position offset for the Oculus tracking.

setOculusRiftTrackingOriginType(originType)

 

Windows only: Sets the tracking origin type for the oculus rift.

Please note: This also resets the tracking origin according to the current headset location and yaw orientation. Wear the headset and stand or sit in a comfortable position.

Parameters:
  • originType (int) - 0 = Seated, 1 = Standing.

setOpenGLDebugging(s)

 

Enables/Disables OpenGL Debugging. This currently only works on Nvidia Quadro Hardware.

Parameters:
  • s (bool) - On/Off.

setPanningSpeed(scalefactor)

 

Set the scalefactor for the navigator panning speed when pivot based panning or linear navigation is turned on.

Parameters:
  • scalefactor (float) - panning speed scaling factor

setPivot(index, point, x, y, z)

 

Set navigator rotation pivot. Actually there are two functions:

setPivot(index,x,y,z) sets the rotation pivot with the widget index and three float parameters.

setPivot(index,point) sets the rotation pivot with the widget index and a point parameter.

See also getNavigationPivot.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • point (Pnt3f) - The rotation pivot.
  • x (float) - The x coordinate of the rotation pivot.
  • y (float) - The y coordinate of the rotation pivot.
  • z (float) - The z coordinate of the rotation pivot.

setPostprocessAntialiasingMode(on)

 

Enables/Disables postprocessing antialiasing.

Parameters:
  • on (unsigned int) - 0 = Off, 1 = On.

setPrecomputedRendering(state)

 

Enables or disables precomputed illumination rendering.

Parameters:
  • state (int) - Precomputed illumination rendering: On/Off.

setRaytracingDownscaleFactor(factor)

 

Sets the raytracing downscale factor.

Parameters:
  • factor (unsigned integer) - Factor: VR_DOWNSCALE_FACTOR_LOW, VR_DOWNSCALE_FACTOR_MEDIUM, VR_DOWNSCALE_FACTOR_HIGH.

setRealisticRendering(state)

 

Enables or disables realistic rendering. If nothing else is chosen, this is the default rendering mode.

Parameters:
  • state (int) - True activates realistic rendering, false keeps current rendering mode.

setRenderFullscreen(state)

 

Maximizes/minimizes the render widget.

Parameters:
  • state (boolean) - Render widget: maximize/minimize.

setRenderQuality(quality)

 

Sets the render quality.

Parameters:
  • quality (integer) - The render quality: VR_QUALITY_ANALYTIC_LOW, VR_QUALITY_ANALYTIC_HIGH, VR_QUALITY_REALISTIC_LOW, VR_QUALITY_REALISTIC_HIGH, VR_QUALITY_RAYTRACING, VR_QUALITY_NPR.

setRenderRegion(on, startX, startY, endX, endY)

 

Sets render region parameters.

Parameters:
  • on (boolean) - Enabling render region, True, False.
  • startX (integer) - Render region start x position.
  • startY (integer) - Render region start y position.
  • endX (integer) - Render region end x position.
  • endY (integer) - Render region end y position.

setRenderRoot(index, root)

 

Sets render root.

Parameters:
  • index (integer) - The index of render window.
  • root (NodePtr) - The render root.

setRenderRoots(index, roots)

 

Sets render roots.

Parameters:
  • index (integer) - The index of render window.
  • roots - The list of roots.
  • root (list of vrNodePtrs)

setRenderWindowDocked(index, state, flags)

 

Docks a render window.

Parameters:
  • index (integer) - The index of render window.
  • state (boolean) - Docked: On/Off.
  • flags (integer) - Window flags (NORMAL | FULLSCREEN | NOBORDER | ONTOP). Optional. Default is NORMAL.

setRoll(index, roll)

 

Set navigator roll.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • roll (float) - The roll.

setSAAWindow(id)

 

Sets the still anti-aliasing window, -1 means use window with focus.

Parameters:
  • id (int) - The window id.

setScreenspaceAO(state)

 

Enables or disables screen space ambient occlusion in OpenGL. Default is off.

Parameters:
  • state (int) - 1: use screen space AO. 0: Use precomputed AO, -1: toggle state.

setSelectionMode(mode)

 

Sets the selection mode.

Parameters:
  • mode (unsigned int) - Selection mode: VR_SELECT_COMPONENT, VR_SELECT_OBJECT, VR_SELECT_GROUP, VR_SELECT_BY_MATERIAL, VR_SELECT_ADJACENT.

setSeparateBakeColor(color)

 

Sets color multiplier for the baked separate illumination in 3D rendering. Default is white.

Parameters:
  • color (Color3f) - The color multiplier.

setSeparateBakeIntensity(intensity)

 

Sets intensity multiplier for the baked separate illumination in 3D rendering. Default is 1.0.

Parameters:
  • intensity (float) - The intensity multiplier.

setShadow(switch)

 

Sets shadow state.

Parameters:
  • switch (integer) - Shadows: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setShadowMapUpdates(on)

 

Enables/Disables updates to the shadow map.

Parameters:
  • on (bool) - true, false.

setShowABSides(showASides, showBSides)

 

Enable/disable the rendering of A and B Sides.

Parameters:
  • showASides (bool) - Render A Sides.
  • showBSides (bool) - Render BSides.

setSnapshotFrame(state, width, height)

 

Show snapshot frame.

Parameters:
  • state (boolean) - Snapshot frame: On/Off.
  • width (int) - The width.
  • height (int) - The height.

setSortTrans(switch)

 

Sets transparent sorting.

Parameters:
  • switch (integer) - Transparent sorting: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setSpaceMouseHeight(height)

 

Sets a fixed height in spacemouse mode.

Parameters:
  • height (float) - The height.

setSpaceMousePivotMode(i)

 

Sets the spacemouse pivot mode.

Parameters:
  • i (integer) - pivot mode: 0 == camera, 1 == object, 2 == focus distance, 3 == standard vred at.

setSpaceMouseTwoAxis(s)

 

Sets the two axis mode for the spacemouse.

Parameters:
  • s (bool) - two axis mode: On/Off.

setSpaceMouseViewMode(i)

 

Sets the spacemouse view mode.

Parameters:
  • i (integer) - view mode: 0 == camera, 1 == object.

setStillDOF(state, radius, focaldistance)

 

Enables depth of field.

Parameters:
  • state (bool) - Depth of field: On/Off.
  • radius (float) - The radius.
  • focaldistance (float) - The focal distance (parameter is optional).

setSuperSampling(state)

 

Enables or disables super sampling (Visualization > Realtime Antialiasing).

Parameters:
  • state (bool) - Super sampling: On/Off.

setSuperSamplingOnCameraMovement(state)

 

Enables/Disables super sampling (realtime antialiasing) on camera movements.

Parameters:
  • state (bool) - On/Off.

setSuperSamplingQuality(quality)

 

Sets the super sampling quality (Visualization > Realtime Antialiasing). Note, to enable realtime antialiasing you must also call setSuperSampling(True).

Parameters:
  • quality (unsigned int) - Super sampling quality level: VR_SS_QUALITY_LOW, VR_SS_QUALITY_MEDIUM, VR_SS_QUALITY_HIGH or VR_SS_QUALITY_ULTRA_HIGH.

setTextureCompression(switch)

 

Sets the opengl texture compression state.

Parameters:
  • switch (integer) - texture compression: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setTransformNodeSelectionPressed(node)

 

Select a transform node by mouse press event.

Parameters:
  • node (NodePtr) - The node to select as transform node.

setTransformNodeSelectionReleased(node)

 

Deselect of a transform node by mouse release event.

Parameters:
  • node (NodePtr) - The node to deselect.

setUp(index, vector, x, y, z)

 

Set camera "up" vector. Actually there are two functions:

setUp(index,x,y,z) sets the "up" vector with the widget index and three float parameters.

setUp(index,vector) sets the "up" vector with the widget index and a vector parameter.

Parameters:
  • index (integer) - The index of the render widget (-1 for the main widget).
  • vector (Vec3f) - The "up" vector.
  • x (float) - The x coordinate of the "up" vector.
  • y (float) - The y coordinate of the "up" vector.
  • z (float) - The z coordinate of the "up" vector.

setUseBake(bakeComponent, state)

 

Enables/Disables individual baking components to be used by 3D rendering. This applies to both vertex and texture baking. By default, all components are on.

Parameters:
  • bakeComponent (unsigned int) - VR_BAKED_SHADOWS, VR_BAKED_BASE_ILLUMINATION, or VR_BAKED_SEPARATE_ILLUMINATION
  • state (int) - True or 1 to enable, False or 0 to disable, -1 or SWITCH_TOGGLE to toggle.

setUseBindless(bindlessEnable)

 

Windows only, Experimental: Enables/Disables the use of bindless graphics extension if available. This can reduce the cost of rendering many geometries in OpenGL but it might get unstable if GPU memory is not sufficient.

Parameters:
  • bindlessEnable (bool) - On/Off.

setUseCommandList(commandlistEnable)

 

Deprecated: Commandlists are not supported.

Parameters:
  • commandlistEnable (bool) - On/Off.

setUseLastDrawTree(s)

 

Re-use old draw tree.

Parameters:
  • s (bool) - On/Off.

setUseMulticastSLI(multicastEnable)

 

Windows only: Enables/Disables use of multicast SLI for stereo rendering if present.

Parameters:
  • multicastEnable (bool) - On/Off.

setUsePivotBasedPanning(on)

 

Set the navigator panning mode to be based on the pivot.

Parameters:
  • on (bool) - true uses the distance to the pivot to base the panning speed on, false uses the distances to the picked position for panning

setUseSinglePassStereo(on)

 

Windows only: Enables/Disables use of single pass stereo if supported. This command should be called before stereo rendering is activated.

Parameters:
  • on (bool) - On/Off.

setUseSpaceMouseHeight(value)

 

Sets whether a fixed height is used or not.

Parameters:
  • value (bool) - Fixed height: On/Off.

setUseVariableRateShading(state)

 

Enable or disable variable rate shading.

Parameters:
  • state (boolean) - Enable/Disable.

setUserMatrix(id, matrix)

 

Sets the user projection transform matrix (column-wise).

Parameters:
  • id (int) - The render window index.
  • matrix (vector of floats) - The user projection transform matrix.

setVSyncInterval(interval)

 

Sets the V-Sync swap interval. 0 disables V-Sync, 1 Enables V-Sync. -1 Enables adaptive V-Sync if the GPU supports it.

Parameters:
  • interval (int) - Sets the swap interval.

setVariableRateShadingMode(mode)

 

Set shading rate mode.

Parameters:
  • mode (int) - 0 Screen & Materials (whole image has a specific uniform shading rate, overwrites per material are allowed), 1 Materials (whole image has native uniform shading, only overwrites per material are allowed), 2 Foveated (rings with different shading rate around center, overwrites per material are allowed).

setVariableRateShadingQuality(quality)

 

Set a predefined shading quality for uniform and foveated rendering. Latter one requires value of 6 to work properly. The super-sampling modes require enabled real-time antialiasing with corresponding multi-samples.

Parameters:
  • quality (int) - 0 native 1x1 pixel shading, 1 coarse 2x2 shading (1 sample per 4 pixels), 2 coarse 4x4 (1 sample per 16 pixels), 3 super-sampling 2x (2 samples per pixel), 4 super-sampling 4x (4 samples per pixel), 5 super-sampling 8x (8 samples per pixel), 6 foveated (quality is defined in VR preferences).

setViewportCamera(index, cameraNode)

 

Sets the active camera for the given render window to the camera of the given camera node.

Parameters:
  • index (integer) - The index of the render window (-1 for the focused widget).
  • cameraNode (vrNodePtr) - The camera node

setVolumeDrawing(switch)

 

Sets volume drawing mode.

Parameters:
  • switch (integer) - Volume drawing mode: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setWireframe(switch)

 

Sets wireframe rendering mode.

Parameters:
  • switch (int) - Wireframe rendering mode: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setWireframeSelection(switch)

 

Sets wireframe selection mode.

Parameters:
  • switch (int) - true, false.

setZWriteTrans(switch)

 

Sets z write transparency.

Parameters:
  • switch (integer) - Z write transparency: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

setZeroParallaxDistance(zp)

 

Sets zero parallax distance.

Parameters:
  • zp (float) - The zero parallax distance.

showADSKLogo(state)

 

Enable/disable Autodesk logo.

Parameters:
  • state (bool) - Show logo: On/Off.

showBanner(text, t, bcolor, width, height)

 

Shows a banner on all render widgets. There are four valid sets of parameters:

showBanner(text)

showBanner(text,t)

showBanner(text,t,bcolor)

showBanner(text,t,bcolor,width,height)

Parameters:
  • text (string) - The text to display.
  • t (float) - The transparency.
  • bcolor (unsigned int) - The background color (0xAARRGGBB).
  • width (int) - The banner width.
  • height (int) - The banner height.

showCoordinateSystem(switch)

 

Sets display of the render coordinate systems.

Parameters:
  • switch (integer) - Render coordinate systems: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

showOculusRiftPerformanceHUD(mode)

 

Sets oculus rift performance HUD .

Parameters:
  • mode (int) - the mode to set. 0 = off, 1 = summary, 2 = latency timer, 3 = app rendering timer, 4 = composer rendering timer, 5 = version info

showPIVRLogo(state)

 

Enable/disable Autodesk logo.

Parameters:
  • state (bool) - Show logo: On/Off.

showProgressCursor(s)

 

Show progress cursor.

Parameters:
  • s (bool) - On/Off.

showStatistic(switch)

 

Sets display of the render statistic.

Parameters:
  • switch (integer) - Render statistic: SWITCH_TOGGLE, SWITCH_ON, SWITCH_OFF, true, false.

showVRECLogo(state)

 

Enable/disable Autodesk logo.

Parameters:
  • state (bool) - Show logo: On/Off.

showViewCube(s)

 

Show view cube.

Parameters:
  • s (bool) - On/Off.

startStatisticsRecording(index)

 

Starts (resumes) recording statistical data of the given render window.

Parameters:
  • index (integer) - The index of the render window (-1 for the focused window).

stopStatisticsRecording(index)

 

Stops (pauses) recording statistical data of the given render window.

Parameters:
  • index (integer) - The index of the render window (-1 for the focused window).

toggleFullscreen(index, multiDisplayFullscreen)

 

switched between fullscreen and normal mode.

Parameters:
  • index (integer) - Render widget index.
  • multiDisplayFullscreen (boolean) - switch fullscreen over multi displays.

toggleRaytracing(state)

 

Toggle RayTracing on/off

Parameters:
  • state (bool) - Toggle Raytracing: On/Off.

writeRecordedStatistics(index, path)

 

Write all recorded statistics of the given render window to a csv file.

Parameters:
  • index (integer) - The index of the render window (-1 for the focused window).
  • path (string) - path to the folder where the file should be stored, e.g. C:/vred.

   Trees       Indices       Help   
VRED Python API v1
Generated by Epydoc 3.0.1 on Fri Nov 29 09:33:22 2024 http://epydoc.sourceforge.net