C# Class XCom.Interfaces.IXCImageFile

Class that contains all information needed to read/save image files and collections. This class should not be instantiated directly. Upon startup, objects from derived classes will be created and tracked

Inheritance: IAssemblyLoadable, IOpenSave

Datei anzeigen Open project: pmprog/OpenXCOM.Tools Class Usage Examples

Protected Properties

Property	Type	Description
author	string
defPal	Palette
expDesc	string
ext	string
fileOptions	xcFileOptions
imageSize	System.Drawing.Size
singleFile	string

Public Methods

Method	Description
IXCImageFile ( ) : System	Creates an object of this class with width and height of 0
IXCImageFile ( int width, int height ) : System	It is not recommended to instantiate objects of this type directly. See PckView.xcProfile for a generic implementation that does not throw runtime exceptions
LoadFile ( string directory, string file ) : XCImageCollection	Calls LoadFile with ImageSize.Width and ImageSize.Height
LoadFile ( string directory, string file, int imgWid, int imgHei ) : XCImageCollection	Method that calls the overloaded load function in order to do some similar functionality across all instances of this class
LoadFile ( string directory, string file, int imgWid, int imgHei, Palette pal ) : XCImageCollection
RegisterFile ( ) : bool	See: AssemblyLoadable.RegisterFile
SaveCollection ( string directory, string file, XCImageCollection images ) : void	Saves a collection
Unload ( ) : void

Protected Methods

Method	Description
LoadFileOverride ( string directory, string file, int imgWid, int imgHei, Palette pal ) : XCImageCollection	Load a file and return a collection of images

Method Details

IXCImageFile() public method

Creates an object of this class with width and height of 0

public IXCImageFile ( ) : System
return	System

IXCImageFile() public method

It is not recommended to instantiate objects of this type directly. See PckView.xcProfile for a generic implementation that does not throw runtime exceptions

public IXCImageFile ( int width, int height ) : System
width	int	Default width
height	int	Default Height
return	System

LoadFile() public method

Calls LoadFile with ImageSize.Width and ImageSize.Height

public LoadFile ( string directory, string file ) : XCImageCollection
directory	string
file	string
return	XCImageCollection

LoadFile() public method

Method that calls the overloaded load function in order to do some similar functionality across all instances of this class

public LoadFile ( string directory, string file, int imgWid, int imgHei ) : XCImageCollection
directory	string
file	string
imgWid	int
imgHei	int
return	XCImageCollection

LoadFile() public method

public LoadFile ( string directory, string file, int imgWid, int imgHei, Palette pal ) : XCImageCollection
directory	string
file	string
imgWid	int
imgHei	int
pal	Palette
return	XCImageCollection

LoadFileOverride() protected method

Load a file and return a collection of images

protected LoadFileOverride ( string directory, string file, int imgWid, int imgHei, Palette pal ) : XCImageCollection
directory	string
file	string
imgWid	int
imgHei	int
pal	Palette
return	XCImageCollection

RegisterFile() public method

See: AssemblyLoadable.RegisterFile

public RegisterFile ( ) : bool
return	bool

SaveCollection() public method

Saves a collection

public SaveCollection ( string directory, string file, XCImageCollection images ) : void
directory	string	Directory to save to
file	string	Filename
images	XCImageCollection	images to save in this format
return	void

Unload() public method

public Unload ( ) : void
return	void

Property Details

author protected_oe property

protected string author
return	string

defPal protected_oe property

protected Palette defPal
return	Palette

expDesc protected_oe property

protected string expDesc
return	string

ext protected_oe property

protected string ext
return	string

fileOptions protected_oe property

protected xcFileOptions,XCom.Interfaces fileOptions
return	xcFileOptions

imageSize protected_oe property

protected System.Drawing.Size imageSize
return	System.Drawing.Size

singleFile protected_oe property

protected string singleFile
return	string