LightAttrib¶
from panda3d.core import LightAttrib
-
class
LightAttrib
¶ Bases:
RenderAttrib
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.
Inheritance diagram
-
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
= 0
-
enumerator
O_add
= 1
-
enumerator
O_remove
= 2
-
enumerator
-
addLight
(light: Light) → RenderAttrib¶ Returns a new
LightAttrib
, just like this one, but with the indicated light added to the list of lights.Deprecated: Use
addOnLight()
oraddOffLight()
instead.
-
addOffLight
(light: NodePath) → RenderAttrib¶ 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
(light: NodePath) → RenderAttrib¶ Returns a new
LightAttrib
, just like this one, but with the indicated light added to the list of lights turned on by this attrib.
-
static
getClassType
() → TypeHandle¶
-
getLight
(n: int) → Light¶ Returns the nth light listed in the attribute.
Deprecated:
LightAttribs
nowadays have a separate list of on_lights andoff_lights, so this method no longer makes sense. Query the lists independently.
-
getMostImportantLight
() → NodePath¶ Returns the most important light (that is, the light with the highest priority) in the
LightAttrib
, excluding any ambient lights. Returns an emptyNodePath
if no non-ambient lights are found.
-
getNumLights
() → int¶ Returns the number of lights listed in the attribute.
Deprecated:
LightAttribs
nowadays have a separate list of on_lights andoff_lights, so this method no longer makes sense. Query the lists independently.
-
getNumNonAmbientLights
() → int¶ Returns the number of non-ambient lights that are turned on by this attribute.
-
getOffLight
(n: int) → NodePath¶ Returns the nth light turned off by the attribute, sorted in arbitrary (pointer) order.
-
getOnLight
(n: int) → NodePath¶ Returns the nth light turned on by the attribute, sorted in render order.
-
getOperation
() → Operation¶ 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.Deprecated:
LightAttribs
nowadays have a separate list of on_lights andoff_lights, so this method no longer makes sense. Query the lists independently.
-
hasAllOff
() → bool¶ Returns true if this attrib turns off all lights (although it may also turn some on).
-
hasLight
(light: Light) → bool¶ Returns true if the indicated light is listed in the attrib, false otherwise.
Deprecated:
LightAttribs
nowadays have a separate list of on_lights andoff_lights, so this method no longer makes sense. Query the lists independently.
-
hasOffLight
(light: NodePath) → bool¶ Returns true if the indicated light is turned off by the attrib, false otherwise.
-
hasOnLight
(light: NodePath) → bool¶ Returns true if the indicated light is turned on by the attrib, false otherwise.
-
isIdentity
() → bool¶ Returns true if this is an identity attrib: it does not change the set of lights in use.
-
static
make
() → RenderAttrib¶ The following is the new, more general interface to the
LightAttrib
.
-
static
make
(op: Operation, light: Light) → RenderAttrib Constructs a new
LightAttrib
object that turns on (or off, according to op) the indicated light(s).Deprecated: Use
addOnLight()
oraddOffLight()
instead.
-
static
make
(op: Operation, light1: Light, light2: Light) → RenderAttrib Constructs a new
LightAttrib
object that turns on (or off, according to op) the indicate light(s).Deprecated: Use
addOnLight()
oraddOffLight()
instead.
-
static
make
(op: Operation, light1: Light, light2: Light, light3: Light) → RenderAttrib Constructs a new
LightAttrib
object that turns on (or off, according to op) the indicate light(s).Deprecated: Use
addOnLight()
oraddOffLight()
instead.
-
static
make
(op: Operation, light1: Light, light2: Light, light3: Light, light4: Light) → RenderAttrib Constructs a new
LightAttrib
object that turns on (or off, according to op) the indicate light(s).Deprecated: Use
addOnLight()
oraddOffLight()
instead.
-
static
makeAllOff
() → RenderAttrib¶ Constructs a new
LightAttrib
object that turns off all lights (and hence disables lighting).
-
static
makeDefault
() → RenderAttrib¶ Returns a
RenderAttrib
that corresponds to whatever the standard default properties for render attributes of this type ought to be.
-
property
off_lights
→ Sequence[NodePath]¶ Returns the nth light turned off by the attribute, sorted in arbitrary (pointer) order.
-
property
on_lights
→ Sequence[NodePath]¶ Returns the nth light turned on by the attribute, sorted in render order.
-
removeLight
(light: Light) → RenderAttrib¶ Returns a new
LightAttrib
, just like this one, but with the indicated light removed from the list of lights.Deprecated: Use
removeOnLight()
orremoveOffLight()
instead.
-
removeOffLight
(light: NodePath) → RenderAttrib¶ 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
(light: NodePath) → RenderAttrib¶ Returns a new
LightAttrib
, just like this one, but with the indicated light removed from the list of lights turned on by this attrib.
-
replaceOffLight
(source: NodePath, dest: NodePath) → RenderAttrib¶ Returns a new
LightAttrib
, just like this one, but with the indicated light replaced with the given other light.
-
replaceOnLight
(source: NodePath, dest: NodePath) → RenderAttrib¶ Returns a new
LightAttrib
, just like this one, but with the indicated light replaced with the given other light.
-
enum