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

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

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

Public Types

enum  Operation { O_set = 0, O_add = 1, O_remove = 2 }
 This is the old, deprecated interface to LightAttrib. Do not use any of these methods for new code; these methods will be removed soon. More...
 
- 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
}
 intentionally defined to match D3DCMPFUNC More...
 
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
}
 This is the enumerated type for TexGenAttrib. It is inherited into TexGenAttrib. It is defined up at this level only to avoid circular dependencies in the header files. More...
 

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...
 
const LightAttrib filterToMax (int max_lights)
 Returns a new LightAttrib, very much like this one, but with the number of on_lights reduced to be no more than max_lights. The number of off_lights in the new LightAttrib is undefined. 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. Returns an empty NodePath if no non-ambient lights are found. More...
 
int getNumLights ()
 Returns the number of lights listed in the 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. 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 of lights that were already on, and if O_remove, the lights here are removed from the set of lights that were on. More...
 
bool hasAllOff ()
 Returns true if this attrib turns off all lights (although it may also turn some on). 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. In most cases, this is the same as the other attrib; a compose b produces b. Some kinds of attributes, like a TextureTransform, for instance, might produce a new result: a compose b produces c. More...
 
const RenderAttrib getAutoShaderAttrib (const RenderState state)
 Returns the variant of this RenderAttrib that's most relevant for associating with an auto-generated shader. This should be a new RenderAttrib of the same type as this one, with any superfluous data set to neutral. Only the parts of the attrib that contribute to the shader should be reflected in the returned attrib. The idea is to associate the auto-generated shader with the most neutral form of all states, to allow it to be shared across as many RenderState objects as possible. More...
 
size_t 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. This may be the same pointer as this object, or it may be a different pointer; but it will be an equivalent object, and it will be a shared pointer. This may be called from time to time to improve cache benefits. 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. In most cases, this is the same as the other attrib; !a compose b produces b. Some kinds of attributes, like a TextureTransform, for instance, might produce a new result: !a compose b produces c. 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)
 
str encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. Returns empty string on failure. More...
 
bool encodeToBamStream (String data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. Returns true on success, false on failure. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 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(). 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. 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. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
 
bool unref ()
 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.) However, see the helper function unref_delete(). More...
 

Static Public Member Functions

static int getClassSlot ()
 
static TypeHandle getClassType ()
 
static const RenderAttrib make ()
 Constructs a new LightAttrib object that does nothing. More...
 
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. This is called automatically from RenderState::garbage_collect(); see that method for more information. More...
 
static TypeHandle getClassType ()
 
static int getNumAttribs ()
 Returns the total number of unique RenderAttrib objects allocated in the world. This will go up and down during normal operations. More...
 
static listAttribs (Ostream out)
 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. More...
 
static bool validateAttribs ()
 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). More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (str data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. 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 ()
 

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

This is the old, deprecated interface to LightAttrib. Do not use any of these methods for new code; these methods will be removed soon.

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.

◆ filterToMax()

const LightAttrib filterToMax ( int  max_lights)

Returns a new LightAttrib, very much like this one, but with the number of on_lights reduced to be no more than max_lights. The number of off_lights in the new LightAttrib is undefined.

The number of AmbientLights is not included in the count. All AmbientLights in the original attrib are always included in the result, regardless of the value of max_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.

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

◆ 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

Constructs a new LightAttrib object that does nothing.

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