Integration of OCCT 6.5.0 from SVN
[occt.git] / src / Prs3d / Prs3d_PointAspect.cdl
1 -- File:        Prs3d_PointAspect.cdl
2 -- Created:     Mon Apr 26 16:18:12 1993
3 -- Author:      Jean-Louis Frenkel
4 --              <jlf@phylox>
5 --   GG  : GER61351 17/11/1999 Change SetColor() with a compatible Quantity_Color instead
6 --                                     the restricted NameOfColor.
7 ---Copyright:    Matra Datavision 1993
8
9
10 class PointAspect from Prs3d inherits BasicAspect from Prs3d
11  
12         ---Purpose: This  class  defines  attributes for the points
13         --  The points are drawn using markers, whose size does not depend on
14         --  the zoom value of the views. 
15
16 uses 
17
18     AspectMarker3d      from Graphic3d,
19     NameOfColor         from Quantity,
20     Color               from Quantity,
21     TypeOfMarker        from Aspect,
22     HArray1OfByte       from TColStd
23
24
25 is
26
27
28    Create ( aType: TypeOfMarker from Aspect;
29            aColor: Color from Quantity;
30              aScale: Real from Standard)
31              returns mutable PointAspect from Prs3d;
32
33     Create ( aType: TypeOfMarker from Aspect;  
34            aColor: NameOfColor from Quantity;
35              aScale: Real from Standard)
36              returns mutable PointAspect from Prs3d;
37
38     Create ( AColor         : Color from Quantity;
39              AnId           : Real from Standard;
40              AWidth         : Integer from Standard;
41              AHeight        : Integer from Standard;
42              ATexture       : HArray1OfByte from TColStd)
43              returns mutable PointAspect from Prs3d;
44         ---Purpose: defines only the urer defined marker point.
45
46              
47     SetColor (me: mutable; aColor: Color from Quantity) is static;
48  
49     SetColor (me: mutable; aColor: NameOfColor from Quantity) 
50         ---Purpose: defines the color to be used when drawing a point.
51         --          Default value: Quantity_NOC_YELLOW
52     is static;
53
54     SetTypeOfMarker (me: mutable; aType: TypeOfMarker from Aspect) 
55         ---Purpose: defines the type of representation to be used when drawing a point.
56         --          Default value: Aspect_TOM_PLUS
57     is static;
58     
59     SetScale (me: mutable; aScale: Real from Standard) 
60         ---Purpose: defines the size of the marker used when drawing a point.
61         --          Default value: 1.
62     is static;
63     
64     Aspect(me) returns AspectMarker3d from Graphic3d 
65     is static;
66     
67     Print( me; s: in out OStream from Standard);
68
69     GetTextureSize (me:mutable; AWidth     : out Integer from Standard;
70                                     AHeight    : out Integer from Standard);
71         ---Level: Public
72         ---Purpose: Returns marker's texture size.                  
73
74     GetTexture (me:mutable)
75          returns HArray1OfByte from TColStd;
76         ---Level: Public
77         ---Purpose: Returns marker's texture. 
78         ---C++: return const &
79
80     
81 fields
82
83     myAspect: AspectMarker3d from Graphic3d;
84
85 end PointAspect from Prs3d;