///////////////////////////////////////////////////////////////////////////////
// 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_GRYDSYSTEMELEMENT_H__
#define __TNW_GRYDSYSTEMELEMENT_H__

#include "NwObject.h"
#include "NwGridTypes.h"

class OdGeMatrix3d;
class OdNwGridSystem;

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

/** \details
  This class represents a system grid element.
 
  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwGridSystemElement : public OdNwObject
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwGridSystemElement);
  //DOM-IGNORE-END
public:
  /** \details
    Default constructor.
  */
  OdNwGridSystemElement();

  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwGridSystemElement();
  
  /** \details
    Gets an array of grid system smart pointers.

    \param grisSystemList [out] List of OdNwGridSystem smart pointers.
    \returns eOk if the sceneRefs are retrieved successfully, or an appropriate error code otherwise.
  */
  OdResult getGridSystemList(OdArray<OdNwGridSystemPtr>& grisSystemList) const;
  
  /** \details
    Gets an active Grid System.

    \returns Index of active grid system.
    \remarks
    Index of array from ::getGridSystemList
  */
  OdInt32 getActiveSystem() const;

  /** \details
    Gets a Grid mode.

    \returns Enum indicated current Grid render mode.
    \remarks
    Enum  NwGridMode::Enum
  */
  NwGridMode::Enum getGridMode() const;
  
  /** \details
    Adds a Grid System object.

    \param name [in] Name of Grid System.
    \param transform [in] Ttransformation matrix.
    \param pRes [out] Pointer to the OdResult object with the error code.
    \returns Smart pointer to created OdNwGridSystem object.
    \remarks
    Creates an OdNwGridSystem object and add it to array of OdNwGridSystemPtr objects in current object.
  */
  OdNwGridSystemPtr addGridSystem(const OdString& name, const OdGeMatrix3d& transform, OdResult* pResult = nullptr);

};

/** \details
  Virtual destructor. Frees allocated resources.
*/
typedef OdSmartPtr<OdNwGridSystemElement> OdNwGridSystemElementPtr;

#endif /* __TNW_GRYDSYSTEMELEMENT_H__ */