Table of Contents

Class Camera

Namespace
NominalSystems.Classes
Assembly
NominalSystems.Classes.dll

Payload model for the camera that can interface with Unreal and produce images.

public class Camera : PhysicalComponent
Inheritance
Camera
Inherited Members

Constructors

Camera()

Default constructor

public Camera()

Fields

CaptureName

[-] The name of the image that will be saved when the image is captured.

[EditableVariable("-", false, "", "")]
public string CaptureName

Field Value

string

FieldOfView

[deg] The field of view of the camera

[EditableVariable("deg", 0, 360, false, "", "")]
public double FieldOfView

Field Value

double

Out_CameraImageMsg

An output message that contains the data from the image and is able to store all the bytes.

public CameraImageMessage Out_CameraImageMsg

Field Value

CameraImageMessage

SampleRate

[s] The time between photo captures

[EditableVariable("s", 0, false, "", "")]
public double SampleRate

Field Value

double

Properties

LastCaptureTime

[s] Stores the last time of a successful capture

[EditableVariable("s", true, "", "")]
public double LastCaptureTime { get; }

Property Value

double

ReadyToCapture

[-] A flag for if the image is ready to capture

[EditableVariable("-", true, "", "")]
public bool ReadyToCapture { get; }

Property Value

bool

Methods

CanCapture()

Checks if the camera is ready to capture and if it is, it will reset the flag back to false.

public bool CanCapture()

Returns

bool

A flag if the camera can capture

Capture(string)

Called to capture the photo. This is handled through the Unreal Engine

public void Capture(string name = "")

Parameters

name string

OnUpdate(double, double)

Called when the 'Component' should update

protected override void OnUpdate(double time, double step)

Parameters

time double

current time (seconds)

step double

the time step (seconds)