GsRayTraceReactor.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef __ODGSRAYTRACEREACTOR_H_INCLUDED_
#define __ODGSRAYTRACEREACTOR_H_INCLUDED_
 
#include "TD_PackPush.h"
 
class OdGePoint3d;
class OdGeVector3d;
class OdGiViewport;
class OdGiPathNode;

class OdGsRayTraceReactor
{
public:
  struct TraceResult
  {
    const OdGePoint3d &m_origin; // Ray origin / intersection point.
    const OdGeVector3d &m_direction; // Ray direction / intersection normal.

    TraceResult(const OdGePoint3d &origin, const OdGeVector3d &direction)
      : m_origin(origin), m_direction(direction) { }

    const OdGePoint3d &point() const { return m_origin; }
    
    const OdGeVector3d &normal() const { return m_direction; }
  };
 
  enum
  {
    kContinue = 0, // Continue ray tracing operation.
    kBreak    = 1  // Break ray tracing operation.
  };

  virtual OdUInt32 rayIntersection(const OdGiPathNode &pathNode, const TraceResult &intResult,
                                   const TraceResult &ray, const OdGiViewport &viewInfo) = 0;

  virtual ~OdGsRayTraceReactor() {}
};
 
#include "TD_PackPop.h"
 
#endif // __ODGSRAYTRACEREACTOR_H_INCLUDED_