src/AIS/AIS_Point.cdl

   1 -- Created on: 1995-08-09
   2 -- Created by: Arnaud BOUZY
   3 -- Copyright (c) 1995-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 Point from AIS inherits InteractiveObject from AIS
  18
  19         ---Purpose: Constructs point datums to be used in construction of
  20         -- composite shapes. The datum is displayed as the plus marker +.
  21
  22 uses
  23     Point                 from Geom,
  24     TypeOfMarker          from Aspect,
  25     Presentation          from Prs3d,
  26     PresentationManager3d from PrsMgr,
  27     NameOfColor           from Quantity,
  28     Color                         from Quantity,
  29     Selection             from SelectMgr,
  30     Projector             from Prs3d,
  31     Transformation        from Geom,
  32     Vertex                from TopoDS,
  33     KindOfInteractive     from AIS
  34
  35
  36 is
  37     Create(aComponent : Point from Geom)
  38     returns Point from AIS;
  39         ---Purpose:
  40         -- Initializes the point aComponent from which the point
  41         -- datum will be built.
  42
  43     Signature(me) returns Integer from Standard is redefined;
  44          ---Purpose: Returns index 1, the default index for a point.
  45          ---C++: inline
  46
  47     Type(me) returns KindOfInteractive from AIS is redefined;
  48         ---Purpose: Indicates that a point is a datum.
  49         ---C++: inline
  50
  51     Component(me: mutable) returns Point from Geom
  52     is static;
  53         ---Purpose: Returns the component specified in SetComponent.
  54     SetComponent(me: mutable;aComponent:Point from Geom )
  55     is static;
  56         ---Purpose: Constructs an instance of the point aComponent.
  57     AcceptDisplayMode(me;aMode:Integer from Standard) returns Boolean from  Standard is redefined static;
  58         ---Purpose: Returns true if the display mode selected is valid for point datums.
  59
  60     Compute(me            : mutable;
  61             aPresentationManager: PresentationManager3d from PrsMgr;
  62             aPresentation : Presentation from Prs3d;
  63             aMode         : Integer from Standard = 0)
  64     is redefined virtual protected;
  65
  66     Compute(me:mutable;
  67                 aProjector: Projector from Prs3d;
  68                 aPresentation: Presentation from Prs3d)
  69     is redefined static private;
  70
  71     Compute(me            : mutable;
  72             aProjector    : Projector from Prs3d;
  73             aTrsf         : Transformation from Geom;
  74             aPresentation : Presentation from Prs3d)
  75     is redefined;
  76         ---Purpose: computes the presentation according to a point of view
  77         --          given by <aProjector>.
  78         --          To be Used when the associated degenerated Presentations
  79         --          have been transformed by <aTrsf> which is not a Pure
  80         --          Translation. The HLR Prs can't be deducted automatically
  81         --          WARNING :<aTrsf> must be applied
  82         --           to the object to display before computation  !!!
  83
  84 -- Methods from SelectableObject
  85
  86     ComputeSelection(me         : mutable;
  87                      aSelection : Selection from SelectMgr;
  88                      aMode      : Integer from Standard )is private;
  89
  90 -- Methods from InteractiveObject
  91
  92     SetColor(me :mutable; aColor : NameOfColor from Quantity)
  93     is redefined static;
  94         ---Purpose: Allows you to provide settings for the cp;pr aColor.
  95     SetColor(me :mutable; aColor : Color from Quantity)
  96     is redefined static;
  97
  98     UnsetColor(me:mutable) is redefined static;
  99         ---Purpose: Allows you to remove color settings.
 100     SetMarker(me:mutable; aType : TypeOfMarker from Aspect);
 101         ---Purpose: Allows you to provide settings for a marker. These include
 102         -- -   type of marker,
 103         -- -   marker color,
 104         -- -   scale factor.
 105
 106     UnsetMarker(me:mutable);
 107         ---Purpose: Removes the marker settings.
 108     HasMarker(me) returns Boolean from Standard;
 109         ---Purpose: Returns true if the point datum has a marker.
 110         ---C++: inline
 111
 112     Vertex(me) returns Vertex from TopoDS;
 113         ---Purpose: Converts a point into a vertex.
 114     UpdatePointValues(me:mutable) is private;
 115         ---Level: Internal
 116
 117
 118
 119 fields
 120
 121     myComponent   : Point from Geom;
 122     myHasTOM      : Boolean from Standard;
 123     myTOM         : TypeOfMarker from Aspect;
 124 end Point;