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

A class that manages material settings for material resources More...

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

Public Member Functions

 Material ()
 
 Material (SharpKmyGfx.Material material)
 
override void onCatalogCleanup ()
 Catalog release processing More...
 
void updateText ()
 
void setText (string txt)
 
SharpKmyGfx.Material getMaterial ()
 
override void load (System.IO.BinaryReader reader)
 
void invalidateReferencingModelThumbnail ()
 
void postLoad ()
 
override void initializeKmyGfx ()
 Resource initialization processing More...
 
override void save (System.IO.BinaryWriter writer)
 
override void saveUsedGUID (BinaryWriter writer, bool inIncludeChildUseRomGUID)
 Export the GUID you are using (for tools) More...
 
List< Guid > getTextureIds (bool inIsRaw=false, bool inRemoveEmpty=true)
 Get the Id of the texture you are using More...
 
override bool initializingAfterLoading ()
 Initialization process after loading More...
 
override void ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
 
override List< Guid > GetUsedResourceIdList ()
 Get list of used resource IDs More...
 
override void onNameChanged ()
 Processing when renaming More...
 
void NormalizeTexture ()
 Remove non-existing textures More...
 
string getShaderDescription ()
 
bool getSlotName (int index, ref SharpKmyGfx.UNIFORMPARAMTYPE ptype, ref bool hideInEdtior, out string name, out string localName)
 
string getDescription (string name)
 
- 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 List< Guid > getTextureIds (SharpKmyGfx.Material inMaterial, bool inIsRaw=false, bool inRemoveEmpty=true)
 Get the Id of the texture used in the material More...
 
static void saveUsedGUID (BinaryWriter writer, SharpKmyGfx.Material mtl)
 
- 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

string m_image = ""
 
string m_modelMaterialName = ""
 
int version = nowVersion
 
- 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 Guid CollisionId = new Guid("99276bc3-70b4-4bd9-8327-a70bad256da4")
 
- 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 void Dispose (bool disposing)
 
- 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)
 
virtual void Dispose (bool disposing)
 

Properties

Catalog Catalog [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...
 

Detailed Description

A class that manages material settings for material resources

Constructor & Destructor Documentation

◆ Material() [1/2]

Yukar.Common.Resource.Material.Material ( )

◆ Material() [2/2]

Yukar.Common.Resource.Material.Material ( SharpKmyGfx.Material  material)

Member Function Documentation

◆ ChangeId()

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

◆ Dispose()

override void Yukar.Common.Resource.Material.Dispose ( bool  disposing)
protectedvirtual

Reimplemented from Yukar.Common.Rom.RomItem.

◆ getDescription()

string Yukar.Common.Resource.Material.getDescription ( string  name)

◆ getMaterial()

SharpKmyGfx.Material Yukar.Common.Resource.Material.getMaterial ( )

◆ getShaderDescription()

string Yukar.Common.Resource.Material.getShaderDescription ( )

◆ getSlotName()

bool Yukar.Common.Resource.Material.getSlotName ( int  index,
ref SharpKmyGfx.UNIFORMPARAMTYPE  ptype,
ref bool  hideInEdtior,
out string  name,
out string  localName 
)

◆ getTextureIds() [1/2]

List< Guid > Yukar.Common.Resource.Material.getTextureIds ( bool  inIsRaw = false,
bool  inRemoveEmpty = true 
)

Get the Id of the texture you are using

Parameters
inIsRawDo not delete even if there is the same Id
inRemoveEmptyremove empty texture
Returns
texture id list

◆ getTextureIds() [2/2]

static List< Guid > Yukar.Common.Resource.Material.getTextureIds ( SharpKmyGfx.Material  inMaterial,
bool  inIsRaw = false,
bool  inRemoveEmpty = true 
)
static

Get the Id of the texture used in the material

Parameters
inMaterialmaterial
inIsRawDo not delete even if there is the same Id
inRemoveEmptyremove empty texture
Returns
texture id list

◆ GetUsedResourceIdList()

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

Get list of used resource IDs

Returns

Reimplemented from Yukar.Common.Resource.ResourceItem.

◆ initializeKmyGfx()

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

Resource initialization processing

Reimplemented from Yukar.Common.Resource.ResourceItem.

◆ initializingAfterLoading()

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

Initialization process after loading

Returns

Reimplemented from Yukar.Common.Rom.RomItem.

◆ invalidateReferencingModelThumbnail()

void Yukar.Common.Resource.Material.invalidateReferencingModelThumbnail ( )

◆ IsErrorImp()

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

◆ load()

override void Yukar.Common.Resource.Material.load ( System.IO.BinaryReader  reader)

◆ NormalizeTexture()

void Yukar.Common.Resource.Material.NormalizeTexture ( )

Remove non-existing textures

◆ onCatalogCleanup()

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

Catalog release processing

Reimplemented from Yukar.Common.Rom.RomItem.

◆ onNameChanged()

override void Yukar.Common.Resource.Material.onNameChanged ( )
virtual

Processing when renaming

Reimplemented from Yukar.Common.Rom.RomItem.

◆ postLoad()

void Yukar.Common.Resource.Material.postLoad ( )

◆ save()

override void Yukar.Common.Resource.Material.save ( System.IO.BinaryWriter  writer)

◆ saveUsedGUID() [1/2]

override void Yukar.Common.Resource.Material.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.

◆ saveUsedGUID() [2/2]

static void Yukar.Common.Resource.Material.saveUsedGUID ( BinaryWriter  writer,
SharpKmyGfx.Material  mtl 
)
static

◆ setText()

void Yukar.Common.Resource.Material.setText ( string  txt)

◆ updateText()

void Yukar.Common.Resource.Material.updateText ( )

Member Data Documentation

◆ CollisionId

Guid Yukar.Common.Resource.Material.CollisionId = new Guid("99276bc3-70b4-4bd9-8327-a70bad256da4")
static

◆ m_image

string Yukar.Common.Resource.Material.m_image = ""

◆ m_modelMaterialName

string Yukar.Common.Resource.Material.m_modelMaterialName = ""

◆ version

int Yukar.Common.Resource.Material.version = nowVersion

Property Documentation

◆ Catalog

Catalog Yukar.Common.Resource.Material.Catalog
getset