Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ColorAttrib Class Reference

Indicates what color should be applied to renderable geometry. More...

Inheritance diagram for ColorAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Types

enum  Type { T_vertex = 0, T_flat = 1, T_off = 2 }
 
- 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
}
 

Public Member Functions

const LColor getColor ()
 If the type is T_flat or T_off, this returns the color that will be applied to geometry. More...
 
ColorAttrib::Type getColorType ()
 Returns the type of color specified by this ColorAttrib. 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 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 makeFlat (const LColor color)
 Constructs a new ColorAttrib object that indicates geometry should be rendered in the indicated color. More...
 
static const RenderAttrib makeOff ()
 Constructs a new ColorAttrib object that indicates geometry should be rendered in white. More...
 
static const RenderAttrib makeVertex ()
 Constructs a new ColorAttrib object that indicates geometry should be rendered according to its own vertex color. 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
 
const LColor color
 If the type is T_flat or T_off, this returns the color that will be applied to geometry. More...
 
ColorAttrib::Type color_type
 Returns the type of color specified by this ColorAttrib. More...
 
- 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...
 

Detailed Description

Indicates what color should be applied to renderable geometry.

Member Enumeration Documentation

◆ Type

enum Type
Enumerator
T_vertex 
T_flat 
T_off 

Member Function Documentation

◆ getClassSlot()

static int getClassSlot ( )
static

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getColor()

const LColor getColor ( )

If the type is T_flat or T_off, this returns the color that will be applied to geometry.

If the type is T_vertex, this is meaningless.

◆ getColorType()

ColorAttrib::Type getColorType ( )

Returns the type of color specified by this ColorAttrib.

The options are:

T_vertex - use the vertex color specified in the geometry itself.

T_flat - use the color specified in this ColorAttrib for all geometry. You can get this color via get_color().

T_off - use the color white.

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

◆ makeFlat()

static const RenderAttrib makeFlat ( const LColor  color)
static

Constructs a new ColorAttrib object that indicates geometry should be rendered in the indicated color.

◆ makeOff()

static const RenderAttrib makeOff ( )
static

Constructs a new ColorAttrib object that indicates geometry should be rendered in white.

◆ makeVertex()

static const RenderAttrib makeVertex ( )
static

Constructs a new ColorAttrib object that indicates geometry should be rendered according to its own vertex color.

Member Data Documentation

◆ class_slot

int class_slot

◆ color

const LColor color

If the type is T_flat or T_off, this returns the color that will be applied to geometry.

If the type is T_vertex, this is meaningless.

◆ color_type

ColorAttrib::Type color_type

Returns the type of color specified by this ColorAttrib.

The options are:

T_vertex - use the vertex color specified in the geometry itself.

T_flat - use the color specified in this ColorAttrib for all geometry. You can get this color via get_color().

T_off - use the color white.