#include <Camera.h>

Inheritance diagram for ACamera:

[legend]

Collaboration diagram for ACamera:

[legend]

Public Member Functions
	ACamera (const FObjectInitializer &ObjectInitializer)

virtual void	Init (FCameraBaseParameters parameters, bool SimulateSensor=true)

virtual ESensorTypes	GetSensorType () const override

void	ChangeCameraParameters (FCameraBaseParameters newParameters)

FCameraBaseParameters	GetCameraParameters ()

void	AddPostProcessingMaterial (const FString &Path, float Weight=1.0f)

void	RemovePostProcessingMaterial (UMaterial *Material)

USceneCaptureComponent2D *	GetCaptureComponent2D () const

UTextureRenderTarget2D *	GetCaptureRenderTarget2D () const

void	AddWidgetToWindow (UWidget *WidgetToAdd)

void	RemoveWidgetFromWindow (UWidget *WidgetToRemove)

void	SetShadowRendering (bool RenderShadows)

void	SetTemporalAA (bool SetTemporal)

void	ResizeCamera (int Width=1280, int Height=720)

void	SaveCurrentFrameToDisk ()

int	GetCameraWidth () const

int	GetCameraHeight () const

virtual FString	GetParametersAsString () const override

Public Member Functions inherited from ASensor
	ASensor (const FObjectInitializer &ObjectInitializer)

FString	ExportToJsonFile (const FString &FileName)

virtual ESensorTypes	GetSensorType () const

FString	GetSensorIdentifier () const

void	SetSensorIdentifier (const FString newIdentifier)

FString	GetSensorName () const

virtual FString	GetParametersAsString () const

void	SetSensorName (const FString newName)

virtual FString	GetTopicName ()

UTopic *	GetROSTopic () const

void	SetSimulateSensor (bool SimulateSensor)

bool	CanSimulateSensor () const

ASensorModel *	GetSensorModel () const

void	SetSensorModel (ASensorModel *NewSensorModel)

FORCEINLINE bool	IsROSConnected () const

UROSIntegrationGameInstance *	GetROSGameInstance () const

virtual FString	GetActorID_Implementation () const override

virtual FString	GetActorName_Implementation () const override

virtual FString	GetActorInformation_Implementation () const override

virtual void	SetActorName_Implementation (const FString &NewActorName) override

virtual void	SetActorIDAndName_Implementation (const FString &NewActorName, const FString &NewID) override

Public Member Functions inherited from IActorInformation
FString	GetActorID () const

FString	GetActorName () const

FString	GetActorInformation () const

void	SetActorName (const FString &NewActorName)

void	SetActorIDAndName (const FString &NewActorName, const FString &NewID)

Public Attributes
TEnumAsByte< ETextureRenderTargetFormat >	TextureFormat = ETextureRenderTargetFormat::RTF_RGBA8

FCameraDelegate_OnWindowClosed	OnCameraWindowClosed

FCameraDelegate_OnWindowResized	OnCameraWindowResized

Public Attributes inherited from ASensor
FSensorDestroy	OnSensorDestroy

FString	AttachedToComponent

FName	AttachedToBone

Protected Member Functions
virtual void	BeginPlay () override

virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

virtual void	PreActorTick (UWorld *World, ELevelTick TickType, float DeltaSeconds)

virtual void	EndOfFrame (UWorld *World, ELevelTick TickType, float DeltaSeconds)

virtual void	EndOfFrameParellel (float DeltaTime)

virtual void	AddProcessingToFrameBuffer (TArray< FColor > &buffer)

virtual void	SendImageDataToROS (const TArray< FColor > &FrameBuffer, int32 Width, int32 Height)

void	HidePrimitiveComponent (UPrimitiveComponent *PrimitiveComponent)

void	SaveImageToDisk (const TArray< FColor > FrameBuffer, int32 Width, int32 Height)

void	SaveCameraMetaDataToDisk (const FString &ImageName)

void	CreateLogFile () override

Protected Member Functions inherited from ASensor
virtual void	BeginPlay () override

virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

virtual void	CreateROSTopic ()

virtual void	DestroyROSTopic ()

virtual void	CreateDataSavePath ()

bool	IsLogFileCreated ()

virtual void	CreateLogFile ()

void	WriteToLogFile (const FString &Message)

Protected Attributes
bool	UseParallelLateTick = true

FDelegateHandle	OnPreTickDelegate

FDelegateHandle	OnPostTickDelegate

FString	CameraName = "Camera "

FString	FilePrefix = "Data/Camera_"

UTextureRenderTarget2D *	CaptureRenderTarget = nullptr

USceneCaptureComponent2D *	CaptureComponent2D = nullptr

UTexture2D *	CaptureFrameTexture

TSharedPtr< FUnrealWindow >	UnrealWindow

FTickEntry	TickEntry

TWeakObjectPtr< UMaterialInstanceDynamic >	IceMaterialInstance

TWeakObjectPtr< UMaterial >	PhysicLensDistortion

Protected Attributes inherited from ASensor
UTopic *	ROSTopic = nullptr

bool	SendDataToROS = true

ULogFile *	LogFile = nullptr

FString	FileSavePath

UROSIntegrationGameInstance *	ROSInstance = nullptr

Private Member Functions
void	StartFrameGrabber ()

void	ReleaseFrameGrabber ()

void	FrameGrabberCapture ()

void	OnWindowClosed (const TSharedRef< SWindow > &Window)

void	SetupCamera (FCameraBaseParameters parameters)

bool	ShouldSimulate (const float DeltaSeconds)

Private Attributes
TSharedPtr< FFrameGrabber >	FrameGrabber

FCameraBaseParameters	CameraParameters

FCameraBaseParameters	TempParams

AGeoReferencingSystem *	GeoReferencingSystem = nullptr

bool	ParametersChanged = false

FOnWindowClosed	OnWindowClosedDelegate

TSharedPtr< ROSMessages::sensor_msgs::Image >	ImageMsg

int	ImageWidth = 1280

int	ImageHeight = 720

bool	SaveCurrentFrameToDiskRequested = false

bool	ShouldSimulateCamera = true

float	CameraFrameRate = 0.0f

float	FrameRateTimer = 0.0f

int	ImageNumber = 0

uint8 *	BGR8Buffer = nullptr

int32	CurrentBufferSize = 0

Additional Inherited Members
Static Public Member Functions inherited from ASensor
static void	HideComponentForAllCameras (UPrimitiveComponent *PrimitiveComponent)

static TMap< FString, FColor >	GetSemanticColors ()

static TArray< TWeakObjectPtr< UPrimitiveComponent > >	GetComponentsToHide ()

Static Public Member Functions inherited from IActorInformation
static void	SetAndValidateActorIDAndName (FString &ActorName, FString &ActorID, TWeakObjectPtr< AActor > Actor)

static bool	DestroyActorByID (const FString &ID)

static AActor *	GetActorByID (const FString &ID)

template<typename T >
static TArray< T * >	GetActorsWithInterface ()

static void	PrintAllIds ()

Static Protected Member Functions inherited from ASensor
template<typename InStructType >
static FString	StructToString (const InStructType &InStruct)

Static Protected Attributes inherited from ASensor
static FPrimitiveAdded	OnPrimitiveAdded

static const FName	NiagaraPointsInt = "User.PointCount"

static const FName	NiagaraHitPoints = "User.HitPoints"

static const FName	NiagaraHitColors = "User.HitColors"

static const FName	NiagaraPointsFloat = "User.Test"

Detailed Description

Camera sensor base class. All other Camera sensors are inherited from this class.

This creates custom Unreal Engine Window and renders USceneCaptureComponent2D into it. Then the Window screen pixels are read by FrameGrabber API which depending on the Camera type, might add processing on the read pixels. The pixels are then saved to disk if SaveDataToDisk is set to true and data is sent to ROS.

Definition at line 51 of file Camera.h.

Constructor & Destructor Documentation

◆ ACamera()

ACamera::ACamera ( const FObjectInitializer & ObjectInitializer )

Setup new ACamera class

Parameters

FObjectInitializer default ObjectInitializer

Definition at line 29 of file Camera.cpp.

                                                            : Super(ObjectInitializer)
{
    PrimaryActorTick.bCanEverTick = true;
    PrimaryActorTick.TickGroup = TG_PostUpdateWork;
 
    CaptureRenderTarget = CreateDefaultSubobject<UTextureRenderTarget2D>(FName(*FString::Printf(TEXT("CaptureRenderTarget"))));
    CaptureRenderTarget->CompressionSettings = TextureCompressionSettings::TC_Default;
    CaptureRenderTarget->SRGB = false;
    CaptureRenderTarget->bAutoGenerateMips = false;
    CaptureRenderTarget->bGPUSharedFlag = true;
    CaptureRenderTarget->AddressX = TextureAddress::TA_Clamp;
    CaptureRenderTarget->AddressY = TextureAddress::TA_Clamp;
 
    CaptureComponent2D = CreateDefaultSubobject<USceneCaptureComponent2D>(FName(*FString::Printf(TEXT("SceneCaptureComponent2D"))));
    CaptureComponent2D->SetupAttachment(RootComponent);
    CaptureComponent2D->PrimitiveRenderMode = ESceneCapturePrimitiveRenderMode::PRM_RenderScenePrimitives;
    CaptureComponent2D->bCaptureOnMovement = false;
    CaptureComponent2D->bCaptureEveryFrame = false;
    CaptureComponent2D->bAlwaysPersistRenderingState = true;
}

References CaptureComponent2D, and CaptureRenderTarget.

Member Function Documentation

◆ AddPostProcessingMaterial()

void ACamera::AddPostProcessingMaterial	(	const FString &	Path,
		float	Weight = `1.0f`
	)

Adds a post-processing material from the specified file path.

Parameters

Path	The file path to the post-processing material.
Weight	The weight or influence of the material. Default is 1.0f.

Definition at line 55 of file Camera.cpp.

{
    UMaterial* PostProcessingMat = Cast<UMaterial>(StaticLoadObject(UMaterial::StaticClass(), nullptr, *Path));
    if (PostProcessingMat && CaptureComponent2D)
    {
        FPostProcessSettings& PostProcessSettings = CaptureComponent2D->PostProcessSettings;
        PostProcessSettings.AddBlendable(PostProcessingMat, Weight);
    }
    else 
    {
        FString Sensor = GetSensorName();
        FString Msg = "Failed to add Post processing material to " + Sensor;
        SimulatorLog::Log(Msg);
    }
}

References CaptureComponent2D, ASensor::GetSensorName(), and SimulatorLog::Log().

Referenced by ASemanticSegmentationCamera::Init(), and ADepthCamera::SetupDepthMaterial().

◆ AddProcessingToFrameBuffer()

void ACamera::AddProcessingToFrameBuffer ( TArray< FColor > & buffer )

protectedvirtual

Reimplemented in ADVSCamera.

Definition at line 547 of file Camera.cpp.

{
    // Only DVSCamera adds processing to the frame buffer
    return;
}

Referenced by FrameGrabberCapture().

◆ AddWidgetToWindow()

void ACamera::AddWidgetToWindow ( UWidget * WidgetToAdd )

Add Widget to custom Unreal Window

Definition at line 750 of file Camera.cpp.

{
    if (UnrealWindow.IsValid() && WidgetToAdd)
    {
        UnrealWindow->AddUWidgetToWindow(WidgetToAdd);
    }
}

References UnrealWindow.

Referenced by SetupCamera().

◆ BeginPlay()

void ACamera::BeginPlay ( )

overrideprotectedvirtual

Reimplemented from ASensor.

Definition at line 375 of file Camera.cpp.

{
    Super::BeginPlay();
 
    // Register to PreActorTick where USceneCaptureComponent2D will get rendered.
    OnPreTickDelegate = FWorldDelegates::OnWorldPreActorTick.AddUObject(this, &ACamera::PreActorTick);
 
    // Check if we should use ATickManager which ticks in parallel, or use Post actor tick
    // In there we capture the screen pixels with FrameGrabber API, 
    // might do some extra processing, save image to disk and send data to ROS. 
    if (UseParallelLateTick)
    {
        SetActorTickEnabled(false);
        TickEntry = ATickManager::AddTick(this, BindTick(this, &ACamera::EndOfFrameParellel), ETickType::LateTickParallel);
    }
    else
    {
        SetActorTickEnabled(true);
        OnPostTickDelegate = FWorldDelegates::OnWorldPostActorTick.AddUObject(this, &ACamera::EndOfFrame);
    }
 
    // Get all existing components set to be hidden for all Camera sensors (like Lidar point cloud visualization).
    auto Components = ASensor::GetComponentsToHide();
    for (int32 i = 0; i < Components.Num(); i++)
    {
        UPrimitiveComponent* Primitive = Components[i].Get();
        if (Primitive)
        {
            HidePrimitiveComponent(Primitive);
        }
    }
 
    OnPrimitiveAdded.AddUniqueDynamic(this, &ACamera::HidePrimitiveComponent);
}

References ATickManager::AddTick(), BindTick(), EndOfFrame(), EndOfFrameParellel(), ASensor::GetComponentsToHide(), HidePrimitiveComponent(), OnPostTickDelegate, OnPreTickDelegate, ASensor::OnPrimitiveAdded, PreActorTick(), TickEntry, and UseParallelLateTick.

◆ ChangeCameraParameters()

void ACamera::ChangeCameraParameters ( FCameraBaseParameters newParameters )

Change Camera parameters on the fly. Callable from blueprint.

Parameters

FCameraBaseParameters CameraParameters struct

Definition at line 50 of file Camera.cpp.

{
    SetupCamera(newParameters);
}

References SetupCamera().

Referenced by ADepthCamera::ChangeDepthCameraParameters(), ADVSCamera::ChangeParametersInternal(), AThermalCamera::ChangeThermalCameraParameters(), ResizeCamera(), and APhotoCapture::SetupPhotoCapture().

◆ CreateLogFile()

void ACamera::CreateLogFile ( )

overrideprotectedvirtual

Create Text file for this sensor if it has not been created already. Text file will be created to ROOT/Data/Run/Logs directory. Filename will be SensorName_ID_UnixTimestamp.txt Can be overriden by individual sensor if needed.

Reimplemented from ASensor.

Definition at line 88 of file Camera.cpp.

{
    if (IsValid(LogFile))
    {
        // File has already been created, return
        return;
    }
 
    FLogFileSettings Settings;
    Settings.FileCreationOptions = FFileCreationOptions::Overwrite;
    Settings.FileWriteOptions = FFileWriteOptions::Queue;
    Settings.QueueLength = MAX_int32; // Only write the log after destroying the sensor
    Settings.KeepFileOpen = false;
    Settings.Timestamp = false;
    Settings.OverrideFilePath = true;
    Settings.FilePath = FileSavePath;
 
    LogFile = NewObject<ULogFile>(ULogFile::StaticClass());
    if (IsValid(LogFile))
    {
        FString FileName = "camera_metadata";
        LogFile->Create(FileName, Settings);
 
        // Write camera metadata first line to explain the values.
        GeoReferencingSystem = AGeoReferencingSystem::GetGeoReferencingSystem(GetWorld());
        if (GeoReferencingSystem)
        {
            WriteToLogFile("image_name, X location, Y location, Z location, yaw rotation, pitch rotation, roll rotation, GPS latitude, GPS longitude, GPS altitude");
        }
        else
        {
            WriteToLogFile("image_name, X location, Y location, Z location, yaw rotation, pitch rotation, roll rotation");
        }
    }
}

References ULogFile::Create(), FLogFileSettings::FileCreationOptions, FLogFileSettings::FilePath, ASensor::FileSavePath, FLogFileSettings::FileWriteOptions, GeoReferencingSystem, FLogFileSettings::KeepFileOpen, ASensor::LogFile, FLogFileSettings::OverrideFilePath, Overwrite, Queue, FLogFileSettings::QueueLength, FLogFileSettings::Timestamp, and ASensor::WriteToLogFile().

Referenced by Init().

◆ EndOfFrame()

void ACamera::EndOfFrame	(	UWorld *	World,
		ELevelTick	TickType,
		float	DeltaSeconds
	)

protectedvirtual

Definition at line 475 of file Camera.cpp.

{
    FrameGrabberCapture();
}

References FrameGrabberCapture().

Referenced by BeginPlay().

◆ EndOfFrameParellel()

void ACamera::EndOfFrameParellel ( float DeltaTime )

protectedvirtual

Definition at line 480 of file Camera.cpp.

{
    FrameGrabberCapture();
}

References FrameGrabberCapture().

Referenced by BeginPlay().

◆ EndPlay()

void ACamera::EndPlay ( const EEndPlayReason::Type EndPlayReason )

overrideprotectedvirtual

Reimplemented from ASensor.

Reimplemented in ADepthCamera, ADVSCamera, and AThermalCamera.

Definition at line 410 of file Camera.cpp.

{
    Super::EndPlay(EndPlayReason);
 
    FWorldDelegates::OnWorldPreActorTick.Remove(OnPreTickDelegate);
 
    if (UseParallelLateTick)
    {
        ATickManager::RemoveTick(TickEntry);
    }
    else
    {
        FWorldDelegates::OnWorldPostActorTick.Remove(OnPostTickDelegate);
    }
 
    if (UnrealWindow.IsValid())
    {
        OnWindowClosedDelegate.Unbind();
        UnrealWindow->DestroyWindow();
        UnrealWindow.Reset();
    }
 
    ReleaseFrameGrabber();
 
    if (CaptureRenderTarget)
    {
        CaptureRenderTarget->ConditionalBeginDestroy();
        CaptureRenderTarget = nullptr;
    }
 
    if (CaptureComponent2D)
    {
        CaptureComponent2D->UnregisterComponent();
        CaptureComponent2D->ConditionalBeginDestroy();
        CaptureComponent2D = nullptr;
    }
 
    ImageMsg.Reset();
    IceMaterialInstance.Reset();
 
    if (BGR8Buffer)
    {
        delete[] BGR8Buffer;
        BGR8Buffer = nullptr;
    }
    CurrentBufferSize = 0;
}

References BGR8Buffer, CaptureComponent2D, CaptureRenderTarget, CurrentBufferSize, IceMaterialInstance, ImageMsg, OnPostTickDelegate, OnPreTickDelegate, OnWindowClosedDelegate, ReleaseFrameGrabber(), ATickManager::RemoveTick(), TickEntry, UnrealWindow, and UseParallelLateTick.

◆ FrameGrabberCapture()

void ACamera::FrameGrabberCapture ( )

private

Capture screen pixels with FrameGrabber

Definition at line 512 of file Camera.cpp.

{
    TRACE_CPUPROFILER_EVENT_SCOPE(ACamera::FrameGrabberCapture);
 
    if (!ShouldSimulateCamera || !FrameGrabber.IsValid())
    {
        return;
    }
 
    if (!SendDataToROS && !CameraParameters.SaveImageToDisk && !SaveCurrentFrameToDiskRequested)
    {
        return;
    }
 
    TArray<FCapturedFrameData> Frames = FrameGrabber->GetCapturedFrames();
    if (Frames.Num())
    {
        FCapturedFrameData& LastFrame = Frames.Last();
        TArray<FColor>& ImageBuffer = LastFrame.ColorBuffer;
 
        AddProcessingToFrameBuffer(ImageBuffer);
 
        if (CameraParameters.SaveImageToDisk || SaveCurrentFrameToDiskRequested)
        {
            SaveCurrentFrameToDiskRequested = false;
            AsyncTask(ENamedThreads::AnyBackgroundThreadNormalTask, [this, ImageBuffer]()
            {
                SaveImageToDisk(ImageBuffer, ImageWidth, ImageHeight);
            });
        }
 
        SendImageDataToROS(ImageBuffer, ImageWidth, ImageHeight);
    }
}

References AddProcessingToFrameBuffer(), CameraParameters, FrameGrabber, FrameGrabberCapture(), ImageHeight, ImageWidth, SaveCurrentFrameToDiskRequested, SaveImageToDisk(), FCameraBaseParameters::SaveImageToDisk, ASensor::SendDataToROS, SendImageDataToROS(), and ShouldSimulateCamera.

Referenced by EndOfFrame(), EndOfFrameParellel(), and FrameGrabberCapture().

◆ GetCameraHeight()

int ACamera::GetCameraHeight ( ) const

inline

Definition at line 198 of file Camera.h.

    {
        return ImageHeight;
    }

Referenced by ADVSCamera::ChangeParametersInternal(), ADVSCamera::Init(), and ADVSCamera::SimulateDVS().

◆ GetCameraParameters()

FCameraBaseParameters ACamera::GetCameraParameters ( )

inline

Get current Camera parameters

Returns: FCameraBaseParameters struct

Definition at line 90 of file Camera.h.

    {
        return CameraParameters;
    }

Referenced by USimulatorJsonExporter::ExportSensorToJSON(), and APhotoCapture::SetupPhotoCapture().

◆ GetCameraWidth()

int ACamera::GetCameraWidth ( ) const

inline

Definition at line 192 of file Camera.h.

    {
        return ImageWidth;
    }

Referenced by ADVSCamera::ChangeParametersInternal(), ADVSCamera::Init(), and ADVSCamera::SimulateDVS().

◆ GetCaptureComponent2D()

USceneCaptureComponent2D * ACamera::GetCaptureComponent2D ( ) const

inline

Get CaptureComponent USceneCaptureComponent2D pointer.

Returns: USceneCaptureComponent2D pointer

Definition at line 113 of file Camera.h.

    {
        return CaptureComponent2D;
    }

Referenced by ADepthCamera::SetupDepthMaterial(), and AThermalCamera::SetupMaterial().

◆ GetCaptureRenderTarget2D()

UTextureRenderTarget2D * ACamera::GetCaptureRenderTarget2D ( ) const

inline

Get UTextureRenderTarget2D pointer.

Returns: UTextureRenderTarget2D pointer

Definition at line 123 of file Camera.h.

    {
        return CaptureRenderTarget;
    }

◆ GetParametersAsString()

virtual FString ACamera::GetParametersAsString ( ) const

inlineoverridevirtual

Get current LidarParameters struct fields as one string.

Reimplemented from ASensor.

Reimplemented in ADepthCamera, ADVSCamera, and AThermalCamera.

Definition at line 206 of file Camera.h.

    {
        return StructToString(CameraParameters);
    }

◆ GetSensorType()

virtual ESensorTypes ACamera::GetSensorType ( ) const

inlineoverridevirtual

Get type of the sensor

Returns: Sensor's type

Reimplemented from ASensor.

Reimplemented in ADepthCamera, ADVSCamera, ASemanticSegmentationCamera, and AThermalCamera.

Definition at line 73 of file Camera.h.

    { 
        return ESensorTypes::RGBCamera; 
    }

References RGBCamera.

Referenced by SetupCamera(), and StartFrameGrabber().

◆ HidePrimitiveComponent()

void ACamera::HidePrimitiveComponent ( UPrimitiveComponent * PrimitiveComponent )

protected

Definition at line 553 of file Camera.cpp.

{
    if (PrimitiveComponent && CaptureComponent2D)
    {
        CaptureComponent2D->HideComponent(PrimitiveComponent);
    }
}

References CaptureComponent2D.

Referenced by BeginPlay().

◆ Init()

void ACamera::Init	(	FCameraBaseParameters	parameters,
		bool	SimulateSensor = `true`
	)

virtual

Initialize new Camera sensor

Parameters

FCameraBaseParameters CameraParameters struct

Reimplemented in ADepthCamera, ADVSCamera, ASemanticSegmentationCamera, and AThermalCamera.

Definition at line 80 of file Camera.cpp.

{
    CreateDataSavePath();
    SetSimulateSensor(SimulateSensor);
    SetupCamera(parameters);
    CreateLogFile();
}

References ASensor::CreateDataSavePath(), CreateLogFile(), ASensor::SetSimulateSensor(), and SetupCamera().

◆ OnWindowClosed()

void ACamera::OnWindowClosed ( const TSharedRef< SWindow > & Window )

private

On camera window closed event

Parameters

Window reference to SWindow pointer

Definition at line 737 of file Camera.cpp.

{
#if WITH_EDITOR
    UE_LOG(LogTemp, Warning, TEXT("Camera.cpp: Camera window closed. Destroying Camera sensor.."));
#endif
 
    // Broadcast event that this Camera sensor is about be destroyed when user has clicked Window Close button.
    OnCameraWindowClosed.Broadcast(this);
 
    // Destroy this camera sensor
    this->Destroy();
}

References Destroy, and OnCameraWindowClosed.

Referenced by SetupCamera().

◆ PreActorTick()

void ACamera::PreActorTick	(	UWorld *	World,
		ELevelTick	TickType,
		float	DeltaSeconds
	)

protectedvirtual

Definition at line 458 of file Camera.cpp.

{
    TRACE_CPUPROFILER_EVENT_SCOPE(ACamera::PreActorTick);
 
    if (ShouldSimulate(DeltaSeconds) && CaptureComponent2D)
    {
        // Capture scene now.
        // We could use CaptureSceneDeferred but it would not work if World (Spectator) Rendering is disabled.
        CaptureComponent2D->CaptureScene();
 
        if (FrameGrabber.IsValid()) 
        {
            FrameGrabber->CaptureThisFrame(FFramePayloadPtr());
        }
    }
}

References CaptureComponent2D, FrameGrabber, PreActorTick(), and ShouldSimulate().

Referenced by BeginPlay(), and PreActorTick().

◆ ReleaseFrameGrabber()

void ACamera::ReleaseFrameGrabber ( )

private

Release FrameGrabber and destroy UTexture2D

Definition at line 594 of file Camera.cpp.

{
    if (FrameGrabber.IsValid())
    {
        FrameGrabber->StopCapturingFrames();
        FrameGrabber->Shutdown();
        FrameGrabber.Reset();
    }
 
    if (CaptureFrameTexture)
    {
        CaptureFrameTexture->RemoveFromRoot();
        CaptureFrameTexture->ConditionalBeginDestroy();
        CaptureFrameTexture = nullptr;
    }
}

References CaptureFrameTexture, and FrameGrabber.

Referenced by EndPlay(), and StartFrameGrabber().

◆ RemovePostProcessingMaterial()

void ACamera::RemovePostProcessingMaterial ( UMaterial * Material )

Removes a specified post-processing material.

Parameters

Material A pointer to the material to be removed.

Definition at line 71 of file Camera.cpp.

{
    if (CaptureComponent2D)
    {
        FPostProcessSettings& PostProcessSettings = CaptureComponent2D->PostProcessSettings;
        PostProcessSettings.RemoveBlendable(Material);
    }
}

References CaptureComponent2D.

Referenced by ADepthCamera::SetupDepthMaterial().

◆ RemoveWidgetFromWindow()

void ACamera::RemoveWidgetFromWindow ( UWidget * WidgetToRemove )

Remove Widget from custom Unreal Window

Definition at line 758 of file Camera.cpp.

{
    if (UnrealWindow.IsValid() && WidgetToRemove)
    {
        UnrealWindow->RemoveUWidgetFromWindow(WidgetToRemove);
    }
}

References UnrealWindow.

◆ ResizeCamera()

void ACamera::ResizeCamera	(	int	Width = `1280`,
		int	Height = `720`
	)

Resize camera and custom Unreal Window certain size

Definition at line 786 of file Camera.cpp.

{
    if (Width == 0 || Height == 0)
    {
        return;
    }
 
    CameraParameters.Width = Width;
    CameraParameters.Height = Height;
    ChangeCameraParameters(CameraParameters);
}

References CameraParameters, ChangeCameraParameters(), FCameraBaseParameters::Height, and FCameraBaseParameters::Width.

◆ SaveCameraMetaDataToDisk()

void ACamera::SaveCameraMetaDataToDisk ( const FString & ImageName )

protected

Definition at line 707 of file Camera.cpp.

{
    if (!IsValid(LogFile)) 
    {
        // If the log file located in base class is not valid, return here.
        return;
    }
 
    const FVector ActorPosition = GetActorLocation();
    const FRotator ActorRotation = GetActorRotation();
 
    FString MetaData;
 
    if (GeoReferencingSystem)
    {
        FGeographicCoordinates GeoCoordinates = UCoordinateConversionUtilities::UnrealToGeographicCoordinates(GeoReferencingSystem, ActorPosition);
        MetaData = FString::Printf(TEXT("%s, %.2f, %.2f, %.2f, %.2f, %.2f, %.2f, %.6f, %.6f, %.2f"), *ImageName, ActorPosition.X, ActorPosition.Y, ActorPosition.Z,
            ActorRotation.Pitch, ActorRotation.Yaw, ActorRotation.Roll,
            GeoCoordinates.Latitude, GeoCoordinates.Longitude, GeoCoordinates.Altitude);
    }
    else
    {
        MetaData = FString::Printf(TEXT("%s, %.2f, %.2f, %.2f, %.2f, %.2f, %.2f"), *ImageName, ActorPosition.X, ActorPosition.Y, ActorPosition.Z, 
            ActorRotation.Pitch, ActorRotation.Yaw, ActorRotation.Roll);
    }
 
    // Write to the log file (this is written after sensor is destroyed)
    WriteToLogFile(MetaData);
}

References GeoReferencingSystem, ASensor::LogFile, UCoordinateConversionUtilities::UnrealToGeographicCoordinates(), and ASensor::WriteToLogFile().

Referenced by SaveImageToDisk().

◆ SaveCurrentFrameToDisk()

void ACamera::SaveCurrentFrameToDisk ( )

inline

Saves this frame to disk even if CameraParameters.SaveImageToDisk is set to false.

Definition at line 183 of file Camera.h.

    {
        if (!CameraParameters.SaveImageToDisk) 
        {
            SaveCurrentFrameToDiskRequested = true;
        }
    }

Referenced by APhotoCapture::CaptureImages().

◆ SaveImageToDisk()

void ACamera::SaveImageToDisk	(	const TArray< FColor >	FrameBuffer,
		int32	Width,
		int32	Height
	)

protected

Save Image data as png to disk

Parameters

FrameBuffer	Image buffer
width	Image width
height	Image height

Definition at line 666 of file Camera.cpp.

{
    TRACE_CPUPROFILER_EVENT_SCOPE(ACamera::SaveImageToDisk);
 
    if (FrameBuffer.IsEmpty() || Width == 0 || Height == 0)
    {
        return;
    }
 
    int32 Size = Width * Height;
    if (FrameBuffer.Num() != Size) 
    {
        FString Msg = "Camera sensor: Unable to save Image to disk. FrameBuffer size and resolution don't match!";
        SimulatorLog::Log(Msg);
        return;
    }
 
    FString ImageName = FString::Printf(TEXT("image_%d.png"), ImageNumber);
    FString fullFileName = FString::Printf(TEXT("%s%s"), *FileSavePath, *ImageName);
    ++ImageNumber;
 
    SaveCameraMetaDataToDisk(ImageName);
 
    FIntPoint DestSize(Width, Height);
    TImagePixelData<FColor> PixelData(DestSize);
    PixelData.Pixels = FrameBuffer;
 
    // Create ImageTask
    TUniquePtr<FImageWriteTask> ImageTask = MakeUnique<FImageWriteTask>();
    ImageTask->PixelData = MakeUnique<TImagePixelData<FColor>>(PixelData);
    ImageTask->Filename = fullFileName;
    ImageTask->Format = EImageFormat::PNG;
    ImageTask->CompressionQuality = (int32)EImageCompressionQuality::Default;
    ImageTask->bOverwriteFile = true;
    ImageTask->PixelPreProcessors.Add(TAsyncAlphaWrite<FColor>(255));
 
    // Get Screenshot config and enqueue image save task
    FHighResScreenshotConfig& HighResScreenshotConfig = GetHighResScreenshotConfig();
    TFuture<bool> CompletionFuture = HighResScreenshotConfig.ImageWriteQueue->Enqueue(MoveTemp(ImageTask));
}

References ASensor::FileSavePath, ImageNumber, SimulatorLog::Log(), SaveCameraMetaDataToDisk(), and SaveImageToDisk().

Referenced by FrameGrabberCapture(), and SaveImageToDisk().

◆ SendImageDataToROS()

void ACamera::SendImageDataToROS	(	const TArray< FColor > &	FrameBuffer,
		int32	Width,
		int32	Height
	)

protectedvirtual

Construct ROS Image msg and send data to ROS topic

Parameters

FrameBuffer	Pixel array
width	Image width
height	Image height

Definition at line 611 of file Camera.cpp.

{
    TRACE_CPUPROFILER_EVENT_SCOPE(ACamera::SendImageDataToROS);
 
    UTopic* Topic = GetROSTopic();
    if (!SendDataToROS
        || !Topic
        || !IsROSConnected()
        || FrameBuffer.IsEmpty()
        || !ImageMsg.IsValid())
    {
        return;
    }
 
    ImageMsg->height = Height;
    ImageMsg->width = Width;
 
    // Cast TArray<FColor> into uint8[] data with all channels (RBGA)
    // Currently not in use but left here incase this is ever needed again.
    //ImageMsg->encoding = "bgra8";
    //ImageMsg->step = Width * 4;
    //ImageMsg->data = const_cast<uint8*>(reinterpret_cast<const uint8*>(FrameBuffer.GetData()));
 
    // Convert TArray<FColor> to uint8[] data without alpha channel
    // By removing alpha channel, we reduce ~25% of ROS bandwidth, 
    // but costs a bit more in processing time here
    const int32 BufferSize = Width * Height * 3;
    if (!BGR8Buffer || CurrentBufferSize != BufferSize)
    {
        // Resize buffer if needed
        delete[] BGR8Buffer;
        BGR8Buffer = new uint8[BufferSize];
        CurrentBufferSize = BufferSize;
    }
 
    uint8* Dest = BGR8Buffer;
 
    const FColor* Source = FrameBuffer.GetData();
    const int32 PixelCount = FrameBuffer.Num();
 
    for (int32 i = 0; i < PixelCount; ++i)
    {
        const FColor& Pixel = Source[i];
        *Dest++ = Pixel.B;
        *Dest++ = Pixel.G;
        *Dest++ = Pixel.R;
    }
 
    ImageMsg->step = Width * 3;
    ImageMsg->data = BGR8Buffer;
 
    // Send Image to ROS
    Topic->Publish(ImageMsg);
}

References BGR8Buffer, CurrentBufferSize, ASensor::GetROSTopic(), ImageMsg, ASensor::IsROSConnected(), ASensor::SendDataToROS, and SendImageDataToROS().

Referenced by FrameGrabberCapture(), and SendImageDataToROS().

◆ SetShadowRendering()

void ACamera::SetShadowRendering ( bool RenderShadows )

Set should this camera USceneCaptureComponent2D render shadows

Definition at line 766 of file Camera.cpp.

{
    if (CaptureComponent2D)
    {
        auto& CameraShowFlags = CaptureComponent2D->ShowFlags;
        CameraShowFlags.SetDynamicShadows(RenderShadows);
        CameraShowFlags.SetContactShadows(RenderShadows);
        CameraShowFlags.SetCapsuleShadows(RenderShadows);
    }
}

References CaptureComponent2D.

Referenced by ADepthCamera::Init(), ASemanticSegmentationCamera::Init(), and AThermalCamera::Init().

◆ SetTemporalAA()

void ACamera::SetTemporalAA ( bool SetTemporal )

Set USceneCaptureComponent2D TemporalAA on or off.

Definition at line 777 of file Camera.cpp.

{
    if (CaptureComponent2D) 
    {
        auto& CameraShowFlags = CaptureComponent2D->ShowFlags;
        CameraShowFlags.SetTemporalAA(SetTemporal);
    }
}

References CaptureComponent2D.

Referenced by SetupCamera().

◆ SetupCamera()

void ACamera::SetupCamera ( FCameraBaseParameters parameters )

private

Setup all needed things to make Camera operate.

Definition at line 124 of file Camera.cpp.

{
    if (!CaptureComponent2D)
    {
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("Camera.cpp: CaptureComponent2D is nullptr!"));
#endif
        return;
    }
 
    CameraParameters = parameters;
 
    SendDataToROS = CameraParameters.SendDataToROS;
 
    if (CameraParameters.TargetFrameRate != 0.0f)
    {
        CameraFrameRate = 1.0f / CameraParameters.TargetFrameRate;
    }
 
    const bool UsePostProcessingEffects = CameraParameters.PostProcessingEffects;
    auto& PostProcessSettings = CaptureComponent2D->PostProcessSettings;
 
    if (parameters.UsePhysicLensDistortionEffect)
    {
        if (!PhysicLensDistortion.IsValid())
        {
            const FString Path = "/Game/Agrarsense/Materials/PostProcessingMaterials/PhysicLensDistortion.PhysicLensDistortion";
            PhysicLensDistortion = Cast<UMaterial>(StaticLoadObject(UMaterial::StaticClass(), nullptr, *Path));
 
            if (PhysicLensDistortion.IsValid())
            {
                PostProcessSettings.AddBlendable(PhysicLensDistortion.Get(), 1.0f);
#if WITH_EDITOR
                UE_LOG(LogTemp, Warning, TEXT("Camera.cpp: Added physics lens distortion effect."));
#endif
            }
        }
    }
    else if (PhysicLensDistortion.IsValid())
    {
        PostProcessSettings.RemoveBlendable(PhysicLensDistortion.Get());
        PhysicLensDistortion.Reset();
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("Camera.cpp: Removed physics lens distortion effect."));
#endif
    }
 
    if (parameters.UseIceLensEffect)
    {
        if (!IceMaterialInstance.IsValid())
        {
            const FString Path = "/Game/Agrarsense/Materials/PostProcessingMaterials/CameraPostProcessEffects/m_ice_lens_effect";
            UMaterial* LoadedIceMaterial = Cast<UMaterial>(StaticLoadObject(UMaterial::StaticClass(), nullptr, *Path));
 
            // Create UMaterialInstanceDynamic from LoadedIceMaterial
            IceMaterialInstance = UMaterialInstanceDynamic::Create(LoadedIceMaterial, nullptr);
            if (IceMaterialInstance.IsValid())
            {
                // Add material to CaptureComponent2D PostProcessSettings 
                PostProcessSettings.AddBlendable(IceMaterialInstance.Get(), 1.0f);
#if WITH_EDITOR
                UE_LOG(LogTemp, Warning, TEXT("Camera.cpp: Added ice lens effect."));
#endif
            }
        }
 
        UMaterialInstanceDynamic* IceMatInstance = IceMaterialInstance.Get();
        if (IceMatInstance)
        {
            // Set IceMaterialInstance scalar parameters values
            IceMatInstance->SetScalarParameterValue(FName("Strength"), parameters.IceLensEffectStrength);
            IceMatInstance->SetScalarParameterValue(FName("Angle"), parameters.IceLensEffectAngle);
#if WITH_EDITOR
            UE_LOG(LogTemp, Warning, TEXT("Camera.cpp: Changed ice lens effect parameters."));
#endif
        }
    }
    else if (IceMaterialInstance.IsValid())
    {
        UMaterialInstanceDynamic* IceMatInstance = IceMaterialInstance.Get();
        if (IceMatInstance)
        {
            // Remove material from CaptureComponent2D PostProcessSettings
            PostProcessSettings.RemoveBlendable(IceMatInstance);
            IceMaterialInstance.Reset();
 
#if WITH_EDITOR
            UE_LOG(LogTemp, Warning, TEXT("Camera.cpp: Removed ice lens effect."));
#endif
        }
    }
 
    ImageWidth = CameraParameters.Width;
    ImageHeight = CameraParameters.Height;
    const float TargetGamma = CameraParameters.TargetGamma;
    const bool Enable16BitFormat = CameraParameters.Enable16BitFormat;
 
    CaptureRenderTarget->InitCustomFormat(ImageWidth, ImageHeight, Enable16BitFormat ? PF_FloatRGB : PF_B8G8R8A8, !UsePostProcessingEffects);
 
    CaptureRenderTarget->TargetGamma = TargetGamma;
 
    // Set PostProcessSettings override (on or off)
    PostProcessSettings.bOverride_AutoExposureMethod = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AutoExposureBias = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AutoExposureMinBrightness = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AutoExposureMaxBrightness = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AutoExposureSpeedUp = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AutoExposureSpeedDown = UsePostProcessingEffects;
    PostProcessSettings.bOverride_HistogramLogMin = UsePostProcessingEffects;
    PostProcessSettings.bOverride_HistogramLogMax = UsePostProcessingEffects;
    PostProcessSettings.bOverride_CameraShutterSpeed = UsePostProcessingEffects;
    PostProcessSettings.bOverride_CameraISO = UsePostProcessingEffects;
    PostProcessSettings.bOverride_DepthOfFieldFstop = UsePostProcessingEffects;
    PostProcessSettings.bOverride_DepthOfFieldMinFstop = UsePostProcessingEffects;
    PostProcessSettings.bOverride_DepthOfFieldBladeCount = UsePostProcessingEffects;
    PostProcessSettings.bOverride_FilmSlope = UsePostProcessingEffects;
    PostProcessSettings.bOverride_FilmToe = UsePostProcessingEffects;
    PostProcessSettings.bOverride_FilmShoulder = UsePostProcessingEffects;
    PostProcessSettings.bOverride_FilmWhiteClip = UsePostProcessingEffects;
    PostProcessSettings.bOverride_FilmBlackClip = UsePostProcessingEffects;
    PostProcessSettings.bOverride_MotionBlurAmount = UsePostProcessingEffects;
    PostProcessSettings.bOverride_MotionBlurMax = UsePostProcessingEffects;
    PostProcessSettings.bOverride_MotionBlurPerObjectSize = UsePostProcessingEffects;
    PostProcessSettings.bOverride_WhiteTemp = UsePostProcessingEffects;
    PostProcessSettings.bOverride_WhiteTint = UsePostProcessingEffects;
    PostProcessSettings.bOverride_ColorContrast = UsePostProcessingEffects;
    PostProcessSettings.bOverride_SceneFringeIntensity = UsePostProcessingEffects;
    PostProcessSettings.bOverride_ChromaticAberrationStartOffset = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AmbientOcclusionIntensity = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AmbientOcclusionRadius = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AmbientOcclusionStaticFraction = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AmbientOcclusionFadeDistance = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AmbientOcclusionPower = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AmbientOcclusionBias = UsePostProcessingEffects;
    PostProcessSettings.bOverride_AmbientOcclusionQuality = UsePostProcessingEffects;
    PostProcessSettings.bOverride_BloomMethod = UsePostProcessingEffects;
    PostProcessSettings.bOverride_BloomIntensity = UsePostProcessingEffects;
    PostProcessSettings.bOverride_BloomThreshold = UsePostProcessingEffects;
    PostProcessSettings.bOverride_LensFlareIntensity = UsePostProcessingEffects;
    PostProcessSettings.bOverride_DepthOfFieldFocalDistance = UsePostProcessingEffects;
    PostProcessSettings.bOverride_DepthOfFieldDepthBlurAmount = UsePostProcessingEffects;
    PostProcessSettings.bOverride_DepthOfFieldDepthBlurRadius = UsePostProcessingEffects;
 
    // Set PostProcessSettings values
    PostProcessSettings.CameraShutterSpeed = CameraParameters.ShutterSpeed;
    PostProcessSettings.CameraISO = CameraParameters.ISO;
    PostProcessSettings.DepthOfFieldFstop = CameraParameters.Aperture;
    PostProcessSettings.DepthOfFieldFocalDistance = CameraParameters.FocalDistance;
    PostProcessSettings.DepthOfFieldDepthBlurAmount = CameraParameters.DepthBlurAmount;
    PostProcessSettings.DepthOfFieldDepthBlurRadius = CameraParameters.DepthBlurRadius;
    PostProcessSettings.DepthOfFieldMinFstop = CameraParameters.DofMinFStop;
    PostProcessSettings.DepthOfFieldBladeCount = CameraParameters.DofBladeCount;
    PostProcessSettings.FilmSlope = CameraParameters.FilmSlope;
    PostProcessSettings.FilmToe = CameraParameters.FilmToe;
    PostProcessSettings.FilmShoulder = CameraParameters.FilmShoulder;
    PostProcessSettings.FilmBlackClip = CameraParameters.FilmBlackClip;
    PostProcessSettings.FilmWhiteClip = CameraParameters.FilmWhiteClip;
    PostProcessSettings.AutoExposureMinBrightness = CameraParameters.ExposureMinBrightness;
    PostProcessSettings.AutoExposureMaxBrightness = CameraParameters.ExposureMaxBrightness;
    PostProcessSettings.AutoExposureSpeedUp = CameraParameters.ExposureSpeedUp;
    PostProcessSettings.AutoExposureSpeedDown = CameraParameters.ExposureSpeedDown;
    PostProcessSettings.MotionBlurAmount = CameraParameters.MotionBlurIntensity;
    PostProcessSettings.MotionBlurMax = CameraParameters.MotionBlurMax;
    PostProcessSettings.MotionBlurPerObjectSize = CameraParameters.MotionBlurMinObjSize;
    PostProcessSettings.LensFlareIntensity = CameraParameters.LensFlareIntensity;
    PostProcessSettings.BloomIntensity = CameraParameters.BloomIntensity;
    PostProcessSettings.WhiteTemp = CameraParameters.WhiteTemp;
    PostProcessSettings.WhiteTint = CameraParameters.WhiteTint;
    PostProcessSettings.SceneFringeIntensity = CameraParameters.ChromAberrIntensity;
    PostProcessSettings.ChromaticAberrationStartOffset = CameraParameters.ChromAberrOffset;
 
    CaptureComponent2D->FOVAngle = CameraParameters.FOV;
    CaptureComponent2D->TextureTarget = CaptureRenderTarget;
 
    if (CameraParameters.UseHDR && GetSensorType() == ESensorTypes::RGBCamera)
    {
        // Enable HDR on CaptureSource, only allowed for RGB Camera for now.
        CaptureComponent2D->CaptureSource = ESceneCaptureSource::SCS_FinalColorHDR;
    }
    else 
    {
        CaptureComponent2D->CaptureSource = ESceneCaptureSource::SCS_FinalColorLDR;
    }
 
    CaptureComponent2D->bUseRayTracingIfEnabled = true;
    CaptureComponent2D->UpdateContent();
    CaptureComponent2D->Activate();
 
    SetTemporalAA(CameraParameters.UseTemporalAA);
 
    FString Encoding = "bgr8";
 
    // Create ROS Image message
    ImageMsg.Reset();
    ImageMsg = MakeShared<ROSMessages::sensor_msgs::Image>();
    ImageMsg->header.frame_id = "world";
    ImageMsg->height = ImageWidth;
    ImageMsg->width = ImageHeight;
    ImageMsg->encoding = Encoding;
    ImageMsg->is_bigendian = 0;
    ImageMsg->step = ImageWidth * 4;
 
    CreateROSTopic();
 
    if (!UnrealWindow.IsValid())
    {
        // Create and setup UnrealWindow
        FString windowName = GetSensorIdentifier() + " Window";
        UnrealWindow = MakeShareable(new FUnrealWindow(ImageWidth, ImageHeight, windowName));
 
        // Set on Window closed event
        OnWindowClosedDelegate.BindUObject(this, &ACamera::OnWindowClosed);
        UnrealWindow->GetSWindow()->SetOnWindowClosed(OnWindowClosedDelegate);
 
        // try to create Camera parameter Widget from path
        FSoftClassPath WidgetClassPath(TEXT("/Game/Agrarsense/Widgets/Camera/WBP_CameraControlsMenu.WBP_CameraControlsMenu_C"));
        UClass* WidgetClass = WidgetClassPath.TryLoadClass<UUserWidget>();
 
        APlayerController* PlayerController = UGameplayStatics::GetPlayerController(GetWorld(), 0);
 
        if (WidgetClass && PlayerController)
        {
            UCameraWidgetBase* WidgetInstance = CreateWidget<UCameraWidgetBase>(PlayerController, WidgetClass);
            if (WidgetInstance)
            {
                bool ShowGuide = false;
                WidgetInstance->Setup(this, ShowGuide);
                this->AddWidgetToWindow(WidgetInstance);
            }
        }
    }
 
    bool Resized = false;
    if (UnrealWindow.IsValid())
    {
        UnrealWindow->SetupComponent(CaptureRenderTarget);
        if (UnrealWindow->GetWindowWidth() != ImageWidth || UnrealWindow->GetWindowHeight() != ImageHeight)
        {
            UnrealWindow->ResizeWindow(ImageWidth, ImageHeight);
            Resized = true;
        }
    }
 
    StartFrameGrabber();
 
    if (Resized)
    {
        OnCameraWindowResized.Broadcast(this, CameraParameters);
    }
}

Referenced by ChangeCameraParameters(), and Init().

◆ ShouldSimulate()

bool ACamera::ShouldSimulate ( const float DeltaSeconds )

private

Should this camera sensor be simulated this frame

Definition at line 485 of file Camera.cpp.

{
    if (!CanSimulateSensor())
    {
        ShouldSimulateCamera = false;
        return ShouldSimulateCamera;
    }
 
    if (CameraParameters.TargetFrameRate == 0.0f)
    {
        ShouldSimulateCamera = true;
        return ShouldSimulateCamera;
    }
 
    FrameRateTimer += DeltaSeconds;
    if (FrameRateTimer >= CameraFrameRate)
    {
        FrameRateTimer = 0.0f;
        ShouldSimulateCamera = true;
        return ShouldSimulateCamera;
    }
 
    ShouldSimulateCamera = false;
 
    return ShouldSimulateCamera;
}

References CameraFrameRate, CameraParameters, ASensor::CanSimulateSensor(), FrameRateTimer, ShouldSimulateCamera, and FCameraBaseParameters::TargetFrameRate.

Referenced by PreActorTick().

◆ StartFrameGrabber()

void ACamera::StartFrameGrabber ( )

private

Setup and start FrameGrabber

Definition at line 561 of file Camera.cpp.

{
    if (!UnrealWindow.IsValid())
    {
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("Camera.cpp: UnrealWindow is nullptr!"));
#endif
        return;
    }
 
    // Destroy old FrameGrabber
    ReleaseFrameGrabber();
 
    // Get SceneViewport TSharedPtr
    auto SceneViewport = UnrealWindow->GetSceneViewport();
 
    if (SceneViewport.IsValid() && CaptureRenderTarget)
    {
        EPixelFormat PixelFormat = GetPixelFormatFromRenderTargetFormat(TextureFormat);
        FIntPoint Size = SceneViewport->GetSize();
 
        if (GetSensorType() == ESensorTypes::DVSCamera)
        {
            // Currently only DVS camera needs this texture to render DVS output into separate FUnrealWindow.
            CaptureFrameTexture = UTexture2D::CreateTransient(Size.X, Size.Y, PixelFormat);
            CaptureFrameTexture->UpdateResource();
        }
 
        FrameGrabber = MakeShareable(new FFrameGrabber(SceneViewport.ToSharedRef(), Size, PixelFormat));
        FrameGrabber->StartCapturingFrames();
    }
}

References CaptureFrameTexture, CaptureRenderTarget, DVSCamera, FrameGrabber, GetSensorType(), ReleaseFrameGrabber(), TextureFormat, and UnrealWindow.

Referenced by SetupCamera().

Member Data Documentation

◆ BGR8Buffer

uint8* ACamera::BGR8Buffer = nullptr

private

Definition at line 358 of file Camera.h.

Referenced by EndPlay(), and SendImageDataToROS().

◆ CameraFrameRate

float ACamera::CameraFrameRate = 0.0f

private

Definition at line 353 of file Camera.h.

Referenced by SetupCamera(), and ShouldSimulate().

◆ CameraName

FString ACamera::CameraName = "Camera "

protected

Camera title name for the new Unreal Window For example: "Camera 2 Window" or "ThermalCamera 1 Window" Accessible in inherited classes.

Definition at line 262 of file Camera.h.

Referenced by ADepthCamera::Init(), ADVSCamera::Init(), ASemanticSegmentationCamera::Init(), and AThermalCamera::Init().

◆ CameraParameters

FCameraBaseParameters ACamera::CameraParameters

private

Current Camera parameters.

Definition at line 329 of file Camera.h.

Referenced by FrameGrabberCapture(), ResizeCamera(), SetupCamera(), and ShouldSimulate().

◆ CaptureComponent2D

USceneCaptureComponent2D* ACamera::CaptureComponent2D = nullptr

protected

Definition at line 270 of file Camera.h.

Referenced by ACamera(), AddPostProcessingMaterial(), EndPlay(), HidePrimitiveComponent(), PreActorTick(), RemovePostProcessingMaterial(), SetShadowRendering(), SetTemporalAA(), and SetupCamera().

◆ CaptureFrameTexture

UTexture2D* ACamera::CaptureFrameTexture

protected

public UTexture2D variable pointer BlueprintReadOnly.

Definition at line 277 of file Camera.h.

Referenced by ReleaseFrameGrabber(), StartFrameGrabber(), and ADVSCamera::UpdateDVSWindowOutput().

◆ CaptureRenderTarget

UTextureRenderTarget2D* ACamera::CaptureRenderTarget = nullptr

protected

Definition at line 267 of file Camera.h.

Referenced by ACamera(), EndPlay(), SetupCamera(), and StartFrameGrabber().

◆ CurrentBufferSize

int32 ACamera::CurrentBufferSize = 0

private

Definition at line 360 of file Camera.h.

Referenced by EndPlay(), and SendImageDataToROS().

◆ FilePrefix

FString ACamera::FilePrefix = "Data/Camera_"

protected

Definition at line 264 of file Camera.h.

Referenced by ADepthCamera::Init(), ADVSCamera::Init(), ASemanticSegmentationCamera::Init(), and AThermalCamera::Init().

◆ FrameGrabber

TSharedPtr<FFrameGrabber> ACamera::FrameGrabber

private

FrameGrabber TSharedPtr

Definition at line 313 of file Camera.h.

Referenced by FrameGrabberCapture(), PreActorTick(), ReleaseFrameGrabber(), and StartFrameGrabber().

◆ FrameRateTimer

float ACamera::FrameRateTimer = 0.0f

private

Definition at line 354 of file Camera.h.

Referenced by ShouldSimulate().

◆ GeoReferencingSystem

AGeoReferencingSystem* ACamera::GeoReferencingSystem = nullptr

private

Definition at line 338 of file Camera.h.

Referenced by CreateLogFile(), and SaveCameraMetaDataToDisk().

◆ IceMaterialInstance

TWeakObjectPtr<UMaterialInstanceDynamic> ACamera::IceMaterialInstance

protected

Definition at line 283 of file Camera.h.

Referenced by EndPlay(), and SetupCamera().

◆ ImageHeight

int ACamera::ImageHeight = 720

private

Definition at line 347 of file Camera.h.

Referenced by FrameGrabberCapture(), and SetupCamera().

◆ ImageMsg

TSharedPtr<ROSMessages::sensor_msgs::Image> ACamera::ImageMsg

private

Definition at line 344 of file Camera.h.

Referenced by EndPlay(), SendImageDataToROS(), and SetupCamera().

◆ ImageNumber

int ACamera::ImageNumber = 0

private

Definition at line 356 of file Camera.h.

Referenced by SaveImageToDisk().

◆ ImageWidth

int ACamera::ImageWidth = 1280

private

Definition at line 346 of file Camera.h.

Referenced by FrameGrabberCapture(), and SetupCamera().

◆ OnCameraWindowClosed

FCameraDelegate_OnWindowClosed ACamera::OnCameraWindowClosed

On Camera sensor destroyed event. BlueprintAssignable.

Returns: ACamera pointer

Definition at line 140 of file Camera.h.

Referenced by OnWindowClosed().

◆ OnCameraWindowResized

FCameraDelegate_OnWindowResized ACamera::OnCameraWindowResized

On Camera sensor window resized event. BlueprintAssignable.

Returns: ACamera pointer

Definition at line 147 of file Camera.h.

Referenced by ADVSCamera::EndPlay(), ADVSCamera::Init(), and SetupCamera().

◆ OnPostTickDelegate

FDelegateHandle ACamera::OnPostTickDelegate

protected

Definition at line 225 of file Camera.h.

Referenced by BeginPlay(), and EndPlay().

◆ OnPreTickDelegate

FDelegateHandle ACamera::OnPreTickDelegate

protected

Definition at line 222 of file Camera.h.

Referenced by BeginPlay(), and EndPlay().

◆ OnWindowClosedDelegate

FOnWindowClosed ACamera::OnWindowClosedDelegate

private

Definition at line 342 of file Camera.h.

Referenced by EndPlay(), and SetupCamera().

◆ ParametersChanged

bool ACamera::ParametersChanged = false

private

Definition at line 340 of file Camera.h.

◆ PhysicLensDistortion

TWeakObjectPtr<UMaterial> ACamera::PhysicLensDistortion

protected

Definition at line 285 of file Camera.h.

Referenced by SetupCamera().

◆ SaveCurrentFrameToDiskRequested

bool ACamera::SaveCurrentFrameToDiskRequested = false

private

Definition at line 349 of file Camera.h.

Referenced by FrameGrabberCapture().

◆ ShouldSimulateCamera

bool ACamera::ShouldSimulateCamera = true

private

Definition at line 351 of file Camera.h.

Referenced by FrameGrabberCapture(), and ShouldSimulate().

◆ TempParams

FCameraBaseParameters ACamera::TempParams

private

Definition at line 335 of file Camera.h.

◆ TextureFormat

TEnumAsByte<ETextureRenderTargetFormat> ACamera::TextureFormat = ETextureRenderTargetFormat::RTF_RGBA8

public TEnumAsByte<ETextureRenderTargetFormat> variable BlueprintReadOnly.

Definition at line 133 of file Camera.h.

Referenced by StartFrameGrabber().

◆ TickEntry

FTickEntry ACamera::TickEntry

protected

Definition at line 281 of file Camera.h.

Referenced by BeginPlay(), and EndPlay().

◆ UnrealWindow

TSharedPtr<FUnrealWindow> ACamera::UnrealWindow

protected

Definition at line 279 of file Camera.h.

Referenced by AddWidgetToWindow(), EndPlay(), ADVSCamera::Init(), RemoveWidgetFromWindow(), SetupCamera(), and StartFrameGrabber().

◆ UseParallelLateTick

bool ACamera::UseParallelLateTick = true

protected

Definition at line 220 of file Camera.h.

Referenced by ADVSCamera::ADVSCamera(), BeginPlay(), and EndPlay().

The documentation for this class was generated from the following files:

Unreal/Agrarsense/Source/Agrarsense/Sensor/Camera/Camera.h
Unreal/Agrarsense/Source/Agrarsense/Sensor/Camera/Camera.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ACamera()

Member Function Documentation

◆ AddPostProcessingMaterial()

◆ AddProcessingToFrameBuffer()

◆ AddWidgetToWindow()

◆ BeginPlay()

◆ ChangeCameraParameters()

◆ CreateLogFile()

◆ EndOfFrame()

◆ EndOfFrameParellel()

◆ EndPlay()

◆ FrameGrabberCapture()

◆ GetCameraHeight()

◆ GetCameraParameters()

◆ GetCameraWidth()

◆ GetCaptureComponent2D()

◆ GetCaptureRenderTarget2D()

◆ GetParametersAsString()

◆ GetSensorType()

◆ HidePrimitiveComponent()

◆ Init()

◆ OnWindowClosed()

◆ PreActorTick()

◆ ReleaseFrameGrabber()

◆ RemovePostProcessingMaterial()

◆ RemoveWidgetFromWindow()

◆ ResizeCamera()

◆ SaveCameraMetaDataToDisk()

◆ SaveCurrentFrameToDisk()

◆ SaveImageToDisk()

◆ SendImageDataToROS()

◆ SetShadowRendering()

◆ SetTemporalAA()

◆ SetupCamera()

◆ ShouldSimulate()

◆ StartFrameGrabber()

Member Data Documentation

◆ BGR8Buffer

◆ CameraFrameRate

◆ CameraName

◆ CameraParameters

◆ CaptureComponent2D

◆ CaptureFrameTexture

◆ CaptureRenderTarget

◆ CurrentBufferSize

◆ FilePrefix

◆ FrameGrabber

◆ FrameRateTimer

◆ GeoReferencingSystem

◆ IceMaterialInstance

◆ ImageHeight

◆ ImageMsg

◆ ImageNumber

◆ ImageWidth

◆ OnCameraWindowClosed

◆ OnCameraWindowResized

◆ OnPostTickDelegate

◆ OnPreTickDelegate

◆ OnWindowClosedDelegate

◆ ParametersChanged

◆ PhysicLensDistortion

◆ SaveCurrentFrameToDiskRequested

◆ ShouldSimulateCamera

◆ TempParams

◆ TextureFormat

◆ TickEntry

◆ UnrealWindow

◆ UseParallelLateTick