Avara3D 0.2.0
C++ API reference
a3d::DirectionalLight Class Reference

Infinitely distant light with uniform direction and no distance attenuation. More...

#include <a3d/visual/light/DirectionalLight.h>

Inheritance diagram for a3d::DirectionalLight:
[legend]

Public Member Functions

 DirectionalLight ()
 Creates an unnamed white DirectionalLight. More...
 
 DirectionalLight (const std::string &name)
 Creates a named white DirectionalLight. More...
 
 DirectionalLight (const Color &color)
 Creates an unnamed DirectionalLight with color. More...
 
 DirectionalLight (const std::string &name, const Color &color)
 Creates a DirectionalLight with name and color. More...
 
- Public Member Functions inherited from a3d::Light
const std::optional< std::string > & name () const
 Returns the optional light name. More...
 
void name (const std::string &name)
 Sets the light name. More...
 
const Colorcolor () const
 Returns the light color. More...
 
void color (const Color &color)
 Sets the light color. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from a3d::Light
static std::shared_ptr< AmbientLightAmbient ()
 Creates a white AmbientLight. More...
 
static std::shared_ptr< AmbientLightAmbient (const Color &color)
 Creates an AmbientLight with color. More...
 
static std::shared_ptr< DirectionalLightDirectional ()
 Creates a white DirectionalLight. More...
 
static std::shared_ptr< DirectionalLightDirectional (const Color &color)
 Creates a DirectionalLight with color. More...
 
static std::shared_ptr< PointLightPoint ()
 Creates a white PointLight. More...
 
static std::shared_ptr< PointLightPoint (const Color &color)
 Creates a PointLight with color. More...
 
static std::shared_ptr< SpotLightSpot ()
 Creates a white SpotLight. More...
 
static std::shared_ptr< SpotLightSpot (const Color &color)
 Creates a SpotLight with color. More...
 

Detailed Description

Infinitely distant light with uniform direction and no distance attenuation.

The light direction follows the containing Node's world-forward direction.

Definition at line 26 of file DirectionalLight.h.

Constructor & Destructor Documentation

◆ DirectionalLight() [1/4]

a3d::DirectionalLight::DirectionalLight ( )

Creates an unnamed white DirectionalLight.

◆ DirectionalLight() [2/4]

a3d::DirectionalLight::DirectionalLight ( const std::string &  name)
explicit

Creates a named white DirectionalLight.

◆ DirectionalLight() [3/4]

a3d::DirectionalLight::DirectionalLight ( const Color color)
explicit

Creates an unnamed DirectionalLight with color.

◆ DirectionalLight() [4/4]

a3d::DirectionalLight::DirectionalLight ( const std::string &  name,
const Color color 
)

Creates a DirectionalLight with name and color.


The documentation for this class was generated from the following file: