IMP logo
IMP Reference Guide  develop.d247202c1c,2019/10/23
The Integrative Modeling Platform
IMP::core::Transform Class Reference

Apply a transformation to a passed particle. More...

#include <IMP/core/Transform.h>

+ Inheritance diagram for IMP::core::Transform:

Detailed Description

Apply a transformation to a passed particle.

See Also
algebra::Transformation3D

Definition at line 20 of file Transform.h.

Public Member Functions

 Transform (const algebra::Transformation3D &t, bool ignore_non_xyz=false)
 Initialize. More...
 
virtual void apply_index (Model *m, ParticleIndex p) const
 
virtual void apply_indexes (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound) const
 
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the inputs. More...
 
virtual ModelObjectsTemp do_get_outputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the outputs. More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::SingletonModifier
 SingletonModifier (std::string name="SingletonModifier %1%")
 
- Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects read when the given list of particles is used. More...
 
- Public Member Functions inherited from IMP::ParticleOutputs
ModelObjectsTemp get_outputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects changed when the given list of particles is used. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Additional Inherited Members

- Public Types inherited from IMP::SingletonModifier
typedef ParticleArgument
 
typedef ParticleIndex IndexArgument
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::core::Transform::Transform ( const algebra::Transformation3D t,
bool  ignore_non_xyz = false 
)

Initialize.

Parameters
[in]ta 3d transformation to be applied on a particle
[in]ignore_non_xyzif false then applying the transformation on a non XYZ particle will result in an exception.

Member Function Documentation

virtual void IMP::core::Transform::apply_index ( Model m,
ParticleIndex  v 
) const
virtual

Apply the function to a single value

Implements IMP::SingletonModifier.

virtual void IMP::core::Transform::apply_indexes ( Model m,
const ParticleIndexes o,
unsigned int  lower_bound,
unsigned int  upper_bound 
) const
virtual

Apply the function to a collection of ParticlesTemp If bounds are passed, only apply to ones between the upper and lower bounds.

Reimplemented from IMP::SingletonModifier.

Definition at line 36 of file Transform.h.

virtual ModelObjectsTemp IMP::core::Transform::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

virtual ModelObjectsTemp IMP::core::Transform::do_get_outputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the outputs.

Implements IMP::ParticleOutputs.

virtual ::IMP::VersionInfo IMP::core::Transform::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 37 of file Transform.h.


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