0031431: Visualization, PrsMgr_PresentableObject - simplify HLR computing interface
[occt.git] / src / AIS / AIS_EqualDistanceRelation.hxx
1 // Created on: 1998-01-24
2 // Created by: Julia GERASIMOVA
3 // Copyright (c) 1998-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _AIS_EqualDistanceRelation_HeaderFile
18 #define _AIS_EqualDistanceRelation_HeaderFile
19
20 #include <AIS_Relation.hxx>
21 #include <AIS_TypeOfDist.hxx>
22 #include <DsgPrs_ArrowSide.hxx>
23
24 class Geom_Plane;
25
26 DEFINE_STANDARD_HANDLE(AIS_EqualDistanceRelation, AIS_Relation)
27
28 //! A framework to display equivalent distances between
29 //! shapes and a given plane.
30 //! The distance is the length of a projection from the
31 //! shape to the plane.
32 //! These distances are used to compare shapes by this vector alone.
33 class AIS_EqualDistanceRelation : public AIS_Relation
34 {
35   DEFINE_STANDARD_RTTIEXT(AIS_EqualDistanceRelation,AIS_Relation)
36 public:
37
38   //! Constructs a framework to display equivalent
39   //! distances between the shapes aShape1, aShape2,
40   //! aShape3, aShape4 and the plane aPlane.
41   //! The distance is the length of a projection from the
42   //! shape to the plane.
43   Standard_EXPORT AIS_EqualDistanceRelation(const TopoDS_Shape& aShape1, const TopoDS_Shape& aShape2, const TopoDS_Shape& aShape3, const TopoDS_Shape& aShape4, const Handle(Geom_Plane)& aPlane);
44   
45
46   //! Sets the shape aShape to be used as the shape
47   //! aShape3 in the framework created at construction time.
48     void SetShape3 (const TopoDS_Shape& aShape);
49   
50
51   //! Returns the shape aShape3 from the framework
52   //! created at construction time.
53     const TopoDS_Shape& Shape3() const;
54   
55
56   //! Sets the shape aShape to be used as the shape
57   //! aShape4 in the framework created at construction time.
58     void SetShape4 (const TopoDS_Shape& aShape);
59   
60
61   //! Returns the shape aShape4 from the framework
62   //! created at construction time.
63     const TopoDS_Shape& Shape4() const;
64
65   //! Computes the location of an intreval between
66   //! between two edges. FirstAttach , SecondAttach
67   //! are the returned extreme points of the interval.
68   Standard_EXPORT static void ComputeTwoEdgesLength (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Real ArrowSize, const TopoDS_Edge& FirstEdge, const TopoDS_Edge& SecondEdge, const Handle(Geom_Plane)& Plane, const Standard_Boolean AutomaticPos, const Standard_Boolean IsSetBndBox, const Bnd_Box& BndBox, gp_Pnt& Position, gp_Pnt& FirstAttach, gp_Pnt& SecondAttach, gp_Pnt& FirstExtreme, gp_Pnt& SecondExtreme, DsgPrs_ArrowSide& SymbolPrs);
69   
70   //! Computes the interval position between two vertexs. FirstAttach,
71   //! SecondAttach are the returned extreme points of the interval.
72   Standard_EXPORT static void ComputeTwoVerticesLength (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Real ArrowSize, const TopoDS_Vertex& FirstVertex, const TopoDS_Vertex& SecondVertex, const Handle(Geom_Plane)& Plane, const Standard_Boolean AutomaticPos, const Standard_Boolean IsSetBndBox, const Bnd_Box& BndBox, const AIS_TypeOfDist TypeDist, gp_Pnt& Position, gp_Pnt& FirstAttach, gp_Pnt& SecondAttach, gp_Pnt& FirstExtreme, gp_Pnt& SecondExtreme, DsgPrs_ArrowSide& SymbolPrs);
73   
74   //! Compute the interval location between a vertex and an edge. Edge may be
75   //! a line or a circle.
76   Standard_EXPORT static void ComputeOneEdgeOneVertexLength (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const Standard_Real ArrowSize, const TopoDS_Shape& FirstShape, const TopoDS_Shape& SecondShape, const Handle(Geom_Plane)& Plane, const Standard_Boolean AutomaticPos, const Standard_Boolean IsSetBndBox, const Bnd_Box& BndBox, gp_Pnt& Position, gp_Pnt& FirstAttach, gp_Pnt& SecondAttach, gp_Pnt& FirstExtreme, gp_Pnt& SecondExtreme, DsgPrs_ArrowSide& SymbolPrs);
77
78 private:
79
80   Standard_EXPORT void Compute (const Handle(PrsMgr_PresentationManager3d)& aPresentationManager, const Handle(Prs3d_Presentation)& aPresentation, const Standard_Integer aMode = 0) Standard_OVERRIDE;
81   
82   Standard_EXPORT void ComputeSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode) Standard_OVERRIDE;
83
84   TopoDS_Shape myShape3;
85   TopoDS_Shape myShape4;
86   gp_Pnt myAttachPoint1;
87   gp_Pnt myAttachPoint2;
88   gp_Pnt myAttachPoint3;
89   gp_Pnt myAttachPoint4;
90   gp_Pnt myPoint1;
91   gp_Pnt myPoint2;
92   gp_Pnt myPoint3;
93   gp_Pnt myPoint4;
94
95 };
96
97 #include <AIS_EqualDistanceRelation.lxx>
98
99 #endif // _AIS_EqualDistanceRelation_HeaderFile