Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Doomwad::GLSegs Class Reference

Inheritance diagram for Doomwad::GLSegs:

Doomwad::WadEntry List of all members.

Detailed Description

Collection of GLSeg objects.

See also:
GLMap GLNodes GLSeg GLSsectors WadEntry

Definition at line 183 of file segs.hpp.

Public Member Functions

 GLSegs (const Lump &) throw ()
 Construct from a Lump.
 GLSegs (void) throw ()
 Default constructor.
virtual bool setFromLump (const Lump &lump) throw ()
 Convert a Lump to this entry.
virtual Lump toLump (void) const throw ()
 Convert this entry to a Lump.
virtual Lump toLumpV1 (void) const throw ()
 Convert to a Lump.
virtual std::string toString (void) const throw ()
 Convert this entry to a std::string.
virtual ~GLSegs (void) throw ()
 Destructor.

Static Public Attributes

static const std::string NAME = "GL_SEGS"
 Name of an entry.
static const size_t V3_MARKER = 0x674E6433
 Marker identifying version three resources.


Constructor & Destructor Documentation

GLSegs::GLSegs const Lump lump  )  throw ()
 

Construct from a Lump.

Parameters:
lump Source Lump.

Definition at line 302 of file segs.cpp.

References setFromLump().


Member Function Documentation

bool GLSegs::setFromLump const Lump lump  )  throw () [virtual]
 

Convert a Lump to this entry.

Lumps should not know about specific data structures. Those structures know about Lumps, including how to convert from them.

Setting from a Lump involves parsing that Lump's contents to see if they are valid. If they are, then this object will contain what you expect it to. If not, it will return false and the atomic operation will not succeed.

Parameters:
lump Reference to a source Lump object.
Returns:
True if successful, false if not.

Implements Doomwad::WadEntry.

Definition at line 316 of file segs.cpp.

References Doomwad::Lump::size().

Referenced by GLSegs().

Lump GLSegs::toLump void   )  const throw () [virtual]
 

Convert this entry to a Lump.

Each subclass must be able to convert itself to a Lump for storage in a Wad.

Returns:
Lump containing the raw file representation of this entry.

Implements Doomwad::WadEntry.

Definition at line 323 of file segs.cpp.

References NAME.

Lump GLSegs::toLumpV1 void   )  const throw () [virtual]
 

Convert to a Lump.

Converts to a version 1 Lump.

Returns:
Lump containing object state.

Definition at line 337 of file segs.cpp.

References NAME.

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

Convert this entry to a std::string.

The exact implementation varies by the exact concrete class, but the idea is to convert the entry into a summary to be displayed to the user. Please note that converting to a string may lose information. This is not serialization in the purest sense of the word, this is merely a quick and dirty user-readable summary of the entry.

True serialization is achieved by converting a Lump object and using its stream I/O functions to read and write.

Returns:
std::string containing a summary of this entry.

Implements Doomwad::WadEntry.

Definition at line 344 of file segs.cpp.


Generated on Fri Jun 10 19:38:52 2005 for libdoomwad by  doxygen 1.4.0