k3d::scripted_node< base_t > Class Template Reference

Uses parameterized inheritance to provide a boilerplate implementation for nodes that are controlled by scripts. More...

#include <scripted_node.h>

Inheritance diagram for k3d::scripted_node< base_t >:

[legend]

List of all members.

Classes
class	execute_lock
	RAII helper class that keeps track of whether we're executing, so we can avoid recursive loops. More...
Public Member Functions
	scripted_node (iplugin_factory &Factory, idocument &Document)
Protected Member Functions
void	set_script (const string_t &Script)
void	connect_script_changed_signal (const sigc::slot< void, ihint * > &Slot)
bool	execute_script (iscript_engine::context &Context)
Private Member Functions
void	on_script_changed (ihint *hint)
	k3d_data (string_t, immutable_name, change_signal, with_undo, local_storage, no_constraint, script_property, with_serialization) m_script
Private Attributes
boost::scoped_ptr< iscript_engine >	m_script_engine
user_property_changed_signal	m_user_property_changed_signal
bool	m_executing

---

Detailed Description

template<typename base_t>
class k3d::scripted_node< base_t >

Uses parameterized inheritance to provide a boilerplate implementation for nodes that are controlled by scripts.

---

Constructor & Destructor Documentation

template<typename base_t>

k3d::scripted_node< base_t >::scripted_node	(	iplugin_factory &	Factory,
		idocument &	Document
	)			[inline]

---

Member Function Documentation

template<typename base_t>

void k3d::scripted_node< base_t >::connect_script_changed_signal

(

const sigc::slot< void, ihint * > &

Slot

)

[inline, protected]

template<typename base_t>

bool k3d::scripted_node< base_t >::execute_script

(

iscript_engine::context &

Context

)

[inline, protected]

template<typename base_t>

k3d::scripted_node< base_t >::k3d_data	(	string_t	,
		immutable_name	,
		change_signal	,
		with_undo	,
		local_storage	,
		no_constraint	,
		script_property	,
		with_serialization
	)			[private]

template<typename base_t>

void k3d::scripted_node< base_t >::on_script_changed

(

ihint *

hint

)

[inline, private]

Referenced by k3d::scripted_node< k3d::transformable< k3d::node > >::scripted_node().

template<typename base_t>

void k3d::scripted_node< base_t >::set_script

(

const string_t &

Script

)

[inline, protected]

---

Member Data Documentation

template<typename base_t>

bool k3d::scripted_node< base_t >::m_executing [private]

Referenced by k3d::scripted_node< k3d::transformable< k3d::node > >::execute_script().

template<typename base_t>

boost::scoped_ptr<iscript_engine> k3d::scripted_node< base_t >::m_script_engine [private]

Referenced by k3d::scripted_node< k3d::transformable< k3d::node > >::execute_script(), and k3d::scripted_node< k3d::transformable< k3d::node > >::on_script_changed().

template<typename base_t>

user_property_changed_signal k3d::scripted_node< base_t >::m_user_property_changed_signal [private]

Referenced by k3d::scripted_node< k3d::transformable< k3d::node > >::connect_script_changed_signal().

---

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

• scripted_node.h