DOTS 학습을 위한 기초 정리 #15 엔티티 데이터 접근 - IJobForEach

참고문헌 : https://docs.unity3d.com/Packages/com.unity.entities@0.0/manual/entity_iteration_job.html

Using IJobForEach | Package Manager UI website

Using IJobForEach

JobComponentSystem의 IJobForEach를 이용해 작업을 정의하여 구성 요소 데이터를 읽고 쓸 수 있습니다.

 

작업이 실행되면 ECS 프레임 워크는 필요한 구성 요소가있는 모든 엔티티를 찾고 각각에 대해 작업의 Execute () 함수를 호출합니다. 데이터는 메모리에 배치 된 순서대로 처리되고 Job은 병렬로 실행되므로 IJobForEach단순성과 효율성 이 결합됩니다.

 

다음 예제에서는 IJobForEach을 사용하는 간단한 시스템을 보여줍니다. 작업은 RotationSpeed 구성 요소를 읽고 RotationQuaternion 구성 요소에 씁니다.

public class RotationSpeedSystem : JobComponentSystem
{
   // Use the [BurstCompile] attribute to compile a job with Burst.
   [BurstCompile]
   struct RotationSpeedJob : IJobForEach<RotationQuaternion, RotationSpeed>
   {
       public float DeltaTime;
       // The [ReadOnly] 속성은 Job Scheduler에게 이 작업이 rotSpeed에 쓰이지 않음을 알려줌
       public void Execute(ref RotationQuaternion rotationQuaternion, [ReadOnly] ref RotationSpeed rotSpeed)
       {
           // RotationSpeed에 의해 주어진 속도로 상단 벡터를 축으로 회전시킨다.  
           rotationQuaternion.Value = math.mul(math.normalize(rotationQuaternion.Value), quaternion.AxisAngle(math.up(), rotSpeed.RadiansPerSecond * DeltaTime));
       }
   }

// OnUpdate runs on the main thread.
// 이전에 예약된 모든 작업 읽기/쓰기 또는 회전 속도 쓰기
// 는 자동으로 inputDependencies에 포함된다.
protected override JobHandle OnUpdate(JobHandle inputDependencies)
   {
       var job = new RotationSpeedJob()
       {
           DeltaTime = Time.deltaTime
       };
       return job.Schedule(this, inputDependencies);
   }
}

참고 : 위의 시스템은 ECS 샘플 저장소 의 HelloCube IJobForEach 샘플을 기반으로 합니다 .

Defining the IJobForEach signature

IJobForEach시스템에서 작동하는 구성 요소 구조체 서명 식별 :

 

struct RotationSpeedJob : IJobForEach<RotationQuaternion, RotationSpeed>

다음 속성을 사용하여 작업이 선택하는 항목을 수정할 수도 있습니다.

• [ExcludeComponent (typeof (T)] - Archetype에 T 유형의 구성 요소가 포함 된 엔티티를 제외합니다.
• [RequireComponentTag (typeof (T)] - Archetype에 T 유형의 구성 요소가 포함 된 엔티티 만 포함합니다. 시스템이 여전히 엔티티와 연관되어야하는 구성 요소를 읽거나 쓰지 않는 경우이 속성을 사용합니다.

예를 들어, 다음 Job 정의는 Gravity, RotationQuaternion 및 RotationSpeed ​​구성 요소를 포함하지만 Frozen 구성 요소는 포함하지 않는 아키타 입을 가진 엔티티를 선택합니다.

[ExcludeComponent(typeof(Frozen))]
[RequireComponentTag(typeof(Gravity))]
[BurstCompile]
struct RotationSpeedJob : IJobForEach<RotationQuaternion, RotationSpeed>

조작 할 엔터티를 선택하기 위해보다 복잡한 쿼리가 필요한 경우 IJobForEach 대신 IJobChunk 작업을 사용할 수 있습니다.

Writing the Execute() method

JobComponentSystem은 IJobForEach 서명으로 식별되는 구성 요소를 전달하면서 각 적합한 엔터티에 대해 Execute () 메서드를 호출합니다. 따라서 Execute () 함수의 매개 변수는 구조체에 대해 정의한 일반 인수와 일치해야합니다.

예를 들어 다음 Execute () 메서드는 RotationSpeed ​​구성 요소를 읽고 RotationQuaternion 구성 요소를 읽고 씁니다. (읽기 / 쓰기가 기본값이므로 아무 속성도 필요하지 않습니다.)

public void Execute(ref RotationQuaternion rotationQuaternion, [ReadOnly] ref RotationSpeed rotSpeed){}

ECS가 시스템을 최적화하는 데 도움이되도록 함수 매개 변수에 속성을 추가 할 수 있습니다.

• [ReadOnly] - 함수가 읽지 만 쓰지 않는 구성 요소에 사용합니다.
• [WriteOnly] - 함수가 쓰지만 읽지 않는 구성 요소에 사용합니다.
• [ChangeFilter] - 시스템을 마지막으로 실행 한 이후에 구성 요소 값이 변경되었을 수있는 엔티티에서만 함수를 실행하려는 경우에 사용합니다.

읽기 전용 및 쓰기 전용 구성 요소를 식별하면 작업 스케줄러가 작업을 효율적으로 예약 할 수 있습니다. 예를 들어 스케줄러는 해당 구성 요소를 읽는 작업과 동시에 구성 요소에 쓰는 작업을 예약하지 않지만 동일한 구성 요소 만 읽는 경우 두 개의 작업을 병렬로 실행할 수 있습니다.

 

효율성을 위해 변경 필터는 엔티티의 전체 청크에서 작동합니다. 개별 개체를 추적하지 않습니다. 해당 구성 요소 유형에 쓰는 기능이있는 다른 작업에서 청크에 액세스 한 경우 ECS 프레임 워크는 청크가 변경된 것으로 간주하고 작업의 모든 엔티티를 포함합니다. 그렇지 않으면 ECS 프레임 워크는 해당 청크의 엔티티를 완전히 제외합니다.

 

Using IJobForEachWithEntity

IJobForEachWithEntity 인터페이스를 구현하는 작업은 IJobForEach를 구현하는 작업과 거의 동일하게 작동합니다. 차이점은 IJobForEachWithEntity의 Execute () 함수 시그니처가 현재 엔티티에 대한 Entity 개체와 확장 된 병렬 배열에 대한 인덱스를 제공한다는 것입니다.

Using the Entity parameter

Entity 개체를 사용하여 EntityCommandBuffer에 명령을 추가 할 수 있습니다. 예를 들어 경쟁 조건을 피하기 위해 작업 내에서 직접 수행 할 수없는 모든 작업 - 엔티티의 구성 요소를 추가 또는 제거하거나 엔티티를 제거하는 명령을 추가 할 수 있습니다. 명령 버퍼를 사용하면 작업 스레드에서 잠재적으로 값 비싼 계산을 수행 할 수 있으며 나중에 실제 스레드에서 수행 할 실제 삽입 및 삭제를 대기열에 넣을 수 있습니다.

HelloCube SpawnFromEntity 샘플을 기반으로하는 다음 시스템은 명령 버퍼를 사용하여 작업에서 위치를 계산 한 후에 엔티티를 인스턴스화합니다.

public class SpawnerSystem : JobComponentSystem
{
   // EndFrameBarrier provides the CommandBuffer
   EndFrameBarrier m_EndFrameBarrier;

   protected override void OnCreate()
   {
       // Cache the EndFrameBarrier in a field, so we don't have to get it every frame
       m_EndFrameBarrier = World.GetOrCreateSystem<EndFrameBarrier>();
   }
   struct SpawnJob : IJobForEachWithEntity<Spawner, LocalToWorld>
   {
       public EntityCommandBuffer CommandBuffer;
       public void Execute(Entity entity, int index, [ReadOnly] ref Spawner spawner,
           [ReadOnly] ref LocalToWorld location)
       {
           for (int x = 0; x < spawner.CountX; x++)
           {
               for (int y = 0; y < spawner.CountY; y++)
               {
                   var __instance __= CommandBuffer.Instantiate(spawner.Prefab);
                   // Place the instantiated in a grid with some noise
                   var position = math.transform(location.Value,
                       new float3(x * 1.3F, noise.cnoise(new float2(x, y) * 0.21F) * 2, y * 1.3F));
                   CommandBuffer.SetComponent(instance, new Translation {Value = position});
               }
           }
           CommandBuffer.DestroyEntity(entity);
       }
   }

   protected override JobHandle OnUpdate(JobHandle inputDeps)
   {
       // Schedule the job that will add Instantiate commands to the EntityCommandBuffer.
       var job = new SpawnJob
       {
           CommandBuffer = m_EndFrameBarrier.CreateCommandBuffer()
       }.ScheduleSingle(this, inputDeps);

       // We need to tell the barrier system which job it needs to complete before it can play back the commands.
       m_EndFrameBarrier.AddJobHandleForProducer(job);

       return job;
   }
}

참고 : 이 예제에서는 단일 스레드에서 작업을 수행하는 IJobForEach.ScheduleSingle ()을 사용합니다. 대신 Schedule () 메소드를 사용한 경우, 시스템은 병렬 작업을 사용하여 엔티티를 처리합니다. 병행 된 경우에는 동시 엔터티 명령 버퍼 (EntityCommandBuffer.Concurrent)를 사용해야합니다.

전체 예제 소스 코드 는 ECS 샘플 저장소 를 참조하십시오 .

Using the index parameter

동시 명령 버퍼에 명령을 추가 할 때 인덱스를 사용할 수 있습니다. 엔티티를 병렬로 처리하는 작업을 실행할 때 동시 명령 버퍼를 사용합니다. IJobForEachWithEntity 작업에서 Job System은 위 예제에서 사용한 ScheduleSingle () 메서드 대신 Schedule () 메서드를 사용할 때 병렬로 엔터티를 처리합니다. 스레드의 안전성과 버퍼 명령의 결정 론적 실행을 보장하기 위해 동시 작업에는 항상 동시 명령 버퍼를 사용해야합니다.

색인을 사용하여 동일한 시스템 내의 여러 작업에서 동일한 항목을 참조 할 수도 있습니다. 예를 들어 여러 패스에서 엔티티 집합을 처리하고 그 과정에서 임시 데이터를 수집해야하는 경우 인덱스를 사용하여 임시 데이터를 하나의 작업에서 NativeArray에 삽입 한 다음 인덱스를 사용하여 후속 작업. (당연히 두 작업에 동일한 NativeArray를 전달해야합니다.)