disguise developers

Designer Plugins

Plugins for Disguise Designer software.

Camera

A camera which captures a view of objects in the stage. May represent a physical camera with a video input, or a virtual camera which renders the modelled stage objects.

Category: Stage

Base class: SlcAwareDisplay

Subclasses: OptiCalCameraPlan, SphericalCamera, VirtualCamera

Properties

activeMixedRealitySets : List[MixedRealitySet] (Read-Only)

The mixed reality sets that this camera is currently active in.

aperture : float

Aperture (f-stop) value, defined as the focal length / aperture diameter

aspectRatio : float

Aspect ratio of the camera lens, defined as x/y. This is not necessarily the same as the aspect ratio of the camera’s resolution, unless the pixels are perfectly square.

cameraImagingPredictionSamples : int

Number of samples to use for camera imaging forward prediction

Category: Prediction
UserName: Camera imaging delay prediction samples

cameraImagingPredictionTerms : int

Number of terms to use for camera imaging forward prediction

Category: Prediction
UserName: Camera imaging delay prediction terms

centerShiftMM : Vec2

Center shift of the camera in millimeters.

doesTrackingSourceSupportLensData : bool (Read-Only)

Whether the tracking source attached to this camera (if present) supports lens data.

fieldOfViewH : float

Horizontal field of view of the camera, in degrees.

fieldOfViewV : float

Vertical field of view of the camera, in degrees.

focalLengthMM : float

Focal length of the camera in millimeters. Defined relative to the sensor width of the camera.

focusDistance : float

Distance to the focal plane in m

frontplateCompositeOrder : int

Order in which the distorted and undistorted front plates are composited

Options: {0: ‘Undistorted On Top’, 1: ‘Distorted On Top’}
Category: Output
UserName: Frontplate composite order

frontplateFade : float

The opacity of the camera’s frontplate content. 0 is fully transparent, 1 is fully opaque.

Category: Output
UserName: AR fade

frontplateReprojectionMode : int

Mode used for frontplate delay compensation and reprojection:
Backplate Aligned: The frontplate is delayed and reprojected with the backplate.
No Reprojection: The frontplate is delayed with the backplate but not reprojected.
Minimal Latency: The most recently rendered frontplate is composited with no reprojection.

Options: {0: ‘Backplate Aligned’, 1: ‘No Reprojection’, 2: ‘Minimal Latency’}
Category: Output
UserName: Frontplate reprojection

isLiveCamera : bool (Read-Only)

Whether the camera has a live video input.

k1k2k3 : Vec

Radial lens distortion coefficients k1, k2 and k3

lens : LensIntrinsics

The camera’s lens intrinsics values.

Category: Lens

lensFocusMode : int

Disabled: No focus effects applied.
Manual: Use focus distance set manually or from tracking source.
Object Tracking: Set the focus distance based on a tracked object.

Options: {0: ‘Disabled’, 1: ‘Manual’, 2: ‘Object Tracking’}
Category: Focus
UserName: Focus mode

lensFocusParams : LensFocusParams

The lens focus parameters of the camera. These parameters are used to define depth of field effects, such as aperture and focus distance.

lensFocusTrackedObject : Object

Object used to calculate focus distance when focus mode is set to Object Tracking

Category: Focus
UserName: Focus tracked object

minOverscan : Vec2 (Read-Only)

Minimum overscan required to avoid blank areas in the image, based on distortion settings.
Note that a moving camera may require larger overscan than this to account for reprojection due to latency compensation.

orthographicScale : float

Orthographic scale of the camera, when the camera is in orthographic mode.

Category: Stage Render
UserName: Orthographic scale

overscan : Vec2

Generate extra content outside the original canvas resolution to compensate for lens distortion.
1 means 100% of original resolution, 2 means 200%.

Category: Lens
UserName: Overscan

overscanResolution : Int2 (Read-Only)

The resolution of the overscanned camera image. This is equal to the camera resolution multiplied by the overscan.

paWidthMM : float

The physical width of the camera sensor in millimeters. Changing this does not affect the field of view or distortion of the camera.

projectionMatrixType : int

Perspective or orthographic view of stage

Options: {0: ‘Perspective’, 1: ‘Orthographic’}
Category: Stage Render
UserName: Camera type

radialMaskScale : float

Apply a radial mask to the filmed content. Scales between 0 and 1 based on the image diagonal.

Category: Output
UserName: Radial mask scale

renderTimeToCameraCaptureTime : float

Amount of time between rendering a frame and the camera taking the picture of the stage showing that frame

Category: Prediction
UserName: Camera imaging delay (sec)

renderTimeToVideoReceiveTimeSec : float

Amount of time between rendering a frame and receiving the corresponding video frame

Category: Physical
UserName: Video receive delay (sec)

sensorSizeMM : Vec2

The size of the camera’s sensor in millimeters. Changing this does not affect the field of view or distortion of the camera.

setExtensionAlpha : float

Set to 1 for set extension, or 0 to turn it off

Category: Output
UserName: Set extension fade

setExtensionFeather : int

The size of the feathering blending the set extension with reality

Category: Output
UserName: Set extension feather

spatialCalibration : SpatialCalibrationConfig

Calibrate the difference between d3-space and tracker space by adjusting the cameras position, zoom and focus.
This should always be calibrated after the Video Receive Delay.

Category: Physical
UserName: Spatial calibration

sphericalRenderParams : SphericalRenderParams (Read-Only)

Spherical render parameters, used by cameras which are capable of producing an equirectangular spherical output.

stageRenderSettings : StageRenderSettings (Read-Only)

Settings defining how the camera renders the stage. For example, which objects are visible and which renderer is used.

takeResolutionFromGuiHead : int

Whether the camera resolution is fixed or should be taken from the GUI head.

Options: {0: ‘Fixed’, 1: ‘Take from GUI’}
Category: Settings
UserName: Resolution Source

usingSpatialCalibrationLensPoses : bool (Read-Only)

Whether or not the camera is using spatial calibration lens poses for tracking. True if the camera has a tracking source and secondary spatial calibration has been carried out, False otherwise.

videoIn : LogicalVideoInDevice

Video input received from real-world camera

Category: Physical
UserName: Video in

videoInCompositeFade : float

Set to 1 for video input in transmission, or 0 to turn it off. If no video input is selected, fade the visualser. This shows AR effects only, against an alpha background.

Category: Output
UserName: Video input fade

videoReceiveTimeToTrackerReceiveTimeSec : float

Amount of time between receiving a video frame and receiving the corresponding tracking data.
If negative tracker data arrives before the video frame.
If positive, tracker data arrives after the video frame.

Category: Physical
UserName: Spatial Tracker delay (sec)

visibilitySettings : StageRenderSettings

Settings controlling the camera’s render of the stage

Category: Stage Render
UserName: Render settings

zFar : float

Set the furthest distance from the camera before an object will be clipped.

Category: Stage Render
UserName: Far clipping plane

zNear : float

Set the closest distance to the camera before an object will be clipped.

Category: Stage Render
UserName: Near clipping plane

Variables

TargetBackplate : Final = 1

TargetFrontplate : Final = 2

TargetTransmission : Final = 0

localVisualiserCamera : Callable

Methods

applyCalibrationToLockedOffCamera(self)

Applies the calibration to a locked off camera.

This method applies the results of a spatial calibration in the case where the camera does not have a tracking source. In this case it is treated as ‘locked off’ i.e. static, so the calibrated pose is applied directly to the camera position, rotation and lens intrinsics.

saveCurrentView(self, filename: str)

Save the current camera view to a file.

This method saves the current camera view to a file with the specified filename. The file will be saved in the “screenshots” directory, and the extension will be determined by the screen shot texture format.

Parameters: