ツリー構造データのフォルダ情報クラス [詳解]

Yukar.Common.Rom.Folder の継承関係図

公開メンバ関数
string	GetDisplayName (string inLanguage)
	指定された言語での表示名を取得 [詳解]

string	GetLocalName (string inLanguage)
	指定された言語でのローカル名を取得 [詳解]

void	SetLocalName (string inLanguage, string inName)
	指定された言語でのローカル名を設定 [詳解]

void	UpdateChildIds ()
	Childsの内容をChildIdsに反映 [詳解]

	Folder ()
	コンストラクタ [詳解]

override void	load (BinaryReader reader)
	読み込み [詳解]

override void	save (BinaryWriter writer)
	保存 [詳解]

override void	saveUsedGUID (BinaryWriter writer, bool inIncludeChildUseRomGUID)
	使用しているGUIDの書き出し(ツール用) [詳解]

void	initialize (Catalog inCatalog, bool includeChildrenFolder=false)
	フォルダのChildIdsからの初期化 [詳解]

void	AddChild (RomItem child, bool toTop=false)
	子要素の追加 [詳解]

void	RemoveChild (RomItem child)
	子要素の削除 [詳解]

List< RomItem >	AllItems (bool inIgnoreFolder=false)
	全ての子要素を取得 [詳解]

List< Folder >	AllFolders ()
	全ての子フォルダを取得 [詳解]

bool	IsEmpty (bool inIsResourceOnly)
	フォルダが空かどうか [詳解]

List< RomItem >	ParseChilds (bool inIsAll=true)
	全ての子要素を取得 [詳解]

string	FullPath ()
	フォルダのフルパスを取得 [詳解]

Common.Rom.Folder	FindChildFolder (string path)
	指定されたパスの子フォルダを検索 [詳解]

Folder	Clone ()
	フォルダのクローンを作成 [詳解]

基底クラス 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)
	使用しているGUIDの書き出し(ツール用) [詳解]

void	saveUsedGUID (BinaryWriter writer)
	使用しているGUIDの書き出し(ツール用) [詳解]

virtual bool	initializingAfterLoading ()
	ロード後の初期化処理 [詳解]

virtual void	reImport ()
	再インポート [詳解]

virtual void	export (string path)
	エクスポート [詳解]

virtual void	onCatalogCleanup ()
	カタログ解放時処理 [詳解]

virtual void	onNameChanged ()
	名前変更時の処理 [詳解]

void	copyFrom (Common.Rom.RomItem src)
	別のRomItemからデータをコピーする [詳解]

virtual void	CheckRecourceConsistency (Catalog inCatalog)
	整合性チェック(ツール用) [詳解]

virtual void	ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
	使用しているIdを対応するロムのIdに差し替える [詳解]

void	ClearId (List< Rom.RomItem > inClearRomItemList)
	リストのロムの使用を削除 [詳解]

void	Dispose ()

void	AddUpdatecall (int count)
	サムネイル生成の保留カウンタを増減する [詳解]

void	save (BinaryWriter writer)
	保存 [詳解]

void	load (BinaryReader reader)
	読み込み [詳解]

静的公開メンバ関数
static Common.Rom.Folder	FindChildFolder (Common.Rom.Folder parent, string path)
	指定されたパスの子フォルダを検索 [詳解]

基底クラス Yukar.Common.Rom.RomItem に属する継承静的公開メンバ関数
static bool	reImport (List< RomItem > inRomList)
	再インポート [詳解]

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)
	RomItemをクローンする [詳解]

static bool	equalChunk (IChunk a, IChunk b)
	チャンクの内容が等しいか [詳解]

static IChunk	duplicate (IChunk rom)
	IChunkを複製する [詳解]

公開変数類
Guid	dlcGuid = Guid.Empty
	DLC、またはシステムプロジェクトのGUID [詳解]

基底クラス Yukar.Common.Rom.RomItem に属する継承公開変数類
Guid	guId
	ID [詳解]

String	name
	名前 [詳解]

string	tags = ""
	タグ [詳解]

string	category = ""
	カテゴリ [詳解]

プロパティ
short	Signature `[get, set]`
	フォルダのシグネチャ(フォルダに格納される要素のシグネチャ) [詳解]

Dictionary< string, string >	LocalNameDic `[get]`
	ローカル名辞書 [詳解]

List< RomItem >	Childs `[get, set]`
	子要素リスト [詳解]

List< Guid >	ChildIds `[get, set]`
	子要素GUIDリスト [詳解]

bool	Visibility = true `[get, set]`
	フォルダの表示 [詳解]

bool	Locked = false `[get, set]`
	フォルダのロック [詳解]

bool	IsExpanded `[get, set]`
	フォルダの展開状態 [詳解]

基底クラス 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]`
	親フォルダ [詳解]

その他の継承メンバ
基底クラス Yukar.Common.Rom.RomItem に属する継承公開型
enum	ThumbnailStatusType { Empty = 0 , Creating , Created , Failed }
	サムネイル画像生成状況 [詳解]

基底クラス Yukar.Common.Rom.RomItem に属する継承静的公開変数類
static int	thumbnailWidth = 128
	サムネイル画像の幅(ピクセル) [詳解]

static int	thumbnailHeight = 128
	サムネイル画像の高さ(ピクセル) [詳解]

const char	CATEGORY_SPLITTER = '\\'
	カテゴリ区切り文字 [詳解]

static CREATETHUMBNAIL	createThumbnailFunction = null
	サムネイル生成関数 [詳解]

const int	UnknownRefCount = -2000
	参照カウントが不明な場合の定数 [詳解]

基底クラス Yukar.Common.Rom.RomItem に属する継承限定公開メンバ関数
virtual void	Dispose (bool disposing)

詳解

ツリー構造データのフォルダ情報クラス

構築子と解体子

◆ Folder()

Yukar.Common.Rom.Folder.Folder ( )

コンストラクタ

メソッド詳解

◆ AddChild()

void Yukar.Common.Rom.Folder.AddChild	(	RomItem	child,
		bool	toTop = `false`
	)

子要素の追加

引数

child	Rom
toTop	先頭に追加

◆ AllFolders()

List< Folder > Yukar.Common.Rom.Folder.AllFolders ( )

全ての子フォルダを取得

戻り値

◆ AllItems()

List< RomItem > Yukar.Common.Rom.Folder.AllItems ( bool inIgnoreFolder = false )

全ての子要素を取得

引数

inIgnoreFolder Folder型以外の子要素リストを取得

戻り値

◆ Clone()

Folder Yukar.Common.Rom.Folder.Clone ( )

フォルダのクローンを作成

戻り値

◆ FindChildFolder() [1/2]

static Common.Rom.Folder Yukar.Common.Rom.Folder.FindChildFolder	(	Common.Rom.Folder	parent,
		string	path
	)

static

指定されたパスの子フォルダを検索

引数

parent	親フォルダ
path	パス

戻り値

◆ FindChildFolder() [2/2]

Common.Rom.Folder Yukar.Common.Rom.Folder.FindChildFolder ( string path )

指定されたパスの子フォルダを検索

引数

path パス

戻り値

◆ FullPath()

string Yukar.Common.Rom.Folder.FullPath ( )

フォルダのフルパスを取得

戻り値

◆ GetDisplayName()

string Yukar.Common.Rom.Folder.GetDisplayName ( string inLanguage )

指定された言語での表示名を取得

引数

inLanguage 言語コード

戻り値

◆ GetLocalName()

string Yukar.Common.Rom.Folder.GetLocalName ( string inLanguage )

指定された言語でのローカル名を取得

引数

inLanguage 言語コード

戻り値

◆ initialize()

void Yukar.Common.Rom.Folder.initialize	(	Catalog	inCatalog,
		bool	includeChildrenFolder = `false`
	)

フォルダのChildIdsからの初期化

引数

inCatalog	カタログ
includeChildrenFolder	子フォルダも再帰的に初期化

◆ IsEmpty()

bool Yukar.Common.Rom.Folder.IsEmpty ( bool inIsResourceOnly )

フォルダが空かどうか

引数

inIsResourceOnly Folder型以外の子要素のみ対象

戻り値

◆ load()

override void Yukar.Common.Rom.Folder.load ( BinaryReader reader )

virtual

読み込み

引数

reader リーダー

Yukar.Common.Rom.RomItemを再実装しています。

◆ ParseChilds()

List< RomItem > Yukar.Common.Rom.Folder.ParseChilds ( bool inIsAll = true )

全ての子要素を取得

引数

inIsAll フォルダ内のフォルダも展開

戻り値

◆ RemoveChild()

void Yukar.Common.Rom.Folder.RemoveChild ( RomItem child )

子要素の削除

引数

child Rom

◆ save()

override void Yukar.Common.Rom.Folder.save ( BinaryWriter writer )

virtual

保存

引数

writer ライター

Yukar.Common.Rom.RomItemを再実装しています。

◆ saveUsedGUID()

override void Yukar.Common.Rom.Folder.saveUsedGUID	(	BinaryWriter	writer,
		bool	inIncludeChildUseRomGUID
	)

virtual

使用しているGUIDの書き出し(ツール用)

引数

writer	ライター
inIncludeChildUseRomGUID	使用しているロムが使用しているロムも含むか？

Yukar.Common.Rom.RomItemを再実装しています。

◆ SetLocalName()

void Yukar.Common.Rom.Folder.SetLocalName	(	string	inLanguage,
		string	inName
	)

指定された言語でのローカル名を設定

引数

inLanguage	言語コード
inName	ローカル名

◆ UpdateChildIds()

void Yukar.Common.Rom.Folder.UpdateChildIds ( )

Childsの内容をChildIdsに反映

メンバ詳解

◆ dlcGuid

Guid Yukar.Common.Rom.Folder.dlcGuid = Guid.Empty

DLC、またはシステムプロジェクトのGUID

プロパティ詳解

◆ ChildIds

List<Guid> Yukar.Common.Rom.Folder.ChildIds

getset

子要素GUIDリスト

◆ Childs

List<RomItem> Yukar.Common.Rom.Folder.Childs

getset

子要素リスト

◆ IsExpanded

bool Yukar.Common.Rom.Folder.IsExpanded

getset

フォルダの展開状態

◆ LocalNameDic

Dictionary<string, string> Yukar.Common.Rom.Folder.LocalNameDic

get

ローカル名辞書

◆ Locked

bool Yukar.Common.Rom.Folder.Locked = false

getset

フォルダのロック

◆ Signature

short Yukar.Common.Rom.Folder.Signature

getset

フォルダのシグネチャ(フォルダに格納される要素のシグネチャ)

◆ Visibility

bool Yukar.Common.Rom.Folder.Visibility = true

getset

フォルダの表示

公開メンバ関数

静的公開メンバ関数

公開変数類

プロパティ

その他の継承メンバ

詳解

構築子と解体子

◆ Folder()

メソッド詳解

◆ AddChild()

◆ AllFolders()

◆ AllItems()

◆ Clone()

◆ FindChildFolder() [1/2]

◆ FindChildFolder() [2/2]

◆ FullPath()

◆ GetDisplayName()

◆ GetLocalName()

◆ initialize()

◆ IsEmpty()

◆ load()

◆ ParseChilds()

◆ RemoveChild()

◆ save()

◆ saveUsedGUID()

◆ SetLocalName()

◆ UpdateChildIds()

メンバ詳解

◆ dlcGuid

プロパティ詳解

◆ ChildIds

◆ Childs

◆ IsExpanded

◆ LocalNameDic

◆ Locked

◆ Signature

◆ Visibility