Image Component Library (ICL)
Hit.h
Go to the documentation of this file.
1 /********************************************************************
2 ** Image Component Library (ICL) **
3 ** **
4 ** Copyright (C) 2006-2013 CITEC, University of Bielefeld **
5 ** Neuroinformatics Group **
6 ** Website: www.iclcv.org and **
7 ** http://opensource.cit-ec.de/projects/icl **
8 ** **
9 ** File : ICLGeom/src/ICLGeom/Hit.h **
10 ** Module : ICLGeom **
11 ** Authors: Christof Elbrechter **
12 ** **
13 ** **
14 ** GNU LESSER GENERAL PUBLIC LICENSE **
15 ** This file may be used under the terms of the GNU Lesser General **
16 ** Public License version 3.0 as published by the **
17 ** **
18 ** Free Software Foundation and appearing in the file LICENSE.LGPL **
19 ** included in the packaging of this file. Please review the **
20 ** following information to ensure the license requirements will **
21 ** be met: http://www.gnu.org/licenses/lgpl-3.0.txt **
22 ** **
23 ** The development of this software was supported by the **
24 ** Excellence Cluster EXC 277 Cognitive Interaction Technology. **
25 ** The Excellence Cluster EXC 277 is a grant of the Deutsche **
26 ** Forschungsgemeinschaft (DFG) in the context of the German **
27 ** Excellence Initiative. **
28 ** **
29 ********************************************************************/
30 
31 #pragma once
32 
33 #include <ICLUtils/CompatMacros.h>
34 #include <ICLGeom/GeomDefs.h>
35 #include <iostream>
36 
37 namespace icl{
38  namespace geom{
39 
41  class SceneObject;
44  struct ICLGeom_API Hit{
47  Hit():obj(0),dist(-1){}
48 
51 
54 
56  float dist;
57 
59  inline bool operator<(const Hit &h) const { return dist < h.dist; }
60 
62  operator bool() const { return obj; }
63 
65  friend std::ostream &operator<<(std::ostream &str, const Hit &h){
66  return (h ? (str << "Hit(obj=" << (void*) h.obj << ", dist=" << h.dist
67  << ", pos=" << h.pos.transp() << ")" )
68  : (str << "Hit(NULL)"));
69  }
70  };
71 
72 
73 
74  } // namespace geom
75 }
76 
undocument this line if you encounter any issues!
Definition: Any.h:37
float dist
distance to the originating viewrays origin
Definition: Hit.h:56
#define ICLGeom_API
Definition: CompatMacros.h:179
Hit()
constructor (initializes obj with 0 and dist with -1)
Definition: Hit.h:47
friend std::ostream & operator<<(std::ostream &str, const Hit &h)
friendly implemented ostream operator ...
Definition: Hit.h:65
utility structure that defines a hit between a ViewRay and SceneObjects
Definition: Hit.h:45
SceneObject * obj
hit SceneObject
Definition: Hit.h:50
std::string str(const T &t)
convert a data type into a string using an std::ostringstream instance
Definition: StringUtils.h:136
FixedMatrix< T, ROWS, COLS > transp() const
returns matrix's transposed
Definition: FixedMatrix.h:728
Vec pos
exact position in the world where it was hit
Definition: Hit.h:53
bool operator<(const Hit &h) const
for sorting by closest distance ot viewray origin
Definition: Hit.h:59
The SceneObject class defines visible objects in scenes or scene graph nodes.
Definition: SceneObject.h:140