0031682: Visualization - Prs3d_ShadingAspect::SetTransparency() has no effect with...
[occt.git] / src / IGESBasic / IGESBasic_SubfigureDef.hxx
CommitLineData
42cf5bc1 1// Created on: 1993-01-09
2// Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
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#ifndef _IGESBasic_SubfigureDef_HeaderFile
18#define _IGESBasic_SubfigureDef_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
23#include <Standard_Integer.hxx>
24#include <IGESData_HArray1OfIGESEntity.hxx>
25#include <IGESData_IGESEntity.hxx>
26class TCollection_HAsciiString;
27class Standard_OutOfRange;
28class IGESData_IGESEntity;
29class Standard_Transient;
30
31
32class IGESBasic_SubfigureDef;
33DEFINE_STANDARD_HANDLE(IGESBasic_SubfigureDef, IGESData_IGESEntity)
34
35//! defines SubfigureDef, Type <308> Form <0>
36//! in package IGESBasic
37//! This Entity permits a single definition of a detail to
38//! be utilized in multiple instances in the creation of
39//! the whole picture
40class IGESBasic_SubfigureDef : public IGESData_IGESEntity
41{
42
43public:
44
45
46 Standard_EXPORT IGESBasic_SubfigureDef();
47
48 //! This method is used to set the fields of the class
49 //! SubfigureDef
50 //! - aDepth : It indicates the amount of nesting
51 //! - aName : the subfigure name
52 //! - allAssocEntities : the associated entities
53 Standard_EXPORT void Init (const Standard_Integer aDepth, const Handle(TCollection_HAsciiString)& aName, const Handle(IGESData_HArray1OfIGESEntity)& allAssocEntities);
54
55 //! returns depth of the Subfigure
56 //! if theDepth = 0 - No reference to any subfigure instance.
57 Standard_EXPORT Standard_Integer Depth() const;
58
59 //! returns the name of Subfigure
60 Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
61
62 //! returns number of entities. Is greater than or equal to zero.
63 Standard_EXPORT Standard_Integer NbEntities() const;
64
65 //! returns the specific entity as indicated by Index
66 //! raises exception if Index <= 0 or Index > NbEntities()
67 Standard_EXPORT Handle(IGESData_IGESEntity) AssociatedEntity (const Standard_Integer Index) const;
68
69 //! returns the specific entity as indicated by Index
70 //! raises exception if Index <= 0 or Index > NbEntities()
71 Standard_EXPORT Handle(Standard_Transient) Value (const Standard_Integer Index) const;
72
73
74
75
92efcf78 76 DEFINE_STANDARD_RTTIEXT(IGESBasic_SubfigureDef,IGESData_IGESEntity)
42cf5bc1 77
78protected:
79
80
81
82
83private:
84
85
86 Standard_Integer theDepth;
87 Handle(TCollection_HAsciiString) theName;
88 Handle(IGESData_HArray1OfIGESEntity) theAssocEntities;
89
90
91};
92
93
94
95
96
97
98
99#endif // _IGESBasic_SubfigureDef_HeaderFile