A decorator for a particle that is part of a rigid body but not rigid. More...

#include <IMP/core/rigid_bodies.h>

Inheritance diagram for IMP::core::NonRigidMember:

Public Member Functions
	NonRigidMember (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)

	NonRigidMember (const IMP::kernel::ParticleAdaptor &d)

void	show (std::ostream &out=std::cout) const

Public Member Functions inherited from IMP::core::RigidBodyMember
	RigidBodyMember (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)

	RigidBodyMember (const IMP::kernel::ParticleAdaptor &d)

const algebra::Vector3D &	get_internal_coordinates () const
	Return the current orientation of the body.

algebra::Transformation3D	get_internal_transformation () const

RigidBody	get_rigid_body () const

void	set_coordinates (const algebra::Vector3D &center)
	XYZ::set_coordiantes()

void	set_internal_coordinates (const algebra::Vector3D &v) const
	set the internal coordinates for this member

void	set_internal_transformation (const algebra::Transformation3D &v)
	Member must be a rigid body.

void	show (std::ostream &out=std::cout) const

Public Member Functions inherited from IMP::core::XYZ
	XYZ (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)

	XYZ (const IMP::kernel::ParticleAdaptor &d)

void	add_to_derivative (int i, Float v, DerivativeAccumulator &d)
	Add something to the derivative of the ith coordinate.

void	add_to_derivatives (const algebra::Vector3D &v, DerivativeAccumulator &d)
	Add something to the derivative of the coordinates.

Float	get_coordinate (int i) const
	Get the ith coordinate.

const algebra::Vector3D &	get_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
	Get the ith coordinate derivative.

algebra::Vector3D	get_derivatives () const
	Get the vector of derivatives. More...

algebra::Vector3D	get_vector_to (const XYZ &b) const
	Get the vector from this particle to another.

Float	get_x () const

Float	get_y () const

Float	get_z () const

void	set_coordinate (unsigned int i, Float v)
	set the ith coordinate

void	set_coordinates (const algebra::Vector3D &v)
	set all coordinates from a vector

void	set_coordinates_are_optimized (bool tf) const
	Set whether the coordinates are optimized.

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::kernel::Decorator
ParticleIndex	get_particle_index () const

Particle *	get_particle () const

Model *	get_model () const
	Returns the Model containing the particle.

	Decorator (Particle *p)

	Decorator ()

Static Public Member Functions
static NonRigidMember	decorate_particle (::IMP::kernel::Particle *p)

static bool	get_is_setup (const IMP::kernel::ParticleAdaptor &p)

static bool	get_is_setup (kernel::Model *m, kernel::ParticleIndex p)
	return true if it is a rigid member

static bool	particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)

static bool	particle_is_instance (::IMP::kernel::Particle *p)

Static Public Member Functions inherited from IMP::core::RigidBodyMember
static RigidBodyMember	decorate_particle (::IMP::kernel::Particle *p)

static FloatKeys	get_internal_coordinate_keys ()

static bool	get_is_setup (const IMP::kernel::ParticleAdaptor &p)

static bool	get_is_setup (kernel::Model *m, kernel::ParticleIndexAdaptor p)
	return true if it is a rigid member

static bool	particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)

static bool	particle_is_instance (::IMP::kernel::Particle *p)

Static Public Member Functions inherited from IMP::core::XYZ
static XYZ	decorate_particle (::IMP::kernel::Particle *p)

static FloatKey	get_coordinate_key (unsigned int i)

static bool	get_is_setup (const IMP::kernel::ParticleAdaptor &p)

static bool	get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)

static const FloatKeys &	get_xyz_keys ()
	Get a vector containing the keys for x,y,z. More...

static bool	particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)

static bool	particle_is_instance (::IMP::kernel::Particle *p)

static XYZ	setup_particle (IMP::kernel::ParticleAdaptor decorator)

static XYZ	setup_particle (kernel::Model *m, ParticleIndex pi)

static XYZ	setup_particle (kernel::Model *m, ParticleIndex pi, algebra::Vector3D v)

static XYZ	setup_particle (IMP::kernel::ParticleAdaptor decorator, algebra::Vector3D v)

Static Public Member Functions inherited from IMP::kernel::Decorator
static bool	get_is_setup (Particle *p)
	Return true if the particle can be cast to the decorator. More...

Additional Inherited Members
Protected Member Functions inherited from IMP::kernel::Decorator
	Decorator (kernel::Model *m, ParticleIndex pi)

	Decorator (ParticleAdaptor p)

Detailed Description

NonRigidMembers, like RigidMembers have internal coordinates and move along with the rigid body. However, it is expected that their internal coordinates will change, and so they are not part of structures that assume rigidity.

See Also: RigidBody

Definition at line 371 of file rigid_bodies.h.

Member Function Documentation

static NonRigidMember IMP::core::NonRigidMember::decorate_particle ( ::IMP::kernel::Particle * p )

static

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Check explicitly instead.

Definition at line 373 of file rigid_bodies.h.

static bool IMP::core::NonRigidMember::particle_is_instance ( ::IMP::kernel::Particle * p )

static

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 373 of file rigid_bodies.h.

static bool IMP::core::NonRigidMember::particle_is_instance	(	IMP::kernel::Model *	m,
		IMP::kernel::ParticleIndex	pi
	)

static

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 373 of file rigid_bodies.h.

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

rigid_bodies.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation