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

-- Created on: 1993-11-05
-- 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 Domain from HatchGen

uses
    PointOnHatching from HatchGen

raises
    DomainError from Standard

is

    Create
    
    	---Purpose: Creates an infinite domain.

        returns Domain from HatchGen ;
	

    Create (P1, P2 : PointOnHatching from HatchGen)
    
    	---Purpose: Creates a domain for the curve associated to a hatching.

    	returns Domain from HatchGen ;


    Create (P : PointOnHatching from HatchGen ; First : Boolean from Standard)
    
    	---Purpose: Creates a semi-infinite domain for the curve associated
    	--          to a hatching. The `First' flag means that the given
    	--          point is the first one.

    	returns Domain from HatchGen ;


    SetPoints (me : in out ; P1, P2 : PointOnHatching from HatchGen)
    
    	---Purpose: Sets the first and the second points of the domain.

      	---C++: inline
	is static ;


    SetPoints (me : in out)
    
    	---Purpose: Sets the first and the second points of the domain
    	--          as the infinite.

    	---C++: inline
	is static ;


    SetFirstPoint (me : in out ; P : PointOnHatching from HatchGen)
    
    	---Purpose: Sets the first point of the domain.

    	---C++: inline
	is static ;


    SetFirstPoint (me : in out)
    
    	---Purpose: Sets the first point of the domain at the
    	--          infinite.

    	---C++: inline
	is static ;


    SetSecondPoint (me : in out ; P : PointOnHatching from HatchGen)
    
    	---Purpose: Sets the second point of the domain.

    	---C++: inline
	is static ;


    SetSecondPoint (me : in out)
    
    	---Purpose: Sets the second point of the domain at the
    	--          infinite.

    	---C++: inline
	is static ;


    HasFirstPoint (me)

    	---Purpose: Returns True if the domain has a first point.
 
    	---C++: inline
   	returns Boolean from Standard
	is static ;


    FirstPoint (me)
    
    	---Purpose: Returns the first point of the domain.
    	--          The exception DomainError is raised if
    	--          HasFirstPoint returns False.

    	---C++: inline
    	---C++: return const &

    	returns PointOnHatching from HatchGen
	raises DomainError from Standard
	is static ;


    HasSecondPoint (me)

    	---Purpose: Returns True if the domain has a second point.

    	---C++: inline
    	returns Boolean from Standard
	is static ;


    SecondPoint (me)
    
    	---Purpose: Returns the second point of the domain.
    	--          The exception DomainError is raised if
    	--          HasSecondPoint returns False.

    	---C++: inline
    	---C++: return const &

    	returns PointOnHatching from HatchGen
	raises DomainError from Standard
	is static ;


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

    	is static ;
	

fields

    myHasFirstPoint  : Boolean         from Standard ;
    myFirstPoint     : PointOnHatching from HatchGen ;
    myHasSecondPoint : Boolean         from Standard ;
    mySecondPoint    : PointOnHatching from HatchGen ;
    
end Domain from HatchGen ;
Commit	Line	Data
b311480e	1	-- Created on: 1993-11-05
	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 Domain from HatchGen
	23
	24	uses
	25	PointOnHatching from HatchGen
	26
	27	raises
	28	DomainError from Standard
	29
	30	is
	31
	32	Create
	33
	34	---Purpose: Creates an infinite domain.
	35
	36	returns Domain from HatchGen ;
	37
	38
	39	Create (P1, P2 : PointOnHatching from HatchGen)
	40
	41	---Purpose: Creates a domain for the curve associated to a hatching.
	42
	43	returns Domain from HatchGen ;
	44
	45
	46	Create (P : PointOnHatching from HatchGen ; First : Boolean from Standard)
	47
	48	---Purpose: Creates a semi-infinite domain for the curve associated
	49	-- to a hatching. The `First' flag means that the given
	50	-- point is the first one.
	51
	52	returns Domain from HatchGen ;
	53
	54
	55	SetPoints (me : in out ; P1, P2 : PointOnHatching from HatchGen)
	56
	57	---Purpose: Sets the first and the second points of the domain.
	58
	59	---C++: inline
	60	is static ;
	61
	62
	63	SetPoints (me : in out)
	64
	65	---Purpose: Sets the first and the second points of the domain
	66	-- as the infinite.
	67
	68	---C++: inline
	69	is static ;
	70
	71
	72	SetFirstPoint (me : in out ; P : PointOnHatching from HatchGen)
	73
	74	---Purpose: Sets the first point of the domain.
	75
	76	---C++: inline
	77	is static ;
	78
	79
	80	SetFirstPoint (me : in out)
	81
	82	---Purpose: Sets the first point of the domain at the
	83	-- infinite.
	84
85	---C++: inline
86	is static ;
87
88
89	SetSecondPoint (me : in out ; P : PointOnHatching from HatchGen)
90
91	---Purpose: Sets the second point of the domain.
92
93	---C++: inline
94	is static ;
95
96
97	SetSecondPoint (me : in out)
98
99	---Purpose: Sets the second point of the domain at the
100	-- infinite.
101
102	---C++: inline
103	is static ;
104
105
106	HasFirstPoint (me)
107
108	---Purpose: Returns True if the domain has a first point.
109
110	---C++: inline
111	returns Boolean from Standard
112	is static ;
113
114
115	FirstPoint (me)
116
117	---Purpose: Returns the first point of the domain.
118	-- The exception DomainError is raised if
119	-- HasFirstPoint returns False.
120
121	---C++: inline
122	---C++: return const &
123
124	returns PointOnHatching from HatchGen
125	raises DomainError from Standard
126	is static ;
127
128
129	HasSecondPoint (me)
130
131	---Purpose: Returns True if the domain has a second point.
132
133	---C++: inline
134	returns Boolean from Standard
135	is static ;
136
137
138	SecondPoint (me)
139
140	---Purpose: Returns the second point of the domain.
141	-- The exception DomainError is raised if
142	-- HasSecondPoint returns False.
143
144	---C++: inline
145	---C++: return const &
146
147	returns PointOnHatching from HatchGen
148	raises DomainError from Standard
149	is static ;
150
151
152	Dump (me; Index : Integer from Standard = 0)
153
154	---Purpose: Dump of the domain.
155
156	is static ;
157
158
159	fields
160
161	myHasFirstPoint : Boolean from Standard ;
162	myFirstPoint : PointOnHatching from HatchGen ;
163	myHasSecondPoint : Boolean from Standard ;
164	mySecondPoint : PointOnHatching from HatchGen ;
165
166	end Domain from HatchGen ;