vrdCameraNode

class vrdCameraNode

(Inherits vrdCameraBaseNode)

This class represents a camera in VRED.

For access to existing cameras and to create new cameras use vrCameraService. This class holds all properties that are specific to cameras and not valid for viewpoints (vrdViewpointNode). For more properties see also vrdCameraBaseNode.

There are actually two different nodes for each camera in VRED: One node is in the regular scene graph, the second node is in the graph in the Camera Editor. They have different ids but internally work on the same OSG camera.

Functions

vrdCameraNode.activate()

Sets the camera to active.

vrdCameraNode.getAimConstraintSources()

Returns the list of nodes set as aim constraint sources for the camera.

Returns:The list of aim constraint source nodes.
Return type:List[vrdNode]
vrdCameraNode.getAimVisualizationScale()

Returns the scaling value used for the aim and up vector visualization.

Returns:The visualization scaling value.
Return type:float
vrdCameraNode.getAimVisualizationVisible()

Queries if the aim and up vector visualization is visible in the renderer.

Returns:True if the visualization is enabled.
Return type:bool
vrdCameraNode.getCameraCollider()

This object gives access to the camera collision functionality.

Returns:The camera collider object.
Return type:vrdCameraCollider
vrdCameraNode.getCameraTrack(cameraTrackIndex)

Gets the camera track.

Parameters:cameraTrackIndex (integer) – The camera track index
Returns:The camera track.
Return type:vrdCameraTrackNode
vrdCameraNode.getCameraTrackCount()

Returns the number of camera tracks in the camera.

Returns:The number of camera tracks.
Return type:integer
vrdCameraNode.getCameraTracks()

Returns the list of all camera track nodes of the camera.

Returns:The list of camera track nodes.
Return type:List[vrdCameraTrackNode]
vrdCameraNode.getDefaultCameraTrack()

Returns the default camera track node.

Returns:The default camera track node.
Return type:vrdCameraTrackNode
vrdCameraNode.getDollyZoom()

Returns the state of dolly zoom mode.

Returns:True if dolly zoom mode is enabled, False otherwise.
Return type:bool
vrdCameraNode.getEvaluateNavigationMode()

Queries if evaluation of the navigation mode is enabled.

Returns:True if evaluation is enabled, False otherwise.
Return type:bool
vrdCameraNode.getModuleNode()

Returns the corresponding camera graph node to this camera node.

Returns:Returns the camera graph node
Return type:vrdCameraNode
vrdCameraNode.getTurntable()

This object gives access to the turntable.

Returns:The turntable object.
Return type:vrdTurntable
vrdCameraNode.getUpVectorConstraintSources()

Returns the list of nodes set as up vector sources for the camera.

Returns:The list of up vector constraint source nodes.
Return type:List[vrdNode]
vrdCameraNode.getVisualizationScale()

Returns the scaling value used for the camera visualization.

Returns:The visualization scaling value.
Return type:float
vrdCameraNode.getVisualizationVisible()

Queries if the visualization for the camera has been enabled.

Returns:The visualization visible.
Return type:bool
vrdCameraNode.hasAimConstraint()

Queries if the camera has an aim constraint.

Returns:True if has aim constraint, False otherwise.
Return type:bool
vrdCameraNode.hasAimConstraintSource(sourceNode)

Queries if a given node is an aim constraint source for the camera.

Parameters:sourceNode (vrdNode) – The node to check.
Returns:True if the node is part of the aim constraint sources, False otherwise.
Return type:bool
vrdCameraNode.isActive()

Determines if the camera is active.

Returns:True if active, False otherwise.
Return type:bool
vrdCameraNode.isDefault()

Determines if the camera is the default camera.

Returns:True if default, False otherwise.
Return type:bool
vrdCameraNode.isInitialCamera()

Queries if this camera is the initial camera.

Returns:True if initial camera, False otherwise.
Return type:bool
vrdCameraNode.removeAimConstraintSources()

Removes all aim constraint sources from the camera.

Note that this will also remove the default ‘CameraNameAim’ node which is automatically created and added as an aim constraint source when creating a new camera with an aim constraint.

Returns:True if aim constraint sources could be removed, False otherwise
Return type:bool
vrdCameraNode.removeUpVectorConstraintSources()

Removes all up vector constraint sources.

Note that this will also remove the default ‘CameraNameUp’ node which is automatically created and added as an up vector constraint source when creating a new camera with an aim and up constraint.

Returns:True if up vector constraint sources could be removed, False otherwise
Return type:bool
vrdCameraNode.setAimConstraintSources(nodes)

Sets a list of nodes as aim constraint sources for the camera.

Parameters:nodes (List[vrdNode]) – The nodes to set as aim constraint sources.
vrdCameraNode.setAimVisualizationScale(value)

Sets the scaling value for the aim and up vector visualization.

Parameters:value (float) – The scaling value (minimum: 0)
vrdCameraNode.setAimVisualizationVisible(enable)

Enables / disables the aim and up vector visualizations.

Parameters:enable (bool) – True to enable the visualization, False to disable.
vrdCameraNode.setDollyZoom(enabled)

Enables / disables dolly zoom mode.

Parameters:enabled (bool) – True to enable dolly zoom mode, False to disable.
vrdCameraNode.setEvaluateNavigationMode(enabled)

Enable / disable the evaluation of the navigation mode when playing camera animations.

Parameters:enabled (bool) – True enables evaluation, False disables it.
vrdCameraNode.setInitialCamera()

Sets this camera to be the initial camera.

vrdCameraNode.setUpVectorConstraintSources(nodes)

Sets a list of nodes as up vector constraint sources.

Parameters:nodes (List[vrdNode]) – The nodes to set as up vector constraint sources.
vrdCameraNode.setVisualizationScale(value)

Sets a scaling value for the camera visualization.

Parameters:value (float) – The scaling value (minimum: 0)
vrdCameraNode.setVisualizationVisible(enable)

Enables / disables the visualization of the camera.

Enabling this will show a visualization of the camera in the render window.

Parameters:enable (bool) – True to enable the visualization, False to disable.
vrdCameraNode.updateFromPerspectiveMatch()

Updates this camera’s focal length and rotation according to perspective match settings.