summaryrefslogtreecommitdiff
path: root/tikzit/src/common/Node.h
blob: 1e580ce3db67ceb489b9dcab69e7c4576f553824 (plain)
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
171
172
173
174
175
176
177
178
179
180
181
//
//  Node.h
//  TikZiT
//  
//  Copyright 2010 Aleks Kissinger. All rights reserved.
//  
//  
//  This file is part of TikZiT.
//  
//  TikZiT is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//  
//  TikZiT is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//  
//  You should have received a copy of the GNU General Public License
//  along with TikZiT.  If not, see <http://www.gnu.org/licenses/>.
//  


// Node : store the data associated with a node.

#import <Foundation/Foundation.h>

#import "NodeStyle.h"
#import "GraphElementData.h"

@class GraphElementProperty;
@class Shape;
@class Transformer;

/*!
 @class Node
 @brief A graph node, with associated location and style data.
 */
@interface Node : NSObject<NSCopying> {
	NSPoint point;
	NodeStyle *style;
	NSString *name;
	NSString *label;
	GraphElementData *data;
}

/*!
 @property   shape
 @brief      The shape to use
 @detail     This is a convenience property that resolves the shape name
             from the style, and uses a circle if there is no style.

			 This property is NOT KVO-compliant
 */
@property (readonly) Shape *shape;

/*!
 @property   point
 @brief      The point where this node is located.
 */
@property (assign) NSPoint point;

/*!
 @property   style
 @brief      The style of this node.
 */
@property (retain) NodeStyle *style;

/*!
 @property   name
 @brief      The name of this node. This is a temporary name and may change between
             successive TikZ outputs.
 */
@property (copy) NSString *name;

/*!
 @property   label
 @brief      The latex label that appears on this node.
 */
@property (copy) NSString *label;

/*!
 @property   data
 @brief      Associated extra data.
 */
@property (copy) GraphElementData *data;

// KVC methods
- (void) insertObject:(GraphElementProperty*)gep
		inDataAtIndex:(NSUInteger)index;
- (void) removeObjectFromDataAtIndex:(NSUInteger)index;
- (void) replaceObjectInDataAtIndex:(NSUInteger)index
						 withObject:(GraphElementProperty*)gep;

/*!
 @brief      Initialize a new node with the given point.
 @param      p a point.
 @result     A node.
 */
- (id)initWithPoint:(NSPoint)p;

/*!
 @brief      Initialize a new node at (0,0).
 @result     A node.
 */
- (id)init;

/*!
 @brief    Composes the shape transformer with another transformer
 @param t  The transform to apply before the shape transform
 @result   A transformer that first maps according to t, then according
           to -shapeTransformer.
 */
- (Transformer*) shapeTransformerFromTransformer:(Transformer*)t;

/*!
 @brief    A transformer that may be used to convert the shape to the
           right position and scale
 */
- (Transformer*) shapeTransformer;

/*!
 @brief             The bounding rect in the given co-ordinate system
 @detail            This is the bounding rect of the shape (after being
                    suitably translated and scaled).  The label is not
					considered.
 @param shapeTrans  The mapping from graph co-ordinates to the required
                    co-ordinates
 @result            The bounding rectangle
 */
- (NSRect) boundsUsingShapeTransform:(Transformer*)shapeTrans;

/*!
 @brief    The bounding rect in graph co-ordinates
 @detail   This is the bounding rect of the shape (after being suitably
           translated and scaled).  The label is not considered.
 */
- (NSRect) boundingRect;

/*!
 @brief      Try to attach a style of the correct name from the given style list.
 @param      styles an array of styles.
 @result     YES if successfully attached, NO otherwise.
 */
- (BOOL)attachStyleFromTable:(NSArray*)styles;

/*!
 @brief      Set node properties from <tt>GraphElementData</tt>.
 */
- (void)updateData;

/*!
 @brief      Set properties of this node to match the given node.
 @param      nd a node to mimic.
 */
- (void)setPropertiesFromNode:(Node *)nd;

/*!
 @brief      Compare a node to another node using a lex ordering on coordinates.
 @param      nd another node.
 @result     A comparison result.
 */
- (NSComparisonResult)compareTo:(id)nd;

/*!
 @brief      Factory method to construct a node with the given point.
 @param      p a point.
 @result     A node.
 */
+ (Node*)nodeWithPoint:(NSPoint)p;

/*!
 @brief      Factory method to construct a node at (0,0).
 @result     A node.
 */
+ (Node*)node;

@end

// vi:ft=objc:noet:ts=4:sts=4:sw=4