TheCloud/panda3d
1
0
Fork 0
mirror of https://github.com/panda3d/panda3d.git synced 2025-10-01 17:35:34 -04:00
Code Issues Packages Projects Releases Wiki Activity

clarify NodePath light interfaces

Browse Source
This commit is contained in:
David Rose 2004-07-30 18:59:42 +00:00
parent 95b096ccfa
commit 8b5014d01e
2 changed files with 162 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

241
panda/src/pgraph/nodePath.cxx
View File

@ -2027,7 +2027,7 @@ get_color_scale() const {
////////////////////////////////////////////////////////////////////
// Function: NodePath::set_light
// Access: Published
// Description: Adds the indicated light to the list of lights that
// Description: Adds the indicated Light to the list of lights that
// illuminate geometry at this node and below. The
// light itself should be parented into the scene graph
// elsewhere, to represent the light's position in
@ -2056,6 +2056,45 @@ set_light(Light *light, int priority) {
}
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::set_light
// Access: Published
// Description: Adds a PolylightEffect to the geometry at this node
// and below. This makes the geometry at this point in
// the scene graph grow brighter or dimmer according to
// its proximity to the indicated PolylightNode; this is
// an effect similar to lighting, but is not related to
// traditional hardware T&L.
////////////////////////////////////////////////////////////////////
void NodePath::
set_light(PolylightNode *) {
// Not yet implemented.
nassertv(false);
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::set_light
// Access: Published
// Description: Adds the indicated Light or PolylightNode to the list
// of lights that illuminate geometry at this node and
// below. The light itself should be parented into the
// scene graph elsewhere, to represent the light's
// position in space; but until set_light() is called it
// will illuminate no geometry.
////////////////////////////////////////////////////////////////////
void NodePath::
set_light(const NodePath &light, int priority) {
if (!light.is_empty()) {
PandaNode *node = light.node();
Light *light_obj = node->as_light();
if (light_obj != (Light *)NULL) {
set_light(light_obj, priority);
return;
}
}
nassert_raise("Not a Light object.");
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::set_light_off
// Access: Published
@ -2080,8 +2119,8 @@ set_light_off(int priority) {
// Function: NodePath::set_light_off
// Access: Published
// Description: Sets the geometry at this level and below to render
// using without the indicated light. This is different
// from not specifying the light; rather, this
// using without the indicated Light. This is different
// from not specifying the Light; rather, this
// specifically contradicts set_light() at a higher node
// level (or, with a priority, overrides a set_light()
// at a lower level).
@ -2110,6 +2149,32 @@ set_light_off(Light *light, int priority) {
}
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::set_light_off
// Access: Published
// Description: Sets the geometry at this level and below to render
// using without the indicated Light. This is different
// from not specifying the Light; rather, this
// specifically contradicts set_light() at a higher node
// level (or, with a priority, overrides a set_light()
// at a lower level).
//
// This interface does not support PolylightNodes, which
// cannot be turned off at a lower level.
////////////////////////////////////////////////////////////////////
void NodePath::
set_light_off(const NodePath &light, int priority) {
if (!light.is_empty()) {
PandaNode *node = light.node();
Light *light_obj = node->as_light();
if (light_obj != (Light *)NULL) {
set_light_off(light_obj, priority);
return;
}
}
nassert_raise("Not a Light object.");
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::clear_light
// Access: Published
@ -2121,12 +2186,13 @@ void NodePath::
clear_light() {
nassertv_always(!is_empty());
node()->clear_attrib(LightAttrib::get_class_type());
node()->clear_effect(PolylightEffect::get_class_type());
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::clear_light
// Access: Published
// Description: Removes any reference to the indicated light
// Description: Removes any reference to the indicated Light
// from the NodePath.
////////////////////////////////////////////////////////////////////
void NodePath::
@ -2150,10 +2216,41 @@ clear_light(Light *light) {
}
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::clear_light
// Access: Published
// Description: Removes the indicated PolylightEffect from the
// geometry. This undoes a previous set_light() call.
////////////////////////////////////////////////////////////////////
void NodePath::
clear_light(PolylightNode *) {
// Not yet implemented.
nassertv(false);
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::clear_light
// Access: Published
// Description: Removes any reference to the indicated Light or
// PolylightNode from the NodePath.
////////////////////////////////////////////////////////////////////
void NodePath::
clear_light(const NodePath &light) {
if (!light.is_empty()) {
PandaNode *node = light.node();
Light *light_obj = node->as_light();
if (light_obj != (Light *)NULL) {
clear_light(light_obj);
return;
}
}
nassert_raise("Not a Light object.");
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::has_light
// Access: Published
// Description: Returns true if the indicated light has been
// Description: Returns true if the indicated Light has been
// specifically enabled on this particular node. This
// means that someone called set_light() on this node
// with the indicated light.
@ -2172,10 +2269,46 @@ has_light(Light *light) const {
return false;
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::has_light
// Access: Published
// Description: Returns true if the indicated PolylightNode has been
// specifically enabled on this particular node. This
// means that someone called set_light() on this node
// with the indicated light.
////////////////////////////////////////////////////////////////////
bool NodePath::
has_light(PolylightNode *) const {
// Not yet implemented.
nassertr(false, false);
return false;
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::has_light
// Access: Published
// Description: Returns true if the indicated Light or PolylightNode
// has been specifically enabled on this particular
// node. This means that someone called set_light() on
// this node with the indicated light.
////////////////////////////////////////////////////////////////////
bool NodePath::
has_light(const NodePath &light) const {
if (!light.is_empty()) {
PandaNode *node = light.node();
Light *light_obj = node->as_light();
if (light_obj != (Light *)NULL) {
return has_light(light_obj);
}
}
nassert_raise("Not a Light object.");
return false;
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::has_light_off
// Access: Published
// Description: Returns true if all lights have been specifically
// Description: Returns true if all Lights have been specifically
// disabled on this particular node. This means that
// someone called set_light_off() on this node with no
// parameters.
@ -2196,7 +2329,7 @@ has_light_off() const {
////////////////////////////////////////////////////////////////////
// Function: NodePath::has_light_off
// Access: Published
// Description: Returns true if the indicated light has been
// Description: Returns true if the indicated Light has been
// specifically disabled on this particular node. This
// means that someone called set_light_off() on this
// node with the indicated light.
@ -2216,92 +2349,18 @@ has_light_off(Light *light) const {
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::set_light
// Function: NodePath::has_light_off
// Access: Published
// Description: Adds a PolylightEffect to the geometry at this node
// and below. This makes the geometry at this point in
// the scene graph grow brighter or dimmer according to
// its proximity to the indicated PolylightNode; this is
// an effect similar to lighting, but is not related to
// traditional hardware T&L.
////////////////////////////////////////////////////////////////////
void NodePath::
set_light(PolylightNode *) {
// Not yet implemented.
nassertv(false);
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::clear_light
// Access: Published
// Description: Removes the indicated PolylightEffect from the
// geometry. This undoes a previous set_light() call.
////////////////////////////////////////////////////////////////////
void NodePath::
clear_light(PolylightNode *) {
// Not yet implemented.
nassertv(false);
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::has_light
// Access: Published
// Description: Returns true if the indicated PolylightNode was added
// to this node, false otherwise.
// Description: Returns true if the indicated Light has been
// specifically disabled on this particular node. This
// means that someone called set_light_off() on this
// node with the indicated light.
//
// This interface does not support PolylightNodes, which
// cannot be turned off at a lower level.
////////////////////////////////////////////////////////////////////
bool NodePath::
has_light(PolylightNode *) {
// Not yet implemented.
nassertr(false, false);
return false;
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::set_light
// Access: Published
// Description: Adds a Light or Polylight to the geometry at this
// node and below.
////////////////////////////////////////////////////////////////////
void NodePath::
set_light(const NodePath &light) {
if (!light.is_empty()) {
PandaNode *node = light.node();
Light *light_obj = node->as_light();
if (light_obj != (Light *)NULL) {
set_light(light_obj);
return;
}
}
nassert_raise("Not a light object.");
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::clear_light
// Access: Published
// Description: Removes the indicated PolylightEffect from the
// geometry. This undoes a previous set_light() call.
////////////////////////////////////////////////////////////////////
void NodePath::
clear_light(const NodePath &light) {
if (!light.is_empty()) {
PandaNode *node = light.node();
Light *light_obj = node->as_light();
if (light_obj != (Light *)NULL) {
clear_light(light_obj);
return;
}
}
nassert_raise("Not a light object.");
}
////////////////////////////////////////////////////////////////////
// Function: NodePath::has_light
// Access: Published
// Description: Returns true if the indicated PolylightNode was added
// to this node, false otherwise.
////////////////////////////////////////////////////////////////////
bool NodePath::
has_light(const NodePath &light) {
has_light_off(const NodePath &light) const {
if (!light.is_empty()) {
PandaNode *node = light.node();
Light *light_obj = node->as_light();
@ -2309,7 +2368,7 @@ has_light(const NodePath &light) {
return has_light(light_obj);
}
}
nassert_raise("Not a light object.");
nassert_raise("Not a Light object.");
return false;
}

20
panda/src/pgraph/nodePath.h
View File

@ -488,21 +488,25 @@ PUBLISHED:
INLINE float get_sa() const;
void set_light(Light *light, int priority = 0);
void set_light(PolylightNode *light);
void set_light(const NodePath &light, int priority = 0);
void set_light_off(int priority = 0);
void set_light_off(Light *light, int priority = 0);
void set_light_off(const NodePath &light, int priority = 0);
void clear_light();
void clear_light(Light *light);
void clear_light(PolylightNode *light);
void clear_light(const NodePath &light);
bool has_light(Light *light) const;
bool has_light(PolylightNode *light) const;
bool has_light(const NodePath &light) const;
bool has_light_off() const;
bool has_light_off(Light *light) const;
void set_light(PolylightNode *light);
void clear_light(PolylightNode *light);
bool has_light(PolylightNode *light);
void set_light(const NodePath &light);
void clear_light(const NodePath &light);
bool has_light(const NodePath &light);
bool has_light_off(const NodePath &light) const;
void set_bin(const string &bin_name, int draw_order, int priority = 0);
void clear_bin();