vrdCameraBaseNode

class vrdCameraBaseNode

(Inherits vrdTransformNode)

This class serves as base class for vrdCameraNode and vrdViewpointNode.

It holds all properties that are shared between cameras and viewpoints. So even if the documentation here mostly talks about cameras, it applies to viewpoints, too. Technically a viewpoint is a camera and activating a viewpoint initiates a copy of its properties to the active camera.

Instances of this class can not be directly created by the user nor is there any factory that hands out vrdCameraBaseNodes.

Summary

Functions:

Functions

vrdCameraBaseNode.adjustAtPosition(root=vrdNode())

Adjust the look at point onto the surface of the closest object in the direction of viewing.

Parameters:root (vrdNode) – The root node that may contain the object.
vrdCameraBaseNode.calculateClippingPlanes()

Update near and far clipping plane from scene contents.

vrdCameraBaseNode.getApplyColorCorrectionToBackground()

Returns if color correction should be applied to background.

Returns:True if color correction is applied to the background, False otherwise.
Return type:bool
vrdCameraBaseNode.getApplyColorCorrectionToForeground()

Returns if color correction should be applied to foreground.

Returns:True if color correction is applied to the foreground, False otherwise.
Return type:bool
vrdCameraBaseNode.getAutofocus()

Returns the current autofocus state of the camera.

Returns:True if autofocus is enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.getAutofocusTransitionTime()

Returns the time in frames the autofocus should use to adjust the focus distance.

Returns:Time in frames the autofocus should use to adjust the focus distance.
Return type:integer
vrdCameraBaseNode.getBlendAmount()

Returns the amount of blending used.

Returns:The blending value (between 0.0 and 1.0).
Return type:float
vrdCameraBaseNode.getBlendMapLeftEye()

Returns the blending map for the left eye of the camera.

Returns:The blend map for the left eye.
Return type:vrdImage
vrdCameraBaseNode.getBlendMapRightEye()

Returns the blending map for the right eye of the camera.

Returns:The blend map for the right eye.
Return type:vrdImage
vrdCameraBaseNode.getBlendMode()

Returns the current blending mode.

Returns:The current blending mode.
Return type:vrCameraTypes.BlendMode
vrdCameraBaseNode.getColorCorrectionBrightness()

Returns the color correction brightness.

Returns:The color correction brightness (must be >0)..
Return type:float
vrdCameraBaseNode.getColorCorrectionContrast()

Returns the color correction contrast.

Returns:The color correction contrast (must be >0).
Return type:float
vrdCameraBaseNode.getColorCorrectionHueOffset()

Returns the color correction hue offset.

Returns:The color correction hue offset (must be >=0).
Return type:float
vrdCameraBaseNode.getColorCorrectionSaturation()

Returns the color correction saturation.

Returns:The color correction saturation (must be >=0)..
Return type:float
vrdCameraBaseNode.getCustomFrustumEnabled()

Returns the state of the custom frustum.

Returns:True if the custom frustum is enabled, False if it’s disabled.
Return type:bool
vrdCameraBaseNode.getCustomProjectionMatrix()

Returns the custom 4x4 projection matrix.

Returns:The custom projection matrix.
Return type:QMatrix4x4
vrdCameraBaseNode.getDepthOfField()

Returns the current depth of field state of the camera. For a more detailed definition please see vrdCameraBaseNode.getDepthOfFieldMode().

Returns:True if depth of field is enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.getDepthOfFieldMode()

Returns the current depth of field mode of the camera.

Returns:Current depth of field mode
Return type:vrCameraTypes.DepthOfFieldMode
vrdCameraBaseNode.getDistanceFog()

Returns the current activation state of distance-fog.

Returns:True if distance-fog is enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.getDistanceFogColor()

Get the color of distance-fog.

Returns:The RGB color of the distance-fog.
Return type:QColor
vrdCameraBaseNode.getDistanceFogDensity()

Returns the density of distance-fog.

Returns:The fog density.
Return type:float
vrdCameraBaseNode.getDistanceFogEnableNoiseSizeUniform()

Returns the uniform noise size flag for distance-fog.

Returns:If True, uniform noise is activated.
Return type:bool
vrdCameraBaseNode.getDistanceFogFalloff()

Returns the falloff type of distance-fog.

Returns:The distance-fog falloff type (Realistic or Linear).
Return type:vrCameraTypes.FogFalloffMode
vrdCameraBaseNode.getDistanceFogNoise()

Returns the noise intensity of distance-fog.

Returns:The distance fog noise intensity.
Return type:float
vrdCameraBaseNode.getDistanceFogNoiseOffset()

Returns the noise offset of distance-fog.

Returns:The distance-fog noise offset along x,y,z axis.
Return type:QVector3D
vrdCameraBaseNode.getDistanceFogNoiseSize()

Returns the noise size of distance-fog.

Returns:The distance-fog noise size along x,y,z axis.
Return type:QVector3D
vrdCameraBaseNode.getDistanceFogRange()

Get the near value of distance-fog.

Returns:Distance from camera where the fog begins.
Return type:float
vrdCameraBaseNode.getDistortion()

Returns if distortion is enabled.

Returns:True if distortion is enabled, False if disabled.
Return type:bool
vrdCameraBaseNode.getDistortionMapLeftEye()

Returns the distortion map for the left eye of the camera.

Returns:The distortion map for the left eye.
Return type:vrdImage
vrdCameraBaseNode.getDistortionMapRightEye()

Returns the distortion map for the left right of the camera.

Returns:The distortion map for the right eye.
Return type:vrdImage
vrdCameraBaseNode.getFarClippingDistance()

Returns the distance of the far clipping plane.

Returns:The distance of the far clipping plane.
Return type:float
vrdCameraBaseNode.getFocalLength()

Returns the focal length.

Returns:The focal length.
Return type:float
vrdCameraBaseNode.getFocusDistance()

Returns the focus distance.

Returns:The focus distance.
Return type:float
vrdCameraBaseNode.getFov()

Gets the field of view.

Returns:The field of view value in degree.
Return type:float
vrdCameraBaseNode.getFovMode()

Returns the field of view mode.

Returns:The field of view mode (horizontal / vertical).
Return type:vrCameraTypes.FovMode
vrdCameraBaseNode.getFromAtUp()

Gets the from at and up vectors in local space.

Returns:The from at up vectors in local space.
Return type:vrCameraFromAtUp
vrdCameraBaseNode.getFromAtUpWorld()

Returns from, at and up vectors in world space.

Returns:The from, at and up vectors in world space.
Return type:vrCameraFromAtUp
vrdCameraBaseNode.getFrustum()

Returns the custom frustum.

Returns:The frustum as a vector. The order is left, right, top, bottom.
Return type:QVector4D
vrdCameraBaseNode.getFrustumBottom()

Returns the size bottom side of the frustum.

Returns:The size of the bottom side of the frustum.
Return type:float
vrdCameraBaseNode.getFrustumLeft()

Returns the size left side of the frustum.

Returns:The size of the left side of the frustum.
Return type:float
vrdCameraBaseNode.getFrustumRight()

Returns the size right side of the frustum.

Returns:The size of the right side of the frustum.
Return type:float
vrdCameraBaseNode.getFrustumTop()

Returns the size top side of the frustum.

Returns:The size of the top side of the frustum.
Return type:float
vrdCameraBaseNode.getFStop()

Returns the FStop of the camera,.

Returns:The FStop in f/N where N is the value returned by this function.
Return type:float
vrdCameraBaseNode.getGlare()

Returns the current glare state of the camera.

Returns:The current state of the glare flag.
Return type:bool
vrdCameraBaseNode.getGlareIntensity()

Returns the glare intensity.

Returns:The glare intensity (must be >=0).
Return type:float
vrdCameraBaseNode.getGlareRotation()

Returns the glare rotation.

Returns:The glare rotation in degrees (0 to 360).
Return type:float
vrdCameraBaseNode.getGlareSize()

Returns the glare size.

Returns:The glare size (must be >0).
Return type:float
vrdCameraBaseNode.getGlareStreaks()

Returns the number of glare streaks.

Returns:The number of glare streaks used.
Return type:integer
vrdCameraBaseNode.getGlareThreshold()

Returns the glare threshold.

Returns:The glare threshold.
Return type:float
vrdCameraBaseNode.getGlow()

Returns the current glow state of the camera.

Returns:True if glow is enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.getGlowFalloff()

Returns the glow falloff.

Returns:The glow falloff (must be between 0 and 2).
Return type:float
vrdCameraBaseNode.getGlowIntensity()

Returns the glow intensity.

Returns:The glow intensity (must be >0).
Return type:float
vrdCameraBaseNode.getGlowSize()

Returns the glow size.

Returns:The glow size (must be >0).
Return type:float
vrdCameraBaseNode.getGlowThreshold()

Returns the glow threshold.

Returns:The glow threshold (must be >0).
Return type:float
vrdCameraBaseNode.getGradingEnabled()
Returns:True if color grading is enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.getGradingLut()

Returns the grading lut.

Returns:The grading lut.
Return type:vrdGradingLut
vrdCameraBaseNode.getGradingPresetFilename()

Returns the grading preset file name.

Returns:Name of the grading preset file
Return type:string
vrdCameraBaseNode.getGradingPresetFolder()

Returns the folder to search for grading presets.

Returns:Name of the grading preset search folder
Return type:string
vrdCameraBaseNode.getGradingPrimary()

Returns the primary grading controls.

Returns:The primary grading object.
Return type:vrdGradingPrimary
vrdCameraBaseNode.getGradingRGBCurve()

Returns the rgb grading curve.

Returns:The rgb grading curve.
Return type:vrdGradingRGBMCurve
vrdCameraBaseNode.getGradingTone()

Returns the tone grading controls.

Returns:The tone grading object.
Return type:vrdGradingTone
vrdCameraBaseNode.getHeightFog()

Returns the current activation value of height-fog.

Returns:True if height-fog is enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.getHeightFogBlend()

Returns the blend value of height-fog.

Returns:Returns the blend value of height-fog (between 0 and 1).
Return type:float
vrdCameraBaseNode.getHeightFogColor()

Get the color of height-fog.

Returns:The RGB color of the height-fog.
Return type:QColor
vrdCameraBaseNode.getHeightFogDensity()

Returns the density of height-fog.

Returns:The density of height-fog.
Return type:float
vrdCameraBaseNode.getHeightFogEnableNoiseSizeUniform()

Returns the uniform noise size flag for height-fog.

Returns:If True, uniform noise is activated.
Return type:bool
vrdCameraBaseNode.getHeightFogFalloff()

Returns the falloff type of height-fog.

Returns:The falloff type (Realistic or Linear).
Return type:vrCameraTypes.FogFalloffMode
vrdCameraBaseNode.getHeightFogNoise()

Returns the noise intensity of height-fog.

Returns:The height fog noise intensity.
Return type:float
vrdCameraBaseNode.getHeightFogNoiseOffset()

Returns the noise offset of height-fog.

Returns:The height-fog noise offset along x,y,z axis.
Return type:QVector3D
vrdCameraBaseNode.getHeightFogNoiseSize()

Returns the noise size of height-fog.

Returns:The height-fog noise size along x,y,z axis.
Return type:QVector3D
vrdCameraBaseNode.getHeightFogRange()

Returns the range of height-fog.

Returns:A vector with min, max values (see vrdCameraBaseNode.getHeightFogDensity()).
Return type:QVector2D
vrdCameraBaseNode.getInteractiveDofQuality()

Returns the quality of the interactive depth of field effect.

Returns:Value of the interactive dof quality from ultra-low to ultra-high.
Return type:vrCameraTypes.InteractiveDofQuality
vrdCameraBaseNode.getLensFlare()

Queries if lens flares are visible for this camera.

Returns:True if visible, False otherwise.
Return type:bool
vrdCameraBaseNode.getMotionBlur()

Returns the current motion blur state of the camera.

Returns:True if motion blur is enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.getNearClippingDistance()

Returns the distance of the near clipping plane.

Returns:The distance of the near clipping plane.
Return type:float
vrdCameraBaseNode.getOrthographicSize()

Returns the orthographic size.

Returns:The orthographic size.
Return type:float
vrdCameraBaseNode.getPerspectiveMatch()

Gets the camera perspective match object.

Returns:The perspective match object.
Return type:vrdPerspectiveMatch
vrdCameraBaseNode.getPrincipalPointOffset()

Returns the principal point offset.

Returns:The principal point offset.
Return type:QVector2D
vrdCameraBaseNode.getProjectionMode()

Returns the projection mode used for the camera.

Returns:The projection mode.
Return type:vrCameraTypes.CameraProjectionMode
vrdCameraBaseNode.getRoll()

Returns the camera roll.

Returns:The camera roll in degrees.
Return type:float
vrdCameraBaseNode.getSensorSize()

Returns the sensor size.

Returns:The sensor size as width, height in mm.
Return type:QVector2D
vrdCameraBaseNode.getShutterSpeed()

Returns the shutter speed.

Returns:The shutter speed value in fractions of a second. The returned value is 1/value of a second.
Return type:float
vrdCameraBaseNode.getSkew()

Returns the skew factor of the camera.

Returns:The skew factor.
Return type:float
vrdCameraBaseNode.getStereoEyeSeparation()

Returns the stereo eye separation used during omnidirectional stereo rendering.

Returns:The eye separation value.
Return type:float
vrdCameraBaseNode.getStereoLayout()

Returns the stereo layout.

Returns:The stero layout (top/bottom, left/right, left eye, right eye).
Return type:vrCameraTypes.CameraStereoLayout
vrdCameraBaseNode.getStereoPolarMergeAngle()

Returns the polar merge angle used during omnidirectional stereo rendering.

Returns:The polar merge angle.
Return type:float
vrdCameraBaseNode.getTonemapper()

Returns the tone mapper.

The tone mapper gives access to the tone mapper functionality of the camera.

Returns:The tone mapper.
Return type:vrdTonemapper
vrdCameraBaseNode.getUseHightAsVRGround()

Check, if camera height is used as gound in VR.

Returns:True, if height is used as VR ground height.
Return type:bool
vrdCameraBaseNode.getViewpointTransition()

Returns if viewpoint transitions are enabled.

Returns:True if transitions are enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.getViewpointTransitionDuration()

Returns the duration of viewpoint transitions.

Returns:The viewpoint transition duration in seconds.
Return type:float
vrdCameraBaseNode.getVignetteFeather()

Returns the vignette feather.

Returns:The vignette feather (between 0.0 and 1.0).
Return type:float
vrdCameraBaseNode.getVignetteRadius()

Returns the vignette radius.

Returns:The vignette radius (between 0.0 and 1.0).
Return type:float
vrdCameraBaseNode.getVignetteRoundness()

Returns the vignette roundness.

Returns:The vignette roundness (between -1.0 and 1.0).
Return type:float
vrdCameraBaseNode.getWireframeRendering()

Returns the state of wireframe rendering.

Returns:True if wireframe rendering is enabled, False otherwise.
Return type:bool
vrdCameraBaseNode.isEditable()

Returns if the node is in a locked state or can be edited.

Returns:True if editable, False otherwise.
Return type:bool
vrdCameraBaseNode.isEqual(camera)

Determines if two camera nodes are internally using the same camera.

A camera exists in two node graphs at the same time. Once in the regular scene graph and once in the graph visible in the camera editor. You can get both nodes with vrCameraService.getCamera(name, useCameraGraph). The OSG camera is internally shared between both nodes. Usually cameras which have the same name in both graphs are identical.

This example shows that both nodes are different since they have different object ids, but are internally using the same camera.

root: cam1 = vrCameraService.getCamera("Perspective", useCameraGraph=True)
root: cam2 = vrCameraService.getCamera("Perspective", useCameraGraph=False)
root: print cam1.getObjectId()
596
root: print cam2.getObjectId()
597
root: print cam1.isEqual(cam2)
True
Parameters:camera (vrdCameraBaseNode) – The camera to compare to.
Returns:True if both internal cameras are equal, False otherwise. It will also return True if both cameras are null.
Return type:bool
vrdCameraBaseNode.isGradingPresetModified()

Returns whether the grading presets was modified or not.

Returns:True if the grading preset was modified, False otherwise.
Return type:bool
vrdCameraBaseNode.isOrthographic()

Returns if the camera is using orthographic projection.

Returns:True if the camera uses orthographic projection, False if perspective projection is used.
Return type:bool
vrdCameraBaseNode.loadBlendMap(fileName, eye)

Loads an image from a file and sets it as blending map for either the left or the right eye.

Parameters:
  • fileName (string) – The file name of the image to load.
  • eye (vrCameraTypes.CameraEye) – Specifies which eye to use (CameraLeftEye or CameraRightEye).
Returns:

True if loading succeeded, False otherwise.
Return type:

bool
vrdCameraBaseNode.loadDistortionMap(fileName, eye)

Loads an image from a file and sets it as distortion map for either the left or the right eye.

Parameters:
  • fileName (string) – The file name of the image to load.
  • eye (vrCameraTypes.CameraEye) – Specifies which eye to use (CameraLeftEye or CameraRightEye).
Returns:

True if loading succeeded, False otherwise.
Return type:

bool
vrdCameraBaseNode.loadGradingPreset(fileName)

Loads a grading preset from a file.

Parameters:fileName (string) – The file name containing a saved grading preset.
Returns:True if loading was successful, False otherwise.
Return type:bool
vrdCameraBaseNode.mirrorView(axis)

Mirrors the camera view along one of the major axis.

Parameters:axis (vrCameraTypes.CameraAxis) – The axis on which the view will be mirrored.
vrdCameraBaseNode.resetView()

Zeros all values in the camera viewing matrix.

vrdCameraBaseNode.saveGradingPreset(fileName)

Saves a grading preset to a file.

Parameters:fileName (string) – The file name to use.
Returns:True if saving was successful, False otherwise.
Return type:bool
vrdCameraBaseNode.setApplyColorCorrectionToBackground(enabled)

Enable / disable the color correction for the background.

Parameters:enabled (bool) – True to enable color correction, False to disable.
vrdCameraBaseNode.setApplyColorCorrectionToForeground(enabled)

Enable / disable the color correction for the foreground.

Parameters:enabled (bool) – True to enable color correction, False to disable.
vrdCameraBaseNode.setAutofocus(enabled)

Enables / disables autofocus on screen center.

Parameters:enabled (bool) – True to enable, False to disable autofocus.
vrdCameraBaseNode.setAutofocusTransitionTime(value)

Sets the time in frames the autofocus should use to adjust the focus distance.

Parameters:value (integer) – Time in frames the autofocus should use to adjust the focus distance.
vrdCameraBaseNode.setBlendAmount(value)

Sets the amount of blending to use.

This affects both image and vignette blending.

Parameters:value (float) – The blending value (between 0.0 and 1.0).
vrdCameraBaseNode.setBlendMapLeftEye(image)

Sets the blending map for the left eye of the camera.

Parameters:image (vrdImage) – The image to use as blending map.
vrdCameraBaseNode.setBlendMapRightEye(image)

Sets the blending map for the right eye of the camera.

Parameters:image (vrdImage) – The image to use as blending map.
vrdCameraBaseNode.setBlendMode(mode)

Sets and enables / disables the blending mode.

Parameters:mode (vrCameraTypes.BlendMode) – The blending mode to use. Use BlendOff to disable blending.
vrdCameraBaseNode.setColorCorrectionBrightness(value)

Sets the color correction brightness.

Parameters:value (float) – The color correction brightness (must be >0).
vrdCameraBaseNode.setColorCorrectionContrast(value)

Sets the color correction contrast.

Parameters:value (float) – The color correction contrast (must be >0).
vrdCameraBaseNode.setColorCorrectionHueOffset(value)

Sets the color correction hue offset.

Parameters:value (float) – The hue offset (must be >=0),
vrdCameraBaseNode.setColorCorrectionSaturation(value)

Sets the color correction saturation.

Parameters:value (float) – The saturation (must be >=0).
vrdCameraBaseNode.setCustomFrustumEnabled(enabled)

Enable / disable the use of a custom frustum.

Parameters:enabled (bool) – True if the custom frustum is enabled, False if it’s disabled.
vrdCameraBaseNode.setCustomProjectionMatrix(matrix)

Sets a custom 4x4 projection matrix.

To use the matrix you need to also set the projection mode accordingly with vrdCameraBaseNode.setProjectionMode(mode).

camera = vrCameraService.getActiveCamera()
camera.setProjectionMode(vrCameraTypes.ProjectionCustomMatrix)
Parameters:matrix (QMatrix4x4) – The custom matrix.
vrdCameraBaseNode.setDepthOfField(enabled)

Enables / disables depth of field for the camera. For a more detailed definition please see vrdCameraBaseNode.setDepthOfFieldMode(mode).

Parameters:enabled (bool) – True to enable, False to disable depth of field.
vrdCameraBaseNode.setDepthOfFieldMode(mode)

Sets the depth of field mode for the camera.

Parameters:mode (vrCameraTypes.DepthOfFieldMode) – Defines depth of field mode
vrdCameraBaseNode.setDistanceFog(enable)

Enables / disables distance-fog.

Parameters:enable (bool) – True to enable, False to disable.
vrdCameraBaseNode.setDistanceFogColor(color)

Sets the color of the distance-fog.

Parameters:color (QColor) – The RGB color of the distance-fog.
vrdCameraBaseNode.setDistanceFogDensity(density)

Set the density of distance-fog.

Parameters:density (float) – The fog density (value >= 0).
vrdCameraBaseNode.setDistanceFogEnableNoiseSizeUniform(enable)

Enables / disables uniform noise size for distance-fog.

Parameters:enable (bool) – If True, uniform noise is activated.
vrdCameraBaseNode.setDistanceFogFalloff(value)

Sets the falloff type of distance-fog.

Parameters:value (vrCameraTypes.FogFalloffMode) – The falloff type (Realistic or Linear).
vrdCameraBaseNode.setDistanceFogNoise(intensity)

Set the intensity of noise for distance-fog.

Parameters:intensity (float) – Multiplier of noise (value from 0 to 10).
vrdCameraBaseNode.setDistanceFogNoiseOffset(offset)

Set the offset of noise for distance-fog.

Parameters:offset (QVector3D) – The noise offset along x,y,z axis.
vrdCameraBaseNode.setDistanceFogNoiseSize(size)

Set the size of noise for distance-fog.

Parameters:size (QVector3D) – The noise size along x,y,z axis. Every value must be >= 0.01.
vrdCameraBaseNode.setDistanceFogRange(nearDistance)

Sets where distance-fog begins.

Parameters:nearDistance (float) – Distance from camera where the fog begins.
vrdCameraBaseNode.setDistortion(enabled)

Enable / disable distortion.

Parameters:enabled (bool) – True to enable distortion, False to disable.
vrdCameraBaseNode.setDistortionMapLeftEye(image)

Sets the distortion map for the left eye of the camera.

Parameters:image (vrdImage) – The image to use as distortion map.
vrdCameraBaseNode.setDistortionMapRightEye(image)
Parameters:image (vrdImage) –
vrdCameraBaseNode.setFarClippingDistance(value)

Sets the distance of the far clipping plane.

Parameters:value (float) – The distance of the far clipping plane.
vrdCameraBaseNode.setFocalLength(value)

Sets the focal length.

Parameters:value (float) – The focal length.
vrdCameraBaseNode.setFocusDistance(distance)

Sets the focus distance.

Parameters:distance (float) – The focus distance
vrdCameraBaseNode.setFov(value)

Sets the field of view.

Parameters:value (float) – The field of view value in degree.
vrdCameraBaseNode.setFovMode(mode)

Sets the field of view mode.

Parameters:mode (vrCameraTypes.FovMode) – The field of view mode (horizontal / vertical).
vrdCameraBaseNode.setFromAtUp(fromAtUp)

Sets the from, at and up vectors in local space.

The from at and up vector are encapsulated in a single object. The individual vectors can be extracted from this vrCameraFromAtUp instance.

Parameters:fromAtUp (vrCameraFromAtUp) – The from, at and up vectors in local space.
vrdCameraBaseNode.setFromAtUpWorld(fromAtUp)

Sets the from, at and up vectors in world space.

The from at and up vector are encapsulated in a single object. The individual vectors can be extracted from this vrCameraFromAtUp instance.

Parameters:fromAtUp (vrCameraFromAtUp) – The from, at and up vectors in world space.
vrdCameraBaseNode.setFrustum(frustum)

Sets the custom frustum.

Parameters:frustum (QVector4D) – The frustum as a vector. The order is left, right, top, bottom
vrdCameraBaseNode.setFrustumBottom(value)

Sets the size of the bottom side of the frustum.

Parameters:value (float) – The size of the bottom side of the frustum.
vrdCameraBaseNode.setFrustumLeft(value)

Sets the size of the left side of the frustum.

Parameters:value (float) – The size of the left side of the frustum.
vrdCameraBaseNode.setFrustumRight(value)

Sets the size of the right side of the frustum.

Parameters:value (float) – The size of the right side of the frustum.
vrdCameraBaseNode.setFrustumTop(value)

Sets the size of the top side of the frustum.

Parameters:value (float) – The size of the top side of the frustum.
vrdCameraBaseNode.setFStop(value)

Sets the FStop of the camera.

Please note that the FStop value only takes effect if Depth of Field is activated for the camera.

Parameters:value (float) – The FStop in f/N where N is the value passed to this function.
vrdCameraBaseNode.setGlare(enabled)

Enables / disables glare for the camera.

Parameters:enabled (bool) – True to enable glare, False to disable.
vrdCameraBaseNode.setGlareIntensity(value)

Sets the glare intensity.

Parameters:value (float) – The glare intensity (must be >=0).
vrdCameraBaseNode.setGlareRotation(value)

Sets the glare rotation.

Parameters:value (float) – The glare rotation in degrees (0 to 360).
vrdCameraBaseNode.setGlareSize(value)

Sets the glare size.

Parameters:value (float) – The glare size (must >0).
vrdCameraBaseNode.setGlareStreaks(value)

Sets the number of glare streaks.

Parameters:value (integer) – The number of streaks to use.
vrdCameraBaseNode.setGlareThreshold(value)

Sets the glare threshold.

Parameters:value (float) – The glare threshold. Must be greater than 0.
vrdCameraBaseNode.setGlow(enabled)

Enables / disables glow for the camera.

Parameters:enabled (bool) – True to enable, False to disable
vrdCameraBaseNode.setGlowFalloff(value)

Sets the glow falloff.

Parameters:value (float) – The glow fallof (must be between 0 and 2).
vrdCameraBaseNode.setGlowIntensity(value)

Sets the glow intensity.

Parameters:value (float) – The glow intensity (must be >0).
vrdCameraBaseNode.setGlowSize(value)

Sets the glow size.

Parameters:value (float) – The glow size (must be >0).
vrdCameraBaseNode.setGlowThreshold(value)

Sets the glow threshold.

Parameters:value (float) – The glow threshold (must be >0),
vrdCameraBaseNode.setGradingEnabled(enabled)

Enables / disables color grading.

Parameters:enabled (bool) – True to enable, False to disable
vrdCameraBaseNode.setHeightFog(enable)

Enables / disables height-fog.

Parameters:enable (bool) – True to enable height-fog, False to disable.
vrdCameraBaseNode.setHeightFogBlend(blend)

Set the transition distance between fog and no fog.

Parameters:blend (float) – Smooths the transition between areas with fog and areas without fog (value from 0 to 1).
vrdCameraBaseNode.setHeightFogColor(color)

Sets the color of the height-fog.

Parameters:color (QColor) – The RGB color of the height-fog.
vrdCameraBaseNode.setHeightFogDensity(density)

Set the density of height-fog.

Parameters:density (float) – The fog density (value >= 0).
vrdCameraBaseNode.setHeightFogEnableNoiseSizeUniform(enable)

Enables / disables uniform noise size for height-fog.

Parameters:enable (bool) – If True, uniform noise is activated.
vrdCameraBaseNode.setHeightFogFalloff(value)

Set the falloff of height-fog.

Parameters:value (vrCameraTypes.FogFalloffMode) – The falloff type (Realistic or Linear).
vrdCameraBaseNode.setHeightFogNoise(intensity)

Set the intensity of noise for height-fog.

Parameters:intensity (float) – Multiplier of noise (value from 0 to 10).
vrdCameraBaseNode.setHeightFogNoiseOffset(offset)

Set the offset of noise for height-fog.

Parameters:offset (QVector3D) – The noise offset along x,y,z axis.
vrdCameraBaseNode.setHeightFogNoiseSize(size)

Set the size of noise for height-fog.

Parameters:size (QVector3D) – The noise size along x,y,z axis. Every value must be >= 0.01.
vrdCameraBaseNode.setHeightFogRange(range)

Sets where height-fog begins and where it ends.

Set minimum and maximum height for height-fog.
minimum: Height from ground where the fog begins.
maximum: Height from ground where the fog ends. Must be greater than minimum.
Parameters:range (QVector2D) – A vector with min, max values.
vrdCameraBaseNode.setInteractiveDofQuality(value)

Sets the quality of the interactive depth of field effect.

Parameters:value (vrCameraTypes.InteractiveDofQuality) – Value of the interactive dof quality from ultra-low to ultra-high.
vrdCameraBaseNode.setLensFlare(enabled)

Enables / disables the visibility of lens flares for this camera.

Parameters:enabled (bool) – True to enable, False to disable the lens flare visibility.
vrdCameraBaseNode.setMotionBlur(enabled)

Enables / disables motion blur for the camera.

Parameters:enabled (bool) – True to enable motion blur, False to disable it.
vrdCameraBaseNode.setNearClippingDistance(value)

Sets the distance of the near clipping plane.

Parameters:value (float) – The distance of the near clipping plane.
vrdCameraBaseNode.setOrthographicSize(size)

Sets the orthographic size.

Parameters:size (float) – The orthographic size
vrdCameraBaseNode.setPrincipalPointOffset(offset)

Sets the principal point offset.

Parameters:offset (QVector2D) – The principal point offset.
vrdCameraBaseNode.setProjectionMode(mode)

Sets the projection mode for the camera.

Parameters:mode (vrCameraTypes.CameraProjectionMode) – The projection mode.
vrdCameraBaseNode.setRoll(value)

Sets the camera roll.

Parameters:value (float) – The camera roll in degrees.
vrdCameraBaseNode.setSensorSize(size)

Sets the sensor size.

The sensor size is measured as width * height mm.

Parameters:size (QVector2D) – The sensor size as width, height
vrdCameraBaseNode.setShutterSpeed(value)

Sets the shutter speed used for motion blur.

The shutter speed is measured in fractions of a second. To set it to 1/250th of a second, the value to pass to this function would be 250. The shutter speed is only considered when motion blur is activated.

Parameters:value (float) – The shutter speed value. 1/value of a second.
vrdCameraBaseNode.setSkew(value)

Sets the skew factor of the camera.

Parameters:value (float) – The skew factor.
vrdCameraBaseNode.setStereoEyeSeparation(value)

Sets eye separation used during omnidirectional stereo rendering.

Parameters:value (float) – The eye separation value.
vrdCameraBaseNode.setStereoLayout(layout)

Sets the image layout during omnidirectional stereo rendering.

Top Bottom will place the images for the left and right eye on top of each other while Left Right will place them next to each other. The render output resolution should be set to a matching width/height ratio, 1:1 for Top Bottom layout and 4:1 for Left Right Layout.

Parameters:layout (vrCameraTypes.CameraStereoLayout) – The stero layout (top/bottom, left/right, left eye, right eye).
vrdCameraBaseNode.setStereoPolarMergeAngle(value)

Sets the polar merge angle used during omnidirectional stereo rendering.

Starting from this angle to the poles the eye separation will be reduced to avoid stereo parallax artifacts during viewing.

Parameters:value (float) – The polar merge angle.
vrdCameraBaseNode.setToCurrentView()

Applies the current viewport transformation to the camera.

vrdCameraBaseNode.setUseHightAsVRGround(value)

Changes the camera behavior in VR.

Parameters:value (bool) – If true, the camera height is the ground height in VR.
vrdCameraBaseNode.setViewpointTransition(enabled)

Enables / disables a transition animation between viewpoints.

Parameters:enabled (bool) – True if transitions should be enabled, False otherwise.
vrdCameraBaseNode.setViewpointTransitionDuration(seconds)

Sets the duration of viewpoint transitions.

Parameters:seconds (float) – The duration of viewpoint transitions in seconds.
vrdCameraBaseNode.setVignetteFeather(value)

Sets the vignette feather.

Parameters:value (float) – The vignette feather (between 0.0 and 1.0).
vrdCameraBaseNode.setVignetteRadius(value)

Sets the radius of the vignette used for blending.

Parameters:value (float) – The vignette blend radius (between 0.0 and 1.0).
vrdCameraBaseNode.setVignetteRoundness(value)

Sets the vignette roundness.

Parameters:value (float) – The vignette roundness (between -1.0 and 1.0).
vrdCameraBaseNode.setWireframeRendering(enabled)

Enables / disables wireframe rendering.

Parameters:enabled (bool) – True to enable wireframe rendering, False to disable.