IMP logo
IMP Reference Guide  2.11.1
The Integrative Modeling Platform
IMP::core::RigidBodyMember Class Reference

A member of a rigid body, it has internal (local) coordinates. More...

#include <IMP/core/rigid_bodies.h>

+ Inheritance diagram for IMP::core::RigidBodyMember:

Detailed Description

A member of a rigid body, it has internal (local) coordinates.

Definition at line 575 of file rigid_bodies.h.

Public Member Functions

 RigidBodyMember (::IMP::Model *m,::IMP::ParticleIndex id)
 
 RigidBodyMember (const IMP::ParticleAdaptor &d)
 
const algebra::Vector3Dget_internal_coordinates () const
 Return the internal (local) coordinates of this member. More...
 
algebra::Transformation3D get_internal_transformation () const
 
RigidBody get_rigid_body () const
 
void set_coordinates (const algebra::Vector3D &center)
 sets the global coordinates of this member using XYZ::set_coordinates() More...
 
void set_internal_coordinates (const algebra::Vector3D &v) const
 set the internal (local) coordinates for this member More...
 
void set_internal_transformation (const algebra::Transformation3D &v)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::core::XYZ
 XYZ (::IMP::Model *m,::IMP::ParticleIndex id)
 
 XYZ (const IMP::ParticleAdaptor &d)
 
void add_to_derivative (int i, Float v, DerivativeAccumulator &d)
 
void add_to_derivatives (const algebra::Vector3D &v, DerivativeAccumulator &d)
 Add the vector v to the derivative vector of the x,y,z coordinates. More...
 
Float get_coordinate (int i) const
 Get the ith coordinate. More...
 
const algebra::Vector3Dget_coordinates () const
 Convert it to a vector. More...
 
bool get_coordinates_are_optimized () const
 Get whether the coordinates are optimized. More...
 
Float get_derivative (int i) const
 
algebra::Vector3D get_derivatives () const
 Get the vector of derivatives accumulated by add_to_derivatives(). More...
 
algebra::Vector3D get_vector_to (const XYZ &b) const
 Get the vector from this particle to another. More...
 
Float get_x () const
 
Float get_y () const
 
Float get_z () const
 
void set_coordinate (unsigned int i, Float v)
 set the ith coordinate More...
 
void set_coordinates (const algebra::Vector3D &v)
 set all coordinates from a vector More...
 
void set_coordinates_are_optimized (bool tf) const
 Set whether the coordinates are optimized. More...
 
void set_x (Float t)
 
void set_y (Float t)
 
void set_z (Float t)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::Decorator
bool get_is_valid () const
 Returns true if constructed with a non-default constructor. More...
 
Modelget_model () const
 Returns the Model containing the particle. More...
 
Particleget_particle () const
 Returns the particle decorated by this decorator. More...
 
ParticleIndex get_particle_index () const
 Returns the particle index decorated by this decorator. More...
 
 operator Particle * () const
 
 operator ParticleIndex () const
 
Particleoperator-> () const
 

Static Public Member Functions

static FloatKeys get_internal_coordinate_keys ()
 
static FloatKeys get_internal_rotation_keys ()
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndexAdaptor p)
 return true if it is a rigid member More...
 
- Static Public Member Functions inherited from IMP::core::XYZ
static FloatKey get_coordinate_key (unsigned int i)
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndex pi)
 
static const FloatKeysget_xyz_keys ()
 Get a vector containing the keys for x,y,z. More...
 
static XYZ setup_particle (IMP::ParticleAdaptor decorator)
 
static XYZ setup_particle (Model *m, ParticleIndex pi)
 
static XYZ setup_particle (IMP::ParticleAdaptor decorator, algebra::Vector3D v)
 
static XYZ setup_particle (Model *m, ParticleIndex pi, algebra::Vector3D v)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Member Function Documentation

const algebra::Vector3D& IMP::core::RigidBodyMember::get_internal_coordinates ( ) const

Return the internal (local) coordinates of this member.

These coordinates are relative to the reference frame of the rigid body that owns it

Definition at line 584 of file rigid_bodies.h.

+ Here is the call graph for this function:

algebra::Transformation3D IMP::core::RigidBodyMember::get_internal_transformation ( ) const

Return the internal (local) coordinates of this member, assuming it is a rigid body itself Return the internal (local) coordinates of this rigid body relative to the reference frame of the rigid body that owns it

Definition at line 627 of file rigid_bodies.h.

+ Here is the call graph for this function:

static bool IMP::core::RigidBodyMember::get_is_setup ( Model m,
ParticleIndexAdaptor  p 
)
static

return true if it is a rigid member

Definition at line 664 of file rigid_bodies.h.

void IMP::core::RigidBodyMember::set_coordinates ( const algebra::Vector3D center)

sets the global coordinates of this member using XYZ::set_coordinates()

Definition at line 650 of file rigid_bodies.h.

+ Here is the call graph for this function:

void IMP::core::RigidBodyMember::set_internal_coordinates ( const algebra::Vector3D v) const

set the internal (local) coordinates for this member

Definition at line 589 of file rigid_bodies.h.

+ Here is the call graph for this function:

void IMP::core::RigidBodyMember::set_internal_transformation ( const algebra::Transformation3D v)

Set the internal (local) coordinates of this member, assuming it is a rigid body itself Set the internal (local) coordinates of this rigid body relative to the reference frame of the rigid body that owns it

Definition at line 599 of file rigid_bodies.h.

+ Here is the call graph for this function:


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