TextureAttrib

Inheritance:

Methods of TextureAttrib:

Methods of RenderAttrib:

Methods of TypedWritableReferenceCount:

Methods of TypedWritable:

Methods of TypedObject:

Methods of ReferenceCount:

Constants in RenderAttrib:

addOffStage
ConstPointerTo< RenderAttrib > TextureAttrib::add_off_stage(TextureStage *stage) const;

Description: Returns a new TextureAttrib, just like this one, but with the indicated stage added to the list of stages turned off by this attrib.

addOnStage
ConstPointerTo< RenderAttrib > TextureAttrib::add_on_stage(TextureStage *stage, Texture *tex) const;

Description: Returns a new TextureAttrib, just like this one, but with the indicated stage added to the list of stages turned on by this attrib.

findOnStage
int TextureAttrib::find_on_stage(TextureStage const *stage) const;

Description: Returns the index number of the indicated TextureStage within the list of on_stages, or -1 if the indicated stage is not listed.

getClassType
static TypeHandle TextureAttrib::get_class_type(void);

Undocumented function.

getFfTcIndex
int TextureAttrib::get_ff_tc_index(int n) const;

Description: 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, even if the texture render order changes.

getNumOffStages
int TextureAttrib::get_num_off_stages(void) const;

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

getNumOnFfStages
int TextureAttrib::get_num_on_ff_stages(void) const;

Description: Returns the number of on-stages that are relevant to the classic fixed function pipeline. This excludes texture stages such as normal maps.

getNumOnStages
int TextureAttrib::get_num_on_stages(void) const;

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

getOffStage
TextureStage *TextureAttrib::get_off_stage(int n) const;

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

getOnFfStage
TextureStage *TextureAttrib::get_on_ff_stage(int n) const;

Description: 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.

getOnStage
TextureStage *TextureAttrib::get_on_stage(int n) const;

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

getOnTexture
Texture *TextureAttrib::get_on_texture(TextureStage *stage) const;

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

getTexture
Texture *TextureAttrib::get_texture(void) const;

Description: If the TextureAttrib is not an 'off' TextureAttrib, returns the base-level texture that is associated. Otherwise, return NULL.

hasAllOff
bool TextureAttrib::has_all_off(void) const;

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

hasOffStage
bool TextureAttrib::has_off_stage(TextureStage *stage) const;

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

hasOnStage
bool TextureAttrib::has_on_stage(TextureStage *stage) const;

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

isIdentity
bool TextureAttrib::is_identity(void) const;

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

isOff
bool TextureAttrib::is_off(void) const;

Description: 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.

make
static ConstPointerTo< RenderAttrib > TextureAttrib::make(Texture *tex);

These methods are used to create a simple, single-textured layer. For multitexture, use the multitexture interfaces, further below.
The following methods define the new multitexture mode for TextureAttrib. Each TextureAttrib can add or remove individual texture stages from the complete set of textures that are to be applied; this is similar to the mechanism of LightAttrib.
Description: Constructs a new TextureAttrib object suitable for rendering the indicated texture onto geometry, using the default TextureStage.
Description: Constructs a new TextureAttrib object that does nothing.

makeAllOff
static ConstPointerTo< RenderAttrib > TextureAttrib::make_all_off(void);

The following methods define the new multitexture mode for TextureAttrib. Each TextureAttrib can add or remove individual texture stages from the complete set of textures that are to be applied; this is similar to the mechanism of LightAttrib.
Description: Constructs a new TextureAttrib object that turns off all stages (and hence disables texturing).

makeOff
static ConstPointerTo< RenderAttrib > TextureAttrib::make_off(void);

These methods are used to create a simple, single-textured layer. For multitexture, use the multitexture interfaces, further below.
Description: Constructs a new TextureAttrib object suitable for rendering untextured geometry.

removeOffStage
ConstPointerTo< RenderAttrib > TextureAttrib::remove_off_stage(TextureStage *stage) const;

Description: Returns a new TextureAttrib, just like this one, but with the indicated stage removed from the list of stages turned off by this attrib.

removeOnStage
ConstPointerTo< RenderAttrib > TextureAttrib::remove_on_stage(TextureStage *stage) const;

Description: Returns a new TextureAttrib, just like this one, but with the indicated stage removed from the list of stages turned on by this attrib.

unifyTextureStages
ConstPointerTo< RenderAttrib > TextureAttrib::unify_texture_stages(TextureStage *stage) const;

Description: Returns a new TextureAttrib, just like this one, but with any included TextureAttribs that happen to have the same name as the given object replaced with the object.

compareTo
int RenderAttrib::compare_to(RenderAttrib const &other) const;

Description: 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.
This method is not needed outside of the RenderAttrib class because all equivalent RenderAttrib objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

getClassType
static TypeHandle RenderAttrib::get_class_type(void);

Undocumented function.

getNumAttribs
static int RenderAttrib::get_num_attribs(void);

Description: Returns the total number of unique RenderAttrib objects allocated in the world. This will go up and down during normal operations.

listAttribs
static void RenderAttrib::list_attribs(ostream &out);

Description: Lists all of the RenderAttribs in the cache to the output stream, one per line. This can be quite a lot of output if the cache is large, so be prepared.

output
virtual void RenderAttrib::output(ostream &out) const;

Description:

unref
bool RenderAttrib::unref(void) const;

Description: This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero.

validateAttribs
static bool RenderAttrib::validate_attribs(void);

Description: Ensures that the cache is still stored in sorted order. Returns true if so, false if there is a problem (which implies someone has modified one of the supposedly-const RenderAttrib objects).

write
virtual void RenderAttrib::write(ostream &out, int indent_level) const;

Description:

getClassType
static TypeHandle TypedWritableReferenceCount::get_class_type(void);

Undocumented function.

getClassType
static TypeHandle TypedWritable::get_class_type(void);

Undocumented function.

getClassType
static TypeHandle TypedObject::get_class_type(void);

Undocumented function.

getType
virtual TypeHandle TypedObject::get_type(void) const = 0;

Derived classes should override this function to return get_class_type().

getTypeIndex
int TypedObject::get_type_index(void) const;

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

isExactType
bool TypedObject::is_exact_type(TypeHandle handle) const;

Description: Returns true if the current object is the indicated type exactly.

isOfType
bool TypedObject::is_of_type(TypeHandle handle) const;

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

getClassType
static TypeHandle ReferenceCount::get_class_type(void);

Undocumented function.

getRefCount
int ReferenceCount::get_ref_count(void) const;

Description: Returns the current reference count.

ref
void ReferenceCount::ref(void) const;

Description: 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.

testRefCountIntegrity
bool ReferenceCount::test_ref_count_integrity(void) const;

Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero
bool ReferenceCount::test_ref_count_nonzero(void) const;

Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref
bool ReferenceCount::unref(void) const;

Description: 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; plus, we don't have a virtual destructor anyway.) 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.