Test for 0022778: Bug in BRepMesh

[occt.git] / src / Graphic3d / Graphic3d_VertexN.cdl

-- Created by: NW,JPB,CAL
-- Copyright (c) 1991-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.

-- Modified:	03-02-98 : FMN ; Add Flag Normal

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

--\f

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;