/////////////////////////////////////////////////////////////////////////////// 
// 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 __TNW_LIGHTITEMDISTANT_H__
#define __TNW_LIGHTITEMDISTANT_H__

#include "NwLightItem.h"

class OdGePoint3d;

/** \details
  This class represents light saved item which emits uniform parallel light rays in one direction only.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwLightItemDistant : public OdNwLightItem
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwLightItemDistant);
  //DOM-IGNORE-END

public:
  /** \details
    Default constructor. Creates an object of the OdNwLightItemDistant class.
  */
  OdNwLightItemDistant();
public:
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwLightItemDistant();

public:
  /** \details
    Returns the position of the light.

    \returns Returns an OdGePoint3d value with the light position.
  */
  OdGePoint3d getFrom() const;

  /** \details
    Returns the target of the light.

    \returns Returns an OdGePoint3d value with the light target.
  */
  OdGePoint3d getTo() const;

public:

  /** \details
    Sets the position of the light.

    \param ptFrom [in] constant reference to point with light's position.

    \returns eOk if the light's position sets is successfully, or an
    appropriate error code otherwise.
  */
  OdResult setFrom(const OdGePoint3d& ptFrom);

  /** \details
    Sets the target of the light.

    \param ptTo [in] constant reference to point with light's target.

    \returns eOk if the light's target sets is successfully, or an
    appropriate error code otherwise.
  */
  OdResult setTo(const OdGePoint3d& ptTo);
};

/** \details
  This template class is a specialization of the OdSmartPtr class for
  OdNwLightItemDistant object pointers.
*/
typedef OdSmartPtr<OdNwLightItemDistant> OdNwLightItemDistantPtr;

#endif //__TNW_SAVEDVIEWDISTANT_H__