FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kOrientation.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_ORIENTATION_H
9 #define K_FIRESYNC_ORIENTATION_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kOrientation; --forward-declared in kFsDef.x.h
22 
23 
30 kFsFx(kStatus) kOrientation_ClearAll(kOrientation orientation);
31 
42 kFsFx(kStatus) kOrientation_Enable(kOrientation orientation, kBool enable);
43 
51 kFsFx(kBool) kOrientation_IsEnabled(kOrientation orientation);
52 
61 
72 
82 
93 
103 kFsFx(kStatus) kOrientation_SetAxisSign(kOrientation orientation, kOrientationAxis axis, kBool positive);
104 
113 kFsFx(kBool) kOrientation_AxisSign(kOrientation orientation, kOrientationAxis axis);
114 
125 
134 kFsFx(kStatus) kOrientation_SetAnyMotionThreshold(kOrientation orientation, k64u threshold);
135 
144 
154 
163 kFsFx(kStatus) kOrientation_SetNoMotionThreshold(kOrientation orientation, k64u threshold);
164 
173 
183 
192 kFsFx(kStatus) kOrientation_SetNoMotionDelay(kOrientation orientation, k64u delay);
193 
201 kFsFx(k64u) kOrientation_NoMotionDelay(kOrientation orientation);
202 
212 
221 
230 kFsFx(kStatus) kOrientation_Stats(kOrientation orientation, kOrientationStats* stats);
231 
232 kEndHeader()
233 
234 #include <kFireSync/Client/kOrientation.x.h>
235 
236 #endif
Represents supported orientation device types.
kOrientationAxis kOrientation_AxisRemap(kOrientation orientation, kOrientationAxis axis)
Gets the remapped axis.
Represents orientation device run-time statistics.
Definition: kNodeDef.h:1369
k64u kOrientation_AnyMotionThreshold(kOrientation orientation)
Gets the threshold of any motion detection.
kStatus kOrientation_AxisRemapInfo(kOrientation orientation, kOrientationAxis axis, kInfoBits *info)
Reports constraint and validity information for the axis remapping setting.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
Essential declarations related to FireSync nodes.
kStatus kOrientation_NoMotionThresholdInfo(kOrientation orientation, kInfo64u *info)
Reports constraint and validity information for the no motion threshold setting.
kBool kOrientation_IsEnabled(kOrientation orientation)
Reports whether the orientation is currently enabled.
kStatus kOrientation_StartCalibration(kOrientation orientation)
Start the calibration procedure.
kStatus kOrientation_SetAxisRemap(kOrientation orientation, kOrientationAxis axis, kOrientationAxis remappedAxis)
Sets the remapping axis.
kStatus kOrientation_AnyMotionThresholdInfo(kOrientation orientation, kInfo64u *info)
Reports constraint and validity information for the any motion threshold setting. ...
kStatus kOrientation_SetAnyMotionThreshold(kOrientation orientation, k64u threshold)
Sets the threshold of any motion detection.
Represents supported orientation axes.
Represents configuration for a node's local orientation.
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:187
kStatus kOrientation_AxisSignInfo(kOrientation orientation, kOrientationAxis axis, kInfoBool *info)
Reports constraint and validity information for the remapped axis sign setting.
kOrientationModel kOrientation_Model(kOrientation orientation)
Gets the model of the orientation device.
kStatus kOrientation_NoMotionDelayInfo(kOrientation orientation, kInfo64u *info)
Reports constraint and validity information for the no motion delay setting.
kStatus kOrientation_SetNoMotionThreshold(kOrientation orientation, k64u threshold)
Sets the threshold of no motion detection.
kStatus kOrientation_SetAxisSign(kOrientation orientation, kOrientationAxis axis, kBool positive)
Sets the sign of remapped axis.
kBool kOrientation_AxisSign(kOrientation orientation, kOrientationAxis axis)
Gets the sign of remapped axis.
k64u kOrientation_NoMotionThreshold(kOrientation orientation)
Gets the threshold of no motion detection.
kStatus kOrientation_ClearAll(kOrientation orientation)
Resets orientation device settings to defaults.
k64u kOrientation_NoMotionDelay(kOrientation orientation)
Gets the delay of no motion detection.
kStatus kOrientation_Stats(kOrientation orientation, kOrientationStats *stats)
Retrieve statistics.
kStatus kOrientation_SetNoMotionDelay(kOrientation orientation, k64u delay)
Sets the delay of no motion detection.
kStatus kOrientation_Enable(kOrientation orientation, kBool enable)
Enables or disables the orientation.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:403