1 -- Created on: 1992-01-17
3 -- Copyright (c) 1992-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
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.
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.
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.
21 -- Modified: GG 23/11/00 Add Display(),Erase(),IsDisplayed() methods
29 ---Purpose: Defines the services of Plane type objects. Only
30 -- the creation and editing of the functions is dealt
32 -- Warning: The representation of the clipping plane must be
33 -- calculated by the application by means of Graphic3d.
34 -- Editing of this representation must be coherent with
35 -- respect to the position of the plane.
40 ClipPlane from Visual3d,
41 Structure from Graphic3d,
42 Parameter from Quantity,
56 Create (A: Parameter = 0.0;
60 ) returns mutable Plane
62 ---Purpose: Creates a clipping plane using the equation :
63 -- <A>*X + <B>*Y + <C>*Z + <D> = 0.0
64 raises BadValue from V3d;
65 ---Purpose: Warning! raises BadValue from V3d
66 -- if the norm of the plane is NULL.
68 --------------------------------------------------------
69 ---Category: Methods to modify the Attributs of the Plane
70 --------------------------------------------------------
72 SetPlane( me : mutable; A,B,C,D : Parameter)
74 ---Purpose: Modifies the plane equation.
75 raises BadValue from V3d
76 ---Purpose: Warning! raises BadValue from V3d
77 -- if the norm of the plane is NULL.
78 -- If the norm of the plane is NULL.
81 Display(me: mutable; aView: View from V3d;
82 aColor: Color from Quantity= Quantity_NOC_GRAY)
84 ---Purpose: Display the plane representation
85 -- in the choosen view.
88 Erase(me: mutable) is static;
90 ---Purpose: Erase the plane representation.
92 ---------------------------------------------------
93 ---Category: Inquire methods
94 ---------------------------------------------------
96 Plane( me ; A,B,C,D : out Parameter ) is static;
98 ---Purpose: Returns the parameters of the plane .
100 IsDisplayed( me ) returns Boolean from Standard is static;
102 ---Purpose: Returns TRUE when the plane representation is displayed
104 -----------------------------------------
105 ---Category: Private or Protected methods
106 -----------------------------------------
108 Plane( me) returns mutable ClipPlane from Visual3d is static private ;
110 ---Purpose: Returns the associated plane from Visual3d.
112 Update( me : mutable ) is static private;
114 ---Purpose: Updates the the plane representation.
119 MyPlane: ClipPlane from Visual3d ;
120 MyGraphicStructure: Structure from Graphic3d is protected;
124 SetPlaneOn from class View from V3d ( me : mutable ),
125 SetPlaneOn from class View from V3d
126 ( me : mutable ; Plane : Plane from V3d ),
127 SetPlaneOff from class View from V3d ( me : mutable ),
128 SetPlaneOff from class View from V3d
129 ( me : mutable ; Plane : Plane from V3d )