forked from GafferHQ/gaffer
-
Notifications
You must be signed in to change notification settings - Fork 3
/
StandardNodeGadget.h
170 lines (135 loc) · 6.53 KB
/
StandardNodeGadget.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
//////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2011-2012, John Haddon. All rights reserved.
// Copyright (c) 2011-2013, Image Engine Design Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above
// copyright notice, this list of conditions and the following
// disclaimer.
//
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following
// disclaimer in the documentation and/or other materials provided with
// the distribution.
//
// * Neither the name of John Haddon nor the names of
// any other contributors to this software may be used to endorse or
// promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////
#ifndef GAFFERUI_STANDARDNODEGADGET_H
#define GAFFERUI_STANDARDNODEGADGET_H
#include "Gaffer/StringAlgo.h"
#include "GafferUI/NodeGadget.h"
#include "GafferUI/LinearContainer.h"
namespace GafferUI
{
/// The standard means of representing a Node in a GraphGadget.
/// Nodes are represented as rectangular boxes with the name displayed
/// centrally and the nodules arranged at the sides. Supports the following
/// Metadata entries :
///
/// - "nodeGadget:nodulePosition" : a plug entry with a value of
/// "left", "right", "top" or "bottom"
/// - "nodeGadget:minimumWidth" : a node entry with a float value
/// - "nodeGadget:horizontalNoduleSpacing" : a node entry with a float value
/// - "nodeGadget:verticalNoduleSpacing" : a node entry with a float value
/// - "nodeGadget:padding" : a node entry with a float value
class StandardNodeGadget : public NodeGadget
{
public :
IE_CORE_DECLARERUNTIMETYPEDEXTENSION( GafferUI::StandardNodeGadget, StandardNodeGadgetTypeId, NodeGadget );
enum Edge
{
TopEdge,
BottomEdge,
LeftEdge,
RightEdge,
FirstEdge = TopEdge,
LastEdge = RightEdge,
InvalidEdge
};
/// \todo Remove orientation parameter - Metadata can do everything it can do.
StandardNodeGadget( Gaffer::NodePtr node, LinearContainer::Orientation orientation=LinearContainer::X );
virtual ~StandardNodeGadget();
virtual Nodule *nodule( const Gaffer::Plug *plug );
virtual const Nodule *nodule( const Gaffer::Plug *plug ) const;
virtual Imath::V3f noduleTangent( const Nodule *nodule ) const;
/// The central content of the Gadget may be customised. By default
/// the contents is a simple NameGadget for the node, but any Gadget or
/// Container can be placed there instead.
void setContents( GadgetPtr contents );
Gadget *getContents();
const Gadget *getContents() const;
/// Additional Gadgets can be placed alongside the
/// Nodules at the end of each outside edge.
/// Initially these are SpacerGadgets, but they can
/// be replaced with anything.
void setEdgeGadget( Edge edge, GadgetPtr gadget );
Gadget *getEdgeGadget( Edge edge );
const Gadget *getEdgeGadget( Edge edge ) const;
void setLabelsVisibleOnHover( bool labelsVisible );
bool getLabelsVisibleOnHover() const;
virtual Imath::Box3f bound() const;
protected :
virtual void doRender( const Style *style ) const;
const Imath::Color3f *userColor() const;
private :
Edge plugEdge( const Gaffer::Plug *plug );
NodulePtr addNodule( Gaffer::PlugPtr plug );
LinearContainer *noduleContainer( Edge edge );
const LinearContainer *noduleContainer( Edge edge ) const;
IndividualContainer *contentsContainer();
const IndividualContainer *contentsContainer() const;
static NodeGadgetTypeDescription<StandardNodeGadget> g_nodeGadgetTypeDescription;
typedef std::map<const Gaffer::Plug *, Nodule *> NoduleMap;
NoduleMap m_nodules;
void childAdded( Gaffer::GraphComponent *parent, Gaffer::GraphComponent *child );
void childRemoved( Gaffer::GraphComponent *parent, Gaffer::GraphComponent *child );
void plugDirtied( const Gaffer::Plug *plug );
void enter( Gadget *gadget );
void leave( Gadget *gadget );
bool dragEnter( GadgetPtr gadget, const DragDropEvent &event );
bool dragMove( GadgetPtr gadget, const DragDropEvent &event );
bool dragLeave( GadgetPtr gadget, const DragDropEvent &event );
bool drop( GadgetPtr gadget, const DragDropEvent &event );
Nodule *closestCompatibleNodule( const DragDropEvent &event );
bool noduleIsCompatible( const Nodule *nodule, const DragDropEvent &event );
void plugMetadataChanged( IECore::TypeId nodeTypeId, const Gaffer::MatchPattern &plugPath, IECore::InternedString key );
void nodeMetadataChanged( IECore::TypeId nodeTypeId, IECore::InternedString key );
bool updateUserColor();
void updatePadding();
IE_CORE_FORWARDDECLARE( ErrorGadget );
ErrorGadget *errorGadget( bool createIfMissing = true );
void error( Gaffer::ConstPlugPtr plug, Gaffer::ConstPlugPtr source, const std::string &message );
void displayError( Gaffer::ConstPlugPtr plug, const std::string &message );
const LinearContainer::Orientation m_orientation;
bool m_nodeEnabled;
bool m_labelsVisibleOnHover;
// we accept drags from nodules and forward them to the
// closest compatible child nodule - m_dragDestinationProxy.
Nodule *m_dragDestinationProxy;
boost::optional<Imath::Color3f> m_userColor;
};
IE_CORE_DECLAREPTR( StandardNodeGadget )
typedef Gaffer::FilteredChildIterator<Gaffer::TypePredicate<StandardNodeGadget> > StandardNodeGadgetIterator;
typedef Gaffer::FilteredRecursiveChildIterator<Gaffer::TypePredicate<StandardNodeGadget> > RecursiveStandardNodeGadgetIterator;
} // namespace GafferUI
#endif // GAFFERUI_STANDARDNODEGADGET_H