EIC code displayed by LXR master/​include/​opencascade/​PrsDim_LengthDimension.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:04:41

 // Copyright (c) 1999-2013 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _PrsDim_LengthDimension_HeaderFile
 #define _PrsDim_LengthDimension_HeaderFile
 
 #include <PrsDim_Dimension.hxx>
 #include <Geom_Plane.hxx>
 #include <gp_Pnt.hxx>
 #include <gp_Dir.hxx>
 #include <Prs3d_DimensionAspect.hxx>
 #include <TopoDS.hxx>
 
 DEFINE_STANDARD_HANDLE (PrsDim_LengthDimension, PrsDim_Dimension)
 
 //! Length dimension. Can be constructed:
 //! - Between two generic points.
 //! - Between two vertices.
 //! - Between two faces.
 //! - Between two parallel edges.
 //! - Between face and edge.
 //!
 //! In case of two points (vertices) or one linear edge the user-defined plane
 //! that includes this geometry is necessary to be set.
 //!
 //! In case of face-edge, edge-vertex or face-face lengths the automatic plane
 //! computing is allowed. For this plane the third point is found on the
 //! edge or on the face.
 //!
 //! Please note that if the inappropriate geometry is defined
 //! or the distance between measured points is less than
 //! Precision::Confusion(), the dimension is invalid and its
 //! presentation can not be computed.
 class PrsDim_LengthDimension : public PrsDim_Dimension
 {
   DEFINE_STANDARD_RTTIEXT(PrsDim_LengthDimension, PrsDim_Dimension)
 public:
 
   //! Construct an empty length dimension.
   //! @sa SetMeasuredGeometry(), SetMeasuredShapes() for initialization.
   Standard_EXPORT PrsDim_LengthDimension();
 
   //! Construct length dimension between face and edge.
   //! Here dimension can be built without user-defined plane.
   //! @param theFace [in] the face (first shape).
   //! @param theEdge [in] the edge (second shape).
   Standard_EXPORT PrsDim_LengthDimension (const TopoDS_Face& theFace,
                                           const TopoDS_Edge& theEdge);
 
   //! Construct length dimension between two faces.
   //! @param theFirstFace [in] the first face (first shape).
   //! @param theSecondFace [in] the second face (second shape).
   Standard_EXPORT PrsDim_LengthDimension (const TopoDS_Face& theFirstFace,
                                           const TopoDS_Face& theSecondFace);
 
   //! Construct length dimension between two points in
   //! the specified plane.
   //! @param theFirstPoint [in] the first point.
   //! @param theSecondPoint [in] the second point.
   //! @param thePlane [in] the plane to orient dimension.
   Standard_EXPORT PrsDim_LengthDimension (const gp_Pnt& theFirstPoint,
                                           const gp_Pnt& theSecondPoint,
                                           const gp_Pln& thePlane);
 
   //! Construct length dimension between two arbitrary shapes in
   //! the specified plane.
   //! @param theFirstShape [in] the first shape.
   //! @param theSecondShape [in] the second shape.
   //! @param thePlane [in] the plane to orient dimension.
   Standard_EXPORT PrsDim_LengthDimension (const TopoDS_Shape& theFirstShape,
                                           const TopoDS_Shape& theSecondShape,
                                           const gp_Pln& thePlane);
 
   //! Construct length dimension of linear edge.
   //! @param theEdge [in] the edge to measure.
   //! @param thePlane [in] the plane to orient dimension.
   Standard_EXPORT PrsDim_LengthDimension (const TopoDS_Edge& theEdge,
                                           const gp_Pln& thePlane);
 
 public:
 
   //! @return first attachment point.
   const gp_Pnt& FirstPoint() const { return myFirstPoint; }
 
   //! @return second attachment point.
   const gp_Pnt& SecondPoint() const { return mySecondPoint; }
 
   //! @return first attachment shape.
   const TopoDS_Shape& FirstShape() const { return myFirstShape; }
 
   //! @return second attachment shape.
   const TopoDS_Shape& SecondShape() const { return mySecondShape; }
 
 public:
 
   //! Measure distance between two points.
   //! The dimension will become invalid if the new distance between
   //! attachment points is less than Precision::Confusion().
   //! @param theFirstPoint [in] the first point.
   //! @param theSecondPoint [in] the second point.
   //! @param thePlane [in] the user-defined plane
   Standard_EXPORT void SetMeasuredGeometry (const gp_Pnt& theFirstPoint,
                                             const gp_Pnt& theSecondPoint,
                                             const gp_Pln& thePlane);
 
   //! Measure length of edge.
   //! The dimension will become invalid if the new length of edge
   //! is less than Precision::Confusion().
   //! @param theEdge [in] the edge to measure.
   //! @param thePlane [in] the user-defined plane
   Standard_EXPORT void SetMeasuredGeometry (const TopoDS_Edge& theEdge,
                                             const gp_Pln& thePlane);
 
   //! Measure distance between two faces.
   //! The dimension will become invalid if the distance can not
   //! be measured or it is less than Precision::Confusion().
   //! @param theFirstFace [in] the first face (first shape).
   //! @param theSecondFace [in] the second face (second shape).
   Standard_EXPORT void SetMeasuredGeometry (const TopoDS_Face& theFirstFace,
                                             const TopoDS_Face& theSecondFace);
 
   //! Measure distance between face and edge.
   //! The dimension will become invalid if the distance can not
   //! be measured or it is less than Precision::Confusion().
   //! @param theFace [in] the face (first shape).
   //! @param theEdge [in] the edge (second shape).
   Standard_EXPORT void SetMeasuredGeometry (const TopoDS_Face& theFace,
                                             const TopoDS_Edge& theEdge);
 
   //! Measure distance between generic pair of shapes (edges, vertices, length),
   //! where measuring is applicable.
   //! @param theFirstShape [in] the first shape.
   //! @param theSecondShape [in] the second shape.
   Standard_EXPORT void SetMeasuredShapes (const TopoDS_Shape& theFirstShape,
                                           const TopoDS_Shape& theSecondShape);
 
   //! @return the display units string.
   Standard_EXPORT virtual const TCollection_AsciiString& GetDisplayUnits() const Standard_OVERRIDE;
 
   //! @return the model units string.
   Standard_EXPORT virtual const TCollection_AsciiString& GetModelUnits() const Standard_OVERRIDE;
 
   Standard_EXPORT virtual void SetDisplayUnits (const TCollection_AsciiString& theUnits) Standard_OVERRIDE;
 
   Standard_EXPORT virtual void SetModelUnits (const TCollection_AsciiString& theUnits) Standard_OVERRIDE;
 
   Standard_EXPORT virtual void SetTextPosition (const gp_Pnt& theTextPos) Standard_OVERRIDE;
 
   Standard_EXPORT virtual gp_Pnt GetTextPosition() const Standard_OVERRIDE;
 
   //! Set custom direction for dimension. If it is not set, the direction is obtained
   //! from the measured geometry (e.g. line between points of dimension)
   //! The direction does not change flyout direction of dimension.
   //! @param theDirection [in] the dimension direction.
   //! @param theUseDirection [in] boolean value if custom direction should be used.
   Standard_EXPORT void SetDirection (const gp_Dir& theDirection, const Standard_Boolean theUseDirection = Standard_True);
 
 protected:
 
   //! Checks if the plane includes first and second points to build dimension.
   Standard_EXPORT virtual Standard_Boolean CheckPlane (const gp_Pln& thePlane) const Standard_OVERRIDE;
 
   Standard_EXPORT virtual gp_Pln ComputePlane(const gp_Dir& theAttachDir) const;
 
   //! Computes distance between dimension points. If custom direction is defined, the distance
   //! is a projection value of the distance between points to this direction
   //! @return dimension value
   Standard_EXPORT Standard_Real ComputeValue() const Standard_OVERRIDE;
 
   Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager)& thePresentationManager,
                                         const Handle(Prs3d_Presentation)& thePresentation,
                                         const Standard_Integer theMode = 0) Standard_OVERRIDE;
 
   //! Computes points bounded the flyout line for linear dimension.
   //! Direction of flyout line equal to the custom direction of dimension if defined or
   //! parallel to the main direction line
   //! @param theFirstPoint [in] the first attach point of linear dimension.
   //! @param theSecondPoint [in] the second attach point of linear dimension.
   //! @param theLineBegPoint [out] the first attach point of linear dimension.
   //! @param theLineEndPoint [out] the second attach point of linear dimension.
   Standard_EXPORT virtual void ComputeFlyoutLinePoints (const gp_Pnt& theFirstPoint, const gp_Pnt& theSecondPoint,
                                                         gp_Pnt& theLineBegPoint, gp_Pnt& theLineEndPoint) Standard_OVERRIDE;
 
   Standard_EXPORT virtual void ComputeFlyoutSelection (const Handle(SelectMgr_Selection)& theSelection,
                                                        const Handle(SelectMgr_EntityOwner)& theEntityOwner) Standard_OVERRIDE;
 
 protected:
 
   //! Checks that distance between two points is valid.
   //! @param theFirstPoint [in] the first point.
   //! @param theSecondPoint [in] the second point.
   Standard_EXPORT Standard_Boolean IsValidPoints (const gp_Pnt& theFirstPoint,
                                                   const gp_Pnt& theSecondPoint) const;
 
   Standard_EXPORT Standard_Boolean InitTwoEdgesLength (const TopoDS_Edge & theFirstEdge,
                                                        const TopoDS_Edge& theSecondEdge,
                                                        gp_Dir& theEdgeDir);
 
   //! Auxiliary method for InitTwoShapesPoints()
   //! in case of the distance between edge and vertex.
   //! Finds the point on the edge that is the closest one to <theVertex>.
   //! @param theEdgeDir [out] is the direction on the edge to build automatic plane.
   Standard_EXPORT Standard_Boolean InitEdgeVertexLength (const TopoDS_Edge& theEdge,
                                                          const TopoDS_Vertex& theVertex,
                                                          gp_Dir& theEdgeDir,
                                                          Standard_Boolean isInfinite);
 
   //! Auxiliary method for InitTwoShapesPoints()
   //! in case of the distance between face and edge.
   //! The first attachment point is first parameter point from <theEdge>.
   //! Find the second attachment point which belongs to <theFace>
   //! Iterate over the edges of the face and find the closest point according
   //! to found point on edge.
   //! @param theEdgeDir [out] is the direction on the edge to build automatic plane.
   Standard_EXPORT Standard_Boolean InitEdgeFaceLength (const TopoDS_Edge& theEdge,
                                                        const TopoDS_Face& theFace,
                                                        gp_Dir& theEdgeDir);
 
   //! Initialization of two attach points in case of two owner shapes.
   Standard_EXPORT Standard_Boolean InitTwoShapesPoints (const TopoDS_Shape& theFirstShape,
                                                         const TopoDS_Shape& theSecondShape,
                                                         gp_Pln& theComputedPlane,
                                                         Standard_Boolean& theIsPlaneComputed);
 
   //! Initialization of two attach points in case of one owner shape.
   Standard_EXPORT Standard_Boolean InitOneShapePoints (const TopoDS_Shape& theShape);
 
 protected:
 
   gp_Pnt myFirstPoint;
   gp_Pnt mySecondPoint;
   TopoDS_Shape myFirstShape;
   TopoDS_Shape mySecondShape;
   gp_Dir myDirection;
   Standard_Boolean myHasCustomDirection;
 };
 
 #endif // _PrsDim_LengthDimension_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team