# synfigapp Namespace Reference

## Classes

class | BLineConverter
class | CanvasInterface
class | PushMode
| Class that changes the mode of a CanvasInterface, and restores it on destruction. More...
class | CVSInfo
class | InputDevice
| This class provides a device independent representation the state of an input device. More...
class | Instance
class | Main
class | SelectionManager
class | NullSelectionManager
| A place holding selection manager that does nothing. More...
class | Settings
struct | ValueBaseTimeInfo
struct | ActiveTimeInfo
struct | timepoints_ref
class | UIInterface
class | DefaultUIInterface
class | ConfidentUIInterface
class | ConsoleUIInterface
class | ValueDesc

## Namespaces

namespace | Action

## Enumerations

enum | EditMode { MODE_NORMAL = 0, MODE_ANIMATE = (1<<0), MODE_ANIMATE_FUTURE = (1<<1), MODE_ANIMATE_PAST = (1<<2), MODE_ANIMATE_ALL = (3<<1), MODE_UNDEFINED = (~0) }

## Functions

EditMode | operator| (const EditMode &lhs, const EditMode &rhs)
| Combine Flags.
EditMode | operator- (const EditMode &lhs, const EditMode &rhs)
| Exclude Flags.
EditMode & | operator|= (EditMode &lhs, const EditMode &rhs)
EditMode | operator & (const EditMode &lhs, const EditMode &rhs)
| Flag Comparison. THIS IS NOT LESS-THAN-OR-EQUAL-TO.
bool | is_editable (synfig::ValueNode::Handle value_node)
etl::handle< Instance > | find_instance (etl::handle< synfig::Canvas > canvas)
void | recurse_canvas (synfig::Canvas::Handle h, const std::set< Time > &tlist, timepoints_ref &vals, synfig::Time time_offset)
void | recurse_layer (synfig::Layer::Handle h, const std::set< Time > &tlist, timepoints_ref &vals, synfig::Time time_offset)
void | recurse_valuedesc (synfigapp::ValueDesc h, const std::set< Time > &tlist, timepoints_ref &vals, synfig::Time time_offset)
template<typename I1, typename I2>
bool | check_intersect (I1 b1, I1 end1, I2 b2, I2 end2, synfig::Time time_offset=0)
bool | get_closest_time (const synfig::Node::time_set &tset, const synfig::Time &t, const synfig::Time &range, synfig::Time &out)
void | recurse_valuedesc (synfigapp::ValueDesc valdesc, const std::set< synfig::Time > &tlist, timepoints_ref &vals, synfig::Time time=0)
void | recurse_layer (synfig::Layer::Handle layer, const std::set< synfig::Time > &tlist, timepoints_ref &vals, synfig::Time time=0)
void | recurse_canvas (synfig::Canvas::Handle canvas, const std::set< synfig::Time > &tlist, timepoints_ref &vals, synfig::Time time=0)

## Enumeration Type Documentation

enum synfigapp::EditMode

Todo:
  This needs to be documented further.

Enumerator:

  MODE_NORMAL | Normal editing mode. Place holder.
  MODE_ANIMATE | Animated editing mode.
  MODE_ANIMATE_FUTURE | Respect future keyframes.
  MODE_ANIMATE_PAST | Respect past keyframes.
  MODE_ANIMATE_ALL | Respect all keyframes.
  MODE_UNDEFINED | Undefined Mode.

## Function Documentation

EditMode synfigapp::operator| | ( | const EditMode & | lhs,
|  | const EditMode & | rhs |
| ) |  |  | `[inline]`

Combine Flags.

EditMode synfigapp::operator- | ( | const EditMode & | lhs,
|  | const EditMode & | rhs |
| ) |  |  | `[inline]`

Exclude Flags.

EditMode& synfigapp::operator|= | ( | EditMode & | lhs,
|  | const EditMode & | rhs |
| ) |  |  | `[inline]`

EditMode synfigapp::operator & | ( | const EditMode & | lhs,
|  | const EditMode & | rhs |
| ) |  |  | `[inline]`

Flag Comparison. THIS IS NOT LESS-THAN-OR-EQUAL-TO.

This function will return true of all of the flags in the rhs are set in the lhs

bool synfigapp::is_editable | ( | synfig::ValueNode::Handle | value_node | ) |

Referenced by studio::Duckmatic::add_to_ducks(), and studio::CanvasTreeStore::get_value_vfunc().

etl::handle< Instance > synfigapp::find_instance | ( | etl::handle< synfig::Canvas > | canvas | ) |

References instance_map_.

Referenced by synfigapp::CanvasInterface::change_value().

void synfigapp::recurse_canvas | ( | synfig::Canvas::Handle | h,
|  | const std::set< Time > & | tlist,
|  | timepoints_ref & | vals,
|  | synfig::Time | time_offset |
| ) |  |  |

References check_intersect(), and recurse_layer().

Referenced by synfigapp::Action::TimepointsMove::prepare(), synfigapp::Action::TimepointsDelete::prepare(), synfigapp::Action::TimepointsCopy::prepare(), and recurse_layer().

void synfigapp::recurse_layer | ( | synfig::Layer::Handle | h,
|  | const std::set< Time > & | tlist,
|  | timepoints_ref & | vals,
|  | synfig::Time | time_offset |
| ) |  |  |

References check_intersect(), recurse_canvas(), and recurse_valuedesc().

Referenced by synfigapp::Action::TimepointsMove::prepare(), synfigapp::Action::TimepointsDelete::prepare(), synfigapp::Action::TimepointsCopy::prepare(), and recurse_canvas().

void synfigapp::recurse_valuedesc | ( | synfigapp::ValueDesc | h,
|  | const std::set< Time > & | tlist,
|  | timepoints_ref & | vals,
|  | synfig::Time | time_offset |
| ) |  |  |

References check_intersect(), synfigapp::ValueDesc::get_index(), synfigapp::ValueDesc::get_parent_value_node(), synfigapp::ValueDesc::get_value_node(), synfigapp::timepoints_ref::insert(), and synfigapp::ValueDesc::parent_is_value_node().

Referenced by synfigapp::Action::TimepointsMove::prepare(), synfigapp::Action::TimepointsDelete::prepare(), synfigapp::Action::TimepointsCopy::prepare(), and recurse_layer().

template<typename I1, typename I2>

bool synfigapp::check_intersect | ( | I1 | b1,
|  | I1 | end1,
|  | I2 | b2,
|  | I2 | end2,
|  | synfig::Time | time_offset = `0` |
| ) |  |  | `[inline]`

Referenced by recurse_canvas(), recurse_layer(), and recurse_valuedesc().

bool synfigapp::get_closest_time | ( | const synfig::Node::time_set & | tset,
|  | const synfig::Time & | t,
|  | const synfig::Time & | range,
|  | synfig::Time & | out |
| ) |  |  |

void synfigapp::recurse_valuedesc | ( | synfigapp::ValueDesc | valdesc,
|  | const std::set< synfig::Time > & | tlist,
|  | timepoints_ref & | vals,
|  | synfig::Time | time = `0` |
| ) |  |  |

void synfigapp::recurse_layer | ( | synfig::Layer::Handle | layer,
|  | const std::set< synfig::Time > & | tlist,
|  | timepoints_ref & | vals,
|  | synfig::Time | time = `0` |
| ) |  |  |

void synfigapp::recurse_canvas | ( | synfig::Canvas::Handle | canvas,
|  | const std::set< synfig::Time > & | tlist,
|  | timepoints_ref & | vals,
|  | synfig::Time | time = `0` |
| ) |  |  |