Open CASCADE Technology  7.7.0.dev
Public Member Functions | Protected Attributes

Geom_AxisPlacement Class Referenceabstract

The abstract class AxisPlacement describes the common behavior of positioning systems in 3D space, such as axis or coordinate systems. The Geom package provides two implementations of 3D positioning systems: More...

#include <Geom_AxisPlacement.hxx>

Inheritance diagram for Geom_AxisPlacement:
Inheritance graph
[legend]

Public Member Functions

void SetAxis (const gp_Ax1 &A1)
 Assigns A1 as the "main Axis" of this positioning system. This modifies. More...
 
virtual void SetDirection (const gp_Dir &V)=0
 Changes the direction of the axis placement. If <me> is an axis placement two axis the main "Direction" is modified and the "XDirection" and "YDirection" are recomputed. Raises ConstructionError only for an axis placement two axis if V and the previous "XDirection" are parallel because it is not possible to calculate the new "XDirection" and the new "YDirection". More...
 
void SetLocation (const gp_Pnt &P)
 Assigns the point P as the origin of this positioning system. More...
 
Standard_Real Angle (const Handle< Geom_AxisPlacement > &Other) const
 Computes the angular value, in radians, between the "main Direction" of this positioning system and that of positioning system Other. The result is a value between 0 and Pi. More...
 
const gp_Ax1Axis () const
 Returns the main axis of the axis placement. For an "Axis2placement" it is the main axis (Location, Direction ). For an "Axis1Placement" this method returns a copy of <me>. More...
 
gp_Dir Direction () const
 Returns the main "Direction" of an axis placement. More...
 
gp_Pnt Location () const
 Returns the Location point (origin) of the axis placement. More...
 
- Public Member Functions inherited from Geom_Geometry
void Mirror (const gp_Pnt &P)
 Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry. More...
 
void Mirror (const gp_Ax1 &A1)
 Performs the symmetrical transformation of a Geometry with respect to an axis placement which is the axis of the symmetry. More...
 
void Mirror (const gp_Ax2 &A2)
 Performs the symmetrical transformation of a Geometry with respect to a plane. The axis placement A2 locates the plane of the symmetry : (Location, XDirection, YDirection). More...
 
void Rotate (const gp_Ax1 &A1, const Standard_Real Ang)
 Rotates a Geometry. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians. More...
 
void Scale (const gp_Pnt &P, const Standard_Real S)
 Scales a Geometry. S is the scaling value. More...
 
void Translate (const gp_Vec &V)
 Translates a Geometry. V is the vector of the translation. More...
 
void Translate (const gp_Pnt &P1, const gp_Pnt &P2)
 Translates a Geometry from the point P1 to the point P2. More...
 
virtual void Transform (const gp_Trsf &T)=0
 Transformation of a geometric object. This tansformation can be a translation, a rotation, a symmetry, a scaling or a complex transformation obtained by combination of the previous elementaries transformations. (see class Transformation of the package Geom). More...
 
Handle< Geom_GeometryMirrored (const gp_Pnt &P) const
 
Handle< Geom_GeometryMirrored (const gp_Ax1 &A1) const
 
Handle< Geom_GeometryMirrored (const gp_Ax2 &A2) const
 
Handle< Geom_GeometryRotated (const gp_Ax1 &A1, const Standard_Real Ang) const
 
Handle< Geom_GeometryScaled (const gp_Pnt &P, const Standard_Real S) const
 
Handle< Geom_GeometryTransformed (const gp_Trsf &T) const
 
Handle< Geom_GeometryTranslated (const gp_Vec &V) const
 
Handle< Geom_GeometryTranslated (const gp_Pnt &P1, const gp_Pnt &P2) const
 
virtual Handle< Geom_GeometryCopy () const =0
 Creates a new object which is a copy of this geometric object. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

gp_Ax1 axis
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

The abstract class AxisPlacement describes the common behavior of positioning systems in 3D space, such as axis or coordinate systems. The Geom package provides two implementations of 3D positioning systems:

Member Function Documentation

◆ Angle()

Standard_Real Geom_AxisPlacement::Angle ( const Handle< Geom_AxisPlacement > &  Other) const

Computes the angular value, in radians, between the "main Direction" of this positioning system and that of positioning system Other. The result is a value between 0 and Pi.

◆ Axis()

const gp_Ax1& Geom_AxisPlacement::Axis ( ) const

Returns the main axis of the axis placement. For an "Axis2placement" it is the main axis (Location, Direction ). For an "Axis1Placement" this method returns a copy of <me>.

◆ Direction()

gp_Dir Geom_AxisPlacement::Direction ( ) const

Returns the main "Direction" of an axis placement.

◆ Location()

gp_Pnt Geom_AxisPlacement::Location ( ) const

Returns the Location point (origin) of the axis placement.

◆ SetAxis()

void Geom_AxisPlacement::SetAxis ( const gp_Ax1 A1)

Assigns A1 as the "main Axis" of this positioning system. This modifies.

  • its origin, and
  • its "main Direction". If this positioning system is a Geom_Axis2Placement, then its "X Direction" and "Y Direction" are recomputed. Exceptions For a Geom_Axis2Placement: Standard_ConstructionError if A1 and the previous "X Direction" of the coordinate system are parallel.

◆ SetDirection()

virtual void Geom_AxisPlacement::SetDirection ( const gp_Dir V)
pure virtual

Changes the direction of the axis placement. If <me> is an axis placement two axis the main "Direction" is modified and the "XDirection" and "YDirection" are recomputed. Raises ConstructionError only for an axis placement two axis if V and the previous "XDirection" are parallel because it is not possible to calculate the new "XDirection" and the new "YDirection".

Implemented in Geom_Axis2Placement, and Geom_Axis1Placement.

◆ SetLocation()

void Geom_AxisPlacement::SetLocation ( const gp_Pnt P)

Assigns the point P as the origin of this positioning system.

Field Documentation

◆ axis

gp_Ax1 Geom_AxisPlacement::axis
protected

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