/////////////////////////////////////////////////////////////////////////////// 
// 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_LIGHTSELEMENT_H__
#define __TNW_LIGHTSELEMENT_H__

#include "NwSavedItemsElement.h"

class OdGePoint3d;

/** \details
  This class represents a lights element.

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

public:
  /** \details
    Default constructor.
  */
  OdNwLightsElement();

  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwLightsElement();

public:
  /** \details
    Adds a point light item.
    \param sName              [in] Name of saved light item.
    \param ptPosition         [in] the position of the light.
    \param pRes               [out] Receives eOk if the appending operation is successful, or an appropriate error code otherwise.
    \returns OdNwObjectId with an OdNwLightItemPoint object.
  */
  OdNwObjectId addItemPointLight(const OdString& sName, const OdGePoint3d& ptPosition, OdResult* pRes = NULL);

  /** \details
    Adds a distant light item.
    \param sName              [in] Name of saved light item.
    \param ptFrom             [in] the position of the light.
    \param ptTo               [in] the target of the light.
    \param pRes               [out] Receives eOk if the appending operation is successful, or an appropriate error code otherwise.
    \returns OdNwObjectId with an OdNwLightItemDistant object.
  */
  OdNwObjectId addItemDistantLight(const OdString& sName, const OdGePoint3d& ptFrom, const OdGePoint3d& ptTo, OdResult* pRes = NULL);

  /** \details
    Adds a spot light item.
    \param sName              [in] Name of saved light item.
    \param ptFrom             [in] the position of the light.
    \param ptTo               [in] the target of the light.
    \param pRes               [out] Receives eOk if the appending operation is successful, or an appropriate error code otherwise.
    \returns OdNwObjectId with an OdNwLightItemSpot object.
  */
  OdNwObjectId addItemSpotLight(const OdString& sName, const OdGePoint3d& ptFrom, const OdGePoint3d& ptTo, OdResult* pRes = NULL);

  /** \details
    Adds a web light item.
    \param sName              [in] Name of saved light item.
    \param ptFrom             [in] the position of the light.
    \param ptTo               [in] the target of the light.
    \param pRes               [out] Receives eOk if the appending operation is successful, or an appropriate error code otherwise.
    \returns OdNwObjectId with an OdNwLightItemWeb object.
  */
  OdNwObjectId addItemWebLight(const OdString& sName, const OdGePoint3d& ptFrom, const OdGePoint3d& ptTo, OdResult* pRes = NULL);

  /** \details
    Gets the list of scene light objects ID.
    \param sceneLights        [out] The array of ObjectId to receive scene light objects IDs.
    \returns eOk if successful, or an appropriate error code otherwise.
  */
  OdResult getSceneLights(OdNwObjectIdArray& sceneLights);
};

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

#endif //__TNW_LIGHTSELEMENT_H__