src/Graphic3d/Graphic3d_ArrayOfSegments.cdl

   1 -- Created on: 2001-01-04
   2 -- Copyright (c) 2001-2014 OPEN CASCADE SAS
   3 --
   4 -- This file is part of Open CASCADE Technology software library.
   5 --
   6 -- This library is free software; you can redistribute it and/or modify it under
   7 -- the terms of the GNU Lesser General Public License version 2.1 as published
   8 -- by the Free Software Foundation, with special exception defined in the file
   9 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 -- distribution for complete text of the license and disclaimer of any warranty.
  11 --
  12 -- Alternatively, this file may be used under the terms of Open CASCADE
  13 -- commercial license or contractual agreement.
  14
  15 class ArrayOfSegments from Graphic3d inherits ArrayOfPrimitives from Graphic3d
  16
  17 is
  18
  19         -- constructor
  20         Create (
  21                 maxVertexs: Integer from Standard;
  22                 maxEdges: Integer from Standard = 0;
  23                 hasVColors: Boolean from Standard = Standard_False)
  24         returns mutable ArrayOfSegments from Graphic3d;
  25         ---Purpose: Creates an array of segments,
  26         -- a segment can be filled as:
  27         -- 1) creating a set of segments defined with his vertexs.
  28         --    i.e:
  29         --    myArray = Graphic3d_ArrayOfSegments(4)
  30         --    myArray->AddVertex(x1,y1,z1)
  31         --      ....
  32         --    myArray->AddVertex(x4,y4,z4)
  33         -- 2) creating a set of indexed segments defined with his vertex
  34         --    ans edges.
  35         --    i.e:
  36         --    myArray = Graphic3d_ArrayOfSegments(4,0,8)
  37         --    myArray->AddVertex(x1,y1,z1)
  38         --      ....
  39         --    myArray->AddVertex(x4,y4,z4)
  40         --    myArray->AddEdge(1)
  41         --    myArray->AddEdge(2)
  42         --    myArray->AddEdge(3)
  43         --    myArray->AddEdge(4)
  44         --    myArray->AddEdge(2)
  45         --    myArray->AddEdge(4)
  46         --    myArray->AddEdge(1)
  47         --    myArray->AddEdge(3)
  48         --
  49         -- <maxVertexs> defined the maximun allowed vertex number in the array.
  50         -- <maxEdges> defined the maximun allowed edge number in the array.
  51         --  Warning:
  52         -- When <hasVColors> is TRUE , you must use only
  53         --      AddVertex(Point,Color) method
  54
  55 end;