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

#include <BRepTools_ShapeSet.hxx>

Inheritance diagram for BRepTools_ShapeSet:

Public Member Functions
	BRepTools_ShapeSet (const bool theWithTriangles=true, const bool theWithNormals=false)
	Builds an empty ShapeSet.

	BRepTools_ShapeSet (const BRep_Builder &theBuilder, const bool theWithTriangles=true, const bool theWithNormals=false)
	Builds an empty ShapeSet.

	~BRepTools_ShapeSet () override

bool	IsWithTriangles () const
	Return true if shape should be stored with triangles.

bool	IsWithNormals () const
	Return true if shape should be stored triangulation with normals.

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

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

void	Clear () override
	Clears the content of the set.

void	AddGeometry (const TopoDS_Shape &S) override
	Stores the geometry of .

void	DumpGeometry (Standard_OStream &OS) const override
	Dumps the geometry of me on the stream <OS>.

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.

void	ReadGeometry (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Reads the geometry of me from the stream <IS>.

void	DumpGeometry (const TopoDS_Shape &S, Standard_OStream &OS) const override
	Dumps the geometry of ~~on the stream <OS>.~~

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.~~

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 .

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.

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.~~

void	ReadPolygon3D (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads the 3d polygons of me from the stream <IS>.

void	WritePolygon3D (Standard_OStream &OS, const bool Compact=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.

void	DumpPolygon3D (Standard_OStream &OS) const
	Dumps the 3d polygons on the stream <OS>.

void	ReadTriangulation (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads the triangulation of me from the stream <IS>.

void	WriteTriangulation (Standard_OStream &OS, const bool Compact=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.

void	DumpTriangulation (Standard_OStream &OS) const
	Dumps the triangulation on the stream <OS>.

void	ReadPolygonOnTriangulation (Standard_IStream &IS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads the polygons on triangulation of me from the stream <IS>.

void	WritePolygonOnTriangulation (Standard_OStream &OS, const bool Compact=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.

void	DumpPolygonOnTriangulation (Standard_OStream &OS) const
	Dumps the polygons on triangulation on the stream <OS>.

Public Member Functions inherited from TopTools_ShapeSet
	TopTools_ShapeSet ()
	Builds an empty ShapeSet.

virtual	~TopTools_ShapeSet ()

void	SetFormatNb (const int theFormatNb)
	Sets the TopTools_FormatVersion.

int	FormatNb () const
	Returns the TopTools_FormatVersion.

int	Add (const TopoDS_Shape &S)
	Stores ~~and its sub-shape. Returns the index of ~~. The method AddGeometry is called on each sub-shape.~~~~

const TopoDS_Shape &	Shape (const int I) const
	Returns the sub-shape of index .

int	Index (const TopoDS_Shape &S) const
	Returns the index of .

const TopTools_LocationSet &	Locations () const

TopTools_LocationSet &	ChangeLocations ()

Standard_OStream &	DumpExtent (Standard_OStream &OS) const
	Dumps the number of objects in me on the stream <OS>. (Number of shapes of each type)

void	DumpExtent (TCollection_AsciiString &S) const
	Dumps the number of objects in me in the string S (Number of shapes of each type)

virtual void	Dump (Standard_OStream &OS) const
	Dumps the content of me on the stream <OS>.

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.

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.

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.~~

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.~~

void	Read (TopoDS_Shape &S, Standard_IStream &IS) const
	Reads from <IS> a shape and returns it in S.

int	NbShapes () const
	Returns number of shapes read from file.

Additional Inherited Members
Static Public Attributes inherited from TopTools_ShapeSet
static const char *const	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 bool	theWithTriangles = true,
		const bool	theWithNormals = false )

Builds an empty ShapeSet.

Parameters

theWithTriangles flag to write triangulation data

◆ BRepTools_ShapeSet() [2/2]

BRepTools_ShapeSet::BRepTools_ShapeSet	(	const BRep_Builder &	theBuilder,
		const bool	theWithTriangles = true,
		const bool	theWithNormals = false )

Builds an empty ShapeSet.

Parameters

theWithTriangles flag to write triangulation data

◆ ~BRepTools_ShapeSet()

BRepTools_ShapeSet::~BRepTools_ShapeSet ( )

override

Member Function Documentation

◆ AddGeometry()

void BRepTools_ShapeSet::AddGeometry ( const TopoDS_Shape & S )

overridevirtual

Stores the geometry of .

Reimplemented from TopTools_ShapeSet.

◆ AddShapes()

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()

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()

void BRepTools_ShapeSet::Clear ( )

overridevirtual

Clears the content of the set.

Reimplemented from TopTools_ShapeSet.

◆ DumpGeometry() [1/2]

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]

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()

bool BRepTools_ShapeSet::IsWithNormals ( ) const

inline

Return true if shape should be stored triangulation with normals.

◆ IsWithTriangles()

bool BRepTools_ShapeSet::IsWithTriangles ( ) const

inline

Return true if shape should be stored with triangles.

◆ ReadGeometry() [1/2]

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]

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 bool 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 bool theWithTriangles )

inline

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

◆ WriteGeometry() [1/2]

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]

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 bool	Compact = 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 bool	Compact = 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 bool	Compact = 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:

BRepTools_ShapeSet.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BRepTools_ShapeSet() [1/2]

◆ BRepTools_ShapeSet() [2/2]

◆ ~BRepTools_ShapeSet()

Member Function Documentation

◆ AddGeometry()

◆ AddShapes()

◆ Check()

◆ Clear()

◆ DumpGeometry() [1/2]

◆ DumpGeometry() [2/2]

◆ DumpPolygon3D()

◆ DumpPolygonOnTriangulation()

◆ DumpTriangulation()

◆ IsWithNormals()

◆ IsWithTriangles()

◆ ReadGeometry() [1/2]

◆ ReadGeometry() [2/2]

◆ ReadPolygon3D()

◆ ReadPolygonOnTriangulation()

◆ ReadTriangulation()

◆ SetWithNormals()

◆ SetWithTriangles()

◆ WriteGeometry() [1/2]

◆ WriteGeometry() [2/2]

◆ WritePolygon3D()

◆ WritePolygonOnTriangulation()

◆ WriteTriangulation()