k3d::python::detail Namespace Reference

Classes
class	role_method_creator
Functions
boost::python::object	wrap (AtkObject *Object)
	Wrap an AtkObject, adding additional dynamic methods for any actions it may have.
const k3d::string_t	script_name (const k3d::string_t &Name)
	Converts the given string to a name suitable as Python function name.
const k3d::int32_t	action_index (AtkAction *Action, const k3d::string_t &ActionName)
k3d::bool_t	do_named_action (atk_object_wrapper &Self, const k3d::string_t &ActionName)
	Performs the action with the given name. Requires Self to be an AtkAction and the action must exist (caller needs to check this).
static void	click (atk_object_wrapper &Self)
	Proxy for click action.
k3d::bool_t	has_action (AtkObject *Object, const k3d::string_t &ActionName)
void	define_action_methods (AtkObject *Object, boost::python::object &Instance)
static object	get_item_name (atk_object_wrapper &Self, const string_t &Key, const AtkRole Role)
	Get the item with role Role and name Key.
static object	get_item_idx (atk_object_wrapper &Self, const k3d::uint_t Key, const AtkRole Role)
	Get the item with index Key and role Role, with indices counted within children of the same type.
template<typename Role >
static object	get_item (atk_object_wrapper &Self, object Key)
template<typename return_type , typename value_type >
object	wrap_const_object (const pipeline_data< value_type > &Data)
template<typename value_type >
object	wrap_non_const_object (pipeline_data< value_type > &Data)
template<typename return_type , typename value_type >
object	create_object (pipeline_data< value_type > &Data)
template<typename array_type >
object	wrap_const_array (const pipeline_data< array_type > &Data)
template<typename array_type >
object	wrap_non_const_array (pipeline_data< array_type > &Data)
template<typename array_type >
object	create_array (pipeline_data< array_type > &Data)

---

Function Documentation

const k3d::int32_t k3d::python::detail::action_index	(	AtkAction *	Action,
		const k3d::string_t &	ActionName
	)

References return_val_if_fail.

Referenced by do_named_action(), and has_action().

static void k3d::python::detail::click

(

atk_object_wrapper &

Self

)

[static]

Proxy for click action.

References do_named_action().

Referenced by define_action_methods().

template<typename array_type >

object k3d::python::detail::create_array

(

pipeline_data< array_type > &

Data

)

[inline]

References k3d::pipeline_data< T >::create().

Referenced by k3d::python::mesh_create_point_selection(), and k3d::python::mesh_create_points().

template<typename return_type , typename value_type >

object k3d::python::detail::create_object

(

pipeline_data< value_type > &

Data

)

[inline]

References k3d::pipeline_data< T >::create(), and generate::return_type().

void k3d::python::detail::define_action_methods	(	AtkObject *	Object,
		boost::python::object &	Instance
	)

References k3d::python::utility::add_method(), click(), has_action(), and k3d::python::utility::make_function().

Referenced by wrap().

k3d::bool_t k3d::python::detail::do_named_action	(	atk_object_wrapper &	Self,
		const k3d::string_t &	ActionName
	)

Performs the action with the given name. Requires Self to be an AtkAction and the action must exist (caller needs to check this).

References action_index(), modifier::result, return_val_if_fail, k3d::iuser_interface::synchronize(), k3d::user_interface(), and k3d::python::instance_wrapper< T >::wrapped_ptr().

Referenced by click().

template<typename Role >

static object k3d::python::detail::get_item	(	atk_object_wrapper &	Self,
		object	Key
	)			[inline, static]

References get_item_idx(), get_item_name(), and generate::value.

static object k3d::python::detail::get_item_idx	(	atk_object_wrapper &	Self,
		const k3d::uint_t	Key,
		const AtkRole	Role
	)			[static]

Get the item with index Key and role Role, with indices counted within children of the same type.

References k3d::error(), wrap(), and k3d::python::instance_wrapper< T >::wrapped_ptr().

Referenced by get_item().

static object k3d::python::detail::get_item_name	(	atk_object_wrapper &	Self,
		const string_t &	Key,
		const AtkRole	Role
	)			[static]

Get the item with role Role and name Key.

References wrap(), and k3d::python::instance_wrapper< T >::wrapped_ptr().

Referenced by get_item().

k3d::bool_t k3d::python::detail::has_action	(	AtkObject *	Object,
		const k3d::string_t &	ActionName
	)

References action_index().

Referenced by define_action_methods().

const k3d::string_t k3d::python::detail::script_name

(

const k3d::string_t &

Name

)

Converts the given string to a name suitable as Python function name.

TODO: Move this to the SDK, so the conversion is always consistent?

Referenced by module::ngui::atk_event_recorder::dialog::on_action_recorded(), and k3d::python::detail::role_method_creator::operator()().

boost::python::object k3d::python::detail::wrap

(

AtkObject *

Object

)

Wrap an AtkObject, adding additional dynamic methods for any actions it may have.

References define_action_methods().

Referenced by module::ngui::atk_event_recorder::dialog::click_event_listener(), k3d::ngui::viewport::control::create_font(), get_item_idx(), get_item_name(), module::linear_curve::lissajous_curve::on_update_mesh_topology(), module::linear_curve::knot_curve::on_update_mesh_topology(), and wrap_non_const_object().

template<typename array_type >

object k3d::python::detail::wrap_const_array

(

const pipeline_data< array_type > &

Data

)

[inline]

Referenced by k3d::python::const_mesh_point_selection(), and k3d::python::const_mesh_points().

template<typename return_type , typename value_type >

object k3d::python::detail::wrap_const_object

(

const pipeline_data< value_type > &

Data

)

[inline]

References generate::return_type().

template<typename array_type >

object k3d::python::detail::wrap_non_const_array

(

pipeline_data< array_type > &

Data

)

[inline]

References k3d::pipeline_data< T >::writable().

Referenced by k3d::python::mesh_point_selection(), and k3d::python::mesh_points().

template<typename value_type >

object k3d::python::detail::wrap_non_const_object

(

pipeline_data< value_type > &

Data

)

[inline]

References wrap(), and k3d::pipeline_data< T >::writable().

Referenced by k3d::python::mesh_primitives_t_get_item().