Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
IGESDraw_LabelDisplay Class Reference

defines IGESLabelDisplay, Type <402> Form <5>
in package IGESDraw

Permits one or more displays for the
entity labels of an entity

#include <IGESDraw_LabelDisplay.hxx>

Inheritance diagram for IGESDraw_LabelDisplay:
Inheritance graph
[legend]

Public Member Functions

 IGESDraw_LabelDisplay ()
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)
 This method is used to set the fields of the class
LabelDisplay

Standard_Integer NbLabels () const
 returns the number of label placements in <me>

Handle_IGESData_ViewKindEntity ViewItem (const Standard_Integer ViewIndex) const
 returns the View entity indicated by ViewIndex
raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

gp_Pnt TextLocation (const Standard_Integer ViewIndex) const
 returns the 3d-Point coordinates of the text location, in the
view indicated by ViewIndex
raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

Handle_IGESDimen_LeaderArrow LeaderEntity (const Standard_Integer ViewIndex) const
 returns the Leader entity in the view indicated by ViewIndex
raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

Standard_Integer LabelLevel (const Standard_Integer ViewIndex) const
 returns the Entity label level number in the view indicated
by ViewIndex
raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

Handle_IGESData_IGESEntity DisplayedEntity (const Standard_Integer EntityIndex) const
 returns the entity indicated by EntityIndex
raises an exception if EntityIndex <= 0 or EntityIndex > NbLabels().

gp_Pnt TransformedTextLocation (const Standard_Integer ViewIndex) const
 returns the transformed 3d-Point coordinates of the text
location, in the view indicated by ViewIndex
raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().


Constructor & Destructor Documentation


Member Function Documentation

Handle_IGESData_IGESEntity IGESDraw_LabelDisplay::DisplayedEntity ( const Standard_Integer  EntityIndex) const
  • allViews : Pointers to View Entities
  • allTextLocations : Coordinates of text locations in the views
  • allLeaderEntities : Pointers to Leader Entities in the views
  • allLabelLevels : Entity label level numbers in the views
  • allDisplayedEntities : Pointers to the entities being displayed
    raises exception if Lengths of allViews, allTextLocations,
    allLeaderEntities, allLabelLevels and allDisplayedEntities are
    not same.
Handle_IGESDimen_LeaderArrow IGESDraw_LabelDisplay::LeaderEntity ( const Standard_Integer  ViewIndex) const
Handle_IGESData_ViewKindEntity IGESDraw_LabelDisplay::ViewItem ( const Standard_Integer  ViewIndex) const

The documentation for this class was generated from the following file: