vrdViewpointNode

class vrdViewpointNode

(Inherits vrdCameraBaseNode)

This class represents a viewpoint in VRED.

A viewpoint is essentially a camera. Therefore it is derived from vrdCameraBaseNode. When a viewpoint is activated, its values are copied into the currently active camera. For that reason it is not possible to query which is the ‘active’ viewpoint.

Functions

vrdViewpointNode.activate(disableTransition=False, blockForAnimation=False)

Activates the viewpoint.

Activating the viewpoint copies its values into the active camera.

Parameters:
  • disableTransition (bool) – True to disable transition animations. The default is False to have transitions enabled.
  • blockForAnimation (bool) – When setting this to True, this function will block until the transition animation is finished. The default (False) is to return immediately. If disableTransition is set to True, this parameter has no effect.
vrdViewpointNode.createPreview(force=False)

Create a preview for the viewpoint.

Parameters:force (bool) – Force creating a new preview in case there is already an existing one.
vrdViewpointNode.getOverrideTrackSettings()

Returns if overriding of camera track settings is enabled.

Returns:True if overriding of camera track settings is enabled, False otherwise.
Return type:bool
vrdViewpointNode.getPreview()

Returns the viewpoint preview image.

Returns:The preview image
Return type:vrdImage
vrdViewpointNode.getShowInVRMenu()

Check, if this viewpoint is visible in VR Menu.

Returns:True, if visible in VR Menu.
Return type:bool
vrdViewpointNode.getTrackFadeInDurationOverride()

Returns the override for the fade in duration of the camera track.

Returns:The fade in duration in seconds.
Return type:float
vrdViewpointNode.getTrackPauseDurationOverride()

Returns the override for the pause duration of the camera track.

Returns:The pause duration in seconds.
Return type:float
vrdViewpointNode.getTrackTransitionDurationOverride()

Returns the override for the transition duration of the camera track.

Returns:The transition duration in seconds.
Return type:float
vrdViewpointNode.hasPreview()

Checks if the viewpoint has a preview image.

Returns:True if it has a preview, False otherwise.
Return type:bool
vrdViewpointNode.removePreview()

Removes the current preview for the viewpoint.

vrdViewpointNode.setOverrideTrackSettings(enable)

Enables / disables overriding of camera track settings.

Parameters:enable (bool) – True to enable override track settings, False to disable.
vrdViewpointNode.setShowInVRMenu(value)

Set visiblility of this viewpoint in VR Menu.

Parameters:value (bool) – If True, this viewpoint is visible.
vrdViewpointNode.setTrackFadeInDurationOverride(value)

Sets the override for the fade in duration of the camera track.

Parameters:value (float) – The fade in duration in seconds.
vrdViewpointNode.setTrackPauseDurationOverride(value)

Sets the override for the pause duration of the camera track.

Parameters:value (float) – The pause duration in seconds.
vrdViewpointNode.setTrackTransitionDurationOverride(value)

Sets the override for the transition duration of the camera track.

Parameters:value (float) – The transition duration in seconds.