HepGeom::Transform3D Class Reference

#include <Transform3D.h>

Inheritance diagram for HepGeom::Transform3D:

Collaboration diagram for HepGeom::Transform3D:

Classes
class	Transform3D_row

Public Member Functions
	Transform3D ()
	Transform3D (const CLHEP::HepRotation &m, const CLHEP::Hep3Vector &v)
	Transform3D (const Point3D< double > &fr0, const Point3D< double > &fr1, const Point3D< double > &fr2, const Point3D< double > &to0, const Point3D< double > &to1, const Point3D< double > &to2)
	Transform3D (const Transform3D &m)
	~Transform3D ()
const Transform3D_row	operator[] (int) const
double	operator() (int, int) const
double	xx () const
double	xy () const
double	xz () const
double	yx () const
double	yy () const
double	yz () const
double	zx () const
double	zy () const
double	zz () const
double	dx () const
double	dy () const
double	dz () const
Transform3D &	operator= (const Transform3D &m)
void	setIdentity ()
Transform3D	inverse () const
Transform3D	operator* (const Transform3D &b) const
void	getDecomposition (Scale3D &scale, Rotate3D &rotation, Translate3D &translation) const
bool	isNear (const Transform3D &t, double tolerance=2.2E-14) const
CLHEP::HepRotation	getRotation () const
CLHEP::Hep3Vector	getTranslation () const
bool	operator== (const Transform3D &transform) const
bool	operator!= (const Transform3D &transform) const

Static Public Attributes
static const Transform3D	Identity = Transform3D ()

Protected Member Functions
	Transform3D (double XX, double XY, double XZ, double DX, double YX, double YY, double YZ, double DY, double ZX, double ZY, double ZZ, double DZ)
void	setTransform (double XX, double XY, double XZ, double DX, double YX, double YY, double YZ, double DY, double ZX, double ZY, double ZZ, double DZ)

Protected Attributes
double	xx_
double	xy_
double	xz_
double	dx_
double	yx_
double	yy_
double	yz_
double	dy_
double	zx_
double	zy_
double	zz_
double	dz_

Detailed Description

Class for transformation of 3D geometrical objects. It allows different translations, rotations, scalings and reflections. Several specialized classes are derived from it:

TranslateX3D, TranslateY3D, TranslateZ3D, Translate3D,
RotateX3D, RotateY3D, RotateZ3D, Rotate3D,
ScaleX3D, ScaleY3D, ScaleZ3D, Scale3D,
ReflectX3D, ReflectY3D, ReflectZ3D, Reflect3D.

The idea behind these classes is to provide some additional constructors for Transform3D, they normally should not be used as separate classes.

Example:

HepGeom::Transform3D m;
m = HepGeom::TranslateX3D(10.*cm);

Remark: For the reason that the operator* is left associative, the notation

v2 = m3*(m2*(m1*v1));

is much more effective then the notation

v2 = m3*m2*m1*v1;

In the first case three operations Transform3D*Vector3D are executed, in the second case two operations Transform3D*Transform3D and one Transform3D*Vector3D are performed. Transform3D*Transform3D is roughly three times slower than Transform3D*Vector3D.

Author

Evgue.nosp@m.ni.T.nosp@m.chern.nosp@m.iaev.nosp@m.@cern.nosp@m..ch

Definition at line 171 of file Transform3D.h.

Constructor & Destructor Documentation

HepGeom::Transform3D::Transform3D ( double  XX, double  XY, double  XZ, double  DX, double  YX, double  YY, double  YZ, double  DY, double  ZX, double  ZY, double  ZZ, double  DZ  )

inlineprotected

Definition at line 178 of file Transform3D.h.

HepGeom::Transform3D::Transform3D ( )

inline

Default constructor - sets the Identity transformation.

Definition at line 211 of file Transform3D.h.

Here is the caller graph for this function:

HepGeom::Transform3D::Transform3D ( const CLHEP::HepRotation &  m, const CLHEP::Hep3Vector &  v  )

inline

Constructor: rotation and then translation.

HepGeom::Transform3D::Transform3D	(	const Point3D< double > &	fr0,
		const Point3D< double > &	fr1,
		const Point3D< double > &	fr2,
		const Point3D< double > &	to0,
		const Point3D< double > &	to1,
		const Point3D< double > &	to2
	)

Constructor: transformation of basis (assumed - no reflection).

Definition at line 63 of file Transform3D.cc.

Here is the call graph for this function:

HepGeom::Transform3D::Transform3D ( const Transform3D &  m)

inline

Copy constructor.

Definition at line 231 of file Transform3D.h.

HepGeom::Transform3D::~Transform3D ( )

inline

Destructor. Virtual for now as some persistency mechanism needs that, in future releases this might go away again.

Definition at line 241 of file Transform3D.h.

Member Function Documentation

double HepGeom::Transform3D::dx ( ) const

inline

Gets dx-element of the transformation matrix.

Definition at line 279 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::dy ( ) const

inline

Gets dy-element of the transformation matrix.

Definition at line 282 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::dz ( ) const

inline

Gets dz-element of the transformation matrix.

Definition at line 285 of file Transform3D.h.

Here is the caller graph for this function:

void HepGeom::Transform3D::getDecomposition	(	Scale3D &	scale,
		Rotate3D &	rotation,
		Translate3D &	translation
	)		const

Decomposition of general transformation. This function gets decomposition of the transformation in three consequentive specific transformations: Scale3D, then Rotate3D, then Translate3, i.e.

Transform3D = Translate3D * Rotate3D * Scale3D

Parameters

scale	output: scaling transformation; if there was a reflection, then scale factor for z-component (scale(2,2)) will be negative.
rotation	output: rotation transformaion.
translation	output: translation transformaion.

Definition at line 174 of file Transform3D.cc.

Here is the caller graph for this function:

CLHEP::HepRotation HepGeom::Transform3D::getRotation ( ) const

inline

Extracts the rotation matrix. This functions is obsolete - use getDecomposition() instead.

Here is the caller graph for this function:

CLHEP::Hep3Vector HepGeom::Transform3D::getTranslation ( ) const

inline

Extracts the translation vector. This functions is obsolete - use getDecomposition() instead.

Here is the caller graph for this function:

Transform3D HepGeom::Transform3D::inverse

(

)

const

Returns the inverse transformation.

Definition at line 142 of file Transform3D.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HepGeom::Transform3D::isNear	(	const Transform3D &	t,
		double	tolerance = 2.2E-14
	)		const

Returns true if the difference between corresponding matrix elements is less than the tolerance.

Definition at line 204 of file Transform3D.cc.

bool HepGeom::Transform3D::operator!= ( const Transform3D &  transform) const

inline

Test for inequality.

Definition at line 353 of file Transform3D.h.

Here is the call graph for this function:

double HepGeom::Transform3D::operator()	(	int	i,
		int	j
	)		const

Fortran-style subscripting: returns (i,j) element of the matrix.

Definition at line 24 of file Transform3D.cc.

Transform3D HepGeom::Transform3D::operator*

(

const Transform3D &

b)

const

Transformation by another Transform3D.

Definition at line 52 of file Transform3D.cc.

Here is the call graph for this function:

Transform3D& HepGeom::Transform3D::operator= ( const Transform3D &  m)

inline

Assignment.

Definition at line 289 of file Transform3D.h.

bool HepGeom::Transform3D::operator==

(

const Transform3D &

transform)

const

Test for equality.

Definition at line 221 of file Transform3D.cc.

Here is the caller graph for this function:

const Transform3D_row HepGeom::Transform3D::operator[] ( int  ) const

inline

Returns object of the helper class for C-style subscripting r[i][j]

void HepGeom::Transform3D::setIdentity ( )

inline

Sets the Identity transformation.

Definition at line 298 of file Transform3D.h.

Here is the caller graph for this function:

void HepGeom::Transform3D::setTransform ( double  XX, double  XY, double  XZ, double  DX, double  YX, double  YY, double  YZ, double  DY, double  ZX, double  ZY, double  ZZ, double  DZ  )

inlineprotected

Definition at line 186 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::xx ( ) const

inline

Gets xx-element of the transformation matrix.

Definition at line 252 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::xy ( ) const

inline

Gets xy-element of the transformation matrix.

Definition at line 255 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::xz ( ) const

inline

Gets xz-element of the transformation matrix.

Definition at line 258 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::yx ( ) const

inline

Gets yx-element of the transformation matrix.

Definition at line 261 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::yy ( ) const

inline

Gets yy-element of the transformation matrix.

Definition at line 264 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::yz ( ) const

inline

Gets yz-element of the transformation matrix.

Definition at line 267 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::zx ( ) const

inline

Gets zx-element of the transformation matrix.

Definition at line 270 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::zy ( ) const

inline

Gets zy-element of the transformation matrix.

Definition at line 273 of file Transform3D.h.

Here is the caller graph for this function:

double HepGeom::Transform3D::zz ( ) const

inline

Gets zz-element of the transformation matrix.

Definition at line 276 of file Transform3D.h.

Here is the caller graph for this function:

Member Data Documentation

double HepGeom::Transform3D::dx_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::dy_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::dz_

protected

Definition at line 173 of file Transform3D.h.

const Transform3D HepGeom::Transform3D::Identity = Transform3D ()

static

Global identity transformation.

Definition at line 197 of file Transform3D.h.

double HepGeom::Transform3D::xx_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::xy_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::xz_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::yx_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::yy_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::yz_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::zx_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::zy_

protected

Definition at line 173 of file Transform3D.h.

double HepGeom::Transform3D::zz_

protected

Definition at line 173 of file Transform3D.h.

---

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

• D:/Geant4/geant4_9_6_p02/source/externals/clhep/include/CLHEP/Geometry/Transform3D.h
• D:/Geant4/geant4_9_6_p02/source/externals/clhep/src/Transform3D.cc