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