IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
OffsetXYZ.h
1 // OffsetXYZ.h:
3 // ------------
4 //
14 
15 #ifndef __IPSDKBASEDATA_OFFSETXYZ_H__
16 #define __IPSDKBASEDATA_OFFSETXYZ_H__
17 
19 #include <IPSDKSerialization/Engine/BaseSerializationObject.h>
20 
21 namespace ipsdk {
22 
25 
27 {
28  // declare serial class
30 
31 public:
34  OffsetXYZ();
35  OffsetXYZ(const ipInt32 xOffset,
36  const ipInt32 yOffset,
37  const ipInt32 zOffset);
38  ~OffsetXYZ();
40 
41 // methods
42 public:
45  ipInt32 getXOffset() const;
46  ipInt32 getYOffset() const;
47  ipInt32 getZOffset() const;
49 
52  void setXOffset(const ipInt32 xOffset);
53  void setYOffset(const ipInt32 yOffset);
54  void setZOffset(const ipInt32 zOffset);
55  void setOffsets(const ipInt32 xOffset,
56  const ipInt32 yOffset,
57  const ipInt32 zOffset);
59 
60 // attributes
61 protected:
68 };
69 
72 
73 inline ipInt32
75 {
76  return _xOffset;
77 }
78 
79 inline ipInt32
81 {
82  return _yOffset;
83 }
84 
85 inline ipInt32
87 {
88  return _zOffset;
89 }
90 
91 inline void
93 {
94  _xOffset = xOffset;
95 }
96 
97 inline void
99 {
100  _yOffset = yOffset;
101 }
102 
103 inline void
105 {
106  _zOffset = zOffset;
107 }
108 
109 inline void
111  const ipInt32 yOffset,
112  const ipInt32 zOffset)
113 {
114  _xOffset = xOffset;
115  _yOffset = yOffset;
116  _zOffset = zOffset;
117 }
118 
121 
122 } // end of namespace ipsdk
123 
124 #endif // __IPSDKBASEDATA_OFFSETXYZ_H__
#define IPSDK_DECLARE_SERIAL_WITH_COPY(libraryName, className)
macro enabling serialization on class
Definition: SerializationHdrMacro.h:73
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22
void setZOffset(const ipInt32 zOffset)
set offsets associated to object
Definition: OffsetXYZ.h:104
Definition of import/export macro for library.
void setXOffset(const ipInt32 xOffset)
set offsets associated to object
Definition: OffsetXYZ.h:92
int32_t ipInt32
Base types definition.
Definition: BaseTypes.h:52
ipInt32 getXOffset() const
retrieve offsets associated to object
Definition: OffsetXYZ.h:74
ipInt32 _xOffset
offsets associated to object
Definition: OffsetXYZ.h:64
void setOffsets(const ipInt32 xOffset, const ipInt32 yOffset, const ipInt32 zOffset)
set offsets associated to object
Definition: OffsetXYZ.h:110
Class encapsulating a 3d offset along x, y and z axis.
Definition: OffsetXYZ.h:26
ipInt32 getZOffset() const
retrieve offsets associated to object
Definition: OffsetXYZ.h:86
ipInt32 _yOffset
offsets associated to object
Definition: OffsetXYZ.h:65
ipInt32 _zOffset
offsets associated to object
Definition: OffsetXYZ.h:66
ipInt32 getYOffset() const
retrieve offsets associated to object
Definition: OffsetXYZ.h:80
#define IPSDKBASEDATA_API
Import/Export macro for library IPSDKUtil.
Definition: IPSDKBaseDataExports.h:27
Base class for serializable class.
Definition: BaseSerializationObject.h:33
void setYOffset(const ipInt32 yOffset)
set offsets associated to object
Definition: OffsetXYZ.h:98