# synfig::ValueNode_DynamicList::ListEntry Class Reference

Contains a potential list item, and associated timing information. More...

`#include <valuenode_dynamiclist.h>`

Inheritance diagram for synfig::ValueNode_DynamicList::ListEntry:

List of all members.

## Public Types

typedef synfig::Activepoint | Activepoint
typedef std::list< Activepoint > | ActivepointList
typedef std::pair < ActivepointList::iterator, bool > | findresult
typedef std::pair < ActivepointList::const_iterator, bool > | const_findresult

## Public Member Functions

int | get_index () const
bool | status_at_time (const Time &x) const
float | amount_at_time (const Time &x, bool *rising=0) const
ActivepointList::iterator | add (Time time, bool status, int priority=0)
ActivepointList::iterator | add (const Activepoint &x)
findresult | find_uid (const UniqueID &x)
const_findresult | find_uid (const UniqueID &x) const
findresult | find_time (const Time &x)
const_findresult | find_time (const Time &x) const
ActivepointList::iterator | find (const UniqueID &x)
ActivepointList::const_iterator | find (const UniqueID &x) const
ActivepointList::iterator | find (const Time &x)
ActivepointList::const_iterator | find (const Time &x) const
ActivepointList::iterator | find_prev (const Time &x)
ActivepointList::const_iterator | find_prev (const Time &x) const
ActivepointList::iterator | find_next (const Time &x)
ActivepointList::const_iterator | find_next (const Time &x) const
Activepoint | new_activepoint_at_time (const Time &x) const
ActivepointList::iterator | add (Time time)
void | erase (const UniqueID &x)
int | find (const Time &begin, const Time &end, std::vector< Activepoint * > &list)
const synfig::Node::time_set & | get_times () const
const etl::loose_handle < ValueNode > & | get_parent_value_node () const
| ListEntry ()
| ListEntry (const ValueNode::Handle &value_node)
| ListEntry (const ValueNode::Handle &value_node, Time begin, Time end)

## Public Attributes

ValueNode::RHandle | value_node
ActivepointList | timing_info

## Friends

class | ValueNode_DynamicList
class | ValueNode_BLine

## Detailed Description

Contains a potential list item, and associated timing information.

This structure contains a RHandle to a ValueNode, as well as the associated on/off timing information which determines when this item is included in the list.

The timing information is stored in the member `timing_info`.

## Member Typedef Documentation

typedef synfig::Activepoint synfig::ValueNode_DynamicList::ListEntry::Activepoint

typedef std::list<Activepoint> synfig::ValueNode_DynamicList::ListEntry::ActivepointList

typedef std::pair<ActivepointList::iterator,bool> synfig::ValueNode_DynamicList::ListEntry::findresult

typedef std::pair<ActivepointList::const_iterator,bool> synfig::ValueNode_DynamicList::ListEntry::const_findresult

## Constructor & Destructor Documentation

ValueNode_DynamicList::ListEntry::ListEntry | ( |  | ) |

ValueNode_DynamicList::ListEntry::ListEntry | ( | const ValueNode::Handle & | value_node | ) |

ValueNode_DynamicList::ListEntry::ListEntry | ( | const ValueNode::Handle & | value_node,
|  | Time | begin,
|  | Time | end |
| ) |  |  |

## Member Function Documentation

int synfig::ValueNode_DynamicList::ListEntry::get_index | ( |  | ) | const`[inline]`

Referenced by add().

bool ValueNode_DynamicList::ListEntry::status_at_time | ( | const Time & | x | ) | const

Todo:
  This needs to be optimized further. Perhaps we should use a binary search...?

References timing_info.

Referenced by add(), and new_activepoint_at_time().

float ValueNode_DynamicList::ListEntry::amount_at_time | ( | const Time & | x,
|  | bool * | rising = `0` |
| ) |  |  | const

References f, find(), find_next(), find_prev(), and timing_info.

ValueNode_DynamicList::ListEntry::ActivepointList::iterator ValueNode_DynamicList::ListEntry::add | ( | Time | time,
|  | bool | status,
|  | int | priority = `0` |
| ) |  |  |

Todo:
  This needs to be optimized further.

References get_index(), get_parent_value_node(), synfig::Activepoint::set_parent_index(), synfig::Activepoint::set_parent_value_node(), and timing_info.

ValueNode_DynamicList::ListEntry::ActivepointList::iterator ValueNode_DynamicList::ListEntry::add | ( | const Activepoint & | x | ) |

Todo:
  This needs to be optimized further.

References get_index(), get_parent_value_node(), synfig::Activepoint::set_parent_index(), synfig::Activepoint::set_parent_value_node(), and timing_info.

ValueNode_DynamicList::ListEntry::findresult ValueNode_DynamicList::ListEntry::find_uid | ( | const UniqueID & | x | ) |

References f, and timing_info.

ValueNode_DynamicList::ListEntry::const_findresult ValueNode_DynamicList::ListEntry::find_uid | ( | const UniqueID & | x | ) | const

References f, and timing_info.

ValueNode_DynamicList::ListEntry::findresult ValueNode_DynamicList::ListEntry::find_time | ( | const Time & | x | ) |

References f, and timing_info.

ValueNode_DynamicList::ListEntry::const_findresult ValueNode_DynamicList::ListEntry::find_time | ( | const Time & | x | ) | const

References f, and timing_info.

ValueNode_DynamicList::ListEntry::ActivepointList::iterator ValueNode_DynamicList::ListEntry::find | ( | const UniqueID & | x | ) |

References timing_info.

Referenced by amount_at_time(), erase(), and find().

ValueNode_DynamicList::ListEntry::ActivepointList::const_iterator ValueNode_DynamicList::ListEntry::find | ( | const UniqueID & | x | ) | const

References timing_info.

ValueNode_DynamicList::ListEntry::ActivepointList::iterator ValueNode_DynamicList::ListEntry::find | ( | const Time & | x | ) |

References synfig::Time::get_string(), and timing_info.

ValueNode_DynamicList::ListEntry::ActivepointList::const_iterator ValueNode_DynamicList::ListEntry::find | ( | const Time & | x | ) | const

References synfig::Time::get_string(), and timing_info.

ValueNode_DynamicList::ListEntry::ActivepointList::iterator ValueNode_DynamicList::ListEntry::find_prev | ( | const Time & | x | ) |

References synfig::Time::get_string(), and timing_info.

Referenced by amount_at_time().

ValueNode_DynamicList::ListEntry::ActivepointList::const_iterator ValueNode_DynamicList::ListEntry::find_prev | ( | const Time & | x | ) | const

References synfig::Time::get_string(), and timing_info.

ValueNode_DynamicList::ListEntry::ActivepointList::iterator ValueNode_DynamicList::ListEntry::find_next | ( | const Time & | x | ) |

References synfig::Time::get_string(), and timing_info.

Referenced by amount_at_time(), find(), and synfig::ValueNode_DynamicList::insert_time().

ValueNode_DynamicList::ListEntry::ActivepointList::const_iterator ValueNode_DynamicList::ListEntry::find_next | ( | const Time & | x | ) | const

References synfig::Time::get_string(), and timing_info.

Activepoint ValueNode_DynamicList::ListEntry::new_activepoint_at_time | ( | const Time & | x | ) | const

References synfig::Activepoint::set_priority(), synfig::Activepoint::set_state(), and status_at_time().

ActivepointList::iterator synfig::ValueNode_DynamicList::ListEntry::add | ( | Time | time | ) | `[inline]`

References status_at_time().

void ValueNode_DynamicList::ListEntry::erase | ( | const UniqueID & | x | ) |

References find(), and timing_info.

int ValueNode_DynamicList::ListEntry::find | ( | const Time & | begin,
|  | const Time & | end,
|  | std::vector< Activepoint * > & | list |
| ) |  |  |

References find(), and find_next().

const synfig::Node::time_set & ValueNode_DynamicList::ListEntry::get_times | ( |  | ) | const

References synfig::TimePointSet::insert(), synfig::TimePoint::set_guid(), synfig::TimePoint::set_time(), timing_info, and value_node.

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

Referenced by add().

## Friends And Related Function Documentation

friend class ValueNode_DynamicList `[friend]`

friend class ValueNode_BLine `[friend]`

## Member Data Documentation

ValueNode::RHandle synfig::ValueNode_DynamicList::ListEntry::value_node

Referenced by synfig::ValueNode_DynamicList::add(), synfig::ValueNode_DynamicList::clone(), synfig::ValueNode_DynamicList::create_list_entry(), synfig::ValueNode_BLine::create_list_entry(), and get_times().

ActivepointList synfig::ValueNode_DynamicList::ListEntry::timing_info

Referenced by synfig::ValueNode_DynamicList::add(), add(), amount_at_time(), erase(), find(), find_next(), find_prev(), find_time(), find_uid(), get_times(), synfig::ValueNode_DynamicList::insert_time(), and status_at_time().

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

- valuenode_dynamiclist.h
- valuenode_dynamiclist.cpp