Panda3D
Classes | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions

Light Class Reference

The abstract interface to all kinds of lights. More...

#include "light.h"

Inheritance diagram for Light:
ReferenceCount MemoryBase LightLensNode LightNode DirectionalLight PointLight Spotlight AmbientLight

List of all members.

Classes

class  CData

Public Member Functions

 Light (const Light &copy)
virtual PandaNodeas_node ()=0
virtual void bind (GraphicsStateGuardianBase *gsg, const NodePath &light, int light_id)=0
virtual int get_class_priority () const =0
const Colorfget_color () const
 Returns the basic color of the light.
int get_priority () const
 Returns the priority associated with this light.
int get_ref_count () const
 Returns the current reference count.
virtual TypeHandle get_type () const
virtual bool get_vector_to_light (LVector3f &result, const LPoint3f &from_object_point, const LMatrix4f &to_object_space)
 Computes the vector from a particular vertex to this light.
GeomNodeget_viz ()
 Returns a GeomNode that may be rendered to visualize the Light.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
virtual bool is_ambient_light () const
 Returns true if this is an AmbientLight, false if it is some other kind of light.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
virtual void output (ostream &out) const =0
void ref () const
 Explicitly increments the reference count.
void set_color (const Colorf &color)
 Sets the basic color of the light.
void set_priority (int priority)
 Changes the relative importance of this light relative to the other lights that are applied simultaneously.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool unref () const
 Explicitly decrements the reference count.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.
virtual void write (ostream &out, int indent_level) const =0

Static Public Member Functions

static TypeHandle get_class_type ()
static UpdateSeq get_sort_seq ()
 Returns a global sequence number that is incremented any time any Light in the world changes sort or priority.
static void init_type ()

Protected Types

enum  ClassPriority { CP_ambient_priority, CP_point_priority, CP_directional_priority, CP_spot_priority }

Protected Member Functions

bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.
virtual void fill_viz_geom (GeomNode *viz_geom)
 Fills the indicated GeomNode up with Geoms suitable for rendering this light.
void fillin (DatagramIterator &scan, BamReader *manager)
 This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new Light.
void mark_viz_stale ()
 Indicates that the internal visualization object will need to be updated.
void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file.

Detailed Description

The abstract interface to all kinds of lights.

The actual light objects also inherit from PandaNode, and can therefore be added to the scene graph at some arbitrary point to define the coordinate system of effect.

Definition at line 42 of file light.h.


Member Function Documentation

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

void Light::fill_viz_geom ( GeomNode viz_geom) [protected, virtual]

Fills the indicated GeomNode up with Geoms suitable for rendering this light.

Reimplemented in Spotlight.

Definition at line 128 of file light.cxx.

Referenced by get_viz().

void Light::fillin ( DatagramIterator scan,
BamReader manager 
) [protected]

This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new Light.

Reimplemented in AmbientLight, DirectionalLight, LightLensNode, LightNode, PointLight, and Spotlight.

Definition at line 151 of file light.cxx.

References DatagramIterator::get_int32(), and BamReader::read_cdata().

const Colorf & Light::get_color ( ) const [inline]

Returns the basic color of the light.

Definition at line 70 of file light.I.

Referenced by DXGraphicsStateGuardian9::get_light_color(), and DXGraphicsStateGuardian8::get_light_color().

int Light::get_priority ( ) const [inline]

Returns the priority associated with this light.

See set_priority().

Definition at line 118 of file light.I.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
UpdateSeq Light::get_sort_seq ( ) [inline, static]

Returns a global sequence number that is incremented any time any Light in the world changes sort or priority.

This is used by LightAttrib to determine when it is necessary to re-sort its internal array of stages.

Definition at line 132 of file light.I.

bool Light::get_vector_to_light ( LVector3f result,
const LPoint3f from_object_point,
const LMatrix4f to_object_space 
) [virtual]

Computes the vector from a particular vertex to this light.

The exact vector depends on the type of light (e.g. point lights return a different result than directional lights).

The input parameters are the vertex position in question, expressed in object space, and the matrix which converts from light space to object space. The result is expressed in object space.

The return value is true if the result is successful, or false if it cannot be computed (e.g. for an ambient light).

Reimplemented in DirectionalLight, PointLight, and Spotlight.

Definition at line 97 of file light.cxx.

GeomNode * Light::get_viz ( )

Returns a GeomNode that may be rendered to visualize the Light.

This is used during the cull traversal to render the Lights that have been made visible.

Definition at line 109 of file light.cxx.

References fill_viz_geom().

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

bool Light::is_ambient_light ( ) const [virtual]

Returns true if this is an AmbientLight, false if it is some other kind of light.

Reimplemented in AmbientLight.

Definition at line 75 of file light.cxx.

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

void Light::mark_viz_stale ( ) [inline, protected]

Indicates that the internal visualization object will need to be updated.

Definition at line 143 of file light.I.

Referenced by set_color(), DirectionalLight::set_direction(), PointLight::set_point(), DirectionalLight::set_point(), Spotlight::xform(), and DirectionalLight::xform().

void ReferenceCount::ref ( ) const [inline, inherited]

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.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

void Light::set_color ( const Colorf color) [inline]

Sets the basic color of the light.

Definition at line 81 of file light.I.

References mark_viz_stale().

Referenced by WindowFramework::setup_lights().

void Light::set_priority ( int  priority) [inline]

Changes the relative importance of this light relative to the other lights that are applied simultaneously.

The priority number is used to decide which of the requested lights are to be selected for rendering when more lights are requested than the hardware will support. The highest-priority n lights are selected for rendering.

This is similar to TextureStage::set_priority().

Definition at line 103 of file light.I.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool ReferenceCount::unref ( ) const [inline, virtual, inherited]

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

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.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().

void Light::write_datagram ( BamWriter manager,
Datagram dg 
) [protected]

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented in AmbientLight, DirectionalLight, LightLensNode, LightNode, PointLight, and Spotlight.

Definition at line 138 of file light.cxx.

References Datagram::add_int32(), and BamWriter::write_cdata().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations