k3d::isnappable Class Reference

Abstract interface implemented by objects to which other objects can be interactively "snapped". More...

#include <isnappable.h>

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

List of all members.

Public Types

typedef std::vector
< isnap_source * > 
snap_sources_t
 Defines a collection of "snap sources" that describe what parts of this object can be snapped.
typedef std::vector
< isnap_target * > 
snap_targets_t
 Defines a collection of "snap targets" that describe what parts of this object can be snapped-to.

Public Member Functions

virtual ~isnappable ()
virtual const snap_sources_t snap_sources ()=0
virtual const snap_targets_t snap_targets ()=0
virtual void add_snap_source (isnap_source *const SnapSource)=0
 Adds a new snap source to the object (which takes control of the lifetime of the new source).
virtual void add_snap_target (isnap_target *const SnapTarget)=0
 Adds a new snap target to the object (which takes control of the lifetime of the new target).

Protected Member Functions

 isnappable ()
 isnappable (const isnappable &)
isnappableoperator= (const isnappable &)

Detailed Description

Abstract interface implemented by objects to which other objects can be interactively "snapped".


Member Typedef Documentation

Defines a collection of "snap sources" that describe what parts of this object can be snapped.

Defines a collection of "snap targets" that describe what parts of this object can be snapped-to.


Constructor & Destructor Documentation

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

Member Function Documentation

virtual void k3d::isnappable::add_snap_source ( isnap_source *const   SnapSource  )  [pure virtual]

Adds a new snap source to the object (which takes control of the lifetime of the new source).

Implemented in k3d::snappable_detail.

virtual void k3d::isnappable::add_snap_target ( isnap_target *const   SnapTarget  )  [pure virtual]

Adds a new snap target to the object (which takes control of the lifetime of the new target).

Implemented in k3d::snappable_detail.

isnappable& k3d::isnappable::operator= ( const isnappable  )  [inline, protected]
virtual const snap_sources_t k3d::isnappable::snap_sources (  )  [pure virtual]
virtual const snap_targets_t k3d::isnappable::snap_targets (  )  [pure virtual]

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

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