#include <IMP/kinematics/KinematicNode.h>

Inheritance diagram for IMP::kinematics::KinematicNode:

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

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

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

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

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

void	add_member (kernel::ParticleIndexAdaptor p)

void	add_non_rigid_member (kernel::ParticleIndex pi)

const kernel::ParticleIndexes &	get_body_member_particle_indexes () const

algebra::Vector3D	get_coordinates () const
	Get the coordinates of the particle.

bool	get_coordinates_are_optimized () const

const kernel::ParticleIndexes &	get_member_particle_indexes () const
	Return the members as particle pointers. More...

RigidMembers	get_members () const

IMP::algebra::ReferenceFrame3D	get_reference_frame () const
	Get the reference frame for the local coordinates.

algebra::VectorD< 4 >	get_rotational_derivatives () const
	Get the derivatives of the quaternion.

algebra::Vector3D	get_torque () const

void	normalize_rotation ()
	Normalized the quaternion.

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

void	set_is_rigid_member (kernel::ParticleIndex pi, bool tf)

void	set_reference_frame (const IMP::algebra::ReferenceFrame3D &tr)
	Set the current reference frame. More...

void	set_reference_frame_from_members (const kernel::ParticleIndexes &members)

void	set_reference_frame_lazy (const IMP::algebra::ReferenceFrame3D &tr)
	Change the reference, delay updating the members until evaluate. More...

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

void	update_members ()
	Update the coordinates of the members.

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 KinematicNode	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 pi)
	Return true if the particle is a kinematic nodea (has the appropriate properties).

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

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

static KinematicNode	setup_particle (kernel::Model m, ParticleIndex pi, KinematicForest owner)

static KinematicNode	setup_particle (IMP::kernel::ParticleAdaptor decorator, KinematicForest *owner)

static KinematicNode	setup_particle (kernel::Model m, ParticleIndex pi, KinematicForest owner, Joint *in_joint)

static KinematicNode	setup_particle (IMP::kernel::ParticleAdaptor decorator, KinematicForest owner, Joint in_joint)

static KinematicNode	setup_particle (IMP::kernel::ParticleAdaptor decorator, KinematicForest owner, Joint in_joint, Joints out_joints)

static KinematicNode	setup_particle (kernel::Model m, ParticleIndex pi, KinematicForest owner, Joint *in_joint, Joints out_joints)

Static Public Member Functions inherited from IMP::core::RigidBody
static RigidBody	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 pi)

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

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

static RigidBody	setup_particle (kernel::Model *m, ParticleIndex pi, kernel::ParticleIndexesAdaptor ps)

static RigidBody	setup_particle (IMP::kernel::ParticleAdaptor decorator, kernel::ParticleIndexesAdaptor ps)

static RigidBody	setup_particle (IMP::kernel::ParticleAdaptor decorator, algebra::ReferenceFrame3D rf)

static RigidBody	setup_particle (kernel::Model *m, ParticleIndex pi, algebra::ReferenceFrame3D rf)

static void	teardown_particle (RigidBody rb)
	Make the rigid body no longer rigid.

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

A KinematicNode is a rigid body that is connected by a joint to other rigid bodies

Definition at line 29 of file KinematicNode.h.

Member Function Documentation

static KinematicNode IMP::kinematics::KinematicNode::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 38 of file KinematicNode.h.

static bool IMP::kinematics::KinematicNode::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 38 of file KinematicNode.h.

static bool IMP::kinematics::KinematicNode::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 38 of file KinematicNode.h.

static KinematicNode IMP::kinematics::KinematicNode::setup_particle	(	kernel::Model *	m,
		ParticleIndex	pi,
		KinematicForest *	owner
	)

static

Setup the particle so it can be used with this decorator.

Definition at line 39 of file KinematicNode.h.

static KinematicNode IMP::kinematics::KinematicNode::setup_particle	(	kernel::Model *	m,
		ParticleIndex	pi,
		KinematicForest *	owner,
		Joint *	in_joint
	)

static

Setup the particle so it can be used with this decorator.

Definition at line 41 of file KinematicNode.h.

static KinematicNode IMP::kinematics::KinematicNode::setup_particle	(	kernel::Model *	m,
		ParticleIndex	pi,
		KinematicForest *	owner,
		Joint *	in_joint,
		Joints	out_joints
	)

static

Setup the particle so it can be used with this decorator.

Definition at line 43 of file KinematicNode.h.

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

KinematicNode.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation