RobotKit API
Public Member Functions | Static Public Member Functions | Properties
RKRotationRateCommand Class Reference

Class that encapsulates a set rotation rate command. More...

#import <RKRotationRateCommand.h>

Inheritance diagram for RKRotationRateCommand:
RKDeviceCommand RKDeviceMessage

List of all members.

Public Member Functions

(id) - initWithRate:

Static Public Member Functions

(void) + sendCommandWithRate:

Properties

float rate

Detailed Description

This class is used to change the rotation rate of Sphero. The rotation rate effects how sharp Sphero can turn. A low rotation rate means Sphero will make a larger radius of curvature in a turn, and a higher value will make a smaller radius of curvature, but will be more unstable.

See also:
RKRotationRateResponse

Member Function Documentation

- (id) initWithRate: (float)  rate

Initializer for the object.

Parameters:
rateA value between 0.0 to 1.0 to adjust the rotation rate for the adjustable range.
Returns:
The initialized object.
+ (void) sendCommandWithRate: (float)  rate

A convenience method for sending the command.

Parameters:
rateA value between 0.0 to 1.0 to adjust the rotation rate for the adjustable range.

Property Documentation

- (float) rate [read, assign]

The rotation rate set for the command.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties