scenepic 1.1.0
3D Visualization Made Easy
Public Member Functions | Static Public Member Functions | List of all members
scenepic::Shading Class Reference

Parameters of the shaders. More...

#include <shading.h>

Public Member Functions

 Shading (const Color &bg_color=Color(0, 0, 0), const Color &ambient_light_color=Color(0.7f, 0.7f, 0.7f), const Color &directional_light_color=Color(0.3f, 0.3f, 0.3f), const Vector &directional_light_dir=Vector(2, 1, 2))
 Constructor. More...
 
 Shading (const Color4 &bg_color, const Color &ambient_light_color, const Color &directional_light_color, const Vector &directional_light_dir)
 Constructor. More...
 
const Color4 & bg_color () const
 
const Colorambient_light_color () const
 
const Colordirectional_light_color () const
 
const Vector & directional_light_dir () const
 
std::string to_string () const
 Return a JSON string representing the object. More...
 
JsonValue to_json () const
 Convert this object into ScenePic json. More...
 
bool is_none () const
 Whether this is a "no shading" instance. More...
 

Static Public Member Functions

static const Shading None ()
 A Shading value indication "no shading". More...
 

Detailed Description

Parameters of the shaders.

Constructor & Destructor Documentation

◆ Shading() [1/2]

scenepic::Shading::Shading ( const Color bg_color = Color(0, 0, 0),
const Color ambient_light_color = Color(0.7f, 0.7f, 0.7f),
const Color directional_light_color = Color(0.3f, 0.3f, 0.3f),
const Vector &  directional_light_dir = Vector(2, 1, 2) 
)

Constructor.

Parameters
bg_colorbackground color
ambient_light_colorcolor of ambient light
directional_light_colorcolor of directional light
directional_light_dirdirection of directional light

◆ Shading() [2/2]

scenepic::Shading::Shading ( const Color4 &  bg_color,
const Color ambient_light_color,
const Color directional_light_color,
const Vector &  directional_light_dir 
)

Constructor.

Parameters
bg_colorbackground color (RGBA)
ambient_light_colorcolor of ambient light
directional_light_colorcolor of directional light
directional_light_dirdirection of directional light

Member Function Documentation

◆ ambient_light_color()

const Color & scenepic::Shading::ambient_light_color ( ) const

◆ bg_color()

const Color4 & scenepic::Shading::bg_color ( ) const

◆ directional_light_color()

const Color & scenepic::Shading::directional_light_color ( ) const

◆ directional_light_dir()

const Vector & scenepic::Shading::directional_light_dir ( ) const

◆ is_none()

bool scenepic::Shading::is_none ( ) const

Whether this is a "no shading" instance.

◆ None()

static const Shading scenepic::Shading::None ( )
static

A Shading value indication "no shading".

◆ to_json()

JsonValue scenepic::Shading::to_json ( ) const

Convert this object into ScenePic json.

Returns
a json value

◆ to_string()

std::string scenepic::Shading::to_string ( ) const

Return a JSON string representing the object.


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