0024624: Lost word in license statement in source files
[occt.git] / src / Prs3d / Prs3d_PointAspect.cdl
CommitLineData
b311480e 1-- Created on: 1993-04-26
2-- Created by: Jean-Louis Frenkel
3-- Copyright (c) 1993-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--
d5f74e42 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
973c2be1 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
20
21class PointAspect from Prs3d inherits BasicAspect from Prs3d
22
23 ---Purpose: This class defines attributes for the points
24 -- The points are drawn using markers, whose size does not depend on
25 -- the zoom value of the views.
26
27uses
28
29 AspectMarker3d from Graphic3d,
30 NameOfColor from Quantity,
31 Color from Quantity,
32 TypeOfMarker from Aspect,
a577aaab 33 HArray1OfByte from TColStd,
34 MarkerImage_Handle from Graphic3d
7fd59977 35
36
37is
38
39
40 Create ( aType: TypeOfMarker from Aspect;
41 aColor: Color from Quantity;
42 aScale: Real from Standard)
43 returns mutable PointAspect from Prs3d;
44
45 Create ( aType: TypeOfMarker from Aspect;
46 aColor: NameOfColor from Quantity;
47 aScale: Real from Standard)
48 returns mutable PointAspect from Prs3d;
49
50 Create ( AColor : Color from Quantity;
7fd59977 51 AWidth : Integer from Standard;
52 AHeight : Integer from Standard;
53 ATexture : HArray1OfByte from TColStd)
54 returns mutable PointAspect from Prs3d;
55 ---Purpose: defines only the urer defined marker point.
56
57
58 SetColor (me: mutable; aColor: Color from Quantity) is static;
59
60 SetColor (me: mutable; aColor: NameOfColor from Quantity)
61 ---Purpose: defines the color to be used when drawing a point.
62 -- Default value: Quantity_NOC_YELLOW
63 is static;
64
65 SetTypeOfMarker (me: mutable; aType: TypeOfMarker from Aspect)
66 ---Purpose: defines the type of representation to be used when drawing a point.
67 -- Default value: Aspect_TOM_PLUS
68 is static;
69
70 SetScale (me: mutable; aScale: Real from Standard)
71 ---Purpose: defines the size of the marker used when drawing a point.
72 -- Default value: 1.
73 is static;
74
75 Aspect(me) returns AspectMarker3d from Graphic3d
76 is static;
77
7fd59977 78 GetTextureSize (me:mutable; AWidth : out Integer from Standard;
79 AHeight : out Integer from Standard);
80 ---Level: Public
81 ---Purpose: Returns marker's texture size.
82
83 GetTexture (me:mutable)
a577aaab 84 returns MarkerImage_Handle from Graphic3d;
7fd59977 85 ---Level: Public
86 ---Purpose: Returns marker's texture.
87 ---C++: return const &
88
89
90fields
91
92 myAspect: AspectMarker3d from Graphic3d;
93
94end PointAspect from Prs3d;