class WaypointList

June 4, 2021 ยท View on GitHub

Member values

Member nameData typeDescription
waypointsWaypointArray of waypoints
durationfloat32Duration of the waypoint list (in seconds). If unspecified or equal to 0, optimal duration is assumed.
use_optimal_blendingboolAt validation if this value is true, the waypoint list with optimal blending will be returned.

Member functions

Function nameReturn typeInput typeDescription
waypoints_size() constintvoidReturns the number of elements currently in the field.
waypoints() constconst Waypointint indexReturns the element at the given zero-based index. Calling this method with index outside of [0, waypoints_size()) yields undefined behavior.
mutable_waypoints()Waypoint*int indexReturns a pointer to the mutable Waypoint object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, waypoints_size()) yields undefined behavior.
add_waypoints()Waypoint*voidAdds a new element and returns a pointer to it. The returned Waypoint is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated Waypoint).
clear_waypoints()voidvoidRemoves all elements from the field. After calling this, waypoints_size() will return zero.
waypoints() constconst RepeatedPtrField< Waypoint>&voidReturns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
mutable_waypoints()RepeatedPtrField< Waypoint>*voidReturns a pointer to the underlying mutable RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
duration()float32voidReturns the current value of duration. If the duration is not set, returns 0.
set_duration()voidfloat32Sets the value of duration. After calling this, duration() will return value.
clear_duration()voidvoidClears the value of duration. After calling this, duration() will return 0.
use_optimal_blending()boolvoidReturns the current value of use_optimal_blending. If the use_optimal_blending is not set, returns 0.
set_use_optimal_blending()voidboolSets the value of use_optimal_blending. After calling this, use_optimal_blending() will return value.
clear_use_optimal_blending()voidvoidClears the value of use_optimal_blending. After calling this, use_optimal_blending() will return 0.

Parent topic: Base (C++)