include/opencascade/AIS_BaseAnimationObject.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_BaseAnimationObject_HeaderFile
0015 #define _AIS_BaseAnimationObject_HeaderFile
0016
0017 #include <AIS_Animation.hxx>
0018 #include <AIS_InteractiveContext.hxx>
0019
0020 //! Animation defining object transformation.
0021 class AIS_BaseAnimationObject : public AIS_Animation
0022 {
0023   DEFINE_STANDARD_RTTIEXT(AIS_BaseAnimationObject, AIS_Animation)
0024 protected:
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 local transformation
0030   Standard_EXPORT AIS_BaseAnimationObject (const TCollection_AsciiString& theAnimationName,
0031                                            const Handle(AIS_InteractiveContext)& theContext,
0032                                            const Handle(AIS_InteractiveObject)&  theObject);
0033
0034   //! Update the transformation.
0035   Standard_EXPORT void updateTrsf (const gp_Trsf& theTrsf);
0036
0037 private:
0038
0039   //! Invalidate the viewer for proper update.
0040   Standard_EXPORT void invalidateViewer();
0041
0042 protected:
0043
0044   Handle(AIS_InteractiveContext) myContext;   //!< context where object is displayed
0045   Handle(AIS_InteractiveObject)  myObject;    //!< presentation object to set location
0046
0047 };
0048
0049 #endif // _AIS_BaseAnimationObject_HeaderFile