/////////////////////////////////////////////////////////////////////////////// 
// 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_SPEED_ELEMENT_H__
#define __TNW_SPEED_ELEMENT_H__

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

class OdNwColor;

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

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

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

public:

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

public:

  /** \details
    Animation framerate as frames per second.

    \returns The animation framerate. It must be in the range 1..60
  */
  OdUInt8 getFramerate() const;

  /** \details
    Sets the partial viewing's fixed frame rate value of animation.

    \param frameRateInHz [in]  Frames/second.

    \returns eOk if the frame rate is set successfully, or an
    appropriate error code otherwise.

    \remarks
    A frame rate must be in the range 1..60.
    */
  OdResult setFramerate(OdUInt8 frameRateInHz);
};

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

#endif //__TNW_SPEED_ELEMENT_H__