k3d::isnap_target Class Reference

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

#include <isnap_target.h>

Inheritance diagram for k3d::isnap_target:
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_target ()
virtual const string_t label ()=0
 Returns a human-readable label that describes this target.
virtual const groups_t groups ()=0
 Returns a collection of groups that this target is a member of.
virtual bool target_position (const point3 &Position, point3 &TargetPosition)=0
 Given a set of local coordinates, returns the (optional, could return false) corresponding target position in local coordiantes.
virtual bool target_orientation (const point3 &Position, vector3 &TargetLook, vector3 &TargetUp)=0
 Given a set of local coordinates, returns the (optional, could return false) corresponding target orientation in local coordinates.

Protected Member Functions

 isnap_target ()
 isnap_target (const isnap_target &)
isnap_targetoperator= (const isnap_target &)

Detailed Description

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


Member Typedef Documentation

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

Defines a collection of "snap groups".


Constructor & Destructor Documentation

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

Member Function Documentation

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

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

Implemented in k3d::explicit_snap_target, and k3d::snap_target.

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

Returns a human-readable label that describes this target.

Implemented in k3d::explicit_snap_target, and k3d::snap_target.

isnap_target& k3d::isnap_target::operator= ( const isnap_target  )  [inline, protected]
virtual bool k3d::isnap_target::target_orientation ( const point3 Position,
vector3 TargetLook,
vector3 TargetUp 
) [pure virtual]

Given a set of local coordinates, returns the (optional, could return false) corresponding target orientation in local coordinates.

Implemented in k3d::explicit_snap_target, and k3d::snap_target.

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

virtual bool k3d::isnap_target::target_position ( const point3 Position,
point3 TargetPosition 
) [pure virtual]

Given a set of local coordinates, returns the (optional, could return false) corresponding target position in local coordiantes.

Implemented in k3d::explicit_snap_target, and k3d::snap_target.

Referenced by module::matrix::snap::on_update_matrix().


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