Open CASCADE Technology  7.7.0.dev
Public Member Functions

BRepTools_ShapeSet Class Reference

Contains a Shape and all its subshapes, locations and geometries. More...

#include <BRepTools_ShapeSet.hxx>

Inheritance diagram for BRepTools_ShapeSet:
Inheritance graph
[legend]

Public Member Functions

 BRepTools_ShapeSet (const Standard_Boolean theWithTriangles=Standard_True, const Standard_Boolean theWithNormals=Standard_False)
 Builds an empty ShapeSet. More...
 
 BRepTools_ShapeSet (const BRep_Builder &theBuilder, const Standard_Boolean theWithTriangles=Standard_True, const Standard_Boolean theWithNormals=Standard_False)
 Builds an empty ShapeSet. More...
 
virtual ~BRepTools_ShapeSet ()
 
Standard_Boolean IsWithTriangles () const
 Return true if shape should be stored with triangles. More...
 
Standard_Boolean IsWithNormals () const
 Return true if shape should be stored triangulation with normals. More...
 
void SetWithTriangles (const Standard_Boolean theWithTriangles)
 Define if shape will be stored with triangles. Ignored (always written) if face defines only triangulation (no surface). More...
 
void SetWithNormals (const Standard_Boolean theWithNormals)
 Define if shape will be stored triangulation with normals. Ignored (always written) if face defines only triangulation (no surface). More...
 
virtual void Clear () override
 Clears the content of the set. More...
 
virtual void AddGeometry (const TopoDS_Shape &S) override
 Stores the goemetry of . More...
 
virtual void DumpGeometry (Standard_OStream &OS) const override
 Dumps the geometry of me on the stream <OS>. More...
 
virtual void WriteGeometry (Standard_OStream &OS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
 Writes the geometry of me on the stream <OS> in a format that can be read back by Read. More...
 
virtual void ReadGeometry (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
 Reads the geometry of me from the stream <IS>. More...
 
virtual void DumpGeometry (const TopoDS_Shape &S, Standard_OStream &OS) const override
 Dumps the geometry of on the stream <OS>. More...
 
virtual void WriteGeometry (const TopoDS_Shape &S, Standard_OStream &OS) const override
 Writes the geometry of on the stream <OS> in a format that can be read back by Read. More...
 
virtual void ReadGeometry (const TopAbs_ShapeEnum T, Standard_IStream &IS, TopoDS_Shape &S) override
 Reads the geometry of a shape of type <T> from the stream <IS> and returns it in . More...
 
virtual void AddShapes (TopoDS_Shape &S1, const TopoDS_Shape &S2) override
 Inserts the shape <S2> in the shape <S1>. This method must be redefined to use the correct builder. More...
 
virtual void Check (const TopAbs_ShapeEnum T, TopoDS_Shape &S) override
 This method is called after each new completed shape. <T> is the type. is the shape. In this class it does nothing, but it gives the opportunity in derived classes to perform extra treatment on shapes. More...
 
void ReadPolygon3D (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Reads the 3d polygons of me from the stream <IS>. More...
 
void WritePolygon3D (Standard_OStream &OS, const Standard_Boolean Compact=Standard_True, const Message_ProgressRange &theProgress=Message_ProgressRange()) const
 Writes the 3d polygons on the stream <OS> in a format that can be read back by Read. More...
 
void DumpPolygon3D (Standard_OStream &OS) const
 Dumps the 3d polygons on the stream <OS>. More...
 
void ReadTriangulation (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Reads the triangulation of me from the stream <IS>. More...
 
void WriteTriangulation (Standard_OStream &OS, const Standard_Boolean Compact=Standard_True, const Message_ProgressRange &theProgress=Message_ProgressRange()) const
 Writes the triangulation on the stream <OS> in a format that can be read back by Read. More...
 
void DumpTriangulation (Standard_OStream &OS) const
 Dumps the triangulation on the stream <OS>. More...
 
void ReadPolygonOnTriangulation (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Reads the polygons on triangulation of me from the stream <IS>. More...
 
void WritePolygonOnTriangulation (Standard_OStream &OS, const Standard_Boolean Compact=Standard_True, const Message_ProgressRange &theProgress=Message_ProgressRange()) const
 Writes the polygons on triangulation on the stream <OS> in a format that can be read back by Read. More...
 
void DumpPolygonOnTriangulation (Standard_OStream &OS) const
 Dumps the polygons on triangulation on the stream <OS>. More...
 
- Public Member Functions inherited from TopTools_ShapeSet
 TopTools_ShapeSet ()
 Builds an empty ShapeSet. More...
 
virtual ~TopTools_ShapeSet ()
 
void SetFormatNb (const Standard_Integer theFormatNb)
 Sets the TopTools_FormatVersion. More...
 
Standard_Integer FormatNb () const
 Returns the TopTools_FormatVersion. More...
 
Standard_Integer Add (const TopoDS_Shape &S)
 Stores and its sub-shape. Returns the index of . The method AddGeometry is called on each sub-shape. More...
 
const TopoDS_ShapeShape (const Standard_Integer I) const
 Returns the sub-shape of index . More...
 
Standard_Integer Index (const TopoDS_Shape &S) const
 Returns the index of . More...
 
const TopTools_LocationSetLocations () const
 
TopTools_LocationSetChangeLocations ()
 
Standard_OStreamDumpExtent (Standard_OStream &OS) const
 Dumps the number of objects in me on the stream <OS>. (Number of shapes of each type) More...
 
void DumpExtent (TCollection_AsciiString &S) const
 Dumps the number of objects in me in the string S (Number of shapes of each type) More...
 
virtual void Dump (Standard_OStream &OS) const
 Dumps the content of me on the stream <OS>. More...
 
virtual void Write (Standard_OStream &OS, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Writes the content of me on the stream <OS> in a format that can be read back by Read. More...
 
virtual void Read (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange())
 Reads the content of me from the stream <IS>. me is first cleared. More...
 
void Dump (const TopoDS_Shape &S, Standard_OStream &OS) const
 Dumps on <OS> the shape . Dumps the orientation, the index of the TShape and the index of the Location. More...
 
void Write (const TopoDS_Shape &S, Standard_OStream &OS) const
 Writes on <OS> the shape . Writes the orientation, the index of the TShape and the index of the Location. More...
 
void Read (TopoDS_Shape &S, Standard_IStream &IS) const
 Reads from <IS> a shape and returns it in S. More...
 
Standard_Integer NbShapes () const
 Returns number of shapes read from file. More...
 

Additional Inherited Members

- Static Public Attributes inherited from TopTools_ShapeSet
static const Standard_CString THE_ASCII_VERSIONS [TopTools_FormatVersion_VERSION_3+1]
 

Detailed Description

Contains a Shape and all its subshapes, locations and geometries.

The topology is inherited from TopTools.

Constructor & Destructor Documentation

◆ BRepTools_ShapeSet() [1/2]

BRepTools_ShapeSet::BRepTools_ShapeSet ( const Standard_Boolean  theWithTriangles = Standard_True,
const Standard_Boolean  theWithNormals = Standard_False 
)

Builds an empty ShapeSet.

Parameters
theWithTrianglesflag to write triangulation data

◆ BRepTools_ShapeSet() [2/2]

BRepTools_ShapeSet::BRepTools_ShapeSet ( const BRep_Builder theBuilder,
const Standard_Boolean  theWithTriangles = Standard_True,
const Standard_Boolean  theWithNormals = Standard_False 
)

Builds an empty ShapeSet.

Parameters
theWithTrianglesflag to write triangulation data

◆ ~BRepTools_ShapeSet()

virtual BRepTools_ShapeSet::~BRepTools_ShapeSet ( )
virtual

Member Function Documentation

◆ AddGeometry()

virtual void BRepTools_ShapeSet::AddGeometry ( const TopoDS_Shape S)
overridevirtual

Stores the goemetry of .

Reimplemented from TopTools_ShapeSet.

◆ AddShapes()

virtual void BRepTools_ShapeSet::AddShapes ( TopoDS_Shape S1,
const TopoDS_Shape S2 
)
overridevirtual

Inserts the shape <S2> in the shape <S1>. This method must be redefined to use the correct builder.

Reimplemented from TopTools_ShapeSet.

◆ Check()

virtual void BRepTools_ShapeSet::Check ( const TopAbs_ShapeEnum  T,
TopoDS_Shape S 
)
overridevirtual

This method is called after each new completed shape. <T> is the type. is the shape. In this class it does nothing, but it gives the opportunity in derived classes to perform extra treatment on shapes.

Reimplemented from TopTools_ShapeSet.

◆ Clear()

virtual void BRepTools_ShapeSet::Clear ( )
overridevirtual

Clears the content of the set.

Reimplemented from TopTools_ShapeSet.

◆ DumpGeometry() [1/2]

virtual void BRepTools_ShapeSet::DumpGeometry ( const TopoDS_Shape S,
Standard_OStream OS 
) const
overridevirtual

Dumps the geometry of on the stream <OS>.

Reimplemented from TopTools_ShapeSet.

◆ DumpGeometry() [2/2]

virtual void BRepTools_ShapeSet::DumpGeometry ( Standard_OStream OS) const
overridevirtual

Dumps the geometry of me on the stream <OS>.

Reimplemented from TopTools_ShapeSet.

◆ DumpPolygon3D()

void BRepTools_ShapeSet::DumpPolygon3D ( Standard_OStream OS) const

Dumps the 3d polygons on the stream <OS>.

◆ DumpPolygonOnTriangulation()

void BRepTools_ShapeSet::DumpPolygonOnTriangulation ( Standard_OStream OS) const

Dumps the polygons on triangulation on the stream <OS>.

◆ DumpTriangulation()

void BRepTools_ShapeSet::DumpTriangulation ( Standard_OStream OS) const

Dumps the triangulation on the stream <OS>.

◆ IsWithNormals()

Standard_Boolean BRepTools_ShapeSet::IsWithNormals ( ) const
inline

Return true if shape should be stored triangulation with normals.

◆ IsWithTriangles()

Standard_Boolean BRepTools_ShapeSet::IsWithTriangles ( ) const
inline

Return true if shape should be stored with triangles.

◆ ReadGeometry() [1/2]

virtual void BRepTools_ShapeSet::ReadGeometry ( const TopAbs_ShapeEnum  T,
Standard_IStream IS,
TopoDS_Shape S 
)
overridevirtual

Reads the geometry of a shape of type <T> from the stream <IS> and returns it in .

Reimplemented from TopTools_ShapeSet.

◆ ReadGeometry() [2/2]

virtual void BRepTools_ShapeSet::ReadGeometry ( Standard_IStream IS,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
overridevirtual

Reads the geometry of me from the stream <IS>.

Reimplemented from TopTools_ShapeSet.

◆ ReadPolygon3D()

void BRepTools_ShapeSet::ReadPolygon3D ( Standard_IStream IS,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)

Reads the 3d polygons of me from the stream <IS>.

◆ ReadPolygonOnTriangulation()

void BRepTools_ShapeSet::ReadPolygonOnTriangulation ( Standard_IStream IS,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)

Reads the polygons on triangulation of me from the stream <IS>.

◆ ReadTriangulation()

void BRepTools_ShapeSet::ReadTriangulation ( Standard_IStream IS,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)

Reads the triangulation of me from the stream <IS>.

◆ SetWithNormals()

void BRepTools_ShapeSet::SetWithNormals ( const Standard_Boolean  theWithNormals)
inline

Define if shape will be stored triangulation with normals. Ignored (always written) if face defines only triangulation (no surface).

◆ SetWithTriangles()

void BRepTools_ShapeSet::SetWithTriangles ( const Standard_Boolean  theWithTriangles)
inline

Define if shape will be stored with triangles. Ignored (always written) if face defines only triangulation (no surface).

◆ WriteGeometry() [1/2]

virtual void BRepTools_ShapeSet::WriteGeometry ( const TopoDS_Shape S,
Standard_OStream OS 
) const
overridevirtual

Writes the geometry of on the stream <OS> in a format that can be read back by Read.

Reimplemented from TopTools_ShapeSet.

◆ WriteGeometry() [2/2]

virtual void BRepTools_ShapeSet::WriteGeometry ( Standard_OStream OS,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
overridevirtual

Writes the geometry of me on the stream <OS> in a format that can be read back by Read.

Reimplemented from TopTools_ShapeSet.

◆ WritePolygon3D()

void BRepTools_ShapeSet::WritePolygon3D ( Standard_OStream OS,
const Standard_Boolean  Compact = Standard_True,
const Message_ProgressRange theProgress = Message_ProgressRange() 
) const

Writes the 3d polygons on the stream <OS> in a format that can be read back by Read.

◆ WritePolygonOnTriangulation()

void BRepTools_ShapeSet::WritePolygonOnTriangulation ( Standard_OStream OS,
const Standard_Boolean  Compact = Standard_True,
const Message_ProgressRange theProgress = Message_ProgressRange() 
) const

Writes the polygons on triangulation on the stream <OS> in a format that can be read back by Read.

◆ WriteTriangulation()

void BRepTools_ShapeSet::WriteTriangulation ( Standard_OStream OS,
const Standard_Boolean  Compact = Standard_True,
const Message_ProgressRange theProgress = Message_ProgressRange() 
) const

Writes the triangulation on the stream <OS> in a format that can be read back by Read.


The documentation for this class was generated from the following file: