blender::bke::curves::CurvePoint Struct Reference

#include <BKE_curves_utils.hh>

Inherits blender::bke::curves::CurveSegment.

Public Member Functions
#CurvePoint Inline Methods
bool	is_controlpoint () const
bool	operator== (const CurvePoint &other) const
bool	operator!= (const CurvePoint &other) const
bool	operator< (const CurvePoint &other) const

Public Attributes
float	parameter
Public Attributes inherited from blender::bke::curves::CurveSegment
int	index
int	next_index

Detailed Description

Reference to a point on a piecewise curve (spline).

Tracks indices of the neighboring control/evaluated point pair associated with the segment in which the point resides. Referenced point within the segment is defined by a normalized parameter in the range [0, 1].

Definition at line 46 of file BKE_curves_utils.hh.

Member Function Documentation

is_controlpoint()

bool blender::bke::curves::CurvePoint::is_controlpoint ( ) const

inline

True if the parameter is an integer and references a control/evaluated point.

Definition at line 541 of file BKE_curves_utils.hh.

Referenced by blender::bke::curves::IndexRangeCyclic::get_range_between_endpoints(), blender::geometry::sample_interval_bezier(), blender::geometry::sample_interval_catmull_rom(), and blender::geometry::sample_interval_linear().

operator!=()

bool blender::bke::curves::CurvePoint::operator!= ( const CurvePoint & other ) const

inline

Definition at line 552 of file BKE_curves_utils.hh.

References operator==().

operator<()

bool blender::bke::curves::CurvePoint::operator< ( const CurvePoint & other ) const

inline

Compare if 'this' point comes before 'other'. Loop segment for cyclical curves counts as the first (least) segment.

Definition at line 557 of file BKE_curves_utils.hh.

References blender::bke::curves::CurveSegment::next_index.

operator==()

bool blender::bke::curves::CurvePoint::operator== ( const CurvePoint & other ) const

inline

Definition at line 546 of file BKE_curves_utils.hh.

References blender::bke::curves::CurveSegment::next_index.

Referenced by operator!=().

Member Data Documentation

parameter

float blender::bke::curves::CurvePoint::parameter

Normalized parameter in the range [0, 1] defining the point on the piecewise segment. Note that the curve point representation is not unique at segment endpoints.

Definition at line 51 of file BKE_curves_utils.hh.

Referenced by blender::bke::curves::IndexRangeCyclic::get_range_between_endpoints(), blender::geometry::interpolate_catmull_rom(), blender::geometry::knot_insert_bezier(), blender::geometry::sample_interval_bezier(), and blender::geometry::sample_interval_linear().

---

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

• BKE_curves_utils.hh