ossia::curve< X, Y > Class Template Reference

The curve class. More...

Inheritance diagram for ossia::curve< X, Y >:

Detailed Description

template<typename X, typename Y>
class ossia::curve< X, Y >

The curve class.

A curve is a succession of curve_segment. It is used in a Behavior to drive automation or mapper.

Public Types
using	abscissa_type = X
using	ordinate_type = Y
using	curve_type = curve< X, Y >
using	map_type = curve_map< X, std::pair< Y, ossia::curve_segment< Y > > >

Public Member Functions
	curve (const curve &other)
	curve (curve &&other) noexcept
curve &	operator= (const curve &other)
curve &	operator= (curve &&other) noexcept
virtual	~curve ()=default
	destructor
void	reset () override
	Clear internal data structures of the curve.
bool	add_point (ossia::curve_segment< Y > &&segment, X abscissa, Y value)
	add a segment to reach a target point to the curve
bool	remove_point (X abscissa)
	remove a point from the curve
Y	value_at (X abscissa) const
	get value at an abscissa
ossia::curve_type	get_type () const override
	get the type of both coordinates
X	get_x0 () const
	get initial point abscissa
Y	get_y0 () const
	get initial point ordinate
void	set_x0 (X value)
	set initial point abscissa
void	set_y0 (Y value)
	set initial point ordinate
std::optional< destination >	get_y0_destination () const
	get initial point ordinate destination
void	set_y0_destination (const ossia::destination &destination)
	set initial curve ordinate using a Destination
map_type	get_points () const
	get points of the curve
void	reserve (std::size_t count)

Static Public Member Functions
static Y	convert_to_template_type_value (const ossia::value &value, ossia::destination_index::const_iterator idx)

Member Function Documentation

reset()

template<typename X , typename Y >

void ossia::curve< X, Y >::reset ( )

inlineoverridevirtual

Clear internal data structures of the curve.

Call before a new execution.

Implements ossia::curve_abstract.

add_point()

template<typename X , typename Y >

bool ossia::curve< X, Y >::add_point ( ossia::curve_segment< Y > &&  segment, X  abscissa, Y  value  )

inline

add a segment to reach a target point to the curve

Parameters

std::shared_ptr<	CurveSegment<Y>>	segment to target point
	X	target point abscissa
	Y	target point ordinate

Returns

bool

remove_point()

template<typename X , typename Y >

bool ossia::curve< X, Y >::remove_point ( X  abscissa )

inline

remove a point from the curve

Parameters

X	point abscissa

Returns

bool

value_at()

template<typename X , typename Y >

Y ossia::curve< X, Y >::value_at ( X  abscissa ) const

inline

get value at an abscissa

Parameters

X

abscissa.

Returns

Y ordinate

get_type()

template<typename X , typename Y >

curve_type ossia::curve< X, Y >::get_type ( ) const

inlineoverridevirtual

get the type of both coordinates

Implements ossia::curve_abstract.

get_x0()

template<typename X , typename Y >

X ossia::curve< X, Y >::get_x0 ( ) const

inline

get initial point abscissa

if there is an initial abcissa destination, it will return the value of the address

Returns

X value

get_y0()

template<typename X , typename Y >

Y ossia::curve< X, Y >::get_y0 ( ) const

inline

get initial point ordinate

if there is an initial ordinate destination, it will return the value of the address

Returns

Y value

set_x0()

template<typename X , typename Y >

void ossia::curve< X, Y >::set_x0 ( X  value )

inline

set initial point abscissa

if there is an initial abscissa destination, this accessor is useless

Parameters

X

abscissa

set_y0()

template<typename X , typename Y >

void ossia::curve< X, Y >::set_y0 ( Y  value )

inline

set initial point ordinate

if there is an initial ordinate destination, this accessor is useless

Parameters

Y

ordinate

get_y0_destination()

template<typename X , typename Y >

std::optional< destination > ossia::curve< X, Y >::get_y0_destination ( ) const

inline

get initial point ordinate destination

Returns

const Destination*

set_y0_destination()

template<typename X , typename Y >

void ossia::curve< X, Y >::set_y0_destination ( const ossia::destination &  destination )

inline

set initial curve ordinate using a Destination

Parameters

const

Destination*

get_points()

template<typename X , typename Y >

curve< X, Y >::map_type ossia::curve< X, Y >::get_points ( ) const

inline

get points of the curve

Returns

std::map<X, pair<Y, CurveSegment<Y>>> map of {abscissa, {value, previous segment}