Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions
TransparencyAttrib Class Reference

This controls the enabling of transparency. More...

#include "transparencyAttrib.h"

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

List of all members.

Public Types

enum  Mode {
  M_none = 0, M_alpha = 1, M_notused, M_multisample,
  M_multisample_mask, M_binary, M_dual
}

Public Member Functions

virtual TypeHandle force_init_type ()
Mode get_mode () const
 Returns the transparency mode.
virtual int get_slot () const
virtual TypeHandle get_type () const
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.

Static Public Member Functions

static CPT (RenderAttrib) make(Mode mode)
static CPT (RenderAttrib) make_default()
static int get_class_slot ()
static TypeHandle get_class_type ()
static void init_type ()
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type TransparencyAttrib.

Protected Member Functions

virtual int compare_to_impl (const RenderAttrib *other) const
 Intended to be overridden by derived TransparencyAttrib types to return a unique number indicating whether this TransparencyAttrib is equivalent to the other one.
virtual CPT (RenderAttrib) get_auto_shader_attrib_impl(const RenderState *state) const
void fillin (DatagramIterator &scan, BamReader *manager)
 This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new TransparencyAttrib.
virtual size_t get_hash_impl () const
 Intended to be overridden by derived RenderAttrib types to return a unique hash for these particular properties.

Static Protected Member Functions

static TypedWritablemake_from_bam (const FactoryParams &params)
 This function is called by the BamReader's factory when a new object of type TransparencyAttrib is encountered in the Bam file.

Detailed Description

This controls the enabling of transparency.

Simply setting an alpha component to non-1 does not in itself make an object transparent; you must also enable transparency mode with a suitable TransparencyAttrib. Similarly, it is wasteful to render an object with a TransparencyAttrib in effect unless you actually want it to be at least partially transparent (and it has alpha components less than 1).

Definition at line 36 of file transparencyAttrib.h.


Member Function Documentation

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

Intended to be overridden by derived TransparencyAttrib types to return a unique number indicating whether this TransparencyAttrib is equivalent to the other one.

This should return 0 if the two TransparencyAttrib objects are equivalent, a number less than zero if this one should be sorted before the other one, and a number greater than zero otherwise.

This will only be called with two TransparencyAttrib objects whose get_type() functions return the same.

Reimplemented from RenderAttrib.

Definition at line 103 of file transparencyAttrib.cxx.

void TransparencyAttrib::fillin ( DatagramIterator scan,
BamReader manager 
) [protected, virtual]

This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new TransparencyAttrib.

Reimplemented from RenderAttrib.

Definition at line 188 of file transparencyAttrib.cxx.

References DatagramIterator::get_int8().

Referenced by make_from_bam().

size_t TransparencyAttrib::get_hash_impl ( ) const [protected, virtual]

Intended to be overridden by derived RenderAttrib types to return a unique hash for these particular properties.

RenderAttribs that compare the same with compare_to_impl(), above, should return the same hash; RenderAttribs that compare differently should return a different hash.

Reimplemented from RenderAttrib.

Definition at line 120 of file transparencyAttrib.cxx.

References integer_hash< Key, Compare >::add_hash().

TransparencyAttrib::Mode TransparencyAttrib::get_mode ( ) const [inline]
TypedWritable * TransparencyAttrib::make_from_bam ( const FactoryParams params) [static, protected]

This function is called by the BamReader's factory when a new object of type TransparencyAttrib is encountered in the Bam file.

It should create the TransparencyAttrib and extract its information from the file.

Definition at line 169 of file transparencyAttrib.cxx.

References fillin().

Referenced by register_with_read_factory().

Tells the BamReader how to create objects of type TransparencyAttrib.

Definition at line 143 of file transparencyAttrib.cxx.

References BamReader::get_factory(), make_from_bam(), and Factory< Type >::register_factory().

void TransparencyAttrib::write_datagram ( BamWriter manager,
Datagram dg 
) [virtual]

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from RenderAttrib.

Definition at line 154 of file transparencyAttrib.cxx.

References Datagram::add_int8().


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