StoryboardView Class Reference

#include <StoryboardView.h>

Inheritance diagram for StoryboardView:

Public Member Functions
bool	commentIsVisible () const
QModelIndex	indexAt (const QPoint &point) const override
Qt::Orientation	itemOrientation ()
	whether Comments are below or on the right of Thumbnail
void	mouseReleaseEvent (QMouseEvent *event) override
void	paintEvent (QPaintEvent *event) override
void	setCommentVisibility (bool value)
	Sets the visibility of comments.
void	setCurrentItem (int frame)
	changes the currentIndex and selectedIndex to frame
void	setItemOrientation (Qt::Orientation orientation)
void	setThumbnailVisibility (bool value)
	Sets the visibility of thumbnails.
QSize	sizeHint () const override
	StoryboardView (QWidget *parent=0)
bool	thumbnailIsVisible () const
QRect	visualRect (const QModelIndex &index) const override
	~StoryboardView () override

Private Slots
void	slotContextMenuRequested (const QPoint &)
void	slotItemClicked (const QModelIndex &clicked)

Private Attributes
bool	m_commentIsVisible
Qt::Orientation	m_itemOrientation
bool	m_thumbnailIsVisible

Detailed Description

This view draws the children of every index in the first column of the model inside the parent index

Definition at line 23 of file StoryboardView.h.

Constructor & Destructor Documentation

StoryboardView()

StoryboardView::StoryboardView ( QWidget * parent = 0 )

explicit

This view draws the children of every index in the first column of the model inside the parent

Definition at line 67 of file StoryboardView.cpp.

    : QListView(parent)
    , m_itemOrientation(Qt::Vertical)
    , m_commentIsVisible(true)
    , m_thumbnailIsVisible(true)
{
    setSelectionBehavior(SelectRows);
    setDefaultDropAction(Qt::MoveAction);
    setResizeMode(QListView::Adjust);
    setUniformItemSizes(true);
    setVerticalScrollMode(QAbstractItemView::ScrollPerPixel);
    setHorizontalScrollMode(QAbstractItemView::ScrollPerPixel);
    QWidget::setMouseTracking(true);
    setContextMenuPolicy(Qt::CustomContextMenu);
    setDragEnabled(true);
    viewport()->setAcceptDrops(true);
    setDropIndicatorShown(true);
    setDragDropMode(QAbstractItemView::InternalMove);
 
    QStyle *newStyle = QStyleFactory::create(this->style()->objectName());
    // proxy style steals the ownership of the style and deletes it later
    StoryboardStyle *proxyStyle = new StoryboardStyle(newStyle);
    proxyStyle->setParent(this);
    setStyle(proxyStyle);
 
    connect(this, SIGNAL(customContextMenuRequested(const QPoint &)),
                this, SLOT(slotContextMenuRequested(const QPoint &)));
 
    connect(this, &StoryboardView::clicked,
            this, &StoryboardView::slotItemClicked);
}

References connect(), slotContextMenuRequested(), and slotItemClicked().

~StoryboardView()

StoryboardView::~StoryboardView ( )

override

Definition at line 99 of file StoryboardView.cpp.

{}

Member Function Documentation

commentIsVisible()

bool StoryboardView::commentIsVisible

(

)

const

Returns

True if comments are visible, otherwise False.

Definition at line 260 of file StoryboardView.cpp.

{
    return m_commentIsVisible;
}

References m_commentIsVisible.

indexAt()

QModelIndex StoryboardView::indexAt ( const QPoint & point ) const

override

Definition at line 234 of file StoryboardView.cpp.

{
    QModelIndex index = QListView::indexAt(point);
    if (index.isValid()) {
        //look for the index in children of the current index
        int numChild = model()->rowCount(index);
        for (int row = 0; row < numChild; row++) {
            QRect childRect = visualRect(model()->index(row, 0, index));
            if (childRect.contains(point)) {
                return model()->index(row, 0, index);
            }
        }
    }
    return index;
}

References visualRect().

itemOrientation()

Qt::Orientation StoryboardView::itemOrientation

(

)

whether Comments are below or on the right of Thumbnail

Returns

The orientation of each Storyboard Item

Definition at line 255 of file StoryboardView.cpp.

{
    return m_itemOrientation;
}

References m_itemOrientation.

mouseReleaseEvent()

void StoryboardView::mouseReleaseEvent ( QMouseEvent * event )

override

Definition at line 337 of file StoryboardView.cpp.

                                                         {
    QModelIndex index = indexAt(event->pos());
 
    // To prevent selection changes from occurring when hitting the "plus" button,
    // we want to filter out these inputs before passing it up to QListView / QAbstractItemView
    if (index.isValid() && index.parent().isValid() && index.row() == StoryboardItem::FrameNumber) {
        StoryboardDelegate* sbDelegate = dynamic_cast<StoryboardDelegate*>(itemDelegate(index));
        QRect itemRect = visualRect(index);
        if (sbDelegate && sbDelegate->isOverlappingActionIcons(itemRect, event)) {
            return;
        }
    }
 
    QListView::mouseReleaseEvent(event);
}

References StoryboardItem::FrameNumber, indexAt(), StoryboardDelegate::isOverlappingActionIcons(), and visualRect().

paintEvent()

void StoryboardView::paintEvent ( QPaintEvent * event )

override

Definition at line 102 of file StoryboardView.cpp.

{
    event->accept();
    QListView::paintEvent(event);
 
    //ask delegate to draw the child nodes too
    QPainter painter(viewport());
    int itemNum = model()->rowCount();
    for (int row = 0; row < itemNum; row++) {
        QModelIndex index = model()->index(row, 0);
        int childNum = model()->rowCount(index);
        for (int childRow = 0; childRow < childNum; childRow++) {
 
            QModelIndex childIndex = model()->index(childRow, 0, index);
 
            QStyleOptionViewItem option;
            if (selectionModel()->isSelected(childIndex)) {
                option.state |= QStyle::State_Selected;
            }
            if (childIndex == selectionModel()->currentIndex()) {
                option.state |= QStyle::State_HasFocus;
            }
            option.font = font();
            option.fontMetrics = fontMetrics();
            option.rect = visualRect(childIndex);
            itemDelegate()->paint(&painter, option, childIndex);
        }
    }
}

References visualRect().

setCommentVisibility()

void StoryboardView::setCommentVisibility

(

bool

value

)

Sets the visibility of comments.

Parameters

value

The new visibility value

Definition at line 270 of file StoryboardView.cpp.

{
    m_commentIsVisible = value;
}

References m_commentIsVisible, and value().

setCurrentItem()

void StoryboardView::setCurrentItem

(

int

frame

)

changes the currentIndex and selectedIndex to frame

Parameters

frame

The new current frame

Definition at line 324 of file StoryboardView.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(model());
    const StoryboardModel* sbModel = dynamic_cast<const StoryboardModel*>(model());
    KIS_SAFE_ASSERT_RECOVER_RETURN(sbModel);
    QModelIndex index = sbModel->indexFromFrame(frame);
    if (index.isValid()) {
        selectionModel()->select(index, QItemSelectionModel::ClearAndSelect);
        selectionModel()->setCurrentIndex(index, QItemSelectionModel::ClearAndSelect);
        scrollTo(index);
    }
}

References StoryboardModel::indexFromFrame(), and KIS_SAFE_ASSERT_RECOVER_RETURN.

setItemOrientation()

void StoryboardView::setItemOrientation

(

Qt::Orientation

orientation

)

Definition at line 250 of file StoryboardView.cpp.

{
    m_itemOrientation = orientation;
}

References m_itemOrientation.

setThumbnailVisibility()

void StoryboardView::setThumbnailVisibility

(

bool

value

)

Sets the visibility of thumbnails.

Parameters

value

The new visibility value

Definition at line 275 of file StoryboardView.cpp.

{
    m_thumbnailIsVisible = value;
}

References m_thumbnailIsVisible, and value().

sizeHint()

QSize StoryboardView::sizeHint ( ) const

override

Definition at line 353 of file StoryboardView.cpp.

                                     {
    if (model()) {
        StoryboardModel* m_storyboardModel = static_cast<StoryboardModel*>(model());
        const bool hasContent = m_storyboardModel->hasIndex(0,0);
        if (hasContent) {
            const bool hasComments = m_storyboardModel->visibleCommentCount() > 0;
            const bool hasMoreThanOneComment = m_storyboardModel->visibleCommentCount() > 1;
            const float commentPadding = hasComments ? 1.0f + (0.1f * hasMoreThanOneComment) : 0.0f;
            const int thumbnailWidth = 286;
            const int commentWidth = 200 * commentPadding;
            return QSize(thumbnailWidth + commentWidth, 128);
        }
    }
 
    return QSize(250, 128);
}

References StoryboardModel::visibleCommentCount().

slotContextMenuRequested

void StoryboardView::slotContextMenuRequested ( const QPoint & point )

privateslot

Definition at line 280 of file StoryboardView.cpp.

{
    StoryboardModel* pModel = dynamic_cast<StoryboardModel*>(model());
    QMenu contextMenu;
    QModelIndex index = indexAt(point);
    if (!index.isValid()) {
        contextMenu.addAction(i18nc("Add new scene as the last storyboard", "Add Scene"), [index, pModel] {pModel->insertItem(index, false); });
    }
    else if (index.parent().isValid()) {
        index = index.parent();
    }
 
    if (index.isValid()) {
        contextMenu.addAction(i18nc("Add scene after active scene", "Add Scene After"), [index, pModel] {pModel->insertItem(index, true); });
        if (index.row() > 0) {
            contextMenu.addAction(i18nc("Add scene before active scene", "Add Scene Before"), [index, pModel] {pModel->insertItem(index, false); });
        }
 
        contextMenu.addAction(i18nc("Duplicate current scene from storyboard docker", "Duplicate Scene"), [index, pModel] {
           int row = index.row();
           KisDuplicateStoryboardCommand *command = new KisDuplicateStoryboardCommand(row, pModel);
           command->redo();
           pModel->pushUndoCommand(command);
        });
 
        contextMenu.addAction(i18nc("Remove current scene from storyboards", "Remove Scene"), [index, pModel] {
            int row = index.row();
            KisRemoveStoryboardCommand *command = new KisRemoveStoryboardCommand(row, pModel->getData().at(row), pModel);
            pModel->removeItem(index, command);
            pModel->pushUndoCommand(command);
        });
    }
    contextMenu.exec(viewport()->mapToGlobal(point));
}

References StoryboardModel::getData(), indexAt(), StoryboardModel::insertItem(), StoryboardModel::pushUndoCommand(), KisDuplicateStoryboardCommand::redo(), and StoryboardModel::removeItem().

slotItemClicked

void StoryboardView::slotItemClicked ( const QModelIndex & clicked )

privateslot

Definition at line 315 of file StoryboardView.cpp.

{
    StoryboardModel* sbModel = dynamic_cast<StoryboardModel*>(model());
 
    if(sbModel) {
        sbModel->visualizeScene(clicked.parent().isValid() ? clicked.parent() : clicked);
    }
}

References StoryboardModel::visualizeScene().

thumbnailIsVisible()

bool StoryboardView::thumbnailIsVisible

(

)

const

Returns

True if thumbnails are visible, otherwise False.

Definition at line 265 of file StoryboardView.cpp.

{
    return m_thumbnailIsVisible;
}

References m_thumbnailIsVisible.

visualRect()

QRect StoryboardView::visualRect ( const QModelIndex & index ) const

override

Definition at line 132 of file StoryboardView.cpp.

{
    /*
     *    fw = fontWidth
     * 
     *  (3*fw+2),        (5*fw+10)  _____ (4*fw+10)
     *    |                |       /
     *    |                |      /
     *   ,_________________________,
     *   |__|_____________|____|___|  ---------->(fontHeight)
     *   |                         |
     *   |                         |
     *   |                         |
     *   |                         |
     *   |_________________________|
     */
 
    if (!index.isValid() || !index.parent().isValid()) {
        return QListView::visualRect(index);
    }
    else {
        QRect parentRect = visualRect(index.parent());
        parentRect.setTopLeft(parentRect.topLeft() + QPoint(5, 5));
        parentRect.setBottomRight(parentRect.bottomRight() - QPoint(5, 5));
        int fontHeight = fontMetrics().height() + 3;
        int numericFontWidth = fontMetrics().horizontalAdvance("0");
 
        int parentWidth = parentRect.width();
        int childRow = index.row();
 
        int thumbnailWidth = parentWidth;
        if (m_itemOrientation == Qt::Horizontal) {
            thumbnailWidth = 250;
        }
        switch (childRow)
        {
            case StoryboardItem::FrameNumber:
            {   
                //the frame thumbnail rect
                if (!thumbnailIsVisible()) {
                    parentRect.setSize(QSize(3*numericFontWidth + 2, fontHeight));
                    return parentRect;
                }
 
                parentRect.setSize(QSize(thumbnailWidth, 120));
                parentRect.translate(0, fontHeight);
                return parentRect;
            }
            case StoryboardItem::ItemName:
            {
                QRect itemNameRect = parentRect;
                itemNameRect.setSize(QSize(thumbnailWidth - (12 * numericFontWidth + 22), fontHeight));
                itemNameRect.moveLeft(parentRect.left() + 3*numericFontWidth + 2);
                return itemNameRect;
            }
            case StoryboardItem::DurationSecond:
            {
                QRect secondRect = parentRect;
                secondRect.setSize(QSize(5 * numericFontWidth + 10, fontHeight));
                secondRect.moveLeft(parentRect.left() + thumbnailWidth - 9*numericFontWidth  -20);
                return secondRect;
            }
            case StoryboardItem::DurationFrame:
            {
                QRect frameRect = parentRect;
                frameRect.setSize(QSize(4 * numericFontWidth + 10, fontHeight));
                frameRect.moveLeft(parentRect.left() + thumbnailWidth - 4*numericFontWidth  - 10);
                return frameRect;
            }
            default:
            {
                //comment rect
                if (!commentIsVisible()) {
                    return QRect();
                }
 
                int thumbnailheight = thumbnailIsVisible() ? 120 : 0;
                if (m_itemOrientation == Qt::Vertical) {
                    const StoryboardModel* Model = dynamic_cast<const StoryboardModel*>(model());
                    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(Model, QRect());
                    parentRect.setTop(parentRect.top() + thumbnailheight + fontHeight + Model->visibleCommentsUpto(index) * 100);
                    parentRect.setHeight(100);
                    return parentRect;
                }
                else {
                    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(model(), QRect());
                    const StoryboardModel* storyboardModel = dynamic_cast<const StoryboardModel*>(model());
                    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(storyboardModel, QRect());
                    int numVisibleComments = storyboardModel->visibleCommentCount();
                    int commentWidth = 200;
                    if (numVisibleComments) {
                        commentWidth = qMax(200, (viewport()->width() - 250) / numVisibleComments);
                    }
                    parentRect.setSize(QSize(commentWidth, thumbnailheight + fontHeight));
                    parentRect.moveLeft(parentRect.left() + thumbnailWidth + storyboardModel->visibleCommentsUpto(index) * commentWidth);
                    return parentRect;
                }
            }
        }
    }
}

References commentIsVisible(), StoryboardItem::DurationFrame, StoryboardItem::DurationSecond, StoryboardItem::FrameNumber, StoryboardItem::ItemName, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_itemOrientation, thumbnailIsVisible(), StoryboardModel::visibleCommentCount(), StoryboardModel::visibleCommentsUpto(), and visualRect().

Member Data Documentation

m_commentIsVisible

bool StoryboardView::m_commentIsVisible

private

Definition at line 81 of file StoryboardView.h.

m_itemOrientation

Qt::Orientation StoryboardView::m_itemOrientation

private

Definition at line 80 of file StoryboardView.h.

m_thumbnailIsVisible

bool StoryboardView::m_thumbnailIsVisible

private

Definition at line 82 of file StoryboardView.h.

---

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

• plugins/dockers/storyboarddocker/StoryboardView.h
• plugins/dockers/storyboarddocker/StoryboardView.cpp