Files
OCCT/src/IntSurf/IntSurf_PathPointTool.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

134 lines
4.0 KiB
Plaintext
Executable File

-- Created on: 1992-09-25
-- Created by: Jacques GOUSSARD
-- Copyright (c) 1992-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.
class PathPointTool from IntSurf
uses Pnt from gp,
Vec from gp,
Dir2d from gp,
PathPoint from IntSurf
raises OutOfRange from Standard,
UndefinedDerivative from StdFail
is
Value3d(myclass; PStart: PathPoint from IntSurf)
---Purpose: Returns the 3d coordinates of the starting point.
returns Pnt from gp;
---C++: inline
Value2d(myclass; PStart: PathPoint from IntSurf;
U, V: out Real from Standard);
---Purpose: Returns the <U, V> parameters which are associated
-- with <P>
-- it's the parameters which start the marching algorithm
---C++: inline
IsPassingPnt(myclass; PStart: PathPoint from IntSurf)
---Purpose: Returns True if the point is a point on a non-oriented
-- arc, which means that the intersection line does not
-- stop at such a point but just go through such a point.
-- IsPassingPnt is True when IsOnArc is True
returns Boolean from Standard;
---C++: inline
IsTangent(myclass; PStart: PathPoint from IntSurf )
---Purpose: Returns True if the surfaces are tangent at this point.
-- IsTangent can be True when IsOnArc is True
-- if IsPassingPnt is True and IsTangent is True,this point
-- is a stopped point.
returns Boolean from Standard;
---C++: inline
Direction3d(myclass; PStart: PathPoint from IntSurf)
---Purpose: returns the tangent at the intersection in 3d space
-- associated to <P>
-- an exception is raised if IsTangent is true.
returns Vec from gp
---C++: inline
raises UndefinedDerivative from StdFail;
Direction2d(myclass; PStart: PathPoint from IntSurf)
---Purpose: returns the tangent at the intersection in the
-- parametric space of the parametrized surface.This tangent
-- is associated to the value2d
-- la tangente a un sens signifiant (indique le sens de chemin
-- ement)
-- an exception is raised if IsTangent is true.
returns Dir2d from gp
---C++: inline
raises UndefinedDerivative from StdFail;
Multiplicity(myclass; PStart: PathPoint from IntSurf)
---Purpose: Returns the multiplicity of the point i-e
-- the number of auxillar parameters associated to the
-- point which the principal parameters are given by Value2d
returns Integer from Standard;
---C++: inline
Parameters(myclass; PStart: PathPoint from IntSurf;
Mult: Integer from Standard;
U, V: out Real from Standard)
---Purpose: Parametric coordinates associated to the multiplicity.
-- An exception is raised if Mult<=0 or Mult>multiplicity.
---C++: inline
raises OutOfRange from Standard;
end PathPointTool;