Panda3D
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
TextureAttrib Class Reference

Indicates the set of TextureStages and their associated Textures that should be applied to (or removed from) a node. More...

#include "textureAttrib.h"

Inheritance diagram for TextureAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

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
 
int get_num_on_ff_stages () const
 
int get_num_on_stages () const
 
TextureStageget_off_stage (int n) const
 
TextureStageget_on_ff_stage (int n) const
 
const SamplerStateget_on_sampler (TextureStage *stage) const
 
TextureStageget_on_stage (int n) const
 
int get_on_stage_override (TextureStage *stage) const
 Returns the override value associated with the indicated stage. More...
 
Textureget_on_texture (TextureStage *stage) const
 
virtual int get_slot () const
 
Textureget_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
 
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...
 
virtual void output (std::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...
 
- Public Member Functions inherited from RenderAttrib
 RenderAttrib (const RenderAttrib &copy)=delete
 
virtual ~RenderAttrib ()
 The destructor is responsible for removing the RenderAttrib from the global set if it is there. More...
 
int compare_to (const RenderAttrib &other) const
 
 CPT (RenderAttrib) compose(const RenderAttrib *other) const
 
 CPT (RenderAttrib) invert_compose(const RenderAttrib *other) const
 
 CPT (RenderAttrib) get_unique() 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
 
RenderAttriboperator= (const RenderAttrib &copy)=delete
 
virtual bool unref () const final
 This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero. More...
 
virtual void write (std::ostream &out, int indent_level) const
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
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...
 
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
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_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...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_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 ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. 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...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 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 Public Member Functions inherited from RenderAttrib
static TypedWritablechange_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 (std::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, RenderAttrib *default_attrib)
 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 Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data
 
- 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...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_class_slot
 
 get_num_off_stages
 Returns the number of stages that are turned off by the attribute. More...
 
 get_num_on_ff_stages
 Returns the number of on-stages that are relevant to the classic fixed function pipeline. More...
 
 get_num_on_stages
 Returns the number of stages that are turned on by the attribute. More...
 
 get_off_stage
 Returns the nth stage turned off by the attribute, sorted in arbitrary (pointer) order. More...
 
 get_on_ff_stage
 Returns the nth stage turned on by the attribute, sorted in render order, including only those relevant to the classic fixed function pipeline. More...
 
 get_on_sampler
 Returns the sampler associated with the indicated stage, or the one associated with its texture if no custom stage has been specified. More...
 
 get_on_stage
 Returns the nth stage turned on by the attribute, sorted in render order. More...
 
 get_on_texture
 Returns the texture associated with the indicated stage, or NULL if no texture is associated. More...
 
 has_on_stage
 Returns true if the indicated stage is turned on by the attrib, false otherwise. More...
 
Texture int override = 0) const
 
Texture const SamplerState int override = 0) const
 
int override = 0) const
 
Texture const SamplerStatesampler
 
Texturetex
 
- Public Attributes inherited from RenderAttrib
 get_slot
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Additional Inherited Members

- Public Types inherited from RenderAttrib
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 Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

Indicates the set of TextureStages and their associated Textures that should be applied to (or removed from) a node.

Definition at line 31 of file textureAttrib.h.

Member Function Documentation

◆ complete_pointers()

int TextureAttrib::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
)
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 795 of file textureAttrib.cxx.

◆ cull_callback()

virtual bool TextureAttrib::cull_callback ( CullTraverser trav,
const CullTraverserData data 
) const
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.

◆ find_on_stage()

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 94 of file textureAttrib.cxx.

References ordered_vector< Key, Compare, Vector >::begin(), and ordered_vector< Key, Compare, Vector >::end().

◆ get_ff_tc_index()

int TextureAttrib::get_ff_tc_index ( int  n) const
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 115 of file textureAttrib.I.

◆ get_on_stage_override()

int TextureAttrib::get_on_stage_override ( TextureStage stage) const
inline

Returns the override value associated with the indicated stage.

Definition at line 162 of file textureAttrib.I.

References ordered_vector< Key, Compare, Vector >::end().

◆ get_texture()

Texture * TextureAttrib::get_texture ( ) const
inline

If the TextureAttrib is not an 'off' TextureAttrib, returns the base-level texture that is associated.

Otherwise, return NULL.

Definition at line 61 of file textureAttrib.I.

References ordered_vector< Key, Compare, Vector >::empty(), get_on_stage, and get_on_texture.

◆ has_all_off()

bool TextureAttrib::has_all_off ( ) const
inline

Returns true if this attrib turns off all stages (although it may also turn some on).

Definition at line 205 of file textureAttrib.I.

◆ has_cull_callback()

virtual bool TextureAttrib::has_cull_callback ( ) const
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.

◆ has_off_stage()

bool TextureAttrib::has_off_stage ( TextureStage stage) const
inline

Returns true if the indicated stage is turned off by the attrib, false otherwise.

Definition at line 195 of file textureAttrib.I.

References ordered_vector< Key, Compare, Vector >::end(), and has_on_stage.

◆ is_identity()

bool TextureAttrib::is_identity ( ) const
inline

Returns true if this is an identity attrib: it does not change the set of stages in use.

Definition at line 214 of file textureAttrib.I.

References ordered_vector< Key, Compare, Vector >::empty().

◆ is_off()

bool TextureAttrib::is_off ( ) const
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 52 of file textureAttrib.I.

References ordered_vector< Key, Compare, Vector >::empty().

◆ lower_attrib_can_override()

virtual bool TextureAttrib::lower_attrib_can_override ( ) const
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 true 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.

◆ write_datagram()

void TextureAttrib::write_datagram ( BamWriter manager,
Datagram dg 
)
virtual

Member Data Documentation

◆ get_num_off_stages

int TextureAttrib::get_num_off_stages
inline

Returns the number of stages that are turned off by the attribute.

Definition at line 77 of file textureAttrib.h.

Referenced by write_datagram().

◆ get_num_on_ff_stages

int TextureAttrib::get_num_on_ff_stages
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 58 of file textureAttrib.h.

◆ get_num_on_stages

int TextureAttrib::get_num_on_stages
inline

Returns the number of stages that are turned on by the attribute.

Definition at line 55 of file textureAttrib.h.

Referenced by GraphicsStateGuardian::get_alpha_scale_via_texture(), PT(), and write_datagram().

◆ get_off_stage

TextureStage * TextureAttrib::get_off_stage
inline

Returns the nth stage turned off by the attribute, sorted in arbitrary (pointer) order.

Definition at line 77 of file textureAttrib.h.

◆ get_on_ff_stage

TextureStage * TextureAttrib::get_on_ff_stage
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 58 of file textureAttrib.h.

◆ get_on_sampler

const SamplerState & TextureAttrib::get_on_sampler
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 72 of file textureAttrib.h.

Referenced by PT().

◆ get_on_stage

TextureStage * TextureAttrib::get_on_stage
inline

Returns the nth stage turned on by the attribute, sorted in render order.

Definition at line 55 of file textureAttrib.h.

Referenced by get_texture(), and PT().

◆ get_on_texture

Texture * TextureAttrib::get_on_texture
inline

Returns the texture associated with the indicated stage, or NULL if no texture is associated.

Definition at line 69 of file textureAttrib.h.

Referenced by get_texture(), and PT().

◆ has_on_stage

bool TextureAttrib::has_on_stage
inline

Returns true if the indicated stage is turned on by the attrib, false otherwise.

Definition at line 69 of file textureAttrib.h.

Referenced by has_off_stage().


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