Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoExtParam.h
1 ///@cond private
2
3 /**
4 * @file GoExtParam.h
5 * @brief Declares the GoExtParam class.
6 *
7 * @internal
8 * Copyright (C) 2016 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
35 GoFx(const kChar*) GoExtParam_Label(GoExtParam param);
36 GoFx(const kChar*) GoExtParam_Id(GoExtParam param);
37 GoFx(GoExtParamType) GoExtParam_Type(GoExtParam param);
38 GoFx(kBool) GoExtParam_Used(GoExtParam param);
39 GoFx(GoUnitType) GoExtParam_UnitType(GoExtParam param);
40
41 typedef GoExtParam GoExtParamBool;
42
43 GoFx(kBool) GoExtParamBool_Value(GoExtParamBool param);
44 GoFx(kStatus) GoExtParamBool_SetValue(GoExtParamBool param, kBool newVal);
45
46 typedef GoExtParam GoExtParamInt;
47
48 GoFx(k32s) GoExtParamInt_Value(GoExtParamInt param);
49 GoFx(kStatus) GoExtParamInt_SetValue(GoExtParamInt param, k32s newVal);
50 GoFx(kBool) GoExtParamInt_IsValueLimitUsed(GoExtParamInt param);
51 GoFx(k32s) GoExtParamInt_ValueMin(GoExtParam param);
52 GoFx(k32s) GoExtParamInt_ValueMax(GoExtParam param);
53 GoFx(kSize) GoExtParamInt_OptionCount(GoExtParamInt param);
54 GoFx(k32s) GoExtParamInt_OptionValueAt(GoExtParamInt param, kSize index);
55 GoFx(const kChar*) GoExtParamInt_OptionDescriptionAt(GoExtParamInt param, kSize index);
56
57 typedef GoExtParam GoExtParamFloat;
58
59 GoFx(k64f) GoExtParamFloat_Value(GoExtParamFloat param);
60 GoFx(kStatus) GoExtParamFloat_SetValue(GoExtParamFloat param, k64f newVal);
61 GoFx(kBool) GoExtParamFloat_IsValueLimitUsed(GoExtParamFloat param);
62 GoFx(k64f) GoExtParamFloat_ValueMin(GoExtParam param);
63 GoFx(k64f) GoExtParamFloat_ValueMax(GoExtParam param);
64 GoFx(kSize) GoExtParamFloat_OptionCount(GoExtParamFloat param);
65 GoFx(k64f) GoExtParamFloat_OptionValueAt(GoExtParamFloat param, kSize index);
66 GoFx(const kChar*) GoExtParamFloat_OptionDescriptionAt(GoExtParamFloat param, kSize index);
67
68 typedef GoExtParam GoExtParamString;
69 GoFx(kString) GoExtParamString_Value(GoExtParamString param);
70
71 typedef GoExtParam GoExtParamProfileRegion;
72 GoFx(GoProfileRegion) GoExtParamProfileRegion_Value(GoExtParamProfileRegion param);
73
74 typedef GoExtParam GoExtParamSurfaceRegion2d;
75 GoFx(GoSurfaceRegion2d) GoExtParamSurfaceRegion2d_Value(GoExtParamSurfaceRegion2d param);
76
77 typedef GoExtParam GoExtParamSurfaceRegion3d;
78 GoFx(GoRegion3d) GoExtParamSurfaceRegion3d_Value(GoExtParamSurfaceRegion3d param);
79
80 kEndHeader()
81 #include <GoSdk/Tools/GoExtParam.x.h>
82
83 #endif
84 ///@endcond
kText64
kSize
kChar
GoProfileRegion
Represents a profile region used in various profile tools.
GoSdkDef.h
Essential SDK declarations.
k32s
kString
GoProfileToolUtils.h
Declares shared profile tool configuration classes.
kObject
kStatus
kXml.h
k64f
kBool