/////////////////////////////////////////////////////////////////////////////// 
// 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_HEADLIGHT_ELEMENT_H__
#define __TNW_HEADLIGHT_ELEMENT_H__

#include "NwObject.h"
#include "RxSystemServices.h"
#include "NwExport.h"

class OdNwColor;

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

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

public:
  /** \details
    Default constructor. Creates a new object of the OdNwHeadlightElement
    class.
  */
  OdNwHeadlightElement();

public:

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

public:

  /** \details
    An ambient value of the Headlight element.

    \returns The value of the light's ambient.
  */
  double getAmbient() const;

  /** \details
    Returns an intensity value of the element.

    \returns The value of the light's intensity.
  */
  double getIntensity() const;

  /** \details
  Sets the ambient value of headlight element.

  \param The ambient value.

  \returns eOk if the ambient value was set successfully, otherwise the
  corresponoding error code.

  \remarks
  The ambient value must be in the [0.0, 1.0] range.
  */
  OdResult setAmbient(double val);

  /** \details
  Sets the intensity value of headlight element.

  \param The intensity value.

  \returns eOk if the intensity value was set successfully, otherwise the
  corresponoding error code.

  \remarks
  The intensity value must be in the [0.0, 1.0] range.
  */
  OdResult setIntensity(double val);
};

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

#endif //__TNW_HEADLIGHT_ELEMENT_H__