include/opencascade/AIS_AnimationAxisRotation.hxx

0001 // Copyright (c) 2023 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _AIS_AnimationAxisRotation_HeaderFile
0015 #define _AIS_AnimationAxisRotation_HeaderFile
0016
0017 #include <AIS_BaseAnimationObject.hxx>
0018 #include <gp_TrsfNLerp.hxx>
0019
0020 //! Animation defining object transformation.
0021 class AIS_AnimationAxisRotation : public AIS_BaseAnimationObject
0022 {
0023   DEFINE_STANDARD_RTTIEXT(AIS_AnimationAxisRotation, AIS_BaseAnimationObject)
0024 public:
0025
0026   //! Constructor with initialization.
0027   //! @param[in] theAnimationName animation identifier
0028   //! @param[in] theContext       interactive context where object have been displayed
0029   //! @param[in] theObject        object to apply rotation
0030   //! @param[in] theAxis          rotation axis
0031   //! @param[in] theAngleStart    rotation angle at the start of animation
0032   //! @param[in] theAngleEnd      rotation angle at the end   of animation
0033   Standard_EXPORT AIS_AnimationAxisRotation (const TCollection_AsciiString& theAnimationName,
0034                                              const Handle(AIS_InteractiveContext)& theContext,
0035                                              const Handle(AIS_InteractiveObject)& theObject,
0036                                              const gp_Ax1& theAxis,
0037                                              const Standard_Real theAngleStart,
0038                                              const Standard_Real theAngleEnd);
0039
0040 protected:
0041
0042   //! Update the progress.
0043   Standard_EXPORT virtual void update (const AIS_AnimationProgress& theProgress) Standard_OVERRIDE;
0044
0045 private:
0046
0047   gp_Ax1         myRotAxis;     //!< rotation axis
0048   Standard_Real  myAngleStart;  //!< start angle for rotation
0049   Standard_Real  myAngleEnd;    //!< end angle for rotation
0050
0051 };
0052
0053 #endif // _AIS_AnimationAxisRotation_HeaderFile