src/Graphic3d/Graphic3d_ArrayOfSegments.cdl

   1 -- Created on: 2001-01-04
   2 -- Copyright (c) 2001-2012 OPEN CASCADE SAS
   3 --
   4 -- The content of this file is subject to the Open CASCADE Technology Public
   5 -- License Version 6.5 (the "License"). You may not use the content of this file
   6 -- except in compliance with the License. Please obtain a copy of the License
   7 -- at http://www.opencascade.org and read it completely before using this file.
   8 --
   9 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  10 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  11 --
  12 -- The Original Code and all software distributed under the License is
  13 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  14 -- Initial Developer hereby disclaims all such warranties, including without
  15 -- limitation, any warranties of merchantability, fitness for a particular
  16 -- purpose or non-infringement. Please see the License for the specific terms
  17 -- and conditions governing the rights and limitations under the License.
  18
  19
  20 class ArrayOfSegments from Graphic3d inherits ArrayOfPrimitives from Graphic3d
  21
  22 is
  23
  24         -- constructor
  25         Create (
  26                 maxVertexs: Integer from Standard;
  27                 maxEdges: Integer from Standard = 0;
  28                 hasVColors: Boolean from Standard = Standard_False)
  29         returns mutable ArrayOfSegments from Graphic3d;
  30         ---Purpose: Creates an array of segments,
  31         -- a segment can be filled as:
  32         -- 1) creating a set of segments defined with his vertexs.
  33         --    i.e:
  34         --    myArray = Graphic3d_ArrayOfSegments(4)
  35         --    myArray->AddVertex(x1,y1,z1)
  36         --      ....
  37         --    myArray->AddVertex(x4,y4,z4)
  38         -- 2) creating a set of indexed segments defined with his vertex
  39         --    ans edges.
  40         --    i.e:
  41         --    myArray = Graphic3d_ArrayOfSegments(4,0,8)
  42         --    myArray->AddVertex(x1,y1,z1)
  43         --      ....
  44         --    myArray->AddVertex(x4,y4,z4)
  45         --    myArray->AddEdge(1)
  46         --    myArray->AddEdge(2)
  47         --    myArray->AddEdge(3)
  48         --    myArray->AddEdge(4)
  49         --    myArray->AddEdge(2)
  50         --    myArray->AddEdge(4)
  51         --    myArray->AddEdge(1)
  52         --    myArray->AddEdge(3)
  53         --
  54         -- <maxVertexs> defined the maximun allowed vertex number in the array.
  55         -- <maxEdges> defined the maximun allowed edge number in the array.
  56         --  Warning:
  57         -- When <hasVColors> is TRUE , you must use only
  58         --      AddVertex(Point,Color) method
  59
  60 end;