include/opencascade/IGESDraw_ViewsVisible.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
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_ViewsVisible_HeaderFile
0018 #define _IGESDraw_ViewsVisible_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESDraw_HArray1OfViewKindEntity.hxx>
0023 #include <IGESData_HArray1OfIGESEntity.hxx>
0024 #include <IGESData_ViewKindEntity.hxx>
0025 #include <Standard_Integer.hxx>
0026 class IGESData_IGESEntity;
0027
0028
0029 class IGESDraw_ViewsVisible;
0030 DEFINE_STANDARD_HANDLE(IGESDraw_ViewsVisible, IGESData_ViewKindEntity)
0031
0032 //! Defines IGESViewsVisible, Type <402>, Form <3>
0033 //! in package IGESDraw
0034 //!
0035 //! If an entity is to be displayed in more than one views,
0036 //! this class instance is used, which contains the Visible
0037 //! views and the associated entity Displays.
0038 class IGESDraw_ViewsVisible : public IGESData_ViewKindEntity
0039 {
0040
0041 public:
0042
0043
0044   Standard_EXPORT IGESDraw_ViewsVisible();
0045
0046   //! This method is used to set the fields of the class
0047   //! ViewsVisible
0048   //! - allViewEntities  : All View kind entities
0049   //! - allDisplayEntity : All entities whose display is specified
0050   Standard_EXPORT void Init (const Handle(IGESDraw_HArray1OfViewKindEntity)& allViewEntities, const Handle(IGESData_HArray1OfIGESEntity)& allDisplayEntity);
0051
0052   //! Changes only the list of Displayed Entities (Null allowed)
0053   Standard_EXPORT void InitImplied (const Handle(IGESData_HArray1OfIGESEntity)& allDisplayEntity);
0054
0055   //! Returns False (for a complex view)
0056   Standard_EXPORT Standard_Boolean IsSingle() const Standard_OVERRIDE;
0057
0058   //! returns the Number of views visible
0059   Standard_EXPORT Standard_Integer NbViews() const Standard_OVERRIDE;
0060
0061   //! returns the number of entities displayed in the Views or zero if
0062   //! no Entities specified in these Views
0063   Standard_EXPORT Standard_Integer NbDisplayedEntities() const;
0064
0065   //! returns the Index'th ViewKindEntity Entity
0066   //! raises exception if Index  <= 0 or Index > NbViewsVisible()
0067   Standard_EXPORT Handle(IGESData_ViewKindEntity) ViewItem (const Standard_Integer Index) const Standard_OVERRIDE;
0068
0069   //! returns the Index'th entity whose display is being specified by
0070   //! this associativity instance
0071   //! raises exception if Index  <= 0 or Index > NbEntityDisplayed()
0072   Standard_EXPORT Handle(IGESData_IGESEntity) DisplayedEntity (const Standard_Integer Index) const;
0073
0074
0075
0076
0077   DEFINE_STANDARD_RTTIEXT(IGESDraw_ViewsVisible,IGESData_ViewKindEntity)
0078
0079 protected:
0080
0081
0082
0083
0084 private:
0085
0086
0087   Handle(IGESDraw_HArray1OfViewKindEntity) theViewEntities;
0088   Handle(IGESData_HArray1OfIGESEntity) theDisplayEntity;
0089
0090
0091 };
0092
0093
0094
0095
0096
0097
0098
0099 #endif // _IGESDraw_ViewsVisible_HeaderFile