Integration of OCCT 6.5.0 from SVN
[occt.git] / src / AIS / AIS_Point.cdl
CommitLineData
7fd59977 1-- File: AIS_Point.cdl
2-- Created: Wed Aug 9 14:38:00 1995
3-- Author: Arnaud BOUZY
4-- <adn@houblon>
5-- GG : GER61351 17/11/1999 Change SetColor() with a compatible Quantity_Color instead
6-- the restricted NameOfColor.
7---Copyright: Matra Datavision 1995
8
9class Point from AIS inherits InteractiveObject from AIS
10
11 ---Purpose: Constructs point datums to be used in construction of
12 -- composite shapes. The datum is displayed as the plus marker +.
13
14uses
15 Point from Geom,
16 TypeOfMarker from Aspect,
17 Presentation from Prs3d,
18 PresentationManager3d from PrsMgr,
19 NameOfColor from Quantity,
20 Color from Quantity,
21 Selection from SelectMgr,
22 Projector from Prs3d,
23 Transformation from Geom,
24 PresentationManager2d from PrsMgr,
25 GraphicObject from Graphic2d,
26 Vertex from TopoDS,
27 KindOfInteractive from AIS
28
29
30is
31 Create(aComponent : Point from Geom)
32 returns mutable Point from AIS;
33 ---Purpose:
34 -- Initializes the point aComponent from which the point
35 -- datum will be built.
36
37 Signature(me) returns Integer from Standard is redefined;
38 ---Purpose: Returns index 1, the default index for a point.
39 ---C++: inline
40
41 Type(me) returns KindOfInteractive from AIS is redefined;
42 ---Purpose: Indicates that a point is a datum.
43 ---C++: inline
44
45 Component(me: mutable) returns Point from Geom
46 is static;
47 ---Purpose: Returns the component specified in SetComponent.
48 SetComponent(me: mutable;aComponent:Point from Geom )
49 is static;
50 ---Purpose: Constructs an instance of the point aComponent.
51 AcceptDisplayMode(me;aMode:Integer from Standard) returns Boolean from Standard is redefined static;
52 ---Purpose: Returns true if the display mode selected is valid for point datums.
53
54 Compute(me : mutable;
55 aPresentationManager: PresentationManager3d from PrsMgr;
56 aPresentation : mutable Presentation from Prs3d;
57 aMode : Integer from Standard = 0)
58 is redefined virtual protected;
59
60 Compute(me:mutable;
61 aProjector: Projector from Prs3d;
62 aPresentation: mutable Presentation from Prs3d)
63 is redefined static private;
64
65 Compute(me:mutable;
66 aPresentationManager: PresentationManager2d from PrsMgr;
67 aPresentation: mutable GraphicObject from Graphic2d;
68 aMode: Integer from Standard = 0)
69 is redefined static private;
70
71 Compute(me : mutable;
72 aProjector : Projector from Prs3d;
73 aTrsf : Transformation from Geom;
74 aPresentation : mutable 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 : mutable 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
119fields
120
121 myComponent : Point from Geom;
122 myHasTOM : Boolean from Standard;
123 myTOM : TypeOfMarker from Aspect;
124end Point;