0031456: Visualization - move out Dimensions and Relations from package AIS to PrsDims
[occt.git] / src / PrsDim / PrsDim_FixRelation.hxx
CommitLineData
42cf5bc1 1// Created on: 1996-12-05
2// Created by: Flore Lantheaume/Odile Olivier
3// Copyright (c) 1996-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
787ff240 17#ifndef _PrsDim_FixRelation_HeaderFile
18#define _PrsDim_FixRelation_HeaderFile
42cf5bc1 19
42cf5bc1 20#include <TopoDS_Wire.hxx>
787ff240 21#include <PrsDim_Relation.hxx>
42cf5bc1 22
7dd7c146 23class Geom_Plane;
42cf5bc1 24
787ff240 25DEFINE_STANDARD_HANDLE(PrsDim_FixRelation, PrsDim_Relation)
42cf5bc1 26
27//! Constructs and manages a constraint by a fixed
28//! relation between two or more interactive datums. This
29//! constraint is represented by a wire from a shape -
30//! point, vertex, or edge - in the first datum and a
31//! corresponding shape in the second.
32//! Warning: This relation is not bound with any kind of parametric
33//! constraint : it represents the "status" of an parametric
34//! object.
787ff240 35class PrsDim_FixRelation : public PrsDim_Relation
42cf5bc1 36{
787ff240 37 DEFINE_STANDARD_RTTIEXT(PrsDim_FixRelation, PrsDim_Relation)
42cf5bc1 38public:
42cf5bc1 39
40 //! initializes the vertex aShape, the
41 //! plane aPlane and the wire aWire, which connects
42 //! the two vertices in a fixed relation.
787ff240 43 Standard_EXPORT PrsDim_FixRelation(const TopoDS_Shape& aShape, const Handle(Geom_Plane)& aPlane, const TopoDS_Wire& aWire);
42cf5bc1 44
45 //! initializes the vertex aShape, the
46 //! plane aPlane and the wire aWire, the position
47 //! aPosition, the arrow size anArrowSize and the
48 //! wire aWire, which connects the two vertices in a fixed relation.
787ff240 49 Standard_EXPORT PrsDim_FixRelation(const TopoDS_Shape& aShape, const Handle(Geom_Plane)& aPlane, const TopoDS_Wire& aWire, const gp_Pnt& aPosition, const Standard_Real anArrowSize = 0.01);
42cf5bc1 50
51 //! initializes the edge aShape and the plane aPlane.
787ff240 52 Standard_EXPORT PrsDim_FixRelation(const TopoDS_Shape& aShape, const Handle(Geom_Plane)& aPlane);
42cf5bc1 53
54 //! initializes the edge aShape, the
55 //! plane aPlane, the position aPosition and the arrow
56 //! size anArrowSize.
787ff240 57 Standard_EXPORT PrsDim_FixRelation(const TopoDS_Shape& aShape, const Handle(Geom_Plane)& aPlane, const gp_Pnt& aPosition, const Standard_Real anArrowSize = 0.01);
42cf5bc1 58
59 //! Returns the wire which connects vertices in a fixed relation.
787ff240 60 const TopoDS_Wire& Wire() { return myWire; }
42cf5bc1 61
62 //! Constructs the wire aWire. This connects vertices
63 //! which are in a fixed relation.
787ff240 64 void SetWire (const TopoDS_Wire& aWire) { myWire = aWire; }
42cf5bc1 65
66 //! Returns true if the Interactive Objects in the relation
67 //! are movable.
b31fbc83 68 virtual Standard_Boolean IsMovable() const Standard_OVERRIDE { return Standard_True; }
42cf5bc1 69
42cf5bc1 70private:
42cf5bc1 71
787ff240 72 Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& aPresentationManager, const Handle(Prs3d_Presentation)& aPresentation, const Standard_Integer aMode = 0) Standard_OVERRIDE;
42cf5bc1 73
42cf5bc1 74 Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode) Standard_OVERRIDE;
75
76 //! computes the presentation for <myFixShape> if it's a
77 //! vertex.
78 Standard_EXPORT void ComputeVertex (const TopoDS_Vertex& FixVertex, gp_Pnt& curpos);
79
80 Standard_EXPORT gp_Pnt ComputePosition (const Handle(Geom_Curve)& curv1, const Handle(Geom_Curve)& curv2, const gp_Pnt& firstp1, const gp_Pnt& lastp1, const gp_Pnt& firstp2, const gp_Pnt& lastp2) const;
81
82 Standard_EXPORT gp_Pnt ComputePosition (const Handle(Geom_Curve)& curv, const gp_Pnt& firstp, const gp_Pnt& lastp) const;
83
84 //! computes the presentation for <myFixShape> if it's a
85 //! edge.
86 Standard_EXPORT void ComputeEdge (const TopoDS_Edge& FixEdge, gp_Pnt& curpos);
87
88 Standard_EXPORT void ComputeLinePosition (const gp_Lin& glin, gp_Pnt& pos, Standard_Real& pfirst, Standard_Real& plast);
89
90 Standard_EXPORT void ComputeCirclePosition (const gp_Circ& gcirc, gp_Pnt& pos, Standard_Real& pfirst, Standard_Real& plast);
91
92 Standard_EXPORT static Standard_Boolean ConnectedEdges (const TopoDS_Wire& aWire, const TopoDS_Vertex& aVertex, TopoDS_Edge& Edge1, TopoDS_Edge& Edge2);
93
787ff240 94private:
95
42cf5bc1 96 TopoDS_Wire myWire;
97 gp_Pnt myPntAttach;
98
42cf5bc1 99};
100
787ff240 101#endif // _PrsDim_FixRelation_HeaderFile