# synfig::Waypoint Class Reference

`#include <waypoint.h>`

Inheritance diagram for synfig::Waypoint:

List of all members.

## Public Types

enum | Side { SIDE_UNSPECIFIED, SIDE_LEFT, SIDE_RIGHT, SIDE_END = 2 }
typedef synfig::Interpolation | Interpolation

## Public Member Functions

| Waypoint (ValueBase value, Time time)
| Waypoint (etl::handle< ValueNode > value_node, Time time)
| Waypoint ()
void | apply_model (const Model &x)
Interpolation | get_before () const
void | set_before (Interpolation x)
Interpolation | get_after () const
void | set_after (Interpolation x)
ValueBase | get_value () const
ValueBase | get_value (const Time &t) const
void | set_value (const ValueBase &x)
const etl::rhandle< ValueNode > & | get_value_node () const
void | set_value_node (const etl::handle< ValueNode > &x)
const Real & | get_tension () const
void | set_tension (const Real &x)
const Real & | get_continuity () const
void | set_continuity (const Real &x)
const Real & | get_bias () const
void | set_bias (const Real &x)
const Time & | get_time () const
void | set_time (const Time &x)
int | get_priority () const
void | set_priority (int x)
const etl::loose_handle < ValueNode > & | get_parent_value_node () const
void | set_parent_value_node (const etl::loose_handle< ValueNode > &x)
bool | is_static () const
float | get_temporal_tension () const
void | set_temporal_tension (const float &x)
bool | operator< (const Waypoint &rhs) const
bool | operator< (const Time &rhs) const
bool | operator> (const Time &rhs) const
bool | operator== (const Time &rhs) const
bool | operator!= (const Time &rhs) const
bool | operator== (const UniqueID &rhs) const
bool | operator!= (const UniqueID &rhs) const
Waypoint | clone (const GUID &deriv_guid=GUID()) const
GUID | get_guid () const

## Classes

class | Model

## Detailed Description

Todo:
  This needs to be documented further.

## Member Typedef Documentation

typedef synfig::Interpolation synfig::Waypoint::Interpolation

## Member Enumeration Documentation

enum synfig::Waypoint::Side

Enumerator:

  SIDE_UNSPECIFIED |
  SIDE_LEFT |
  SIDE_RIGHT |
  SIDE_END | For internal use only.

## Constructor & Destructor Documentation

Waypoint::Waypoint | ( | ValueBase | value,
|  | Time | time |
| ) |  |  |

References f, synfig::ValueBase::get_type(), synfig::INTERPOLATION_LINEAR, and synfig::ValueBase::TYPE_ANGLE.

Waypoint::Waypoint | ( | etl::handle< ValueNode > | value_node,
|  | Time | time |
| ) |  |  |

References f, synfig::INTERPOLATION_LINEAR, and synfig::ValueBase::TYPE_ANGLE.

Waypoint::Waypoint | ( |  | ) |

References f.

## Member Function Documentation

void Waypoint::apply_model | ( | const Model & | x | ) |

References synfig::Waypoint::Model::after_flag, synfig::Waypoint::Model::before_flag, synfig::Waypoint::Model::bias_flag, synfig::Waypoint::Model::continuity_flag, synfig::Waypoint::Model::get_after(), synfig::Waypoint::Model::get_before(), synfig::Waypoint::Model::get_bias(), synfig::Waypoint::Model::get_continuity(), synfig::Waypoint::Model::get_priority(), synfig::Waypoint::Model::get_temporal_tension(), synfig::Waypoint::Model::get_tension(), synfig::Waypoint::Model::priority_flag, set_after(), set_before(), set_bias(), set_continuity(), set_priority(), set_temporal_tension(), set_tension(), synfig::Waypoint::Model::temporal_tension_flag, and synfig::Waypoint::Model::tension_flag.

Interpolation synfig::Waypoint::get_before | ( |  | ) | const`[inline]`

void synfig::Waypoint::set_before | ( | Interpolation | x | ) | `[inline]`

Referenced by apply_model().

Interpolation synfig::Waypoint::get_after | ( |  | ) | const`[inline]`

void synfig::Waypoint::set_after | ( | Interpolation | x | ) | `[inline]`

Referenced by apply_model().

ValueBase Waypoint::get_value | ( |  | ) | const

ValueBase Waypoint::get_value | ( | const Time & | t | ) | const

void Waypoint::set_value | ( | const ValueBase & | x | ) |

References synfig::ValueNode_Const::create(), synfig::ValueBase::get_type(), synfig::INTERPOLATION_LINEAR, and synfig::ValueBase::TYPE_ANGLE.

Referenced by synfig::ValueNode_Animated::new_waypoint_at_time().

const etl::rhandle<ValueNode>& synfig::Waypoint::get_value_node | ( |  | ) | const`[inline]`

void Waypoint::set_value_node | ( | const etl::handle< ValueNode > & | x | ) |

References synfig::INTERPOLATION_LINEAR, and synfig::ValueBase::TYPE_ANGLE.

Referenced by synfig::ValueNode_Animated::new_waypoint_at_time().

const Real& synfig::Waypoint::get_tension | ( |  | ) | const`[inline]`

void synfig::Waypoint::set_tension | ( | const Real & | x | ) | `[inline]`

Referenced by apply_model().

const Real& synfig::Waypoint::get_continuity | ( |  | ) | const`[inline]`

void synfig::Waypoint::set_continuity | ( | const Real & | x | ) | `[inline]`

Referenced by apply_model().

const Real& synfig::Waypoint::get_bias | ( |  | ) | const`[inline]`

void synfig::Waypoint::set_bias | ( | const Real & | x | ) | `[inline]`

Referenced by apply_model().

const Time& synfig::Waypoint::get_time | ( |  | ) | const`[inline]`

void Waypoint::set_time | ( | const Time & | x | ) |

Referenced by synfig::ValueNode_Animated::new_waypoint_at_time().

int synfig::Waypoint::get_priority | ( |  | ) | const`[inline]`

void synfig::Waypoint::set_priority | ( | int | x | ) | `[inline]`

Referenced by apply_model().

const etl::loose_handle<ValueNode>& synfig::Waypoint::get_parent_value_node | ( |  | ) | const`[inline]`

void synfig::Waypoint::set_parent_value_node | ( | const etl::loose_handle< ValueNode > & | x | ) | `[inline]`

Referenced by synfig::ValueNode_Animated::add(), and synfig::ValueNode_Animated::new_waypoint_at_time().

bool Waypoint::is_static | ( |  | ) | const

float synfig::Waypoint::get_temporal_tension | ( |  | ) | const`[inline]`

void synfig::Waypoint::set_temporal_tension | ( | const float & | x | ) | `[inline]`

Referenced by apply_model().

bool synfig::Waypoint::operator< | ( | const Waypoint & | rhs | ) | const`[inline]`

References time.

bool synfig::Waypoint::operator< | ( | const Time & | rhs | ) | const`[inline]`

References synfig::Time::is_less_than().

bool synfig::Waypoint::operator> | ( | const Time & | rhs | ) | const`[inline]`

References synfig::Time::is_more_than().

bool synfig::Waypoint::operator== | ( | const Time & | rhs | ) | const`[inline]`

References synfig::Time::is_equal().

bool synfig::Waypoint::operator!= | ( | const Time & | rhs | ) | const`[inline]`

References synfig::Time::is_equal().

bool synfig::Waypoint::operator== | ( | const UniqueID & | rhs | ) | const`[inline]`

Reimplemented from synfig::UniqueID.

References synfig::UniqueID::get_uid().

bool synfig::Waypoint::operator!= | ( | const UniqueID & | rhs | ) | const`[inline]`

Reimplemented from synfig::UniqueID.

References synfig::UniqueID::get_uid().

Waypoint Waypoint::clone | ( | const GUID & | deriv_guid = `GUID()` | ) | const

References synfig::UniqueID::make_unique(), parent_, and value_node.

synfig::GUID Waypoint::get_guid | ( |  | ) | const

References synfig::UniqueID::get_uid(), and synfig::GUID::hasher().

The documentation for this class was generated from the following files:

- waypoint.h
- waypoint.cpp