KisNodeFacade Class Reference

#include <kis_node_facade.h>

Inheritance diagram for KisNodeFacade:

Public Member Functions
bool	addNode (KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis, KisNodeAdditionFlags flags=KisNodeAdditionFlag::None)
bool	addNode (KisNodeSP node, KisNodeSP parent, quint32 index, KisNodeAdditionFlags flags=KisNodeAdditionFlag::None)
bool	addNode (KisNodeSP node, KisNodeSP parent=KisNodeSP(), KisNodeAdditionFlags flags=KisNodeAdditionFlag::None)
	KisNodeFacade ()
	KisNodeFacade (KisNodeSP root)
bool	moveNode (KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis)
bool	moveNode (KisNodeSP node, KisNodeSP parent, quint32 index)
bool	removeNode (KisNodeSP node)
const KisNodeSP	root () const
void	setRoot (KisNodeSP root)
virtual	~KisNodeFacade ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Attributes
KisNodeWSP	root
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

KisNodeFacade is the public interface to adding and removing nodes.

Definition at line 11 of file kis_node_facade.cpp.

Constructor & Destructor Documentation

KisNodeFacade() [1/2]

KisNodeFacade::KisNodeFacade

(

)

Create a new, empty KisNodeFacade

Definition at line 17 of file kis_node_facade.cpp.

        : m_d(new Private())
{
}

KisNodeFacade() [2/2]

KisNodeFacade::KisNodeFacade

(

KisNodeSP

root

)

Create a new kisnodefacade for the given root.

Definition at line 22 of file kis_node_facade.cpp.

        : m_d(new Private())
{
    m_d->root = root;
}

References m_d, and root.

~KisNodeFacade()

KisNodeFacade::~KisNodeFacade ( )

virtual

Definition at line 28 of file kis_node_facade.cpp.

{
}

Member Function Documentation

addNode() [1/3]

bool KisNodeFacade::addNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		KisNodeSP	aboveThis,
		KisNodeAdditionFlags	flags = KisNodeAdditionFlag::None )

Add already existing node to the graph.

Parameters

node	the node to be added
parent	the parent node
aboveThis	in the list with child nodes of the specified parent, add this node above the specified sibling. if 0, the node is put in the lowermost position in its group. returns false if adding the node didn't work, true if the node got added

Definition at line 104 of file kis_node_facade.cpp.

{
    if (!node) return false;
    if (!parent) return false;
 
    return parent->add(node, aboveThis, flags);
}

addNode() [2/3]

bool KisNodeFacade::addNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		quint32	index,
		KisNodeAdditionFlags	flags = KisNodeAdditionFlag::None )

Adds the node as a child of the given parent at the specified index.

childCount() is a valid index and appends to the end. Fails and returns false if the node is already in this group or any other (remove it first.)

Definition at line 112 of file kis_node_facade.cpp.

{
    if (!node) return false;
    if (!parent) return false;
 
    if (index == parent->childCount())
        return parent->add(node, parent->lastChild(), flags);
    else if (index != 0)
        return parent->add(node, parent->at(index), flags);
    else
        return parent->add(node, 0, flags);
}

addNode() [3/3]

bool KisNodeFacade::addNode	(	KisNodeSP	node,
		KisNodeSP	parent = KisNodeSP(),
		KisNodeAdditionFlags	flags = KisNodeAdditionFlag::None )

Add an already existing node to the image. The node is put on top of the nodes in the specified node group. If parent is 0, then the root is used as parent.

Parameters

node	the node to be added
parent	the parent node

Definition at line 92 of file kis_node_facade.cpp.

{
    dbgImage << "Add node " << node << " to " << parent;
    if (!node) return false;
    if (!parent && !m_d->root) return false;
 
    if (parent)
        return parent->add(node, parent->lastChild(), flags);
    else
        return m_d->root->add(node, m_d->root->lastChild(), flags);
}

References dbgImage, KisNode::lastChild(), and m_d.

moveNode() [1/2]

bool KisNodeFacade::moveNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		KisNodeSP	aboveThis )

Move the given node to specified position. If the node already has a parent, it is removed from the parent's node list.

Definition at line 42 of file kis_node_facade.cpp.

{
    dbgImage << "moveNode " << node << " " << parent << " " << aboveThis;
    if (!node) {
        dbgImage << "cannot move null node"; return false;
    }
    if (!parent)  {
        dbgImage << "cannot move to null parent"; return false;
    }
    if (node == parent)  {
        dbgImage << "cannot move self inside self"; return false;
    }
    if (node == aboveThis)  {
        dbgImage << "cannot move self above self"; return false;
    }
    if (parent == aboveThis)  {
        dbgImage << "cannot move above parent"; return false;
    }
    if (!node->parent())  {
        dbgImage << "node does not have a parent"; return false;
    }
 
    if (aboveThis && aboveThis->parent() != parent)  {
        dbgImage << "above this parent is not the parent"; return false;
    }
 
    int newIndex = aboveThis ? parent->index(aboveThis) + 1 : 0;
    return moveNode(node, parent, newIndex);
}

References dbgImage, moveNode(), and KisNode::parent.

moveNode() [2/2]

bool KisNodeFacade::moveNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		quint32	index )

Move the given node at the specified index. If the node already has a parent, it is removed from the parent's node list.

childCount() is a valid index and appends to the end.

Definition at line 72 of file kis_node_facade.cpp.

{
    dbgImage << "moveNode " << node << " " << parent << " " << newIndex;
    int oldIndex = node->parent()->index(node);
 
    if (node->graphListener())
        node->graphListener()->aboutToMoveNode(node.data(), oldIndex, newIndex);
    KisNodeSP aboveThis = parent->at(newIndex - 1);
    if (aboveThis == node) return false;
    if (node->parent()) {
        if (!node->parent()->remove(node)) return false;
    }
    dbgImage << "moving node to " << newIndex;
    bool success = addNode(node, parent, aboveThis);
    if (node->graphListener())
        node->graphListener()->nodeHasBeenMoved(node.data(), oldIndex, newIndex);
    return success;
}

References KisNodeGraphListener::aboutToMoveNode(), addNode(), KisSharedPtr< T >::data(), dbgImage, KisNode::graphListener, KisNode::index(), KisNodeGraphListener::nodeHasBeenMoved(), KisNode::parent, and KisNode::remove().

removeNode()

bool KisNodeFacade::removeNode

(

KisNodeSP

node

)

Remove the specified node.

Returns

false if removing the node failed

Definition at line 125 of file kis_node_facade.cpp.

{
    if (!node) return false;
    if (!node->parent()) return false;
 
    return node->parent()->remove(node);
 
}

References KisNode::parent, and KisNode::remove().

root()

const KisNodeSP KisNodeFacade::root

(

)

const

Return the root node for the graph this facade managed

setRoot()

void KisNodeFacade::setRoot

(

KisNodeSP

root

)

Set the rootnode for this facade

Definition at line 32 of file kis_node_facade.cpp.

{
    m_d->root = root;
}

References m_d, and root.

Member Data Documentation

m_d

QScopedPointer<Private> KisNodeFacade::m_d

private

Definition at line 103 of file kis_node_facade.h.

root

const KisNodeSP KisNodeFacade::root

Definition at line 14 of file kis_node_facade.cpp.

---

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

• libs/image/kis_node_facade.cpp
• libs/image/kis_node_facade.h