ScaleViz/actions/ScRayPickAction.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Ludovic PEINE (Jun 2007)
**=======================================================================*/


#ifndef  SC_RAY_PICK_ACTION
#define  SC_RAY_PICK_ACTION

#include <Inventor/actions/SoRayPickAction.h>

class ScRayPickAction;
class SoPath;

typedef void ScRayPickCallback( void*, ScRayPickAction* );

class  ScRayPickAction : public SoRayPickAction
{
  SO_ACTION_HEADER(ScRayPickAction);

public:

  ScRayPickAction(
    const SbViewportRegion &viewportRegion,
    SoAction::DistribMode distribMode = SoAction::LOCAL_ONLY,
    ScRayPickCallback* callback = NULL,
    void* userData = NULL
  );

#ifndef HIDDEN_FROM_DOC
  ~ScRayPickAction();
#endif // HIDDEN_FROM_DOC

  virtual void apply( SoNode *node );

  void setRay( 
    const SbVec3f &rayStart,
    const SbVec3f &rayDirection,
    float nearDistance = -1,
    float farDistance = -1 );

  void setRay( 
    float fovy,
    const SbVec3f &rayStart,
    const SbVec3f &rayDirection,
    float nearDistance = -1,
    float farDistance = -1 );

  void setPoint( const SbVec2s &viewportPoint );

  void setPoint( const SbVec2f &viewportPoint );

  void setNormalizedPoint( const SbVec2f &normPoint );

  SbVec3f getppNormal();

  SbVec3f getppPoint();

  SoPath* getppPath();

  SbBool isValidPp();

  private:

  typedef enum ScRayDefinition
  {
    UNDEFINED,
    RAY,
    POINT,
    NORMPOINT
  } ScRayDefinition_t;

  static void initClass();
  static void exitClass();
  virtual bool mustTraverseDepth() { return true; }

  // Retrieve how the ray has been defined
  ScRayDefinition getRayDefinition() { return m_rayDefinition; }

  // Retrieve ray properties
  void getRay( SbVec3f &rayStart, SbVec3f &rayDirection, float &nearDistance, float &farDistance );

  void getNormalizedPoint( SbVec2f &normPoint );

  void getPoint( SbVec2s &point );

  void getPoint( SbVec2f &point );
  
  // Retrieve the fovy set for the action
  float getFov();

  // Return true if the user set the fovy manually
  bool isFovSet();

  // Method used to set the picked point properties of an action
  void setPickedPoint( SbVec3f ppPoint, SbVec3f ppNormal, SoPath* ppPath, SbBool isValidPp );


private:

  // Pointer to the user callback
  ScRayPickCallback* m_rayPickCallback;

  // Pointer to user data
  void* m_data;

  SbVec3f m_rayStart;                 // ray starting point ( world-space )
  SbVec3f m_rayDirection;             // ray direction
  SbVec2f m_normPoint;                // normalized point
  SbVec2f m_rayPoint;                 // ray point ( viewport-space )
  float m_nearDst;                    // near plane clipping
  float m_farDst;                     // far plane clipping
  ScRayDefinition m_rayDefinition;    // how the ray has been defined
  SbVec3f m_ppPoint;                  // coordinate of picked point
  SbVec3f m_ppNormal;                 // normal of picked point
  SoPath* m_ppPath;                   // SoPath to picked point
  SbBool m_isValidPp;                  // flag to know if something got picked
  float m_fovy;                       // define the field of view angle
  bool m_bFovSet;                     // Indicates if the fov has been changed by user
};

// INLINE METHODS
/*************************************************************************/
inline void
ScRayPickAction::setPickedPoint( SbVec3f ppPoint, SbVec3f ppNormal, SoPath* ppPath, SbBool isValidPp )
{
  m_ppPoint = ppPoint;
  m_ppNormal = ppNormal;
  m_ppPath = ppPath;
  m_isValidPp = isValidPp;
}

/*************************************************************************/
inline SbVec3f
ScRayPickAction::getppNormal()
{
  return m_ppNormal;
}

/*************************************************************************/
inline SbVec3f
ScRayPickAction::getppPoint()
{
  return m_ppPoint;
}

/*************************************************************************/
inline SoPath* 
ScRayPickAction::getppPath()
{
  return m_ppPath;
}

/*************************************************************************/
inline SbBool
ScRayPickAction::isValidPp()
{
  return m_isValidPp;
}

/*************************************************************************/
inline float
ScRayPickAction::getFov()
{
  return m_fovy;
}

inline bool
ScRayPickAction::isFovSet()
{
  return m_bFovSet;
}
#endif // SC_RAY_PICK_ACTION

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/