k3d::inode_selection Class Reference

Abstract interface for objects that store document node selections and their weights. More...

#include <inode_selection.h>

Inheritance diagram for k3d::inode_selection:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::list< inode * > selected_nodes_t
 Storage for a list of selected nodes.
typedef sigc::signal< void,
ihint * > 
changed_signal_t
 Changed signal emitted when the selection changed.

Public Member Functions

virtual void select (inode &Node, const double_t Weight)=0
 Selects a node.
virtual double_t selection_weight (inode &Node)=0
 Return the selection weight of the given node.
virtual const selected_nodes_t selected_nodes ()=0
 List of selected nodes, in the order they were selected.
virtual void deselect_all ()=0
 Deselect all nodes.
virtual changed_signal_tselection_changed_signal ()=0

Protected Member Functions

 inode_selection ()
 inode_selection (const inode_selection &Other)
inode_selectionoperator= (const inode_selection &)
virtual ~inode_selection ()

Detailed Description

Abstract interface for objects that store document node selections and their weights.


Member Typedef Documentation

typedef sigc::signal<void, ihint*> k3d::inode_selection::changed_signal_t

Changed signal emitted when the selection changed.

Storage for a list of selected nodes.

Note: we use a list for fast removal at any position. Fast random access is not needed


Constructor & Destructor Documentation

k3d::inode_selection::inode_selection (  )  [inline, protected]
k3d::inode_selection::inode_selection ( const inode_selection Other  )  [inline, protected]
virtual k3d::inode_selection::~inode_selection (  )  [inline, protected, virtual]

Member Function Documentation

virtual void k3d::inode_selection::deselect_all (  )  [pure virtual]

Deselect all nodes.

Implemented in module::selection::node_selection.

inode_selection& k3d::inode_selection::operator= ( const inode_selection  )  [inline, protected]
virtual void k3d::inode_selection::select ( inode Node,
const double_t  Weight 
) [pure virtual]

Selects a node.

Parameters:
Node the node to select
Weight The selection weight. Setting this to 0 removes the node from the selection

Implemented in module::selection::node_selection.

virtual const selected_nodes_t k3d::inode_selection::selected_nodes (  )  [pure virtual]
virtual changed_signal_t& k3d::inode_selection::selection_changed_signal (  )  [pure virtual]
virtual double_t k3d::inode_selection::selection_weight ( inode Node  )  [pure virtual]

Return the selection weight of the given node.

Implemented in module::selection::node_selection.

Referenced by module::opengl::detail::draw_selection::operator()(), and module::opengl::detail::draw::operator()().


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

Generated on Mon Mar 21 07:41:54 2011 for K-3D by doxygen 1.6.3