Indicates the set of TextureStages and their associated Textures that should be applied to (or removed from) a node. More...
#include "textureAttrib.h"
Public Member Functions | |
virtual int | complete_pointers (TypedWritable **plist, BamReader *manager) |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More... | |
CPT (RenderAttrib) add_on_stage(TextureStage *stage | |
CPT (RenderAttrib) add_on_stage(TextureStage *stage | |
CPT (RenderAttrib) remove_on_stage(TextureStage *stage) const | |
CPT (RenderAttrib) add_off_stage(TextureStage *stage | |
CPT (RenderAttrib) remove_off_stage(TextureStage *stage) const | |
CPT (RenderAttrib) unify_texture_stages(TextureStage *stage) const | |
CPT (TextureAttrib) filter_to_max(int max_texture_stages) const | |
virtual bool | cull_callback (CullTraverser *trav, const CullTraverserData &data) const |
If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time. More... | |
int | find_on_stage (const TextureStage *stage) const |
Returns the index number of the indicated TextureStage within the list of on_stages, or -1 if the indicated stage is not listed. More... | |
virtual TypeHandle | force_init_type () |
int | get_ff_tc_index (int n) const |
For each TextureStage listed in get_on_ff_stage(), this returns a unique index number for the texture coordinate name used by that TextureStage. More... | |
int | get_num_off_stages () const |
Returns the number of stages that are turned off by the attribute. More... | |
int | get_num_on_ff_stages () const |
Returns the number of on-stages that are relevant to the classic fixed function pipeline. More... | |
int | get_num_on_stages () const |
Returns the number of stages that are turned on by the attribute. More... | |
TextureStage * | get_off_stage (int n) const |
Returns the nth stage turned off by the attribute, sorted in arbitrary (pointer) order. More... | |
TextureStage * | get_on_ff_stage (int n) const |
Returns the nth stage turned on by the attribute, sorted in render order, including only those relevant to the classic fixed function pipeline. More... | |
const SamplerState & | get_on_sampler (TextureStage *stage) const |
Returns the sampler associated with the indicated stage, or the one associated with its texture if no custom stage has been specified. More... | |
TextureStage * | get_on_stage (int n) const |
Returns the nth stage turned on by the attribute, sorted in render order. More... | |
int | get_on_stage_override (TextureStage *stage) const |
Returns the override value associated with the indicated stage. More... | |
Texture * | get_on_texture (TextureStage *stage) const |
Returns the texture associated with the indicated stage, or NULL if no texture is associated. More... | |
virtual int | get_slot () const |
Texture * | get_texture () const |
If the TextureAttrib is not an 'off' TextureAttrib, returns the base-level texture that is associated. More... | |
virtual TypeHandle | get_type () const |
bool | has_all_off () const |
Returns true if this attrib turns off all stages (although it may also turn some on). More... | |
virtual bool | has_cull_callback () const |
Should be overridden by derived classes to return true if cull_callback() has been defined. More... | |
bool | has_off_stage (TextureStage *stage) const |
Returns true if the indicated stage is turned off by the attrib, false otherwise. More... | |
bool | has_on_stage (TextureStage *stage) const |
Returns true if the indicated stage is turned on by the attrib, false otherwise. More... | |
bool | is_identity () const |
Returns true if this is an identity attrib: it does not change the set of stages in use. More... | |
bool | is_off () const |
Returns true if the TextureAttrib is an 'off' TextureAttrib, indicating that it should disable texturing. More... | |
virtual bool | lower_attrib_can_override () const |
Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. More... | |
MAKE_SEQ (get_on_stages, get_num_on_stages, get_on_stage) | |
MAKE_SEQ (get_on_ff_stages, get_num_on_ff_stages, get_on_ff_stage) | |
MAKE_SEQ (get_off_stages, get_num_off_stages, get_off_stage) | |
virtual void | output (ostream &out) const |
virtual void | write_datagram (BamWriter *manager, Datagram &dg) |
Writes the contents of this object to the datagram for shipping out to a Bam file. More... | |
![]() | |
virtual | ~RenderAttrib () |
The destructor is responsible for removing the RenderAttrib from the global set if it is there. More... | |
bool | always_reissue () const |
int | compare_to (const RenderAttrib &other) const |
Provides an arbitrary ordering among all unique RenderAttribs, so we can store the essentially different ones in a big set and throw away the rest. More... | |
CPT (RenderAttrib) compose(const RenderAttrib *other) const | |
CPT (RenderAttrib) invert_compose(const RenderAttrib *other) const | |
CPT (RenderAttrib) get_unique() const | |
CPT (RenderAttrib) get_auto_shader_attrib(const RenderState *state) const | |
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... | |
size_t | get_hash () const |
Returns a suitable hash value for phash_map. More... | |
virtual bool | unref () const FINAL |
Explicitly decrements the reference count. More... | |
virtual void | write (ostream &out, int indent_level) const |
![]() | |
TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
virtual ReferenceCount * | as_reference_count () |
Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More... | |
void | operator= (const TypedWritableReferenceCount ©) |
![]() | |
TypedWritable (const TypedWritable ©) | |
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. More... | |
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. More... | |
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 ©) |
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... | |
![]() | |
TypedObject (const TypedObject ©) | |
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... | |
void | operator= (const TypedObject ©) |
![]() | |
int | get_ref_count () const |
Returns the current reference count. More... | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
void | ref () const |
Explicitly increments the reference count. More... | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. More... | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Static Public Member Functions | |
static | CPT (RenderAttrib) make(Texture *tex) |
static | CPT (RenderAttrib) make_off() |
static | CPT (RenderAttrib) make_default() |
static | CPT (RenderAttrib) make() |
static | CPT (RenderAttrib) make_all_off() |
static int | get_class_slot () |
static TypeHandle | get_class_type () |
static void | init_type () |
static void | register_with_read_factory () |
![]() | |
static TypedWritable * | change_this (TypedWritable *old_ptr, BamReader *manager) |
Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired. More... | |
static int | garbage_collect () |
Performs a garbage-collection cycle. More... | |
static TypeHandle | get_class_type () |
static int | get_num_attribs () |
Returns the total number of unique RenderAttrib objects allocated in the world. More... | |
static void | init_attribs () |
Make sure the global _attribs map is allocated. More... | |
static void | init_type () |
static void | list_attribs (ostream &out) |
Lists all of the RenderAttribs in the cache to the output stream, one per line. More... | |
static int | register_slot (TypeHandle type_handle, int sort, RenderAttribRegistry::MakeDefaultFunc *make_default_func) |
Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number. More... | |
static bool | validate_attribs () |
Ensures that the cache is still stored in sorted order. More... | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
static | PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data |
![]() | |
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. More... | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
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... | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
Public Attributes | |
Texture int | override = 0) const |
Texture const SamplerState int | override = 0) const |
int | override = 0) const |
Texture const SamplerState & | sampler |
Texture * | tex |
![]() | |
static BamReader * | reader = NULL) |
Additional Inherited Members | |
![]() | |
enum | PandaCompareFunc { M_none =0, M_never, M_less, M_equal, M_less_equal, M_greater, M_not_equal, M_greater_equal, M_always } |
enum | TexGenMode { M_off, M_eye_sphere_map, M_world_cube_map, M_eye_cube_map, M_world_normal, M_eye_normal, M_world_position, M_unused, M_eye_position, M_point_sprite, M_unused2, M_constant } |
![]() | |
static TypedWritable *const | Null = (TypedWritable*)0L |
Indicates the set of TextureStages and their associated Textures that should be applied to (or removed from) a node.
Definition at line 34 of file textureAttrib.h.
|
virtual |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
Returns the number of pointers processed.
Reimplemented from TypedWritable.
Definition at line 881 of file textureAttrib.cxx.
References ordered_vector< Key, Compare, Vector >::begin(), TypedWritable::complete_pointers(), ordered_vector< Key, Compare, Vector >::end(), TextureStagePool::get_stage(), UpdateSeq::old(), ordered_vector< Key, Compare, Vector >::push_back(), ordered_vector< Key, Compare, Vector >::size(), and ov_set< Key, Compare, Vector >::sort().
|
virtual |
If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time.
This is called each time the RenderAttrib is discovered applied to a Geom in the traversal. It should return true if the Geom is visible, false if it should be omitted.
Reimplemented from RenderAttrib.
Definition at line 481 of file textureAttrib.cxx.
References ordered_vector< Key, Compare, Vector >::begin(), Texture::cull_callback(), and ordered_vector< Key, Compare, Vector >::end().
int TextureAttrib::find_on_stage | ( | const TextureStage * | stage | ) | const |
Returns the index number of the indicated TextureStage within the list of on_stages, or -1 if the indicated stage is not listed.
Definition at line 111 of file textureAttrib.cxx.
References ordered_vector< Key, Compare, Vector >::begin(), and ordered_vector< Key, Compare, Vector >::end().
|
inline |
For each TextureStage listed in get_on_ff_stage(), this returns a unique index number for the texture coordinate name used by that TextureStage.
It is guaranteed to remain the same index number for each texcoord name (for a given set of TextureStages), even if the texture render order changes.
Definition at line 146 of file textureAttrib.I.
|
inline |
Returns the number of stages that are turned off by the attribute.
Definition at line 220 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::size().
Referenced by write_datagram().
|
inline |
Returns the number of on-stages that are relevant to the classic fixed function pipeline.
This excludes texture stages such as normal maps.
Definition at line 116 of file textureAttrib.I.
|
inline |
Returns the number of stages that are turned on by the attribute.
Definition at line 91 of file textureAttrib.I.
Referenced by GeomNode::apply_attribs_to_vertices(), GeomNode::r_prepare_scene(), DXShaderContext9::update_shader_texture_bindings(), and write_datagram().
|
inline |
Returns the nth stage turned off by the attribute, sorted in arbitrary (pointer) order.
Definition at line 231 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::size().
|
inline |
Returns the nth stage turned on by the attribute, sorted in render order, including only those relevant to the classic fixed function pipeline.
This excludes texture stages such as normal maps.
Definition at line 130 of file textureAttrib.I.
|
inline |
Returns the sampler associated with the indicated stage, or the one associated with its texture if no custom stage has been specified.
It is an error to call this if the stage does not exist.
Definition at line 187 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::end(), and SamplerState::get_default().
Referenced by NodePath::get_texture_sampler(), and DXShaderContext9::update_shader_texture_bindings().
|
inline |
Returns the nth stage turned on by the attribute, sorted in render order.
Definition at line 103 of file textureAttrib.I.
Referenced by GeomNode::apply_attribs_to_vertices(), get_texture(), GeomNode::r_prepare_scene(), and DXShaderContext9::update_shader_texture_bindings().
|
inline |
Returns the override value associated with the indicated stage.
Definition at line 203 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::end().
|
inline |
Returns the texture associated with the indicated stage, or NULL if no texture is associated.
Definition at line 169 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::end().
Referenced by get_texture(), NodePath::get_texture(), GeomNode::r_prepare_scene(), and DXShaderContext9::update_shader_texture_bindings().
|
inline |
If the TextureAttrib is not an 'off' TextureAttrib, returns the base-level texture that is associated.
Otherwise, return NULL.
Definition at line 76 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::empty(), get_on_stage(), and get_on_texture().
Referenced by EggRenderState::fill_state(), and NodePath::get_texture().
|
inline |
Returns true if this attrib turns off all stages (although it may also turn some on).
Definition at line 255 of file textureAttrib.I.
Referenced by SpeedTreeNode::cull_callback(), and NodePath::has_texture_off().
|
virtual |
Should be overridden by derived classes to return true if cull_callback() has been defined.
Otherwise, returns false to indicate cull_callback() does not need to be called for this node during the cull traversal.
Reimplemented from RenderAttrib.
Definition at line 455 of file textureAttrib.cxx.
References ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), and Texture::has_cull_callback().
|
inline |
Returns true if the indicated stage is turned off by the attrib, false otherwise.
Definition at line 243 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::end(), and has_on_stage().
Referenced by NodePath::has_texture_off().
|
inline |
Returns true if the indicated stage is turned on by the attrib, false otherwise.
Definition at line 158 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::end().
Referenced by has_off_stage(), and NodePath::has_texture().
|
inline |
Returns true if this is an identity attrib: it does not change the set of stages in use.
Definition at line 266 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::empty().
|
inline |
Returns true if the TextureAttrib is an 'off' TextureAttrib, indicating that it should disable texturing.
If multitexture is in effect, a TextureAttrib may not be strictly "on" or "off"; therefore, to get a more precise answer to this question, you should consider using has_all_off() or get_num_off_stages() or has_off_stage() instead.
Definition at line 64 of file textureAttrib.I.
References ordered_vector< Key, Compare, Vector >::empty().
|
virtual |
Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.
This should return false if a RenderAttrib on a higher node will compose into a RenderAttrib on a lower node that has a higher override value, or false if the lower RenderAttrib will completely replace the state.
The default behavior is false: normally, a RenderAttrib in the graph cannot completely override a RenderAttrib above it, regardless of its override value–instead, the two attribs are composed. But for some kinds of RenderAttribs, it is useful to allow this kind of override.
This method only handles the one special case of a lower RenderAttrib with a higher override value. If the higher RenderAttrib has a higher override value, it always completely overrides. And if both RenderAttribs have the same override value, they are always composed.
Reimplemented from RenderAttrib.
Definition at line 378 of file textureAttrib.cxx.
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from RenderAttrib.
Definition at line 842 of file textureAttrib.cxx.
References Datagram::add_bool(), Datagram::add_int32(), Datagram::add_uint16(), ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), get_num_off_stages(), get_num_on_stages(), RenderAttrib::write_datagram(), and BamWriter::write_pointer().