[occt.git] / src / STEPEdit / STEPEdit.hxx

// Created on: 1998-07-29
// Created by: Christian CAILLET
// Copyright (c) 1998-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 _STEPEdit_HeaderFile
#define _STEPEdit_HeaderFile

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

class Interface_Protocol;
class StepData_StepModel;
class IFSelect_Signature;
class IFSelect_SelectSignature;
class STEPEdit_EditContext;
class STEPEdit_EditSDR;


//! Provides tools to exploit and edit a set of STEP data :
//! editors, selections ..
class STEPEdit 
{
public:

  DEFINE_STANDARD_ALLOC

  
  //! Returns a Protocol fit for STEP (creates the first time)
  Standard_EXPORT static Handle(Interface_Protocol) Protocol();
  
  //! Returns a new empty StepModel fit for STEP
  //! i.e. with its header determined from Protocol
  Standard_EXPORT static Handle(StepData_StepModel) NewModel();
  
  //! Returns a SignType fit for STEP (creates the first time)
  Standard_EXPORT static Handle(IFSelect_Signature) SignType();
  
  //! Creates a Selection for ShapeDefinitionRepresentation
  //! By default searches among root entities
  Standard_EXPORT static Handle(IFSelect_SelectSignature) NewSelectSDR();
  
  //! Creates a Selection for Placed Items, i.e. MappedItem or
  //! ContextDependentShapeRepresentation, which itself refers to a
  //! RepresentationRelationship with possible subtypes (Shape...
  //! and/or ...WithTransformation)
  //! By default in the whole StepModel
  Standard_EXPORT static Handle(IFSelect_SelectSignature) NewSelectPlacedItem();
  
  //! Creates a Selection for ShapeRepresentation and its sub-types,
  //! plus ContextDependentShapeRepresentation (which is not a
  //! sub-type of ShapeRepresentation)
  //! By default in the whole StepModel
  Standard_EXPORT static Handle(IFSelect_SelectSignature) NewSelectShapeRepr();


protected:


private:


friend class STEPEdit_EditContext;
friend class STEPEdit_EditSDR;

};


#endif // _STEPEdit_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 1998-07-29
	2	// Created by: Christian CAILLET
	3	// Copyright (c) 1998-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	#ifndef _STEPEdit_HeaderFile
	18	#define _STEPEdit_HeaderFile
	19
	20	#include <Standard.hxx>
	21	#include <Standard_DefineAlloc.hxx>
	22	#include <Standard_Handle.hxx>
	23
	24	class Interface_Protocol;
	25	class StepData_StepModel;
	26	class IFSelect_Signature;
	27	class IFSelect_SelectSignature;
	28	class STEPEdit_EditContext;
	29	class STEPEdit_EditSDR;
	30
	31
	32	//! Provides tools to exploit and edit a set of STEP data :
	33	//! editors, selections ..
	34	class STEPEdit
	35	{
	36	public:
	37
	38	DEFINE_STANDARD_ALLOC
	39
	40
	41	//! Returns a Protocol fit for STEP (creates the first time)
	42	Standard_EXPORT static Handle(Interface_Protocol) Protocol();
	43
	44	//! Returns a new empty StepModel fit for STEP
	45	//! i.e. with its header determined from Protocol
	46	Standard_EXPORT static Handle(StepData_StepModel) NewModel();
	47
	48	//! Returns a SignType fit for STEP (creates the first time)
	49	Standard_EXPORT static Handle(IFSelect_Signature) SignType();
	50
	51	//! Creates a Selection for ShapeDefinitionRepresentation
	52	//! By default searches among root entities
	53	Standard_EXPORT static Handle(IFSelect_SelectSignature) NewSelectSDR();
	54
	55	//! Creates a Selection for Placed Items, i.e. MappedItem or
	56	//! ContextDependentShapeRepresentation, which itself refers to a
	57	//! RepresentationRelationship with possible subtypes (Shape...
	58	//! and/or ...WithTransformation)
	59	//! By default in the whole StepModel
	60	Standard_EXPORT static Handle(IFSelect_SelectSignature) NewSelectPlacedItem();
	61
	62	//! Creates a Selection for ShapeRepresentation and its sub-types,
	63	//! plus ContextDependentShapeRepresentation (which is not a
	64	//! sub-type of ShapeRepresentation)
65	//! By default in the whole StepModel
66	Standard_EXPORT static Handle(IFSelect_SelectSignature) NewSelectShapeRepr();
67
68
69
70
71	protected:
72
73
74
75
76
77	private:
78
79
80
81
82	friend class STEPEdit_EditContext;
83	friend class STEPEdit_EditSDR;
84
85	};
86
87
88
89
90
91
92
93	#endif // _STEPEdit_HeaderFile