include/opencascade/TPrsStd_Driver.hxx

0001 // Created on: 1997-08-01
0002 // Created by: SMO
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TPrsStd_Driver_HeaderFile
0018 #define _TPrsStd_Driver_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 class TDF_Label;
0025 class AIS_InteractiveObject;
0026
0027
0028 class TPrsStd_Driver;
0029 DEFINE_STANDARD_HANDLE(TPrsStd_Driver, Standard_Transient)
0030
0031 //! Driver for AIS
0032 //! ==============
0033 //! An abstract class, which - in classes inheriting
0034 //! from it - allows you to update an
0035 //! AIS_InteractiveObject or create one if one does
0036 //! not already exist.
0037 //! For both creation and update, the interactive
0038 //! object is filled with information contained in
0039 //! attributes. These attributes are those found on
0040 //! the label given as an argument in the method Update.
0041 //! true is returned if the interactive object was modified by the update.
0042 //! This class  provide  an algorithm  to  Build with its  default
0043 //! values (if Null) or Update (if !Null) an AIS_InteractiveObject
0044 //! .   Resources are found  in  attributes associated to  a given
0045 //! label.
0046 class TPrsStd_Driver : public Standard_Transient
0047 {
0048
0049 public:
0050
0051
0052
0053   //! Updates the interactive object ais with
0054   //! information found on the attributes associated with the label L.
0055   Standard_EXPORT virtual Standard_Boolean Update (const TDF_Label& L, Handle(AIS_InteractiveObject)& ais) = 0;
0056
0057
0058
0059
0060   DEFINE_STANDARD_RTTIEXT(TPrsStd_Driver,Standard_Transient)
0061
0062 protected:
0063
0064
0065   Standard_EXPORT TPrsStd_Driver();
0066
0067
0068
0069 private:
0070
0071
0072
0073
0074 };
0075
0076
0077
0078
0079
0080
0081
0082 #endif // _TPrsStd_Driver_HeaderFile