Class PathtracedSensingComponent

This class implement the sensing part of the photosensor.

Limitations One must know that the current implementation of the photosensor uses dx12 and DXR API through unity interfaces to measure the scene. For this reason, SensorSDK requires hardware that supports DXR to work. Otherwise, the user will experience no output coming from the photosensor.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
PhotosensorSensingComponent
PathtracedSensingComponent
Inherited Members
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
Namespace: Mechatronics.SensorSDK
Syntax
[Serializable]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.sensorsdk@1.0/manual/DeveloperGuide/BeamDivergence.html")]
public class PathtracedSensingComponent : PhotosensorSensingComponent

Fields

spp

Amount of samples to take to measure intensity. If this is less than or equal to one we will use a biased output(tracing only the center ray). Lower values result in better performance

Declaration
[Tooltip("Number of samples per taken around the beam direction to measure intensity. Higher values increase quality at the cost of performance, when this value is exactly 1, we use only the center ray, giving a biased but non noisy result.")]
public int spp
Field Value
Type Description
Int32

Methods

Activate(PhotosensorData, Action<CustomPassContext, PhotosensorOutputBuffer>)

Initializes the sensing component.

Declaration
public override void Activate(PhotosensorData photosensorData, Action<CustomPassContext, PhotosensorOutputBuffer> callback)
Parameters
Type Name Description
PhotosensorData photosensorData

Information define on the photosensor node.
Action<CustomPassContext, PhotosensorOutputBuffer> callback

Provides a callback to invoke when the scene sampling is completed.
Overrides

Deactivate()

Releases the sampler and other GPU resources.

Declaration
public override void Deactivate()
Overrides

ExecuteSampling(CustomPassContext, RayTracingAccelerationStructure, ref UInt32)

Call a path tracing process on the GPU to execute the sampling request sent through samplingRequest input port.

Declaration
public void ExecuteSampling(CustomPassContext ctx, RayTracingAccelerationStructure accelerationStructure, ref uint sampleIndex)
Parameters
Type Name Description
CustomPassContext ctx

Custom pass context.
RayTracingAccelerationStructure accelerationStructure

Acceleration structure
UInt32 sampleIndex

sample index

UpdateSamplingOffsets(List<OrientedPoint>)

Updates the sensing component with new sampling offsets.

Declaration
public override void UpdateSamplingOffsets(List<OrientedPoint> samplingOffsets)
Parameters
Type Name Description
List<OrientedPoint> samplingOffsets

The sampling offsets to update the sensing component with.
Overrides