File: itkSpatialObjectProperty.h

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (175 lines) | stat: -rw-r--r-- 3,596 bytes parent folder | download
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
/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkSpatialObjectProperty_h
#define itkSpatialObjectProperty_h

#include <string>
#include <map>

#include "itkLightObject.h"
#include "itkRGBAPixel.h"
#include "itkTimeStamp.h"
#include "itkObjectFactory.h"

#include "ITKSpatialObjectsExport.h"

namespace itk
{
/**
 * This class contains the objects properties such as colors, opacity, etc...
 * it's templated over the representation to use for each color component.
 */

class ITKSpatialObjects_EXPORT SpatialObjectProperty
{
public:
  SpatialObjectProperty();

  virtual ~SpatialObjectProperty() = default;

  using Self = SpatialObjectProperty;

  using ColorType = RGBAPixel<double>;

  virtual void
  Clear();

  void
  SetColor(const ColorType & color)
  {
    m_Color = color;
  }

  ColorType &
  GetColor()
  {
    return m_Color;
  }

  const ColorType &
  GetColor() const
  {
    return m_Color;
  }

  void
  SetColor(double r, double g, double b);

  void
  SetRed(double r);
  double
  GetRed() const;

  void
  SetGreen(double g);
  double
  GetGreen() const;

  void
  SetBlue(double b);
  double
  GetBlue() const;

  void
  SetAlpha(double a);
  double
  GetAlpha() const;

  void
  SetName(const std::string & name)
  {
    m_Name = name;
  }

#if !defined(ITK_WRAPPING_PARSER)
  std::string &
  GetName()
  {
    return m_Name;
  }
#endif

  const std::string &
  GetName() const
  {
    return m_Name;
  }

  void
  SetTagScalarValue(const std::string & tag, double value);
  void
  SetTagStringValue(const std::string & tag, const std::string & value);

  bool
  GetTagScalarValue(const std::string & tag, double & value) const;
  double
  GetTagScalarValue(const std::string & tag) const
  {
    double value = 0;
    this->GetTagScalarValue(tag, value);
    return value;
  }


#if !defined(ITK_WRAPPING_PARSER)
  bool
  GetTagStringValue(const std::string & tag, std::string & value) const;
#endif
  std::string
  GetTagStringValue(const std::string & tag) const;


  std::map<std::string, double> &
  GetTagScalarDictionary();
  const std::map<std::string, double> &
  GetTagScalarDictionary() const;
  std::map<std::string, std::string> &
  GetTagStringDictionary();
  const std::map<std::string, std::string> &
  GetTagStringDictionary() const;

  void
  SetTagScalarDictionary(const std::map<std::string, double> & dict);
  void
  SetTagStringDictionary(const std::map<std::string, std::string> & dict);

  void
  Print(std::ostream & os) const
  {
    this->PrintSelf(os, 3);
  }

  Self &
  operator=(const SpatialObjectProperty & rhs);

protected:
  void
  PrintSelf(std::ostream & os, Indent indent) const;

private:
  ColorType m_Color{};

  std::string m_Name{};

  std::map<std::string, double>      m_ScalarDictionary{};
  std::map<std::string, std::string> m_StringDictionary{};
};

} // namespace itk

#endif // __SpatialObjectProperty_h