A Location is a composite transition. It comprises a series of elementary reference coordinates, i.e. objects of type TopLoc_Datum3D, and the powers to which these objects are raised. More...

#include <TopLoc_Location.hxx>

Public Member Functions
	TopLoc_Location ()
	Constructs an empty local coordinate system object. Note: A Location constructed from a default datum is said to be "empty". More...

	TopLoc_Location (const gp_Trsf &T)
	Constructs the local coordinate system object defined by the transformation T. T invokes in turn, a TopLoc_Datum3D object. More...

	TopLoc_Location (const Handle< TopLoc_Datum3D > &D)
	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. More...

Standard_Boolean	IsIdentity () const
	Returns true if this location is equal to the Identity transformation. More...

void	Identity ()
	Resets this location to the Identity transformation. More...

const Handle< TopLoc_Datum3D > &	FirstDatum () const
	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. More...

Standard_Integer	FirstPower () const
	Returns the power elevation of the first elementary datum. Exceptions Standard_NoSuchObject if this location is empty. More...

const TopLoc_Location &	NextLocation () const
	Returns a Location representing <me> without the first datum. We have the relation : More...

const gp_Trsf &	Transformation () const
	Returns the transformation associated to the coordinate system. More...

	operator gp_Trsf () const

TopLoc_Location	Inverted () const
	Returns the inverse of <me>. More...

TopLoc_Location	Multiplied (const TopLoc_Location &Other) const
	Returns <me> * <Other>, the elementary datums are concatenated. More...

TopLoc_Location	operator* (const TopLoc_Location &Other) const

TopLoc_Location	Divided (const TopLoc_Location &Other) const
	Returns <me> / <Other>. More...

TopLoc_Location	operator/ (const TopLoc_Location &Other) const

TopLoc_Location	Predivided (const TopLoc_Location &Other) const
	Returns <Other>.Inverted() * <me>. More...

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

Standard_Integer	HashCode (Standard_Integer theUpperBound) const
	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]. More...

Standard_Boolean	IsEqual (const TopLoc_Location &Other) const
	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 ==. More...

Standard_Boolean	operator== (const TopLoc_Location &Other) const

Standard_Boolean	IsDifferent (const TopLoc_Location &Other) const
	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 !=. More...

Standard_Boolean	operator!= (const TopLoc_Location &Other) const

void	DumpJson (Standard_OStream &theOStream, const Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream. More...

void	ShallowDump (Standard_OStream &S) const
	Prints the contents of <me> on the stream <s>. More...

Detailed Description

A Location is a composite transition. It comprises a series of elementary reference coordinates, i.e. objects of type TopLoc_Datum3D, and the powers to which these objects are raised.

Constructor & Destructor Documentation

◆ TopLoc_Location() [1/3]

TopLoc_Location::TopLoc_Location ( )

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

◆ TopLoc_Location() [2/3]

TopLoc_Location::TopLoc_Location ( const gp_Trsf & T )

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

◆ TopLoc_Location() [3/3]

TopLoc_Location::TopLoc_Location ( const Handle< TopLoc_Datum3D > & D )

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.

Member Function Documentation

◆ Divided()

TopLoc_Location TopLoc_Location::Divided ( const TopLoc_Location & Other ) const

Returns <me> / <Other>.

◆ DumpJson()

void TopLoc_Location::DumpJson	(	Standard_OStream &	theOStream,
		const Standard_Integer	theDepth = `-1`
	)		const

Dumps the content of me into the stream.

◆ FirstDatum()

const Handle< TopLoc_Datum3D >& TopLoc_Location::FirstDatum ( ) const

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.

◆ FirstPower()

Standard_Integer TopLoc_Location::FirstPower ( ) const

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

◆ HashCode()

Standard_Integer TopLoc_Location::HashCode ( Standard_Integer theUpperBound ) const

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

Parameters

theUpperBound the upper bound of the range a computing hash code must be within

Returns: a computed hash code, in the range [1, theUpperBound]

◆ Identity()

void TopLoc_Location::Identity ( )

Resets this location to the Identity transformation.

◆ Inverted()

TopLoc_Location TopLoc_Location::Inverted ( ) const

Returns the inverse of <me>.

<me> * Inverted() is an Identity.

◆ IsDifferent()

Standard_Boolean TopLoc_Location::IsDifferent ( const TopLoc_Location & Other ) const

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 !=.

◆ IsEqual()

Standard_Boolean TopLoc_Location::IsEqual ( const TopLoc_Location & Other ) const

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

◆ IsIdentity()

Standard_Boolean TopLoc_Location::IsIdentity ( ) const

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

◆ Multiplied()

TopLoc_Location TopLoc_Location::Multiplied ( const TopLoc_Location & Other ) const

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

◆ NextLocation()

const TopLoc_Location& TopLoc_Location::NextLocation ( ) const

Returns a Location representing <me> without the first datum. We have the relation :

<me> = NextLocation() * FirstDatum() ^ FirstPower() Exceptions Standard_NoSuchObject if this location is empty.

◆ operator gp_Trsf()

TopLoc_Location::operator gp_Trsf ( ) const

◆ operator!=()

Standard_Boolean TopLoc_Location::operator!= ( const TopLoc_Location & Other ) const

inline

◆ operator*()

TopLoc_Location TopLoc_Location::operator* ( const TopLoc_Location & Other ) const

inline

◆ operator/()

TopLoc_Location TopLoc_Location::operator/ ( const TopLoc_Location & Other ) const

inline

◆ operator==()

Standard_Boolean TopLoc_Location::operator== ( const TopLoc_Location & Other ) const

inline

◆ Powered()

TopLoc_Location TopLoc_Location::Powered ( const Standard_Integer pwr ) const

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

◆ Predivided()

TopLoc_Location TopLoc_Location::Predivided ( const TopLoc_Location & Other ) const

Returns <Other>.Inverted() * <me>.

◆ ShallowDump()

void TopLoc_Location::ShallowDump ( Standard_OStream & S ) const

Prints the contents of <me> on the stream <s>.

◆ Transformation()

const gp_Trsf& TopLoc_Location::Transformation ( ) const

Returns the transformation associated to the coordinate system.

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

TopLoc_Location.hxx

TopLoc_Location Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TopLoc_Location() [1/3]

◆ TopLoc_Location() [2/3]

◆ TopLoc_Location() [3/3]

Member Function Documentation

◆ Divided()

◆ DumpJson()

◆ FirstDatum()

◆ FirstPower()

◆ HashCode()

◆ Identity()

◆ Inverted()

◆ IsDifferent()

◆ IsEqual()

◆ IsIdentity()

◆ Multiplied()

◆ NextLocation()

◆ operator gp_Trsf()

◆ operator!=()

◆ operator*()

◆ operator/()

◆ operator==()

◆ Powered()

◆ Predivided()

◆ ShallowDump()

◆ Transformation()