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

#include "imageFile.h"

Inheritance diagram for ImageFile:

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. More...

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. More...

bool	exists () const
	Returns true if the file or files named by the image file exist, false otherwise. More...

int	get_alpha_file_channel () const
	Returns the particular channel number of the alpha image file from which the alpha channel should be extracted. More...

const Filename &	get_alpha_filename () const
	Returns the alpha filename of the image file. More...

const Filename &	get_filename () const
	Returns the primary filename of the image file. More...

int	get_num_channels () const
	Returns the number of channels of the image. More...

const TextureProperties &	get_properties () const
	Returns the grouping properties of the image. More...

virtual TypeHandle	get_type () const

int	get_x_size () const
	Returns the size of the image file in pixels in the X direction. More...

int	get_y_size () const
	Returns the size of the image file in pixels in the Y direction. More...

bool	has_num_channels () const
	Returns true if the number of channels in the image is known, false otherwise. More...

bool	is_size_known () const
	Returns true if the size of the image file is known, false otherwise. More...

bool	make_shadow_image (const std::string &basename)
	Sets up the ImageFile as a "shadow image" of a particular PaletteImage. More...

void	output_filename (std::ostream &out) const
	Writes the filename (or pair of filenames) to the indicated output stream. More...

bool	read (PNMImage &image) const
	Reads in the image (or images, if the alpha_filename is separate) and stores it in the indicated PNMImage. More...

bool	set_filename (PaletteGroup *group, const std::string &basename)
	Sets the filename, and if applicable, the alpha_filename, from the indicated basename. More...

bool	set_filename (const std::string &dirname, const std::string &basename)
	Sets the filename, and if applicable, the alpha_filename, from the indicated basename. More...

void	unlink ()
	Deletes the image file or files. More...

void	update_egg_tex (EggTexture *egg_tex) const
	Sets the indicated EggTexture to refer to this file. More...

void	update_properties (const TextureProperties &properties)
	If the indicate TextureProperties structure is more specific than this one, updates this one. More...

bool	write (const PNMImage &image) const
	Writes out the image in the indicated PNMImage to the _filename and/or _alpha_filename. More...

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. More...

Public Member Functions inherited from TypedWritable
	TypedWritable (const TypedWritable &copy)

virtual ReferenceCount *	as_reference_count ()
	Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...

vector_uchar	encode_to_bam_stream () const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...

bool	encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...

virtual void	finalize (BamReader *manager)
	Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...

virtual TypeHandle	force_init_type ()

UpdateSeq	get_bam_modified () const
	Returns the current bam_modified counter. More...

void	mark_bam_modified ()
	Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...

void	operator= (const TypedWritable &copy)

virtual bool	require_fully_complete () const
	Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...

virtual void	update_bam_nested (BamWriter *manager)
	Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

int	get_best_parent_from_Set (const std::set< int > &) const

int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...

bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly. More...

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type. More...

TypedObject &	operator= (const TypedObject &copy)=default

Static Public Member Functions
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedWritable
static bool	decode_raw_from_bam_stream (TypedWritable &ptr, ReferenceCount &ref_ptr, vector_uchar data, BamReader *reader=nullptr)
	Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...

static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedObject
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. More...

Additional Inherited Members
Public Attributes inherited from TypedObject
	get_type

Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

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 33 of file imageFile.h.

Member Function Documentation

◆ clear_basic_properties()

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 128 of file imageFile.cxx.

References TextureProperties::clear_basic().

Referenced by TextureImage::clear_source_basic_properties().

◆ complete_pointers()

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 TextureImage, PaletteImage, and SourceTextureImage.

Definition at line 454 of file imageFile.cxx.

Referenced by PaletteImage::complete_pointers().

◆ exists()

bool ImageFile::exists ( ) const

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

Definition at line 256 of file imageFile.cxx.

References Filename::exists(), and TextureProperties::uses_alpha().

Referenced by TextureImage::get_preferred_source().

◆ get_alpha_file_channel()

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 246 of file imageFile.cxx.

◆ get_alpha_filename()

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 235 of file imageFile.cxx.

◆ get_filename()

const Filename & ImageFile::get_filename ( ) const

Returns the primary filename of the image file.

Definition at line 225 of file imageFile.cxx.

Referenced by DestTextureImage::copy_if_stale(), TextureImage::get_preferred_source(), and PaletteImage::update_filename().

◆ get_num_channels()

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 111 of file imageFile.cxx.

References TextureProperties::get_num_channels().

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

◆ get_properties()

const TextureProperties & ImageFile::get_properties ( ) const

Returns the grouping properties of the image.

Definition at line 119 of file imageFile.cxx.

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

◆ get_x_size()

int ImageFile::get_x_size ( ) const

Returns the size of the image file in pixels in the X direction.

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

Definition at line 82 of file imageFile.cxx.

Referenced by DestTextureImage::copy_if_stale(), TextureImage::get_preferred_source(), TextureImage::post_txa_file(), PT(), and TextureImage::write_source_pathnames().

◆ get_y_size()

int ImageFile::get_y_size ( ) const

Returns the size of the image file in pixels in the Y direction.

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

Definition at line 92 of file imageFile.cxx.

Referenced by DestTextureImage::copy_if_stale(), TextureImage::get_preferred_source(), TextureImage::post_txa_file(), PT(), and TextureImage::write_source_pathnames().

◆ has_num_channels()

bool ImageFile::has_num_channels ( ) const

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

Definition at line 102 of file imageFile.cxx.

References TextureProperties::has_num_channels().

Referenced by TextureReference::update_egg().

◆ is_size_known()

bool ImageFile::is_size_known ( ) const

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

Definition at line 73 of file imageFile.cxx.

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

◆ make_shadow_image()

bool ImageFile::make_shadow_image ( const std::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 51 of file imageFile.cxx.

Referenced by PaletteImage::setup_shadow_image().

◆ output_filename()

void ImageFile::output_filename ( std::ostream & out ) const

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

Definition at line 424 of file imageFile.cxx.

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

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

◆ read()

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 277 of file imageFile.cxx.

Referenced by TextureImage::read_source_image().

◆ set_filename() [1/2]

bool ImageFile::set_filename	(	PaletteGroup *	group,
		const std::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 150 of file imageFile.cxx.

◆ set_filename() [2/2]

bool ImageFile::set_filename	(	const std::string &	dirname,
		const std::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 188 of file imageFile.cxx.

◆ unlink()

void ImageFile::unlink ( )

Deletes the image file or files.

Definition at line 388 of file imageFile.cxx.

References Filename::exists().

◆ update_egg_tex()

void ImageFile::update_egg_tex ( EggTexture * egg_tex ) const

Sets the indicated EggTexture to refer to this file.

Definition at line 403 of file imageFile.cxx.

◆ update_properties()

void ImageFile::update_properties ( const TextureProperties & properties )

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

Definition at line 137 of file imageFile.cxx.

References TextureProperties::update_properties().

◆ write()

bool ImageFile::write ( const PNMImage & image ) const

Writes out the image in the indicated PNMImage to the _filename and/or _alpha_filename.

Returns true on success, false on failure.

Definition at line 339 of file imageFile.cxx.

Referenced by DestTextureImage::copy().

◆ write_datagram()

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 TextureImage, PaletteImage, SourceTextureImage, and DestTextureImage.

Definition at line 436 of file imageFile.cxx.

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

Referenced by DestTextureImage::write_datagram(), SourceTextureImage::write_datagram(), PaletteImage::write_datagram(), and TextureImage::write_datagram().

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

pandatool/src/palettizer/imageFile.h
pandatool/src/palettizer/imageFile.cxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear_basic_properties()

◆ complete_pointers()

◆ exists()

◆ get_alpha_file_channel()

◆ get_alpha_filename()

◆ get_filename()

◆ get_num_channels()

◆ get_properties()

◆ get_x_size()

◆ get_y_size()

◆ has_num_channels()

◆ is_size_known()

◆ make_shadow_image()

◆ output_filename()

◆ read()

◆ set_filename() [1/2]

◆ set_filename() [2/2]

◆ unlink()

◆ update_egg_tex()

◆ update_properties()

◆ write()

◆ write_datagram()