OCC.TopLoc module¶
-Level : Public.All methods of all classes will be public.The TopLoc package gives ressources to handle 3D localcoordinate systems called Locations.A Location is a composition of elementary coordinatesystems, each one is called a Datum. The Locationkeeps track of this composition.
-
class
Handle_TopLoc_Datum3D
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_TopLoc_IndexedMapNodeOfIndexedMapOfLocation
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_TopLoc_SListNodeOfItemLocation
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_TopLoc_StdMapNodeOfMapOfLocation
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
SwigPyIterator
(*args, **kwargs)¶ Bases:
object
-
advance
()¶
-
copy
()¶
-
decr
()¶
-
distance
()¶
-
equal
()¶
-
incr
()¶
-
next
()¶
-
previous
()¶
-
thisown
¶ The membership flag
-
value
()¶
-
-
class
TopLoc_Datum3D
(*args)¶ Bases:
OCC.MMgt.MMgt_TShared
- Constructs a default Datum3D.
Return type: None - Constructs a Datum3D form a Trsf from gp. An error is raised if the Trsf is not a rigid transformation.
Parameters: T (gp_Trsf) – Return type: None -
GetHandle
()¶
-
ShallowDumpToString
()¶ TopLoc_Datum3D_ShallowDumpToString(TopLoc_Datum3D self) -> std::string
-
Transformation
()¶ - Returns a gp_Trsf which, when applied to this datum, produces the default datum.
Return type: gp_Trsf
-
thisown
¶ The membership flag
-
class
TopLoc_IndexedMapNodeOfIndexedMapOfLocation
(*args)¶ Bases:
OCC.TCollection.TCollection_MapNode
Parameters: - K1 (TopLoc_Location &) –
- K2 (int) –
- n1 (TCollection_MapNodePtr &) –
- n2 (TCollection_MapNodePtr &) –
Return type: -
GetHandle
()¶
-
GetKey2
()¶ TopLoc_IndexedMapNodeOfIndexedMapOfLocation_GetKey2(TopLoc_IndexedMapNodeOfIndexedMapOfLocation self) -> Standard_Integer
-
Key1
()¶ Return type: TopLoc_Location
-
Next2
()¶ Return type: TCollection_MapNodePtr
-
SetKey2
()¶ TopLoc_IndexedMapNodeOfIndexedMapOfLocation_SetKey2(TopLoc_IndexedMapNodeOfIndexedMapOfLocation self, Standard_Integer value)
-
thisown
¶ The membership flag
-
class
TopLoc_IndexedMapOfLocation
(*args)¶ Bases:
OCC.TCollection.TCollection_BasicMap
Parameters: - NbBuckets (int) – default value is 1
- Other (TopLoc_IndexedMapOfLocation &) –
Return type: Return type: -
Assign
()¶ Parameters: Other (TopLoc_IndexedMapOfLocation &) – Return type: TopLoc_IndexedMapOfLocation
-
FindKey
()¶ Parameters: I (int) – Return type: TopLoc_Location
-
Set
()¶ Parameters: Other (TopLoc_IndexedMapOfLocation &) – Return type: TopLoc_IndexedMapOfLocation
-
thisown
¶ The membership flag
-
class
TopLoc_ItemLocation
(*args)¶ Bases:
object
- Sets the elementary Datum to <D> Sets the exponent to <P>
Parameters: - D (Handle_TopLoc_Datum3D &) –
- P (int) –
Return type: -
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’.
Return type: None - Constructs the local coordinate system object defined by the transformation T. T invokes in turn, a TopLoc_Datum3D object.
Parameters: T (gp_Trsf) – Return type: 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.
Parameters: D (Handle_TopLoc_Datum3D &) – Return type: None -
Divided
()¶ - Returns <self> / <Other>.
Parameters: Other (TopLoc_Location &) – Return type: TopLoc_Location
-
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.
Return type: Handle_TopLoc_Datum3D
-
FirstPower
()¶ - Returns the power elevation of the first elementary datum. Exceptions Standard_NoSuchObject if this location is empty.
Return type: 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..Upper ].
Parameters: Upper (int) – Return type: int
-
Inverted
()¶ - Returns the inverse of <self>. //! <self> * Inverted() is an Identity.
Return type: 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 !=.
Parameters: Other (TopLoc_Location &) – Return type: 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 ==.
Parameters: Other (TopLoc_Location &) – Return type: bool
-
IsIdentity
()¶ - Returns true if this location is equal to the Identity transformation.
Return type: bool
-
Multiplied
()¶ - Returns <self> * <Other>, the elementary datums are concatenated.
Parameters: Other (TopLoc_Location &) – Return type: 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.
Return type: 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).
Parameters: pwr (int) – Return type: TopLoc_Location
-
Predivided
()¶ - Returns <Other>.Inverted() * <self>.
Parameters: Other (TopLoc_Location &) – Return type: TopLoc_Location
-
ShallowDumpToString
()¶ TopLoc_Location_ShallowDumpToString(TopLoc_Location self) -> std::string
-
Transformation
()¶ - Returns the transformation associated to the coordinate system.
Return type: gp_Trsf
-
thisown
¶ The membership flag
-
class
TopLoc_MapIteratorOfMapOfLocation
(*args)¶ Bases:
OCC.TCollection.TCollection_BasicMapIterator
Return type: None Parameters: aMap (TopLoc_MapOfLocation &) – Return type: None -
Key
()¶ Return type: TopLoc_Location
-
thisown
¶ The membership flag
-
-
TopLoc_MapLocationHasher_IsEqual
()¶ Parameters: - K1 (TopLoc_Location &) –
- K2 (TopLoc_Location &) –
Return type:
-
class
TopLoc_MapOfLocation
(*args)¶ Bases:
OCC.TCollection.TCollection_BasicMap
Parameters: - NbBuckets (int) – default value is 1
- Other (TopLoc_MapOfLocation &) –
Return type: Return type: -
Assign
()¶ Parameters: Other (TopLoc_MapOfLocation &) – Return type: TopLoc_MapOfLocation
-
Set
()¶ Parameters: Other (TopLoc_MapOfLocation &) – Return type: TopLoc_MapOfLocation
-
thisown
¶ The membership flag
-
class
TopLoc_SListNodeOfItemLocation
(*args)¶ Bases:
OCC.MMgt.MMgt_TShared
Parameters: - I (TopLoc_ItemLocation &) –
- aTail (TopLoc_SListOfItemLocation &) –
Return type: -
GetHandle
()¶
-
Tail
()¶ Return type: TopLoc_SListOfItemLocation
-
Value
()¶ Return type: TopLoc_ItemLocation
-
thisown
¶ The membership flag
-
class
TopLoc_SListOfItemLocation
(*args)¶ Bases:
object
- Creates an empty List.
Return type: None - Creates a List with <anItem> as value and <aTail> as tail.
Parameters: - anItem (TopLoc_ItemLocation &) –
- aTail (TopLoc_SListOfItemLocation &) –
Return type: - Creates a list from an other one. The lists are shared.
Parameters: Other (TopLoc_SListOfItemLocation &) – Return type: None -
Assign
()¶ - Sets a list from an other one. The lists are shared. The list itself is returned.
Parameters: Other (TopLoc_SListOfItemLocation &) – Return type: TopLoc_SListOfItemLocation
-
Construct
()¶ - Replaces the list by a list with <anItem> as Value and the list <self> as tail.
Parameters: anItem (TopLoc_ItemLocation &) – Return type: None
-
Next
()¶ - Moves the iterator to the next object in the list. If the iterator is empty it will stay empty. This is ToTail()
Return type: None
-
Set
()¶ Parameters: Other (TopLoc_SListOfItemLocation &) – Return type: TopLoc_SListOfItemLocation
-
Tail
()¶ - Returns the current tail of the list. On an empty list the tail is the list itself.
Return type: TopLoc_SListOfItemLocation
-
Value
()¶ - Returns the current value of the list. An error is raised if the list is empty.
Return type: TopLoc_ItemLocation
-
thisown
¶ The membership flag
-
class
TopLoc_StdMapNodeOfMapOfLocation
(*args)¶ Bases:
OCC.TCollection.TCollection_MapNode
Parameters: - K (TopLoc_Location &) –
- n (TCollection_MapNodePtr &) –
Return type: -
GetHandle
()¶
-
Key
()¶ Return type: TopLoc_Location
-
thisown
¶ The membership flag
-
new_instancemethod
(func, inst, cls)¶
-
register_handle
(handle, base_object)¶ Inserts the handle into the base object to prevent memory corruption in certain cases