summaryrefslogtreecommitdiff
path: root/src/Graphic3d/Graphic3d_VertexN.cdl
blob: d16a67dcee82d5a56b73e4f53a88f90cfc8894bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
--
-- File:	Graphic3d_VertexN.cdl
-- Created:	Jeudi 22 Aout 1991
-- Author:	NW,JPB,CAL
-- Modified:	03-02-98 : FMN ; Add Flag Normal
--
---Copyright:	MatraDatavision 1991,1992,1993
--

class VertexN from Graphic3d inherits Vertex from Graphic3d

	---Version:

	---Purpose: This class allows the creation and update of
	--	    a vertex with a 3D normal.

	---Keywords: Vertex, Normal, Coordinate, Point

	---Warning:
	---References:

uses

	Vector	from Graphic3d

is

	Create
		returns VertexN from Graphic3d;
	---Level: Public
	---Purpose: Creates a point with 0.0, 0.0, 0.0 coordinates
	--	    for which the normal is 0.0, 0.0, 1.0.

	Create ( AX, AY, AZ	: Real from Standard;
		 ANX, ANY, ANZ	: Real from Standard;
		 FlagNormalise  : Boolean from Standard = Standard_True )
		returns VertexN from Graphic3d;
	---Level: Public
	---Purpose: Creates a point with coordinates <AX>, <AY>, <AZ> and
	--	    for which the normal is <ANX>, <ANY>, <ANZ>.
	--	    If <FlagNormalise> is True the normal is already normalised
	--	    Else the normal is not normalised, the graphic do it.

	Create ( APoint		: Vertex from Graphic3d;
		 AVector	: Vector from Graphic3d;
		 FlagNormalise  : Boolean from Standard = Standard_True )
		returns VertexN from Graphic3d;
	---Level: Public
	---Purpose: Creates a point in <APoint> for which the normal is <AVector>. 
	--	    If <FlagNormalise> is True the normal is already normalised
	--	    Else the normal is not normalised, the graphic do it.

	---------------------------------------------------
	-- Category: Methods to modify the class definition
	---------------------------------------------------

	SetNormal ( me			: in out;
		    NXnew, NYnew, NZnew	: Real from Standard;
		    FlagNormalise  : Boolean from Standard = Standard_True )
		is static;
	---Level: Public
	---Purpose: Modifies the normal to the point <me>.
	--	    If <FlagNormalise> is True the normal is already normalised
	--	    Else the normal is not normalised, the graphic do it.
	---Category: Methods to modify the class definition

	----------------------------
	-- Category: Inquire methods
	----------------------------

	Normal ( me;
		 ANX, ANY, ANZ	: out Real from Standard )
		is static;
	---Level: Public
	---Purpose: Returns the normal to the point <me>.
	---Category: Inquire methods

--

fields

--
-- Class	:	Graphic3d_VertexN
--
-- Purpose	:	Declaration of variables specific to points.
--
-- Reminder	:	A point is defined by its coordinates and its normal.

	-- the normale to the point
	MyDX	:	ShortReal from Standard;
	MyDY	:	ShortReal from Standard;
	MyDZ	:	ShortReal from Standard;

end VertexN;