Waypoint is used to handle variations along the time of the ValueNodes. More...

#include <waypoint.h>

Inheritance diagram for synfig::Waypoint:

Classes
class	Model

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)
	Constructor for constant Waypoint.
	Waypoint (etl::handle< ValueNode > value_node, Time time)
	Waypoint ()
	Default constructor. Leaves unset the Value Node.
void	apply_model (const Model &x)
Interpolation	get_before () const
	Gets the before Interpolation.
void	set_before (Interpolation x)
	Sets the before Interpolation.
Interpolation	get_after () const
	Gets the after Interpolation.
void	set_after (Interpolation x)
	Sets the after Interpolation.
ValueBase	get_value () const
	Gets the value hold by the Waypoint.
ValueBase	get_value (const Time &t) const
	Gets the value hold by the Waypoint at time when it is animated.
void	set_value (const ValueBase &x)
const etl::rhandle< ValueNode > &	get_value_node () const
	Returns the handle to the value node.
void	set_value_node (const etl::handle< ValueNode > &x)
	Sets the value node by handle.
const Real &	get_tension () const
	Gets tension.
void	set_tension (const Real &x)
	Sets tension.
const Real &	get_continuity () const
	Gets continuity.
void	set_continuity (const Real &x)
	Sets continuity.
const Real &	get_bias () const
	Gets bias.
void	set_bias (const Real &x)
	Sets bias.
const Time &	get_time () const
	Gets the time of the waypoint.
void	set_time (const Time &x)
	Sets the time of the waypoint.
int	get_priority () const
void	set_priority (int x)
const etl::loose_handle < ValueNode > &	get_parent_value_node () const
	Gets parent Value Node.
void	set_parent_value_node (const etl::loose_handle< ValueNode > &x)
	Sets parent Value Node.
bool	is_static () const
	if the Value Node is constant, not null and not exported
float	get_temporal_tension () const
	! Gets temporal tension
void	set_temporal_tension (const float &x)
	! Sets temporal tension
bool	operator< (const Waypoint &rhs) const
	True if the current waypoint's time is earlier than the compared waypoint's time.
bool	operator< (const Time &rhs) const
	True if the current waypoint's time is earlier than the given time.
bool	operator> (const Time &rhs) const
	True if the current waypoint's time is later than the given time.
bool	operator== (const Time &rhs) const
	True if the waypoint's time is the same than the given time.
bool	operator!= (const Time &rhs) const
	True if the waypoint's time is different than the given time.
bool	operator== (const UniqueID &rhs) const
	True if the Waypoint's Unique Id is the same than the argument's Unique ID.
bool	operator!= (const UniqueID &rhs) const
	True if the Waypoint's Unique Id is different than the argument's Unique ID.
Waypoint	clone (etl::loose_handle< Canvas > canvas, const GUID &deriv_guid=GUID()) const
GUID	get_guid () const
	Returns a hack GUID using the UniqueID's value.
Public Member Functions inherited from synfig::UniqueID
const int &	get_uid () const
	Returns the internal unique identifier for this object.
	UniqueID ()
void	make_unique ()
	operator bool () const
void	mimic (const UniqueID &x)
bool	operator< (const UniqueID &rhs) const

Additional Inherited Members
Static Public Member Functions inherited from synfig::UniqueID
static const UniqueID	nil ()

Detailed Description

Waypoint is used to handle variations along the time of the ValueNodes.

The Waypoint is a child of a ValueNode (or any of inherited) and it describes the Interpolation type (before and after), the ValueNode (usually waypoints are constant but in fact they can be animated) and the time where the waypoint is.

See Also: Waypoint::get_value(), Waypoint::get_value(const Time &t)

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

Constructor & Destructor Documentation

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

Constructor for constant Waypoint.

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

Constructor for animated Waypoint Is is called anytime?

synfig::Waypoint::Waypoint ( )

Default constructor. Leaves unset the Value Node.

Member Function Documentation

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

Applies the content of the Model to the Waypoint. It doesn't alter the Value Node hold or the time.

Interpolation synfig::Waypoint::get_before ( ) const

inline

Gets the before Interpolation.

void synfig::Waypoint::set_before ( Interpolation x )

inline

Sets the before Interpolation.

Interpolation synfig::Waypoint::get_after ( ) const

inline

Gets the after Interpolation.

void synfig::Waypoint::set_after ( Interpolation x )

inline

Sets the after Interpolation.

ValueBase synfig::Waypoint::get_value ( ) const

Gets the value hold by the Waypoint.

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

Gets the value hold by the Waypoint at time when it is animated.

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

Sets the value of the Waypoint. Maybe it would be posible to define set_value(const ValueBase &x, Time &t) ?

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

const etl::rhandle<ValueNode>& synfig::Waypoint::get_value_node ( ) const

inline

Returns the handle to the value node.

Referenced by synfig::ValueNode_Animated::erase(), and synfig::ValueNode_Animated::waypoint_is_only_use_of_valuenode().

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

Sets the value node by handle.

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

const Real& synfig::Waypoint::get_tension ( ) const

inline

Gets tension.

void synfig::Waypoint::set_tension ( const Real & x )

inline

Sets tension.

const Real& synfig::Waypoint::get_continuity ( ) const

inline

Gets continuity.

void synfig::Waypoint::set_continuity ( const Real & x )

inline

Sets continuity.

const Real& synfig::Waypoint::get_bias ( ) const

inline

Gets bias.

void synfig::Waypoint::set_bias ( const Real & x )

inline

Sets bias.

const Time& synfig::Waypoint::get_time ( ) const

inline

Gets the time of the waypoint.

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

Sets the time of the waypoint.

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

int synfig::Waypoint::get_priority ( ) const

inline

void synfig::Waypoint::set_priority ( int x )

inline

const etl::loose_handle<ValueNode>& synfig::Waypoint::get_parent_value_node ( ) const

inline

Gets parent Value Node.

void synfig::Waypoint::set_parent_value_node ( const etl::loose_handle< ValueNode > & x )

Sets parent Value Node.

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

bool synfig::Waypoint::is_static ( ) const

if the Value Node is constant, not null and not exported

float synfig::Waypoint::get_temporal_tension ( ) const

inline

! Gets temporal tension

void synfig::Waypoint::set_temporal_tension ( const float & x )

inline

! Sets temporal tension

bool synfig::Waypoint::operator< ( const Waypoint & rhs ) const

inline

True if the current waypoint's time is earlier than the compared waypoint's time.

bool synfig::Waypoint::operator< ( const Time & rhs ) const

inline

True if the current waypoint's time is earlier than the given time.

References synfig::Time::is_less_than().

bool synfig::Waypoint::operator> ( const Time & rhs ) const

inline

True if the current waypoint's time is later than the given time.

References synfig::Time::is_more_than().

bool synfig::Waypoint::operator== ( const Time & rhs ) const

inline

True if the waypoint's time is the same than the given time.

References synfig::Time::is_equal().

bool synfig::Waypoint::operator!= ( const Time & rhs ) const

inline

True if the waypoint's time is different than the given time.

References synfig::Time::is_equal().

bool synfig::Waypoint::operator== ( const UniqueID & rhs ) const

inline

True if the Waypoint's Unique Id is the same than the argument's Unique ID.

Reimplemented from synfig::UniqueID.

References synfig::UniqueID::get_uid().

bool synfig::Waypoint::operator!= ( const UniqueID & rhs ) const

inline

True if the Waypoint's Unique Id is different than the argument's Unique ID.

Reimplemented from synfig::UniqueID.

References synfig::UniqueID::get_uid().

Waypoint synfig::Waypoint::clone	(	etl::loose_handle< Canvas >	canvas,
		const GUID &	deriv_guid = `GUID()`
	)		const

Clones the Value Node if it is not exported and returns a Waypoint with no parent.

GUID synfig::Waypoint::get_guid ( ) const

Returns a hack GUID using the UniqueID's value.

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

waypoint.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation