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

#include "NwSavedItem.h"
#include "NwTimeLinerTypes.h"

class OdNwTimeLinerSimulationStatus;

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

/**
 This class represents timeliner setting item.
 
 <group OdNw_Classes>
*/
class NWDBEXPORT OdNwTimeLinerSettingsItem : public OdNwSavedItem
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwTimeLinerSettingsItem);
  //DOM-IGNORE-END
public:
  /** \details
    Default constructor.
  */
  OdNwTimeLinerSettingsItem();

  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwTimeLinerSettingsItem();
  
  /** \details
    Returns simulation appearance mode for this status.

    \returns One of the enumerated items from the NwTimeLinerSettingsAppearanceMode::Enum enumerated type.
    \remarks
    If appearance mode is set to MANUAL then appearance name must name a valid simulation appearance.
 
    The returned type can be one of the following:

    <table>
    Name                                               Value   Description
    NwTimeLinerSettingsAppearanceMode::NONE              0     Any attached models will be unaffected.
    NwTimeLinerSettingsAppearanceMode::MODEL_APPEARANCE  1     Any attached models will appear as regular model.
    NwTimeLinerSettingsAppearanceMode::HIDE              2     Any attached models will be hidden during simulation.
    NwTimeLinerSettingsAppearanceMode::MANUAL            3     Any attached models will be coloured.
    </table>
  */
  NwTimeLinerSettingsAppearanceMode::Enum getAppearanceMode() const;
  
  /** \details
    Returns name of the simulation appearance name.

    \returns OdString type value containig appearance name.
    \remarks
    Method getAppearanceMode must be returns NwTimeLinerSettingsAppearanceMode::MANUAL.
  */
  OdString getAppearanceName() const;
  
  
  /** \details
    Returns pointer to timeliner simulation status instance.

    \returns OdNwTimeLinerSimulationStatusPtr object to timeliner simulation status instance.
  */
  OdNwTimeLinerSimulationStatusPtr getSimulationStatus();
};

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

#endif /* __NW_TIME_LINER_SETTINGS_ITEM_H__ */