include/opencascade/IGESDraw_LabelDisplay.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( TCD )
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_LabelDisplay_HeaderFile
0018 #define _IGESDraw_LabelDisplay_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESDraw_HArray1OfViewKindEntity.hxx>
0024 #include <TColgp_HArray1OfXYZ.hxx>
0025 #include <IGESDimen_HArray1OfLeaderArrow.hxx>
0026 #include <TColStd_HArray1OfInteger.hxx>
0027 #include <IGESData_HArray1OfIGESEntity.hxx>
0028 #include <IGESData_LabelDisplayEntity.hxx>
0029 #include <Standard_Integer.hxx>
0030 class IGESData_ViewKindEntity;
0031 class gp_Pnt;
0032 class IGESDimen_LeaderArrow;
0033 class IGESData_IGESEntity;
0034
0035 class IGESDraw_LabelDisplay;
0036 DEFINE_STANDARD_HANDLE(IGESDraw_LabelDisplay, IGESData_LabelDisplayEntity)
0037
0038 //! defines IGESLabelDisplay, Type <402> Form <5>
0039 //! in package IGESDraw
0040 //!
0041 //! Permits one or more displays for the
0042 //! entity labels of an entity
0043 class IGESDraw_LabelDisplay : public IGESData_LabelDisplayEntity
0044 {
0045
0046 public:
0047   Standard_EXPORT IGESDraw_LabelDisplay();
0048
0049   //! This method is used to set the fields of the class
0050   //! LabelDisplay
0051   //! - allViews             : Pointers to View Entities
0052   //! - allTextLocations     : Coordinates of text locations in the views
0053   //! - allLeaderEntities    : Pointers to Leader Entities in the views
0054   //! - allLabelLevels       : Entity label level numbers in the views
0055   //! - allDisplayedEntities : Pointers to the entities being displayed
0056   //! raises exception if Lengths of allViews, allTextLocations,
0057   //! allLeaderEntities, allLabelLevels and allDisplayedEntities are
0058   //! not same.
0059   Standard_EXPORT void Init(const Handle(IGESDraw_HArray1OfViewKindEntity)& allViews,
0060                             const Handle(TColgp_HArray1OfXYZ)&              allTextLocations,
0061                             const Handle(IGESDimen_HArray1OfLeaderArrow)&   allLeaderEntities,
0062                             const Handle(TColStd_HArray1OfInteger)&         allLabelLevels,
0063                             const Handle(IGESData_HArray1OfIGESEntity)&     allDisplayedEntities);
0064
0065   //! returns the number of label placements in <me>
0066   Standard_EXPORT Standard_Integer NbLabels() const;
0067
0068   //! returns the View entity indicated by ViewIndex
0069   //! raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().
0070   Standard_EXPORT Handle(IGESData_ViewKindEntity) ViewItem(const Standard_Integer ViewIndex) const;
0071
0072   //! returns the 3d-Point coordinates of the text location, in the
0073   //! view indicated by ViewIndex
0074   //! raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().
0075   Standard_EXPORT gp_Pnt TextLocation(const Standard_Integer ViewIndex) const;
0076
0077   //! returns the Leader entity in the view indicated by ViewIndex
0078   //! raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().
0079   Standard_EXPORT Handle(IGESDimen_LeaderArrow) LeaderEntity(
0080     const Standard_Integer ViewIndex) const;
0081
0082   //! returns the Entity label level number in the view indicated
0083   //! by ViewIndex
0084   //! raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().
0085   Standard_EXPORT Standard_Integer LabelLevel(const Standard_Integer ViewIndex) const;
0086
0087   //! returns the entity indicated by EntityIndex
0088   //! raises an exception if EntityIndex <= 0 or EntityIndex > NbLabels().
0089   Standard_EXPORT Handle(IGESData_IGESEntity) DisplayedEntity(
0090     const Standard_Integer EntityIndex) const;
0091
0092   //! returns the transformed 3d-Point coordinates of the text
0093   //! location, in the view indicated by ViewIndex
0094   //! raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().
0095   Standard_EXPORT gp_Pnt TransformedTextLocation(const Standard_Integer ViewIndex) const;
0096
0097   DEFINE_STANDARD_RTTIEXT(IGESDraw_LabelDisplay, IGESData_LabelDisplayEntity)
0098
0099 protected:
0100 private:
0101   Handle(IGESDraw_HArray1OfViewKindEntity) theViews;
0102   Handle(TColgp_HArray1OfXYZ)              theTextLocations;
0103   Handle(IGESDimen_HArray1OfLeaderArrow)   theLeaderEntities;
0104   Handle(TColStd_HArray1OfInteger)         theLabelLevels;
0105   Handle(IGESData_HArray1OfIGESEntity)     theDisplayedEntities;
0106 };
0107
0108 #endif // _IGESDraw_LabelDisplay_HeaderFile