include/opencascade/ShapeCustom_Modification.hxx

0001 // Copyright (c) 2003-2014 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 _ShapeCustom_Modification_HeaderFile
0015 #define _ShapeCustom_Modification_HeaderFile
0016
0017 #include <Standard.hxx>
0018 #include <Standard_Type.hxx>
0019
0020 #include <BRepTools_Modification.hxx>
0021 #include <Message_Gravity.hxx>
0022 class ShapeExtend_BasicMsgRegistrator;
0023 class TopoDS_Shape;
0024 class Message_Msg;
0025
0026
0027 class ShapeCustom_Modification;
0028 DEFINE_STANDARD_HANDLE(ShapeCustom_Modification, BRepTools_Modification)
0029
0030 //! A base class of Modification's from ShapeCustom.
0031 //! Implements message sending mechanism.
0032 class ShapeCustom_Modification : public BRepTools_Modification
0033 {
0034
0035 public:
0036
0037
0038   //! Sets message registrator
0039   Standard_EXPORT virtual void SetMsgRegistrator (const Handle(ShapeExtend_BasicMsgRegistrator)& msgreg);
0040
0041   //! Returns message registrator
0042   Standard_EXPORT Handle(ShapeExtend_BasicMsgRegistrator) MsgRegistrator() const;
0043
0044   //! Sends a message to be attached to the shape.
0045   //! Calls corresponding message of message registrator.
0046   Standard_EXPORT void SendMsg (const TopoDS_Shape& shape, const Message_Msg& message, const Message_Gravity gravity = Message_Info) const;
0047
0048
0049
0050
0051   DEFINE_STANDARD_RTTIEXT(ShapeCustom_Modification,BRepTools_Modification)
0052
0053 protected:
0054
0055
0056
0057
0058 private:
0059
0060
0061   Handle(ShapeExtend_BasicMsgRegistrator) myMsgReg;
0062
0063
0064 };
0065
0066
0067
0068
0069
0070
0071
0072 #endif // _ShapeCustom_Modification_HeaderFile