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