0024830: Remove redundant keyword 'mutable' in CDL declarations
[occt.git] / src / NLPlate / NLPlate_HPG1Constraint.cdl
CommitLineData
b311480e 1-- Created on: 1998-04-17
2-- Created by: Andre LIEUTIER
3-- Copyright (c) 1998-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class HPG1Constraint from NLPlate inherits HGPPConstraint from NLPlate
18---Purpose: define a PinPoint (no G0) G1 Constraint used to load a Non
19-- Linear Plate
20uses
21 XY from gp,
22 D1 from Plate
23
24is
6e33d3ce 25 Create(UV : XY; D1T : D1 from Plate) returns HPG1Constraint;
7fd59977 26 -- create a G1 Constraint
27 --
28
29
30 SetIncrementalLoadAllowed(me: mutable; ILA : Boolean)
31 is redefined;
32 -- If True, allow the Constraint to be loaded incrementally during optimization
33 -- default is False
34 --
35
36 SetOrientation(me: mutable; Orient : Integer = 0)
37 is redefined;
38 -- set the orientation (meaningless for non G1 Constraints)
39 -- -1 means that the Surface Normal have to be -1*the Constraint Normal
40 -- 0 means that G1 constraint is up to a normal inversion (default value)
41 -- 1 means that the Surface Normal have to be equal to the Constraint Normal.
42 -- remarks : within the current implementation, this is effective only in case of
43 -- incremental loading computation
44
45
46 IncrementalLoadAllowed(me) returns Boolean
47 is redefined;
48 -- If True, allow the Constraint to be loaded incrementally during optimization
49 -- default is False
50 --
51
52 ActiveOrder(me) returns Integer
53 is redefined;
54 -- returns the constraint active order, i.e. the maximum between
55 -- -- the initial constraint i.e 1 (for G1 Constraints)
56 --
57 --
58
59 IsG0(me) returns Boolean
60 is redefined;
61
62 Orientation(me: mutable) returns Integer
63 is redefined;
64 -- set the orientation (meaningless for non G1 Constraints)
65 -- -1 means that the Surface Normal have to be -1*the Constraint Normal
66 -- 0 means that G1 constraint is up to a normal inversion (default value)
67 -- 1 means that the Surface Normal have to be equal to the Constraint Normal.
68 -- remarks : within the current implementation, this is effective only in case of
69 -- incremental loading computation
70 --
71
72 G1Target(me) returns D1 from Plate
73 ---C++: return const &
74 is redefined;
75
76fields
77 IncrementalLoadingAllowed : Boolean;
78 myG1Target : D1 from Plate;
79 myOrientation : Integer;
80end;