[occt.git] / src / IntSurf / IntSurf_Transition.cdl

-- Created on: 1992-05-06
-- Created by: Jacques GOUSSARD
-- Copyright (c) 1992-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 Transition from IntSurf

	---Purpose: Definition of the transition at the intersection
	--          between an intersection line and a restriction curve
	--          on a surface.

uses TypeTrans from IntSurf,
     Situation from IntSurf

raises DomainError from Standard

is

    Create
    
	---Purpose: Empty constructor. Creates an UNDECIDED transition.
    
    	returns Transition from IntSurf;


    Create(Tangent: Boolean from Standard; Type: TypeTrans from IntSurf)
    
	---Purpose: Create a IN or OUT transition

       	returns Transition from IntSurf;


    Create(Tangent: Boolean from Standard;
           Situ: Situation from IntSurf; Oppos: Boolean from Standard)
    
	---Purpose: Create a TOUCH transition.
    
    	returns Transition from IntSurf;


    SetValue(me: in out; Tangent: Boolean from Standard;
             Type: TypeTrans from IntSurf)

	---Purpose: Set the values of an IN or OUT transition.
    	 
	---C++: inline

    	is static;


    SetValue(me: in out; Tangent: Boolean from Standard;
             Situ: Situation from IntSurf; Oppos: Boolean from Standard)

	---Purpose: Set the values of a TOUCH transition.
    
	---C++: inline

    	is static;


    SetValue(me: in out)

	---Purpose: Set the values of an UNDECIDED transition.

	---C++: inline

    	is static;


    TransitionType(me)

    	---Purpose: Returns the type of Transition (in/out/touch/undecided)
    	--          for the arc given by value. This the transition of
    	--          the intersection line compared to the Arc of restriction,
    	--          i-e when the function returns INSIDE for example, it
    	--          means that the intersection line goes inside the 
    	--          part of plane limited by the arc of restriction.

    	returns TypeTrans from IntSurf
	---C++: inline

    	is static;


    IsTangent(me)
    
    	---Purpose: Returns TRUE if the point is tangent to the arc
    	--          given by Value.
    	--          An exception is raised if TransitionType returns UNDECIDED.

    	returns Boolean from Standard
	---C++: inline
	
	raises DomainError from Standard

    	is static;


    Situation(me)
    
	---Purpose: Returns a significant value if TransitionType returns
	--          TOUCH. In this case, the function returns :
	--          INSIDE when the intersection line remains inside the Arc,
	--          OUTSIDE when it remains outside the Arc,
	--          UNKNOWN when the calsulus cannot give results.
	--          If TransitionType returns IN, or OUT, or UNDECIDED, a
	--          exception is raised.

    	returns Situation from IntSurf
	---C++: inline
	
	raises DomainError from Standard
	
	is static;


    IsOpposite(me)
    
    	---Purpose: returns a significant value if TransitionType returns
    	--          TOUCH. 
    	--          In this case, the function returns true when
    	--          the 2 curves locally define two different parts of the
    	--          space.
    	--          If TransitionType returns IN or OUT or UNDECIDED, an
    	--          exception is raised.

    	returns Boolean from Standard
	---C++: inline

        raises DomainError from Standard
	
    	is static;


fields

    tangent : Boolean   from Standard;
    typetra : TypeTrans from IntSurf;
    situat  : Situation from IntSurf;
    oppos   : Boolean   from Standard;

end Transition;
Commit	Line	Data
b311480e	1	-- Created on: 1992-05-06
	2	-- Created by: Jacques GOUSSARD
	3	-- Copyright (c) 1992-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
	23
	24	class Transition from IntSurf
	25
	26	---Purpose: Definition of the transition at the intersection
	27	-- between an intersection line and a restriction curve
	28	-- on a surface.
	29
	30	uses TypeTrans from IntSurf,
	31	Situation from IntSurf
	32
	33	raises DomainError from Standard
	34
	35	is
	36
	37	Create
	38
	39	---Purpose: Empty constructor. Creates an UNDECIDED transition.
	40
	41	returns Transition from IntSurf;
	42
	43
	44	Create(Tangent: Boolean from Standard; Type: TypeTrans from IntSurf)
	45
	46	---Purpose: Create a IN or OUT transition
	47
	48	returns Transition from IntSurf;
	49
	50
	51	Create(Tangent: Boolean from Standard;
	52	Situ: Situation from IntSurf; Oppos: Boolean from Standard)
	53
	54	---Purpose: Create a TOUCH transition.
	55
	56	returns Transition from IntSurf;
	57
	58
	59	SetValue(me: in out; Tangent: Boolean from Standard;
	60	Type: TypeTrans from IntSurf)
	61
	62	---Purpose: Set the values of an IN or OUT transition.
	63
	64	---C++: inline
	65
	66	is static;
	67
	68
	69	SetValue(me: in out; Tangent: Boolean from Standard;
	70	Situ: Situation from IntSurf; Oppos: Boolean from Standard)
	71
	72	---Purpose: Set the values of a TOUCH transition.
	73
	74	---C++: inline
	75
	76	is static;
	77
	78
	79	SetValue(me: in out)
	80
	81	---Purpose: Set the values of an UNDECIDED transition.
	82
	83	---C++: inline
	84
85	is static;
86
87
88	TransitionType(me)
89
90	---Purpose: Returns the type of Transition (in/out/touch/undecided)
91	-- for the arc given by value. This the transition of
92	-- the intersection line compared to the Arc of restriction,
93	-- i-e when the function returns INSIDE for example, it
94	-- means that the intersection line goes inside the
95	-- part of plane limited by the arc of restriction.
96
97	returns TypeTrans from IntSurf
98	---C++: inline
99
100	is static;
101
102
103	IsTangent(me)
104
105	---Purpose: Returns TRUE if the point is tangent to the arc
106	-- given by Value.
107	-- An exception is raised if TransitionType returns UNDECIDED.
108
109	returns Boolean from Standard
110	---C++: inline
111
112	raises DomainError from Standard
113
114	is static;
115
116
117	Situation(me)
118
119	---Purpose: Returns a significant value if TransitionType returns
120	-- TOUCH. In this case, the function returns :
121	-- INSIDE when the intersection line remains inside the Arc,
122	-- OUTSIDE when it remains outside the Arc,
123	-- UNKNOWN when the calsulus cannot give results.
124	-- If TransitionType returns IN, or OUT, or UNDECIDED, a
125	-- exception is raised.
126
127	returns Situation from IntSurf
128	---C++: inline
129
130	raises DomainError from Standard
131
132	is static;
133
134
135	IsOpposite(me)
136
137	---Purpose: returns a significant value if TransitionType returns
138	-- TOUCH.
139	-- In this case, the function returns true when
140	-- the 2 curves locally define two different parts of the
141	-- space.
142	-- If TransitionType returns IN or OUT or UNDECIDED, an
143	-- exception is raised.
144
145	returns Boolean from Standard
146	---C++: inline
147
148	raises DomainError from Standard
149
150	is static;
151
152
153	fields
154
155	tangent : Boolean from Standard;
156	typetra : TypeTrans from IntSurf;
157	situat : Situation from IntSurf;
158	oppos : Boolean from Standard;
159
160	end Transition;