home
about
news
download
doc
source
systems
tests
bugs
contact
IMP Reference Guide
2.14.0
The Integrative Modeling Platform
IMP Manual
Reference Guide
Tutorial Index
Modules
Classes
Examples
include
IMP
core
version 2.14.0
Transform.h
Go to the documentation of this file.
1
/**
2
* \file IMP/core/Transform.h \brief Transform a particle
3
*
4
* Copyright 2007-2020 IMP Inventors. All rights reserved.
5
*
6
*/
7
8
#ifndef IMPCORE_TRANSFORM_H
9
#define IMPCORE_TRANSFORM_H
10
#include <IMP/core/core_config.h>
11
#include <
IMP/algebra/Transformation3D.h
>
12
#include <
IMP/SingletonModifier.h
>
13
#include <
IMP/singleton_macros.h
>
14
IMPCORE_BEGIN_NAMESPACE
15
16
//! Apply a transformation to a passed particle
17
/**
18
\see algebra::Transformation3D
19
*/
20
class
IMPCOREEXPORT
Transform
:
public
SingletonModifier
{
21
public
:
22
//! Initialize
23
/**
24
\param[in] t a 3d transformation to be applied on a particle
25
\param[in] ignore_non_xyz if false then applying the transformation
26
on a non XYZ particle will result in an exception.
27
*/
28
Transform
(
const
algebra::Transformation3D
&t,
bool
ignore_non_xyz =
false
);
29
30
virtual
void
apply_index
(
Model
*m,
ParticleIndex
p)
const
31
IMP_OVERRIDE
;
32
virtual
ModelObjectsTemp
do_get_inputs
(
33
Model
*m,
const
ParticleIndexes
&pis)
const
IMP_OVERRIDE
;
34
virtual
ModelObjectsTemp
do_get_outputs
(
35
Model
*m,
const
ParticleIndexes
&pis)
const
IMP_OVERRIDE
;
36
IMP_SINGLETON_MODIFIER_METHODS
(
Transform
);
37
IMP_OBJECT_METHODS
(
Transform
);
38
;
39
40
private
:
41
algebra::Transformation3D
t_;
42
bool
ignore_non_xyz_;
43
};
44
45
IMPCORE_END_NAMESPACE
46
#endif
/* IMPCORE_TRANSFORM_H */
IMP::SingletonModifier
A base class for modifiers of ParticlesTemp.
Definition:
SingletonModifier.h:32
SingletonModifier.h
A Modifier on ParticlesTemp.
IMP::algebra::Transformation3D
Simple 3D transformation class.
Definition:
Transformation3D.h:36
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition:
object_macros.h:25
IMP::Index< ParticleIndexTag >
singleton_macros.h
Macros for various classes.
IMP::ParticleOutputs::do_get_outputs
virtual ModelObjectsTemp do_get_outputs(Model *m, const ParticleIndexes &pis) const =0
Overload this method to specify the outputs.
IMP::Vector
A more IMP-like version of the std::vector.
Definition:
Vector.h:39
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition:
Model.h:72
IMP_SINGLETON_MODIFIER_METHODS
#define IMP_SINGLETON_MODIFIER_METHODS(Name)
Definition:
singleton_macros.h:93
IMP::ParticleInputs::do_get_inputs
virtual ModelObjectsTemp do_get_inputs(Model *m, const ParticleIndexes &pis) const =0
Overload this method to specify the inputs.
IMP::core::Transform
Apply a transformation to a passed particle.
Definition:
Transform.h:20
Transformation3D.h
Simple 3D transformation class.
IMP::SingletonModifier::apply_index
virtual void apply_index(Model *m, ParticleIndex v) const =0
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition:
compiler_macros.h:78