KisTimeSpan Class Reference

#include <kis_time_span.h>

Inheritance diagram for KisTimeSpan:

Public Member Functions
bool	contains (int time) const
int	duration () const
int	end () const
void	include (int time)
bool	isInfinite () const
bool	isValid () const
	KisTimeSpan ()
KisTimeSpan	operator& (const KisTimeSpan &rhs) const
const KisTimeSpan &	operator&= (const KisTimeSpan &rhs)
bool	operator== (const KisTimeSpan &rhs) const
KisTimeSpan	operator| (const KisTimeSpan &rhs) const
const KisTimeSpan &	operator|= (const KisTimeSpan &rhs)
bool	overlaps (const KisTimeSpan &other) const
int	start () const

Static Public Member Functions
static KisTimeSpan	calculateAffectedFramesRecursive (const KisNode *node, int time)
static KisTimeSpan	calculateIdenticalFramesRecursive (const KisNode *node, int time)
static KisTimeSpan	calculateNodeAffectedFrames (const KisNode *node, int time)
static KisTimeSpan	calculateNodeIdenticalFrames (const KisNode *node, int time)
static KisTimeSpan	fromTimeToTime (int start, int end)
static KisTimeSpan	fromTimeWithDuration (int start, int duration)
static KisTimeSpan	infinite (int start)

Private Member Functions
	KisTimeSpan (int start, int end)

Private Attributes
int	m_end
int	m_start

Detailed Description

Definition at line 19 of file kis_time_span.h.

Constructor & Destructor Documentation

KisTimeSpan() [1/2]

KisTimeSpan::KisTimeSpan ( int start, int end )

inlineprivate

Definition at line 22 of file kis_time_span.h.

        : m_start(start),
          m_end(end)
    {
    }

KisTimeSpan() [2/2]

KisTimeSpan::KisTimeSpan ( )

inline

Definition at line 29 of file kis_time_span.h.

        : m_start(0),
          m_end(-1)
    {
    }

Member Function Documentation

calculateAffectedFramesRecursive()

KisTimeSpan KisTimeSpan::calculateAffectedFramesRecursive ( const KisNode * node, int time )

static

Definition at line 40 of file kis_time_span.cpp.

{
    KisTimeSpan range;
 
    KisLayerUtils::recursiveApplyNodes(node,
        [&range, time] (const KisNode *node) {
            if (node->visible()) {
                range |= calculateNodeIdenticalFrames(node, time);
            }
    });
 
    return range;
}

References KisLayerUtils::recursiveApplyNodes(), and KisBaseNode::visible().

calculateIdenticalFramesRecursive()

KisTimeSpan KisTimeSpan::calculateIdenticalFramesRecursive ( const KisNode * node, int time )

static

Definition at line 26 of file kis_time_span.cpp.

{
    KisTimeSpan range = KisTimeSpan::infinite(0);
 
    KisLayerUtils::recursiveApplyNodes(node,
        [&range, time] (const KisNode *node) {
            if (node->visible()) {
                range &= calculateNodeIdenticalFrames(node, time);
            }
    });
 
    return range;
}

References infinite(), KisLayerUtils::recursiveApplyNodes(), and KisBaseNode::visible().

calculateNodeAffectedFrames()

KisTimeSpan KisTimeSpan::calculateNodeAffectedFrames ( const KisNode * node, int time )

static

Definition at line 69 of file kis_time_span.cpp.

{
    KisTimeSpan range;
 
    if (!node->visible()) return range;
 
    const QMap<QString, KisKeyframeChannel*> channels =
        node->keyframeChannels();
 
    // TODO: channels should report to the image which channel exactly has changed
    //       to avoid the dirty range to be stretched into infinity!
 
    if (channels.isEmpty() ||
        !channels.contains(KisKeyframeChannel::Raster.id())) {
        range = KisTimeSpan::infinite(0);
        return range;
    }
 
    Q_FOREACH (const KisKeyframeChannel *channel, channels) {
        // Union
        range |= channel->affectedFrames(time);
    }
 
    return range;
}

References KisKeyframeChannel::affectedFrames(), KoID::id(), infinite(), KisBaseNode::keyframeChannels, KisKeyframeChannel::Raster, and KisBaseNode::visible().

calculateNodeIdenticalFrames()

KisTimeSpan KisTimeSpan::calculateNodeIdenticalFrames ( const KisNode * node, int time )

static

Definition at line 54 of file kis_time_span.cpp.

{
    KisTimeSpan range = KisTimeSpan::infinite(0);
 
    const QMap<QString, KisKeyframeChannel*> channels =
        node->keyframeChannels();
 
    Q_FOREACH (const KisKeyframeChannel *channel, channels) {
        // Intersection
        range &= channel->identicalFrames(time);
    }
 
    return range;
}

References KisKeyframeChannel::identicalFrames(), infinite(), and KisBaseNode::keyframeChannels.

contains()

bool KisTimeSpan::contains ( int time ) const

inline

Definition at line 55 of file kis_time_span.h.

                                         {
        if (m_end == std::numeric_limits<int>::min()) {
            return m_start <= time;
        }
 
        return m_start <= time && time <= m_end;
    }

duration()

int KisTimeSpan::duration ( ) const

inline

Definition at line 43 of file kis_time_span.h.

                                {
        return m_end >= m_start ? m_end - m_start + 1 : 0;
    }

end()

int KisTimeSpan::end ( ) const

inline

Definition at line 39 of file kis_time_span.h.

                           {
        return m_end;
    }

fromTimeToTime()

static KisTimeSpan KisTimeSpan::fromTimeToTime ( int start, int end )

inlinestatic

Definition at line 88 of file kis_time_span.h.

                                                                 {
        return KisTimeSpan(start, end);
    }

fromTimeWithDuration()

static KisTimeSpan KisTimeSpan::fromTimeWithDuration ( int start, int duration )

inlinestatic

Definition at line 92 of file kis_time_span.h.

                                                                            {
        return KisTimeSpan( start, start + duration - 1);
    }

include()

void KisTimeSpan::include ( int time )

inline

Definition at line 63 of file kis_time_span.h.

                                  {
        m_start = qMin(time, m_start);
        m_end = qMax(time, m_end);
    }

infinite()

static KisTimeSpan KisTimeSpan::infinite ( int start )

inlinestatic

Definition at line 96 of file kis_time_span.h.

                                                  {
        return KisTimeSpan(start, std::numeric_limits<int>::min());
    }

isInfinite()

bool KisTimeSpan::isInfinite ( ) const

inline

Definition at line 47 of file kis_time_span.h.

                                   {
        return m_end == std::numeric_limits<int>::min();
    }

isValid()

bool KisTimeSpan::isValid ( ) const

inline

Definition at line 51 of file kis_time_span.h.

                                {
        return (m_end >= m_start) || (m_end == std::numeric_limits<int>::min() && m_start >= 0);
    }

operator&()

KisTimeSpan KisTimeSpan::operator& ( const KisTimeSpan & rhs ) const

inline

Definition at line 137 of file kis_time_span.h.

                                                        {
         KisTimeSpan result = *this;
 
        if (!isValid()) {
            return result;
        } else if (!rhs.isValid()) {
            result.m_start = rhs.start();
            result.m_end = rhs.m_end;
            return result;
        } else {
            result.m_start = std::max(result.m_start, rhs.start());
        }
 
        if (isInfinite()) {
            result.m_end = rhs.m_end;
        } else if (!rhs.isInfinite()) {
            result.m_end = std::min(result.m_end, rhs.m_end);
        }
 
        return result;
    }

References isInfinite(), isValid(), m_end, m_start, and start().

operator&=()

const KisTimeSpan & KisTimeSpan::operator&= ( const KisTimeSpan & rhs )

inline

Definition at line 159 of file kis_time_span.h.

                                                          {
        KisTimeSpan result = (*this & rhs);
        this->m_start = result.m_start;
        this->m_end = result.m_end;
        return *this;
    }

References m_end, and m_start.

operator==()

bool KisTimeSpan::operator== ( const KisTimeSpan & rhs ) const

inline

Definition at line 106 of file kis_time_span.h.

                                                  {
        return rhs.m_start == m_start && rhs.m_end == m_end;
    }

References m_end, and m_start.

operator|()

KisTimeSpan KisTimeSpan::operator| ( const KisTimeSpan & rhs ) const

inline

Definition at line 110 of file kis_time_span.h.

                                                        {
        KisTimeSpan result = *this;
 
        if (!result.isValid()) {
            result.m_start = rhs.start();
        } else if (rhs.isValid()) {
            result.m_start = std::min(result.m_start, rhs.start());
        }
 
        if (rhs.isInfinite() || result.isInfinite()) {
            result.m_end = std::numeric_limits<int>::min();
        } else if (!isValid()) {
            result.m_end = rhs.m_end;
        } else {
            result.m_end = std::max(m_end, rhs.m_end);
        }
 
        return result;
    }

References isInfinite(), isValid(), m_end, m_start, and start().

operator|=()

const KisTimeSpan & KisTimeSpan::operator|= ( const KisTimeSpan & rhs )

inline

Definition at line 130 of file kis_time_span.h.

                                                          {
        KisTimeSpan result = (*this | rhs);
        this->m_start = result.m_start;
        this->m_end = result.m_end;
        return *this;
    }

References m_end, and m_start.

overlaps()

bool KisTimeSpan::overlaps ( const KisTimeSpan & other ) const

inline

Definition at line 68 of file kis_time_span.h.

                                                         {
        // If either are "invalid", we should probably return false.
        if (!isValid() || !other.isValid()) {
            return false;
        }
 
        // Handle infinite cases...
        if (other.isInfinite()) {
            return (other.contains(start()) || other.contains(end()));
        } else if (isInfinite()) {
            return (contains(other.start()) || contains(other.end()));
        }
 
        const int selfMin = qMin(start(), end());
        const int selfMax = qMax(start(), end());
        const int otherMin = qMin(other.start(), other.end());
        const int otherMax = qMax(other.start(), other.end());
        return (selfMax >= otherMin) && (selfMin <= otherMax );
    }

References contains(), end(), isInfinite(), isValid(), and start().

start()

int KisTimeSpan::start ( ) const

inline

Definition at line 35 of file kis_time_span.h.

                             {
        return m_start;
    }

Member Data Documentation

m_end

int KisTimeSpan::m_end

private

Definition at line 168 of file kis_time_span.h.

m_start

int KisTimeSpan::m_start

private

Definition at line 167 of file kis_time_span.h.

---

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

• libs/image/kis_time_span.h
• libs/image/kis_time_span.cpp