omni::visual::Light Struct Reference

A light with position and phong shader attributes. More...

#include <Light.h>

Inheritance diagram for omni::visual::Light:

Collaboration diagram for omni::visual::Light:

Public Member Functions
	Light (const Tracker &_tracker=Tracker(), qreal const &_intensity=1.0)
	Light (const Tracker &_tracker, const QColor &_ambient, const QColor &_diffuse, const QColor &_specular, const qreal &_intensity=1.0)
void	setup (GLuint _index=GL_LIGHT0)
	Setup light in OpenGL. More...
QColor	ambient () const
	Return color for ambient. More...
void	setAmbient (QColor)
	Set new ambient color. More...
QColor	diffuse () const
	Return diffuse color. More...
void	setDiffuse (QColor)
	Set new diffuse color. More...
QColor	specular () const
	Return specular color. More...
void	setSpecular (QColor)
	Set new specular color. More...
qreal	intensity () const
	Return intensity value. More...
void	setIntensity (qreal)
	Set new intensity value. More...
void	fromStream (QDataStream &)
	Deserialize from stream. More...
void	toStream (QDataStream &) const
	Serialize to stream. More...
Public Member Functions inherited from omni::visual::Tracker
	Tracker ()
	Tracker (const QVector3D &_center, const PolarVec &_direction)
void	track (float _longitude, float _latitude, float _radius)
QVector3D	eye () const
	get tracker position More...
void	setEye (const QVector3D &_pos)
	Set eye position. More...
void	setCenter (QVector3D const &)
	Set center position. More...
QVector3D &	center ()
	Return center position. More...
QVector3D const &	center () const
	Return center position (const version) More...
void	setDirection (PolarVec const &)
	Set direction from polar vector. More...
void	setDistance (float _t)
	Set direction with a certain distance. More...
PolarVec &	direction ()
	Return direction as polar vector. More...
PolarVec const &	direction () const
	Return direction as polar vector (const version) More...
void	limitDistance (float _minDist, float _maxDist)
	Keep distance in limits. More...

Private Types
typedef std::array< GLfloat, 4 >	param_type

Private Member Functions
param_type	colorParam (QColor) const
param_type	eye4 () const

Private Attributes
QColor	ambient_
QColor	diffuse_
QColor	specular_
qreal	intensity_

Friends
bool	operator== (Light const &, Light const &)
	Test for equality. ScreenSetup is ignored. More...

Detailed Description

A light with position and phong shader attributes.

Member Typedef Documentation

typedef std::array<GLfloat, 4> omni::visual::Light::param_type

private

Constructor & Destructor Documentation

omni::visual::Light::Light	(	const Tracker &	_tracker = Tracker(),
		qreal const &	_intensity = 1.0
	)

                                          :
      Tracker(_tracker),
      ambient_("#111111"),
      diffuse_("#FFFFFF"),
      specular_("#FFFFFF"),
      intensity_(_intensity)
    {}

omni::visual::Light::Light	(	const Tracker &	_tracker,
		const QColor &	_ambient,
		const QColor &	_diffuse,
		const QColor &	_specular,
		const qreal &	_intensity = 1.0
	)

                               :
      Tracker(_tracker),
      ambient_(_ambient),
      diffuse_(_diffuse),
      specular_(_specular),
      intensity_(_intensity)
    {}

Member Function Documentation

QColor omni::visual::Light::ambient

(

)

const

Return color for ambient.

    {
      return ambient_;
    }

Light::param_type omni::visual::Light::colorParam ( QColor  _color ) const

private

    {
      return param_type({
        GLfloat(_color.redF() * intensity_),
        GLfloat(_color.greenF() * intensity_),
        GLfloat(_color.blueF() * intensity_),
        GLfloat(1.0)
      });
    }

QColor omni::visual::Light::diffuse

(

)

const

Return diffuse color.

    {
      return diffuse_;
    }

Light::param_type omni::visual::Light::eye4 ( ) const

private

    {
      auto e = eye();

      return param_type({ e.x(), e.y(), e.z(), GLfloat(1.0) });
    }

void omni::visual::Light::fromStream ( QDataStream &  _is )

virtual

Deserialize from stream.

Reimplemented from omni::visual::Tracker.

                                           {
      Tracker::fromStream(_is);
      _is >> ambient_ >> diffuse_ >> specular_ >> intensity_;
    }

qreal omni::visual::Light::intensity

(

)

const

Return intensity value.

    {
      return intensity_;
    }

void omni::visual::Light::setAmbient

(

QColor

_ambient

)

Set new ambient color.

    {
      ambient_ = _ambient;
    }

void omni::visual::Light::setDiffuse

(

QColor

_diffuse

)

Set new diffuse color.

    {
      diffuse_ = _diffuse;
    }

void omni::visual::Light::setIntensity

(

qreal

_intensity

)

Set new intensity value.

    {
      intensity_ = _intensity;
    }

void omni::visual::Light::setSpecular

(

QColor

_specular

)

Set new specular color.

    {
      specular_ = _specular;
    }

void omni::visual::Light::setup

(

GLuint

_index = GL_LIGHT0

)

Setup light in OpenGL.

    {
      // light and material
      withCurrentContext([&](QOpenGLFunctions& _)
      {
        _.glEnable(GL_LIGHTING);
        _.glEnable(GL_COLOR_MATERIAL);
        glLightfv(_index, GL_DIFFUSE, colorParam(diffuse()).data());
        glLightfv(_index, GL_POSITION, eye4().data());
        glLightModelfv(GL_LIGHT_MODEL_AMBIENT, colorParam(ambient()).data());
        glShadeModel(GL_SMOOTH);
        _.glEnable(_index);
      });
    }

QColor omni::visual::Light::specular

(

)

const

Return specular color.

    {
      return specular_;
    }

void omni::visual::Light::toStream ( QDataStream &  _os ) const

virtual

Serialize to stream.

Reimplemented from omni::visual::Tracker.

                                               {
      Tracker::toStream(_os);
      _os << ambient_ << diffuse_ << specular_ << intensity_;
    }

Friends And Related Function Documentation

bool operator== ( Light const &  _lhs, Light const &  _rhs  )

friend

Test for equality. ScreenSetup is ignored.

                                                          {
      return
        OMNI_TEST_MEMBER_EQUAL(ambient_) &&
        OMNI_TEST_MEMBER_EQUAL(diffuse_) &&
        OMNI_TEST_MEMBER_EQUAL(specular_) &&
        OMNI_TEST_MEMBER_EQUAL(intensity_);
    }

Field Documentation

QColor omni::visual::Light::ambient_

private

QColor omni::visual::Light::diffuse_

private

qreal omni::visual::Light::intensity_

private

QColor omni::visual::Light::specular_

private

---

The documentation for this struct was generated from the following files:

• include/omni/visual/Light.h
• src/lib/visual/Light.cpp