Files
OCCT/src/Geom2dHatch/Geom2dHatch_Hatcher.cdl
dln 0b85f9a605 0024761: Convertation of the generic classes to the non-generic. Part 5
1) Generic class "GccEnt_QualifiedCurv" from "GccEnt" package converted to the non-generic class and moved to the "Geom2dGcc" package. Name of this class was changed to "Geom2dGcc_QCurve".

2) Generic classes "HatchGen_ElementGen", "HatchGen_ElementsGen", "HatchGen_HatchingGen" and "HatchGen_Hatcher" from "HatchGen" package converted to the non-generic classes and moved to the "Geom2dHatch" package. Names of this classes were changed to "Geom2dHatch_Element", "Geom2dHatch_Elements", "Geom2dHatch_Hatching" and "Geom2dHatch_Hatcher". Also all instantiations of the "internal" classes of this classes were moved to the "Geom2dHatch.cdl".

3) Generic classes "Extrema_GExtCC", "Extrema_GExtCC2d", "Extrema_GLocateExtCC" and "Extrema_GLocateExtCC2d" from "Extrema" package converted to the non-generic classes. Names of this classes were changed to "Extrema_ExtCC", "Extrema_ExtCC2d", "Extrema_LocateExtCC" and "Extrema_LocateExtCC2d". Also all instantiations of the "internal" classes of this classes were moved to the "Extrema.cdl".
2014-04-04 12:57:39 +04:00

492 lines
11 KiB
Plaintext

-- Created on: 1993-10-25
-- Created by: Jean Marc LACHAUME
-- Copyright (c) 1993-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 Hatcher from Geom2dHatch
uses
MapIntegerHasher from TColStd,
PointOnHatching from HatchGen,
Orientation from TopAbs,
State from TopAbs,
Domain from HatchGen,
ErrorStatus from HatchGen,
Curve from Geom2dAdaptor,
Intersector from Geom2dHatch,
Element from Geom2dHatch,
Elements from Geom2dHatch,
Hatching from Geom2dHatch,
Hatchings from Geom2dHatch,
Classifier from Geom2dHatch
raises
NoSuchObject from Standard ,
OutOfRange from Standard ,
NotDone from StdFail
----------------------------------------------------------------------
-- class Hatcher description.
----------------------------------------------------------------------
is
---Category: General use
Create (Intersector : Intersector from Geom2dHatch ;
Confusion2d : Real from Standard ;
Confusion3d : Real from Standard ;
KeepPnt : Boolean from Standard = Standard_False ;
KeepSeg : Boolean from Standard = Standard_False)
---Purpose: Returns an empty hatcher.
returns Hatcher from Geom2dHatch;
Intersector (me : in out ; Intersector : Intersector from Geom2dHatch)
---Purpose: Sets the associated intersector.
is static ;
Intersector (me : in out)
---Purpose: Returns the associated intersector.
---C++: inline
---C++: return const &
returns Intersector from Geom2dHatch
is static ;
ChangeIntersector (me : in out)
---Purpose: Returns the associated intersector.
---C++: inline
---C++: return &
returns Intersector from Geom2dHatch
is static ;
Confusion2d (me : in out ; Confusion : Real from Standard)
---Purpose: Sets the confusion tolerance.
is static ;
Confusion2d (me)
---Purpose: Returns the 2d confusion tolerance, i.e. the value under
-- which two points are considered identical in the
-- parametric space of the hatching.
---C++: inline
returns Real from Standard
is static ;
Confusion3d (me : in out ; Confusion : Real from Standard)
---Purpose: Sets the confusion tolerance.
is static ;
Confusion3d (me)
---Purpose: Returns the 3d confusion tolerance, i.e. the value under
-- which two points are considered identical in the
-- 3d space of the hatching.
---C++: inline
returns Real from Standard
is static ;
KeepPoints (me : in out; Keep : Boolean from Standard)
---Purpose: Sets the above flag.
is static ;
KeepPoints (me)
---Purpose: Returns the flag about the points consideration.
---C++: inline
returns Boolean from Standard
is static ;
KeepSegments (me : in out; Keep : Boolean from Standard)
---Purpose: Sets the above flag.
is static ;
KeepSegments (me)
---Purpose: Returns the flag about the segments consideration.
---C++: inline
returns Boolean from Standard
is static ;
Clear (me : in out)
---Purpose: Removes all the hatchings and all the elements.
---C++: inline
is static ;
---Category: Element
Element (me : in out ; IndE : Integer from Standard)
---Purpose: Returns the IndE-th element.
---Category: Element
---C++: inline
---C++: return &
returns Element from Geom2dHatch
raises NoSuchObject from Standard
is static protected ;
ElementCurve (me; IndE : Integer from Standard)
---Purpose: Returns the curve associated to the IndE-th element.
---Category: Element
---C++: inline
---C++: return const &
returns Curve from Geom2dAdaptor
raises NoSuchObject from Standard
is static ;
AddElement (me : in out ; Curve : Curve from Geom2dAdaptor ;
Orientation : Orientation from TopAbs = TopAbs_FORWARD)
---Purpose: Adds an element to the hatcher and returns its index.
---Category: Element
returns Integer from Standard
is static ;
RemElement (me : in out ; IndE : Integer from Standard)
---Purpose: Removes the IndE-th element from the hatcher.
---Category: Element
raises NoSuchObject from Standard
is static ;
ClrElements (me : in out)
---Purpose: Removes all the elements from the hatcher.
---Category: Element
is static ;
---Category: Hatching
Hatching (me : in out ; IndH : Integer from Standard)
---Purpose: Returns the IndH-th hatching.
---Category: Hatching
---C++: inline
---C++: return &
returns Hatching from Geom2dHatch
raises NoSuchObject from Standard
is static protected ;
HatchingCurve (me; IndH : Integer from Standard)
---Purpose: Returns the curve associated to the IndH-th hatching.
---Category: Hatching
---C++: inline
---C++: return const &
returns Curve from Geom2dAdaptor
raises NoSuchObject from Standard
is static ;
AddHatching (me : in out ; Curve : Curve from Geom2dAdaptor)
---Purpose: Adds a hatching to the hatcher and returns its index.
---Category: Hatching
returns Integer from Standard
is static ;
RemHatching (me : in out ; IndH : Integer from Standard)
---Purpose: Removes the IndH-th hatching from the hatcher.
---Category: Hatching
raises NoSuchObject from Standard
is static ;
ClrHatchings (me : in out)
---Purpose: Removes all the hatchings from the hatcher.
---Category: Hatching
is static ;
NbPoints (me; IndH : Integer from Standard)
---Purpose: Returns the number of intersection points of
-- the IndH-th hatching.
---Category: Hatching - Test
---C++: inline
returns Integer from Standard
raises NoSuchObject from Standard
is static ;
Point (me; IndH, IndP : Integer from Standard)
---Purpose: Returns the IndP-th intersection point of the
-- IndH-th hatching.
---Category: Hatching - Test
---C++: inline
---C++: return const &
returns PointOnHatching from HatchGen
raises NoSuchObject from Standard,
OutOfRange from Standard
is static ;
---Category: Computation - Trimming
Trim (me : in out)
---Purpose: Trims all the hatchings of the hatcher by all the
-- elements of the hatcher.
is static ;
Trim (me : in out ; Curve : Curve from Geom2dAdaptor)
---Purpose: Adds a hatching to the hatcher and trims it by
-- the elements already given and returns its index.
---Category: Computation
returns Integer from Standard
is static ;
Trim (me : in out ; IndH : Integer from Standard)
---Purpose: Trims the IndH-th hatching by the elements
-- already given.
---Category: Computation
raises NoSuchObject from Standard
is static ;
Trim (me : in out ; IndH, IndE : Integer from Standard)
---Purpose: Trims the IndH-th hatching of the hatcher by the
-- IndE-th element.
---Category: Computation
returns Boolean from Standard
is static private ;
---Category: Computation - Domains
GlobalTransition (me : in out; Point : in out PointOnHatching from HatchGen)
---Purpose: Sets the global transition (the before and after
-- states and segment extremities flags) of the point.
---Category: Computation - Domains
returns Boolean from Standard
is static private ;
ComputeDomains (me : in out)
---Purpose: Computes the domains of all the hatchings.
---Category: Computation - Domains
is static ;
ComputeDomains (me : in out ; IndH : Integer from Standard)
---Purpose: Computes the domains of the IndH-th hatching.
---Category: Computation - Domains
raises NoSuchObject from Standard
is static ;
---Category: Results
TrimDone (me; IndH : Integer from Standard)
---Purpose: Returns the fact that the intersections were computed
-- for the IndH-th hatching.
---C++: inline
returns Boolean from Standard
raises NoSuchObject from Standard
is static ;
TrimFailed (me; IndH : Integer from Standard)
---Purpose: Returns the fact that the intersections failed
-- for the IndH-th hatching.
---C++: inline
returns Boolean from Standard
raises NoSuchObject from Standard
is static ;
IsDone (me)
---Purpose: Returns the fact that the domains were computed
-- for all the hatchings.
---C++: inline
returns Boolean from Standard
raises NoSuchObject from Standard
is static ;
IsDone (me; IndH : Integer from Standard)
---Purpose: Returns the fact that the domains were computed
-- for the IndH-th hatching.
returns Boolean from Standard
raises NoSuchObject from Standard
is static ;
Status (me; IndH : Integer from Standard)
---Purpose: Returns the status about the IndH-th hatching.
---C++: inline
returns ErrorStatus from HatchGen
raises NoSuchObject from Standard
is static ;
NbDomains (me; IndH : Integer from Standard)
---Purpose: Returns the number of domains of the IndH-th hatching.
-- Only ONE "INFINITE" domain means that the hatching is
-- fully included in the contour defined by the elements.
---C++: inline
returns Integer from Standard
raises NoSuchObject from Standard ,
NotDone from StdFail
is static ;
Domain (me; IndH : Integer from Standard ;
IDom : Integer from Standard )
---Purpose: Returns the IDom-th domain of the IndH-th hatching.
---C++: return const &
returns Domain from HatchGen
raises NoSuchObject from Standard ,
NotDone from StdFail ,
OutOfRange from Standard
is static ;
---Category: Dump
Dump (me)
---Purpose: Dump the hatcher.
is static ;
fields
myIntersector : Intersector from Geom2dHatch;
myConfusion2d : Real from Standard ;
myConfusion3d : Real from Standard ;
myKeepPoints : Boolean from Standard ;
myKeepSegments : Boolean from Standard ;
myNbElements : Integer from Standard ;
myElements : Elements from Geom2dHatch ;
myNbHatchings : Integer from Standard ;
myHatchings : Hatchings from Geom2dHatch;
end Hatcher from Geom2dHatch;