// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _gp_Ax2_HeaderFile #define _gp_Ax2_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_Macro_HeaderFile #include #endif #ifndef _gp_Ax1_HeaderFile #include #endif #ifndef _gp_Dir_HeaderFile #include #endif #ifndef _Standard_Storable_HeaderFile #include #endif #ifndef _Standard_Real_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Standard_PrimitiveTypes_HeaderFile #include #endif class Standard_ConstructionError; class gp_Pnt; class gp_Dir; class gp_Ax1; class gp_Trsf; class gp_Vec; Standard_EXPORT const Handle(Standard_Type)& STANDARD_TYPE(gp_Ax2); //! Describes a right-handed coordinate system in 3D space.
//! A coordinate system is defined by:
//! - its origin (also referred to as its "Location point"), and
//! - three orthogonal unit vectors, termed respectively the
//! "X Direction", the "Y Direction" and the "Direction" (also
//! referred to as the "main Direction").
//! The "Direction" of the coordinate system is called its
//! "main Direction" because whenever this unit vector is
//! modified, the "X Direction" and the "Y Direction" are
//! recomputed. However, when we modify either the "X
//! Direction" or the "Y Direction", "Direction" is not modified.
//! The "main Direction" is also the "Z Direction".
//! Since an Ax2 coordinate system is right-handed, its
//! "main Direction" is always equal to the cross product of
//! its "X Direction" and "Y Direction". (To define a
//! left-handed coordinate system, use gp_Ax3.)
//! A coordinate system is used:
//! - to describe geometric entities, in particular to position
//! them. The local coordinate system of a geometric
//! entity serves the same purpose as the STEP function
//! "axis placement two axes", or
//! - to define geometric transformations.
//! Note: we refer to the "X Axis", "Y Axis" and "Z Axis",
//! respectively, as to axes having:
//! - the origin of the coordinate system as their origin, and
//! - the unit vectors "X Direction", "Y Direction" and "main
//! Direction", respectively, as their unit vectors.
//! The "Z Axis" is also the "main Axis".
class gp_Ax2 { public: void* operator new(size_t,void* anAddress) { return anAddress; } void* operator new(size_t size) { return Standard::Allocate(size); } void operator delete(void *anAddress) { if (anAddress) Standard::Free((Standard_Address&)anAddress); } //! Creates an object corresponding to the reference
//! coordinate system (OXYZ).
gp_Ax2(); //! Creates an axis placement with an origin P such that:
//! - N is the Direction, and
//! - the "X Direction" is normal to N, in the plane
//! defined by the vectors (N, Vx): "X
//! Direction" = (N ^ Vx) ^ N,
//! Exception: raises ConstructionError if N and Vx are parallel (same or opposite orientation).
gp_Ax2(const gp_Pnt& P,const gp_Dir& N,const gp_Dir& Vx); //! Creates - a coordinate system with an origin P, where V
//! gives the "main Direction" (here, "X Direction" and "Y
//! Direction" are defined automatically).
Standard_EXPORT gp_Ax2(const gp_Pnt& P,const gp_Dir& V); //! Assigns the origin and "main Direction" of the axis A1 to
//! this coordinate system, then recomputes its "X Direction" and "Y Direction".
//! Note: The new "X Direction" is computed as follows:
//! new "X Direction" = V1 ^(previous "X Direction" ^ V)
//! where V is the "Direction" of A1.
//! Exceptions
//! Standard_ConstructionError if A1 is parallel to the "X
//! Direction" of this coordinate system.
Standard_EXPORT void SetAxis(const gp_Ax1& A1) ; //! Changes the "main Direction" of this coordinate system,
//! then recomputes its "X Direction" and "Y Direction".
//! Note: the new "X Direction" is computed as follows:
//! new "X Direction" = V ^ (previous "X Direction" ^ V)
//! Exceptions
//! Standard_ConstructionError if V is parallel to the "X
//! Direction" of this coordinate system.
Standard_EXPORT void SetDirection(const gp_Dir& V) ; //! Changes the "Location" point (origin) of .
Standard_EXPORT void SetLocation(const gp_Pnt& P) ; //! Changes the "Xdirection" of . The main direction
//! "Direction" is not modified, the "Ydirection" is modified.
//! If is not normal to the main direction then
//! is computed as follows XDirection = Direction ^ (Vx ^ Direction).
//! Exceptions
//! Standard_ConstructionError if Vx or Vy is parallel to
//! the "main Direction" of this coordinate system.
Standard_EXPORT void SetXDirection(const gp_Dir& Vx) ; //! Changes the "Ydirection" of . The main direction is not
//! modified but the "Xdirection" is changed.
//! If is not normal to the main direction then "YDirection"
//! is computed as follows
//! YDirection = Direction ^ ( ^ Direction).
//! Exceptions
//! Standard_ConstructionError if Vx or Vy is parallel to
//! the "main Direction" of this coordinate system.
Standard_EXPORT void SetYDirection(const gp_Dir& Vy) ; //! Computes the angular value, in radians, between the main direction of
//! and the main direction of . Returns the angle
//! between 0 and PI in radians.
Standard_EXPORT Standard_Real Angle(const gp_Ax2& Other) const; //! Returns the main axis of . It is the "Location" point
//! and the main "Direction".
const gp_Ax1& Axis() const; //! Returns the main direction of .
const gp_Dir& Direction() const; //! Returns the "Location" point (origin) of .
const gp_Pnt& Location() const; //! Returns the "XDirection" of .
const gp_Dir& XDirection() const; //! Returns the "YDirection" of .
const gp_Dir& YDirection() const; Standard_EXPORT Standard_Boolean IsCoplanar(const gp_Ax2& Other,const Standard_Real LinearTolerance,const Standard_Real AngularTolerance) const; //! Returns True if
//! . the distance between and the "Location" point of A1
//! is lower of equal to LinearTolerance and
//! . the main direction of and the direction of A1 are normal.
//! Note: the tolerance criterion for angular equality is given by AngularTolerance.
Standard_Boolean IsCoplanar(const gp_Ax1& A1,const Standard_Real LinearTolerance,const Standard_Real AngularTolerance) const; //! Performs a symmetrical transformation of this coordinate
//! system with respect to:
//! - the point P, and assigns the result to this coordinate system.
//! Warning
//! This transformation is always performed on the origin.
//! In case of a reflection with respect to a point:
//! - the main direction of the coordinate system is not changed, and
//! - the "X Direction" and the "Y Direction" are simply reversed
//! In case of a reflection with respect to an axis or a plane:
//! - the transformation is applied to the "X Direction"
//! and the "Y Direction", then
//! - the "main Direction" is recomputed as the cross
//! product "X Direction" ^ "Y Direction".
//! This maintains the right-handed property of the
//! coordinate system.
Standard_EXPORT void Mirror(const gp_Pnt& P) ; //! Performs a symmetrical transformation of this coordinate
//! system with respect to:
//! - the point P, and creates a new one.
//! Warning
//! This transformation is always performed on the origin.
//! In case of a reflection with respect to a point:
//! - the main direction of the coordinate system is not changed, and
//! - the "X Direction" and the "Y Direction" are simply reversed
//! In case of a reflection with respect to an axis or a plane:
//! - the transformation is applied to the "X Direction"
//! and the "Y Direction", then
//! - the "main Direction" is recomputed as the cross
//! product "X Direction" ^ "Y Direction".
//! This maintains the right-handed property of the
//! coordinate system.
Standard_EXPORT gp_Ax2 Mirrored(const gp_Pnt& P) const; //! Performs a symmetrical transformation of this coordinate
//! system with respect to:
//! - the axis A1, and assigns the result to this coordinate systeme.
//! Warning
//! This transformation is always performed on the origin.
//! In case of a reflection with respect to a point:
//! - the main direction of the coordinate system is not changed, and
//! - the "X Direction" and the "Y Direction" are simply reversed
//! In case of a reflection with respect to an axis or a plane:
//! - the transformation is applied to the "X Direction"
//! and the "Y Direction", then
//! - the "main Direction" is recomputed as the cross
//! product "X Direction" ^ "Y Direction".
//! This maintains the right-handed property of the
//! coordinate system.
Standard_EXPORT void Mirror(const gp_Ax1& A1) ; //! Performs a symmetrical transformation of this coordinate
//! system with respect to:
//! - the axis A1, and creates a new one.
//! Warning
//! This transformation is always performed on the origin.
//! In case of a reflection with respect to a point:
//! - the main direction of the coordinate system is not changed, and
//! - the "X Direction" and the "Y Direction" are simply reversed
//! In case of a reflection with respect to an axis or a plane:
//! - the transformation is applied to the "X Direction"
//! and the "Y Direction", then
//! - the "main Direction" is recomputed as the cross
//! product "X Direction" ^ "Y Direction".
//! This maintains the right-handed property of the
//! coordinate system.
Standard_EXPORT gp_Ax2 Mirrored(const gp_Ax1& A1) const; //! Performs a symmetrical transformation of this coordinate
//! system with respect to:
//! - the plane defined by the origin, "X Direction" and "Y
//! Direction" of coordinate system A2 and assigns the result to this coordinate systeme.
//! Warning
//! This transformation is always performed on the origin.
//! In case of a reflection with respect to a point:
//! - the main direction of the coordinate system is not changed, and
//! - the "X Direction" and the "Y Direction" are simply reversed
//! In case of a reflection with respect to an axis or a plane:
//! - the transformation is applied to the "X Direction"
//! and the "Y Direction", then
//! - the "main Direction" is recomputed as the cross
//! product "X Direction" ^ "Y Direction".
//! This maintains the right-handed property of the
//! coordinate system.
Standard_EXPORT void Mirror(const gp_Ax2& A2) ; //! Performs a symmetrical transformation of this coordinate
//! system with respect to:
//! - the plane defined by the origin, "X Direction" and "Y
//! Direction" of coordinate system A2 and creates a new one.
//! Warning
//! This transformation is always performed on the origin.
//! In case of a reflection with respect to a point:
//! - the main direction of the coordinate system is not changed, and
//! - the "X Direction" and the "Y Direction" are simply reversed
//! In case of a reflection with respect to an axis or a plane:
//! - the transformation is applied to the "X Direction"
//! and the "Y Direction", then
//! - the "main Direction" is recomputed as the cross
//! product "X Direction" ^ "Y Direction".
//! This maintains the right-handed property of the
//! coordinate system.
Standard_EXPORT gp_Ax2 Mirrored(const gp_Ax2& A2) const; void Rotate(const gp_Ax1& A1,const Standard_Real Ang) ; //! Rotates an axis placement. is the axis of the
//! rotation . Ang is the angular value of the rotation
//! in radians.
gp_Ax2 Rotated(const gp_Ax1& A1,const Standard_Real Ang) const; void Scale(const gp_Pnt& P,const Standard_Real S) ; //! Applies a scaling transformation on the axis placement.
//! The "Location" point of the axisplacement is modified.
//! Warnings :
//! If the scale is negative :
//! . the main direction of the axis placement is not changed.
//! . The "XDirection" and the "YDirection" are reversed.
//! So the axis placement stay right handed.
gp_Ax2 Scaled(const gp_Pnt& P,const Standard_Real S) const; void Transform(const gp_Trsf& T) ; //! Transforms an axis placement with a Trsf.
//! The "Location" point, the "XDirection" and the
//! "YDirection" are transformed with T. The resulting
//! main "Direction" of is the cross product between
//! the "XDirection" and the "YDirection" after transformation.
gp_Ax2 Transformed(const gp_Trsf& T) const; void Translate(const gp_Vec& V) ; //! Translates an axis plaxement in the direction of the vector
//! . The magnitude of the translation is the vector's magnitude.
gp_Ax2 Translated(const gp_Vec& V) const; void Translate(const gp_Pnt& P1,const gp_Pnt& P2) ; //! Translates an axis placement from the point to the
//! point .
gp_Ax2 Translated(const gp_Pnt& P1,const gp_Pnt& P2) const; const gp_Ax1& _CSFDB_Getgp_Ax2axis() const { return axis; } const gp_Dir& _CSFDB_Getgp_Ax2vydir() const { return vydir; } const gp_Dir& _CSFDB_Getgp_Ax2vxdir() const { return vxdir; } protected: private: gp_Ax1 axis; gp_Dir vydir; gp_Dir vxdir; }; #include // other Inline functions and methods (like "C++: function call" methods) #endif