Source/System/Action/IntersectAction/OSGIntersectAction.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGINTERSECTACTION_H_
  40 #define _OSGINTERSECTACTION_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 //---------------------------------------------------------------------------
  46 //  Includes
  47 //---------------------------------------------------------------------------
  48
  49 #include <vector>
  50
  51 #include "OSGSystemDef.h"
  52 #include "OSGBaseTypes.h"
  53 #include "OSGAction.h"
  54 #include "OSGLine.h"
  55 #include "OSGStatCollector.h"
  56
  57 OSG_BEGIN_NAMESPACE
  58
  59 //---------------------------------------------------------------------------
  60 //  Forward References
  61 //---------------------------------------------------------------------------
  62
  63 class Node;
  64
  65 //---------------------------------------------------------------------------
  66 //   Types
  67 //---------------------------------------------------------------------------
  68
  69 //---------------------------------------------------------------------------
  70 //  Class
  71 //---------------------------------------------------------------------------
  72
  73 /*! \brief IntersectAction class
  74     \ingroup GrpSystemIntersectAction
  75     \ingroup GrpLibOSGSystem
  76  */
  77
  78 class OSG_SYSTEM_DLLMAPPING IntersectAction : public Action
  79 {
  80   public:
  81
  82     OSG_GEN_INTERNAL_MEMOBJPTR(IntersectAction);
  83
  84     static StatElemDesc<StatTimeElem>  statTravTime;
  85     static StatElemDesc<StatIntElem >  statNNodes;
  86     static StatElemDesc<StatIntElem >  statNTriangles;
  87
  88     typedef std::vector<Node*>         NodeStore;
  89
  90     //-----------------------------------------------------------------------
  91     //   class functions
  92     //-----------------------------------------------------------------------
  93
  94     // create a new IntersectAction by cloning the prototype
  95     static ObjTransitPtr create(      void                 );
  96     static ObjTransitPtr create(const Line   &line,
  97                                 const Real32  maxdist = Inf);
  98
  99     // prototype access
 100     // after setting the prototype all new IntersectActions are clones of it
 101
 102     static void             setPrototype(IntersectAction *proto);
 103     static IntersectAction *getPrototype(void                  );
 104
 105     //-----------------------------------------------------------------------
 106     //   instance functions
 107     //-----------------------------------------------------------------------
 108
 109     IntersectAction& operator =(const IntersectAction &source);
 110
 111     /*---------------------------------------------------------------------*/
 112     /*! \name Statistics                                                   */
 113     /*! \{                                                                 */
 114
 115     StatCollector *getStatCollector(void             ) const;
 116     void           setStatCollector(StatCollector *sc);
 117
 118     bool           getResetStatistics(void      ) const;
 119     void           setResetStatistics(bool value);
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123
 124     /*------------------------- your_category -------------------------------*/
 125
 126
 127     // set input data
 128           void     setLine(       const Line   &line,
 129                                   const Real32  maxdist = Inf);
 130           void     setTestLines     ( bool value );
 131           void     setTestLineWidth (Real32 width);
 132
 133
 134     // get input data
 135     const Line    &getLine         (      void                 ) const;
 136           Real32   getMaxDist      (      void                 ) const;
 137           bool     getTestLines    (      void                 ) const;
 138           Real32   getTestLineWidth(   void                 ) const;
 139
 140     // get result data
 141           bool       didHit        (void) const;
 142           Real32     getHitT       (void) const;
 143           Pnt3f      getHitPoint   (void) const;
 144     const Vec3f     &getHitNormal  (void) const;
 145           Node      *getHitObject  (void) const;
 146     const NodeStore &getHitPath    (void) const;
 147           Int32      getHitTriangle(void) const;
 148           Int32      getHitLine    (void) const;
 149
 150     /*------------------------- access ------------------------------*/
 151
 152     // to be used by the traversed nodes
 153     // set (temporary) results
 154     Action::ResultE setEnterLeave(      Real32   enter,
 155                                         Real32   leave   );
 156     void            setHit       (      Real32   t,
 157                                         Node    *obj,
 158                                         Int32    triIndex,
 159                                   const Vec3f   &normal,
 160                                         Int32    lineIndex );
 161
 162     // when entering/leaving a different coordinate system, the values might
 163     // have to be scaled
 164     void scale(Real32 s);
 165
 166     /*------------------------- your_operators ------------------------------*/
 167
 168     /*------------------------- assignment ----------------------------------*/
 169
 170     /*------------------------- comparison ----------------------------------*/
 171
 172     bool operator < (const IntersectAction &other) const;
 173
 174     bool operator == (const IntersectAction &other) const;
 175     bool operator != (const IntersectAction &other) const;
 176
 177
 178     // default registration. static, so it can be called during static init
 179     static void registerEnterDefault(const FieldContainerType &type,
 180                                      const Action::Functor    &func);
 181
 182     static void registerLeaveDefault(const FieldContainerType &type,
 183                                      const Action::Functor    &func);
 184
 185   protected:
 186
 187     //-----------------------------------------------------------------------
 188     //   enums
 189     //-----------------------------------------------------------------------
 190
 191     //-----------------------------------------------------------------------
 192     //   types
 193     //-----------------------------------------------------------------------
 194
 195     //-----------------------------------------------------------------------
 196     //   class variables
 197     //-----------------------------------------------------------------------
 198
 199     //-----------------------------------------------------------------------
 200     //   class functions
 201     //-----------------------------------------------------------------------
 202
 203     static bool terminateEnter(void);
 204     static bool terminateLeave(void);
 205
 206     //-----------------------------------------------------------------------
 207     //   instance variables
 208     //-----------------------------------------------------------------------
 209
 210     //-----------------------------------------------------------------------
 211     //   instance functions
 212     //-----------------------------------------------------------------------
 213
 214     IntersectAction(void);
 215     IntersectAction(const IntersectAction &source);
 216
 217     virtual ~IntersectAction(void);
 218
 219     virtual Action::ResultE start(void               );
 220     virtual Action::ResultE stop (Action::ResultE res);
 221
 222     // access default functors
 223
 224     virtual FunctorStore *getDefaultEnterFunctors(void);
 225     virtual FunctorStore *getDefaultLeaveFunctors(void);
 226
 227     ResultE onEnterNode(Node* node, Action* action);
 228     ResultE onLeaveNode(Node* node, Action* action);
 229
 230   private:
 231
 232     //-----------------------------------------------------------------------
 233     //   enums
 234     //-----------------------------------------------------------------------
 235
 236     //-----------------------------------------------------------------------
 237     //   types
 238     //-----------------------------------------------------------------------
 239
 240     typedef Action Inherited;
 241
 242     //-----------------------------------------------------------------------
 243     //   friend classes
 244     //-----------------------------------------------------------------------
 245
 246     //-----------------------------------------------------------------------
 247     //   friend functions
 248     //-----------------------------------------------------------------------
 249
 250     //-----------------------------------------------------------------------
 251     //   class variables
 252     //-----------------------------------------------------------------------
 253
 254     // the prototype which is copied to create new actions
 255     static IntersectAction * _prototype;
 256
 257     // default functors for instantiation
 258     static FunctorStore *_defaultEnterFunctors;
 259     static FunctorStore *_defaultLeaveFunctors;
 260
 261     //-----------------------------------------------------------------------
 262     //   class functions
 263     //-----------------------------------------------------------------------
 264
 265     //-----------------------------------------------------------------------
 266     //   instance variables
 267     //-----------------------------------------------------------------------
 268
 269     // the line to be tested
 270     Line   _line;
 271     bool   _testLines;     /**< If true, attempt to intersect lines as well as geom. */
 272     float  _lineTestWidth; /**< The width to assume for all lines we intersect against. */
 273
 274     // the maximum distance along the line
 275     Real32 _maxdist;
 276
 277     // Results (also intermediate)
 278     // hit at all (either bv or face)
 279     bool       _hit;
 280     // enter leave distance for bounding volume
 281     Real32     _enterT;
 282     Real32     _leaveT;
 283     NodeStore  _path;
 284
 285     // Hit distance
 286     Real32     _hitT;
 287
 288     // Hit object
 289     Node      *_hitObject;
 290     NodeStore  _hitPath;
 291
 292     // Index of the hit triangle ( from TriangleIterator::getIndex() )
 293     Int32      _hitTriangle;
 294
 295     // Normal of the hit triangle
 296     Vec3f      _hitNormal;
 297
 298     // Index of the hit line ( from LineInterator::getIndex() )
 299     Int32      _hitLine;
 300
 301     StatCollectorRefPtr _statistics;
 302     bool                _resetStatistics;
 303
 304     //-----------------------------------------------------------------------
 305     //   instance functions
 306     //-----------------------------------------------------------------------
 307 };
 308
 309 //---------------------------------------------------------------------------
 310 //   Exported Types
 311 //---------------------------------------------------------------------------
 312
 313 // class pointer
 314
 315 typedef IntersectAction *IntersectActionP;
 316
 317 OSG_GEN_MEMOBJPTR(IntersectAction);
 318
 319 OSG_END_NAMESPACE
 320
 321 #include "OSGIntersectAction.inl"
 322
 323 #endif /* _OSGRENDERACTION_H_ */