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-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21 --   GG  :  GER61351 17/11/1999 Change SetColor() with a compatible Quantity_Color instead
  22 --                                     the restricted NameOfColor.
  23
  24 class Point from AIS inherits InteractiveObject from AIS
  25
  26         ---Purpose: Constructs point datums to be used in construction of
  27         -- composite shapes. The datum is displayed as the plus marker +.
  28
  29 uses
  30     Point                 from Geom,
  31     TypeOfMarker          from Aspect,
  32     Presentation          from Prs3d,
  33     PresentationManager3d from PrsMgr,
  34     NameOfColor           from Quantity,
  35     Color                         from Quantity,
  36     Selection             from SelectMgr,
  37     Projector             from Prs3d,
  38     Transformation        from Geom,
  39     PresentationManager2d from PrsMgr,
  40     GraphicObject         from Graphic2d,
  41     Vertex                from TopoDS,
  42     KindOfInteractive     from AIS
  43
  44
  45 is
  46     Create(aComponent : Point from Geom)
  47     returns mutable Point from AIS;
  48         ---Purpose:
  49         -- Initializes the point aComponent from which the point
  50         -- datum will be built.
  51
  52     Signature(me) returns Integer from Standard is redefined;
  53          ---Purpose: Returns index 1, the default index for a point.
  54          ---C++: inline
  55
  56     Type(me) returns KindOfInteractive from AIS is redefined;
  57         ---Purpose: Indicates that a point is a datum.
  58         ---C++: inline
  59
  60     Component(me: mutable) returns Point from Geom
  61     is static;
  62         ---Purpose: Returns the component specified in SetComponent.
  63     SetComponent(me: mutable;aComponent:Point from Geom )
  64     is static;
  65         ---Purpose: Constructs an instance of the point aComponent.
  66     AcceptDisplayMode(me;aMode:Integer from Standard) returns Boolean from  Standard is redefined static;
  67         ---Purpose: Returns true if the display mode selected is valid for point datums.
  68
  69     Compute(me            : mutable;
  70             aPresentationManager: PresentationManager3d from PrsMgr;
  71             aPresentation : mutable Presentation from Prs3d;
  72             aMode         : Integer from Standard = 0)
  73     is redefined virtual protected;
  74
  75     Compute(me:mutable;
  76                 aProjector: Projector from Prs3d;
  77                 aPresentation: mutable Presentation from Prs3d)
  78     is redefined static private;
  79
  80     Compute(me:mutable;
  81             aPresentationManager: PresentationManager2d from PrsMgr;
  82             aPresentation: mutable GraphicObject from Graphic2d;
  83             aMode: Integer from Standard = 0)
  84     is redefined static private;
  85
  86     Compute(me            : mutable;
  87             aProjector    : Projector from Prs3d;
  88             aTrsf         : Transformation from Geom;
  89             aPresentation : mutable Presentation from Prs3d)
  90     is redefined;
  91         ---Purpose: computes the presentation according to a point of view
  92         --          given by <aProjector>.
  93         --          To be Used when the associated degenerated Presentations
  94         --          have been transformed by <aTrsf> which is not a Pure
  95         --          Translation. The HLR Prs can't be deducted automatically
  96         --          WARNING :<aTrsf> must be applied
  97         --           to the object to display before computation  !!!
  98
  99 -- Methods from SelectableObject
 100
 101     ComputeSelection(me         : mutable;
 102                      aSelection : mutable Selection from SelectMgr;
 103                      aMode      : Integer from Standard )is private;
 104
 105 -- Methods from InteractiveObject
 106
 107     SetColor(me :mutable; aColor : NameOfColor from Quantity)
 108     is redefined static;
 109         ---Purpose: Allows you to provide settings for the cp;pr aColor.
 110     SetColor(me :mutable; aColor : Color from Quantity)
 111     is redefined static;
 112
 113     UnsetColor(me:mutable) is redefined static;
 114         ---Purpose: Allows you to remove color settings.
 115     SetMarker(me:mutable; aType : TypeOfMarker from Aspect);
 116         ---Purpose: Allows you to provide settings for a marker. These include
 117         -- -   type of marker,
 118         -- -   marker color,
 119         -- -   scale factor.
 120
 121     UnsetMarker(me:mutable);
 122         ---Purpose: Removes the marker settings.
 123     HasMarker(me) returns Boolean from Standard;
 124         ---Purpose: Returns true if the point datum has a marker.
 125         ---C++: inline
 126
 127     Vertex(me) returns Vertex from TopoDS;
 128         ---Purpose: Converts a point into a vertex.
 129     UpdatePointValues(me:mutable) is private;
 130         ---Level: Internal
 131
 132
 133
 134 fields
 135
 136     myComponent   : Point from Geom;
 137     myHasTOM      : Boolean from Standard;
 138     myTOM         : TypeOfMarker from Aspect;
 139 end Point;