Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Static Protected Member Functions

TextureProperties Class Reference

This is the set of characteristics of a texture that, if different from another texture, prevent the two textures from sharing a PaletteImage. More...

#include "textureProperties.h"

Inheritance diagram for TextureProperties:
TypedWritable TypedObject MemoryBase

List of all members.

Public Member Functions

 TextureProperties (const TextureProperties &copy)
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
void clear_basic ()
 Resets only the properties that might be changed by update_properties() to a neutral state.
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 egg_properties_match (const TextureProperties &other) const
 Returns true if all of the properties that are reflected directly in an egg file match between this TextureProperties object and the other, or false if any of them differ.
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
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().
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.
void force_grayscale ()
 Sets the actual number of channels to indicate a grayscale image, presumably after discovering that the image contains no colored pixels.
virtual TypeHandle force_init_type ()
void force_nonalpha ()
 Sets the actual number of channels to indicate an image with no alpha channel, presumably after discovering that the alpha channel contains no meaningful pixels.
void fully_define ()
 If any properties remain unspecified, specify them now.
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter.
int get_best_parent_from_Set (const std::set< int > &) const
int get_num_channels () const
 Returns the number of channels (1 through 4) associated with the image.
string get_string () const
 Returns a string corresponding to the TextureProperties object.
virtual TypeHandle get_type () const
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool has_num_channels () const
 Returns true if the number of channels is known.
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
bool operator!= (const TextureProperties &other) const
bool operator< (const TextureProperties &other) const
void operator= (const TextureProperties &copy)
bool operator== (const TextureProperties &other) const
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.
void set_num_channels (int num_channels)
 Sets the number of channels (1 through 4) associated with the image, presumably after reading this information from the image header.
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.
void update_egg_tex (EggTexture *egg_tex) const
 Adjusts the texture properties of the indicated egg reference to match these properties.
void update_properties (const TextureProperties &other)
 If the indicate TextureProperties structure is more specific than this one, updates this one.
bool uses_alpha () const
 Returns true if the texture uses an alpha channel, false otherwise.
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 bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string.
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.
static void register_with_read_factory ()
 Registers the current object as something that can be read from a Bam file.

Public Attributes

PNMFileType_alpha_type
int _anisotropic_degree
PNMFileType_color_type
bool _force_format
EggTexture::Format _format
bool _generic_format
bool _keep_format
EggTexture::FilterType _magfilter
EggTexture::FilterType _minfilter
EggTexture::QualityLevel _quality_level

Static Public Attributes

static TypedWritable *const Null = (TypedWritable*)0L

Static Protected Member Functions

static TypedWritablemake_TextureProperties (const FactoryParams &params)
 This method is called by the BamReader when an object of this type is encountered in a Bam file; it should allocate and return a new object with all the data read.

Detailed Description

This is the set of characteristics of a texture that, if different from another texture, prevent the two textures from sharing a PaletteImage.

It includes properties such as mipmapping, number of channels, etc.

Definition at line 34 of file textureProperties.h.


Member Function Documentation

ReferenceCount * TypedWritable::as_reference_count ( ) [virtual, inherited]

Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.

Reimplemented in PandaNode, and TypedWritableReferenceCount.

Definition at line 155 of file typedWritable.cxx.

Referenced by BamReader::change_pointer(), BamReader::register_change_this(), and BamReader::resolve().

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

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

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

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

Definition at line 110 of file typedObject.I.

void TextureProperties::clear_basic ( )

Resets only the properties that might be changed by update_properties() to a neutral state.

Definition at line 100 of file textureProperties.cxx.

Referenced by ImageFile::clear_basic_properties().

int TextureProperties::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.

Definition at line 856 of file textureProperties.cxx.

Referenced by TextureReference::complete_pointers(), PalettePage::complete_pointers(), and ImageFile::complete_pointers().

bool TypedWritable::decode_raw_from_bam_stream ( TypedWritable *&  ptr,
ReferenceCount *&  ref_ptr,
const string &  data,
BamReader reader = NULL 
) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string.

Returns true on success, false on on error.

This variant sets the TypedWritable and ReferenceCount pointers separately; both are pointers to the same object. The reference count is not incremented; it is the caller's responsibility to manage the reference count.

Note that this method cannot be used to retrieve objects that do not inherit from ReferenceCount, because these objects cannot persist beyond the lifetime of the BamReader that reads them. To retrieve these objects from a bam stream, you must construct a BamReader directly.

If you happen to know that the particular object in question inherits from TypedWritableReferenceCount or PandaNode, consider calling the variant of decode_from_bam_stream() defined for those methods, which presents a simpler interface.

Definition at line 353 of file typedWritable.cxx.

References BamReader::init(), DatagramInputFile::open(), DatagramInputFile::read_header(), BamReader::read_object(), ReferenceCount::ref(), BamReader::resolve(), BamReader::set_source(), and ReferenceCount::unref().

bool TextureProperties::egg_properties_match ( const TextureProperties other) const

Returns true if all of the properties that are reflected directly in an egg file match between this TextureProperties object and the other, or false if any of them differ.

Definition at line 512 of file textureProperties.cxx.

Referenced by TextureReference::is_equivalent(), and TextureImage::post_txa_file().

bool TypedWritable::encode_to_bam_stream ( string &  data,
BamWriter writer = NULL 
) const [inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

Returns true on success, false on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 283 of file typedWritable.cxx.

References BamWriter::init(), DatagramOutputFile::open(), BamWriter::set_target(), DatagramOutputFile::write_header(), and BamWriter::write_object().

string TypedWritable::encode_to_bam_stream ( ) const [inline, inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.

Returns empty string on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 86 of file typedWritable.I.

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

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

Reimplemented from TypedWritable.

Definition at line 899 of file textureProperties.cxx.

References DatagramIterator::get_bool(), DatagramIterator::get_int32(), and BamReader::read_pointer().

Referenced by TextureReference::fillin(), PalettePage::fillin(), ImageFile::fillin(), and make_TextureProperties().

void TypedWritable::finalize ( BamReader manager) [virtual, inherited]

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.

Reimplemented in PartBundle, Geom, GeomPrimitive, GeomVertexArrayData, GeomVertexArrayFormat, GeomVertexData, InternalName, GeomNode, LightAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderState, PaletteGroup, and Palettizer.

Definition at line 145 of file typedWritable.cxx.

Referenced by BamReader::finalize_now().

void TextureProperties::force_grayscale ( )

Sets the actual number of channels to indicate a grayscale image, presumably after discovering that the image contains no colored pixels.

Definition at line 156 of file textureProperties.cxx.

void TextureProperties::force_nonalpha ( )

Sets the actual number of channels to indicate an image with no alpha channel, presumably after discovering that the alpha channel contains no meaningful pixels.

Definition at line 171 of file textureProperties.cxx.

void TextureProperties::fully_define ( )

If any properties remain unspecified, specify them now.

Also reconcile conflicting information.

Definition at line 270 of file textureProperties.cxx.

Referenced by TextureImage::post_txa_file().

UpdateSeq TypedWritable::get_bam_modified ( ) const [inline, inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

Definition at line 66 of file typedWritable.I.

Referenced by BamWriter::consider_update(), and BamWriter::write_pointer().

int TextureProperties::get_num_channels ( ) const

Returns the number of channels (1 through 4) associated with the image.

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

Definition at line 129 of file textureProperties.cxx.

Referenced by ImageFile::get_num_channels(), TextureImage::post_txa_file(), and TextureImage::write_source_pathnames().

string TextureProperties::get_string ( ) const

Returns a string corresponding to the TextureProperties object.

Each unique set of TextureProperties will generate a unique string. This is used to generate unique palette image filenames.

Definition at line 212 of file textureProperties.cxx.

int TypedObject::get_type_index ( ) const [inline, inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

This is equivalent to get_type().get_index().

Definition at line 52 of file typedObject.I.

References TypeHandle::get_index().

bool TextureProperties::has_num_channels ( ) const

Returns true if the number of channels is known.

Definition at line 117 of file textureProperties.cxx.

Referenced by ImageFile::has_num_channels(), TextureImage::post_txa_file(), and TextureImage::write_source_pathnames().

static void TextureProperties::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.

Definition at line 107 of file textureProperties.h.

bool TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
bool TypedObject::is_of_type ( TypeHandle  handle) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

TypedWritable * TextureProperties::make_TextureProperties ( const FactoryParams params) [static, protected]

This method is called by the BamReader when an object of this type is encountered in a Bam file; it should allocate and return a new object with all the data read.

Definition at line 881 of file textureProperties.cxx.

References fillin().

Referenced by register_with_read_factory().

void TypedWritable::mark_bam_modified ( ) [inline, inherited]
void TextureProperties::register_with_read_factory ( ) [static]

Registers the current object as something that can be read from a Bam file.

Definition at line 816 of file textureProperties.cxx.

References BamReader::get_factory(), and make_TextureProperties().

bool TypedWritable::require_fully_complete ( ) const [virtual, inherited]

Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.

If this is the case, override this method to return true, and be careful with circular references (which would make the object unreadable from a bam file).

Reimplemented in GeomVertexData, ClipPlaneAttrib, and RenderEffects.

Definition at line 118 of file typedWritable.cxx.

void TextureProperties::set_num_channels ( int  num_channels)

Sets the number of channels (1 through 4) associated with the image, presumably after reading this information from the image header.

Definition at line 142 of file textureProperties.cxx.

Referenced by TextureImage::post_txa_file(), and SourceTextureImage::set_header().

void TypedWritable::update_bam_nested ( BamWriter manager) [virtual, inherited]

Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.

Reimplemented in CFDoCullCommand, and PandaNode.

Definition at line 77 of file typedWritable.cxx.

void TextureProperties::update_egg_tex ( EggTexture egg_tex) const

Adjusts the texture properties of the indicated egg reference to match these properties.

Definition at line 495 of file textureProperties.cxx.

References EggTexture::set_anisotropic_degree().

Referenced by ImageFile::update_egg_tex().

void TextureProperties::update_properties ( const TextureProperties other)

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

Definition at line 237 of file textureProperties.cxx.

Referenced by ImageFile::update_properties().

bool TextureProperties::uses_alpha ( ) const

Returns true if the texture uses an alpha channel, false otherwise.

Definition at line 184 of file textureProperties.cxx.

Referenced by ImageFile::exists(), ImageFile::output_filename(), and ImageFile::update_egg_tex().

void TextureProperties::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.

Definition at line 829 of file textureProperties.cxx.

References Datagram::add_bool(), Datagram::add_int32(), and BamWriter::write_pointer().

Referenced by TextureReference::write_datagram(), PalettePage::write_datagram(), and ImageFile::write_datagram().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations