src/Prs3d/Prs3d_PointAspect.cdl

   1 -- Created on: 1993-04-26
   2 -- Created by: Jean-Louis Frenkel
   3 -- Copyright (c) 1993-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   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
  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.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class PointAspect from Prs3d inherits BasicAspect from Prs3d
  18
  19         ---Purpose: This  class  defines  attributes for the points
  20         --  The points are drawn using markers, whose size does not depend on
  21         --  the zoom value of the views.
  22
  23 uses
  24
  25     AspectMarker3d      from Graphic3d,
  26     NameOfColor         from Quantity,
  27     Color               from Quantity,
  28     TypeOfMarker        from Aspect,
  29     HArray1OfByte       from TColStd,
  30     MarkerImage_Handle from Graphic3d
  31
  32
  33 is
  34
  35
  36    Create ( aType: TypeOfMarker from Aspect;
  37            aColor: Color from Quantity;
  38              aScale: Real from Standard)
  39              returns PointAspect from Prs3d;
  40
  41     Create ( aType: TypeOfMarker from Aspect;
  42            aColor: NameOfColor from Quantity;
  43              aScale: Real from Standard)
  44              returns PointAspect from Prs3d;
  45
  46     Create ( AColor         : Color from Quantity;
  47              AWidth         : Integer from Standard;
  48              AHeight        : Integer from Standard;
  49              ATexture       : HArray1OfByte from TColStd)
  50              returns PointAspect from Prs3d;
  51         ---Purpose: defines only the urer defined marker point.
  52
  53
  54     SetColor (me: mutable; aColor: Color from Quantity) is static;
  55
  56     SetColor (me: mutable; aColor: NameOfColor from Quantity)
  57         ---Purpose: defines the color to be used when drawing a point.
  58         --          Default value: Quantity_NOC_YELLOW
  59     is static;
  60
  61     SetTypeOfMarker (me: mutable; aType: TypeOfMarker from Aspect)
  62         ---Purpose: defines the type of representation to be used when drawing a point.
  63         --          Default value: Aspect_TOM_PLUS
  64     is static;
  65
  66     SetScale (me: mutable; aScale: Real from Standard)
  67         ---Purpose: defines the size of the marker used when drawing a point.
  68         --          Default value: 1.
  69     is static;
  70
  71     Aspect(me) returns AspectMarker3d from Graphic3d
  72     is static;
  73
  74     GetTextureSize (me:mutable; AWidth     : out Integer from Standard;
  75                                     AHeight    : out Integer from Standard);
  76         ---Level: Public
  77         ---Purpose: Returns marker's texture size.
  78
  79     GetTexture (me:mutable)
  80          returns MarkerImage_Handle from Graphic3d;
  81         ---Level: Public
  82         ---Purpose: Returns marker's texture.
  83         ---C++: return const &
  84
  85
  86 fields
  87
  88     myAspect: AspectMarker3d from Graphic3d;
  89
  90 end PointAspect from Prs3d;