#include <phong_pixel_processor.h>

Public Member Functions
QVector< quint16 >	IlluminatePixel ()

QVector< quint16 >	IlluminatePixelFromHeightmap (quint32 posup, quint32 posdown, quint32 posleft, quint32 posright)

QVector< quint16 >	IlluminatePixelFromNormalmap (qreal r, qreal g, qreal b)

void	initialize (const KisPropertiesConfigurationSP config)

void	normalizeHeightmap ()

	PhongPixelProcessor (quint32 pixelArea, const KisPropertiesConfigurationSP config)

void	setLightVector (QVector3D light_vector)

	~PhongPixelProcessor ()

Public Attributes
bool	diffuseLightIsEnabled

Illuminant	fastLight

Illuminant	fastLight2

qreal	Ia
	Total ambient light.

qreal	Id
	Total diffuse light.

qreal	Is
	Total specular light.

qreal	Ka
	Ambient light coefficient.

qreal	Kd
	Diffuse light coefficient.

qreal	Ks
	Specular light coefficient.

QVector3D	light_vector

QList< Illuminant >	lightSources
	Light sources to use (those disabled in the GUI are not present here)

QVector3D	normal_vector

QVector< double >	realheightmap

QVector3D	reflection_vector

qreal	shiny_exp
	Shinyness exponent.

quint8	size
	Size of this stuff.

bool	specularLightIsEnabled

QVector3D	vision_vector

QVector3D	x_vector

QVector3D	y_vector

Private Attributes
quint32	m_pixelArea

Detailed Description

Definition at line 25 of file phong_pixel_processor.h.

Constructor & Destructor Documentation

◆ PhongPixelProcessor()

PhongPixelProcessor::PhongPixelProcessor	(	quint32	pixelArea,
		const KisPropertiesConfigurationSP	config )

Definition at line 12 of file phong_pixel_processor.cpp.

{
    m_pixelArea = pixelArea;
    initialize(config);
}

References initialize(), and m_pixelArea.

◆ ~PhongPixelProcessor()

PhongPixelProcessor::~PhongPixelProcessor ( )

Definition at line 83 of file phong_pixel_processor.cpp.

{
 
}

Member Function Documentation

◆ IlluminatePixel()

QVector< quint16 > PhongPixelProcessor::IlluminatePixel ( )

Definition at line 115 of file phong_pixel_processor.cpp.

{
    qreal temp;
    quint8 channel = 0;
    const quint8 totalChannels = 3; // The 4th is alpha and we'll fill it with a nice 0xFFFF
    qreal computation[] = {0, 0, 0};
    QVector<quint16> finalPixel(4, 0xFFFF);
 
    if (lightSources.size() == 0)
        return finalPixel;
 
    // PREPARE ALGORITHM HERE
 
    for (int i = 0; i < size; i++) {
        light_vector = lightSources.at(i).lightVector;
 
        for (channel = 0; channel < totalChannels; channel++) {
            Ia = lightSources.at(i).RGBvalue.at(channel) * Ka;
            computation[channel] += Ia;
        }
        if (diffuseLightIsEnabled) {
            temp = Kd * QVector3D::dotProduct(normal_vector, light_vector);
            for (channel = 0; channel < totalChannels; channel++) {
                Id = lightSources.at(i).RGBvalue.at(channel) * temp;
                if (Id < 0)     Id = 0;
                if (Id > 1)     Id = 1;
                computation[channel] += Id;
            }
        }
 
        if (specularLightIsEnabled) {
            reflection_vector = (2 * pow(QVector3D::dotProduct(normal_vector, light_vector), shiny_exp)) * normal_vector - light_vector;
            temp = Ks * QVector3D::dotProduct(vision_vector, reflection_vector);
            for (channel = 0; channel < totalChannels; channel++) {
                Is = lightSources.at(i).RGBvalue.at(channel) * temp;
                if (Is < 0)     Is = 0;
                if (Is > 1)     Is = 1;
                computation[channel] += Is;
            }
        }
    }
 
    for (channel = 0; channel < totalChannels; channel++) {
        if (computation[channel] > 1)
            computation[channel] = 1;
        if (computation[channel] < 0)
            computation[channel] = 0;
    }
 
    //RGBA actually uses the BGRA order of channels, hence the disorder
    finalPixel[2] = quint16(computation[0] * 0xFFFF);
    finalPixel[1] = quint16(computation[1] * 0xFFFF);
    finalPixel[0] = quint16(computation[2] * 0xFFFF);
 
    return finalPixel;
}

References diffuseLightIsEnabled, Ia, Id, Is, Ka, Kd, Ks, light_vector, lightSources, normal_vector, reflection_vector, shiny_exp, size, specularLightIsEnabled, and vision_vector.

◆ IlluminatePixelFromHeightmap()

QVector< quint16 > PhongPixelProcessor::IlluminatePixelFromHeightmap	(	quint32	posup,
		quint32	posdown,
		quint32	posleft,
		quint32	posright )

Definition at line 95 of file phong_pixel_processor.cpp.

{
    QVector<quint16> finalPixel(4, 0xFFFF);
 
    if (lightSources.size() == 0)
        return finalPixel;
 
    // Algorithm begins, Phong Illumination Model
    normal_vector.setX(- realheightmap[posright] + realheightmap[posleft]);
    normal_vector.setY(- realheightmap[posup] + realheightmap[posdown]);
    normal_vector.setZ(8);
    normal_vector.normalize();
 
    // PREPARE ALGORITHM HERE
 
    finalPixel = IlluminatePixel();
 
    return finalPixel;
}

References IlluminatePixel(), lightSources, normal_vector, and realheightmap.

◆ IlluminatePixelFromNormalmap()

QVector< quint16 > PhongPixelProcessor::IlluminatePixelFromNormalmap	(	qreal	r,
		qreal	g,
		qreal	b )

Definition at line 172 of file phong_pixel_processor.cpp.

{
    QVector<quint16> finalPixel(4, 0xFFFF);
 
    if (lightSources.size() == 0)
        return finalPixel;
 
    //  if ()
    // Algorithm begins, Phong Illumination Model
    normal_vector.setX(r*2-1.0);
    normal_vector.setY(-(g*2-1.0));
    normal_vector.setZ(b*2-1.0);
    //normal_vector.normalize();
 
    // PREPARE ALGORITHM HERE
 
    finalPixel = IlluminatePixel();
 
    return finalPixel;
}

References IlluminatePixel(), lightSources, and normal_vector.

◆ initialize()

void PhongPixelProcessor::initialize ( const KisPropertiesConfigurationSP config )

Definition at line 18 of file phong_pixel_processor.cpp.

{
    // Basic, fundamental
    normal_vector = QVector3D(0, 0, 1);
    vision_vector = QVector3D(0, 0, 1);
    x_vector = QVector3D(1, 0, 0);
    y_vector = QVector3D(0, 1, 0);
 
    // Mutable
    light_vector = QVector3D(0, 0, 0);
    reflection_vector = QVector3D(0, 0, 0);
 
    //setLightVector(QVector3D(-8, 8, 2));
 
    Illuminant light[PHONG_TOTAL_ILLUMINANTS];
    QVariant guiLight[PHONG_TOTAL_ILLUMINANTS];
 
    qint32 azimuth;
    qint32 inclination;
 
    for (int i = 0; i < PHONG_TOTAL_ILLUMINANTS; i++) {
        if (config->getBool(PHONG_ILLUMINANT_IS_ENABLED[i])) {
            if (config->getProperty(PHONG_ILLUMINANT_COLOR[i], guiLight[i])) {
                light[i].RGBvalue << guiLight[i].value<QColor>().redF();
                light[i].RGBvalue << guiLight[i].value<QColor>().greenF();
                light[i].RGBvalue << guiLight[i].value<QColor>().blueF();
 
                azimuth = config->getInt(PHONG_ILLUMINANT_AZIMUTH[i]) - 90;
                inclination = config->getInt(PHONG_ILLUMINANT_INCLINATION[i]);
 
                qreal m; //2D vector magnitude
                light[i].lightVector.setZ( sin( inclination * M_PI / 180 ) );
                m = cos( inclination * M_PI / 180);
 
                light[i].lightVector.setX( cos( azimuth * M_PI / 180 ) * m  );
                light[i].lightVector.setY( sin( azimuth * M_PI / 180 ) * m  );
                //Pay close attention to this, indexes will move in this line
                lightSources.append(light[i]);
            }
        }
    }
 
    size = lightSources.size();
 
    //Code that exists only to swiftly switch to the other algorithm (reallyFastIlluminatePixel) to test
    if (size > 0) {
        fastLight = light[0];
        fastLight2 = light[0];
    }
 
    //Ka, Kd and Ks must be between 0 and 1 or grave errors will happen
    Ka = config->getDouble(PHONG_AMBIENT_REFLECTIVITY);
    Kd = config->getDouble(PHONG_DIFFUSE_REFLECTIVITY);
    Ks = config->getDouble(PHONG_SPECULAR_REFLECTIVITY);
    shiny_exp = config->getInt(PHONG_SHINYNESS_EXPONENT);
 
    Ia = Id = Is = 0;
 
    diffuseLightIsEnabled = config->getBool(PHONG_DIFFUSE_REFLECTIVITY_IS_ENABLED);
    specularLightIsEnabled = config->getBool(PHONG_SPECULAR_REFLECTIVITY_IS_ENABLED);
 
    realheightmap = QVector<double>(m_pixelArea, 0);
}

References diffuseLightIsEnabled, fastLight, fastLight2, Ia, Id, Is, Ka, Kd, Ks, light_vector, lightSources, Illuminant::lightVector, M_PI, m_pixelArea, normal_vector, PHONG_AMBIENT_REFLECTIVITY, PHONG_DIFFUSE_REFLECTIVITY, PHONG_DIFFUSE_REFLECTIVITY_IS_ENABLED, PHONG_ILLUMINANT_AZIMUTH, PHONG_ILLUMINANT_COLOR, PHONG_ILLUMINANT_INCLINATION, PHONG_ILLUMINANT_IS_ENABLED, PHONG_SHINYNESS_EXPONENT, PHONG_SPECULAR_REFLECTIVITY, PHONG_SPECULAR_REFLECTIVITY_IS_ENABLED, PHONG_TOTAL_ILLUMINANTS, realheightmap, reflection_vector, Illuminant::RGBvalue, shiny_exp, size, specularLightIsEnabled, vision_vector, x_vector, and y_vector.

◆ normalizeHeightmap()

void PhongPixelProcessor::normalizeHeightmap ( )

◆ setLightVector()

void PhongPixelProcessor::setLightVector ( QVector3D light_vector )

Definition at line 89 of file phong_pixel_processor.cpp.

{
    lightVector.normalize();
    light_vector = lightVector;
}

References light_vector.

Member Data Documentation

◆ diffuseLightIsEnabled

bool PhongPixelProcessor::diffuseLightIsEnabled

Definition at line 80 of file phong_pixel_processor.h.

◆ fastLight

Illuminant PhongPixelProcessor::fastLight

Definition at line 77 of file phong_pixel_processor.h.

◆ fastLight2

Illuminant PhongPixelProcessor::fastLight2

Definition at line 78 of file phong_pixel_processor.h.

◆ Ia

qreal PhongPixelProcessor::Ia

Total ambient light.

Definition at line 57 of file phong_pixel_processor.h.

◆ Id

qreal PhongPixelProcessor::Id

Total diffuse light.

Definition at line 60 of file phong_pixel_processor.h.

◆ Is

qreal PhongPixelProcessor::Is

Total specular light.

Definition at line 63 of file phong_pixel_processor.h.

◆ Ka

qreal PhongPixelProcessor::Ka

Ambient light coefficient.

Definition at line 45 of file phong_pixel_processor.h.

◆ Kd

qreal PhongPixelProcessor::Kd

Diffuse light coefficient.

Definition at line 48 of file phong_pixel_processor.h.

◆ Ks

qreal PhongPixelProcessor::Ks

Specular light coefficient.

Definition at line 51 of file phong_pixel_processor.h.

◆ light_vector

QVector3D PhongPixelProcessor::light_vector

Definition at line 39 of file phong_pixel_processor.h.

◆ lightSources

QList<Illuminant> PhongPixelProcessor::lightSources

Light sources to use (those disabled in the GUI are not present here)

Definition at line 72 of file phong_pixel_processor.h.

◆ m_pixelArea

quint32 PhongPixelProcessor::m_pixelArea

private

Definition at line 84 of file phong_pixel_processor.h.

◆ normal_vector

QVector3D PhongPixelProcessor::normal_vector

Definition at line 36 of file phong_pixel_processor.h.

◆ realheightmap

QVector<double> PhongPixelProcessor::realheightmap

Definition at line 42 of file phong_pixel_processor.h.

◆ reflection_vector

QVector3D PhongPixelProcessor::reflection_vector

Definition at line 35 of file phong_pixel_processor.h.

◆ shiny_exp

qreal PhongPixelProcessor::shiny_exp

Shinyness exponent.

Definition at line 54 of file phong_pixel_processor.h.

◆ size

quint8 PhongPixelProcessor::size

Size of this stuff.

Definition at line 75 of file phong_pixel_processor.h.

◆ specularLightIsEnabled

bool PhongPixelProcessor::specularLightIsEnabled

Definition at line 81 of file phong_pixel_processor.h.

◆ vision_vector

QVector3D PhongPixelProcessor::vision_vector

Definition at line 40 of file phong_pixel_processor.h.

◆ x_vector

QVector3D PhongPixelProcessor::x_vector

Definition at line 37 of file phong_pixel_processor.h.

◆ y_vector

QVector3D PhongPixelProcessor::y_vector

Definition at line 38 of file phong_pixel_processor.h.

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

plugins/filters/phongbumpmap/phong_pixel_processor.h
plugins/filters/phongbumpmap/phong_pixel_processor.cpp

Public Member Functions

Public Attributes

Private Attributes