OCC.Core.TopLoc module

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

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class TopLoc_Datum3D(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Constructs a default Datum3D.

  rtype

  None* Constructs a Datum3D form a Trsf from gp. An error is raised if the Trsf is not a rigid transformation.

  param T

  type T

  gp_Trsf

  rtype

  None

static DownCast(t)

DumpJsonToString(TopLoc_Datum3D self, int depth=-1) → std::string

ShallowDumpToString(TopLoc_Datum3D self) → std::string

Transformation()

• Returns a gp_Trsf which, when applied to this datum, produces the default datum.

  rtype

  gp_Trsf

property thisown

The membership flag

class TopLoc_IndexedMapOfLocation(*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 TopLoc_ItemLocation(*args)

Bases: object

• Sets the elementary Datum to <D> Sets the exponent to <P>

  param D

  type D

  opencascade::handle<TopLoc_Datum3D> &

  param P

  type P

  int

  rtype

  None

DumpJsonToString(TopLoc_ItemLocation self, int depth=-1) → std::string

property thisown

The membership flag

class TopLoc_Location(*args)

Bases: object

• Constructs an empty local coordinate system object. Note: A Location constructed from a default datum is said to be ‘empty’.

  rtype

  None* Constructs the local coordinate system object defined by the transformation T. T invokes in turn, a TopLoc_Datum3D object.

  param T

  type T

  gp_Trsf

  rtype

  None* Constructs the local coordinate system object defined by the 3D datum D. Exceptions Standard_ConstructionError if the transformation T does not represent a 3D coordinate system.

  param D

  type D

  opencascade::handle<TopLoc_Datum3D> &

  rtype

  None

Divided()

• Returns <self> / <Other>.

  param Other

  type Other

  TopLoc_Location &

  rtype

  Standard_NODISCARD TopLoc_Location

DumpJsonToString(TopLoc_Location self, int depth=-1) → std::string

FirstDatum()

• Returns the first elementary datum of the Location. Use the NextLocation function recursively to access the other data comprising this location. Exceptions Standard_NoSuchObject if this location is empty.

  rtype

  opencascade::handle<TopLoc_Datum3D>

FirstPower()

• Returns the power elevation of the first elementary datum. Exceptions Standard_NoSuchObject if this location is empty.

  rtype

  int

HashCode()

• Returns a hashed value for this local coordinate system. This value is used, with map tables, to store and retrieve the object easily, and is in the range [1, theUpperBound]. @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 theUpperBound

  type theUpperBound

  int

  rtype

  int

Identity()

• Resets this location to the Identity transformation.

  rtype

  None

Inverted()

• Returns the inverse of <self>. //! <self> * Inverted() is an Identity.

  rtype

  Standard_NODISCARD TopLoc_Location

IsDifferent()

• Returns true if this location and the location Other do not have the same elementary data, i.e. do not contain the same series of TopLoc_Datum3D and respective powers. This method is an alias for operator !=.

  param Other

  type Other

  TopLoc_Location &

  rtype

  bool

IsEqual()

• Returns true if this location and the location Other have the same elementary data, i.e. contain the same series of TopLoc_Datum3D and respective powers. This method is an alias for operator ==.

  param Other

  type Other

  TopLoc_Location &

  rtype

  bool

IsIdentity()

• Returns true if this location is equal to the Identity transformation.

  rtype

  bool

Multiplied()

• Returns <self> * <Other>, the elementary datums are concatenated.

  param Other

  type Other

  TopLoc_Location &

  rtype

  Standard_NODISCARD TopLoc_Location

NextLocation()

• Returns a Location representing <self> without the first datum. We have the relation//! <self> = NextLocation() * FirstDatum() ^ FirstPower() Exceptions Standard_NoSuchObject if this location is empty.

  rtype

  TopLoc_Location

Powered()

• Returns me at the power <pwr>. If <pwr> is zero returns Identity. <pwr> can be lower than zero (usual meaning for powers).

  param pwr

  type pwr

  int

  rtype

  Standard_NODISCARD TopLoc_Location

Predivided()

• Returns <Other>.Inverted() * <self>.

  param Other

  type Other

  TopLoc_Location &

  rtype

  Standard_NODISCARD TopLoc_Location

ShallowDumpToString(TopLoc_Location self) → std::string

Transformation()

• Returns the transformation associated to the coordinate system.

  rtype

  gp_Trsf

property thisown

The membership flag

class TopLoc_MapLocationHasher

Bases: object

static HashCode()

static IsEqual()

property thisown

The membership flag

class TopLoc_MapOfLocation(*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 TopLoc_SListNodeOfItemLocation(*args)

Bases: OCC.Core.Standard.Standard_Transient

Parameters

I –

type I

TopLoc_ItemLocation &

param aTail

type aTail

TopLoc_SListOfItemLocation &

rtype

None

static DownCast(t)

Tail()

Return type

TopLoc_SListOfItemLocation

Value()

Return type

TopLoc_ItemLocation

property thisown

The membership flag

class TopLoc_SListOfItemLocation(*args)

Bases: object

• Creates an empty List.

  rtype

  None* Creates a List with <anItem> as value and <aTail> as tail.

  param anItem

  type anItem

  TopLoc_ItemLocation &

  param aTail

  type aTail

  TopLoc_SListOfItemLocation &

  rtype

  None* Creates a list from an other one. The lists are shared.

  param Other

  type Other

  TopLoc_SListOfItemLocation &

  rtype

  None* Move constructor

  param theOther

  type theOther

  TopLoc_SListOfItemLocation &

  rtype

  None

Assign()

• Sets a list from an other one. The lists are shared. The list itself is returned.

  param Other

  type Other

  TopLoc_SListOfItemLocation &

  rtype

  TopLoc_SListOfItemLocation

Clear()

• Sets the list to be empty.

  rtype

  None

Construct()

• Replaces the list by a list with <anItem> as Value and the list <self> as tail.

  param anItem

  type anItem

  TopLoc_ItemLocation &

  rtype

  None

IsEmpty()

• Returne true if this list is empty

  rtype

  bool

More()

• Returns True if the iterator has a current value. This is !IsEmpty()

  rtype

  bool

Next()

• Moves the iterator to the next object in the list. If the iterator is empty it will stay empty. This is ToTail()

  rtype

  None

Set()

• Assignment

  param Other

  type Other

  TopLoc_SListOfItemLocation &

  rtype

  TopLoc_SListOfItemLocation* Move operator

  param theOther

  type theOther

  TopLoc_SListOfItemLocation &

  rtype

  TopLoc_SListOfItemLocation

Tail()

• Returns the current tail of the list. On an empty list the tail is the list itself.

  rtype

  TopLoc_SListOfItemLocation

ToTail()

• Replaces the list <self> by its tail.

  rtype

  None

Value()

• Returns the current value of the list. An error is raised if the list is empty.

  rtype

  TopLoc_ItemLocation

property thisown

The membership flag