src/Prs3d/Prs3d_DatumAspect.cdl

   1 -- Created on: 1993-07-30
   2 -- Created by: Jean-Louis FRENKEL
   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 DatumAspect from Prs3d inherits BasicAspect from Prs3d
  18         ---Purpose: A framework to define the display of datums.
  19 uses
  20
  21     LineAspect from Prs3d,
  22     Length from Quantity
  23 is
  24
  25     Create returns DatumAspect from Prs3d;
  26         ---Purpose: An empty framework to define the display of datums.
  27
  28     FirstAxisAspect(me) returns LineAspect from Prs3d;
  29         ---Purpose: Returns the attributes for display of the first axis.
  30     SecondAxisAspect(me) returns LineAspect from Prs3d;
  31         ---Purpose: Returns the attributes for display of the second axis.
  32     ThirdAxisAspect(me) returns LineAspect from Prs3d;
  33         ---Purpose: Returns the attributes for display of the third axis.
  34     SetDrawFirstAndSecondAxis(me:mutable ; draw: Boolean from Standard);
  35         ---Purpose: Sets the DrawFirstAndSecondAxis attributes to active.
  36
  37     DrawFirstAndSecondAxis(me) returns Boolean from Standard;
  38         ---Purpose: Returns true if the first and second axes can be drawn.
  39
  40     SetDrawThirdAxis(me:mutable; draw: Boolean from Standard);
  41         ---Purpose: Sets the DrawThirdAxis attributes to active.
  42
  43     DrawThirdAxis(me) returns Boolean from Standard;
  44         ---Purpose: Returns true if the third axis can be drawn.
  45     SetAxisLength(me:mutable; L1,L2,L3: Real from Standard);
  46         ---Purpose: Sets the lengths L1, L2 and L3 of the three axes.
  47
  48     FirstAxisLength(me) returns Length from Quantity;
  49         --- Purpose: Returns the length of the displayed first axis.
  50
  51     SecondAxisLength(me) returns Length from Quantity;
  52         ---Purpose: Returns the length of the displayed second axis.
  53
  54     ThirdAxisLength(me) returns Length from Quantity;
  55         ---Purpose: Returns the length of the displayed third axis.
  56
  57 fields
  58
  59     myFirstAxisAspect: LineAspect from Prs3d;
  60     mySecondAxisAspect: LineAspect from Prs3d;
  61     myThirdAxisAspect: LineAspect from Prs3d;
  62     myDrawFirstAndSecondAxis: Boolean from Standard;
  63     myDrawThirdAxis: Boolean from Standard;
  64     myFirstAxisLength: Length from Quantity;
  65     mySecondAxisLength: Length from Quantity;
  66     myThirdAxisLength: Length from Quantity;
  67 end DatumAspect from Prs3d;
  68