Logo
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Properties | List of all members
Yukar.Common.Resource.Model Class Reference

A class that manages model resources More...

Inheritance diagram for Yukar.Common.Resource.Model:
Yukar.Common.Resource.ResourceItem Yukar.Common.Rom.RomItem Yukar.Common.Rom.IChunk

Public Member Functions

delegate int ERRCHECKER (string path)
 
delegate bool CONVERTER (ref string path, ref string ext, string tmpPath, float scale)
 
 Model ()
 
override void onCatalogCleanup ()
 Catalog release processing More...
 
void updateMaterialSet ()
 
override void ChangeReImportPath ()
 Change re-import destination More...
 
override void reImport ()
 Reimport More...
 
void reImport (ImportOption.ModelReImport.ReImportOption inOption)
 
override void reload ()
 Reload resource files More...
 
override void export (string dstpath)
 export More...
 
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...
 
void createInternalUseModel (string path)
 
List< string > loadDefFile (string defFileName)
 
List< string > getTexListFromDef (List< string > defList, bool isRemoveGuid=false)
 
void getTextureAndDef (List< string > outDefList, List< string > outTexList, string workFileName)
 
override bool initializingAfterLoading ()
 Initialization process after loading More...
 
override void initializeKmyGfx ()
 Resource initialization processing More...
 
override void ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
 
override void setNativeResourcePath (string inFolderPath)
 set full path of native resource for system project y More...
 
void overwriteImport (string newPath, bool inOptimize, float inScale)
 simple overwrite import More...
 
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 float getSize (string srcpath)
 Get maximum model size More...
 
static string makeCreatePath (string srcpath, bool overwrite=false)
 Get the path to copy the model file to More...
 
static Model import (string srcpath, string createpath, bool optimize, float scale, bool newTexture)
 
static Model convert (string path, bool genMaterial, Option option)
 
static void convertToResourceAll (Catalog catalog)
 
- 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

MaterialSet m_materialSet = new MaterialSet()
 
SharpKmyGfx.ModelData m_mdl = null
 
bool m_isShield = false
 
SharpKmyMath.Vector3 m_previewOffset = new SharpKmyMath.Vector3()
 
SharpKmyMath.Vector3 m_previewAngle = new SharpKmyMath.Vector3()
 
bool vertexCompressMode = true
 
float vrmSpringBoneLimit = -1
 
- 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...
 

Static Public Attributes

static int errorHandle = 0
 
static ERRCHECKER errchecker = null
 
static CONVERTER converter = null
 
- 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...
 

Protected Member Functions

override bool IsErrorImp (bool inCheckDispOnly)
 
override List< ResourceHolderGetResourceHolderList ()
 
override void afterRenamePath (string inNewPath)
 
- Protected Member Functions inherited from Yukar.Common.Resource.ResourceItem
virtual bool IsErrorImp (bool inCheckDispOnly)
 
string checkReImportPath (string importPath, string filter, bool changeReImportPath)
 
virtual List< ResourceHolderGetResourceHolderList ()
 
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 OptimizeScale [get]
 
bool VertexCompressMode [get, set]
 
float VrmSpringBoneLimit [get, set]
 
bool VrmUseSpringBoneLimit [get, set]
 
override bool ConvertableToInternalFormat [get]
 
- 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...
 

Detailed Description

A class that manages model resources

Constructor & Destructor Documentation

◆ Model()

Yukar.Common.Resource.Model.Model ( )

Member Function Documentation

◆ afterRenamePath()

override void Yukar.Common.Resource.Model.afterRenamePath ( string  inNewPath)
protectedvirtual

◆ ChangeId()

override void Yukar.Common.Resource.Model.ChangeId ( Dictionary< Guid, Rom.RomItem >  inChangeIdDic)

◆ ChangeReImportPath()

override void Yukar.Common.Resource.Model.ChangeReImportPath ( )
virtual

Change re-import destination

Reimplemented from Yukar.Common.Resource.ResourceItem.

◆ convert()

static Model Yukar.Common.Resource.Model.convert ( string  path,
bool  genMaterial,
Option  option 
)
static

◆ CONVERTER()

delegate bool Yukar.Common.Resource.Model.CONVERTER ( ref string  path,
ref string  ext,
string  tmpPath,
float  scale 
)

◆ convertToResourceAll()

static void Yukar.Common.Resource.Model.convertToResourceAll ( Catalog  catalog)
static

◆ createInternalUseModel()

void Yukar.Common.Resource.Model.createInternalUseModel ( string  path)

◆ ERRCHECKER()

delegate int Yukar.Common.Resource.Model.ERRCHECKER ( string  path)

◆ export()

override void Yukar.Common.Resource.Model.export ( string  path)
virtual

export

Parameters
pathexport folder path

Reimplemented from Yukar.Common.Rom.RomItem.

◆ GetResourceHolderList()

override List< ResourceHolder > Yukar.Common.Resource.Model.GetResourceHolderList ( )
protectedvirtual

◆ getSize()

static float Yukar.Common.Resource.Model.getSize ( string  srcpath)
static

Get maximum model size

Parameters
srcpathmodel path
Returns
Maximum size

◆ getTexListFromDef()

List< string > Yukar.Common.Resource.Model.getTexListFromDef ( List< string >  defList,
bool  isRemoveGuid = false 
)

◆ getTextureAndDef()

void Yukar.Common.Resource.Model.getTextureAndDef ( List< string >  outDefList,
List< string >  outTexList,
string  workFileName 
)

◆ import()

static Model Yukar.Common.Resource.Model.import ( string  srcpath,
string  createpath,
bool  optimize,
float  scale,
bool  newTexture 
)
static

◆ initializeKmyGfx()

override void Yukar.Common.Resource.Model.initializeKmyGfx ( )
virtual

Resource initialization processing

Reimplemented from Yukar.Common.Resource.ResourceItem.

◆ initializingAfterLoading()

override bool Yukar.Common.Resource.Model.initializingAfterLoading ( )
virtual

Initialization process after loading

Returns

Reimplemented from Yukar.Common.Rom.RomItem.

◆ IsErrorImp()

override bool Yukar.Common.Resource.Model.IsErrorImp ( bool  inCheckDispOnly)
protectedvirtual

◆ load()

override void Yukar.Common.Resource.Model.load ( BinaryReader  reader)
virtual

loading

Parameters
readerleader

Reimplemented from Yukar.Common.Rom.RomItem.

◆ loadDefFile()

List< string > Yukar.Common.Resource.Model.loadDefFile ( string  defFileName)

◆ makeCreatePath()

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

Get the path to copy the model file to

Parameters
srcpathPath of the model file to import from
overwriteOverwrite?
Returns
Path to copy model files to

◆ onCatalogCleanup()

override void Yukar.Common.Resource.Model.onCatalogCleanup ( )
virtual

Catalog release processing

Reimplemented from Yukar.Common.Rom.RomItem.

◆ overwriteImport() [1/2]

void Yukar.Common.Resource.Model.overwriteImport ( string  newPath)

simple overwrite import

Parameters
newPathnew import file

◆ overwriteImport() [2/2]

void Yukar.Common.Resource.Model.overwriteImport ( string  newPath,
bool  inOptimize,
float  inScale 
)

simple overwrite import

Parameters
newPathnew import file
inOptimizeOptimize?
inScalescale

◆ reImport() [1/2]

override void Yukar.Common.Resource.Model.reImport ( )
virtual

Reimport

Reimplemented from Yukar.Common.Rom.RomItem.

◆ reImport() [2/2]

void Yukar.Common.Resource.Model.reImport ( ImportOption.ModelReImport.ReImportOption  inOption)

◆ reload()

override void Yukar.Common.Resource.Model.reload ( )
virtual

Reload resource files

Reimplemented from Yukar.Common.Resource.ResourceItem.

◆ save()

override void Yukar.Common.Resource.Model.save ( BinaryWriter  writer)
virtual

keep

Parameters
writerWriter

Reimplemented from Yukar.Common.Rom.RomItem.

◆ saveUsedGUID()

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

Export the GUID you are using (for tools)

Parameters
writerWriter
inIncludeChildUseRomGUIDDoes it also include the roms used by the roms used?

Reimplemented from Yukar.Common.Rom.RomItem.

◆ setNativeResourcePath()

override void Yukar.Common.Resource.Model.setNativeResourcePath ( string  inFolderPath)
virtual

set full path of native resource for system project y

Parameters
inFolderPathCurrent folder path of the project

Reimplemented from Yukar.Common.Resource.ResourceItem.

◆ updateMaterialSet()

void Yukar.Common.Resource.Model.updateMaterialSet ( )

Member Data Documentation

◆ converter

CONVERTER Yukar.Common.Resource.Model.converter = null
static

◆ errchecker

ERRCHECKER Yukar.Common.Resource.Model.errchecker = null
static

◆ errorHandle

int Yukar.Common.Resource.Model.errorHandle = 0
static

◆ m_isShield

bool Yukar.Common.Resource.Model.m_isShield = false

◆ m_materialSet

MaterialSet Yukar.Common.Resource.Model.m_materialSet = new MaterialSet()

◆ m_mdl

SharpKmyGfx.ModelData Yukar.Common.Resource.Model.m_mdl = null

◆ m_previewAngle

SharpKmyMath.Vector3 Yukar.Common.Resource.Model.m_previewAngle = new SharpKmyMath.Vector3()

◆ m_previewOffset

SharpKmyMath.Vector3 Yukar.Common.Resource.Model.m_previewOffset = new SharpKmyMath.Vector3()

◆ vertexCompressMode

bool Yukar.Common.Resource.Model.vertexCompressMode = true

◆ vrmSpringBoneLimit

float Yukar.Common.Resource.Model.vrmSpringBoneLimit = -1

Property Documentation

◆ ConvertableToInternalFormat

override bool Yukar.Common.Resource.Model.ConvertableToInternalFormat
get

◆ ImportPath

override string Yukar.Common.Resource.Model.ImportPath
getset

◆ OptimizeScale

float Yukar.Common.Resource.Model.OptimizeScale
get

◆ VertexCompressMode

bool Yukar.Common.Resource.Model.VertexCompressMode
getset

◆ VrmSpringBoneLimit

float Yukar.Common.Resource.Model.VrmSpringBoneLimit
getset

◆ VrmUseSpringBoneLimit

bool Yukar.Common.Resource.Model.VrmUseSpringBoneLimit
getset