OCC Main Page | ModelingData | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingData
TKG3d
Geom


Geom_AxisPlacement Class Reference

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:
- the axis (Geom_Axis1Placement class), which is defined by:
- its origin, also termed the "Location point" of the axis,
- its unit vector, termed the "Direction" or "main <br> Direction" of the axis;
- the right-handed coordinate system
(Geom_Axis2Placement class), which is defined by:
- its origin, also termed the "Location point" of the coordinate system,
- three orthogonal unit vectors, termed
respectively the "X Direction", the "Y Direction"
and the "Direction" of the coordinate system. As
the coordinate system is right-handed, these
unit vectors have the following relation:
"Direction" = "X Direction" ^
"Y Direction". The "Direction" is also
called the "main Direction" because, when the
unit vector is modified, the "X Direction" and "Y <br> Direction" are recomputed, whereas when the "X <br> Direction" or "Y Direction" is modified, the "main Direction" does not change.
The axis whose origin is the origin of the positioning
system and whose unit vector is its "main Direction" is
also called the "Axis" or "main Axis" of the positioning system.
.

#include <Geom_AxisPlacement.hxx>

Inheritance diagram for Geom_AxisPlacement:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT void 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.
.
virtual Standard_EXPORT 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".
.
Standard_EXPORT void SetLocation (const gp_Pnt &P)
 Assigns the point P as the origin of this positioning system.
.
Standard_EXPORT 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.
.
Standard_EXPORT const gp_Ax1 & 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>.
.
Standard_EXPORT gp_Dir Direction () const
 Returns the main "Direction" of an axis placement.
.
Standard_EXPORT gp_Pnt Location () const
 Returns the Location point (origin) of the axis placement.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Protected Attributes

gp_Ax1 axis

Member Function Documentation

Standard_EXPORT Standard_Real Geom_AxisPlacement::Angle const Handle(Geom_AxisPlacement)&  Other  )  const
 

Standard_EXPORT const gp_Ax1& Geom_AxisPlacement::Axis  )  const
 

Standard_EXPORT gp_Dir Geom_AxisPlacement::Direction  )  const
 

Standard_EXPORT const Geom_AxisPlacement::Handle Standard_Type   )  const
 

Reimplemented from Geom_Geometry.

Reimplemented in Geom_Axis1Placement, and Geom_Axis2Placement.

Standard_EXPORT gp_Pnt Geom_AxisPlacement::Location  )  const
 

Standard_EXPORT void Geom_AxisPlacement::SetAxis const gp_Ax1 &  A1  ) 
 

virtual Standard_EXPORT void Geom_AxisPlacement::SetDirection const gp_Dir &  V  )  [pure virtual]
 

Implemented in Geom_Axis1Placement, and Geom_Axis2Placement.

Standard_EXPORT void Geom_AxisPlacement::SetLocation const gp_Pnt &  P  ) 
 


Field Documentation

gp_Ax1 Geom_AxisPlacement::axis [protected]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:22:51 2008 for OpenCASCADE by  doxygen 1.4.1