NAME
A function of omni::geometry::path
OVERLOADS
omni::geometry::path::circle
A function of omni::geometry::path
#include <omni/geometry/path.hpp>template < template < class, class > class std_seq_t, typename T, typename std_allocator_t > omni::geometry::path::circle(T x, T y, T radius, T step, bool invert_x, bool invert_y)OVERLOADS
template < template < class, class > class std_seq_t, typename T > omni::geometry::path::circle(T x, T y, T radius, T step, bool invert_x, bool invert_y)
template < template < class, class > class std_seq_t, typename T > omni::geometry::path::circle(T x, T y, T radius, T step)
template < template < class, class > class std_seq_t, typename T > omni::geometry::path::circle(T x, T y, T radius)
template < typename T > omni::geometry::path::circle(T x, T y, T radius, T step, bool invert_x, bool invert_y)
template < typename T > omni::geometry::path::circle(T x, T y, T radius, T step)
template < typename T > omni::geometry::path::circle(T x, T y, T radius)
DESCRIPTION
Creates a path of 2d points along a circle given an {X, Y} center point and a radius size. This will create a point every 1 degree along the circle, alternatively you may pass along a stepping value to change the interval each node along the path is created.
top
Creates a path of 2d points along a circle given an {X, Y} center point and a radius size. This will create a point every 1 degree along the circle, alternatively you may pass along a stepping value to change the interval each node along the path is created.
top
PARAMETERS
top
x - The X value of the center of the circle. y - The Y value of the center of the circle. radius - The radius of the circle. step - The stepping value to create each point at (default is 1 degree). invert_x - True to invert the X direction the points are added to the list. invert_y - True to invert the Y direction the points are added to the list. std_seq_t - The templated sequence type (e.g. vector/deque/etc.). T - The underlying type the points will be (e.g. double/int32_t/etc.). std_allocator_t - The templated sequence type allocator.
top
CONSIDERATIONS
Be aware that if you use non floating point types (e.g. int32_t, etc.), that the values of the points will be clamped to that type, thus making it possible the circle's path will be more jagged than those with a double or float as the backing type.
top
Be aware that if you use non floating point types (e.g. int32_t, etc.), that the values of the points will be clamped to that type, thus making it possible the circle's path will be more jagged than those with a double or float as the backing type.
top