Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

LwoHeader Class Reference

The first chunk in a Lightwave Object file. More...

#include <lwoHeader.h>

Inheritance diagram for LwoHeader:

LwoGroupChunk LwoChunk IffChunk TypedReferenceCount TypedObject ReferenceCount List of all members.

Public Member Functions

 LwoHeader ()
bool is_valid () const
 Returns true if the header represents a valid and recognized Lightwave header, false otherwise.

double get_version () const
 Returns the version of the Lightwave file.

virtual bool read_iff (IffInputFile *in, size_t stop_at)
 Reads the data of the chunk in from the given input file, if possible.

virtual void write (ostream &out, int indent_level=0) const
virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
int get_num_chunks () const
 Returns the number of child chunks of this group.

IffChunk * get_chunk (int n) const
 Returns the nth child chunk of this group.

IffId get_id () const
 Returns the ID associated with this chunk.

void set_id (IffId id)
 Changes the ID associated with this chunk.

virtual void output (ostream &out) const
virtual IffChunk * make_new_chunk (IffInputFile *in, IffId id)
 Allocates and returns a new chunk of the appropriate type based on the given ID, according to the context given by this chunk itself.

int get_type_index () const
bool is_of_type (TypeHandle handle) const
bool is_exact_type (TypeHandle handle) const
int get_ref_count () const
int ref () const
int unref () const
void test_ref_count_integrity () const

Static Public Member Functions

TypeHandle get_class_type ()
void init_type ()

Public Attributes

IffId _lwid

Protected Types

typedef pvector< PointerTo<
IffChunk > > 		Chunks

Protected Member Functions

bool read_chunks_iff (IffInputFile *in, size_t stop_at)
 Reads a sequence of child chunks, until byte stop_at has been been reached, and stores them as the children.

bool read_subchunks_iff (IffInputFile *in, size_t stop_at)
 Similar to read_chunks_iff(), but reads them as subchunks.

void write_chunks (ostream &out, int indent_level) const
 Formats the list of chunks for output to the user (primarily for debugging), one per line.


Protected Attributes

Chunks _chunks
int _ref_count

Private Attributes

bool _valid
double _version

Static Private Attributes

TypeHandle _type_handle

Detailed Description

The first chunk in a Lightwave Object file.

Definition at line 36 of file lwoHeader.h.

Member Typedef Documentation

typedef pvector< PointerTo< IffChunk > > LwoGroupChunk::Chunks [protected, inherited]
 

Definition at line 53 of file lwoGroupChunk.h.

Constructor & Destructor Documentation

LwoHeader::LwoHeader (   ) 
 

Definition at line 38 of file lwoHeader.cxx.

References _lwid, _valid, _version, DCAST, and IffInputFile::get_id().

Member Function Documentation

virtual TypeHandle LwoHeader::force_init_type (  void   )  [inline, virtual]
 

Reimplemented from LwoGroupChunk.

Definition at line 57 of file lwoHeader.h.

IffChunk * LwoGroupChunk::get_chunk (  int  n  )  const [inherited]
 

Returns the nth child chunk of this group.

Definition at line 51 of file lwoGroupChunk.cxx.

References LwoGroupChunk::_chunks, IffInputFile::get_bytes_read(), IffInputFile::get_chunk(), IffInputFile::is_eof(), NULL, and PT.

TypeHandle LwoHeader::get_class_type (  void   )  [inline, static]
 

Reimplemented from LwoGroupChunk.

Definition at line 58 of file lwoHeader.h.

IffId IffChunk::get_id (  void   )  const [inline, inherited]
 

Returns the ID associated with this chunk.

Definition at line 43 of file iffChunk.I.

References IffChunk::_id, and INLINE.

Referenced by LwoTags::read_iff(), LwoSurfaceSmoothingAngle::read_iff(), LwoSurfaceSidedness::read_iff(), LwoSurfaceParameter::read_iff(), LwoSurfaceColor::read_iff(), LwoSurfaceBlockWrap::read_iff(), LwoSurfaceBlockVMapName::read_iff(), LwoSurfaceBlockTransform::read_iff(), LwoSurfaceBlockTMap::read_iff(), LwoSurfaceBlockRepeat::read_iff(), LwoSurfaceBlockRefObj::read_iff(), LwoSurfaceBlockProjection::read_iff(), LwoSurfaceBlockOpacity::read_iff(), LwoSurfaceBlockImage::read_iff(), LwoSurfaceBlockHeader::read_iff(), LwoSurfaceBlockEnabled::read_iff(), LwoSurfaceBlockCoordSys::read_iff(), LwoSurfaceBlockChannel::read_iff(), LwoSurfaceBlockAxis::read_iff(), LwoSurface::read_iff(), LwoStillImage::read_iff(), LwoPolygonTags::read_iff(), LwoPoints::read_iff(), LwoClip::read_iff(), LwoBoundingBox::read_iff(), and IffGenericChunk::read_iff().

int LwoGroupChunk::get_num_chunks (   )  const [inherited]
 

Returns the number of child chunks of this group.

Definition at line 38 of file lwoGroupChunk.cxx.

References LwoGroupChunk::_chunks, nassertr, and NULL.

virtual TypeHandle LwoHeader::get_type (  void   )  const [inline, virtual]
 

Reimplemented from LwoGroupChunk.

Definition at line 54 of file lwoHeader.h.

double LwoHeader::get_version (   )  const [inline]
 

Returns the version of the Lightwave file.

Definition at line 47 of file lwoHeader.I.

void LwoHeader::init_type (  void   )  [inline, static]
 

Reimplemented from LwoGroupChunk.

Definition at line 61 of file lwoHeader.h.

References _type_handle.

bool LwoHeader::is_valid (   )  const [inline]
 

Returns true if the header represents a valid and recognized Lightwave header, false otherwise.

Definition at line 34 of file lwoHeader.I.

References _version, and INLINE.

IffChunk * IffChunk::make_new_chunk (  IffInputFile *  in,
IffId  id
)  [virtual, inherited]
 

Allocates and returns a new chunk of the appropriate type based on the given ID, according to the context given by this chunk itself.

Reimplemented in LwoClip, LwoSurface, LwoSurfaceBlock, LwoSurfaceBlockHeader, and LwoSurfaceBlockTMap.

Definition at line 66 of file iffChunk.cxx.

Referenced by IffInputFile::get_chunk(), LwoSurfaceBlockTMap::write(), and LwoClip::write().

void IffChunk::output (  ostream &  out  )  const [virtual, inherited]
 

Definition at line 37 of file iffChunk.cxx.

References IffChunk::_id, and indent().

bool LwoGroupChunk::read_chunks_iff (  IffInputFile *  in,
size_t  stop_at
)  [protected, inherited]
 

Reads a sequence of child chunks, until byte stop_at has been been reached, and stores them as the children.

Returns true if successful (and exactly the correct number of bytes were read), or false otherwise.

Definition at line 73 of file lwoGroupChunk.cxx.

References LwoGroupChunk::_chunks, IffInputFile::get_bytes_read(), IffInputFile::get_subchunk(), IffInputFile::is_eof(), NULL, and PT.

bool LwoHeader::read_iff (  IffInputFile *  in,
size_t  stop_at
)  [virtual]
 

Reads the data of the chunk in from the given input file, if possible.

The ID and length of the chunk have already been read. stop_at is the byte position of the file to stop at (based on the current position at in->get_bytes_read()). Returns true on success, false otherwise.

Implements IffChunk.

Definition at line 62 of file lwoHeader.cxx.

References _version, and LwoInputFile::set_lwo_version().

bool LwoGroupChunk::read_subchunks_iff (  IffInputFile *  in,
size_t  stop_at
)  [protected, inherited]
 

Similar to read_chunks_iff(), but reads them as subchunks.

Definition at line 96 of file lwoGroupChunk.cxx.

References LwoGroupChunk::_chunks.

void IffChunk::set_id (  IffId  id  )  [inline, inherited]
 

Changes the ID associated with this chunk.

Definition at line 56 of file iffChunk.I.

void LwoHeader::write (  ostream &  out,
int  indent_level = 0
)  const [virtual]
 

Reimplemented from IffChunk.

Definition at line 92 of file lwoHeader.cxx.

void LwoGroupChunk::write_chunks (  ostream &  out,
int  indent_level
)  const [protected, inherited]
 

Formats the list of chunks for output to the user (primarily for debugging), one per line.

Definition at line 119 of file lwoGroupChunk.cxx.

Referenced by LwoSurfaceBlockTMap::read_iff(), LwoSurface::read_iff(), and LwoClip::read_iff().

Member Data Documentation

Chunks LwoGroupChunk::_chunks [protected, inherited]
 

Definition at line 54 of file lwoGroupChunk.h.

Referenced by LwoGroupChunk::get_chunk(), LwoGroupChunk::get_num_chunks(), LwoGroupChunk::read_chunks_iff(), and LwoGroupChunk::read_subchunks_iff().

IffId LwoHeader::_lwid
 

Definition at line 40 of file lwoHeader.h.

Referenced by LwoHeader().

TypeHandle LwoHeader::_type_handle [static, private]
 

Reimplemented from LwoGroupChunk.

Definition at line 28 of file lwoHeader.cxx.

Referenced by init_type().

bool LwoHeader::_valid [private]
 

Definition at line 50 of file lwoHeader.h.

Referenced by LwoHeader().

double LwoHeader::_version [private]
 

Definition at line 51 of file lwoHeader.h.

Referenced by is_valid(), LwoHeader(), and read_iff().

The documentation for this class was generated from the following files:
Generated on Fri May 2 03:27:27 2003 for Panda-Tool by doxygen1.3