#include <Effekseer.h>

Inheritance diagram for Effekseer::Effect:

Public Member Functions
virtual const char16_t *	GetName () const =0
	Get this effect's name. If this effect is loaded from file, default name is file name without extention. More...

virtual void	SetName (const char16_t *name)=0

virtual Setting *	GetSetting () const =0
	設定を取得する。 More...

virtual float	GetMaginification () const =0
	Get the magnification multiplied by the magnification at the time of loaded and exported. More...

virtual int	GetVersion () const =0
	エフェクトデータのバージョン取得 More...

virtual ReferenceObject *	GetLoadingParameter () const =0
	Get loading parameter supecfied by EffectFactory. This parameter is not used unless EffectFactory is used. More...

virtual TextureData *	GetColorImage (int n) const =0
	格納されている色画像のポインタを取得する。 More...

virtual int32_t	GetColorImageCount () const =0
	格納されている画像のポインタの個数を取得する。 More...

virtual const EFK_CHAR *	GetColorImagePath (int n) const =0
	Get a color image's path. More...

virtual TextureData *	GetNormalImage (int n) const =0
	格納されている法線画像のポインタを取得する。 More...

virtual int32_t	GetNormalImageCount () const =0
	格納されている法線画像のポインタの個数を取得する。 More...

virtual const EFK_CHAR *	GetNormalImagePath (int n) const =0
	Get a normal image's path. More...

virtual TextureData *	GetDistortionImage (int n) const =0
	格納されている歪み画像のポインタを取得する。 More...

virtual int32_t	GetDistortionImageCount () const =0
	格納されている歪み画像のポインタの個数を取得する。 More...

virtual const EFK_CHAR *	GetDistortionImagePath (int n) const =0
	Get a distortion image's path. More...

virtual void *	GetWave (int n) const =0
	格納されている音波形のポインタを取得する。 More...

virtual int32_t	GetWaveCount () const =0
	格納されている音波形のポインタの個数を取得する。 More...

virtual const EFK_CHAR *	GetWavePath (int n) const =0
	Get a wave's path. More...

virtual void *	GetModel (int n) const =0
	格納されているモデルのポインタを取得する。 More...

virtual int32_t	GetModelCount () const =0
	格納されているモデルのポインタの個数を取得する。 More...

virtual const EFK_CHAR *	GetModelPath (int n) const =0
	Get a model's path. More...

virtual MaterialData *	GetMaterial (int n) const =0
	Get a material's pointer. More...

virtual int32_t	GetMaterialCount () const =0
	Get the number of stored material pointer. More...

virtual const EFK_CHAR *	GetMaterialPath (int n) const =0
	Get a material's path. More...

virtual bool	Reload (void data, int32_t size, const EFK_CHAR materialPath=nullptr, ReloadingThreadType reloadingThreadType=ReloadingThreadType::Main)=0
	Reload this effect An effect's data An effect's size A path where reaources are loaded A thread where reload function is called ResultIf reloadingThreadType is RenderThread, new resources aren't loaded and old resources aren't disposed. More...

virtual bool	Reload (const EFK_CHAR path, const EFK_CHAR materialPath=nullptr, ReloadingThreadType reloadingThreadType=ReloadingThreadType::Main)=0
	Reload this effect An effect's path A path where reaources are loaded A thread where reload function is called ResultIf reloadingThreadType is RenderThread, new resources aren't loaded and old resources aren't disposed. More...

virtual bool	Reload (Manager *managers, int32_t managersCount, void data, int32_t size, const EFK_CHAR *materialPath=nullptr, ReloadingThreadType reloadingThreadType=ReloadingThreadType::Main)=0
	Reload this effect An array of manager instances Length of array An effect's data An effect's size A path where reaources are loaded A thread where reload function is called ResultIf an effect is generated with Setting, the effect in managers is reloaded with managers If reloadingThreadType is RenderThread, new resources aren't loaded and old resources aren't disposed. More...

virtual bool	Reload (Manager *managers, int32_t managersCount, const EFK_CHAR path, const EFK_CHAR *materialPath=nullptr, ReloadingThreadType reloadingThreadType=ReloadingThreadType::Main)=0
	Reload this effect An array of manager instances Length of array An effect's path A path where reaources are loaded A thread where reload function is called ResultIf an effect is generated with Setting, the effect in managers is reloaded with managers If reloadingThreadType is RenderThread, new resources aren't loaded and old resources aren't disposed. More...

virtual void	ReloadResources (const void data=nullptr, int32_t size=0, const EFK_CHAR materialPath=nullptr)=0
	画像等リソースの再読み込みを行う。 More...

virtual void	UnloadResources ()=0
	画像等リソースの破棄を行う。 More...

virtual EffectNode *	GetRoot () const =0
	Rootを取得する。 More...

virtual EffectTerm	CalculateTerm () const =0

Public Member Functions inherited from Effekseer::IReference
virtual int	AddRef ()=0
	参照カウンタを加算する。 More...

virtual int	GetRef ()=0
	参照カウンタを取得する。 More...

virtual int	Release ()=0
	参照カウンタを減算する。0になった時、インスタンスを削除する。 More...

Static Public Member Functions
static Effect *	Create (Manager manager, void data, int32_t size, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
	エフェクトを生成する。 More...

static Effect *	Create (Manager manager, const EFK_CHAR path, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
	エフェクトを生成する。 More...

static Effect *	Create (Setting setting, void data, int32_t size, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
	エフェクトを生成する。 More...

static Effect *	Create (Setting setting, const EFK_CHAR path, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
	エフェクトを生成する。 More...

::Effekseer::EffectLoader *	CreateEffectLoader (::Effekseer::FileInterface *fileInterface=NULL)
	標準のエフェクト読込インスタンスを生成する。 More...

Protected Member Functions
	Effect ()

virtual	~Effect ()

Detailed Description

Effect parameters.

Definition at line 1798 of file Effekseer.h.

Constructor & Destructor Documentation

◆ Effect()

Effekseer::Effect::Effect ( )

inlineprotected

Definition at line 1802 of file Effekseer.h.

1802 {}

◆ ~Effect()

virtual Effekseer::Effect::~Effect ( )

inlineprotectedvirtual

Definition at line 1803 of file Effekseer.h.

1803 {}

Member Function Documentation

◆ CalculateTerm()

virtual EffectTerm Effekseer::Effect::CalculateTerm ( ) const

pure virtual

    @brief

Calculate a term of instances where the effect exists

◆ Create() [1/4]

static Effect* Effekseer::Effect::Create	(	Manager *	manager,
		void *	data,
		int32_t	size,
		float	magnification = `1.0f`,
		const EFK_CHAR *	materialPath = `NULL`
	)

static

エフェクトを生成する。

Parameters

manager	[in] 管理クラス
data	[in] データ配列の先頭のポインタ
size	[in] データ配列の長さ
magnification	[in] 読み込み時の拡大率
materialPath	[in] 素材ロード時の基準パス

Returns: エフェクト。失敗した場合はNULLを返す。

◆ Create() [2/4]

static Effect* Effekseer::Effect::Create	(	Manager *	manager,
		const EFK_CHAR *	path,
		float	magnification = `1.0f`,
		const EFK_CHAR *	materialPath = `NULL`
	)

static

エフェクトを生成する。

Parameters

manager	[in] 管理クラス
path	[in] 読込元のパス
magnification	[in] 読み込み時の拡大率
materialPath	[in] 素材ロード時の基準パス

Returns: エフェクト。失敗した場合はNULLを返す。

◆ Create() [3/4]

static Effect* Effekseer::Effect::Create	(	Setting *	setting,
		void *	data,
		int32_t	size,
		float	magnification = `1.0f`,
		const EFK_CHAR *	materialPath = `NULL`
	)

static

エフェクトを生成する。

Parameters

setting	[in] 設定クラス
data	[in] データ配列の先頭のポインタ
size	[in] データ配列の長さ
magnification	[in] 読み込み時の拡大率
materialPath	[in] 素材ロード時の基準パス

Returns: エフェクト。失敗した場合はNULLを返す。

◆ Create() [4/4]

static Effect* Effekseer::Effect::Create	(	Setting *	setting,
		const EFK_CHAR *	path,
		float	magnification = `1.0f`,
		const EFK_CHAR *	materialPath = `NULL`
	)

static

エフェクトを生成する。

Parameters

setting	[in] 設定クラス
path	[in] 読込元のパス
magnification	[in] 読み込み時の拡大率
materialPath	[in] 素材ロード時の基準パス

Returns: エフェクト。失敗した場合はNULLを返す。

◆ CreateEffectLoader()

::Effekseer::EffectLoader* Effekseer::Effect::CreateEffectLoader ( ::Effekseer::FileInterface * fileInterface = NULL )

static

標準のエフェクト読込インスタンスを生成する。

◆ GetColorImage()

virtual TextureData* Effekseer::Effect::GetColorImage ( int n ) const

pure virtual

格納されている色画像のポインタを取得する。

Parameters

n	[in] 画像のインデックス

Returns: 画像のポインタ

◆ GetColorImageCount()

virtual int32_t Effekseer::Effect::GetColorImageCount ( ) const

pure virtual

格納されている画像のポインタの個数を取得する。

◆ GetColorImagePath()

virtual const EFK_CHAR* Effekseer::Effect::GetColorImagePath ( int n ) const

pure virtual

Get a color image's path.

◆ GetDistortionImage()

virtual TextureData* Effekseer::Effect::GetDistortionImage ( int n ) const

pure virtual

格納されている歪み画像のポインタを取得する。

Parameters

n	[in] 画像のインデックス

Returns: 画像のポインタ

◆ GetDistortionImageCount()

virtual int32_t Effekseer::Effect::GetDistortionImageCount ( ) const

pure virtual

格納されている歪み画像のポインタの個数を取得する。

◆ GetDistortionImagePath()

virtual const EFK_CHAR* Effekseer::Effect::GetDistortionImagePath ( int n ) const

pure virtual

Get a distortion image's path.

◆ GetLoadingParameter()

virtual ReferenceObject* Effekseer::Effect::GetLoadingParameter ( ) const

pure virtual

Get loading parameter supecfied by EffectFactory. This parameter is not used unless EffectFactory is used.

◆ GetMaginification()

virtual float Effekseer::Effect::GetMaginification ( ) const

pure virtual

Get the magnification multiplied by the magnification at the time of loaded and exported.

◆ GetMaterial()

virtual MaterialData* Effekseer::Effect::GetMaterial ( int n ) const

pure virtual

Get a material's pointer.

◆ GetMaterialCount()

virtual int32_t Effekseer::Effect::GetMaterialCount ( ) const

pure virtual

Get the number of stored material pointer.

◆ GetMaterialPath()

virtual const EFK_CHAR* Effekseer::Effect::GetMaterialPath ( int n ) const

pure virtual

Get a material's path.

◆ GetModel()

virtual void* Effekseer::Effect::GetModel ( int n ) const

pure virtual

格納されているモデルのポインタを取得する。

◆ GetModelCount()

virtual int32_t Effekseer::Effect::GetModelCount ( ) const

pure virtual

格納されているモデルのポインタの個数を取得する。

◆ GetModelPath()

virtual const EFK_CHAR* Effekseer::Effect::GetModelPath ( int n ) const

pure virtual

Get a model's path.

◆ GetName()

virtual const char16_t* Effekseer::Effect::GetName ( ) const

pure virtual

Get this effect's name. If this effect is loaded from file, default name is file name without extention.

◆ GetNormalImage()

virtual TextureData* Effekseer::Effect::GetNormalImage ( int n ) const

pure virtual

格納されている法線画像のポインタを取得する。

Parameters

n	[in] 画像のインデックス

Returns: 画像のポインタ

◆ GetNormalImageCount()

virtual int32_t Effekseer::Effect::GetNormalImageCount ( ) const

pure virtual

格納されている法線画像のポインタの個数を取得する。

◆ GetNormalImagePath()

virtual const EFK_CHAR* Effekseer::Effect::GetNormalImagePath ( int n ) const

pure virtual

Get a normal image's path.

◆ GetRoot()

virtual EffectNode* Effekseer::Effect::GetRoot ( ) const

pure virtual

Rootを取得する。

◆ GetSetting()

virtual Setting* Effekseer::Effect::GetSetting ( ) const

pure virtual

設定を取得する。

Returns: 設定

◆ GetVersion()

virtual int Effekseer::Effect::GetVersion ( ) const

pure virtual

エフェクトデータのバージョン取得

◆ GetWave()

virtual void* Effekseer::Effect::GetWave ( int n ) const

pure virtual

格納されている音波形のポインタを取得する。

◆ GetWaveCount()

virtual int32_t Effekseer::Effect::GetWaveCount ( ) const

pure virtual

格納されている音波形のポインタの個数を取得する。

◆ GetWavePath()

virtual const EFK_CHAR* Effekseer::Effect::GetWavePath ( int n ) const

pure virtual

Get a wave's path.

◆ Reload() [1/4]

virtual bool Effekseer::Effect::Reload	(	void *	data,
		int32_t	size,
		const EFK_CHAR *	materialPath = `nullptr`,
		ReloadingThreadType	reloadingThreadType = `ReloadingThreadType::Main`
	)

pure virtual

Reload this effect An effect's data An effect's size A path where reaources are loaded A thread where reload function is called ResultIf reloadingThreadType is RenderThread, new resources aren't loaded and old resources aren't disposed.

◆ Reload() [2/4]

virtual bool Effekseer::Effect::Reload	(	const EFK_CHAR *	path,
		const EFK_CHAR *	materialPath = `nullptr`,
		ReloadingThreadType	reloadingThreadType = `ReloadingThreadType::Main`
	)

pure virtual

Reload this effect An effect's path A path where reaources are loaded A thread where reload function is called ResultIf reloadingThreadType is RenderThread, new resources aren't loaded and old resources aren't disposed.

◆ Reload() [3/4]

virtual bool Effekseer::Effect::Reload	(	Manager **	managers,
		int32_t	managersCount,
		void *	data,
		int32_t	size,
		const EFK_CHAR *	materialPath = `nullptr`,
		ReloadingThreadType	reloadingThreadType = `ReloadingThreadType::Main`
	)

pure virtual

Reload this effect An array of manager instances Length of array An effect's data An effect's size A path where reaources are loaded A thread where reload function is called ResultIf an effect is generated with Setting, the effect in managers is reloaded with managers If reloadingThreadType is RenderThread, new resources aren't loaded and old resources aren't disposed.

◆ Reload() [4/4]

virtual bool Effekseer::Effect::Reload	(	Manager **	managers,
		int32_t	managersCount,
		const EFK_CHAR *	path,
		const EFK_CHAR *	materialPath = `nullptr`,
		ReloadingThreadType	reloadingThreadType = `ReloadingThreadType::Main`
	)

pure virtual

Reload this effect An array of manager instances Length of array An effect's path A path where reaources are loaded A thread where reload function is called ResultIf an effect is generated with Setting, the effect in managers is reloaded with managers If reloadingThreadType is RenderThread, new resources aren't loaded and old resources aren't disposed.

◆ ReloadResources()

virtual void Effekseer::Effect::ReloadResources	(	const void *	data = `nullptr`,
		int32_t	size = `0`,
		const EFK_CHAR *	materialPath = `nullptr`
	)

pure virtual

画像等リソースの再読み込みを行う。

◆ SetName()

virtual void Effekseer::Effect::SetName ( const char16_t * name )

pure virtual

    \~English       Set this effect's name

◆ UnloadResources()

virtual void Effekseer::Effect::UnloadResources ( )

pure virtual

画像等リソースの破棄を行う。

The documentation for this class was generated from the following file:

include/Effekseer/Effekseer.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Effect()

◆ ~Effect()

Member Function Documentation

◆ CalculateTerm()

◆ Create() [1/4]

◆ Create() [2/4]

◆ Create() [3/4]

◆ Create() [4/4]

◆ CreateEffectLoader()

◆ GetColorImage()

◆ GetColorImageCount()

◆ GetColorImagePath()

◆ GetDistortionImage()

◆ GetDistortionImageCount()

◆ GetDistortionImagePath()

◆ GetLoadingParameter()

◆ GetMaginification()

◆ GetMaterial()

◆ GetMaterialCount()

◆ GetMaterialPath()

◆ GetModel()

◆ GetModelCount()

◆ GetModelPath()

◆ GetName()

◆ GetNormalImage()

◆ GetNormalImageCount()

◆ GetNormalImagePath()

◆ GetRoot()

◆ GetSetting()

◆ GetVersion()

◆ GetWave()

◆ GetWaveCount()

◆ GetWavePath()

◆ Reload() [1/4]

◆ Reload() [2/4]

◆ Reload() [3/4]

◆ Reload() [4/4]

◆ ReloadResources()

◆ SetName()

◆ UnloadResources()