OCC.Core.TopTools module

TopTools module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_toptools.html

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class TopTools_Array1OfListOfShape(*args)

Bases: object

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

First()

Init()

IsAllocated()

IsDeletable()

IsEmpty()

Last()

Length()

Lower()

Move()

Resize()

Set()

SetValue()

Size()

Upper()

Value()

begin()

cbegin()

cend()

end()

next()

property thisown

The membership flag

class TopTools_Array1OfShape(*args)

Bases: object

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

First()

Init()

IsAllocated()

IsDeletable()

IsEmpty()

Last()

Length()

Lower()

Move()

Resize()

Set()

SetValue()

Size()

Upper()

Value()

begin()

cbegin()

cend()

end()

next()

property thisown

The membership flag

class TopTools_Array2OfShape(*args)

Bases: object

Assign()

ChangeValue()

ColLength()

Init()

IsDeletable()

Length()

LowerCol()

LowerRow()

Move()

NbColumns()

NbRows()

Resize()

RowLength()

Set()

SetValue()

Size()

UpperCol()

UpperRow()

Value()

property thisown

The membership flag

class TopTools_DataMapOfIntegerListOfShape(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

Keys()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfIntegerShape(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

Keys()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfOrientedShapeInteger(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfOrientedShapeShape(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfShapeBox(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfShapeInteger(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfShapeListOfInteger(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfShapeListOfShape(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfShapeReal(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfShapeSequenceOfShape(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_DataMapOfShapeShape(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_HArray1OfListOfShape(*args)

Bases: OCC.Core.TopTools.TopTools_Array1OfListOfShape, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Array1()

ChangeArray1()

static DownCast(t)

property thisown

The membership flag

class TopTools_HArray1OfShape(*args)

Bases: OCC.Core.TopTools.TopTools_Array1OfShape, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Array1()

ChangeArray1()

static DownCast(t)

property thisown

The membership flag

class TopTools_HArray2OfShape(*args)

Bases: OCC.Core.TopTools.TopTools_Array2OfShape, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Array2()

ChangeArray2()

static DownCast(t)

property thisown

The membership flag

class TopTools_HSequenceOfShape(*args)

Bases: OCC.Core.TopTools.TopTools_SequenceOfShape, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Append()

ChangeSequence()

static DownCast(t)

Sequence()

property thisown

The membership flag

class TopTools_IndexedDataMapOfShapeAddress(*args)

Bases: object

Add()

Assign()

ChangeFromIndex()

ChangeFromKey()

ChangeSeek()

Clear()

Contains()

Exchange()

FindFromIndex()

FindFromKey()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Seek()

Set()

Size()

Substitute()

Swap()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_IndexedDataMapOfShapeListOfShape(*args)

Bases: object

Add()

Assign()

ChangeFromIndex()

ChangeFromKey()

ChangeSeek()

Clear()

Contains()

Exchange()

FindFromIndex()

FindFromKey()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Seek()

Set()

Size()

Substitute()

Swap()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_IndexedDataMapOfShapeReal(*args)

Bases: object

Add()

Assign()

ChangeFromIndex()

ChangeFromKey()

ChangeSeek()

Clear()

Contains()

Exchange()

FindFromIndex()

FindFromKey()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Seek()

Set()

Size()

Substitute()

Swap()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_IndexedDataMapOfShapeShape(*args)

Bases: object

Add()

Assign()

ChangeFromIndex()

ChangeFromKey()

ChangeSeek()

Clear()

Contains()

Exchange()

FindFromIndex()

FindFromKey()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Seek()

Set()

Size()

Substitute()

Swap()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_IndexedMapOfOrientedShape(*args)

Bases: object

Add()

Assign()

Clear()

Contains()

Exchange()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Set()

Size()

Substitute()

Swap()

cbegin()

cend()

property thisown

The membership flag

class TopTools_IndexedMapOfShape(*args)

Bases: object

Add()

Assign()

Clear()

Contains()

Exchange()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Set()

Size()

Substitute()

Swap()

cbegin()

cend()

property thisown

The membership flag

class TopTools_ListIteratorOfListOfShape(*args)

Bases: object

ChangeValue()

More()

Next()

Value()

property thisown

The membership flag

class TopTools_ListOfListOfShape(*args)

Bases: object

Append()

Assign()

Clear()

First()

InsertAfter()

InsertBefore()

Last()

Prepend()

Remove()

RemoveFirst()

Reverse()

Set()

Size()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_ListOfShape(*args)

Bases: object

Append()

Assign()

Clear()

First()

InsertAfter()

InsertBefore()

Last()

Prepend()

Remove()

RemoveFirst()

Reverse()

Set()

Size()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class TopTools_LocationSet(*args)

Bases: object

• Returns an empty set of locations.

  rtype

  None

Add()

• Incorporate a new Location in the set and returns its index.

  param L

  type L

  TopLoc_Location

  rtype

  int

Clear()

• Clears the content of the set.

  rtype

  None

DumpToString(TopTools_LocationSet self) → std::string

GetProgress()

Return type

opencascade::handle<Message_ProgressIndicator>

Index()

• Returns the index of <L>.

  param L

  type L

  TopLoc_Location

  rtype

  int

Location()

• Returns the location of index <I>.

  param I

  type I

  int

  rtype

  TopLoc_Location

ReadFromString(TopTools_LocationSet self, std::string src)

SetProgress()

Parameters

PR –

type PR

Message_ProgressIndicator

rtype

None

WriteToString(TopTools_LocationSet self) → std::string

property thisown

The membership flag

class TopTools_MapOfOrientedShape(*args)

Bases: object

Add()

Added()

Assign()

Clear()

Contains()

Differ()

Difference()

Exchange()

HasIntersection()

Intersect()

Intersection()

IsEqual()

ReSize()

Remove()

Set()

Size()

Subtract()

Subtraction()

Union()

Unite()

cbegin()

cend()

property thisown

The membership flag

class TopTools_MapOfShape(*args)

Bases: object

Add()

Added()

Assign()

Clear()

Contains()

Differ()

Difference()

Exchange()

HasIntersection()

Intersect()

Intersection()

IsEqual()

ReSize()

Remove()

Set()

Size()

Subtract()

Subtraction()

Union()

Unite()

cbegin()

cend()

property thisown

The membership flag

class TopTools_MutexForShapeProvider(*args)

Bases: object

• Constructor

  rtype

  None

CreateMutexForShape()

• Creates and associates mutex with theShape

  param theShape

  type theShape

  TopoDS_Shape

  rtype

  None

CreateMutexesForSubShapes()

• Creates and associates mutexes with each sub-shape of type theType in theShape.

  param theShape

  type theShape

  TopoDS_Shape

  param theType

  type theType

  TopAbs_ShapeEnum

  rtype

  None

GetMutex()

• Returns pointer to mutex associated with theShape. In case when mutex not found returns NULL.

  param theShape

  type theShape

  TopoDS_Shape

  rtype

  Standard_Mutex *

RemoveAllMutexes()

• Removes all mutexes

  rtype

  None

property thisown

The membership flag

class TopTools_OrientedShapeMapHasher

Bases: object

static HashCode()

• Computes a hash code for the given shape, in the range [1, theUpperBound] @param theShape the shape which hash code is to be computed @param theUpperBound the upper bound of the range a computing hash code must be within returns a computed hash code, in the range [1, theUpperBound]

  param theShape

  type theShape

  TopoDS_Shape

  param theUpperBound

  type theUpperBound

  int

  rtype

  int

static IsEqual()

• Returns True when the two keys are equal. Two same keys must have the same hashcode, the contrary is not necessary.

  param S1

  type S1

  TopoDS_Shape

  param S2

  type S2

  TopoDS_Shape

  rtype

  bool

property thisown

The membership flag

class TopTools_SequenceOfShape(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class TopTools_ShapeMapHasher

Bases: object

static HashCode()

• Computes a hash code for the given shape, in the range [1, theUpperBound] @param theShape the shape which hash code is to be computed @param theUpperBound the upper bound of the range a computing hash code must be within returns a computed hash code, in the range [1, theUpperBound]

  param theShape

  type theShape

  TopoDS_Shape

  param theUpperBound

  type theUpperBound

  int

  rtype

  int

static IsEqual()

• Returns True when the two keys are the same. Two same keys must have the same hashcode, the contrary is not necessary.

  param S1

  type S1

  TopoDS_Shape

  param S2

  type S2

  TopoDS_Shape

  rtype

  bool

property thisown

The membership flag

class TopTools_ShapeSet(*args)

Bases: object

• Builds an empty ShapeSet.

  rtype

  None

Add()

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

  param S

  type S

  TopoDS_Shape

  rtype

  int

AddGeometry()

• Stores the geometry of <S>.

  param S

  type S

  TopoDS_Shape

  rtype

  void

AddShapes()

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

  param S1

  type S1

  TopoDS_Shape

  param S2

  type S2

  TopoDS_Shape

  rtype

  void

ChangeLocations()

Return type

TopTools_LocationSet

Check()

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

  param T

  type T

  TopAbs_ShapeEnum

  param S

  type S

  TopoDS_Shape

  rtype

  void

Clear()

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

  rtype

  void

Dump()

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

  param S

  type S

  TopoDS_Shape

  param OS

  type OS

  Standard_OStream

  rtype

  None

DumpExtent()

• Dumps the number of objects in me in the string S (Number of shapes of each type)

  param S

  type S

  TCollection_AsciiString

  rtype

  None

DumpExtentToString(TopTools_ShapeSet self) → std::string

DumpGeometry()

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

  param S

  type S

  TopoDS_Shape

  param OS

  type OS

  Standard_OStream

  rtype

  void

DumpGeometryToString(TopTools_ShapeSet self) → std::string

DumpToString(TopTools_ShapeSet self) → std::string

FormatNb()

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

  rtype

  int

GetProgress()

Return type

opencascade::handle<Message_ProgressIndicator>

Index()

• Returns the index of <S>.

  param S

  type S

  TopoDS_Shape

  rtype

  int

Locations()

Return type

TopTools_LocationSet

NbShapes()

• Returns number of shapes read from file.

  rtype

  int

Read()

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

  param S

  type S

  TopoDS_Shape

  param IS

  type IS

  Standard_IStream

  rtype

  None

ReadFromString(TopTools_ShapeSet self, std::string src)

ReadGeometry()

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

  param T

  type T

  TopAbs_ShapeEnum

  param IS

  type IS

  Standard_IStream

  param S

  type S

  TopoDS_Shape

  rtype

  void

ReadGeometryFromString(TopTools_ShapeSet self, std::string src)

SetFormatNb()

Parameters

theFormatNb –

type theFormatNb

int

rtype

None

SetProgress()

Parameters

PR –

type PR

Message_ProgressIndicator

rtype

None

Shape()

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

  param I

  type I

  int

  rtype

  TopoDS_Shape

Write()

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

  param S

  type S

  TopoDS_Shape

  param OS

  type OS

  Standard_OStream

  rtype

  None

WriteGeometry()

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

  param S

  type S

  TopoDS_Shape

  param OS

  type OS

  Standard_OStream

  rtype

  void

WriteGeometryToString(TopTools_ShapeSet self) → std::string

WriteToString(TopTools_ShapeSet self) → std::string

property thisown

The membership flag

class toptools

Bases: object

static Dummy()

• This is to bypass an extraction bug. It will force the inclusion of Standard_Integer.hxx itself including Standard_OStream.hxx at the correct position.

  param I

  type I

  int

  rtype

  void

static Dump()

• A set of Shapes. Can be dump, wrote or read. Dumps the topological structure of <Sh> on the stream <S>.

  param Sh

  type Sh

  TopoDS_Shape

  param S

  type S

  Standard_OStream

  rtype

  void

property thisown

The membership flag