Doomwad::Vertex Class Reference

Inheritance diagram for Doomwad::Vertex:

List of all members.

---

Detailed Description

Represents a single Vertex in a map.

See also:

Linedef Vertexes

Vertices are the fundamental building blocks of maps. They define points in space between which Linedefs exist.

Definition at line 73 of file vertexes.hpp.

Public Member Functions
virtual size_t	getLength (void) const throw ()
	Get the length of an element.
virtual bool	read (const Lump &lump, Lump::size_type i) throw ()
	Read this element from a Lump.
virtual std::string	toString (void) const throw ()
	Convert this element to a string.
	Vertex (int16=0, int16=0) throw ()
	Vertex constructor.
virtual bool	write (Lump &lump, Lump::size_type i) const throw ()
	Write this element into a Lump.
virtual	~Vertex (void) throw ()
	Vertex destructor.
Public Attributes
int16	x
	X coordinate.
int16	y
	Y coordinate.
Static Public Attributes
static const size_t	LENGTH = 0x00000004
	Length of a single record.

---

Constructor & Destructor Documentation

Vertex::Vertex (  int16  _x = 0, int16  _y = 0 )  throw ()

Vertex constructor. Constructs a vertex from two optional integers. Parameters: _x  X coordinate. _y  Y coordinate. Definition at line 62 of file vertexes.cpp.

---

Member Function Documentation

size_t Vertex::getLength (  void   )  const throw () [virtual]

Get the length of an element. Each element record type has a length. Some are fixed, in which case this function returns that length. Some records are variable-length, in which case this function returns zero. Returns: Length of the record. Implements Doomwad::WadEntryElement. Definition at line 73 of file vertexes.cpp. References LENGTH.

bool Vertex::read (  const Lump &  lump, Lump::size_type  i )  throw () [virtual]

Read this element from a Lump. Read one element from a Lump at the specified index. Parameters: lump  Reference to the target Lump. i  Index into the Lump's buffer. Returns: True if successful, false if not. Implements Doomwad::WadEntryElement. Definition at line 92 of file vertexes.cpp. Referenced by Doomwad::Vertexes::setFromLump().

std::string Vertex::toString (  void   )  const throw () [virtual]

Convert this element to a string. The format of the string will vary from class to class, but every subclass must be able to format itself as a string. IMPORTANT: this string representation is not guaranteed to preserve all data. Reading back in is not supported. This function's goal is to make the object's state user-readable, not machine-readable. Returns: std::string object containing object state. Implements Doomwad::WadEntryElement. Definition at line 106 of file vertexes.cpp. References x, and y.

bool Vertex::write (  Lump &  lump, Lump::size_type  i )  const throw () [virtual]

Write this element into a Lump. Write one element into a Lump at the specified index. Parameters: lump  Reference to the target Lump. i  Index into the Lump's buffer. Returns: True if successful, false if not. Implements Doomwad::WadEntryElement. Definition at line 78 of file vertexes.cpp.

---