Channel Class Reference

#include <Channel.h>

Inheritance diagram for Channel:

Classes
struct	Private

Public Member Functions
QRect	bounds () const
	Channel (KisNodeSP node, KoChannelInfo *channel, QObject *parent=0)
int	channelSize () const
QString	name () const
bool	operator!= (const Channel &other) const
bool	operator== (const Channel &other) const
QByteArray	pixelData (const QRect &rect) const
int	position () const
void	setPixelData (QByteArray value, const QRect &rect)
	setPixelData writes the given data to the relevant channel in the Node. This is only possible for Nodes that have a paintDevice, so nothing will happen when trying to write to e.g. a group layer.
void	setVisible (bool value)
	setvisible set the visibility of the channel to the given value.
bool	visible () const
	visible checks whether this channel is visible in the node
	~Channel () override

Private Attributes
Private *const	d

Detailed Description

A Channel represents a single channel in a Node. Krita does not use channels to store local selections: these are strictly the color and alpha channels.

Definition at line 22 of file Channel.h.

Constructor & Destructor Documentation

Channel()

Channel::Channel ( KisNodeSP node, KoChannelInfo * channel, QObject * parent = 0 )

explicit

Definition at line 33 of file Channel.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->node = node;
    d->channel = channel;
}

References Channel::Private::channel, d, and Channel::Private::node.

~Channel()

Channel::~Channel ( )

override

Definition at line 41 of file Channel.cpp.

{
    delete d;
}

References d.

Member Function Documentation

bounds()

QRect Channel::bounds

(

)

const

Returns

the exact bounds of the channel. This can be smaller than the bounds of the Node this channel is part of.

Definition at line 115 of file Channel.cpp.

{
    if (!d->node || !d->channel) return QRect();
 
    QRect rect = d->node->exactBounds();
 
    KisPaintDeviceSP dev;
    if (d->node->colorSpace()->colorDepthId() == Integer8BitsColorDepthID) {
        dev = new KisPaintDevice(KoColorSpaceRegistry::instance()->alpha8());
    }
    else if (d->node->colorSpace()->colorDepthId() ==  Integer16BitsColorDepthID) {
        dev = new KisPaintDevice(KoColorSpaceRegistry::instance()->alpha16());
    }
#ifdef HAVE_OPENEXR
    else if (d->node->colorSpace()->colorDepthId() == Float16BitsColorDepthID) {
        dev = new KisPaintDevice(KoColorSpaceRegistry::instance()->alpha16f());
    }
#endif
    else if (d->node->colorSpace()->colorDepthId() == Float32BitsColorDepthID) {
        dev = new KisPaintDevice(KoColorSpaceRegistry::instance()->alpha32f());
    }
 
    KisSequentialConstIterator srcIt(d->node->projection(), rect);
    KisSequentialIterator dstIt(dev, rect);
 
    while(srcIt.nextPixel() && dstIt.nextPixel()) {
        const quint8 *srcPtr = srcIt.rawDataConst();
        memcpy(dstIt.rawData(), srcPtr + d->channel->pos(), d->channel->size());
 
    }
 
    if (dev) {
        return dev->exactBounds();
    }
 
    return QRect();
}

References Channel::Private::channel, KoColorSpace::colorDepthId(), KisBaseNode::colorSpace(), d, KisBaseNode::exactBounds(), KisPaintDevice::exactBounds(), Float16BitsColorDepthID, Float32BitsColorDepthID, KoColorSpaceRegistry::instance(), Integer16BitsColorDepthID, Integer8BitsColorDepthID, KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nextPixel(), Channel::Private::node, KoChannelInfo::pos(), KisBaseNode::projection(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawData(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawDataConst(), and KoChannelInfo::size().

channelSize()

int Channel::channelSize

(

)

const

Returns

the number of bytes this channel takes

Definition at line 110 of file Channel.cpp.

{
    return d->channel->size();
}

References Channel::Private::channel, d, and KoChannelInfo::size().

name()

QString Channel::name

(

)

const

Returns

the name of the channel

Definition at line 100 of file Channel.cpp.

{
    return d->channel->name();
}

References Channel::Private::channel, d, and KoChannelInfo::name().

operator!=()

bool Channel::operator!=

(

const Channel &

other

)

const

Definition at line 53 of file Channel.cpp.

{
    return !(operator==(other));
}

References operator==().

operator==()

bool Channel::operator==

(

const Channel &

other

)

const

Definition at line 47 of file Channel.cpp.

{
    return (d->node == other.d->node
            && d->channel == other.d->channel);
}

References Channel::Private::channel, d, and Channel::Private::node.

pixelData()

QByteArray Channel::pixelData

(

const QRect &

rect

)

const

Read the values of the channel into the a byte array for each pixel in the rect from the Node this channel is part of, and returns it.

Note that if Krita is built with OpenEXR and the Node has the 16 bits floating point channel depth type, Krita returns 32 bits float for every channel; the libkis scripting API does not support half.

Definition at line 153 of file Channel.cpp.

{
    QByteArray ba;
 
    if (!d->node || !d->channel) return ba;
 
    QDataStream stream(&ba, QIODevice::WriteOnly);
    KisSequentialConstIterator srcIt(d->node->projection(), rect);
 
    if (d->node->colorSpace()->colorDepthId() == Integer8BitsColorDepthID) {
        while(srcIt.nextPixel()) {
            quint8 v;
            memcpy(&v, srcIt.rawDataConst() + d->channel->pos(), sizeof(v));
            stream << v;
        }
    }
    else if (d->node->colorSpace()->colorDepthId() ==  Integer16BitsColorDepthID) {
        while(srcIt.nextPixel()) {
            quint16 v;
            memcpy(&v, srcIt.rawDataConst() + d->channel->pos(), sizeof(v));
            stream << v;
        }
    }
#ifdef HAVE_OPENEXR
    else if (d->node->colorSpace()->colorDepthId() == Float16BitsColorDepthID) {
        while(srcIt.nextPixel()) {
            half v;
            memcpy(&v, srcIt.rawDataConst() + d->channel->pos(), sizeof(v));
            stream << (float) v;
        }
    }
#endif
    else if (d->node->colorSpace()->colorDepthId() == Float32BitsColorDepthID) {
        while(srcIt.nextPixel()) {
            float v;
            memcpy(&v, srcIt.rawDataConst() + d->channel->pos(), sizeof(v));
            stream << v;
        }
 
    }
 
    return ba;
}

References Channel::Private::channel, KoColorSpace::colorDepthId(), KisBaseNode::colorSpace(), d, Float16BitsColorDepthID, Float32BitsColorDepthID, Integer16BitsColorDepthID, Integer8BitsColorDepthID, KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nextPixel(), Channel::Private::node, KoChannelInfo::pos(), KisBaseNode::projection(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawDataConst(), and v.

position()

int Channel::position

(

)

const

Returns

the position of the first byte of the channel in the pixel

Definition at line 105 of file Channel.cpp.

{
    return d->channel->pos();
}

References Channel::Private::channel, d, and KoChannelInfo::pos().

setPixelData()

void Channel::setPixelData	(	QByteArray	value,
		const QRect &	rect )

setPixelData writes the given data to the relevant channel in the Node. This is only possible for Nodes that have a paintDevice, so nothing will happen when trying to write to e.g. a group layer.

Note that if Krita is built with OpenEXR and the Node has the 16 bits floating point channel depth type, Krita expects to be given a 4 byte, 32 bits float for every channel; the libkis scripting API does not support half.

Parameters

value	a byte array with exactly enough bytes.
rect	the rectangle to write the bytes into

Definition at line 197 of file Channel.cpp.

{
    if (!d->node || !d->channel || d->node->paintDevice() == 0) return;
 
    QDataStream stream(&value, QIODevice::ReadOnly);
    KisSequentialIterator dstIt(d->node->paintDevice(), rect);
 
    if (d->node->colorSpace()->colorDepthId() == Integer8BitsColorDepthID) {
        while (dstIt.nextPixel()) {
            quint8 v;
            stream >> v;
            memcpy(dstIt.rawData() + d->channel->pos(), &v, sizeof(v));
        }
    }
    else if (d->node->colorSpace()->colorDepthId() ==  Integer16BitsColorDepthID) {
        while (dstIt.nextPixel()) {
            quint16 v;
            stream >> v;
            memcpy(dstIt.rawData() + d->channel->pos(), &v, sizeof(v));
        }
    }
#ifdef HAVE_OPENEXR
    else if (d->node->colorSpace()->colorDepthId() == Float16BitsColorDepthID) {
        while (dstIt.nextPixel()) {
            float f;
            stream >> f;
            half v = f;
            memcpy(dstIt.rawData() + d->channel->pos(), &v, sizeof(v));
        }
 
    }
#endif
    else if (d->node->colorSpace()->colorDepthId() == Float32BitsColorDepthID) {
        while (dstIt.nextPixel()) {
            float v;
            stream >> v;
            memcpy(dstIt.rawData() + d->channel->pos(), &v, sizeof(v));
        }
    }
}

References Channel::Private::channel, KoColorSpace::colorDepthId(), KisBaseNode::colorSpace(), d, Float16BitsColorDepthID, Float32BitsColorDepthID, Integer16BitsColorDepthID, Integer8BitsColorDepthID, KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nextPixel(), Channel::Private::node, KisBaseNode::paintDevice(), KoChannelInfo::pos(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawData(), v, and value().

setVisible()

void Channel::setVisible

(

bool

value

)

setvisible set the visibility of the channel to the given value.

Definition at line 77 of file Channel.cpp.

{
    if (!d->node || !d->channel) return;
    if (!d->node->inherits("KisLayer")) return;
 
    const QList<KoChannelInfo *> channelInfo = d->node->colorSpace()->channels();
 
    KisLayerSP layer = qobject_cast<KisLayer*>(d->node.data());
    QBitArray flags = layer->channelFlags();
    if (flags.isEmpty()) {
        flags.fill(1, channelInfo.size());
    }
 
    for (uint i = 0; i < channelInfo.size(); ++i) {
        if (channelInfo[i] == d->channel) {
            flags.setBit(i, value);
            layer->setChannelFlags(flags);
            break;
        }
    }
 
}

References Channel::Private::channel, KisLayer::channelFlags, KoColorSpace::channels, KisBaseNode::colorSpace(), d, KisSharedPtr< T >::data(), Channel::Private::node, KisLayer::setChannelFlags(), and value().

visible()

bool Channel::visible

(

)

const

visible checks whether this channel is visible in the node

Returns

the status of this channel

Definition at line 59 of file Channel.cpp.

{
    if (!d->node || !d->channel) return false;
    if (!d->node->inherits("KisLayer")) return false;
 
    const QList<KoChannelInfo *> channelInfo = d->node->colorSpace()->channels();
 
    for (uint i = 0; i < channelInfo.size(); ++i) {
        if (channelInfo[i] == d->channel) {
            KisLayerSP layer = qobject_cast<KisLayer*>(d->node.data());
            const QBitArray& flags = layer->channelFlags();
            return flags.isEmpty() || flags.testBit(i);
        }
    }
 
    return false;
}

References Channel::Private::channel, KisLayer::channelFlags, KoColorSpace::channels, KisBaseNode::colorSpace(), d, KisSharedPtr< T >::data(), and Channel::Private::node.

Member Data Documentation

d

Private* const Channel::d

private

Definition at line 87 of file Channel.h.

---

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

• libs/libkis/Channel.h
• libs/libkis/Channel.cpp