C# Class KFreonLib.Textures.TPFTexInfo

Formerly TexNodeHash. Provides an object to store TPFTools texture objects.
Inheritance: abstractTexInfo, IDisposable
Show file Open project: ME3Explorer/ME3Explorer Class Usage Examples

Public Properties

Property Type Description
AutofixSuccess bool
ExpectedFormat ImageEngineFormat
ExpectedMips int
FileDuplicates List
FileName String
FilePath string
Height int
TPFInd int
ThumbInd int
Thumbnail System.IO.MemoryStream
TreeDuplicates List
Width int
found bool
wasAnalysed bool
zippy SaltTPF.ZipReader

Public Methods

Method Description
Autofixedpath ( string TemporaryPath ) : string
CalculateMipCount ( int Width, int Height ) : int
Clone ( ) : TPFTexInfo

Clones current TPF texture object.

Convert ( ) : void

Converts texture.

CreateModJob ( string ExecFolder, string pathBIOGame ) : ModMaker.ModJob

Create a .mod job from current TPF texture object.

DisplayString ( int index ) : string
DisplayString ( string file ) : string
Dispose ( ) : void
EnumerateDetails ( ) : void

Collects details of current texture, like thumbnail, number of mips, and format.

Extract ( string ExtractPath, bool ToMemory = false ) : byte[]

Extracts image from TPF or copies image data from external file. Also able to return a byte[] of image data.

FormatTexDetails ( bool Analysed ) : String

Format texture details for TPFTools.

GetFileFromDisplay ( string file ) : string
TPFTexInfo ( ) : KFreonLib.Debugging

Constructor for TPF texture object. Placeholder for lists.

TPFTexInfo ( string filename, int tpfind, string path, ZipReader zip, int WhichGame ) : KFreonLib.Debugging

Constructor for TPF texture objects.

UndoAnalysis ( int newGameVersion ) : void
UpdateTex ( int treeInd, TreeTexInfo treetex ) : void

Updates current texture object from tree.

ValidateDimensions ( TreeTexInfo tex = null ) : bool

Method Details

Autofixedpath() public method

public Autofixedpath ( string TemporaryPath ) : string
TemporaryPath string
return string

CalculateMipCount() public static method

public static CalculateMipCount ( int Width, int Height ) : int
Width int
Height int
return int

Clone() public method

Clones current TPF texture object.
public Clone ( ) : TPFTexInfo
return TPFTexInfo

Convert() public method

Converts texture.
public Convert ( ) : void
return void

CreateModJob() public method

Create a .mod job from current TPF texture object.
public CreateModJob ( string ExecFolder, string pathBIOGame ) : ModMaker.ModJob
ExecFolder string Path to ME3Explorer \exec\ folder.
pathBIOGame string Path to BIOGame.
return KFreonLib.Scripting.ModMaker.ModJob

DisplayString() public method

public DisplayString ( int index ) : string
index int
return string

DisplayString() public method

public DisplayString ( string file ) : string
file string
return string

Dispose() public method

public Dispose ( ) : void
return void

EnumerateDetails() public method

Collects details of current texture, like thumbnail, number of mips, and format.
public EnumerateDetails ( ) : void
return void

Extract() public method

Extracts image from TPF or copies image data from external file. Also able to return a byte[] of image data.
public Extract ( string ExtractPath, bool ToMemory = false ) : byte[]
ExtractPath string Path to extract image to.
ToMemory bool OPTIONAL: If true, byte[] of image data returned.
return byte[]

FormatTexDetails() public method

Format texture details for TPFTools.
public FormatTexDetails ( bool Analysed ) : String
Analysed bool Add extra stuff if analysis has been performed.
return String

GetFileFromDisplay() public method

public GetFileFromDisplay ( string file ) : string
file string
return string

TPFTexInfo() public method

Constructor for TPF texture object. Placeholder for lists.
public TPFTexInfo ( ) : KFreonLib.Debugging
return KFreonLib.Debugging

TPFTexInfo() public method

Constructor for TPF texture objects.
public TPFTexInfo ( string filename, int tpfind, string path, ZipReader zip, int WhichGame ) : KFreonLib.Debugging
filename string Filename of texture.
tpfind int Index of texture inside TPF, if applicable.
path string Path of texture, if applicable.
zip SaltTPF.ZipReader Zippy of TPF, if applicable.
WhichGame int
return KFreonLib.Debugging

UndoAnalysis() public method

public UndoAnalysis ( int newGameVersion ) : void
newGameVersion int
return void

UpdateTex() public method

Updates current texture object from tree.
public UpdateTex ( int treeInd, TreeTexInfo treetex ) : void
treeInd int Index of texture in tree.
treetex TreeTexInfo Tree texture object to get info from.
return void

ValidateDimensions() public method

public ValidateDimensions ( TreeTexInfo tex = null ) : bool
tex TreeTexInfo
return bool

Property Details

AutofixSuccess public property

public bool AutofixSuccess
return bool

ExpectedFormat public property

public ImageEngineFormat ExpectedFormat
return ImageEngineFormat

ExpectedMips public property

public int ExpectedMips
return int

FileDuplicates public property

public List FileDuplicates
return List

FileName public property

public String FileName
return String

FilePath public property

public string FilePath
return string

Height public property

public int Height
return int

TPFInd public property

public int TPFInd
return int

ThumbInd public property

public int ThumbInd
return int

Thumbnail public property

public MemoryStream,System.IO Thumbnail
return System.IO.MemoryStream

TreeDuplicates public property

public List TreeDuplicates
return List

Width public property

public int Width
return int

found public property

public bool found
return bool

wasAnalysed public property

public bool wasAnalysed
return bool

zippy public property

public ZipReader,SaltTPF zippy
return SaltTPF.ZipReader