[occt.git] / src / IntCurve / IntCurve_Polygon2dGen.cdl

-- File:	Polygon2dGen.cdl
-- Created:	Mon Oct 19 11:51:16 1992
-- Author:	Laurent BUCHARD
---Copyright:	 Matra Datavision 1992


generic class Polygon2dGen from IntCurve ( 
    TheCurve         as any;
    TheCurveTool     as any) -- as CurveTool from IntCurve(TheCurve)

	---Purpose: Describe a polyline  as  a topology to compute the
	--          interference beetween two polylines 2 dimension.

        ---Level: Internal

inherits Polygon2d from Intf

uses    Pnt2d              from gp,
    	Box2d              from Bnd,
    	Array1OfPnt2d      from TColgp,
        Array1OfReal       from TColStd,
        Array1OfInteger    from TColStd,
        Domain             from IntRes2d

raises  OutOfRange from Standard

is  

    Create         (Curve       : TheCurve;
    	    	    NbPnt       : Integer  from Standard;
		    Domain      : Domain   from IntRes2d;
    	    	    Tol         : Real     from Standard) 
		    
		    ---Purpose: Compute a polygon on the domain of the curve.
		    
		    
    	    	    returns Polygon2dGen from IntCurve;

    Create         (Curve       : TheCurve;
    	    	    NbPnt       : Integer  from Standard;
		    Domain      : Domain   from IntRes2d;
    	    	    Tol         : Real     from Standard;
		    OtherBox    : Box2d    from Bnd)
		    
		    ---Purpose: Compute a polygon on the domain of the
		    --          curve.   parameters of  the  begin and
		    --          end of the curve (and its polygon) are
		    --          adjusted to lie in the OtherBox.
		    
    	    	    returns Polygon2dGen from IntCurve;


    ComputeWithBox(me       : in out; 
                   Curve    : TheCurve;
		   OtherBox : Box2d  from Bnd)
		   
		   ---Purpose: The current polygon is modified if most
		   --          of the  points of the  polygon  are are
		   --          outside  the  box  <OtherBox>.  In this
		   --          situation, bounds are computed to build
		   --          a polygon inside or near the OtherBox.
                   is static;

    DeflectionOverEstimation(me)
		   returns Real from Standard
		   ---C++: inline
		   is redefined virtual;

    SetDeflectionOverEstimation(me: in out; x:Real from Standard)
                    ---C++: inline
		    is static;

    Closed         (me : in out; clos : Boolean from Standard)
    	            ---C++: inline
		    is static;

    NbSegments     (me)
    	    	    returns Integer
		    ---C++: inline
    	    	    is redefined virtual;
    ---Purpose: Give the number of Segments in the polyline.

    Segment (me; theIndex : in Integer from Standard;
                 theBegin, theEnd : in out Pnt2d from gp)
        raises OutOfRange from Standard is redefined virtual;
    ---Purpose: Returns the points of the segment <Index> in the Polygon.

-- Implementation : 


   InfParameter(me) 
   
    	---Purpose: Returns the parameter (On the curve)
    	--          of the first point of the Polygon
   
    	returns Real from Standard
	---C++: inline
	is static;

   SupParameter(me) 

       	---Purpose: Returns the parameter (On the curve)
    	--          of the last point of the Polygon
   
    	returns Real from Standard
	---C++: inline
	is static;


   AutoIntersectionIsPossible(me) 
       returns Boolean from Standard
       is static;

   ApproxParamOnCurve(me; 
                      Index       : in  Integer from Standard;
		      ParamOnLine : in  Real    from Standard)
    	    	      
                      returns Real      from Standard
    	    	     
		      raises OutOfRange from Standard
    	    	      is static;

            ---Purpose: Give an approximation of the parameter on the curve 
            --          according to the discretization of the Curve.

     
    CalculRegion  (me; 
    	    	   x  :  Real  from  Standard  ; 
		   y  :  Real  from  Standard  ;
    	    	   x1 :  Real  from  Standard  ; 
    	    	   x2 :  Real  from  Standard  ; 
		   y1 :  Real  from  Standard  ;
		   y2 :  Real  from  Standard  ) 
	returns  Integer  from  Standard  ;	   
	---C++: inline
		 	
    Dump           (me)
    	is static;


fields  TheDeflection : Real                 from Standard;
    	NbPntIn       : Integer              from Standard;
        TheMaxNbPoints: Integer              from Standard;
    	ThePnts       : Array1OfPnt2d        from TColgp;
        TheParams     : Array1OfReal         from TColStd;
        TheIndex      : Array1OfInteger      from TColStd;
        ClosedPolygon : Boolean              from Standard;

	--- To compute an approximate parameter on the Curve
	--  
	Binf          : Real                 from Standard;
	Bsup          : Real                 from Standard;

end Polygon2dGen;
Commit	Line	Data
7fd59977	1	-- File: Polygon2dGen.cdl
	2	-- Created: Mon Oct 19 11:51:16 1992
	3	-- Author: Laurent BUCHARD
7fd59977	4	---Copyright: Matra Datavision 1992
	5
	6
	7	generic class Polygon2dGen from IntCurve (
	8	TheCurve as any;
	9	TheCurveTool as any) -- as CurveTool from IntCurve(TheCurve)
	10
	11	---Purpose: Describe a polyline as a topology to compute the
	12	-- interference beetween two polylines 2 dimension.
7fd59977	13
	14	---Level: Internal
	15
9530af27	16	inherits Polygon2d from Intf
9530af27	17
7fd59977	18	uses Pnt2d from gp,
	19	Box2d from Bnd,
	20	Array1OfPnt2d from TColgp,
9530af27	21	Array1OfReal from TColStd,
	22	Array1OfInteger from TColStd,
	23	Domain from IntRes2d
7fd59977	24
	25	raises OutOfRange from Standard
	26
7fd59977	27	is
	28
	29	Create (Curve : TheCurve;
	30	NbPnt : Integer from Standard;
	31	Domain : Domain from IntRes2d;
	32	Tol : Real from Standard)
	33
	34	---Purpose: Compute a polygon on the domain of the curve.
	35
	36
	37	returns Polygon2dGen from IntCurve;
	38
	39	Create (Curve : TheCurve;
	40	NbPnt : Integer from Standard;
	41	Domain : Domain from IntRes2d;
	42	Tol : Real from Standard;
	43	OtherBox : Box2d from Bnd)
	44
	45	---Purpose: Compute a polygon on the domain of the
	46	-- curve. parameters of the begin and
	47	-- end of the curve (and its polygon) are
	48	-- adjusted to lie in the OtherBox.
	49
	50	returns Polygon2dGen from IntCurve;
	51
	52
	53	ComputeWithBox(me : in out;
	54	Curve : TheCurve;
	55	OtherBox : Box2d from Bnd)
	56
	57	---Purpose: The current polygon is modified if most
	58	-- of the points of the polygon are are
	59	-- outside the box <OtherBox>. In this
	60	-- situation, bounds are computed to build
	61	-- a polygon inside or near the OtherBox.
	62	is static;
	63
7fd59977	64	DeflectionOverEstimation(me)
	65	returns Real from Standard
	66	---C++: inline
9530af27	67	is redefined virtual;
7fd59977	68
	69	SetDeflectionOverEstimation(me: in out; x:Real from Standard)
	70	---C++: inline
	71	is static;
	72
	73	Closed (me : in out; clos : Boolean from Standard)
	74	---C++: inline
	75	is static;
	76
7fd59977	77	NbSegments (me)
	78	returns Integer
	79	---C++: inline
9530af27	80	is redefined virtual;
7fd59977	81	---Purpose: Give the number of Segments in the polyline.
9530af27	82
	83	Segment (me; theIndex : in Integer from Standard;
	84	theBegin, theEnd : in out Pnt2d from gp)
	85	raises OutOfRange from Standard is redefined virtual;
	86	---Purpose: Returns the points of the segment <Index> in the Polygon.
7fd59977	87
	88	-- Implementation :
	89
	90
	91	InfParameter(me)
	92
	93	---Purpose: Returns the parameter (On the curve)
	94	-- of the first point of the Polygon
	95
	96	returns Real from Standard
	97	---C++: inline
	98	is static;
	99
	100	SupParameter(me)
	101
	102	---Purpose: Returns the parameter (On the curve)
	103	-- of the last point of the Polygon
	104
	105	returns Real from Standard
	106	---C++: inline
	107	is static;
	108
	109
	110	AutoIntersectionIsPossible(me)
	111	returns Boolean from Standard
	112	is static;
	113
	114	ApproxParamOnCurve(me;
	115	Index : in Integer from Standard;
	116	ParamOnLine : in Real from Standard)
	117
	118	returns Real from Standard
	119
	120	raises OutOfRange from Standard
	121	is static;
	122
	123	---Purpose: Give an approximation of the parameter on the curve
	124	-- according to the discretization of the Curve.
	125
	126
	127	CalculRegion (me;
	128	x : Real from Standard ;
	129	y : Real from Standard ;
	130	x1 : Real from Standard ;
	131	x2 : Real from Standard ;
	132	y1 : Real from Standard ;
	133	y2 : Real from Standard )
	134	returns Integer from Standard ;
	135	---C++: inline
	136
	137	Dump (me)
	138	is static;
	139
	140
9530af27	141	fields TheDeflection : Real from Standard;
7fd59977	142	NbPntIn : Integer from Standard;
9530af27	143	TheMaxNbPoints: Integer from Standard;
7fd59977	144	ThePnts : Array1OfPnt2d from TColgp;
9530af27	145	TheParams : Array1OfReal from TColStd;
	146	TheIndex : Array1OfInteger from TColStd;
	147	ClosedPolygon : Boolean from Standard;
	148
7fd59977	149	--- To compute an approximate parameter on the Curve
	150	--
	151	Binf : Real from Standard;
	152	Bsup : Real from Standard;
7fd59977	153
7fd59977	154	end Polygon2dGen;