synfig::ValueNode Class Reference

#include <valuenode.h>

Inheritance diagram for synfig::ValueNode:

synfig::Node synfig::LinkableValueNode synfig::PlaceholderValueNode synfig::ValueNode_Animated synfig::ValueNode_Const synfig::ValueNode_Composite synfig::ValueNode_DynamicList synfig::ValueNode_GradientRotate synfig::ValueNode_Linear synfig::ValueNode_RadialComposite synfig::ValueNode_Reference synfig::ValueNode_Scale synfig::ValueNode_SegCalcTangent synfig::ValueNode_SegCalcVertex synfig::ValueNode_Sine synfig::ValueNode_Stripes synfig::ValueNode_Subtract synfig::ValueNode_TimedSwap synfig::ValueNode_TwoTone

List of all members.

Public Types

typedef etl::handle
< ValueNode
Handle
typedef
etl::loose_handle
< ValueNode
LooseHandle
typedef etl::handle
< const ValueNode
ConstHandle
typedef etl::rhandle
< ValueNode
RHandle

Public Member Functions

sigc::signal< void > & signal_value_changed ()
 ValueBase Changed.
sigc::signal< void,
int * > & 
signal_children_reordered ()
 Children Reordered.
sigc::signal< void,
int > & 
signal_child_changed ()
 Child Changed.
sigc::signal< void,
int > & 
signal_child_removed ()
 Child Removed.
sigc::signal< void,
int > & 
signal_child_inserted ()
 Child Inserted.
sigc::signal< void > & signal_id_changed ()
 ID Changed.
virtual ~ValueNode ()
virtual ValueBase operator() (Time t) const
 Returns the value of the ValueNode at time t.
void set_id (const String &x)
 

For internal use only.

Sets the id of the ValueNode


const Stringget_id () const
 Returns the id of the ValueNode.
virtual String get_name () const =0
 Returns the name of the ValueNode type.
virtual String get_local_name () const =0
 Returns the localized name of the ValueNode type.
virtual ValueNodeclone (const GUID &deriv_guid=GUID()) const =0
bool is_exported () const
ValueBase::Type get_type () const
 Returns the type of the ValueNode.
etl::loose_handle
< Canvas
get_parent_canvas () const
 Returns a handle to the parent canvas, if it has one.
etl::loose_handle
< Canvas
get_root_canvas () const
 Returns a handle to the parent canvas, if it has one.
void set_parent_canvas (etl::loose_handle< Canvas > x)
void set_root_canvas (etl::loose_handle< Canvas > x)
String get_relative_id (etl::loose_handle< const Canvas > x) const
int replace (etl::handle< ValueNode > x)
 DCAST_HACK_BASECLASS ()
 DCAST_HACK_ID (0)

Static Public Member Functions

static bool subsys_init ()
static bool subsys_stop ()

Protected Member Functions

 ValueNode (ValueBase::Type type=ValueBase::TYPE_NIL)
void set_type (ValueBase::Type t)
 Sets the type of the ValueNode.
virtual void on_changed ()

Friends

class Layer
class LinkableValueNode


Detailed Description

Todo:
writeme

Member Typedef Documentation

typedef etl::handle<ValueNode> synfig::ValueNode::Handle

Reimplemented in synfig::PlaceholderValueNode, synfig::LinkableValueNode, synfig::ValueNode_Animated, synfig::ValueNode_BLine, synfig::ValueNode_Composite, synfig::ValueNode_Const, synfig::ValueNode_DynamicList, synfig::ValueNode_GradientRotate, synfig::ValueNode_Linear, synfig::ValueNode_RadialComposite, synfig::ValueNode_Reference, synfig::ValueNode_Scale, synfig::ValueNode_SegCalcTangent, synfig::ValueNode_SegCalcVertex, synfig::ValueNode_Sine, synfig::ValueNode_Stripes, synfig::ValueNode_Subtract, synfig::ValueNode_TimedSwap, and synfig::ValueNode_TwoTone.

typedef etl::loose_handle<ValueNode> synfig::ValueNode::LooseHandle

Reimplemented in synfig::PlaceholderValueNode, and synfig::LinkableValueNode.

typedef etl::handle<const ValueNode> synfig::ValueNode::ConstHandle

Reimplemented in synfig::PlaceholderValueNode, synfig::LinkableValueNode, synfig::ValueNode_Animated, synfig::ValueNode_BLine, synfig::ValueNode_Composite, synfig::ValueNode_Const, synfig::ValueNode_DynamicList, synfig::ValueNode_GradientRotate, synfig::ValueNode_Linear, synfig::ValueNode_RadialComposite, synfig::ValueNode_Reference, synfig::ValueNode_Scale, synfig::ValueNode_SegCalcTangent, synfig::ValueNode_SegCalcVertex, synfig::ValueNode_Sine, synfig::ValueNode_Stripes, synfig::ValueNode_Subtract, synfig::ValueNode_TimedSwap, and synfig::ValueNode_TwoTone.

typedef etl::rhandle<ValueNode> synfig::ValueNode::RHandle

Reimplemented in synfig::PlaceholderValueNode, and synfig::LinkableValueNode.


Constructor & Destructor Documentation

ValueNode::ValueNode ( ValueBase::Type  type = ValueBase::TYPE_NIL  )  [protected]

ValueNode::~ValueNode (  )  [virtual]


Member Function Documentation

bool ValueNode::subsys_init (  )  [static]

bool ValueNode::subsys_stop (  )  [static]

sigc::signal<void>& synfig::ValueNode::signal_value_changed (  )  [inline]

ValueBase Changed.

sigc::signal<void,int*>& synfig::ValueNode::signal_children_reordered (  )  [inline]

Children Reordered.

sigc::signal<void,int>& synfig::ValueNode::signal_child_changed (  )  [inline]

Child Changed.

sigc::signal<void,int>& synfig::ValueNode::signal_child_removed (  )  [inline]

Child Removed.

sigc::signal<void,int>& synfig::ValueNode::signal_child_inserted (  )  [inline]

Child Inserted.

sigc::signal<void>& synfig::ValueNode::signal_id_changed (  )  [inline]

ID Changed.

virtual ValueBase synfig::ValueNode::operator() ( Time  t  )  const [inline, virtual]

Returns the value of the ValueNode at time t.

Reimplemented in synfig::PlaceholderValueNode, synfig::ValueNode_BLine, synfig::ValueNode_Composite, synfig::ValueNode_Const, synfig::ValueNode_DynamicList, synfig::ValueNode_GradientRotate, synfig::ValueNode_Linear, synfig::ValueNode_RadialComposite, synfig::ValueNode_Reference, synfig::ValueNode_Scale, synfig::ValueNode_SegCalcTangent, synfig::ValueNode_SegCalcVertex, synfig::ValueNode_Sine, synfig::ValueNode_Stripes, synfig::ValueNode_Subtract, synfig::ValueNode_TimedSwap, and synfig::ValueNode_TwoTone.

void ValueNode::set_id ( const String x  ) 

For internal use only.

Sets the id of the ValueNode

const String& synfig::ValueNode::get_id (  )  const [inline]

Returns the id of the ValueNode.

The ID is used for keeping track of a specific instance of a ValueNode.

virtual String synfig::ValueNode::get_name (  )  const [pure virtual]

Returns the name of the ValueNode type.

Implemented in synfig::PlaceholderValueNode, synfig::ValueNode_Animated, synfig::ValueNode_BLine, synfig::ValueNode_Composite, synfig::ValueNode_Const, synfig::ValueNode_DynamicList, synfig::ValueNode_GradientRotate, synfig::ValueNode_Linear, synfig::ValueNode_RadialComposite, synfig::ValueNode_Reference, synfig::ValueNode_Scale, synfig::ValueNode_SegCalcTangent, synfig::ValueNode_SegCalcVertex, synfig::ValueNode_Sine, synfig::ValueNode_Stripes, synfig::ValueNode_Subtract, synfig::ValueNode_TimedSwap, and synfig::ValueNode_TwoTone.

virtual String synfig::ValueNode::get_local_name (  )  const [pure virtual]

Returns the localized name of the ValueNode type.

Implemented in synfig::PlaceholderValueNode, synfig::ValueNode_Animated, synfig::ValueNode_BLine, synfig::ValueNode_Composite, synfig::ValueNode_Const, synfig::ValueNode_DynamicList, synfig::ValueNode_GradientRotate, synfig::ValueNode_Linear, synfig::ValueNode_RadialComposite, synfig::ValueNode_Reference, synfig::ValueNode_Scale, synfig::ValueNode_SegCalcTangent, synfig::ValueNode_SegCalcVertex, synfig::ValueNode_Sine, synfig::ValueNode_Stripes, synfig::ValueNode_Subtract, synfig::ValueNode_TimedSwap, and synfig::ValueNode_TwoTone.

virtual ValueNode* synfig::ValueNode::clone ( const GUID deriv_guid = GUID()  )  const [pure virtual]

Todo:
This needs to be documented further.

Implemented in synfig::PlaceholderValueNode, synfig::LinkableValueNode, synfig::ValueNode_BLine, synfig::ValueNode_Const, and synfig::ValueNode_DynamicList.

bool synfig::ValueNode::is_exported (  )  const [inline]

Todo:
This needs to be documented further.

ValueBase::Type synfig::ValueNode::get_type (  )  const [inline]

Returns the type of the ValueNode.

etl::loose_handle<Canvas> synfig::ValueNode::get_parent_canvas (  )  const [inline]

Returns a handle to the parent canvas, if it has one.

etl::loose_handle<Canvas> synfig::ValueNode::get_root_canvas (  )  const [inline]

Returns a handle to the parent canvas, if it has one.

void ValueNode::set_parent_canvas ( etl::loose_handle< Canvas x  ) 

Todo:
This needs to be documented further.

void ValueNode::set_root_canvas ( etl::loose_handle< Canvas x  ) 

Todo:
This needs to be documented further.

String ValueNode::get_relative_id ( etl::loose_handle< const Canvas x  )  const

Todo:
This needs to be documented further.

int ValueNode::replace ( etl::handle< ValueNode x  ) 

void synfig::ValueNode::set_type ( ValueBase::Type  t  )  [inline, protected]

Sets the type of the ValueNode.

Reimplemented in synfig::LinkableValueNode, and synfig::ValueNode_Animated.

void ValueNode::on_changed (  )  [protected, virtual]

Reimplemented from synfig::Node.

synfig::ValueNode::DCAST_HACK_BASECLASS (  ) 

synfig::ValueNode::DCAST_HACK_ID (  ) 


Friends And Related Function Documentation

friend class Layer [friend]

friend class LinkableValueNode [friend]


The documentation for this class was generated from the following files:
Generated on Wed Aug 15 05:00:25 2007 for synfig by  doxygen 1.5.3