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

Indicates which set of lights should be considered "on" to illuminate geometry at this level and below. More...

Inheritance diagram for LightAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Types

enum  Operation { O_set = 0, O_add = 1, O_remove = 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 RenderAttrib addLight (Light light)
 Returns a new LightAttrib, just like this one, but with the indicated light added to the list of lights. More...
 
const RenderAttrib addOffLight (const NodePath light)
 Returns a new LightAttrib, just like this one, but with the indicated light added to the list of lights turned off by this attrib. More...
 
const RenderAttrib addOnLight (const NodePath light)
 Returns a new LightAttrib, just like this one, but with the indicated light added to the list of lights turned on by this attrib. More...
 
LColor getAmbientContribution ()
 Returns the total contribution of all the ambient lights. More...
 
Light getLight (int n)
 Returns the nth light listed in the attribute. More...
 
NodePath getMostImportantLight ()
 Returns the most important light (that is, the light with the highest priority) in the LightAttrib, excluding any ambient lights. More...
 
int getNumLights ()
 Returns the number of lights listed in the attribute. More...
 
int getNumNonAmbientLights ()
 Returns the number of non-ambient lights that are turned on by this attribute. More...
 
int getNumOffLights ()
 Returns the number of lights that are turned off by the attribute. More...
 
int getNumOnLights ()
 Returns the number of lights that are turned on by the attribute. More...
 
NodePath getOffLight (int n)
 Returns the nth light turned off by the attribute, sorted in arbitrary (pointer) order. More...
 
list getOffLights ()
 
NodePath getOnLight (int n)
 Returns the nth light turned on by the attribute, sorted in render order. More...
 
list getOnLights ()
 
LightAttrib::Operation getOperation ()
 Returns the basic operation type of the LightAttrib. More...
 
bool hasAllOff ()
 Returns true if this attrib turns off all lights (although it may also turn some on). More...
 
bool hasAnyOnLight ()
 Returns true if any light is turned on by the attrib, false otherwise. More...
 
bool hasLight (Light light)
 Returns true if the indicated light is listed in the attrib, false otherwise. More...
 
bool hasOffLight (const NodePath light)
 Returns true if the indicated light is turned off by the attrib, false otherwise. More...
 
bool hasOnLight (const NodePath light)
 Returns true if the indicated light 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 lights in use. More...
 
const RenderAttrib removeLight (Light light)
 Returns a new LightAttrib, just like this one, but with the indicated light removed from the list of lights. More...
 
const RenderAttrib removeOffLight (const NodePath light)
 Returns a new LightAttrib, just like this one, but with the indicated light removed from the list of lights turned off by this attrib. More...
 
const RenderAttrib removeOnLight (const NodePath light)
 Returns a new LightAttrib, just like this one, but with the indicated light removed from the list of lights turned on by this attrib. 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 (LightAttrib::Operation op, Light light)
 Constructs a new LightAttrib object that turns on (or off, according to op) the indicated light(s). More...
 
static const RenderAttrib make (LightAttrib::Operation op, Light light1, Light light2)
 Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s). More...
 
static const RenderAttrib make (LightAttrib::Operation op, Light light1, Light light2, Light light3)
 Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s). More...
 
static const RenderAttrib make (LightAttrib::Operation op, Light light1, Light light2, Light light3, Light light4)
 Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s). More...
 
static const RenderAttrib makeAllOff ()
 Constructs a new LightAttrib object that turns off all lights (and hence disables lighting). 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 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
 
NodePath off_lights []
 
NodePath on_lights []
 
- 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 which set of lights should be considered "on" to illuminate geometry at this level and below.

A LightAttrib can either add lights or remove lights from the total set of "on" lights.

Member Enumeration Documentation

◆ Operation

enum Operation
Enumerator
O_set 
O_add 
O_remove 

Member Function Documentation

◆ addLight()

const RenderAttrib addLight ( Light  light)

Returns a new LightAttrib, just like this one, but with the indicated light added to the list of lights.

This method is now deprecated. Use add_on_light() or add_off_light() instead.

◆ addOffLight()

const RenderAttrib addOffLight ( const NodePath  light)

Returns a new LightAttrib, just like this one, but with the indicated light added to the list of lights turned off by this attrib.

◆ addOnLight()

const RenderAttrib addOnLight ( const NodePath  light)

Returns a new LightAttrib, just like this one, but with the indicated light added to the list of lights turned on by this attrib.

◆ getAmbientContribution()

LColor getAmbientContribution ( )

Returns the total contribution of all the ambient lights.

◆ getClassSlot()

static int getClassSlot ( )
static

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getLight()

Light getLight ( int  n)

Returns the nth light listed in the attribute.

This method is now deprecated. LightAttribs nowadays have a separate list of on_lights and off_lights, so this method doesn't make sense. Query the lists independently.

◆ getMostImportantLight()

NodePath getMostImportantLight ( )

Returns the most important light (that is, the light with the highest priority) in the LightAttrib, excluding any ambient lights.

Returns an empty NodePath if no non-ambient lights are found.

◆ getNumLights()

int getNumLights ( )

Returns the number of lights listed in the attribute.

This method is now deprecated. LightAttribs nowadays have a separate list of on_lights and off_lights, so this method doesn't make sense. Query the lists independently.

◆ getNumNonAmbientLights()

int getNumNonAmbientLights ( )

Returns the number of non-ambient lights that are turned on by this attribute.

◆ getNumOffLights()

int getNumOffLights ( )

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

◆ getNumOnLights()

int getNumOnLights ( )

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

◆ getOffLight()

NodePath getOffLight ( int  n)

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

◆ getOffLights()

list getOffLights ( )

◆ getOnLight()

NodePath getOnLight ( int  n)

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

◆ getOnLights()

list getOnLights ( )

◆ getOperation()

LightAttrib::Operation getOperation ( )

Returns the basic operation type of the LightAttrib.

If this is O_set, the lights listed here completely replace any lights that were already on. If this is O_add, the lights here are added to the set of lights that were already on, and if O_remove, the lights here are removed from the set of lights that were on.

This method is now deprecated. LightAttribs nowadays have a separate list of on_lights and off_lights, so this method doesn't make sense. Query the lists independently.

◆ hasAllOff()

bool hasAllOff ( )

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

◆ hasAnyOnLight()

bool hasAnyOnLight ( )

Returns true if any light is turned on by the attrib, false otherwise.

◆ hasLight()

bool hasLight ( Light  light)

Returns true if the indicated light is listed in the attrib, false otherwise.

This method is now deprecated. LightAttribs nowadays have a separate list of on_lights and off_lights, so this method doesn't make sense. Query the lists independently.

◆ hasOffLight()

bool hasOffLight ( const NodePath  light)

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

◆ hasOnLight()

bool hasOnLight ( const NodePath  light)

Returns true if the indicated light 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 lights in use.

◆ make() [1/5]

static const RenderAttrib make ( )
static

◆ make() [2/5]

static const RenderAttrib make ( LightAttrib::Operation  op,
Light  light 
)
static

Constructs a new LightAttrib object that turns on (or off, according to op) the indicated light(s).

This method is now deprecated. Use add_on_light() or add_off_light() instead.

◆ make() [3/5]

static const RenderAttrib make ( LightAttrib::Operation  op,
Light  light1,
Light  light2 
)
static

Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

This method is now deprecated. Use add_on_light() or add_off_light() instead.

◆ make() [4/5]

static const RenderAttrib make ( LightAttrib::Operation  op,
Light  light1,
Light  light2,
Light  light3 
)
static

Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

This method is now deprecated. Use add_on_light() or add_off_light() instead.

◆ make() [5/5]

static const RenderAttrib make ( LightAttrib::Operation  op,
Light  light1,
Light  light2,
Light  light3,
Light  light4 
)
static

Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

This method is now deprecated. Use add_on_light() or add_off_light() instead.

◆ makeAllOff()

static const RenderAttrib makeAllOff ( )
static

Constructs a new LightAttrib object that turns off all lights (and hence disables lighting).

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

◆ removeLight()

const RenderAttrib removeLight ( Light  light)

Returns a new LightAttrib, just like this one, but with the indicated light removed from the list of lights.

This method is now deprecated. Use remove_on_light() or remove_off_light() instead.

◆ removeOffLight()

const RenderAttrib removeOffLight ( const NodePath  light)

Returns a new LightAttrib, just like this one, but with the indicated light removed from the list of lights turned off by this attrib.

◆ removeOnLight()

const RenderAttrib removeOnLight ( const NodePath  light)

Returns a new LightAttrib, just like this one, but with the indicated light removed from the list of lights turned on by this attrib.

Member Data Documentation

◆ class_slot

int class_slot

◆ off_lights

NodePath off_lights[]

◆ on_lights

NodePath on_lights[]