[occt.git] / src / AIS / AIS_FixRelation.cdl

-- Created on: 1996-12-05
-- Created by: Flore Lantheaume/Odile Olivier
-- Copyright (c) 1996-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.

class FixRelation from AIS inherits Relation from AIS


	---Purpose: Constructs and manages a constraint by a fixed
    	-- relation between two or more interactive datums. This
    	-- constraint is represented by a wire from a shape -
    	-- point, vertex, or edge - in the first datum and a
    	-- corresponding shape in the second.
	-- Warning: This relation is not bound with any kind of parametric 
	--          constraint : it represents the "status" of an parametric
	--          object.
uses

    PresentationManager3d from PrsMgr,
    Presentation          from Prs3d,
    Selection             from SelectMgr,
    Shape                 from TopoDS,
    Vertex                from TopoDS,
    Edge                  from TopoDS,
    Wire                  from TopoDS,
    Curve                 from Geom,
    Circ                  from gp,
    Lin                   from gp,
    Pnt                   from gp,
    Projector             from Prs3d,
    Transformation        from Geom,
    Plane                 from Geom

is
    Create (aShape      : Shape          from TopoDS;
	    aPlane      : Plane          from Geom;
	    aWire       : Wire           from TopoDS)
	---Purpose:  initializes the vertex aShape, the
    	--   plane aPlane and the wire aWire, which connects
    	--   the two vertices in a fixed relation.
    returns FixRelation from AIS;

    Create (aShape      : Shape          from TopoDS;
	    aPlane      : Plane          from Geom;
	    aWire       : Wire           from TopoDS;
	    aPosition   : Pnt            from gp;
    	    anArrowSize : Real           from Standard = 0.01)
	---Purpose:  initializes the vertex aShape, the
    	--   plane aPlane and the wire aWire, the position
    	--   aPosition, the arrow size anArrowSize and the
    	-- wire aWire, which connects the two vertices in a fixed relation.
    returns FixRelation from AIS;
    Create (aShape      : Shape          from TopoDS;
	    aPlane      : Plane          from Geom)
	---Purpose:  initializes the edge aShape and the plane aPlane.
    returns FixRelation from AIS;

    Create (aShape      : Shape          from TopoDS;
	    aPlane      : Plane          from Geom;
	    aPosition   : Pnt            from gp;
    	    anArrowSize : Real           from Standard = 0.01)
	---Purpose: initializes the edge aShape, the
    	--   plane aPlane, the position aPosition and the arrow
    	--   size anArrowSize.
        
    returns FixRelation from AIS;

    Wire(me: mutable) returns Wire from TopoDS 
    is static;
    	---Purpose: Returns the wire which connects vertices in a fixed relation.

    SetWire(me: mutable;aWire : Wire from TopoDS)
    is static;
    	--- Purpose: Constructs the wire aWire. This connects vertices
    	-- which are in a fixed relation.
        
    IsMovable(me) returns Boolean from Standard 
        ---C++: inline    
    	---Purpose: Returns true if the Interactive Objects in the relation
    	-- are movable.   
    is redefined;    
    
    -- Methods from PresentableObject
    
    Compute(me            : mutable;
  	    aPresentationManager: PresentationManager3d from PrsMgr;
    	    aPresentation : Presentation from Prs3d;
    	    aMode         : Integer from Standard= 0) 
    is redefined static private;
    
    Compute(me:mutable;
    	        aProjector: Projector from Prs3d;
                aPresentation: Presentation from Prs3d)
    is redefined static private;

    Compute(me            : mutable;
    	    aProjector    : Projector from Prs3d;
    	    aTrsf         : Transformation from Geom;
	    aPresentation : Presentation from Prs3d)
    is redefined;
    	---Purpose: computes the presentation according to a point of view
    	--          given by <aProjector>. 
    	--          To be Used when the associated degenerated Presentations 
    	--          have been transformed by <aTrsf> which is not a Pure
    	--          Translation. The HLR Prs can't be deducted automatically
    	--          WARNING :<aTrsf> must be applied
    	--           to the object to display before computation  !!!

    -- Methods from SelectableObject
   
    ComputeSelection(me         : mutable;
    	    	     aSelection : Selection from SelectMgr;
    	    	     aMode      : Integer from Standard)
    is redefined private;
    
       
    --
    --             Computation private methods
    --

    ComputeVertex(me : mutable;
    	    	  FixVertex : Vertex from TopoDS;
		  curpos    : out Pnt from gp)
    ---Purpose: computes the presentation for <myFixShape> if it's a
    --          vertex.
    is private;
    
    
    ComputePosition(me;
    	    	    curv1   : Curve from Geom;
		    curv2   : Curve from Geom;
    	    	    firstp1 : Pnt   from gp;
		    lastp1  : Pnt   from gp ;
    	    	    firstp2 : Pnt   from gp;
		    lastp2  : Pnt   from gp)
    returns Pnt from gp
    is private;
    
    
    ComputePosition(me;
    	    	    curv   : Curve from Geom;
    	    	    firstp : Pnt  from gp;
		    lastp  : Pnt  from gp)
    returns Pnt from gp
    is private;
    
    
    ComputeEdge(me : mutable;
    	    	FixEdge : Edge from TopoDS;
		curpos    : out Pnt from gp)
    ---Purpose: computes the presentation for <myFixShape> if it's a
    --          edge.
    is private;
    
    
    ComputeLinePosition(me     : mutable;
    	    	    	glin   : Lin from gp;
			pos    : out Pnt from gp;
			pfirst : out Real from Standard;
			plast  : out Real from Standard)
    is private;
    
    
    ComputeCirclePosition(me     : mutable;
    	    	    	  gcirc  : Circ from gp;
			  pos    : out Pnt from gp;
			  pfirst : out Real from Standard;
			  plast  : out Real from Standard)
    is private;

    ConnectedEdges(myclass; aWire       : Wire     from TopoDS;
    	    	    	    aVertex     : Vertex   from TopoDS;
			    Edge1,Edge2 : out Edge from TopoDS)
    returns Boolean from Standard
    is private;
    
   
fields

    myWire      : Wire    from TopoDS;
    myPntAttach : Pnt     from gp;

end FixRelation;
Commit	Line	Data
b311480e	1	-- Created on: 1996-12-05
	2	-- Created by: Flore Lantheaume/Odile Olivier
	3	-- Copyright (c) 1996-1999 Matra Datavision
973c2be1	4	-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e	5	--
973c2be1	6	-- This file is part of Open CASCADE Technology software library.
b311480e	7	--
d5f74e42	8	-- This library is free software; you can redistribute it and/or modify it under
d5f74e42	9	-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1	10	-- by the Free Software Foundation, with special exception defined in the file
	11	-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	-- distribution for complete text of the license and disclaimer of any warranty.
b311480e	13	--
973c2be1	14	-- Alternatively, this file may be used under the terms of Open CASCADE
973c2be1	15	-- commercial license or contractual agreement.
7fd59977	16
	17	class FixRelation from AIS inherits Relation from AIS
	18
	19
	20	---Purpose: Constructs and manages a constraint by a fixed
	21	-- relation between two or more interactive datums. This
	22	-- constraint is represented by a wire from a shape -
	23	-- point, vertex, or edge - in the first datum and a
	24	-- corresponding shape in the second.
	25	-- Warning: This relation is not bound with any kind of parametric
	26	-- constraint : it represents the "status" of an parametric
	27	-- object.
	28	uses
	29
	30	PresentationManager3d from PrsMgr,
	31	Presentation from Prs3d,
	32	Selection from SelectMgr,
	33	Shape from TopoDS,
	34	Vertex from TopoDS,
	35	Edge from TopoDS,
	36	Wire from TopoDS,
	37	Curve from Geom,
	38	Circ from gp,
	39	Lin from gp,
	40	Pnt from gp,
	41	Projector from Prs3d,
	42	Transformation from Geom,
7fd59977	43	Plane from Geom
	44
	45	is
	46	Create (aShape : Shape from TopoDS;
	47	aPlane : Plane from Geom;
	48	aWire : Wire from TopoDS)
	49	---Purpose: initializes the vertex aShape, the
	50	-- plane aPlane and the wire aWire, which connects
	51	-- the two vertices in a fixed relation.
6e33d3ce	52	returns FixRelation from AIS;
7fd59977	53
	54	Create (aShape : Shape from TopoDS;
	55	aPlane : Plane from Geom;
	56	aWire : Wire from TopoDS;
	57	aPosition : Pnt from gp;
	58	anArrowSize : Real from Standard = 0.01)
	59	---Purpose: initializes the vertex aShape, the
	60	-- plane aPlane and the wire aWire, the position
	61	-- aPosition, the arrow size anArrowSize and the
	62	-- wire aWire, which connects the two vertices in a fixed relation.
6e33d3ce	63	returns FixRelation from AIS;
7fd59977	64	Create (aShape : Shape from TopoDS;
	65	aPlane : Plane from Geom)
	66	---Purpose: initializes the edge aShape and the plane aPlane.
6e33d3ce	67	returns FixRelation from AIS;
7fd59977	68
	69	Create (aShape : Shape from TopoDS;
	70	aPlane : Plane from Geom;
	71	aPosition : Pnt from gp;
	72	anArrowSize : Real from Standard = 0.01)
	73	---Purpose: initializes the edge aShape, the
	74	-- plane aPlane, the position aPosition and the arrow
	75	-- size anArrowSize.
	76
6e33d3ce	77	returns FixRelation from AIS;
7fd59977	78
	79	Wire(me: mutable) returns Wire from TopoDS
	80	is static;
	81	---Purpose: Returns the wire which connects vertices in a fixed relation.
	82
	83	SetWire(me: mutable;aWire : Wire from TopoDS)
	84	is static;
	85	--- Purpose: Constructs the wire aWire. This connects vertices
	86	-- which are in a fixed relation.
	87
	88	IsMovable(me) returns Boolean from Standard
	89	---C++: inline
	90	---Purpose: Returns true if the Interactive Objects in the relation
	91	-- are movable.
	92	is redefined;
	93
	94	-- Methods from PresentableObject
	95
	96	Compute(me : mutable;
	97	aPresentationManager: PresentationManager3d from PrsMgr;
6e33d3ce	98	aPresentation : Presentation from Prs3d;
7fd59977	99	aMode : Integer from Standard= 0)
	100	is redefined static private;
	101
	102	Compute(me:mutable;
	103	aProjector: Projector from Prs3d;
6e33d3ce	104	aPresentation: Presentation from Prs3d)
7fd59977	105	is redefined static private;
128cc8df	106
7fd59977	107	Compute(me : mutable;
	108	aProjector : Projector from Prs3d;
	109	aTrsf : Transformation from Geom;
6e33d3ce	110	aPresentation : Presentation from Prs3d)
7fd59977	111	is redefined;
	112	---Purpose: computes the presentation according to a point of view
	113	-- given by <aProjector>.
	114	-- To be Used when the associated degenerated Presentations
	115	-- have been transformed by <aTrsf> which is not a Pure
	116	-- Translation. The HLR Prs can't be deducted automatically
	117	-- WARNING :<aTrsf> must be applied
	118	-- to the object to display before computation !!!
	119
	120	-- Methods from SelectableObject
	121
	122	ComputeSelection(me : mutable;
6e33d3ce	123	aSelection : Selection from SelectMgr;
7fd59977	124	aMode : Integer from Standard)
	125	is redefined private;
	126
	127
	128	--
	129	-- Computation private methods
	130	--
	131
	132	ComputeVertex(me : mutable;
	133	FixVertex : Vertex from TopoDS;
	134	curpos : out Pnt from gp)
	135	---Purpose: computes the presentation for <myFixShape> if it's a
	136	-- vertex.
	137	is private;
	138
	139
	140	ComputePosition(me;
	141	curv1 : Curve from Geom;
	142	curv2 : Curve from Geom;
	143	firstp1 : Pnt from gp;
	144	lastp1 : Pnt from gp ;
	145	firstp2 : Pnt from gp;
	146	lastp2 : Pnt from gp)
	147	returns Pnt from gp
	148	is private;
	149
	150
	151	ComputePosition(me;
	152	curv : Curve from Geom;
	153	firstp : Pnt from gp;
	154	lastp : Pnt from gp)
	155	returns Pnt from gp
	156	is private;
	157
	158
	159	ComputeEdge(me : mutable;
	160	FixEdge : Edge from TopoDS;
	161	curpos : out Pnt from gp)
	162	---Purpose: computes the presentation for <myFixShape> if it's a
	163	-- edge.
	164	is private;
	165
	166
	167	ComputeLinePosition(me : mutable;
	168	glin : Lin from gp;
	169	pos : out Pnt from gp;
	170	pfirst : out Real from Standard;
	171	plast : out Real from Standard)
	172	is private;
	173
	174
	175	ComputeCirclePosition(me : mutable;
	176	gcirc : Circ from gp;
	177	pos : out Pnt from gp;
	178	pfirst : out Real from Standard;
	179	plast : out Real from Standard)
	180	is private;
	181
	182	ConnectedEdges(myclass; aWire : Wire from TopoDS;
	183	aVertex : Vertex from TopoDS;
	184	Edge1,Edge2 : out Edge from TopoDS)
	185	returns Boolean from Standard
	186	is private;
	187
188
189	fields
190
191	myWire : Wire from TopoDS;
192	myPntAttach : Pnt from gp;
7fd59977	193
	194	end FixRelation;
	195