Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

nvsg::DirectedLight Class Reference

Class representing a directed light. More...

#include <DirectedLight.h>

Inheritance diagram for nvsg::DirectedLight:

Inheritance graph
[legend]
Collaboration diagram for nvsg::DirectedLight:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual NVSG_API const DirectedLight * clone (void) const
 Get a clone of this DirectedLight. More...

virtual NVSG_API DataID getDataID (void) const
 Get the DataID of the data of this object. More...

virtual NVSG_API bool isDataShared (void) const
 Determine whether the data of this object is shared. More...


Static Public Methods

NVSG_API const DirectedLight * create (void)
 Create a DirectedLight. More...

NVSG_API const DirectedLight * createFromBase (const LightSource &rhs)
 Create a DirectedLight by copying from a LightSource. More...


Protected Methods

NVSG_API DirectedLight (void)
 Default Constructor. More...

NVSG_API DirectedLight (const LightSource &rhs)
 Partial Constructor. More...

NVSG_API DirectedLight (const DirectedLight &rhs)
 Copy Constructor. More...

virtual NVSG_API ~DirectedLight (void)
 Protected destructor to prevent explicit creation on stack. More...


Detailed Description

Class representing a directed light.

Directed light is just that - directed. Directed light always has direction and color, and is a factor in shading algorithms such as Gouraud shading.

Note:
The default light direction is (0,0,-1).


Constructor & Destructor Documentation

NVSG_API nvsg::DirectedLight::DirectedLight void    [protected]
 

Default Constructor.

NVSG_API nvsg::DirectedLight::DirectedLight const LightSource   rhs [protected]
 

Partial Constructor.

NVSG_API nvsg::DirectedLight::DirectedLight const DirectedLight &    rhs [protected]
 

Copy Constructor.

virtual NVSG_API nvsg::DirectedLight::~DirectedLight void    [protected, virtual]
 

Protected destructor to prevent explicit creation on stack.


Member Function Documentation

NVSG_API const DirectedLight* nvsg::DirectedLight::create void    [static]
 

Create a DirectedLight.

Returns:
a constant pointer to a DirectedLight.

NVSG_API const DirectedLight* nvsg::DirectedLight::createFromBase const LightSource   rhs [static]
 

Create a DirectedLight by copying from a LightSource.

Returns:
a constant pointer to a DirectedLight.
Parameters:
rhs  LightSource to copy from

virtual NVSG_API const DirectedLight* nvsg::DirectedLight::clone void    const [virtual]
 

Get a clone of this DirectedLight.

Returns:
A constant pointer to the new created clone.

Implements nvsg::Node.

virtual NVSG_API DataID nvsg::DirectedLight::getDataID void    const [virtual]
 

Get the DataID of the data of this object.

Returns:
DataID of the object's data.

Reimplemented from nvsg::LightSource.

virtual NVSG_API bool nvsg::DirectedLight::isDataShared void    const [virtual]
 

Determine whether the data of this object is shared.

Returns:
true if the object's data is shared, otherwise false.

Reimplemented from nvsg::LightSource.


The documentation for this class was generated from the following file:
Generated on Tue Mar 1 13:20:25 2005 for NVSGSDK by NVIDIA