Skip to content

IScholaSensor

Interface for sensor components that collect observations from the environment.

This interface provides methods for defining the observation space and collecting observations for reinforcement learning agents. Can be implemented in both C++ and Blueprints.

Subclassed by UCameraSensor, URayCastSensor

class IScholaSensor

Methods

InitSensor

void InitSensor()

Initialize the sensor component.

InitSensor_Implementation

inline virtual void InitSensor_Implementation()

Default implementation of InitSensor (no-op).

GetObservationSpace

void GetObservationSpace(FInstancedStruct &OutObservationSpace) const

Return the sensor definition (the observation space) as an instanced FSpace struct.

Parameters

  • OutObservationSpace (FInstancedStruct)

GetObservationSpace_Implementation

inline virtual void
GetObservationSpace_Implementation(FInstancedStruct &OutObservationSpace) const

Default C++ implementation returns an empty box space.

Parameters

  • OutObservationSpace (FInstancedStruct)

CollectObservations

void CollectObservations(FInstancedStruct &OutObservations)

Collect a single observation from the sensor as an instanced FPoint struct.

Parameters

  • OutObservations (FInstancedStruct)

CollectObservations_Implementation

inline virtual void
CollectObservations_Implementation(FInstancedStruct &OutObservations)

Default C++ implementation returns an empty box point.

Parameters

  • OutObservations (FInstancedStruct)

Execute_GetObservationSpace

static inline void
Execute_GetObservationSpace(const UObject *Obj,
                            TInstancedStruct<FSpace> &OutObservationSpace)

Static helper to execute GetObservationSpace with typed parameters.

Parameters

  • Obj (const UObject)

  • OutObservationSpace (TInstancedStruct<FSpace>)

Execute_CollectObservations

static inline void
Execute_CollectObservations(UObject *Obj,
                            TInstancedStruct<FPoint> &OutObservations)

Static helper to execute CollectObservations with typed parameters.

Parameters

  • Obj (UObject)

  • OutObservations (TInstancedStruct<FPoint>)

Source: Source/ScholaInteractors/Public/SensorInterface.h