MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/actions/SoRayPickAction.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */


/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Defines the SoRayPickAction class
 |
 |   Author(s)          : Paul S. Strauss, Nick Thompson
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_RAY_PICK_ACTION_
#define  _SO_RAY_PICK_ACTION_

#include <Inventor/system/SbSystem.h>
#include <Inventor/SoLists.h>
#include <Inventor/actions/SoPickAction.h>





class INVENTOR_API SoRayPickAction : public SoPickAction {

    SO_ACTION_HEADER(SoRayPickAction);

  public:

    SoRayPickAction(const SbViewportRegion &viewportRegion);

    virtual ~SoRayPickAction();


    void                setPoint(const SbVec2s &viewportPoint);

    void                setNormalizedPoint(const SbVec2f &normPoint);

    void                setRadius(float radiusInPixels);

    void                setRay(const SbVec3f &start, const SbVec3f &direction,
                               float nearDistance = -1.0,
                               float farDistance = -1.0);

    void                setPickAll(SbBool flag)         { pickAll = flag; }
    SbBool              isPickAll() const               { return pickAll;     }


    const SoPickedPointList &getPickedPointList() const  { return ptList; }

    SoPickedPoint *     getPickedPoint(int index = 0) const;

  SoEXTENDER public:

    void                computeWorldSpaceRay();

    SbBool              hasWorldSpaceRay() const;

    void                setObjectSpace();
    void                setObjectSpace(const SbMatrix &matrix);


    SbBool              intersect(const SbVec3f &v0,
                                  const SbVec3f &v1,
                                  const SbVec3f &v2,
                                  SbVec3f &intersection, SbVec3f &barycentric,
                                  SbBool &front) const;

    SbBool              intersect(const SbVec3f &v0, const SbVec3f &v1,
                                  SbVec3f &intersection) const;

    SbBool              intersect(const SbVec3f &point) const;

    SbBool              intersect(const SbBox3f &box,
                                  SbBool useFullViewVolume = TRUE);

    const SbViewVolume &getViewVolume() const   { return objVol; }

    const SbLine &      getLine() const         { return objLine; }

    SbBool              isBetweenPlanes(const SbVec3f &intersection) const;

    SoPickedPoint *     addIntersection(const SbVec3f &objectSpacePoint);

  protected:
    virtual void        beginTraversal(SoNode *node);

  SoINTERNAL public:
    static void         initClass();

  private:
    SbBool              lineWasSet;     
    SbBool              rayWasComputed; 
    SbBool              pickAll;        
    SbVec2s             VPPoint;        
    SbVec2f             normVPPoint;    
    SbBool              normPointSet;   
    float               VPRadius;       
    SbMatrix            objToWorld;     
    SbMatrix            worldToObj;     
    SoPickedPointList   ptList;         

    SbViewVolume        worldVol;

    SbBool              clipToNear, clipToFar;

    SbLine              objLine;        
    SbViewVolume        objVol;         

    SbBool              extraMatrixSet;
    SbMatrix            extraMatrix;

    void                computeMatrices();

    void                computeObjVolAndLine();

    SbBool              isCloser(const SoPickedPoint *pp0,
                                 const SoPickedPoint *pp1);

    static float        rayDistance(const SbVec3f &start,
                                    const SbVec3f &direction,
                                    const SbVec3f &point);
};

#endif /* _SO_RAY_PICK_ACTION_ */