0031456: Visualization - move out Dimensions and Relations from package AIS to PrsDims
[occt.git] / src / PrsDim / PrsDim_SymmetricRelation.hxx
CommitLineData
42cf5bc1 1// Created on: 1997-03-03
2// Created by: Jean-Pierre COMBE
3// Copyright (c) 1997-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_SymmetricRelation_HeaderFile
18#define _PrsDim_SymmetricRelation_HeaderFile
42cf5bc1 19
42cf5bc1 20#include <TopoDS_Shape.hxx>
21#include <gp_Pnt.hxx>
22#include <gp_Dir.hxx>
787ff240 23#include <PrsDim_Relation.hxx>
42cf5bc1 24
787ff240 25DEFINE_STANDARD_HANDLE(PrsDim_SymmetricRelation, PrsDim_Relation)
42cf5bc1 26
27//! A framework to display constraints of symmetricity
28//! between two or more datum Interactive Objects.
29//! A plane serves as the axis of symmetry between the
30//! shapes of which the datums are parts.
787ff240 31class PrsDim_SymmetricRelation : public PrsDim_Relation
42cf5bc1 32{
787ff240 33 DEFINE_STANDARD_RTTIEXT(PrsDim_SymmetricRelation, PrsDim_Relation)
42cf5bc1 34public:
35
42cf5bc1 36 //! Constructs an object to display constraints of symmetricity.
37 //! This object is defined by a tool aSymmTool, a first
38 //! shape FirstShape, a second shape SecondShape, and a plane aPlane.
39 //! aPlane serves as the axis of symmetry.
40 //! aSymmTool is the shape composed of FirstShape
41 //! SecondShape and aPlane. It may be queried and
42 //! edited using the functions GetTool and SetTool.
43 //! The two shapes are typically two edges, two vertices or two points.
787ff240 44 Standard_EXPORT PrsDim_SymmetricRelation(const TopoDS_Shape& aSymmTool, const TopoDS_Shape& FirstShape, const TopoDS_Shape& SecondShape, const Handle(Geom_Plane)& aPlane);
42cf5bc1 45
46 //! Returns true if the symmetric constraint display is movable.
787ff240 47 virtual Standard_Boolean IsMovable() const Standard_OVERRIDE { return Standard_True; }
48
42cf5bc1 49 //! Sets the tool aSymmetricTool composed of a first
50 //! shape, a second shape, and a plane.
51 //! This tool is initially created at construction time.
787ff240 52 void SetTool (const TopoDS_Shape& aSymmetricTool) { myTool = aSymmetricTool; }
53
42cf5bc1 54 //! Returns the tool composed of a first shape, a second
55 //! shape, and a plane. This tool is created at construction time.
787ff240 56 const TopoDS_Shape& GetTool() const { return myTool; }
42cf5bc1 57
42cf5bc1 58private:
59
787ff240 60 Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& aPresentationManager, const Handle(Prs3d_Presentation)& aPresentation, const Standard_Integer aMode = 0) Standard_OVERRIDE;
42cf5bc1 61
787ff240 62 Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode) Standard_OVERRIDE;
42cf5bc1 63
64 Standard_EXPORT void ComputeTwoFacesSymmetric (const Handle(Prs3d_Presentation)& aprs);
65
66 Standard_EXPORT void ComputeTwoEdgesSymmetric (const Handle(Prs3d_Presentation)& aprs);
67
68 Standard_EXPORT void ComputeTwoVerticesSymmetric (const Handle(Prs3d_Presentation)& aprs);
69
787ff240 70private:
71
42cf5bc1 72 TopoDS_Shape myTool;
73 gp_Pnt myFAttach;
74 gp_Pnt mySAttach;
75 gp_Dir myFDirAttach;
76 gp_Dir myAxisDirAttach;
77
42cf5bc1 78};
79
787ff240 80#endif // _PrsDim_SymmetricRelation_HeaderFile