Package net.mtrop.doom.texture

Class CommonPatch

java.lang.Object

net.mtrop.doom.texture.CommonPatch

All Implemented Interfaces:

BinaryObject

Direct Known Subclasses:

DoomTextureList.Texture.Patch, StrifeTextureList.Texture.Patch

public abstract class CommonPatch
extends Object
implements BinaryObject

Singular patch entry for a texture.

Nested Class Summary

Nested classes/interfaces inherited from interface net.mtrop.doom.object.BinaryObject

BinaryObject.InlineScanner<BO extends BinaryObject>, BinaryObject.Reflect, BinaryObject.Scanner<BO extends BinaryObject>, BinaryObject.Shared, BinaryObject.Transformer<BO extends BinaryObject>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	originX	Horizontal offset of the patch.
protected int	originY	Vertical offset of the patch.
protected int	patchIndex	Index of patch in patch names lump to use.

Constructor Summary

Constructors

Constructor	Description
CommonPatch()

Method Summary

Modifier and Type	Method	Description
int	getNameIndex()
int	getOriginX()
int	getOriginY()
void	setNameIndex(int patchIndex)	Sets the patch's index into the patch name lump.
void	setOriginX(int originX)	Sets the horizontal offset of the patch in pixels.
void	setOriginY(int originY)	Sets the vertical offset of the patch in pixels.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.mtrop.doom.object.BinaryObject

fromBytes, readBytes, readFile, toBytes, writeBytes, writeFile, writeFile

Field Details

originX

protected int originX

Horizontal offset of the patch.

originY

protected int originY

Vertical offset of the patch.

patchIndex

protected int patchIndex

Index of patch in patch names lump to use.

Constructor Details

CommonPatch

public CommonPatch()

Method Details

getOriginX

public int getOriginX()

Returns:

the horizontal offset of the patch in pixels.

setOriginX

public void setOriginX(int originX)

Sets the horizontal offset of the patch in pixels.

Parameters:

originX - the patch origin, x-coordinate.

Throws:

IllegalArgumentException - if originX is less than -32768 or more than 32767.

getOriginY

public int getOriginY()

Returns:

the vertical offset of the patch in pixels.

setOriginY

public void setOriginY(int originY)

Sets the vertical offset of the patch in pixels.

Parameters:

originY - the patch origin, y-coordinate.

Throws:

IllegalArgumentException - if originY is less than -32768 or more than 32767.

getNameIndex

public int getNameIndex()

Returns:

the patch's index into the patch name lump.

setNameIndex

public void setNameIndex(int patchIndex)

Sets the patch's index into the patch name lump.

Parameters:

patchIndex - the patch index.

Throws:

IllegalArgumentException - if patchIndex is less than 0 or more than 65535.

See Also:

• PatchNames

toString

public String toString()

Overrides:

toString in class Object