Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
core::conformation::symmetry::SymmetryTransform Class Reference

#include <SymmetryTransform.hh>

Inheritance diagram for core::conformation::symmetry::SymmetryTransform:
Inheritance graph
[legend]

Public Member Functions

 SymmetryTransform ()
 Default constructor. More...
 
 SymmetryTransform (numeric::xyzVector< core::Real > const &p1, numeric::xyzVector< core::Real > const &p2, numeric::xyzVector< core::Real > const &p3, bool const mirror_z=false)
 Data constructor. More...
 
 ~SymmetryTransform () override
 Default destructor. More...
 
SymmetryTransformOP clone () const
 Clone operator. More...
 
numeric::HomogeneousTransform
< core::Real > const & 
ht () const
 Get the HomogeneousTransform matrix. More...
 
void set_mirror_z (bool const val)
 Set whether this HomogeneousTransform mirrors about the z-axis or not. More...
 
bool mirror_z () const
 Get whether this HomogeneousTransform mirrors aout the z-axis or not. More...
 

Private Attributes

numeric::HomogeneousTransform
< core::Real
htransform_
 The HomogeneousTransform object that describes the translational and rotational part of the symmetry transform. More...
 
bool mirror_z_
 Should this HomogeneousTransform mirror the object about the z-axis? More...
 

Constructor & Destructor Documentation

core::conformation::symmetry::SymmetryTransform::SymmetryTransform ( )

Default constructor.

core::conformation::symmetry::SymmetryTransform::SymmetryTransform ( numeric::xyzVector< core::Real > const &  p1,
numeric::xyzVector< core::Real > const &  p2,
numeric::xyzVector< core::Real > const &  p3,
bool const  mirror_z = false 
)

Data constructor.

Parameters
[in]p1,p2,p3xyzVectors for initializing the HomogeneousTransform.
[in]mirror_zShould the copy be mirrored about the z-axis?
[in]p1,p2,p3xyzVectors for initializing the HomogeneousTransform.

References set_mirror_z().

core::conformation::symmetry::SymmetryTransform::~SymmetryTransform ( )
overridedefault

Default destructor.

Destructor.

Member Function Documentation

SymmetryTransformOP core::conformation::symmetry::SymmetryTransform::clone ( ) const

Clone operator.

Copy this object and return an owning pointer to the copy.

numeric::HomogeneousTransform< core::Real > const& core::conformation::symmetry::SymmetryTransform::ht ( ) const
inline

Get the HomogeneousTransform matrix.

References htransform_.

bool core::conformation::symmetry::SymmetryTransform::mirror_z ( ) const
inline

Get whether this HomogeneousTransform mirrors aout the z-axis or not.

References mirror_z_.

void core::conformation::symmetry::SymmetryTransform::set_mirror_z ( bool const  val)

Set whether this HomogeneousTransform mirrors about the z-axis or not.

References htransform_, mirror_z_, core::kinematics::Jump::mirror_z_transform, and protocols::hybridization::val.

Referenced by SymmetryTransform().

Member Data Documentation

numeric::HomogeneousTransform< core::Real > core::conformation::symmetry::SymmetryTransform::htransform_
private

The HomogeneousTransform object that describes the translational and rotational part of the symmetry transform.

Referenced by ht(), and set_mirror_z().

bool core::conformation::symmetry::SymmetryTransform::mirror_z_
private

Should this HomogeneousTransform mirror the object about the z-axis?

False by default.

Referenced by mirror_z(), and set_mirror_z().


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