///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, 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-2025 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 _ODTV_RAYTRACE_H_INCLUDED_
#define _ODTV_RAYTRACE_H_INCLUDED_

#include "Tv.h"
#include "TvIObject.h"
#include "TvEntity.h"
#include "TvSelection.h"


/** \details
  This class represents ray trace result item
*/
class ODTV_EXPORT OdTvRayTraceResultItem
{
public:

  /** \details
    Constructs the instance of OdTvRayTraceResultItem.
  */
  OdTvRayTraceResultItem();

  /** \details
    Initializes the instance of OdTvRayTraceResultItem.

    \param first    [in] Path to the element which has intersection with the ray.
    \param distance [in] intersection point.
  */
  void initialize(const OdTvSubItemPath& path, const OdTvPoint& intersectionPt);

  /** \details
    Provides access to the element which has intersection with the ray.

    \returns Returns OdTvSubItemPath that refers to the element which has intersection with the ray.
  */
  const OdTvSubItemPath& getPath() const;

  /** \details
    Provides access to the intersection point.

    \returns Returns the intersection point.
  */
  const OdTvPoint& getIntersectionPoint() const;

  //DOM-IGNORE-BEGIN
protected:

  OdTvSubItemPath     m_path;
  OdTvPoint           m_intersectionPoint;
  //DOM-IGNORE-END
};


/** \details
  A data type that represents an array of <link OdTvRayTraceResultItem, OdTvRayTraceResultItem> objects.
*/
typedef OdArray<OdTvRayTraceResultItem> OdTvRayTraceResultResult;


#endif //_ODTV_RAYTRACE_H_INCLUDED_