src/NLPlate/NLPlate_HPG0Constraint.cdl

   1 -- Created on: 1998-04-17
   2 -- Created by: Andre LIEUTIER
   3 -- Copyright (c) 1998-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
   9 -- under the terms of the GNU Lesser General Public 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  HPG0Constraint  from  NLPlate  inherits  HGPPConstraint from  NLPlate
  18 ---Purpose: define a PinPoint G0  Constraint  used to load a Non Linear
  19 --          Plate
  20 uses
  21      XY from gp,
  22      XYZ from gp
  23
  24 is
  25     Create(UV : XY; Value : XYZ) returns mutable HPG0Constraint;
  26     -- create a G0 Constraint
  27     --
  28
  29     SetUVFreeSliding(me: mutable; UVFree : Boolean)
  30     is  redefined;
  31     -- If True, allow the UV value to  be modified during optimization
  32     --  this  is meaningless (has  no  effect) on   non G0 Constraints
  33     -- default is False
  34     --
  35     --
  36
  37     SetIncrementalLoadAllowed(me: mutable; ILA : Boolean)
  38     is  redefined;
  39     -- If True, allow the Constraint to be loaded incrementally during optimization
  40     -- default is False
  41     --
  42
  43
  44     UVFreeSliding(me)  returns  Boolean
  45     is  redefined;
  46     -- If True, allow the UV value to be modified during optimization
  47     -- default is False
  48     --
  49
  50     IncrementalLoadAllowed(me)  returns  Boolean
  51     is redefined;
  52     -- If True, allow the Constraint to be loaded incrementally during optimization
  53     -- default is False
  54     --
  55
  56     ActiveOrder(me)  returns  Integer
  57     is   redefined;
  58     --  returns the constraint active  order, i.e. the maximum between
  59     --  -- the initial constraint i.e 0 (for G0 Constraints)
  60     --
  61     --
  62
  63     IsG0(me) returns Boolean
  64     is  redefined;
  65
  66     G0Target(me) returns XYZ
  67     ---C++: return const &
  68     is   redefined;
  69
  70 fields
  71     myXYZTarget : XYZ from gp;
  72     UVIsFree : Boolean;
  73     IncrementalLoadingAllowed : Boolean;
  74 end;