///////////////////////////////////////////////////////////////////////////////
// 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_SAVEDANIMSELECTANIM_H__
#define __NW_SAVEDANIMSELECTANIM_H__

#include "NwObject.h"
#include "NwSavedAnimGroup.h"
/**
 This class represents animation set.
 
 <group OdNw_Classes>
*/
class NWDBEXPORT OdNwSavedAnimSelectAnim : public OdNwSavedAnimGroup
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwSavedAnimSelectAnim);
  //DOM-IGNORE-END
public:
  /** \details
    Default constructor.
  */
  OdNwSavedAnimSelectAnim();

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

  /** \details
    Receives the list of the selected model items which the transformations will apply for.
    
    \returns List of OdNwObjectId of the OdNwModelItem objects.
    \remarks
    For NWD and NWC files the method returns object IDs of model items.
    For NWF file the method returns an OdNwObjectId from external embedded database, if Xref model has NWD or NWC type in the same directory with NWF file.
    Returns empty OdNwObjectIds otherwise.
  */
  OdNwObjectIdArray getModelItem() const;

  /** \details
   Adds key frame to Selected Object Animation.
   \param time [in] time of keyframe.
   \param pRes [out] Receives eOk if the appending operation is successful, or an appropriate error code otherwise.
   \returns OdNwObjectId with an OdNwSavedAnimSelectKeyFrame derived object.
  */
  OdNwObjectId addKeyFrame(double time, OdResult* pRes = nullptr);
  
  /** \details
   Sets a list of models to Animation Set.
   \param modelItemList [in] List of OdNwObjectId of the OdNwModelItem objects.
  */
  void setModelItemList(const OdNwObjectIdArray& modelItemList);
};

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

#endif /* __NW_SAVEDANIMSELECTANIM_H__ */