[occt.git] / src / HatchGen / HatchGen_PointOnHatching.cdl

-- Created on: 1993-10-29
-- Created by: Jean Marc LACHAUME
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.


class PointOnHatching from HatchGen


inherits IntersectionPoint from HatchGen


uses
    PointOnElement    from HatchGen ,
    PointsOnElement   from HatchGen ,
    IntersectionPoint from IntRes2d

raises
    OutOfRange from Standard
    
    
is


    Create
    
    	---Purpose: Creates an empty point.

      	---Category: PointOnHatching

    	returns PointOnHatching from HatchGen ;


    Create (Point : PointOnHatching from HatchGen)
    
    	---Purpose: Creates a point from an other.

      	---Category: PointOnHatching

    	returns PointOnHatching from HatchGen ;


    Create (Point : IntersectionPoint from IntRes2d)
    
    	---Purpose: Creates a point from an intersection point.

      	---Category: PointOnHatching

    	returns PointOnHatching from HatchGen ;


    Delete (me : out) is virtual;
    ---C++: alias "Standard_EXPORT virtual ~HatchGen_PointOnHatching(){Delete();}"
    ---Purpose: linux porting      
   
    AddPoint (me : in out ; Point     : PointOnElement from HatchGen ;
    	    	    	    Confusion : Real           from Standard)
    
    	---Purpose: Adds a point on element to the point.

    	---Category: PointOnHatching

    	is static ;


    NbPoints (me)
    
    	---Purpose: Returns the number of elements intersecting the
    	--          hatching at this point.

    	---Category: PointOnHatching

    	returns Integer from Standard
	is static ;


    Point (me; Index : Integer from Standard)
    
    	---Purpose: Returns the Index-th point on element of the point.
    	--          The exception OutOfRange is raised if
    	--          Index > NbPoints.

    	---Category: PointOnHatching

    	---C++: return const &

    	returns PointOnElement from HatchGen
	raises OutOfRange from Standard
	is static ;


    RemPoint (me : in out ; Index : Integer from Standard)
    
    	---Purpose: Removes the Index-th point on element of the point.
    	--          The exception OutOfRange is raised if
    	--          Index > NbPoints.

    	---Category: PointOnHatching

    	raises OutOfRange from Standard
	is static ;


    ClrPoints (me : in out)
    
    	---Purpose: Removes all the points on element of the point.

    	---Category: PointOnHatching

    	is static ;


    IsLower (me; Point     : PointOnHatching from HatchGen ;
    	    	 Confusion : Real            from Standard)
    
      	---Purpose: Tests if the point is lower than an other.
      	--          A point on hatching P1 is said to be lower than an
      	--          other P2 if :
      	--            P2.myParam - P1.myParam > Confusion

      	---Category: PointOnHatching

        returns Boolean from Standard
        is static ;
	

    IsEqual (me; Point     : PointOnHatching from HatchGen ;
    	    	 Confusion : Real            from Standard)
    

      	---Purpose: Tests if the  point is equal to an other.
      	--          A  point on hatching P1 is said to be equal to an
      	--          other P2 if :
        --            | P2.myParam - P1.myParam | <= Confusion

      	---Category: PointOnHatching

	returns Boolean from Standard
  	is static ;


    IsGreater (me; Point     : PointOnHatching from HatchGen ;
                   Confusion : Real            from Standard)
    
    
      	---Purpose: Tests if the point is greater than an other.
      	--          A point on hatching P1 is said to be greater than an
      	--          other P2 if :
      	--            P1.myParam - P2.myParam > Confusion

      	---Category: PointOnHatching

        returns Boolean from Standard
        is static ;


    Dump (me; Index : Integer from Standard = 0)
    
    	---Purpose: Dump of the point.

    	is static ;
	

fields

    myPoints : PointsOnElement from HatchGen is protected ;

end PointOnHatching from HatchGen ;
Commit	Line	Data
b311480e	1	-- Created on: 1993-10-29
	2	-- Created by: Jean Marc LACHAUME
	3	-- Copyright (c) 1993-1999 Matra Datavision
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
	5	--
	6	-- The content of this file is subject to the Open CASCADE Technology Public
	7	-- License Version 6.5 (the "License"). You may not use the content of this file
	8	-- except in compliance with the License. Please obtain a copy of the License
	9	-- at http://www.opencascade.org and read it completely before using this file.
	10	--
	11	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	12	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	13	--
	14	-- The Original Code and all software distributed under the License is
	15	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	16	-- Initial Developer hereby disclaims all such warranties, including without
	17	-- limitation, any warranties of merchantability, fitness for a particular
	18	-- purpose or non-infringement. Please see the License for the specific terms
	19	-- and conditions governing the rights and limitations under the License.
	20
7fd59977	21
	22	class PointOnHatching from HatchGen
	23
	24
	25	inherits IntersectionPoint from HatchGen
	26
	27
	28	uses
	29	PointOnElement from HatchGen ,
	30	PointsOnElement from HatchGen ,
	31	IntersectionPoint from IntRes2d
	32
	33	raises
	34	OutOfRange from Standard
	35
	36
	37	is
	38
	39
	40	Create
	41
	42	---Purpose: Creates an empty point.
	43
	44	---Category: PointOnHatching
	45
	46	returns PointOnHatching from HatchGen ;
	47
	48
	49
	50	Create (Point : PointOnHatching from HatchGen)
	51
	52	---Purpose: Creates a point from an other.
	53
	54	---Category: PointOnHatching
	55
	56	returns PointOnHatching from HatchGen ;
	57
	58
	59	Create (Point : IntersectionPoint from IntRes2d)
	60
	61	---Purpose: Creates a point from an intersection point.
	62
	63	---Category: PointOnHatching
	64
	65	returns PointOnHatching from HatchGen ;
	66
	67
	68	Delete (me : out) is virtual;
	69	---C++: alias "Standard_EXPORT virtual ~HatchGen_PointOnHatching(){Delete();}"
	70	---Purpose: linux porting
	71
	72	AddPoint (me : in out ; Point : PointOnElement from HatchGen ;
	73	Confusion : Real from Standard)
	74
	75	---Purpose: Adds a point on element to the point.
	76
	77	---Category: PointOnHatching
	78
	79	is static ;
	80
	81
	82	NbPoints (me)
	83
	84	---Purpose: Returns the number of elements intersecting the
85	-- hatching at this point.
86
87	---Category: PointOnHatching
88
89	returns Integer from Standard
90	is static ;
91
92
93	Point (me; Index : Integer from Standard)
94
95	---Purpose: Returns the Index-th point on element of the point.
96	-- The exception OutOfRange is raised if
97	-- Index > NbPoints.
98
99	---Category: PointOnHatching
100
101	---C++: return const &
102
103	returns PointOnElement from HatchGen
104	raises OutOfRange from Standard
105	is static ;
106
107
108	RemPoint (me : in out ; Index : Integer from Standard)
109
110	---Purpose: Removes the Index-th point on element of the point.
111	-- The exception OutOfRange is raised if
112	-- Index > NbPoints.
113
114	---Category: PointOnHatching
115
116	raises OutOfRange from Standard
117	is static ;
118
119
120	ClrPoints (me : in out)
121
122	---Purpose: Removes all the points on element of the point.
123
124	---Category: PointOnHatching
125
126	is static ;
127
128
129	IsLower (me; Point : PointOnHatching from HatchGen ;
130	Confusion : Real from Standard)
131
132	---Purpose: Tests if the point is lower than an other.
133	-- A point on hatching P1 is said to be lower than an
134	-- other P2 if :
135	-- P2.myParam - P1.myParam > Confusion
136
137	---Category: PointOnHatching
138
139	returns Boolean from Standard
140	is static ;
141
142
143	IsEqual (me; Point : PointOnHatching from HatchGen ;
144	Confusion : Real from Standard)
145
146
147	---Purpose: Tests if the point is equal to an other.
148	-- A point on hatching P1 is said to be equal to an
149	-- other P2 if :
150	-- \| P2.myParam - P1.myParam \| <= Confusion
151
152	---Category: PointOnHatching
153
154	returns Boolean from Standard
155	is static ;
156
157
158	IsGreater (me; Point : PointOnHatching from HatchGen ;
159	Confusion : Real from Standard)
160
161
162	---Purpose: Tests if the point is greater than an other.
163	-- A point on hatching P1 is said to be greater than an
164	-- other P2 if :
165	-- P1.myParam - P2.myParam > Confusion
166
167	---Category: PointOnHatching
168
169	returns Boolean from Standard
170	is static ;
171
172
173	Dump (me; Index : Integer from Standard = 0)
174
175	---Purpose: Dump of the point.
176
177	is static ;
178
179
180	fields
181
182	myPoints : PointsOnElement from HatchGen is protected ;
183
184	end PointOnHatching from HatchGen ;