A ShapeSets contains a Shape and all its
sub-shapes and locations. It can be dump, write
and read.

Methods to handle the geometry can be redefined.

More...

#include <TopTools_ShapeSet.hxx>

Inheritance diagram for TopTools_ShapeSet:

[legend]

Public Member Functions
	TopTools_ShapeSet ()
	Builds an empty ShapeSet. More...

virtual void	Delete ()

virtual	~TopTools_ShapeSet ()

void	SetFormatNb (const Standard_Integer theFormatNb)

Standard_Integer	FormatNb () const
	two formats available for the moment: First: does not write CurveOnSurface UV Points into the file on reading calls Check() method. Second: stores CurveOnSurface UV Points. On reading format is recognized from Version string. More...

virtual void	Clear ()
	Clears the content of the set. This method can be redefined. More...

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

const TopoDS_Shape &	Shape (const Standard_Integer I) const
	Returns the sub-shape of index <I>. <br> More...

Standard_Integer	Index (const TopoDS_Shape &S) const
	Returns the index of <S>. More...

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>. <br> (Number of shapes of each type) More...

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

virtual void	Dump (Standard_OStream &OS) const
	Dumps the content of me on the stream <OS>. <br> Dumps the shapes from first to last. For each Shape Dump the type, the flags, the subshapes calls DumpGeometry(S) Dumps the geometry calling DumpGeometry. Dumps the locations. More...

virtual void	Write (Standard_OStream &OS)
	Writes the content of me on the stream <OS> in a <br> format that can be read back by Read. <br> Writes the locations. Writes the geometry calling WriteGeometry. Dumps the shapes from last to first. For each shape : Write the type. calls WriteGeometry(S). Write the flags, the subshapes. More...

virtual void	Read (Standard_IStream &IS)
	Reads the content of me from the stream <IS>. me <br> is first cleared. <br> Reads the locations. Reads the geometry calling ReadGeometry. Reads the shapes. For each shape Reads the type. calls ReadGeometry(T,S). Reads the flag, the subshapes. More...

void	Dump (const TopoDS_Shape &S, Standard_OStream &OS) const
	Dumps on <OS> the shape <S>. 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 <S>. 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...

virtual void	AddGeometry (const TopoDS_Shape &S)
	Stores the geometry of <S>. More...

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

virtual void	WriteGeometry (Standard_OStream &OS)
	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)
	Reads the geometry of me from the stream <IS>. More...

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

virtual void	WriteGeometry (const TopoDS_Shape &S, Standard_OStream &OS) const
	Writes the geometry of <S> 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)
	Reads the geometry of a shape of type <T> from the stream <IS> and returns it in <S>. More...

virtual void	AddShapes (TopoDS_Shape &S1, const TopoDS_Shape &S2)
	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)
	This method is called after each new completed shape. <T> is the type. <S> is the shape. In this class it does nothing, but it gives the opportunity in derived classes to perform extra treatment on shapes. More...

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

void	SetProgress (const Handle< Message_ProgressIndicator > &PR)

Handle_Message_ProgressIndicator	GetProgress () const

Detailed Description

A ShapeSets contains a Shape and all its
sub-shapes and locations. It can be dump, write
and read.

Methods to handle the geometry can be redefined.

Constructor & Destructor Documentation

TopTools_ShapeSet::TopTools_ShapeSet ( )

Builds an empty ShapeSet.

virtual TopTools_ShapeSet::~TopTools_ShapeSet ( )

inlinevirtual

Member Function Documentation

Standard_Integer TopTools_ShapeSet::Add ( const TopoDS_Shape & S )

Stores <S> and its sub-shape. Returns the index of <S>.
The method AddGeometry is called on each sub-shape.

virtual void TopTools_ShapeSet::AddGeometry ( const TopoDS_Shape & S )

virtual

Stores the geometry of <S>.

Reimplemented in BRepTools_ShapeSet.

virtual void TopTools_ShapeSet::AddShapes	(	TopoDS_Shape &	S1,
		const TopoDS_Shape &	S2
	)

virtual

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

Reimplemented in BRepTools_ShapeSet.

TopTools_LocationSet& TopTools_ShapeSet::ChangeLocations ( )

virtual void TopTools_ShapeSet::Check	(	const TopAbs_ShapeEnum	T,
		TopoDS_Shape &	S
	)

virtual

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

Reimplemented in BRepTools_ShapeSet.

virtual void TopTools_ShapeSet::Clear ( )

virtual

Clears the content of the set. This method can be
redefined.

Reimplemented in BRepTools_ShapeSet.

virtual void TopTools_ShapeSet::Delete ( )

virtual

virtual void TopTools_ShapeSet::Dump ( Standard_OStream & OS ) const

virtual

 Dumps the content of me on the stream <OS>. <br>

Dumps the shapes from first to last.
For each Shape
Dump the type, the flags, the subshapes
calls DumpGeometry(S)

Dumps the geometry calling DumpGeometry.

Dumps the locations.

void TopTools_ShapeSet::Dump	(	const TopoDS_Shape &	S,
		Standard_OStream &	OS
	)		const

Dumps on <OS> the shape <S>. Dumps the
orientation, the index of the TShape and the index
of the Location.

Standard_OStream& TopTools_ShapeSet::DumpExtent ( Standard_OStream & OS ) const

 Dumps the number of objects in me on the stream <OS>. <br>

(Number of shapes of each type)

void TopTools_ShapeSet::DumpExtent ( TCollection_AsciiString & S ) const

 Dumps the number of objects in me in the string S <br>

(Number of shapes of each type)

virtual void TopTools_ShapeSet::DumpGeometry ( Standard_OStream & OS ) const

virtual

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

Reimplemented in BRepTools_ShapeSet.

virtual void TopTools_ShapeSet::DumpGeometry	(	const TopoDS_Shape &	S,
		Standard_OStream &	OS
	)		const

virtual

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

Reimplemented in BRepTools_ShapeSet.

Standard_Integer TopTools_ShapeSet::FormatNb ( ) const

two formats available for the moment:
First: does not write CurveOnSurface UV Points into the file
on reading calls Check() method.
Second: stores CurveOnSurface UV Points.
On reading format is recognized from Version string.

Handle_Message_ProgressIndicator TopTools_ShapeSet::GetProgress ( ) const

Standard_Integer TopTools_ShapeSet::Index ( const TopoDS_Shape & S ) const

Returns the index of <S>.

const TopTools_LocationSet& TopTools_ShapeSet::Locations ( ) const

Standard_Integer TopTools_ShapeSet::NbShapes ( ) const

Returns number of shapes read from file.

virtual void TopTools_ShapeSet::Read ( Standard_IStream & IS )

virtual

 Reads the content of me from the  stream  <IS>. me <br>
     is first cleared. <br>

Reads the locations.

Reads the geometry calling ReadGeometry.

Reads the shapes.
For each shape
Reads the type.
calls ReadGeometry(T,S).
Reads the flag, the subshapes.

void TopTools_ShapeSet::Read	(	TopoDS_Shape &	S,
		Standard_IStream &	IS
	)		const

Reads from <IS> a shape and returns it in S.

virtual void TopTools_ShapeSet::ReadGeometry ( Standard_IStream & IS )

virtual

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

Reimplemented in BRepTools_ShapeSet.

virtual void TopTools_ShapeSet::ReadGeometry	(	const TopAbs_ShapeEnum	T,
		Standard_IStream &	IS,
		TopoDS_Shape &	S
	)

virtual

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

Reimplemented in BRepTools_ShapeSet.

void TopTools_ShapeSet::SetFormatNb ( const Standard_Integer theFormatNb )

void TopTools_ShapeSet::SetProgress ( const Handle< Message_ProgressIndicator > & PR )

const TopoDS_Shape& TopTools_ShapeSet::Shape ( const Standard_Integer I ) const

 Returns the sub-shape of index <I>. <br>

virtual void TopTools_ShapeSet::Write ( Standard_OStream & OS )

virtual

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

Writes the locations.

Writes the geometry calling WriteGeometry.

Dumps the shapes from last to first.
For each shape :
Write the type.
calls WriteGeometry(S).
Write the flags, the subshapes.

void TopTools_ShapeSet::Write	(	const TopoDS_Shape &	S,
		Standard_OStream &	OS
	)		const

Writes on <OS> the shape <S>. Writes the
orientation, the index of the TShape and the index
of the Location.

virtual void TopTools_ShapeSet::WriteGeometry ( Standard_OStream & OS )

virtual

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

Reimplemented in BRepTools_ShapeSet.

virtual void TopTools_ShapeSet::WriteGeometry	(	const TopoDS_Shape &	S,
		Standard_OStream &	OS
	)		const

virtual

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

Reimplemented in BRepTools_ShapeSet.

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

TopTools_ShapeSet.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation