Detailed Description

A decorator for an angle between two directions.

Note: A Constraint is used to maintain the angle and propagate its derivatives to its Directions.

Definition at line 84 of file direction.h.

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

	DirectionAngle (const IMP::ParticleAdaptor &d)

void	add_to_angle_derivative (Float v, DerivativeAccumulator &d)
	Add to the derivative of the angle. More...

Float	get_angle () const
	Get angle. More...

Float	get_angle_derivative () const
	Get the derivative added to the angle. More...

Particle *	get_particle (unsigned int i) const
	Get ith direction particle. More...

Particle *	get_particle () const

ParticleIndex	get_particle_index (unsigned int i) const
	Get ith direction particle index. More...

ParticleIndex	get_particle_index () const

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...

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

Particle *	get_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

Particle *	operator-> () const

Static Public Member Functions
static FloatKey	get_angle_key ()
	Get key for angle attribute. More...

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

static bool	get_is_setup (Model *m, ParticleIndex pi)
	Check if particle is setup as an angle. More...

static ParticleIndexKey	get_particle_key (unsigned int i)
	Get key for ith direction particle. More...

static DirectionAngle	setup_particle (Model *m, ParticleIndex pi, ParticleIndexPair ds)

static DirectionAngle	setup_particle (IMP::ParticleAdaptor decorator, ParticleIndexPair ds)

static DirectionAngle	setup_particle (Model *m, ParticleIndex pi, ParticleIndexAdaptor d0, ParticleIndexAdaptor d1)

static DirectionAngle	setup_particle (IMP::ParticleAdaptor decorator, ParticleIndexAdaptor d0, ParticleIndexAdaptor d1)

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

	Decorator (ParticleAdaptor p)

Member Function Documentation

void IMP::core::DirectionAngle::add_to_angle_derivative	(	Float	v,
		DerivativeAccumulator &	d
	)

Add to the derivative of the angle.

Float IMP::core::DirectionAngle::get_angle ( ) const

Get angle.

Float IMP::core::DirectionAngle::get_angle_derivative ( ) const

Get the derivative added to the angle.

static FloatKey IMP::core::DirectionAngle::get_angle_key ( )

static

Get key for angle attribute.

static bool IMP::core::DirectionAngle::get_is_setup	(	Model *	m,
		ParticleIndex	pi
	)

static

Check if particle is setup as an angle.

Particle* IMP::core::DirectionAngle::get_particle ( unsigned int i ) const

Get ith direction particle.

ParticleIndex IMP::core::DirectionAngle::get_particle_index ( unsigned int i ) const

Get ith direction particle index.

static ParticleIndexKey IMP::core::DirectionAngle::get_particle_key ( unsigned int i )

static

Get key for ith direction particle.

static DirectionAngle IMP::core::DirectionAngle::setup_particle	(	Model *	m,
		ParticleIndex	pi,
		ParticleIndexPair	ds
	)

static

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

Definition at line 95 of file direction.h.

static DirectionAngle IMP::core::DirectionAngle::setup_particle	(	IMP::ParticleAdaptor	decorator,
		ParticleIndexPair	ds
	)

static

Definition at line 95 of file direction.h.

static DirectionAngle IMP::core::DirectionAngle::setup_particle	(	Model *	m,
		ParticleIndex	pi,
		ParticleIndexAdaptor	d0,
		ParticleIndexAdaptor	d1
	)

static

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

Definition at line 97 of file direction.h.

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