xref: /NW4C-1.2.23/include/nw/gfx/res/gfx_ResParticleInitializer.h

/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     gfx_ResParticleInitializer.h

  Copyright (C)2009-2010 Nintendo Co., Ltd./HAL Laboratory, Inc.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Revision: 19592 $
 *---------------------------------------------------------------------------*/

#ifndef NW_GFX_RESPARTICLEINITIALIZER_H_
#define NW_GFX_RESPARTICLEINITIALIZER_H_

#include <nw/ut/ut_ResUtil.h>
#include <nw/ut/ut_ResDictionary.h>
#include <nw/ut/ut_Color.h>
#include <nw/gfx/res/gfx_ResParticleUpdater.h>
#include <nw/gfx/res/gfx_ResTypeInfo.h>

namespace nw {
namespace gfx {
namespace res {

//! @details :private
struct ResParticleInitializerData
{
    nw::ut::ResTypeInfo typeInfo;
    nw::ut::ResBool m_IsResourceCopyEnabled;
    nw::ut::ResBool m_InitializerEnabled;
    u8              padding_0[2];
    nw::ut::ResS32 m_TargetStream;
};


//--------------------------------------------------------------------------
//! @brief  パーティクルイニシャライザを表すバイナリリソースクラスです（基底クラス）。
//---------------------------------------------------------------------------
class ResParticleInitializer : public nw::ut::ResCommon< ResParticleInitializerData >
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('INIT') };

    NW_RES_CTOR( ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( bool, IsResourceCopyEnabled )
    NW_RES_FIELD_PRIMITIVE_DECL( bool, InitializerEnabled )
    NW_RES_FIELD_PRIMITIVE_DECL( ParticleUsage, TargetStream )

    //---------------------------------------------------------------------------
    //! @brief        インスタンスの型情報を取得します。
    //!
    //! @return       型情報です。
    //---------------------------------------------------------------------------
    nw::ut::ResTypeInfo     GetTypeInfo() const { return ref().typeInfo; }

    NW_DEPRECATED_FUNCTION(s32 GetTargetStreamsCount() const)
    {
        if (this->GetTargetStream() < 0)
        {
            return 0;
        }

        return 1;
    }

    NW_DEPRECATED_FUNCTION(ParticleUsage* GetTargetStreams())
    {
        return (ParticleUsage*)&ref().m_TargetStream;
    }

    NW_DEPRECATED_FUNCTION(const ParticleUsage* GetTargetStreams() const)
    {
        return (const ParticleUsage*)&ref().m_TargetStream;
    }
};

//! @details :private
struct ResParticleDirectionalVelocityInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_Power;
    nw::ut::ResVec3 m_Direction;
};


//--------------------------------------------------------------------------
//! @brief  パーティクル放出方向と速度を表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleDirectionalVelocityInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleDirectionalVelocityInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('DIRV') };

    NW_RES_CTOR_INHERIT( ResParticleDirectionalVelocityInitializer, ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( f32, Power )             // GetPower(), SetPower()
    NW_RES_FIELD_VECTOR3_DECL( nw::math::VEC3, Direction ) // GetDirection()
};


//! @details :private
struct ResParticleRandomDirectionalVelocityInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_Power;
    nw::ut::ResVec3 m_Direction;
    nw::ut::ResF32 m_Angle;
};



//--------------------------------------------------------------------------
//! @brief  ランダムなパーティクル放出方向と速度を表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleRandomDirectionalVelocityInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleRandomDirectionalVelocityInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('RDRV') };

    NW_RES_CTOR_INHERIT( ResParticleRandomDirectionalVelocityInitializer, ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( f32, Power )               // GetPower(), SetPower()
    NW_RES_FIELD_VECTOR3_DECL( nw::math::VEC3, Direction )  // GetDirection()
    NW_RES_FIELD_PRIMITIVE_DECL( f32, Angle )               // GetAngle(), SetAngle()
};


//! @details :private
struct ResParticleOriginVelocityInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_Power;
};


//--------------------------------------------------------------------------
//! @brief  パーティクルの原点から拡散する速度を表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleOriginVelocityInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleOriginVelocityInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('ORIV') };

    NW_RES_CTOR_INHERIT( ResParticleOriginVelocityInitializer, ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( f32, Power ) // GetPower(), SetPower()
};

//! @details :private
struct ResParticleRandomVelocityInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_Power;
};


//--------------------------------------------------------------------------
//! @brief  パーティクルのランダムな速度を表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleRandomVelocityInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleRandomVelocityInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('RNDV') };

    NW_RES_CTOR_INHERIT( ResParticleRandomVelocityInitializer, ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( f32, Power ) // GetPower(), SetPower()
};

//! @details :private
struct ResParticleYAxisVelocityInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_Power;
};


//--------------------------------------------------------------------------
//! @brief  パーティクルのY軸から拡散する速度を表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleYAxisVelocityInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleYAxisVelocityInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('YAXV') };

    NW_RES_CTOR_INHERIT( ResParticleYAxisVelocityInitializer, ResParticleInitializer )

        NW_RES_FIELD_PRIMITIVE_DECL( f32, Power ) // GetPower(), SetPower()
};

//! @details :private
struct ResParticleFloatRandomInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_BaseValue;
    nw::ut::ResF32 m_Random;
};


//--------------------------------------------------------------------------
//! @brief  f32を乱数で初期化するパーティクルイニシャライザを表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleFloatRandomInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleFloatRandomInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('FRND') };

    NW_RES_CTOR_INHERIT( ResParticleFloatRandomInitializer, ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( f32, BaseValue )
    NW_RES_FIELD_PRIMITIVE_DECL( f32, Random )
};

//! @details :private
struct ResParticleFloatRangeRandomInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_MaxValue;
    nw::ut::ResF32 m_MinValue;
};



//--------------------------------------------------------------------------
//! @brief  f32を範囲指定の乱数で初期化するパーティクルイニシャライザを表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleFloatRangeRandomInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleFloatRangeRandomInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('URRA') };

    NW_RES_CTOR_INHERIT( ResParticleFloatRangeRandomInitializer, ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( f32, MaxValue )
    NW_RES_FIELD_PRIMITIVE_DECL( f32, MinValue )
};

//! @details :private
struct ResParticleFloatImmediateInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_ImmediateValue;
};

//--------------------------------------------------------------------------
//! @brief  f32を即値で初期化するパーティクルイニシャライザを表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleFloatImmediateInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleFloatImmediateInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('SFIM') };

    NW_RES_CTOR_INHERIT( ResParticleFloatImmediateInitializer, ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( f32, ImmediateValue )
};

//! @details :private
struct ResParticleVector2ImmediateInitializerData : public ResParticleInitializerData
{
    nw::ut::ResVec2 m_ImmediateValue;
};


//--------------------------------------------------------------------------
//! @brief  Vector2を即値で初期化するパーティクルイニシャライザを表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleVector2ImmediateInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleVector2ImmediateInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('V2IM') };

    NW_RES_CTOR_INHERIT( ResParticleVector2ImmediateInitializer, ResParticleInitializer )

    NW_RES_FIELD_VECTOR2_DECL( nw::math::VEC2, ImmediateValue )
};

//! @details :private
struct ResParticleVector3ImmediateInitializerData : public ResParticleInitializerData
{
    nw::ut::ResVec3 m_ImmediateValue;
};


//--------------------------------------------------------------------------
//! @brief  Vectro3を即値で初期化するパーティクルイニシャライザを表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleVector3ImmediateInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleVector3ImmediateInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('V3IM') };

    NW_RES_CTOR_INHERIT( ResParticleVector3ImmediateInitializer, ResParticleInitializer )

    NW_RES_FIELD_VECTOR3_DECL( nw::math::VEC3, ImmediateValue )
};

//! @details :private
struct ResParticleVector3Random1InitializerData : public ResParticleInitializerData
{
    nw::ut::ResVec3 m_BaseValue;
    nw::ut::ResF32 m_Random;
};


//--------------------------------------------------------------------------
//! @brief  Vector3をひとつの乱数で初期化するパーティクルイニシャライザを表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleVector3Random1Initializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleVector3Random1Initializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('V3R1') };

    NW_RES_CTOR_INHERIT( ResParticleVector3Random1Initializer, ResParticleInitializer )

    NW_RES_FIELD_VECTOR3_DECL( nw::math::VEC3, BaseValue )
    NW_RES_FIELD_PRIMITIVE_DECL( f32, Random )
};

//! @details :private
struct ResParticleVector3Random3InitializerData : public ResParticleInitializerData
{
    nw::ut::ResVec3 m_BaseValue;
    nw::ut::ResVec3 m_Random;
};


//--------------------------------------------------------------------------
//! @brief  Vector3を3個の乱数で初期化するパーティクルイニシャライザを表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleVector3Random3Initializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleVector3Random3Initializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('V3R3') };

    NW_RES_CTOR_INHERIT( ResParticleVector3Random3Initializer, ResParticleInitializer )

    NW_RES_FIELD_VECTOR3_DECL( nw::math::VEC3, BaseValue )
    NW_RES_FIELD_VECTOR3_DECL( nw::math::VEC3, Random )
};

//! @details :private
struct ResParticleVector3MultRandomInitializerData : public ResParticleInitializerData
{
    nw::ut::ResF32 m_Random;
};


//--------------------------------------------------------------------------
//! @brief  Vector3に乱数を乗算するパーティクルイニシャライザを表すバイナリリソースクラスです。
//---------------------------------------------------------------------------
class ResParticleVector3MultRandomInitializer : public ResParticleInitializer
{
public:
    enum { TYPE_INFO = NW_GFX_RES_TYPE_INFO(ResParticleVector3MultRandomInitializer) };
    enum { SIGNATURE = NW_RES_SIGNATURE32('V3MR') };

    NW_RES_CTOR_INHERIT( ResParticleVector3MultRandomInitializer, ResParticleInitializer )

    NW_RES_FIELD_PRIMITIVE_DECL( f32, Random )
};

} // namespace res
} // namespace gfx
} // namespace nw

#endif // NW_GFX_RESPARTICLEINITIALIZER_H_