Panda3D
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends

GeomMunger Class Reference

Objects of this class are used to convert vertex data from a Geom into a format suitable for passing to the rendering backend. More...

#include "geomMunger.h"

Inheritance diagram for GeomMunger:
TypedReferenceCount GeomEnums TypedObject ReferenceCount MemoryBase MemoryBase StateMunger StandardMunger DXGeomMunger8 DXGeomMunger9 TinyGeomMunger

List of all members.

Classes

class  CacheEntry
class  Registry

Public Types

enum  AnimationType { AT_none, AT_panda, AT_hardware }
enum  Contents {
  C_other, C_point, C_clip_point, C_vector,
  C_texcoord, C_color, C_index, C_morph_delta
}
enum  GeomRendering {
  GR_indexed_point = 0x00001, GR_indexed_other = 0x10000, GR_indexed_bits = 0x10001, GR_point = 0x00002,
  GR_point_uniform_size = 0x00004, GR_per_point_size = 0x00008, GR_point_perspective = 0x00010, GR_point_aspect_ratio = 0x00020,
  GR_point_scale = 0x00040, GR_point_rotate = 0x00080, GR_point_sprite = 0x00100, GR_point_sprite_tex_matrix = 0x00200,
  GR_point_bits = 0x003fe, GR_triangle_strip = 0x00400, GR_triangle_fan = 0x00800, GR_line_strip = 0x01000,
  GR_composite_bits = 0x01c00, GR_flat_first_vertex = 0x02000, GR_flat_last_vertex = 0x04000, GR_shade_model_bits = 0x06000,
  GR_texcoord_light_vector = 0x08000
}
enum  NumericType {
  NT_uint8, NT_uint16, NT_uint32, NT_packed_dcba,
  NT_packed_dabc, NT_float32
}
enum  PrimitiveType { PT_none, PT_polygons, PT_lines, PT_points }
enum  ShadeModel { SM_uniform, SM_smooth, SM_flat_first_vertex, SM_flat_last_vertex }
enum  UsageHint {
  UH_client, UH_stream, UH_dynamic, UH_static,
  UH_unspecified
}

Public Member Functions

 GeomMunger (GraphicsStateGuardianBase *gsg)
 GeomMunger (const GeomMunger &copy)
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.
int compare_to (const GeomMunger &other) const
 Provides an arbitrary ordering among all unique GeomMungers, so we can store the essentially different ones in a big set and throw away the rest.
 CPT (GeomVertexData) munge_data(const GeomVertexData *data) const
 CPT (GeomVertexFormat) premunge_format(const GeomVertexFormat *format) const
 CPT (GeomVertexData) premunge_data(const GeomVertexData *data) const
 CPT (GeomVertexFormat) munge_format(const GeomVertexFormat *format
virtual TypeHandle force_init_type ()
int geom_compare_to (const GeomMunger &other) const
 Compares two GeomMungers, considering only whether they would produce a different answer to munge_format(), munge_data(), or munge_geom().
int get_best_parent_from_Set (const std::set< int > &) const
GraphicsStateGuardianBaseget_gsg () const
 Returns a pointer to the GSG that created this munger.
int get_ref_count () const
 Returns the current reference count.
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.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
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.
bool is_registered () const
 Returns true if this munger has been registered, false if it has not.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
bool munge_geom (CPT(Geom)&geom, CPT(GeomVertexData)&data, bool force, Thread *current_thread)
 Applies the indicated munger to the geom and its data, and returns a (possibly different) geom and data, according to the munger's whim.
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete[] (void *ptr)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *, void *)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void operator= (const GeomMunger &copy)
void premunge_geom (CPT(Geom)&geom, CPT(GeomVertexData)&data) const
 This is similar to munge_geom(), but it is done at load time, to optimize a model for eventual rendering on a particular GSG.
void ref () const
 Explicitly increments the reference count.
void remove_data (const GeomVertexData *data)
 Removes a prepared GeomVertexData from the cache.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool unref () const
 Explicitly decrements the reference count.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.

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.
static PT (GeomMunger) register_munger(GeomMunger *munger
static void unregister_mungers_for_gsg (GraphicsStateGuardianBase *gsg)
 Removes all the mungers from the registry that are associated with the indicated GSG.

Public Attributes

const GeomVertexAnimationSpec
&animation 
const
static Threadcurrent_thread

Protected Member Functions

virtual int compare_to_impl (const GeomMunger *other) const
 Called to compare two GeomMungers who are known to be of the same type, for an apples-to-apples comparison.
 CPT (GeomVertexFormat) do_munge_format(const GeomVertexFormat *format
virtual CPT (GeomVertexData) premunge_data_impl(const GeomVertexData *data)
virtual CPT (GeomVertexData) munge_data_impl(const GeomVertexData *data)
virtual CPT (GeomVertexFormat) munge_format_impl(const GeomVertexFormat *orig
 CPT (GeomVertexFormat) do_premunge_format(const GeomVertexFormat *format)
virtual CPT (GeomVertexFormat) premunge_format_impl(const GeomVertexFormat *orig)
bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.
virtual int geom_compare_to_impl (const GeomMunger *other) const
 Compares two GeomMungers, considering only whether they would produce a different answer to munge_format(), munge_data(), or munge_geom().
virtual void munge_geom_impl (CPT(Geom)&geom, CPT(GeomVertexData)&data, Thread *current_thread)
 Converts a Geom and/or its data as necessary.
virtual void premunge_geom_impl (CPT(Geom)&geom, CPT(GeomVertexData)&data)
 Converts a Geom and/or its data as necessary.
void unregister_myself ()
 Unregisters the GeomMunger, for instance when it is being destructed, or whenever it has become invalid for some reason.

Protected Attributes

const GeomVertexAnimationSpecanimation
virtual const
GeomVertexAnimationSpec
animation

Friends

class Geom

Detailed Description

Objects of this class are used to convert vertex data from a Geom into a format suitable for passing to the rendering backend.

Typically, the rendering backend will create a specialization of this class to handle its particular needs (e.g. DXGeomMunger). This class is necessary because DirectX and OpenGL have somewhat different requirements for vertex format.

This also performs runtime application of state changes to the vertex data; for instance, by scaling all of the color values in response to a ColorScaleAttrib.

A GeomMunger must be registered before it can be used, and once registered, the object is constant and cannot be changed. All registered GeomMungers that perform the same operation will have the same pointer.

Definition at line 57 of file geomMunger.h.


Member Function Documentation

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.

int GeomMunger::compare_to ( const GeomMunger other) const [inline]

Provides an arbitrary ordering among all unique GeomMungers, so we can store the essentially different ones in a big set and throw away the rest.

Definition at line 162 of file geomMunger.I.

References compare_to_impl(), and TypeHandle::get_index().

int GeomMunger::compare_to_impl ( const GeomMunger other) const [protected, virtual]

Called to compare two GeomMungers who are known to be of the same type, for an apples-to-apples comparison.

This will never be called on two pointers of a different type.

Reimplemented in StandardMunger, DXGeomMunger8, DXGeomMunger9, and TinyGeomMunger.

Definition at line 357 of file geomMunger.cxx.

Referenced by compare_to().

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

int GeomMunger::geom_compare_to ( const GeomMunger other) const [inline]

Compares two GeomMungers, considering only whether they would produce a different answer to munge_format(), munge_data(), or munge_geom().

(They still might be different in other ways, but if they would produce the same answer, this function consider them to be the same.)

Definition at line 186 of file geomMunger.I.

References geom_compare_to_impl(), and TypeHandle::get_index().

int GeomMunger::geom_compare_to_impl ( const GeomMunger other) const [protected, virtual]

Compares two GeomMungers, considering only whether they would produce a different answer to munge_format(), munge_data(), or munge_geom().

(They still might be different in other ways, but if they would produce the same answer, this function will consider them to be the same.)

Reimplemented in StandardMunger, DXGeomMunger8, DXGeomMunger9, and TinyGeomMunger.

Definition at line 372 of file geomMunger.cxx.

Referenced by geom_compare_to().

GraphicsStateGuardianBase * GeomMunger::get_gsg ( ) const [inline]

Returns a pointer to the GSG that created this munger.

Reimplemented in StandardMunger.

Definition at line 23 of file geomMunger.I.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
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().

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

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

Reimplemented in StandardMunger, DXGeomMunger8, DXGeomMunger9, StateMunger, and TinyGeomMunger.

Definition at line 164 of file geomMunger.h.

References TypedReferenceCount::init_type().

Referenced by StateMunger::init_type().

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().

bool GeomMunger::is_registered ( ) const [inline]

Returns true if this munger has been registered, false if it has not.

It may not be used for a Geom until it has been registered, but once registered, it may no longer be modified.

Definition at line 36 of file geomMunger.I.

Referenced by unregister_myself().

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

bool GeomMunger::munge_geom ( CPT(Geom)&  geom,
CPT(GeomVertexData)&  data,
bool  force,
Thread current_thread 
)

Applies the indicated munger to the geom and its data, and returns a (possibly different) geom and data, according to the munger's whim.

The assumption is that for a particular geom and a particular munger, the result will always be the same; so this result may be cached.

If force is false, this may do nothing and return false if the vertex data is nonresident. If force is true, this will always return true, but it may have to block while the vertex data is paged in.

Definition at line 111 of file geomMunger.cxx.

References LightMutexDirect::acquire(), GeomVertexData::get_modified(), Geom::get_modified(), munge_geom_impl(), LightMutexDirect::release(), GeomVertexData::request_resident(), and Geom::request_resident().

Referenced by CullableObject::munge_geom().

void GeomMunger::munge_geom_impl ( CPT(Geom)&  geom,
CPT(GeomVertexData)&  data,
Thread current_thread 
) [protected, virtual]

Converts a Geom and/or its data as necessary.

Reimplemented in StandardMunger.

Definition at line 268 of file geomMunger.cxx.

Referenced by munge_geom().

void GeomMunger::premunge_geom ( CPT(Geom)&  geom,
CPT(GeomVertexData)&  data 
) const [inline]

This is similar to munge_geom(), but it is done at load time, to optimize a model for eventual rendering on a particular GSG.

At this point, we do not necessarily know the final render state that will be applied, so we cannot make any destructive changes to the geom, its data, or its format.

Unlike munge_geom(), this result is not cached, since the assumption is that this operation is performed at load time once for each model.

Definition at line 150 of file geomMunger.I.

void GeomMunger::premunge_geom_impl ( CPT(Geom)&  geom,
CPT(GeomVertexData)&  data 
) [protected, virtual]

Converts a Geom and/or its data as necessary.

Reimplemented in StandardMunger.

Definition at line 343 of file geomMunger.cxx.

void ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

void GeomMunger::remove_data ( const GeomVertexData data)

Removes a prepared GeomVertexData from the cache.

Definition at line 87 of file geomMunger.cxx.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool ReferenceCount::unref ( ) const [inline, virtual, inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void GeomMunger::unregister_mungers_for_gsg ( GraphicsStateGuardianBase gsg) [inline, static]

Removes all the mungers from the registry that are associated with the indicated GSG.

Definition at line 67 of file geomMunger.I.

void GeomMunger::unregister_myself ( ) [inline, protected]

Unregisters the GeomMunger, for instance when it is being destructed, or whenever it has become invalid for some reason.

This removes it from the registry so that it will no longer be available to be returned by register_munger().

It is not an error to call this if the munger has already been unregistered.

Definition at line 212 of file geomMunger.I.

References is_registered().

Referenced by DXGeomMunger9::wp_callback(), and DXGeomMunger8::wp_callback().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().


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