Yukar.Common.Resource.Particle Class Reference

A class that manages particle resources More...

Inheritance diagram for Yukar.Common.Resource.Particle:

Public Member Functions
	Particle ()
override void	load (BinaryReader reader)
	loading More...
override void	save (BinaryWriter writer)
	keep More...
override void	saveUsedGUID (BinaryWriter writer, bool inIncludeChildUseRomGUID)
	Export the GUID you are using (for tools) More...
override string[]	getPathList ()
	Get path list of files used by resource More...
void	CopyReferenceFiles (string inSrcBasePath, string inSrcPath, string inDstPath, bool inIsOverwrite, bool inIsExistFileRename)
override void	CopySourceResourceFile (string inSrcPath, string inDstPath=null, bool inIsOverwrite=false, bool inIsExistFileRename=false)
	Copy source resource file More...
override void	ChangeReImportPath ()
	Change re-import destination More...
override void	reImport ()
	Reimport More...
override void	reload ()
	Reload resource files More...
override List< string >	getRelatedFiles ()
	Get path list of related files More...
List< string >	getReferenceFilePathList ()
override void	export (string path)
	export More...
override void	ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
override List< Guid >	GetUsedResourceIdList ()
	Get list of used resource IDs More...
SharpKmyGfx.ParticleInstance	getParticleInstance (uint displayID)
void	overwriteImport (string newPath)
	simple overwrite import More...
Public Member Functions inherited from Yukar.Common.Resource.ResourceItem
override bool	initializingAfterLoading ()
	Initialization process after loading More...
virtual void	initializeKmyGfx ()
	Resource initialization processing More...
override void	save (System.IO.BinaryWriter writer)
override void	load (System.IO.BinaryReader reader)
virtual void	setPath (string path)
	Set resource path More...
virtual void	CopySourceResourceFile (string inSrcPath, string inDstPath=null, bool inIsOverwrite=false, bool inIsExistFileRename=false)
	Copy source resource file More...
void	CopyOutsideResourceFile (bool inIsOverwrite=false, bool inIsExistFileRename=false)
	Copying external resource files More...
bool	deleteResourceFile (Dictionary< string, int > inUsedFilePathCountDic, bool inIsAutoDeleteFile)
	Deleting resource files More...
virtual List< string >	getRelatedFiles ()
	Get path list of related files More...
virtual List< string >	getInternalFormatFilePath ()
	Get file path list in private format More...
virtual ErrorType	verify ()
	Check resource integrity (used for converting SGB game files) More...
bool	IsError (bool inCheckDispOnly=true)
	Is the resource in an error state? More...
bool	isSystemResource ()
	Is it a system resource? More...
bool	isDLCResource ()
	Is it a DLC resource? More...
void	setToModified ()
	Not implemented More...
virtual string[]	getPathList ()
	Get path list of files used by resource More...
string	getExtension ()
	Get resource file extension More...
virtual void	ChangeReImportPath ()
	Change re-import destination More...
virtual List< Guid >	GetUsedResourceIdList ()
	Get list of used resource IDs More...
override void	ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
void	ClearResourceHolderCache ()
	Clear resource holder cache More...
void	updateSetuppedThumbnail ()
	Update thumbnails for associated graphics setups More...
virtual void	reload ()
	Reload resource files More...
bool	isExistNewerTimeStamp ()
	Are the resource files updated? More...
virtual void	renamePath (string inNewPath)
	Change resource path More...
virtual void	setNativeResourcePath (string inFolderPath)
	set full path of native resource for system project y More...
Public Member Functions inherited from Yukar.Common.Rom.RomItem
string	getCategory (string locale=null)
	Get category path More...
	RomItem ()
	constructor More...
System.Drawing.Bitmap	getThumbnail (THUMBNAILMAKERNOTIFY notify, out bool setNotify)
	Get thumbnail image More...
System.Drawing.Bitmap	getThumbnail (THUMBNAILMAKERNOTIFY notify)
	Get thumbnail image More...
System.Drawing.Bitmap	getThumbnail ()
	Get thumbnail image More...
void	invalidateThumbnail ()
	Disable thumbnail images More...
void	invalidateThumbnail (THUMBNAILMAKERNOTIFY notify)
	Disable thumbnail images More...
void	forceInvalidateThumbnail (THUMBNAILMAKERNOTIFY notify)
	Force regeneration of thumbnail images More...
virtual void	save (BinaryWriter writer)
	keep More...
virtual void	load (BinaryReader reader)
	loading More...
virtual void	saveUsedGUID (BinaryWriter writer, bool inIncludeChildUseRomGUID)
	Export the GUID you are using (for tools) More...
void	saveUsedGUID (BinaryWriter writer)
	Export the GUID you are using (for tools) More...
virtual bool	initializingAfterLoading ()
	Initialization process after loading More...
virtual void	reImport ()
	Reimport More...
virtual void	export (string path)
	export More...
virtual void	onCatalogCleanup ()
	Catalog release processing More...
virtual void	onNameChanged ()
	Processing when renaming More...
void	copyFrom (Common.Rom.RomItem src)
	Copy data from another RomItem More...
virtual void	CheckRecourceConsistency (Catalog inCatalog)
	Consistency check (for tools) More...
virtual void	ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
	Replace the Id you are using with the corresponding Rom Id More...
void	ClearId (List< Rom.RomItem > inClearRomItemList)
	Removed rom usage in list More...
void	Dispose ()
void	AddUpdatecall (int count)
	Increase/decrease the thumbnail generation pending counter More...
void	save (BinaryWriter writer)
	keep More...
void	load (BinaryReader reader)
	loading More...

Static Public Member Functions
static string	makeCreatePath (string srcpath, bool overwrite=false)
	Get the destination path of the particle file More...
static Particle	import (string path, string createpath)
static Particle	convert (string path, Option option)
Static Public Member Functions inherited from Yukar.Common.Resource.ResourceItem
static string	makeCreateFilePath (Type inType, string inSrcPath, bool inIsOverWrite)
	Creating a file path to copy resource files to More...
Static Public Member Functions inherited from Yukar.Common.Rom.RomItem
static bool	reImport (List< RomItem > inRomList)
	Reimport More...
static void	writeChunk (System.IO.BinaryWriter writer, IChunk rom)
	write chunk More...
static void	readChunk (System.IO.BinaryReader reader, IChunk rom)
	load chunk More...
static void	skipChunk (System.IO.BinaryReader reader)
	skip chunk More...
static T	Clone< T > (RomItem inSrc)
	Clone RomItem More...
static bool	equalChunk (IChunk a, IChunk b)
	Are the contents of the chunks equal? More...
static IChunk	duplicate (IChunk rom)
	Duplicate IChunk More...

Public Attributes
float	prewarm = 0f
ParticleBattleSetting	btlSetting = new ParticleBattleSetting()
ParticleLightSetting	lgtSetting = new ParticleLightSetting()
string	importPath = ""
bool	useEnvEffect = false
Public Attributes inherited from Yukar.Common.Resource.ResourceItem
Guid	dlcGuid = Guid.Empty
	GUID of DLC or system project More...
string	relatedPath = ""
	relative path More...
string	path = ".\\"
	resource path More...
Option	option = new Option()
	Resource options (for converting game files for SGB) More...
ResourceSource	source = ResourceSource.RES_USER
	Resource source type More...
Public Attributes inherited from Yukar.Common.Rom.RomItem
Guid	guId
	ID More...
String	name
	name More...
string	tags = ""
	tag More...
string	category = ""
	category More...

Protected Member Functions
override bool	IsErrorImp (bool inCheckDispOnly)
Protected Member Functions inherited from Yukar.Common.Resource.ResourceItem
virtual bool	IsErrorImp (bool inCheckDispOnly)
string	checkReImportPath (string importPath, string filter, bool changeReImportPath)
virtual List< ResourceHolder >	GetResourceHolderList ()
virtual void	afterRenamePath (string inNewPath)
Protected Member Functions inherited from Yukar.Common.Rom.RomItem
virtual void	Dispose (bool disposing)

Properties
override string	ImportPath [get, set]
float	Prewarm [get, set]
bool	UseEnvEffect [get, set]
bool	UseEmitterControl [get, set]
float	Scale = 1.0f [get, set]
Guid	BattleSettingSE [get, set]
float	BattleSettingSoundTiming [get, set]
float	BattleSettingTime [get, set]
int	BattleSettingStart [get, set]
float	BattleSettingStartOffsetX [get, set]
float	BattleSettingStartOffsetY [get, set]
float	BattleSettingStartOffsetZ [get, set]
int	BattleSettingEnd [get, set]
int	BattleSettingDirection [get, set]
int	BattleSettingGeneration [get, set]
Guid	BattleSettingChainTarget [get, set]
float	BattleSettingChainTiming [get, set]
int	BattleSettingShakeForce [get, set]
float	BattleSettingShakeTiming [get, set]
float	BattleSettingShakeLength [get, set]
float	BattleSettingDamageTiming [get, set]
float	BattleSettingGuardTiming [get, set]
float	LightPosX [get, set]
float	LightPosY [get, set]
float	LightPosZ [get, set]
System.Drawing.Color	LightColor [get, set]
float	LightForce [get, set]
float	LightRadius [get, set]
float	LightFadeInStart [get, set]
float	LightFadeInTime [get, set]
float	LightFadeOutStart [get, set]
float	LightFadeOutTime [get, set]
Properties inherited from Yukar.Common.Resource.ResourceItem
string	SourcePath [get]
	source path More...
virtual string	ImportPath [get, set]
	Import source path More...
virtual string	SourceFileName [get]
	source file name More...
string	SourceFolderName [get]
	source folder name More...
int	StampType [get, set]
bool	ForceExport [get, set]
	Must be included in published work output? More...
bool	ForceExportByLocalize [get, set]
	Must be included in published work output (for localization) More...
virtual bool	ConvertableToInternalFormat [get]
	Is it possible to convert to private format? More...
string	resourcePath [get, set]
	Resource path (DLC, system project compatible version) More...
Properties inherited from Yukar.Common.Rom.RomItem
System.Drawing.Bitmap	Thumbnail [get]
	thumbnail image More...
ThumbnailStatusType	ThumbnailStatus = ThumbnailStatusType.Empty [get, set]
	Thumbnail generation status More...
string	Name [get, set]
	Get display name More...
virtual int	RefCount [get]
	reference count More...
virtual bool	UseRefCount [get]
	Should I use reference counting? More...
Folder	Parent [get, set]
	parent folder More...

Additional Inherited Members
Public Types inherited from Yukar.Common.Rom.RomItem
enum	ThumbnailStatusType { Empty = 0 , Creating , Created , Failed }
	Thumbnail image generation status More...
Static Public Attributes inherited from Yukar.Common.Resource.ResourceItem
static ResourceSource	sCurrentSourceMode
	current source mode More...
static bool	sReferenceLoad = false
	Reference read mode More...
static bool	sClipboardLoad = false
	Load from clipboard mode More...
static bool	sAttachResource = true
	Attach the resource More...
const string	TAG_3D = "#3D"
	3D resource tags More...
const string	TAG_2D = "#2D"
	2D resource tags More...
static Guid	sCurrentSourceGuid
	GUID of the DLC or system project being loaded More...
Static Public Attributes inherited from Yukar.Common.Rom.RomItem
static int	thumbnailWidth = 128
	Thumbnail image width (pixels) More...
static int	thumbnailHeight = 128
	Thumbnail image height (pixels) More...
const char	CATEGORY_SPLITTER = '\\'
	category delimiter More...
static CREATETHUMBNAIL	createThumbnailFunction = null
	Thumbnail generation function More...
const int	UnknownRefCount = -2000
	Constants when reference count is unknown More...

Detailed Description

A class that manages particle resources

Constructor & Destructor Documentation

Particle()

Yukar.Common.Resource.Particle.Particle

(

)

Member Function Documentation

ChangeId()

override void Yukar.Common.Resource.Particle.ChangeId

(

Dictionary< Guid, Rom.RomItem >

inChangeIdDic

)

ChangeReImportPath()

override void Yukar.Common.Resource.Particle.ChangeReImportPath ( )

virtual

Change re-import destination

Reimplemented from Yukar.Common.Resource.ResourceItem.

convert()

static Particle Yukar.Common.Resource.Particle.convert ( string  path, Option  option  )

static

CopyReferenceFiles()

void Yukar.Common.Resource.Particle.CopyReferenceFiles	(	string	inSrcBasePath,
		string	inSrcPath,
		string	inDstPath,
		bool	inIsOverwrite,
		bool	inIsExistFileRename
	)

CopySourceResourceFile()

override void Yukar.Common.Resource.Particle.CopySourceResourceFile ( string  inSrcPath, string  inDstPath = null, bool  inIsOverwrite = false, bool  inIsExistFileRename = false  )

virtual

Copy source resource file

Parameters

inSrcPath	Copy source file path
inDstPath	Copy destination file path
inIsOverwrite	overwrite
inIsExistFileRename	Do you want to rename existing resource files?

Reimplemented from Yukar.Common.Resource.ResourceItem.

export()

override void Yukar.Common.Resource.Particle.export ( string  path )

virtual

export

Parameters

path	export folder path

Reimplemented from Yukar.Common.Rom.RomItem.

getParticleInstance()

SharpKmyGfx.ParticleInstance Yukar.Common.Resource.Particle.getParticleInstance

(

uint

displayID

)

getPathList()

override string[] Yukar.Common.Resource.Particle.getPathList ( )

virtual

Get path list of files used by resource

Returns

Reimplemented from Yukar.Common.Resource.ResourceItem.

getReferenceFilePathList()

List< string > Yukar.Common.Resource.Particle.getReferenceFilePathList

(

)

getRelatedFiles()

override List< string > Yukar.Common.Resource.Particle.getRelatedFiles ( )

virtual

Get path list of related files

Returns

Reimplemented from Yukar.Common.Resource.ResourceItem.

GetUsedResourceIdList()

override List< Guid > Yukar.Common.Resource.Particle.GetUsedResourceIdList ( )

virtual

Get list of used resource IDs

Returns

Reimplemented from Yukar.Common.Resource.ResourceItem.

import()

static Particle Yukar.Common.Resource.Particle.import ( string  path, string  createpath  )

static

IsErrorImp()

override bool Yukar.Common.Resource.Particle.IsErrorImp ( bool  inCheckDispOnly )

protectedvirtual

Reimplemented from Yukar.Common.Resource.ResourceItem.

load()

override void Yukar.Common.Resource.Particle.load ( BinaryReader  reader )

virtual

loading

Parameters

reader

leader

Reimplemented from Yukar.Common.Rom.RomItem.

makeCreatePath()

static string Yukar.Common.Resource.Particle.makeCreatePath ( string  srcpath, bool  overwrite = false  )

static

Get the destination path of the particle file

Parameters

srcpath	Path of the particle file to import from
overwrite	Overwrite?

Returns

Path to copy particle files to

overwriteImport()

void Yukar.Common.Resource.Particle.overwriteImport

(

string

newPath

)

simple overwrite import

Parameters

newPath

reImport()

override void Yukar.Common.Resource.Particle.reImport ( )

virtual

Reimport

Reimplemented from Yukar.Common.Rom.RomItem.

reload()

override void Yukar.Common.Resource.Particle.reload ( )

virtual

Reload resource files

Reimplemented from Yukar.Common.Resource.ResourceItem.

save()

override void Yukar.Common.Resource.Particle.save ( BinaryWriter  writer )

virtual

keep

Parameters

writer

Writer

Reimplemented from Yukar.Common.Rom.RomItem.

saveUsedGUID()

override void Yukar.Common.Resource.Particle.saveUsedGUID ( BinaryWriter  writer, bool  inIncludeChildUseRomGUID  )

virtual

Export the GUID you are using (for tools)

Parameters

writer	Writer
inIncludeChildUseRomGUID	Does it also include the roms used by the roms used?

Reimplemented from Yukar.Common.Rom.RomItem.

Member Data Documentation

btlSetting

ParticleBattleSetting Yukar.Common.Resource.Particle.btlSetting = new ParticleBattleSetting()

importPath

string Yukar.Common.Resource.Particle.importPath = ""

lgtSetting

ParticleLightSetting Yukar.Common.Resource.Particle.lgtSetting = new ParticleLightSetting()

prewarm

float Yukar.Common.Resource.Particle.prewarm = 0f

useEnvEffect

bool Yukar.Common.Resource.Particle.useEnvEffect = false

Property Documentation

BattleSettingChainTarget

Guid Yukar.Common.Resource.Particle.BattleSettingChainTarget

getset

BattleSettingChainTiming

float Yukar.Common.Resource.Particle.BattleSettingChainTiming

getset

BattleSettingDamageTiming

float Yukar.Common.Resource.Particle.BattleSettingDamageTiming

getset

BattleSettingDirection

int Yukar.Common.Resource.Particle.BattleSettingDirection

getset

BattleSettingEnd

int Yukar.Common.Resource.Particle.BattleSettingEnd

getset

BattleSettingGeneration

int Yukar.Common.Resource.Particle.BattleSettingGeneration

getset

BattleSettingGuardTiming

float Yukar.Common.Resource.Particle.BattleSettingGuardTiming

getset

BattleSettingSE

Guid Yukar.Common.Resource.Particle.BattleSettingSE

getset

BattleSettingShakeForce

int Yukar.Common.Resource.Particle.BattleSettingShakeForce

getset

BattleSettingShakeLength

float Yukar.Common.Resource.Particle.BattleSettingShakeLength

getset

BattleSettingShakeTiming

float Yukar.Common.Resource.Particle.BattleSettingShakeTiming

getset

BattleSettingSoundTiming

float Yukar.Common.Resource.Particle.BattleSettingSoundTiming

getset

BattleSettingStart

int Yukar.Common.Resource.Particle.BattleSettingStart

getset

BattleSettingStartOffsetX

float Yukar.Common.Resource.Particle.BattleSettingStartOffsetX

getset

BattleSettingStartOffsetY

float Yukar.Common.Resource.Particle.BattleSettingStartOffsetY

getset

BattleSettingStartOffsetZ

float Yukar.Common.Resource.Particle.BattleSettingStartOffsetZ

getset

BattleSettingTime

float Yukar.Common.Resource.Particle.BattleSettingTime

getset

ImportPath

override string Yukar.Common.Resource.Particle.ImportPath

getset

LightColor

System.Drawing.Color Yukar.Common.Resource.Particle.LightColor

getset

LightFadeInStart

float Yukar.Common.Resource.Particle.LightFadeInStart

getset

LightFadeInTime

float Yukar.Common.Resource.Particle.LightFadeInTime

getset

LightFadeOutStart

float Yukar.Common.Resource.Particle.LightFadeOutStart

getset

LightFadeOutTime

float Yukar.Common.Resource.Particle.LightFadeOutTime

getset

LightForce

float Yukar.Common.Resource.Particle.LightForce

getset

LightPosX

float Yukar.Common.Resource.Particle.LightPosX

getset

LightPosY

float Yukar.Common.Resource.Particle.LightPosY

getset

LightPosZ

float Yukar.Common.Resource.Particle.LightPosZ

getset

LightRadius

float Yukar.Common.Resource.Particle.LightRadius

getset

Prewarm

float Yukar.Common.Resource.Particle.Prewarm

getset

Scale

float Yukar.Common.Resource.Particle.Scale = 1.0f

getset

UseEmitterControl

bool Yukar.Common.Resource.Particle.UseEmitterControl

getset

UseEnvEffect

bool Yukar.Common.Resource.Particle.UseEnvEffect

getset