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

-- File:	Transition.cdl
-- Created:	Wed May  6 14:09:43 1992
-- Author:	Jacques GOUSSARD
--		<jag@sdsun1>
---Copyright:	 Matra Datavision 1992


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