src/HatchGen/HatchGen_Domain.cdl

   1 -- Created on: 1993-11-05
   2 -- Created by: Jean Marc LACHAUME
   3 -- Copyright (c) 1993-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class Domain from HatchGen
  18
  19 uses
  20     PointOnHatching from HatchGen
  21
  22 raises
  23     DomainError from Standard
  24
  25 is
  26
  27     Create
  28
  29         ---Purpose: Creates an infinite domain.
  30
  31         returns Domain from HatchGen ;
  32
  33
  34     Create (P1, P2 : PointOnHatching from HatchGen)
  35
  36         ---Purpose: Creates a domain for the curve associated to a hatching.
  37
  38         returns Domain from HatchGen ;
  39
  40
  41     Create (P : PointOnHatching from HatchGen ; First : Boolean from Standard)
  42
  43         ---Purpose: Creates a semi-infinite domain for the curve associated
  44         --          to a hatching. The `First' flag means that the given
  45         --          point is the first one.
  46
  47         returns Domain from HatchGen ;
  48
  49
  50     SetPoints (me : in out ; P1, P2 : PointOnHatching from HatchGen)
  51
  52         ---Purpose: Sets the first and the second points of the domain.
  53
  54         ---C++: inline
  55         is static ;
  56
  57
  58     SetPoints (me : in out)
  59
  60         ---Purpose: Sets the first and the second points of the domain
  61         --          as the infinite.
  62
  63         ---C++: inline
  64         is static ;
  65
  66
  67     SetFirstPoint (me : in out ; P : PointOnHatching from HatchGen)
  68
  69         ---Purpose: Sets the first point of the domain.
  70
  71         ---C++: inline
  72         is static ;
  73
  74
  75     SetFirstPoint (me : in out)
  76
  77         ---Purpose: Sets the first point of the domain at the
  78         --          infinite.
  79
  80         ---C++: inline
  81         is static ;
  82
  83
  84     SetSecondPoint (me : in out ; P : PointOnHatching from HatchGen)
  85
  86         ---Purpose: Sets the second point of the domain.
  87
  88         ---C++: inline
  89         is static ;
  90
  91
  92     SetSecondPoint (me : in out)
  93
  94         ---Purpose: Sets the second point of the domain at the
  95         --          infinite.
  96
  97         ---C++: inline
  98         is static ;
  99
 100
 101     HasFirstPoint (me)
 102
 103         ---Purpose: Returns True if the domain has a first point.
 104
 105         ---C++: inline
 106         returns Boolean from Standard
 107         is static ;
 108
 109
 110     FirstPoint (me)
 111
 112         ---Purpose: Returns the first point of the domain.
 113         --          The exception DomainError is raised if
 114         --          HasFirstPoint returns False.
 115
 116         ---C++: inline
 117         ---C++: return const &
 118
 119         returns PointOnHatching from HatchGen
 120         raises DomainError from Standard
 121         is static ;
 122
 123
 124     HasSecondPoint (me)
 125
 126         ---Purpose: Returns True if the domain has a second point.
 127
 128         ---C++: inline
 129         returns Boolean from Standard
 130         is static ;
 131
 132
 133     SecondPoint (me)
 134
 135         ---Purpose: Returns the second point of the domain.
 136         --          The exception DomainError is raised if
 137         --          HasSecondPoint returns False.
 138
 139         ---C++: inline
 140         ---C++: return const &
 141
 142         returns PointOnHatching from HatchGen
 143         raises DomainError from Standard
 144         is static ;
 145
 146
 147     Dump (me; Index : Integer from Standard = 0)
 148
 149         ---Purpose: Dump of the domain.
 150
 151         is static ;
 152
 153
 154 fields
 155
 156     myHasFirstPoint  : Boolean         from Standard ;
 157     myFirstPoint     : PointOnHatching from HatchGen ;
 158     myHasSecondPoint : Boolean         from Standard ;
 159     mySecondPoint    : PointOnHatching from HatchGen ;
 160
 161 end Domain from HatchGen ;