k3d::isnap_source Class Reference

Abstract interface for a "source" on a snappable object. More...

#include <isnap_source.h>

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

List of all members.

Public Types

typedef std::vector< string_tgroups_t
 Defines a collection of "snap groups".

Public Member Functions

virtual ~isnap_source ()
virtual const string_t label ()=0
 Returns a human-readable label that describes this source.
virtual const groups_t groups ()=0
 Returns a collection of groups that this source is a member of.
virtual const point3 source_position ()=0
 Returns the position of this source in local coordinates.
virtual bool source_orientation (vector3 &SourceLook, vector3 &SourceUp)=0
 Returns the (optional, could return false) orientation of this source in local coordinates.

Protected Member Functions

 isnap_source ()
 isnap_source (const isnap_source &)
isnap_sourceoperator= (const isnap_source &)

Detailed Description

Abstract interface for a "source" on a snappable object.


Member Typedef Documentation

typedef std::vector<string_t> k3d::isnap_source::groups_t

Defines a collection of "snap groups".


Constructor & Destructor Documentation

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

Member Function Documentation

virtual const groups_t k3d::isnap_source::groups (  )  [pure virtual]

Returns a collection of groups that this source is a member of.

Implemented in k3d::explicit_snap_source, and k3d::snap_source.

Referenced by module::ngui::snap::snap_tool_detail::transform_target::snap().

virtual const string_t k3d::isnap_source::label (  )  [pure virtual]

Returns a human-readable label that describes this source.

Implemented in k3d::explicit_snap_source, and k3d::snap_source.

isnap_source& k3d::isnap_source::operator= ( const isnap_source  )  [inline, protected]
virtual bool k3d::isnap_source::source_orientation ( vector3 SourceLook,
vector3 SourceUp 
) [pure virtual]

Returns the (optional, could return false) orientation of this source in local coordinates.

Implemented in k3d::explicit_snap_source, and k3d::snap_source.

Referenced by module::ngui::snap::snap_tool_detail::transform_target::snap().

virtual const point3 k3d::isnap_source::source_position (  )  [pure virtual]

Returns the position of this source in local coordinates.

Implemented in k3d::explicit_snap_source, and k3d::snap_source.

Referenced by module::matrix::snap::on_update_matrix(), and module::ngui::snap::snap_tool_detail::transform_target::snap().


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

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