Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 2.77 KB

File metadata and controls

30 lines (24 loc) · 2.77 KB

class WaypointList

Member values

Member name Data type Description
waypoints Waypoint Array of waypoints
duration float32 Duration of the waypoint list (in seconds). If unspecified or equal to 0, optimal duration is assumed.
use_optimal_blending bool At validation if this value is true, the waypoint list with optimal blending will be returned.

Member functions

Function name Return type Input type Description
waypoints_size() const int void Returns the number of elements currently in the field.
waypoints() const const Waypoint int index Returns 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 index Returns 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* void Adds 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() void void Removes all elements from the field. After calling this, waypoints_size() will return zero.
waypoints() const const RepeatedPtrField< Waypoint>& void Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
mutable_waypoints() RepeatedPtrField< Waypoint>* void Returns a pointer to the underlying mutable RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
duration() float32 void Returns the current value of duration. If the duration is not set, returns 0.
set_duration() void float32 Sets the value of duration. After calling this, duration() will return value.
clear_duration() void void Clears the value of duration. After calling this, duration() will return 0.
use_optimal_blending() bool void Returns the current value of use_optimal_blending. If the use_optimal_blending is not set, returns 0.
set_use_optimal_blending() void bool Sets the value of use_optimal_blending. After calling this, use_optimal_blending() will return value.
clear_use_optimal_blending() void void Clears the value of use_optimal_blending. After calling this, use_optimal_blending() will return 0.

Parent topic: Base (C++)