Cardboard Robot SDK
 All Classes Namespaces Functions Enumerations Properties Events
Properties | Public Member Functions | List of all members
CBRobot.Path Interface Reference

Detailed Description

Defines a path for the robot arm to follow.

Properties

ArmPosition StartPosition [get]
 Returns the position that the arm should start at when executing this path.
 
double PathLength [get]
 Returns the total length of the path, measured in seconds.
 
bool Loop [get]
 Returns whether or not this path should loop.
 

Public Member Functions

void GetParametersAtTime (double time, out ArmPosition position, out ArmSpeed speed)
 Returns the target position and speed that the robot should have at the given time value, specified in seconds (where zero is the start of the path).
 
void SetPathTime (double time)
 Provides the current time value as the arm moves along the path (can leave this empty)
 

Member Function Documentation

void CBRobot.Path.GetParametersAtTime ( double  time,
out ArmPosition  position,
out ArmSpeed  speed 
)

Returns the target position and speed that the robot should have at the given time value, specified in seconds (where zero is the start of the path).

The result of this function defines the path that the robot will follow.

While the path defined by this function does not need to be consistent, it IS recommended that it remain consistent between each call to setPathTime, in case the path executor samples multiple points per time value (i.e., if the path is wrapped by a path-smoothing class).


The documentation for this interface was generated from the following file: