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)
override void	save (BinaryWriter writer)
override void	saveUsedGUID (BinaryWriter writer, bool inIncludeChildUseRomGUID)
	Export the GUID you are using (for tools) More...
override string[]	getPathList ()
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)
override void	ChangeReImportPath ()
override void	reImport ()
override void	reload ()
override List< string >	getRelatedFiles ()
List< string >	getReferenceFilePathList ()
override void	export (string path)
override void	ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
override List< Guid >	GetUsedResourceIdList ()
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 ()
virtual void	initializeKmyGfx ()
override void	save (System.IO.BinaryWriter writer)
override void	load (System.IO.BinaryReader reader)
virtual void	setPath (string path)
virtual void	CopySourceResourceFile (string inSrcPath, string inDstPath=null, bool inIsOverwrite=false, bool inIsExistFileRename=false)
void	CopyOutsideResourceFile (bool inIsOverwrite=false, bool inIsExistFileRename=false)
bool	deleteResourceFile (Dictionary< string, int > inUsedFilePathCountDic, bool inIsAutoDeleteFile)
virtual List< string >	getRelatedFiles ()
virtual List< string >	getInternalFormatFilePath ()
virtual ErrorType	verify ()
bool	IsError (bool inCheckDispOnly=true)
bool	isSystemResource ()
bool	isDLCResource ()
void	setToModified ()
virtual string[]	getPathList ()
string	getExtension ()
virtual void	ChangeReImportPath ()
virtual List< Guid >	GetUsedResourceIdList ()
override void	ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
void	ClearResourceHolderCache ()
virtual void	reload ()
bool	isExistNewerTimeStamp ()
virtual void	renamePath (string inNewPath)
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)
	RomItem ()
System.Drawing.Bitmap	getThumbnail (THUMBNAILMAKERNOTIFY notify, out bool setNotify)
System.Drawing.Bitmap	getThumbnail (THUMBNAILMAKERNOTIFY notify)
System.Drawing.Bitmap	getThumbnail ()
void	invalidateThumbnail ()
void	invalidateThumbnail (THUMBNAILMAKERNOTIFY notify)
void	forceInvalidateThumbnail (THUMBNAILMAKERNOTIFY notify)
virtual void	save (BinaryWriter writer)
virtual void	load (BinaryReader reader)
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 ()
virtual void	reImport ()
virtual void	export (string path)
virtual void	onCatalogCleanup ()
virtual void	onNameChanged ()
void	copyFrom (Common.Rom.RomItem src)
virtual void	CheckRecourceConsistency (Catalog inCatalog)
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)
void	save (BinaryWriter writer)
void	load (BinaryReader reader)

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 void	writeChunk (System.IO.BinaryWriter writer, IChunk rom)
static void	readChunk (System.IO.BinaryReader reader, IChunk rom)
static void	skipChunk (System.IO.BinaryReader reader)
static T	Clone< T > (RomItem inSrc)
static bool	equalChunk (IChunk a, IChunk b)
static IChunk	duplicate (IChunk rom)

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
string	relatedPath = ""
string	path = ".\\"
Option	option = new Option()
ResourceSource	source = ResourceSource.RES_USER
Public Attributes inherited from Yukar.Common.Rom.RomItem
Guid	guId
String	name
string	tags = ""
string	category = ""

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 ()
void	updateSetuppedThumbnail ()
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]
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]
virtual string	ImportPath [get, set]
virtual string	SourceFileName [get]
string	SourceFolderName [get]
int	StampType [get, set]
bool	ForceExport [get, set]
virtual bool	ConvertableToInternalFormat [get]
string	resourcePath [get, set]
Properties inherited from Yukar.Common.Rom.RomItem
System.Drawing.Bitmap	Thumbnail [get]
ThumbnailStatusType	ThumbnailStatus = ThumbnailStatusType.Empty [get, set]
string	Name [get, set]
virtual int	RefCount [get]
virtual bool	UseRefCount [get]
Folder	Parent [get, set]

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
static bool	sReferenceLoad = false
static bool	sClipboardLoad = false
const string	TAG_3D = "#3D"
const string	TAG_2D = "#2D"
static Guid	sCurrentSourceGuid
Static Public Attributes inherited from Yukar.Common.Rom.RomItem
static int	thumbnailWidth = 128
static int	thumbnailHeight = 128
const char	CATEGORY_SPLITTER = '\\'
static CREATETHUMBNAIL	createThumbnailFunction = null
const int	UnknownRefCount = -2000

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

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

Reimplemented from Yukar.Common.Resource.ResourceItem.

export()

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

virtual

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

Reimplemented from Yukar.Common.Resource.ResourceItem.

getReferenceFilePathList()

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

(

)

getRelatedFiles()

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

virtual

Reimplemented from Yukar.Common.Resource.ResourceItem.

GetUsedResourceIdList()

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

virtual

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

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

Reimplemented from Yukar.Common.Rom.RomItem.

reload()

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

virtual

Reimplemented from Yukar.Common.Resource.ResourceItem.

save()

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

virtual

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

UseEnvEffect

bool Yukar.Common.Resource.Particle.UseEnvEffect

getset