Logo
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
Yukar.Common.Rom.Effect Class Reference

A class that holds SGB effect data More...

Inheritance diagram for Yukar.Common.Rom.Effect:
Yukar.Common.Rom.RomItem Yukar.Common.Rom.IChunk

Classes

class  CellDef
 Cell information More...
 
class  ColorDef
 color information More...
 
class  FlashDef
 flash information More...
 
class  Frame
 frame information More...
 
class  NodeDef
 Node information More...
 
class  PosScaleDef
 Position/scale information More...
 
class  RotateDef
 rotation information More...
 

Public Types

enum  InterpolateType {
  NONE , LINEAR , EASE_IN , EASE_OUT ,
  EASE_IN_3X , EASE_OUT_3X
}
 complement type More...
 
enum  OrigPos { ORIG_CENTER , ORIG_FOOT , ORIG_SCREEN }
 origin More...
 
- Public Types inherited from Yukar.Common.Rom.RomItem
enum  ThumbnailStatusType { Empty = 0 , Creating , Created , Failed }
 Thumbnail image generation status More...
 

Public Member Functions

Frame getFrame (int index, bool create=true)
 
Frame getFrameByTiming (int timing, bool create=true)
 
override void save (System.IO.BinaryWriter writer)
 
string saveToCsv (Catalog catalog)
 
override void load (System.IO.BinaryReader reader)
 
override bool initializingAfterLoading ()
 Initialization process after loading More...
 
void setTiming (int index, int value)
 
- 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...
 

Public Attributes

Guid graphic
 
int nodeNum = 1
 
int numTiming
 
List< Frametimeline = new List<Frame>()
 
List< Guid > extraGraphic = new List<Guid>()
 
OrigPos origPos = OrigPos.ORIG_CENTER
 
- Public Attributes inherited from Yukar.Common.Rom.RomItem
Guid guId
 ID More...
 
String name
 name More...
 
string tags = ""
 tag More...
 
string category = ""
 category More...
 

Additional Inherited Members

- 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...
 
- 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 inherited from Yukar.Common.Rom.RomItem
virtual void Dispose (bool disposing)
 
- 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...
 

Detailed Description

A class that holds SGB effect data

Member Enumeration Documentation

◆ InterpolateType

enum Yukar.Common.Rom.Effect.InterpolateType

complement type

Enumerator
NONE 
LINEAR 
EASE_IN 
EASE_OUT 
EASE_IN_3X 
EASE_OUT_3X 

◆ OrigPos

enum Yukar.Common.Rom.Effect.OrigPos

origin

Enumerator
ORIG_CENTER 
ORIG_FOOT 
ORIG_SCREEN 

Member Function Documentation

◆ getFrame()

Frame Yukar.Common.Rom.Effect.getFrame ( int  index,
bool  create = true 
)

◆ getFrameByTiming()

Frame Yukar.Common.Rom.Effect.getFrameByTiming ( int  timing,
bool  create = true 
)

◆ initializingAfterLoading()

override bool Yukar.Common.Rom.Effect.initializingAfterLoading ( )
virtual

Initialization process after loading

Returns

Reimplemented from Yukar.Common.Rom.RomItem.

◆ load()

override void Yukar.Common.Rom.Effect.load ( System.IO.BinaryReader  reader)

◆ save()

override void Yukar.Common.Rom.Effect.save ( System.IO.BinaryWriter  writer)

◆ saveToCsv()

string Yukar.Common.Rom.Effect.saveToCsv ( Catalog  catalog)

◆ setTiming()

void Yukar.Common.Rom.Effect.setTiming ( int  index,
int  value 
)

Member Data Documentation

◆ extraGraphic

List<Guid> Yukar.Common.Rom.Effect.extraGraphic = new List<Guid>()

◆ graphic

Guid Yukar.Common.Rom.Effect.graphic

◆ nodeNum

int Yukar.Common.Rom.Effect.nodeNum = 1

◆ numTiming

int Yukar.Common.Rom.Effect.numTiming

◆ origPos

OrigPos Yukar.Common.Rom.Effect.origPos = OrigPos.ORIG_CENTER

◆ timeline

List<Frame> Yukar.Common.Rom.Effect.timeline = new List<Frame>()