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

#include "TD_PackPush.h"

#include "Gs/GsProperties.h"
#include "Gi/GiEnvironmentTraitsData.h"
#include "Gs/GsBackground.h"

/** <group OdGs_Classes> 
*/
class GS_TOOLKIT_EXPORT OdGsBackgroundProperties : public OdGsProperties
                                                 , protected OdGsNestedBackground
{
  OdGiBackgroundTraitsData* m_pBackgroundTraits;
  OdGsBackgroundPtr m_pBackgroundPainter;
  OdSmartPtr<OdGsBackgroundProperties> m_pSecondaryBackground;

protected:
  virtual void nestedBackgroundDisplay(OdGsBaseVectorizer& view,
    const OdGiDrawable *pDrawable,
    OdGiBackgroundTraitsData* pBackgroundTraits,
    OdGsPropertiesDirectRenderOutput *pdro = NULL);

public:
  ODRX_DECLARE_MEMBERS(OdGsBackgroundProperties);

  /** \details
    Default constructor for the OdGsBackgroundProperties class. Sets background traits to NULL.
  */
  OdGsBackgroundProperties();

  /** \details
    Destructor for the OdGsBackgroundProperties class. Clears background traits.
  */
  ~OdGsBackgroundProperties();

  /** \details
    Retrieves pointer to background traits of a solid background.
  */
  OdGiSolidBackgroundTraitsData* solidBackgroundTraitsData() const { return (OdGiSolidBackgroundTraitsData*)m_pBackgroundTraits; }

  /** \details
    Retrieves pointer to background traits of a gradient background.
  */
  OdGiGradientBackgroundTraitsData* gradientBackgroundTraitsData() const { return (OdGiGradientBackgroundTraitsData*)m_pBackgroundTraits; }

  /** \details
    Retrieves pointer to background traits of an image background.
  */
  OdGiImageBackgroundTraitsData* imageBackgroundTraitsData() const { return (OdGiImageBackgroundTraitsData*)m_pBackgroundTraits; }

  /** \details
    Retrieves pointer to background traits of ground plane background.
  */
  OdGiGroundPlaneBackgroundTraitsData* groundPlaneBackgroundTraitsData() const { return (OdGiGroundPlaneBackgroundTraitsData*)m_pBackgroundTraits; }

  /** \details
    Retrieves pointer to background traits of a sky background.
  */
  OdGiSkyBackgroundTraitsData* skyBackgroundTraitsData() const { return (OdGiSkyBackgroundTraitsData*)m_pBackgroundTraits; }

  /** \details
    Retrieves pointer to background traits of an image-based lighting background.
  */
  OdGiIBLBackgroundTraitsData* iblBackgroundTraitsData() const { return (OdGiIBLBackgroundTraitsData*)m_pBackgroundTraits; }

  /** \details
    Retrieves pointer to background traits of an environment background.
  */
  OdGiEnvironmentBackgroundTraitsData* environmentBackgroundTraitsData() const { return (OdGiEnvironmentBackgroundTraitsData*)m_pBackgroundTraits; }

  /** \details
    Retrieves pointer to background traits of an custom background.
  */
  OdGiCustomBackgroundTraitsData* customBackgroundTraitsData() const { return (OdGiCustomBackgroundTraitsData*)m_pBackgroundTraits; }

  /** \details
    Retrieves pointer to background traits of the underlying background.
  */
  OdGiBackgroundTraitsData* backgroundTraitsData() const { return m_pBackgroundTraits; }

  /** \details
    Retrieves background type of the underlying background.
  */
  OdGiDrawable::DrawableType backgroundType() const { return (m_pBackgroundTraits) ? m_pBackgroundTraits->type() : OdGiDrawable::kGeometry; }

  /** \details
    Retrieves pointer to the secondary background.
  */
  const OdGsBackgroundProperties *secondaryBackground() const { return m_pSecondaryBackground.get(); }

  /** \details
    Retrieves pointer to the secondary background.
  */
  OdGsBackgroundProperties *secondaryBackground() { return m_pSecondaryBackground.get(); }

  /** \details
    Checks whether background traits is modified.
    \returns
    true if background traits are modified, false otherwise.
  */
  bool isTraitsModified();

  /** \details
    Clears background traits.
  */
  void clearTraits();

  // OdGsProperties virtual overrides

  /** \details
    Retrieves property type of this object which is PropertiesType::kBackground.
  */
  virtual PropertiesType propertiesType() const
  {
    return kBackground;
  }

  /** \details
    Retrieves smart pointer to properties of the background by the specified property type.
    \param type [in]  Property type.
  */
  virtual OdSmartPtr<OdGsProperties> propertiesForType(PropertiesType type) const;

  virtual void update(const OdGiDrawable* pUnderlyingDrawable,
      OdGsViewImpl* view, OdUInt32 incFlags = kAll);

  virtual void display(OdGsBaseVectorizer& view,
      OdGsPropertiesDirectRenderOutput *pdro = NULL, OdUInt32 incFlags = kAll);
};

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

#include "TD_PackPop.h"

#endif // __OD_GS_BACKGROUND_PROPERTIES__