Module vrCamera

Deprecated. Use vrCameraService.getActiveCamera().getCameraCollider().addNode(name) instead.

Add node to collide against for the active camera.

Parameters:

• name (string) - The name of the node.

Deprecated. Use vrCameraService.createViewpoint(name) instead.

Adds the current view as a viewpoint with the name provided.

Parameters:

• name (string) - The name of the viewpoint to add.
• unique (bool) - If true, a unique name is generated. (Optional).

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

Parameters:

• name (string) - The name of the viewpoint.
• rootname (string) - The name of the root node that may contain the object (Optional).

Deprecated. Use vrCameraService.getActiveCamera().getCameraCollider().buildCollisionStructure() instead.

Build data structure for collision detection for the active camera.

Deprecated. Use vrCameraService.getActiveCamera().getCameraCollider().setEnabled(activate) instead.

Enables/disables the collision detection for the active camera.

Parameters:

• activate (bool) - If true, the collision is enabled.

Deprecated. Use vrCameraService.getActiveCamera().getCameraCollider().setSlide(activate) instead.

Enables/disables the sliding for collision detection for the active camera.

Parameters:

• activate (bool) - If true, the sliding for the collision is enabled.

Deprecated. Use vrCameraService.getActiveCamera() instead.

Returns the active camera vrNodePtr of the active render window.

Returns: vrNodePtr

Camera node.

Returns camera Vive mode state.

Returns: bool

0 = off, 1 = on

Deprecated. Use vrCameraService.getAllCameraTracks() and track.getChildren() instead.

Gets all camera track names and the names of the contained viewpoints for the given camera.

Parameters:

• name (string) - Camera name.

Returns: dict

Camera tracks for passed camera name.

Deprecated. Use vrCameraService.getActiveCamera().getDepthOfField() instead.

Returns the current depth of field state of the current camera.

Returns: bool

current state of depth of field flag.

Deprecated. Use vrCameraService.getActiveCamera().getDollyZoom() instead.

Returns the current dolly zoom state of the current camera.

Returns: bool

current state of dolly zoom flag.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogBlend() instead.

Returns the blend value of height-fog.

Returns: float

Returns the blend value of height-fog.

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFogColor() instead.

Get the color of distance-fog.

Returns: Vec3f

A vector with r, g, b components.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogColor() instead.

Get the color of height-fog.

Returns: Vec3f

A vector with r, g, b components.

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFogDensity() instead.

Returns the density of distance-fog.

Returns: float

Returns the density of distance-fog.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogDensity() instead.

Returns the density of height-fog.

Returns: float

Returns the density of height-fog.

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFog() instead.

Returns the current activation value of distance-fog.

Returns: bool

Returns the current activation value of distance-fog.

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFogEnableNoiseSizeUniform() instead.

Returns the uniform noise size flag for distance-fog.

Returns: bool

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogEnableNoiseSizeUniform() instead.

Returns the uniform noise size flag for height-fog.

Returns: bool

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFogFalloff() instead.

Returns the falloff type of distance-fog.

Returns: unsigned int

Returns the current falloff type of distance-fog.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogFalloff() instead.

Returns the falloff type of height-fog.

Returns: unsigned int

Returns the current falloff type of height-fog.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFog() instead.

Returns the current activation value of height-fog.

Returns: bool

Returns the current activation value of height-fog.

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFogNoise() instead.

Returns the noise intensity of distance-fog.

Returns: float

Returns the noise intensity of distance-fog.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogNoise() instead.

Returns the noise intensity of height-fog.

Returns: float

Returns the noise intensity of height-fog.

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFogNoiseOffset() instead.

Returns the noise offset of distance-fog.

Returns: Vec3f

Returns the noise offset of distance-fog.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogNoiseOffset() instead.

Returns the noise offset of distance-fog.

Returns: Vec3f

Returns the noise offset of distance-fog.

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFogNoiseSize() instead.

Returns the noise size of distance-fog.

Returns: Vec3f

Returns the noise size of distance-fog.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogNoiseSize() instead.

Returns the noise size of height-fog.

Returns: Vec3f

Returns the noise size of height-fog.

Deprecated. Use vrCameraService.getActiveCamera().getDistanceFogRange() instead.

Get the near value of distance-fog.

Returns: float

Distance from camera where the fog begins.

Deprecated. Use vrCameraService.getActiveCamera().getHeightFogRange() instead.

Get the range of height-fog.

Returns: Vec2f

A vector with min, max values.

Deprecated. Use vrCameraService.getActiveCamera().getGlare() instead.

Returns the current glare state of the current camera.

Returns: bool

current state of glare flag.

Deprecated. Use vrCameraService.getActiveCamera().getGlow() instead.

Returns the current glow state of the current camera.

Returns: bool

current state of glow flag.

Deprecated. Use vrCameraService.getActiveCamera().getLensFlare() instead.

Returns the current lens flare state of the current camera.

Returns: bool

current state of lens flare flag.

Deprecated. Use vrCameraService.getActiveCamera().getMotionBlur() instead.

Returns the current motion blur state of the current camera.

Returns: bool

current state of motion blur flag.

Deprecated. Use vrCameraService.getViewpointCreationMode() instead.

Returns viewpoint creation mode. See setViewpointCreationMode.

Returns: unsigned int

0 (IgnoreTrackingMatrix), 1 (IncludeTrackingMatrix).

Deprecated. Use vrCameraService.getViewpoint(name) instead.

Returns the viewpoint vrNodePtr with passed name.

Parameters:

• name (string) - The name of the viewpoint.

Returns: vrNodePtr

Viewpoint node.

Deprecated. Use vrCameraService.getAllViewpoints() and vrdViewpointNode.getPreview() instead.

Get a preview image for the viewpoint (if it has one).

Convert returned data to Base64: base64.b64encode(getViewpointPreview("View"))

Parameters:

• name (string) - The name of the viewpoint.

Returns: string

bytes of a png image.

Deprecated. Use vrCameraService.getAllViewpoints() and vrdViewpointNode.getName() instead.

Returns a list of all viewpoints.

Returns: list of strings

Viewpoint names.

Deprecated. Use vrCameraService.getViewpoint(name).activate(True) instead.

Jumps to the Viewpoint via name. The difference to selectViewPoint is that this function immediately jumps to the viewpoint (no interpolation).

Parameters:

• name (string) - The name of the viewpoint.

Deprecated. Use vrCameraService.load(filename) instead.

Loads a viewpoint xml-file from disk.

Parameters:

• filename (string) - The name of the XML-file.

Deprecated. Use vrCameraService.getAllCameraTracks(), find the track with the name, and track.setPlaying(True) instead.

Plays a track via name.

Parameters:

• name (string) - The name of the track.

Deprecated. Use vrNodeService.removeNodes([vrCameraService.getViewpoint(name)]) instead.

Removes the viewpoint with the given name.

Parameters:

• name (string) - The name of the viewpoint to remove.

Deprecated. Use vrCameraService.saveViewpoints(filename) instead.

Saves a viewpoint xml-file to disk.

Parameters:

• filename (string) - The name of the XML-file.

Deprecated. Use vrCameraService.getCamera(name).activate() instead.

Activates a camera via name.

Parameters:

• name (string) - The name of the camera.

Deprecated. Use vrCameraService.getViewpoint(name).activate() instead.

Activates a viewpoint via name.

Parameters:

• name (string) - The name of the viewpoint.

Enables/disables camera Vive mode.

Parameters:

• activate (bool) - 0 = off, 1 = on

Deprecated. Use vrCameraService.getActiveCamera().getCameraCollider().setCollisionStructureBuildMethod(method) instead.

Set collision building method for the active camera.

Parameters:

• method (int) - 0 = use triangles, 1 = use bounding boxes.

Deprecated. Use vrCameraService.getActiveCamera().getCameraCollider().setDistance(dist) instead.

Sets the closest allowed distance from the active camera to a colliding object.

Parameters:

• dist (float) - The distance.

Deprecated. Use vrCameraService.getActiveCamera().setDepthOfField(on) instead.

Enables/disables depth of field for the current camera.

Parameters:

• on (bool) - true/false

Deprecated. Use vrCameraService.getActiveCamera().setDollyZoom(on) instead.

Enables/disables dolly zoom for the current camera.

Parameters:

• on (bool) - true/false

Deprecated. Use vrCameraService.getActiveCamera().getTonemapper().setExposure(exposure) or vrCameraService.getCamera(name).getTonemapper().setExposure(exposure) instead.

Sets the exposure of the active camera. Alternatively, the name of a specific camera can be provided.

Parameters:

• exposure (float) - The exposure.
• name (string) - The name of the camera (Optional).

Deprecated. Use vrCameraService.getActiveCamera().setFStop(fStop) or vrCameraService.getCamera(name).setFStop(fStop) instead.

Sets the FStop of the active camera. Alternatively, the name of a specific camera can be provided.

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

Parameters:

• fStop (float) - The FStop in f/N where N is the value passed to this function.
• name (string) - The name of the camera (Optional).

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogBlend(blend) instead.

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).

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFogColor(color) instead.

Sets the color of the distance-fog.

Parameters:

• r (float) - Red component of the fog color, range [0; 1].
• g (float) - Green component of the fog color, range [0; 1].
• b (float) - Blue component of the fog color, range [0; 1].

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogColor(color) instead.

Sets the color of the height-fog.

Parameters:

• r (float) - Red component of the fog color, range [0; 1].
• g (float) - Green component of the fog color, range [0; 1].
• b (float) - Blue component of the fog color, range [0; 1]n

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFogDensity(density) instead.

Set the density of distance-fog.

Parameters:

• density (float) - The fog density (value >= 0).

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogDensity(density) instead.

Set the density of height-fog.

Parameters:

• density (float) - The fog density (value >= 0).

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFog(activate) instead.

Enables/disables distance-fog.

Parameters:

• activate (bool) - 0 = off, 1 = on

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFogEnableNoiseSizeUniform(uniform) instead.

Enables/disables uniform noise size for distance-fog.

Parameters:

• uniform (bool) - if true, uniform noise is activated

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogEnableNoiseSizeUniform(uniform) instead.

Enables/disables uniform noise size for height-fog.

Parameters:

• uniform (bool) - if true, uniform noise is activated

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFogFalloff(falloff) instead.

Set the falloff.

Parameters:

• falloff (unsigned int) - 0 = realistic, 1 = linear

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogFalloff(falloff) instead.

Set the falloff of height-fog.

Parameters:

• falloff (unsigned int) - 0 = realistic, 1 = linear

Deprecated. Use vrCameraService.getActiveCamera().setHeightFog(activate) instead.

Enables/disables height-fog.

Parameters:

• activate (bool) - 0 = off, 1 = on

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFogNoise(intensity) instead.

Set the intensity of noise for distance-fog.

Parameters:

• intensity (float) - Multiplier of noise (value from 0 to 10).

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogNoise(intensity) instead.

Set the intensity of noise for height-fog.

Parameters:

• intensity (float) - Multiplier of noise (value from 0 to 10).

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFogNoiseOffset(offset) instead.

Set the offset of noise for distance-fog.

Parameters:

• offsetX (float) - Noise offset along X.
• offsetY (float) - Noise offset along Y.
• offsetZ (float) - Noise offset along Z.

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogNoiseOffset(offset) instead.

Set the offset of noise for distance-fog.

Parameters:

• offsetX (float) - Noise offset along X.
• offsetY (float) - Noise offset along Y.
• offsetZ (float) - Noise offset along Z .

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFogNoiseSize(size) instead.

Set the size of noise for distance-fog.

Parameters:

• sizeX (float) - Noise size along X (value >= 0.01).
• sizeY (float) - Noise size along Y (value >= 0.01).
• sizeZ (float) - Noise size along Z (value >= 0.01).

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogNoiseSize(size) instead.

Set the size of noise for height-fog.

Parameters:

• sizeX (float) - Noise size along X (value >= 0.01).
• sizeY (float) - Noise size along Y (value >= 0.01).
• sizeZ (float) - Noise size along Z (value >= 0.01).

Deprecated. Use vrCameraService.getActiveCamera().setDistanceFogRange(near) instead.

Sets where distance-fog begins.

Parameters:

• near (float) - Distance from camera where the fog begins.

Deprecated. Use vrCameraService.getActiveCamera().setHeightFogRange(QVector2D(min, max) instead.

Sets where height-fog begins and where it ends.

Parameters:

• min (float) - Height from ground where the fog begins.
• max (float) - Height from ground where the fog ends. Must be greater than min.

Deprecated. Use vrCameraService.getActiveCamera().setGlare(on) instead.

Enables/disables glare for the current camera.

Parameters:

• on (bool) - true/false

Deprecated. Use vrCameraService.getActiveCamera().setGlow(on) instead.

Enables/disables glow for the current camera.

Parameters:

• on (bool) - true/false

Deprecated. Use vrCameraService.getActiveCamera().loadBlendMap(file, vrCameraTypes.CameraEye.CameraLeftEye) instead.

Sets and enables/disables the blending map for the left eye of the active camera.

Parameters:

• file (string) - BlendingMap file.
• activate (bool) - Enables/Disables left eye blending.

Deprecated. Use vrCameraService.getActiveCamera().setLensFlare(on) instead.

Enables/disables lens flares for the current camera.

Parameters:

• on (bool) - true/false

Deprecated. Use vrCameraService.getActiveCamera().setMotionBlur(on) instead.

Enables/disables motion blur for the current camera.

Parameters:

• on (bool) - true/false

Sets the current navigator mode (0: fly, 1: trackball, 2: axis, 3: none, 4: orientation).

Parameters:

• mode (unsigned int) - Navigator mode.

Deprecated. Use vrCameraService.getActiveCamera().loadBlendMap(file, vrCameraTypes.CameraEye.CameraRightEye) instead.

Sets and enables/disables the blending map for the right eye of the active camera.

Parameters:

• file (string) - BlendingMap file.
• activate (bool) - Enables/Disables right eye blending.

Deprecated. Use vrCameraService.getViewpoint(name).setToCurrentView() instead.

Recaptures a viewpoint via name.

Parameters:

• name (string) - The name of the viewpoint.

Deprecated. Use vrCameraService.setViewpointCreationMode(mode) instead.

Sets how a new viewpoint is created when using head-tracking (e.g. with a HMD in VR). Available modes are: 0 (IgnoreTrackingMatrix), 1 (IncludeTrackingMatrix).

With IncludeTrackingMatrix (default) the head-tracked view is stored in the viewpoint.

With IgnoreTrackingMatrix, the current camera transformation without tracking is stored in the viewpoint.

Affects viewpoints created in the GUI and with Python API, including viewpoints created by capturing a variant set.

Parameters:

• mode (unsigned int) - 0 (IgnoreTrackingMatrix), 1 (IncludeTrackingMatrix).

Deprecated. Use vrCameraService.getActiveCamera().getTonemapper().setWhitePoint(whitepoint) or vrCameraService.getCamera(name).getTonemapper().setWhitePoint(whitepoint) instead.

Sets the whitepoint of the active camera. Alternatively, the name of a specific camera can be provided.

Parameters:

• whitepoint (float) - The whitepoint.
• name (string) - The name of the camera (Optional).

Deprecated. Use vrCameraService.getViewpoint(name).activate(False, True) instead.

Animates to a viewpoint via name. The function waits until animation is finished.

Parameters:

• name (string) - The name of the viewpoint.