include/opencascade/BRepBlend_Line.hxx

0001 // Created on: 1993-12-02
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _BRepBlend_Line_HeaderFile
0018 #define _BRepBlend_Line_HeaderFile
0019
0020 #include <Blend_SequenceOfPoint.hxx>
0021 #include <BRepBlend_Extremity.hxx>
0022 #include <Standard_Transient.hxx>
0023 #include <Standard_Integer.hxx>
0024
0025 class Blend_Point;
0026
0027 class BRepBlend_Line;
0028 DEFINE_STANDARD_HANDLE(BRepBlend_Line, Standard_Transient)
0029
0030 class BRepBlend_Line : public Standard_Transient
0031 {
0032
0033 public:
0034   Standard_EXPORT BRepBlend_Line();
0035
0036   //! Clears the content of the line.
0037   Standard_EXPORT void Clear();
0038
0039   //! Adds a point in the line.
0040   void Append(const Blend_Point& P);
0041
0042   //! Adds a point in the line at the first place.
0043   void Prepend(const Blend_Point& P);
0044
0045   //! Adds a point in the line at the first place.
0046   void InsertBefore(const Standard_Integer Index, const Blend_Point& P);
0047
0048   //! Removes  from  <me>    all  the  items  of
0049   //! positions between <FromIndex> and <ToIndex>.
0050   //! Raises an exception if the indices are out of bounds.
0051   void Remove(const Standard_Integer FromIndex, const Standard_Integer ToIndex);
0052
0053   //! Sets the value of the transition of the line on S1 and
0054   //! the line on S2.
0055   Standard_EXPORT void Set(const IntSurf_TypeTrans TranS1, const IntSurf_TypeTrans TranS2);
0056
0057   //! Sets the value of the transition of the line on a surface
0058   Standard_EXPORT void Set(const IntSurf_TypeTrans Trans);
0059
0060   //! Sets the values of the start points for the line.
0061   void SetStartPoints(const BRepBlend_Extremity& StartPt1, const BRepBlend_Extremity& StartPt2);
0062
0063   //! Sets tne values of the end points for the line.
0064   void SetEndPoints(const BRepBlend_Extremity& EndPt1, const BRepBlend_Extremity& EndPt2);
0065
0066   //! Returns the number of points in the line.
0067   Standard_Integer NbPoints() const;
0068
0069   //! Returns the point of range Index.
0070   const Blend_Point& Point(const Standard_Integer Index) const;
0071
0072   //! Returns the type of the transition of the line defined
0073   //! on the first surface. The transition is "constant"
0074   //! along the line.
0075   //! The transition is IN if the line is oriented in such
0076   //! a way that the system of vectors (N,DRac,T) is
0077   //! right-handed, where
0078   //! N is the normal to the first surface at a point P,
0079   //! DRac is a vector tangent to the blending patch,
0080   //! oriented towards the valid part of this patch,
0081   //! T  is the tangent to the line on S1 at P.
0082   //! The transitioon is OUT when the system of vectors is
0083   //! left-handed.
0084   IntSurf_TypeTrans TransitionOnS1() const;
0085
0086   //! Returns the type of the transition of the line defined
0087   //! on the second surface. The transition is "constant"
0088   //! along the line.
0089   IntSurf_TypeTrans TransitionOnS2() const;
0090
0091   //! Returns the start point on S1.
0092   const BRepBlend_Extremity& StartPointOnFirst() const;
0093
0094   //! Returns the start point on S2
0095   const BRepBlend_Extremity& StartPointOnSecond() const;
0096
0097   //! Returns the end point on S1.
0098   const BRepBlend_Extremity& EndPointOnFirst() const;
0099
0100   //! Returns the point on S2.
0101   const BRepBlend_Extremity& EndPointOnSecond() const;
0102
0103   //! Returns the type of the transition of the line defined
0104   //! on the surface.
0105   IntSurf_TypeTrans TransitionOnS() const;
0106
0107   DEFINE_STANDARD_RTTIEXT(BRepBlend_Line, Standard_Transient)
0108
0109 protected:
0110 private:
0111   Blend_SequenceOfPoint seqpt;
0112   IntSurf_TypeTrans     tras1;
0113   IntSurf_TypeTrans     tras2;
0114   BRepBlend_Extremity   stp1;
0115   BRepBlend_Extremity   stp2;
0116   BRepBlend_Extremity   endp1;
0117   BRepBlend_Extremity   endp2;
0118   Standard_Boolean      hass1;
0119   Standard_Boolean      hass2;
0120 };
0121
0122 #include <BRepBlend_Line.lxx>
0123
0124 #endif // _BRepBlend_Line_HeaderFile