粒子发射器技术指南

创建新的发射器类型需要自定义的ParticleEmitterInstance和ParticleModuleTypeData。 这个指南解释了每项内容的关键部分并描述了创建新自定义发射器类型的步骤。

粒子发射器引用

ParticleEmitterInstance变量和函数以及ParticleModuleTypeData类都在此部分中进行了解释。

ParticleEmitterInstance结构体

ParticleEmitterInstance是一个可以代表ParticleSystemComponent中的特效实例的单独粒子发射器。

成员变量

ParticleEmitterInstance结构体包含以下public 变量：

成员函数

ParticleEmitterInstance 结构体可以包含以下成员函数，它们可以提供覆盖基础功能的机会：

ParticleModuleTypeDataBase类

ParticleModuleTypeDataBase 类可以提供在创建一个 ParticleSystem 供在引擎中使用时生成自定义发射器实例的机制。 例如，ParticleModuleTypeDataMesh 类最后结果会为 ParticleSystem 而创建 FParticleMeshEmitterInstance。

成员函数

ParticleModuleTypeDataBase 结构体会包含以下可以协助生成自定义发射器的 public 函数：

示例粒子发射器

编写自定义发射器实例为两步过程。 第一步，需要创建将会为您的发射器实例提供特定数据的 TypeDataModule，并且在适当的时间生成它。 例如，会创建一个发射器实例，它可以不断执行发射器实例以及‘父’粒子系统组件的旋转量。

TypeDataModule声明

第一步是创建会生成新的发射器实例类型的TypeDataModule。

UCLASS(editinlinenew, collapsecategories, hidecategories=Object)
public class UParticleModuleTypeDataSpinner : public UParticleModuleTypeDataBase
{

    /** 

        *  在给定时间要执行发射器实例的数量
        *  （在全部旋转量中）。
        */

    UPROPERTY(Category=Spinner)
    rawdistributionvector Spin;

#if CPP
    /**
    *   创建自定义 ParticleEmitterInstance。
    *
    *   @param  InEmitterParent           UParticleEmitter 可以具有这个 TypeData 模型。
    *   @param  InComponent               UParticleSystemComponent 可以‘拥有’正在进行创建的发射器实例。
    *   @return FParticleEmitterInstance* 创建发射器实例。
    */
    virtual FParticleEmitterInstance*   CreateInstance(UParticleEmitter* InEmitterParent, UParticleSystemComponent* InComponent);
#endif
}       

TypeDataModule的实现

TypeDataModule的构造函数创建UDistributionVectorConstant以指派给Spin变量。

UParticleModuleTypeDataSpinner::UParticleModuleTypeDataSpinner(const FObjectInitializer& ObjectInitializer)
: Super(ObjectInitializer)
{
    UDistributionVectorConstant* DistributionSpin = ConstructorHelpers::CreateDefaultSubobject<UDistributionVectorConstant>(this, TEXT("DistributionSpin"));
    DistributionSpin->Constant = FVector(0.0f, 0.0f, 0.0f);
    Spin.Distribution = DistributionSpin;
}

CreateInstance() 函数将会由具有发射器实例的 ParticleSystemComponent进行调用。 在这里 TypeDataModule 可以创建任何类型的 ParticleEmitterInstance 供系统使用的。

FParticleEmitterInstance* UParticleModuleTypeDataSpinner::CreateInstance(UParticleEmitter* InEmitterParent, UParticleSystemComponent* InComponent)
{
   // 创建我们的 Spinner 发射器实例。
   FParticleSpinnerEmitterInstance* SpinnerInst = ::new FParticleSpinnerEmitterInstance();
   if (SpinnerInst)
   {
      // 初始化发射器的参数。
      SpinnerInst->InitParameters(InEmitterParent, InComponent);
      return SpinnerInst;
   }

   // 如果失败。 会返回 NULL 可以生成默认平面发射器或断言。
   return NULL;
}

在这个示例中，将会生成一个 FParticleSpinnerEmitterInstance 的实例。 它从 FParticleSpriteEmitterInstance 衍生而来，可以尽量多地利用现有代码。

粒子发射器声明

FParticleSpinnerEmitterInstance自定义的发射器实例结构体定义如下：

struct FParticleSpinnerEmitterInstance : public FParticleSpriteEmitterInstance
{
   /** 指向旋转器 TypeDatModule 的指针。         */
   UParticleModuleTypeDataSpinner* SpinnerTypeData;
   /** 在 Tick（更新）调用过程中使用的旋转量。   */
   FVector CurrentRotation;
   /** 分量的旋转量。            */
   FRotator ComponentRotation;

   /** 构造函数   */
   FParticleSpinnerEmitterInstance();

   virtual void InitParameters(UParticleEmitter* InTemplate, UParticleSystemComponent* InComponent, bool bClearResources = true);
   virtual void Tick(float DeltaTime, bool bSuppressSpawning);
   virtual void UpdateBoundingBox(float DeltaTime);

   /**
    *   调整分量旋转量以便将实例旋转量考虑进去。
    */
   void AdjustComponentRotation();
   /**
    *   恢复分量旋转量。
    */
   void RestoreComponentRotation();
};

FParticleSpinnerEmitterInstance 中包含以下成员变量：

粒子发射器实现

为我们的自定义发射器实例执行以下成员函数：

FParticleSpinnerEmitterInstance::FParticleSpinnerEmitterInstance() :
     FParticleSpriteEmitterInstance()
   , SpinnerTypeData(NULL)
{
}

void FParticleSpinnerEmitterInstance::InitParameters(UParticleEmitter* InTemplate, UParticleSystemComponent* InComponent, bool bClearResources)
{
   // 调用超级 InitParameters。
   FParticleEmitterInstance::InitParameters(InTemplate, InComponent, bClearResources);

   // 获取类型数据模块
   UParticleLODLevel* LODLevel   = InTemplate->GetCurrentLODLevel(this);
   check(LODLevel);
   SpinnerTypeData = CastChecked<UParticleModuleTypeDataSpinner>(LODLevel->TypeDataModule);
}

void FParticleSpinnerEmitterInstance::Tick(float DeltaTime, bool bSuppressSpawning)
{
   // 更新我们当前的旋转量
   check(SpinnerTypeData);
   CurrentRotation = SpinnerTypeData->Spin.GetValue(EmitterTime, Component);

   //  调整分量旋转量。
   AdjustComponentRotation();

   // 调用 Tick（更新）超级版。
   FParticleEmitterInstance::Tick(DeltaTime, bSuppressSpawning);

   // 恢复分量旋转量
   RestoreComponentRotation();
}

void FParticleSpinnerEmitterInstance::UpdateBoundingBox(float DeltaTime)
{
    // 不幸的是，我们必须完全覆盖 UpdateBoundingBox 函数才能
    // 确保将我们的旋转量考虑进去...
    // 
    // 除代码的最后一位（考虑 bUseLocalSpace 的地方）以外， 
    // 这个函数等价于 FParticleSpriteEmitterInstance 
    // 版本。
    if (Component)
    {
        // 考虑分量比例系数
        FVector Scale = FVector(1.0f, 1.0f, 1.0f);
        Scale *= Component->Scale * Component->Scale3D;
        AActor* Actor = Component->GetOwner();
        if (Actor && !Component->AbsoluteScale)
        {
            Scale *= Actor->DrawScale * Actor->DrawScale3D;
        }           
        float MaxSizeScale = 1.0f;
        FVector NewLocation;
        float NewRotation;
        ParticleBoundingBox.Init();
        // 对于每个粒子，相应地偏移盒子 
        for (int32 i=0; i<ActiveParticles; i++)
        {
            DECLARE_PARTICLE(Particle, ParticleData + ParticleStride * ParticleIndices[i]);
            // 进行线性积分操作并更新边界盒
            // 进行角度积分操作并覆盖 +/- 2 PI 范围内的结果
            Particle.OldLocation = Particle.Location;
            if ((Particle.Flags & STATE_Particle_Freeze) == 0)
            {
                if ((Particle.Flags & STATE_Particle_FreezeTranslation) == 0)
                {
                    NewLocation = Particle.Location + (DeltaTime * Particle.Velocity);
                }
                else
                {
                    NewLocation = Particle.Location;
                }
                if ((Particle.Flags & STATE_Particle_FreezeRotation) == 0)
                {
                    NewRotation = (DeltaTime * Particle.RotationRate) + Particle.Rotation;
                }
                else
                {
                    NewRotation = Particle.Rotation;
                }
            }
            else
            {
                NewLocation = Particle.Location;
                NewRotation = Particle.Rotation;
            }
            FVector Size = Particle.Size * Scale;
            MaxSizeScale = Max(MaxSizeScale, Size.GetAbsMax()); //@todo particles: this does a whole lot of compares that can be avoided using SSE/ Altivec.
            Particle.Rotation = appFmod(NewRotation, 2.f*(float)PI);
            Particle.Location = NewLocation;
            ParticleBoundingBox += NewLocation;
        }
        ParticleBoundingBox = ParticleBoundingBox.ExpandBy(MaxSizeScale);
        // 如果发射器可以使用本地空间坐标系统，那么将边界盒变换为世界空间。
        UParticleLODLevel* LODLevel = SpriteTemplate->GetCurrentLODLevel(this);
        check(LODLevel);
        if (LODLevel->RequiredModule->bUseLocalSpace) 
        {
            //  调整分量旋转量
            AdjustComponentRotation();
            // 变换边界盒
            ParticleBoundingBox = ParticleBoundingBox.TransformBy(Component->LocalToWorld);
            // 恢复分量旋转量
            RestoreComponentRotation();
        }
    }
}

void FParticleSpinnerEmitterInstance::AdjustComponentRotation()
{
   // 保存实际的旋转量
   ComponentRotation = Component->Rotation;
   // 由于在各种模块的 Update 函数中可以使用分量的 LocalToWorld，
   // 所以我们需要模仿它，这样才能考虑到我们的实例旋转量。
   // 我们需要重建分量 LocalToWorld，
   // 这样才能正确地考虑到旋转量。
   FVector CurrRotInDegrees = CurrentRotation * 360.0f;
   FRotator RotationRot = FRotator::MakeFromEuler(CurrRotInDegrees);
   Component->Rotation += RotationRot;
   Component->SetTransformedToWorld();
}

void FParticleSpinnerEmitterInstance::RestoreComponentRotation()
{
   // 恢复分量旋转量
   Component->Rotation = ComponentRotation;
   Component->SetTransformedToWorld();
}

结果

下面的屏幕截图会在操作过程中演示 Spinner 发射器实例。 设置如下所示：

• 将 Spin 分布设置为其中一个点位于 (Time=0,X=0,Y=0,Z=0) 另一个点位于 (Time=1,X=0,Y=0,Z=1) 的常量曲线，它可以使实例在发射器的声明周期过程中以不同的速率围绕 Z 轴进行旋转。

• 将 InitialVelocity 模块与一个设置为 (X=100,Y=100,Z=100) 的 Constant Distribution（常数分布）联合使用，这样所有的粒子将会以直线流的方式发射（不考虑实例的旋转）。

• 将 InitialColor 模块与设置为其中一个点为 (Time=0,R=1,G=0,B=0) 另一个点为 (Time=1,R=0,G=0,B=1) 的 StartColor 联合使用，这样可以使发射器的生命周期过程中所发射的粒子从红色变为蓝色。