k3d::idocument Class Reference
Abstract interface for an open K-3D document. More...
#include <idocument.h>
Public Types | |
| typedef sigc::signal< void > | close_signal_t |
| Defines a signal emitted when the document closes. | |
Public Member Functions | |
| virtual inode_collection & | nodes ()=0 |
| Returns the collection of K-3D objects within this document. | |
| virtual ipipeline & | pipeline ()=0 |
| Returns the directed acyclic graph of dependencies between object properties within this document. | |
| virtual ipipeline_profiler & | pipeline_profiler ()=0 |
| Returns an object that can be used to collect and distribute profiling data for the visualization pipeline. | |
| virtual istate_recorder & | state_recorder ()=0 |
| Returns the istate_recorder interface for this document. | |
| virtual inode_name_map & | unique_node_names ()=0 |
| Returns an interface that provides a mapping of nodes to unique names. | |
| virtual iproperty & | path ()=0 |
| Returns a property that will store the document filepath (could be empty). | |
| virtual iproperty & | title ()=0 |
| Returns a property that will store the document title (could be empty string). | |
| virtual close_signal_t & | close_signal ()=0 |
Protected Member Functions | |
| idocument () | |
| idocument (const idocument &Other) | |
| idocument & | operator= (const idocument &) |
| virtual | ~idocument () |
Detailed Description
Abstract interface for an open K-3D document.
Member Typedef Documentation
| typedef sigc::signal<void> k3d::idocument::close_signal_t |
Defines a signal emitted when the document closes.
Constructor & Destructor Documentation
| k3d::idocument::idocument | ( | ) | [inline, protected] |
| k3d::idocument::idocument | ( | const idocument & | Other | ) | [inline, protected] |
| virtual k3d::idocument::~idocument | ( | ) | [inline, protected, virtual] |
Member Function Documentation
| virtual close_signal_t& k3d::idocument::close_signal | ( | ) | [pure virtual] |
| virtual inode_collection& k3d::idocument::nodes | ( | ) | [pure virtual] |
Returns the collection of K-3D objects within this document.
Implemented in k3d::detail::public_document_implementation.
Referenced by k3d::ngui::node_collection_chooser::property_model::available_nodes(), module::ngui::material_manager::mechanics::Model::buildModel(), module::collada::io::collada_obj::collada_obj(), k3d::plugin::create(), module::collada::io::create_camera(), module::opencascade::detail::create_frozen_mesh(), module::collada::io::create_frozen_mesh(), module::collada::io::create_light(), k3d::ngui::pipeline::detail::duplicate_mesh(), k3d::ngui::pipeline::detail::duplicate_node(), module::qtui::node_list::panel::get_factory(), module::ngui::timeline::detail::implementation::implementation(), module::ngui::animation_timeline::detail::implementation::implementation(), k3d::ngui::document_state::implementation::implementation(), module::ngui::material_manager::mechanics::Implementation::init(), module::ngui::pipeline_profiler::panel::initialize(), module::ngui::pipeline::panel::initialize(), module::ngui::node_list::panel::initialize(), k3d::node::lookup(), k3d::ngui::detail::node_context_menu::on_hide_unselected(), k3d::ngui::main_document_window::on_select_child(), k3d::ngui::main_document_window::on_select_parent(), k3d::ngui::main_document_window::on_select_sibling(), k3d::ngui::detail::node_context_menu::on_show_all(), k3d::ngui::main_document_window::on_view_hide_unselected(), k3d::ngui::main_document_window::on_view_show_all(), module::ngui::material_manager::mechanics::Implementation::onTreeRowChanged(), k3d::ngui::detail::pick_render_engine(), module::test::pipeline_profiler::pipeline_profiler(), k3d::ngui::node_collection_chooser::property_model::property_model(), module::k3d_io::document_importer::read_file(), module::ngui::parent::implementation::set_parent(), module::ngui::animation_timeline::detail::implementation::update_track_list(), module::k3d_io::document_exporter::write_file(), and module::collada::io::document_exporter::write_file().
| virtual iproperty& k3d::idocument::path | ( | ) | [pure virtual] |
Returns a property that will store the document filepath (could be empty).
Implemented in k3d::detail::public_document_implementation.
Referenced by k3d::ngui::main_document_window::file_revert(), k3d::ngui::main_document_window::on_file_save(), and module::k3d_io::document_exporter::write_file().
| virtual ipipeline& k3d::idocument::pipeline | ( | ) | [pure virtual] |
Returns the directed acyclic graph of dependencies between object properties within this document.
Implemented in k3d::detail::public_document_implementation.
Referenced by k3d::ngui::pipeline::detail::duplicate_mesh(), k3d::detail::insert_transform_modifier(), k3d::ngui::detail::node_context_menu::on_animate_transformation(), module::ngui::parent::implementation::set_parent(), k3d::ngui::auto_property_toolbar::bypass_property_proxy::set_value(), k3d::detail::skip_node(), k3d::detail::upstream_frozen_transformation(), k3d::detail::upstream_matrix(), and k3d::ngui::auto_property_toolbar::bypass_property_proxy::value().
| virtual ipipeline_profiler& k3d::idocument::pipeline_profiler | ( | ) | [pure virtual] |
Returns an object that can be used to collect and distribute profiling data for the visualization pipeline.
Implemented in k3d::detail::public_document_implementation.
Referenced by module::ngui::pipeline_profiler::panel::initialize(), k3d::mesh_simple_deformation_modifier::on_update_mesh(), and module::test::pipeline_profiler::pipeline_profiler().
| virtual istate_recorder& k3d::idocument::state_recorder | ( | ) | [pure virtual] |
Returns the istate_recorder interface for this document.
Implemented in k3d::detail::public_document_implementation.
Referenced by k3d::qtui::property_widget_factory::create(), module::ngui::undo_tree::detail::implementation::implementation(), module::ngui::toolbar::detail::implementation::implementation(), module::ngui::rectangle::control::initialize(), module::ngui::knot_vector::control::initialize(), k3d::ngui::main_document_window::main_document_window(), k3d::ngui::property::create_dialog::on_add(), module::ngui::undo_tree::detail::implementation::on_current_node_changed(), k3d::ngui::auto_property_page::control::implementation::on_delete_user_property(), k3d::ngui::main_document_window::on_edit_redo(), k3d::ngui::main_document_window::on_edit_undo(), module::ngui::undo_tree::detail::implementation::on_last_saved_node_changed(), module::ngui::undo_tree::detail::implementation::on_redo(), module::ngui::undo_tree::detail::implementation::on_select_row(), k3d::ri::shader::on_shader_changed(), module::ngui::undo_tree::detail::implementation::on_undo(), k3d::ngui::auto_property_toolbar::control::implementation::set_object(), k3d::ngui::auto_property_page::control::implementation::set_properties(), k3d::undoable_delete(), k3d::undoable_new(), k3d::ngui::main_document_window::unsaved_changes(), module::ngui::undo_tree::detail::implementation::update_buttons(), module::ngui::undo_tree::detail::implementation::update_contents(), k3d::ngui::main_document_window::update_undo_redo_controls(), and module::k3d_io::document_exporter::write_file().
| virtual iproperty& k3d::idocument::title | ( | ) | [pure virtual] |
Returns a property that will store the document title (could be empty string).
Implemented in k3d::detail::public_document_implementation.
Referenced by k3d::ngui::main_document_window::main_document_window(), k3d::ngui::main_document_window::on_document_title_changed(), k3d::ngui::main_document_window::on_file_revert(), k3d::ngui::main_document_window::unsaved_document_title(), and module::k3d_io::document_exporter::write_file().
| virtual inode_name_map& k3d::idocument::unique_node_names | ( | ) | [pure virtual] |
Returns an interface that provides a mapping of nodes to unique names.
Implemented in k3d::detail::public_document_implementation.
The documentation for this class was generated from the following file:
