Panda3D
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...

Inheritance diagram for TextureAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Member Functions

const RenderAttrib addOffStage (TextureStage stage, int override)
 Returns a new TextureAttrib, just like this one, but with the indicated stage added to the list of stages turned off by this attrib. More...
 
const RenderAttrib addOnStage (TextureStage stage, Texture tex, const SamplerState sampler, int override)
 Returns a new TextureAttrib, just like this one, but with the indicated stage added to the list of stages turned on by this attrib. More...
 
const RenderAttrib addOnStage (TextureStage stage, Texture tex, int override)
 Returns a new TextureAttrib, just like this one, but with the indicated stage added to the list of stages turned on by this attrib. More...
 
int findOnStage (const TextureStage stage)
 Returns the index number of the indicated TextureStage within the list of on_stages, or -1 if the indicated stage is not listed. More...
 
int getFfTcIndex (int n)
 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 getNumOffStages ()
 Returns the number of stages that are turned off by the attribute. More...
 
int getNumOnFfStages ()
 Returns the number of on-stages that are relevant to the classic fixed function pipeline. More...
 
int getNumOnStages ()
 Returns the number of stages that are turned on by the attribute. More...
 
TextureStage getOffStage (int n)
 Returns the nth stage turned off by the attribute, sorted in arbitrary (pointer) order. More...
 
list getOffStages ()
 
TextureStage getOnFfStage (int n)
 Returns the nth stage turned on by the attribute, sorted in render order, including only those relevant to the classic fixed function pipeline. More...
 
list getOnFfStages ()
 
const SamplerState getOnSampler (TextureStage stage)
 Returns the sampler associated with the indicated stage, or the one associated with its texture if no custom stage has been specified. More...
 
TextureStage getOnStage (int n)
 Returns the nth stage turned on by the attribute, sorted in render order. More...
 
int getOnStageOverride (TextureStage stage)
 Returns the override value associated with the indicated stage. More...
 
list getOnStages ()
 
Texture getOnTexture (TextureStage stage)
 Returns the texture associated with the indicated stage, or NULL if no texture is associated. More...
 
Texture getTexture ()
 If the TextureAttrib is not an 'off' TextureAttrib, returns the base-level texture that is associated. More...
 
bool hasAllOff ()
 Returns true if this attrib turns off all stages (although it may also turn some on). More...
 
bool hasOffStage (TextureStage stage)
 Returns true if the indicated stage is turned off by the attrib, false otherwise. More...
 
bool hasOnStage (TextureStage stage)
 Returns true if the indicated stage is turned on by the attrib, false otherwise. More...
 
bool isIdentity ()
 Returns true if this is an identity attrib: it does not change the set of stages in use. More...
 
bool isOff ()
 Returns true if the TextureAttrib is an 'off' TextureAttrib, indicating that it should disable texturing. More...
 
const RenderAttrib removeOffStage (TextureStage stage)
 Returns a new TextureAttrib, just like this one, but with the indicated stage removed from the list of stages turned off by this attrib. More...
 
const RenderAttrib removeOnStage (TextureStage stage)
 Returns a new TextureAttrib, just like this one, but with the indicated stage removed from the list of stages turned on by this attrib. More...
 
const RenderAttrib unifyTextureStages (TextureStage stage)
 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. More...
 
- Public Member Functions inherited from RenderAttrib
int compareTo (const RenderAttrib other)
 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...
 
const RenderAttrib compose (const RenderAttrib other)
 Returns a new RenderAttrib object that represents the composition of this attrib with the other attrib. More...
 
int getHash ()
 Returns a suitable hash value for phash_map. More...
 
int getSlot ()
 
const RenderAttrib getUnique ()
 Returns the pointer to the unique RenderAttrib in the cache that is equivalent to this one. More...
 
const RenderAttrib invertCompose (const RenderAttrib other)
 Returns a new RenderAttrib object that represents the composition of the inverse of this attrib with the other attrib. More...
 
bool lowerAttribCanOverride ()
 Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. More...
 
 output (Ostream out)
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static int getClassSlot ()
 
static TypeHandle getClassType ()
 
static const RenderAttrib make ()
 
static const RenderAttrib make (Texture tex)
 Constructs a new TextureAttrib object suitable for rendering the indicated texture onto geometry, using the default TextureStage. More...
 
static const RenderAttrib makeAllOff ()
 Constructs a new TextureAttrib object that turns off all stages (and hence disables texturing). More...
 
static const RenderAttrib makeDefault ()
 Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be. More...
 
static const RenderAttrib makeOff ()
 Constructs a new TextureAttrib object suitable for rendering untextured geometry. More...
 
- Static Public Member Functions inherited from RenderAttrib
static int garbageCollect ()
 Performs a garbage-collection cycle. More...
 
static TypeHandle getClassType ()
 
static int getNumAttribs ()
 Returns the total number of unique RenderAttrib objects allocated in the world. More...
 
static listAttribs (Ostream out)
 Lists all of the RenderAttribs in the cache to the output stream, one per line. More...
 
static bool validateAttribs ()
 Ensures that the cache is still stored in sorted order. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Public Attributes

int class_slot
 
TextureStage off_stages []
 
TextureStage on_stages []
 
const SamplerState samplers []
 
Texture textures []
 
- Public Attributes inherited from RenderAttrib
int slot
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Additional Inherited Members

- Public Types inherited from RenderAttrib
enum  PandaCompareFunc {
  M_none = 0, M_never = 1, M_less = 2, M_equal = 3,
  M_less_equal = 4, M_greater = 5, M_not_equal = 6, M_greater_equal = 7,
  M_always = 8
}
 
enum  TexGenMode {
  M_off = 0, M_eye_sphere_map = 1, M_world_cube_map = 2, M_eye_cube_map = 3,
  M_world_normal = 4, M_eye_normal = 5, M_world_position = 6, M_unused = 7,
  M_eye_position = 8, M_point_sprite = 9, M_unused2 = 10, M_constant = 11
}
 

Detailed Description

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

Member Function Documentation

◆ addOffStage()

const RenderAttrib addOffStage ( TextureStage  stage,
int  override 
)

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() [1/2]

const RenderAttrib addOnStage ( TextureStage  stage,
Texture  tex,
const SamplerState  sampler,
int  override 
)

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

◆ addOnStage() [2/2]

const RenderAttrib addOnStage ( TextureStage  stage,
Texture  tex,
int  override 
)

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 findOnStage ( const TextureStage  stage)

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

◆ getClassSlot()

static int getClassSlot ( )
static

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getFfTcIndex()

int getFfTcIndex ( int  n)

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.

◆ getNumOffStages()

int getNumOffStages ( )

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

◆ getNumOnFfStages()

int getNumOnFfStages ( )

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

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

◆ getOffStage()

TextureStage getOffStage ( int  n)

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

◆ getOffStages()

list getOffStages ( )

◆ getOnFfStage()

TextureStage getOnFfStage ( int  n)

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.

◆ getOnFfStages()

list getOnFfStages ( )

◆ getOnSampler()

const SamplerState getOnSampler ( TextureStage  stage)

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.

◆ getOnStage()

TextureStage getOnStage ( int  n)

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

◆ getOnStageOverride()

int getOnStageOverride ( TextureStage  stage)

Returns the override value associated with the indicated stage.

◆ getOnStages()

list getOnStages ( )

◆ getOnTexture()

Texture getOnTexture ( TextureStage  stage)

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

◆ getTexture()

Texture getTexture ( )

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

Otherwise, return NULL.

◆ hasAllOff()

bool hasAllOff ( )

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

◆ hasOffStage()

bool hasOffStage ( TextureStage  stage)

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

◆ hasOnStage()

bool hasOnStage ( TextureStage  stage)

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

◆ isIdentity()

bool isIdentity ( )

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

◆ isOff()

bool isOff ( )

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() [1/2]

static const RenderAttrib make ( )
static

◆ make() [2/2]

static const RenderAttrib make ( Texture  tex)
static

Constructs a new TextureAttrib object suitable for rendering the indicated texture onto geometry, using the default TextureStage.

◆ makeAllOff()

static const RenderAttrib makeAllOff ( )
static

Constructs a new TextureAttrib object that turns off all stages (and hence disables texturing).

◆ makeDefault()

static const RenderAttrib makeDefault ( )
static

Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.

◆ makeOff()

static const RenderAttrib makeOff ( )
static

Constructs a new TextureAttrib object suitable for rendering untextured geometry.

◆ removeOffStage()

const RenderAttrib removeOffStage ( TextureStage  stage)

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

const RenderAttrib removeOnStage ( TextureStage  stage)

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

const RenderAttrib unifyTextureStages ( TextureStage  stage)

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.

Member Data Documentation

◆ class_slot

int class_slot

◆ off_stages

TextureStage off_stages[]

◆ on_stages

TextureStage on_stages[]

◆ samplers

const SamplerState samplers[]

◆ textures

Texture textures[]