This is the base class of both TextureImage and PaletteImage. More...

#include "imageFile.h"

Inheritance diagram for ImageFile:
TypedWritable TypedObject MemoryBase DestTextureImage PaletteImage SourceTextureImage TextureImage

List of all members.

Public Member Functions

void clear_basic_properties ()
 Resets the properties to a neutral state, for instance in preparation for calling update_properties() with all the known contributing properties.
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Called after the object is otherwise completely read from a Bam file, this function's job is to store the pointers that were retrieved from the Bam file for each pointer object written.
bool exists () const
 Returns true if the file or files named by the image file exist, false otherwise.
int get_alpha_file_channel () const
 Returns the particular channel number of the alpha image file from which the alpha channel should be extracted.
const Filenameget_alpha_filename () const
 Returns the alpha filename of the image file.
const Filenameget_filename () const
 Returns the primary filename of the image file.
int get_num_channels () const
 Returns the number of channels of the image.
const TexturePropertiesget_properties () const
 Returns the grouping properties of the image.
virtual TypeHandle get_type () const
int get_x_size () const
 Returns the size of the image file in pixels in the X direction.
int get_y_size () const
 Returns the size of the image file in pixels in the Y direction.
bool has_num_channels () const
 Returns true if the number of channels in the image is known, false otherwise.
bool is_size_known () const
 Returns true if the size of the image file is known, false otherwise.
bool make_shadow_image (const string &basename)
 Sets up the ImageFile as a "shadow image" of a particular PaletteImage.
void output_filename (ostream &out) const
 Writes the filename (or pair of filenames) to the indicated output stream.
bool read (PNMImage &image) const
 Reads in the image (or images, if the alpha_filename is separate) and stores it in the indicated PNMImage.
bool set_filename (const string &dirname, const string &basename)
 Sets the filename, and if applicable, the alpha_filename, from the indicated basename.
bool set_filename (PaletteGroup *group, const string &basename)
 Sets the filename, and if applicable, the alpha_filename, from the indicated basename.
void unlink ()
 Deletes the image file or files.
void update_egg_tex (EggTexture *egg_tex) const
 Sets the indicated EggTexture to refer to this file.
void update_properties (const TextureProperties &properties)
 If the indicate TextureProperties structure is more specific than this one, updates this one.
bool write (const PNMImage &image) const
 Writes out the image in the indicated PNMImage to the _filename and/or _alpha_filename.
virtual void write_datagram (BamWriter *writer, Datagram &datagram)
 Fills the indicated datagram up with a binary representation of the current object, in preparation for writing to a Bam file.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Protected Member Functions

void fillin (DatagramIterator &scan, BamReader *manager)
 Reads the binary data from the given datagram iterator, which was written by a previous call to write_datagram().

Protected Attributes

int _alpha_file_channel
Filename _alpha_filename
Filename _filename
TextureProperties _properties
bool _size_known
int _x_size
int _y_size

Detailed Description

This is the base class of both TextureImage and PaletteImage.

It encapsulates all the information specific to an image file that can be assigned as a texture image to egg geometry.

Definition at line 36 of file imageFile.h.


Member Function Documentation

void ImageFile::clear_basic_properties ( )

Resets the properties to a neutral state, for instance in preparation for calling update_properties() with all the known contributing properties.

Definition at line 153 of file imageFile.cxx.

References TextureProperties::clear_basic().

Referenced by TextureImage::clear_source_basic_properties().

int ImageFile::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
) [virtual]

Called after the object is otherwise completely read from a Bam file, this function's job is to store the pointers that were retrieved from the Bam file for each pointer object written.

The return value is the number of pointers processed from the list.

Reimplemented from TypedWritable.

Reimplemented in PaletteImage, SourceTextureImage, and TextureImage.

Definition at line 519 of file imageFile.cxx.

References TextureProperties::complete_pointers().

bool ImageFile::exists ( ) const

Returns true if the file or files named by the image file exist, false otherwise.

Definition at line 303 of file imageFile.cxx.

References TextureProperties::uses_alpha().

Referenced by TextureImage::get_preferred_source(), and PaletteImage::update_image().

void ImageFile::fillin ( DatagramIterator scan,
BamReader manager 
) [protected, virtual]

Reads the binary data from the given datagram iterator, which was written by a previous call to write_datagram().

Reimplemented from TypedWritable.

Reimplemented in DestTextureImage, PaletteImage, SourceTextureImage, and TextureImage.

Definition at line 535 of file imageFile.cxx.

References TextureProperties::fillin(), FilenameUnifier::get_bam_filename(), DatagramIterator::get_bool(), DatagramIterator::get_int32(), DatagramIterator::get_string(), and DatagramIterator::get_uint8().

int ImageFile::get_alpha_file_channel ( ) const

Returns the particular channel number of the alpha image file from which the alpha channel should be extracted.

This is normally 0 to represent the grayscale combination of r, g, and b; or it may be a 1-based channel number (for instance, 4 for the alpha channel of a 4-component image).

Definition at line 291 of file imageFile.cxx.

Referenced by TextureImage::complete_pointers(), and PaletteGroup::prepare().

const Filename & ImageFile::get_alpha_filename ( ) const

Returns the alpha filename of the image file.

This is the name of the file that contains the alpha channel, if it is stored in a separate file, or the empty string if it is not.

Definition at line 276 of file imageFile.cxx.

Referenced by TextureImage::complete_pointers(), and PaletteGroup::prepare().

int ImageFile::get_num_channels ( ) const

Returns the number of channels of the image.

It is an error to call this unless has_num_channels() returns true.

Definition at line 130 of file imageFile.cxx.

References TextureProperties::get_num_channels().

Referenced by DestTextureImage::copy(), DestTextureImage::copy_if_stale(), TextureReference::from_egg(), TextureImage::post_txa_file(), TextureReference::update_egg(), and TextureImage::write_scale_info().

const TextureProperties & ImageFile::get_properties ( ) const

Returns the grouping properties of the image.

Definition at line 140 of file imageFile.cxx.

Referenced by TexturePlacement::get_properties(), TextureImage::pre_txa_file(), and TextureImage::write_source_pathnames().

bool ImageFile::has_num_channels ( ) const

Returns true if the number of channels in the image is known, false otherwise.

Definition at line 118 of file imageFile.cxx.

References TextureProperties::has_num_channels().

Referenced by TextureReference::update_egg().

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

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedWritable.

Reimplemented in DestTextureImage, PaletteImage, and SourceTextureImage.

Definition at line 89 of file imageFile.h.

bool ImageFile::is_size_known ( ) const

Returns true if the size of the image file is known, false otherwise.

Definition at line 81 of file imageFile.cxx.

Referenced by TexturePlacement::determine_size(), get_x_size(), get_y_size(), TextureImage::write_scale_info(), and TextureImage::write_source_pathnames().

bool ImageFile::make_shadow_image ( const string &  basename)

Sets up the ImageFile as a "shadow image" of a particular PaletteImage.

This is a temporary ImageFile that's used to read and write the shadow palette image, which is used to keep a working copy of the palette.

Returns true if the filename changes from what it was previously, false otherwise.

Definition at line 56 of file imageFile.cxx.

References set_filename().

Referenced by PaletteImage::setup_shadow_image().

void ImageFile::output_filename ( ostream &  out) const

Writes the filename (or pair of filenames) to the indicated output stream.

Definition at line 483 of file imageFile.cxx.

References FilenameUnifier::make_user_filename(), and TextureProperties::uses_alpha().

Referenced by PalettePage::write_image_info(), and TextureImage::write_source_pathnames().

bool ImageFile::read ( PNMImage image) const

Reads in the image (or images, if the alpha_filename is separate) and stores it in the indicated PNMImage.

Returns true on success, false on failure.

Definition at line 326 of file imageFile.cxx.

References PNMImage::add_alpha(), PNMImage::get_alpha(), PNMImage::get_channel_val(), PNMImage::get_gray(), PNMImageHeader::get_num_channels(), PNMImageHeader::get_x_size(), PNMImageHeader::get_y_size(), FilenameUnifier::make_user_filename(), PNMImage::read(), PNMImage::set_alpha(), and PNMImageHeader::set_type().

Referenced by TextureImage::read_source_image().

bool ImageFile::set_filename ( const string &  dirname,
const string &  basename 
)

Sets the filename, and if applicable, the alpha_filename, from the indicated basename.

The extension appropriate to the image file type specified in _color_type (and _alpha_type) is automatically applied.

Returns true if the filename changes from what it was previously, false otherwise.

Definition at line 223 of file imageFile.cxx.

References Filename::get_fullpath_wo_extension(), and PNMFileType::get_suggested_extension().

bool ImageFile::set_filename ( PaletteGroup group,
const string &  basename 
)

Sets the filename, and if applicable, the alpha_filename, from the indicated basename.

The extension appropriate to the image file type specified in _color_type (and _alpha_type) is automatically applied.

Returns true if the filename changes from what it was previously, false otherwise.

Definition at line 181 of file imageFile.cxx.

References PaletteGroup::get_dirname().

Referenced by make_shadow_image().

void ImageFile::unlink ( )

Deletes the image file or files.

Definition at line 442 of file imageFile.cxx.

References FilenameUnifier::make_user_filename(), and Filename::unlink().

void ImageFile::update_properties ( const TextureProperties properties)

If the indicate TextureProperties structure is more specific than this one, updates this one.

Definition at line 164 of file imageFile.cxx.

References TextureProperties::update_properties().

Referenced by TextureReference::apply_properties_to_source(), and TextureReference::from_egg().

bool ImageFile::write ( const PNMImage image) const
void ImageFile::write_datagram ( BamWriter writer,
Datagram datagram 
) [virtual]

Fills the indicated datagram up with a binary representation of the current object, in preparation for writing to a Bam file.

Reimplemented from TypedWritable.

Reimplemented in DestTextureImage, PaletteImage, SourceTextureImage, and TextureImage.

Definition at line 498 of file imageFile.cxx.

References Datagram::add_bool(), Datagram::add_int32(), Datagram::add_string(), Datagram::add_uint8(), FilenameUnifier::make_bam_filename(), and TextureProperties::write_datagram().


The documentation for this class was generated from the following files: