|
Open CASCADE Technology
6.9.0
|
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 (const Standard_Integer Upper) 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..Upper ]. 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 | ShallowDump (Standard_OStream &S) const |
| Prints the contents of <me> on the stream <s>. More... | |
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.
| 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::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::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.
| TopLoc_Location TopLoc_Location::Divided | ( | const TopLoc_Location & | Other | ) | const |
Returns <me> / <Other>.
| 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.
| Standard_Integer TopLoc_Location::FirstPower | ( | ) | const |
Returns the power elevation of the first elementary datum. Exceptions Standard_NoSuchObject if this location is empty.
| Standard_Integer TopLoc_Location::HashCode | ( | const Standard_Integer | Upper | ) | 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..Upper ].
| void TopLoc_Location::Identity | ( | ) |
Resets this location to the Identity transformation.
| TopLoc_Location TopLoc_Location::Inverted | ( | ) | const |
Returns the inverse of <me>.
<me> * Inverted() is an Identity.
| 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 !=.
| 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 ==.
| Standard_Boolean TopLoc_Location::IsIdentity | ( | ) | const |
Returns true if this location is equal to the Identity transformation.
| TopLoc_Location TopLoc_Location::Multiplied | ( | const TopLoc_Location & | Other | ) | const |
Returns <me> * <Other>, the elementary datums are concatenated.
| 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.
| TopLoc_Location::operator gp_Trsf | ( | ) | const |
|
inline |
|
inline |
|
inline |
|
inline |
| 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).
| TopLoc_Location TopLoc_Location::Predivided | ( | const TopLoc_Location & | Other | ) | const |
Returns <Other>.Inverted() * <me>.
| void TopLoc_Location::ShallowDump | ( | Standard_OStream & | S | ) | const |
Prints the contents of <me> on the stream <s>.
| const gp_Trsf& TopLoc_Location::Transformation | ( | ) | const |
Returns the transformation associated to the coordinate system.
1.8.5