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 //! Driver for AIS
0028 //! ==============
0029 //! An abstract class, which - in classes inheriting
0030 //! from it - allows you to update an
0031 //! AIS_InteractiveObject or create one if one does
0032 //! not already exist.
0033 //! For both creation and update, the interactive
0034 //! object is filled with information contained in
0035 //! attributes. These attributes are those found on
0036 //! the label given as an argument in the method Update.
0037 //! true is returned if the interactive object was modified by the update.
0038 //! This class provide an algorithm to Build with its default
0039 //! values (if Null) or Update (if !Null) an AIS_InteractiveObject.
0040 //! Resources are found in attributes associated to a given
0041 //! label.
0042 class TPrsStd_Driver : public Standard_Transient
0043 {
0044
0045 public:
0046   //! Updates the interactive object ais with
0047   //! information found on the attributes associated with the label L.
0048   Standard_EXPORT virtual bool Update(const TDF_Label&                    L,
0049                                       occ::handle<AIS_InteractiveObject>& ais) = 0;
0050
0051   DEFINE_STANDARD_RTTIEXT(TPrsStd_Driver, Standard_Transient)
0052
0053 protected:
0054   Standard_EXPORT TPrsStd_Driver();
0055 };
0056
0057 #endif // _TPrsStd_Driver_HeaderFile