include/opencascade/IGESDraw_ToolViewsVisible.hxx

0001 // Created on: 1993-10-14
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1993-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 _IGESDraw_ToolViewsVisible_HeaderFile
0018 #define _IGESDraw_ToolViewsVisible_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Integer.hxx>
0025 class IGESDraw_ViewsVisible;
0026 class IGESData_IGESReaderData;
0027 class IGESData_ParamReader;
0028 class IGESData_IGESWriter;
0029 class Interface_EntityIterator;
0030 class IGESData_DirChecker;
0031 class Interface_ShareTool;
0032 class Interface_Check;
0033 class Interface_CopyTool;
0034 class IGESData_IGESDumper;
0035
0036 //! Tool to work on a ViewsVisible. Called by various Modules
0037 //! (ReadWriteModule, GeneralModule, SpecificModule)
0038 class IGESDraw_ToolViewsVisible
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   //! Returns a ToolViewsVisible, ready to work
0044   Standard_EXPORT IGESDraw_ToolViewsVisible();
0045
0046   //! Reads own parameters from file. <PR> gives access to them,
0047   //! <IR> detains parameter types and values
0048   Standard_EXPORT void ReadOwnParams(const Handle(IGESDraw_ViewsVisible)&   ent,
0049                                      const Handle(IGESData_IGESReaderData)& IR,
0050                                      IGESData_ParamReader&                  PR) const;
0051
0052   //! Writes own parameters to IGESWriter
0053   Standard_EXPORT void WriteOwnParams(const Handle(IGESDraw_ViewsVisible)& ent,
0054                                       IGESData_IGESWriter&                 IW) const;
0055
0056   //! Lists the Entities shared by a ViewsVisible <ent>, from
0057   //! its specific (own) parameters shared not implied (the Views)
0058   Standard_EXPORT void OwnShared(const Handle(IGESDraw_ViewsVisible)& ent,
0059                                  Interface_EntityIterator&            iter) const;
0060
0061   //! Lists the Entities shared by a ViewsVisible <ent>, from
0062   //! its specific (own) implied parameters : the Displayed Entities
0063   Standard_EXPORT void OwnImplied(const Handle(IGESDraw_ViewsVisible)& ent,
0064                                   Interface_EntityIterator&            iter) const;
0065
0066   //! Returns specific DirChecker
0067   Standard_EXPORT IGESData_DirChecker DirChecker(const Handle(IGESDraw_ViewsVisible)& ent) const;
0068
0069   //! Performs Specific Semantic Check
0070   Standard_EXPORT void OwnCheck(const Handle(IGESDraw_ViewsVisible)& ent,
0071                                 const Interface_ShareTool&           shares,
0072                                 Handle(Interface_Check)&             ach) const;
0073
0074   //! Copies Specific Parameters shared not implied, i.e. all but
0075   //! the Displayed Entities
0076   Standard_EXPORT void OwnCopy(const Handle(IGESDraw_ViewsVisible)& entfrom,
0077                                const Handle(IGESDraw_ViewsVisible)& entto,
0078                                Interface_CopyTool&                  TC) const;
0079
0080   //! Copies Specific implied Parameters : the Displayed Entities
0081   //! which have already been copied
0082   Standard_EXPORT void OwnRenew(const Handle(IGESDraw_ViewsVisible)& entfrom,
0083                                 const Handle(IGESDraw_ViewsVisible)& entto,
0084                                 const Interface_CopyTool&            TC) const;
0085
0086   //! Clears specific implied parameters, which cause looping
0087   //! structures; required for deletion
0088   Standard_EXPORT void OwnWhenDelete(const Handle(IGESDraw_ViewsVisible)& ent) const;
0089
0090   //! Dump of Specific Parameters
0091   Standard_EXPORT void OwnDump(const Handle(IGESDraw_ViewsVisible)& ent,
0092                                const IGESData_IGESDumper&           dumper,
0093                                Standard_OStream&                    S,
0094                                const Standard_Integer               own) const;
0095
0096   //! Sets automatic unambiguous Correction on a ViewsVisible
0097   //! (all displayed entities must refer to <ent> in directory part,
0098   //! else the list is cleared)
0099   Standard_EXPORT Standard_Boolean OwnCorrect(const Handle(IGESDraw_ViewsVisible)& ent) const;
0100
0101 protected:
0102 private:
0103 };
0104
0105 #endif // _IGESDraw_ToolViewsVisible_HeaderFile