Gocator API

GoExtParam.h
1 ///@cond private
2
3 /**
4 * @file GoExtParam.h
5 * @brief Declares the GoExtParam class.
6 *
7 * @internal
8 * Copyright (C) 2016-2020 by LMI Technologies Inc.
9 * Licensed under the MIT License.
10 * Redistributed files must retain the above copyright notice.
11 */
12 #ifndef GO_EXT_VALUE_H
13 #define GO_EXT_VALUE_H
14
15 #include <GoSdk/GoSdkDef.h>
16 #include <GoSdk/Tools/GoProfileToolUtils.h>
17 #include <GoSdk/Tools/GoSurfaceToolUtils.h>
18 #include <kApi/Data/kXml.h>
19 kBeginHeader()
20
21 typedef struct GoExtParamIntOption
22 {
23 k32s value;
24 kText64 description;
25 } GoExtParamIntOption;
26
27 typedef struct GoExtParamFloatOption
28 {
29 k64f value;
30 kText64 description;
31 } GoExtParamFloatOption;
32
33 typedef kObject GoExtParam;
34 GoFx(const kChar*) GoExtParam_Label(GoExtParam param);
35 GoFx(const kChar*) GoExtParam_Id(GoExtParam param);
36 GoFx(GoExtParamType) GoExtParam_Type(GoExtParam param);
37 GoFx(kBool) GoExtParam_Used(GoExtParam param);
38 GoFx(const kChar*) GoExtParam_UnitType(GoExtParam param);
39
40 typedef GoExtParam GoExtParamBool;
41 GoFx(kBool) GoExtParamBool_Value(GoExtParamBool param);
42 GoFx(kStatus) GoExtParamBool_SetValue(GoExtParamBool param, kBool newVal);
43
44 typedef GoExtParam GoExtParamInt;
45 GoFx(k32s) GoExtParamInt_Value(GoExtParamInt param);
46 GoFx(kStatus) GoExtParamInt_SetValue(GoExtParamInt param, k32s newVal);
47 GoFx(kBool) GoExtParamInt_IsValueLimitUsed(GoExtParamInt param);
48 GoFx(k32s) GoExtParamInt_ValueMin(GoExtParamInt param);
49 GoFx(k32s) GoExtParamInt_ValueMax(GoExtParamInt param);
50 GoFx(kSize) GoExtParamInt_OptionCount(GoExtParamInt param);
51 GoFx(k32s) GoExtParamInt_OptionValueAt(GoExtParamInt param, kSize index);
52 GoFx(const kChar*) GoExtParamInt_OptionDescriptionAt(GoExtParamInt param, kSize index);
53
54 typedef GoExtParam GoExtParamFloat;
55 GoFx(k64f) GoExtParamFloat_Value(GoExtParamFloat param);
56 GoFx(kStatus) GoExtParamFloat_SetValue(GoExtParamFloat param, k64f newVal);
57 GoFx(kBool) GoExtParamFloat_IsValueLimitUsed(GoExtParamFloat param);
58 GoFx(k64f) GoExtParamFloat_ValueMin(GoExtParamFloat param);
59 GoFx(k64f) GoExtParamFloat_ValueMax(GoExtParamFloat param);
60 GoFx(kSize) GoExtParamFloat_OptionCount(GoExtParamFloat param);
61 GoFx(k64f) GoExtParamFloat_OptionValueAt(GoExtParamFloat param, kSize index);
62 GoFx(const kChar*) GoExtParamFloat_OptionDescriptionAt(GoExtParamFloat param, kSize index);
63
64 typedef GoExtParam GoExtParamFeature;
65 GoFx(kStatus) GoExtParamFeature_SetFeatureId(GoExtParamFeature param, k32s newVal);
66 GoFx(k32s) GoExtParamFeature_FeatureId(GoExtParamFeature param);
67 GoFx(k32s) GoExtParamFeature_ValueMin(GoExtParamFeature param);
68 GoFx(k32s) GoExtParamFeature_ValueMax(GoExtParamFeature param);
69 GoFx(kSize) GoExtParamFeature_OptionCount(GoExtParamFeature param);
70 GoFx(k32s) GoExtParamFeature_OptionValueAt(GoExtParamFeature param, kSize index);
71 GoFx(const kChar*) GoExtParamFeature_OptionDescriptionAt(GoExtParamFeature param, kSize index);
72
73 typedef GoExtParam GoExtParamString;
74 GoFx(kString) GoExtParamString_Value(GoExtParamString param);
75
76 typedef GoExtParam GoExtParamProfileRegion;
77 GoFx(GoProfileRegion) GoExtParamProfileRegion_Value(GoExtParamProfileRegion param);
78
79 typedef GoExtParam GoExtParamSurfaceRegion2d;
80 GoFx(GoSurfaceRegion2d) GoExtParamSurfaceRegion2d_Value(GoExtParamSurfaceRegion2d param);
81
82 typedef GoExtParam GoExtParamSurfaceRegion3d;
83 GoFx(GoRegion3d) GoExtParamSurfaceRegion3d_Value(GoExtParamSurfaceRegion3d param);
84
85 typedef GoExtParam GoExtParamDataInput;
86 GoFx(GoDataStreamId) GoExtParamDataInput_Value(GoExtParamDataInput param);
87 GoFx(kStatus) GoExtParamDataInput_SetValue(GoExtParamDataInput param, GoDataStreamId newVal);
88 GoFx(kSize) GoExtParamDataInput_OptionCount(GoExtParamDataInput param);
89 GoFx(GoDataStreamId) GoExtParamDataInput_OptionValueAt(GoExtParamDataInput param, kSize index);
90
91 typedef GoExtParam GoExtParamPointSetRegion;
92 GoFx(GoPointSetRegion) GoExtParamPointSetRegion_Value(GoExtParamPointSetRegion param);
93
94 kEndHeader()
95 #include <GoSdk/Tools/GoExtParam.x.h>
96
97 #endif
98 ///@endcond
kText64
GoSurfaceToolUtils.h
Declares all surface tools and their related classes.
kSize
kChar
GoProfileRegion
Represents a profile region used in various profile tools.
GoSdkDef.h
Essential SDK declarations.
GoDataStreamId
Represents a data stream id which consists of a data step, step id and source id.
Definition: GoSdkDef.h:1205
GoSurfaceRegion2d
Represents a two dimensional surface tool region.
k32s
GoRegion3d
Represents a three dimensional surface region.
GoPointSetRegion
Represents a point set region.
kString
GoProfileToolUtils.h
Declares shared profile tool configuration classes.
kObject
kStatus
kXml.h
k64f
kBool