0031687: Draw Harness, ViewerTest - extend command vrenderparams with option updating...

[occt.git] / src / IGESSolid / IGESSolid_TopoBuilder.hxx

// Created on: 1994-11-16
// Created by: Christian CAILLET
// Copyright (c) 1994-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _IGESSolid_TopoBuilder_HeaderFile
#define _IGESSolid_TopoBuilder_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <Standard_Integer.hxx>
#include <TColStd_HSequenceOfTransient.hxx>
#include <TColStd_HSequenceOfInteger.hxx>
#include <TColgp_HSequenceOfXYZ.hxx>
class IGESSolid_ManifoldSolid;
class IGESSolid_Shell;
class IGESSolid_Face;
class IGESData_IGESEntity;
class IGESSolid_Loop;
class IGESSolid_EdgeList;
class IGESSolid_VertexList;
class Standard_DomainError;
class gp_XYZ;


//! This class manages the creation of an IGES Topologic entity
//! (BREP : ManifoldSolid, Shell, Face)
//! This includes definiting of Vertex and Edge Lists,
//! building of Edges and Loops
class IGESSolid_TopoBuilder 
{
public:

  DEFINE_STANDARD_ALLOC

  
  //! Creates an empty TopoBuilder
  //! This creates also a unique VertexList and a unique EdgeList,
  //! empty, but which can be referenced from starting
  Standard_EXPORT IGESSolid_TopoBuilder();
  
  //! Resets the TopoBuilder for an entirely new operation
  //! (with a new EdgeList, a new VertexList, new Shells, ...)
  Standard_EXPORT void Clear();
  
  //! Adds a Vertex to the VertexList
  Standard_EXPORT void AddVertex (const gp_XYZ& val);
  
  //! Returns the count of already recorded Vertices
  Standard_EXPORT Standard_Integer NbVertices() const;
  
  //! Returns a Vertex, given its rank
  Standard_EXPORT const gp_XYZ& Vertex (const Standard_Integer num) const;
  
  //! Returns the VertexList. It can be referenced, but it remains
  //! empty until call to EndShell or EndSolid
  Standard_EXPORT Handle(IGESSolid_VertexList) VertexList() const;
  
  //! Adds an Edge (3D) to the EdgeList, defined by a Curve and
  //! two number of Vertex, for start and end
  Standard_EXPORT void AddEdge (const Handle(IGESData_IGESEntity)& curve, const Standard_Integer vstart, const Standard_Integer vend);
  
  //! Returns the count of recorded Edges (3D)
  Standard_EXPORT Standard_Integer NbEdges() const;
  
  //! Returns the definition of an Edge (3D) given its rank
  Standard_EXPORT void Edge (const Standard_Integer num, Handle(IGESData_IGESEntity)& curve, Standard_Integer& vstart, Standard_Integer& vend) const;
  
  //! Returns the EdgeList. It can be referenced, but it remains
  //! empty until call to EndShell or EndSolid
  Standard_EXPORT Handle(IGESSolid_EdgeList) EdgeList() const;
  
  //! Begins the definition of a new Loop : it is the Current Loop
  //! All Edges (UV) defined by MakeEdge/EndEdge will be added in it
  //! The Loop can then be referenced but is empty. It will be
  //! filled with its Edges(UV) by EndLoop (from SetOuter/AddInner)
  Standard_EXPORT void MakeLoop();
  
  //! Defines an Edge(UV), to be added in the current Loop by EndEdge
  //! <edgetype> gives the type of the edge
  //! <edge3d> identifies the Edge(3D) used as support
  //! The EdgeList is allways the current one
  //! <orientation gives the orientation flag
  //! It is then necessary to :
  //! - give the parametric curves
  //! - close the definition of this edge(UV) by EndEdge, else
  //! the next call to MakeEdge will erase this one
  Standard_EXPORT void MakeEdge (const Standard_Integer edgetype, const Standard_Integer edge3d, const Standard_Integer orientation);
  
  //! Adds a Parametric Curve (UV) to the current Edge(UV)
  Standard_EXPORT void AddCurveUV (const Handle(IGESData_IGESEntity)& curve, const Standard_Integer iso);
  
  //! Closes the definition of an Edge(UV) and adds it to the
  //! current Loop
  Standard_EXPORT void EndEdge();
  
  //! Begins the definition of a new Face, on a surface
  //! All Loops defined by MakeLoop will be added in it, according
  //! the closing call : SetOuter for the Outer Loop (by default,
  //! if SetOuter is not called, no OuterLoop is defined);
  //! AddInner for the list of Inner Loops (there can be none)
  Standard_EXPORT void MakeFace (const Handle(IGESData_IGESEntity)& surface);
  
  //! Closes the current Loop and sets it Loop as Outer Loop. If no
  //! current Loop has yet been defined, does nothing.
  Standard_EXPORT void SetOuter();
  
  //! Closes the current Loop and adds it to the list of Inner Loops
  //! for the current Face
  Standard_EXPORT void AddInner();
  
  //! Closes the definition of the current Face, fills it and adds
  //! it to the current Shell with an orientation flag (0/1)
  Standard_EXPORT void EndFace (const Standard_Integer orientation);
  
  //! Begins the definition of a new Shell (either Simple or in a
  //! Solid)
  Standard_EXPORT void MakeShell();
  
  //! Closes the whole definition as that of a simple Shell
  Standard_EXPORT void EndSimpleShell();
  
  //! Closes the definition of the current Shell as for the Main
  //! Shell of a Solid, with an orientation flag (0/1)
  Standard_EXPORT void SetMainShell (const Standard_Integer orientation);
  
  //! Closes the definition of the current Shell and adds it to the
  //! list of Void Shells of a Solid, with an orientation flag (0/1)
  Standard_EXPORT void AddVoidShell (const Standard_Integer orientation);
  
  //! Closes the whole definition as that of a ManifoldSolid
  //! Its call is exclusive from that of EndSimpleShell
  Standard_EXPORT void EndSolid();
  
  //! Returns the current Shell. The current Shell is created empty
  //! by MakeShell and filled by EndShell
  Standard_EXPORT Handle(IGESSolid_Shell) Shell() const;
  
  //! Returns the current ManifoldSolid. It is created empty by
  //! Create and filled by EndSolid
  Standard_EXPORT Handle(IGESSolid_ManifoldSolid) Solid() const;




protected:

  
  //! Closes the definition of Vertex and Edge Lists
  //! Warning : Called only by EndSimpleShell and EndSolid
  Standard_EXPORT void EndLists();
  
  //! Closes the definition of a Loop and fills it
  //! Warning : EndLoop should not be called directly but through
  //! SetOuter or AddInner, which work on the current Face
  Standard_EXPORT void EndLoop();
  
  //! Closes the definition of the current Shell
  //! Warning : EndShell should not be called directly but through
  //! EndSimpleShell (for a simple Shell), SetMainShell (for main
  //! Shell of a Solid) or AddVoidShell (to a Solid)
  Standard_EXPORT void EndShell();




private:



  Handle(IGESSolid_ManifoldSolid) thesolid;
  Handle(IGESSolid_Shell) themains;
  Standard_Boolean themflag;
  Handle(TColStd_HSequenceOfTransient) thevoids;
  Handle(TColStd_HSequenceOfInteger) thevflag;
  Handle(IGESSolid_Shell) theshell;
  Handle(TColStd_HSequenceOfTransient) thefaces;
  Handle(TColStd_HSequenceOfInteger) thefflag;
  Handle(IGESSolid_Face) theface;
  Handle(IGESData_IGESEntity) thesurf;
  Standard_Boolean theouter;
  Handle(TColStd_HSequenceOfTransient) theinner;
  Handle(IGESSolid_Loop) theloop;
  Handle(TColStd_HSequenceOfInteger) theetype;
  Handle(TColStd_HSequenceOfInteger) thee3d;
  Handle(TColStd_HSequenceOfInteger) theeflag;
  Handle(TColStd_HSequenceOfTransient) theeuv;
  Handle(TColStd_HSequenceOfInteger) theisol;
  Handle(TColStd_HSequenceOfTransient) thecuruv;
  Handle(TColStd_HSequenceOfTransient) theiso;
  Handle(IGESSolid_EdgeList) theedgel;
  Handle(TColStd_HSequenceOfTransient) thecur3d;
  Handle(TColStd_HSequenceOfInteger) thevstar;
  Handle(TColStd_HSequenceOfInteger) thevend;
  Handle(IGESSolid_VertexList) thevertl;
  Handle(TColgp_HSequenceOfXYZ) thepoint;


};







#endif // _IGESSolid_TopoBuilder_HeaderFile