VTK  9.1.0
vtkMoleculeReaderBase.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkMoleculeReaderBase.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
27 #ifndef vtkMoleculeReaderBase_h
28 #define vtkMoleculeReaderBase_h
29 
30 #include "vtkIOChemistryModule.h" // For export macro
31 #include "vtkPolyDataAlgorithm.h"
32 
33 class vtkCellArray;
34 class vtkFloatArray;
35 class vtkDataArray;
36 class vtkIdTypeArray;
39 class vtkPoints;
40 class vtkStringArray;
41 class vtkMolecule;
42 class vtkPeriodicTable;
43 
44 class VTKIOCHEMISTRY_EXPORT vtkMoleculeReaderBase : public vtkPolyDataAlgorithm
45 {
46 public:
48  void PrintSelf(ostream& os, vtkIndent indent) override;
49 
52 
54 
57  vtkSetMacro(BScale, double);
58  vtkGetMacro(BScale, double);
60 
62 
65  vtkSetMacro(HBScale, double);
66  vtkGetMacro(HBScale, double);
68 
72  vtkGetMacro(NumberOfAtoms, vtkIdType);
73 
77  vtkGetMacro(NumberOfModels, unsigned int);
78 
79 protected:
82 
83  char* FileName;
84  double BScale;
85  double HBScale;
87  unsigned int NumberOfModels;
88 
91 
100  int ReadMolecule(FILE* fp, vtkPolyData* output);
101 
110  unsigned int MakeAtomType(const char* atomType);
111 
121  unsigned int MakeBonds(vtkPoints* points, vtkIdTypeArray* atomTypes, vtkCellArray* newBonds);
122 
137 
138  virtual void ReadSpecificMolecule(FILE* fp) = 0;
139 
140 private:
142  void operator=(const vtkMoleculeReaderBase&) = delete;
143 };
144 
145 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:143
vtkMoleculeReaderBase::vtkSetFilePathMacro
vtkSetFilePathMacro(FileName)
vtkMoleculeReaderBase::NumberOfModels
unsigned int NumberOfModels
Definition: vtkMoleculeReaderBase.h:87
vtkMoleculeReaderBase::IsHetatm
vtkSmartPointer< vtkUnsignedCharArray > IsHetatm
Definition: vtkMoleculeReaderBase.h:135
vtkMoleculeReaderBase::Model
vtkSmartPointer< vtkUnsignedIntArray > Model
Definition: vtkMoleculeReaderBase.h:136
vtkMoleculeReaderBase::MakeBonds
unsigned int MakeBonds(vtkPoints *points, vtkIdTypeArray *atomTypes, vtkCellArray *newBonds)
Creates molecular bonds (VTK cells) given atomic coordinates (VTK points) and atom types.
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkMoleculeReaderBase::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkFloatArray
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:145
vtkUnsignedIntArray
dynamic, self-adjusting array of unsigned int
Definition: vtkUnsignedIntArray.h:40
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:145
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:145
vtkSmartPointer< vtkMolecule >
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
vtkMoleculeReaderBase::Radii
vtkSmartPointer< vtkFloatArray > Radii
Definition: vtkMoleculeReaderBase.h:127
vtkMoleculeReaderBase
Read molecular data files.
Definition: vtkMoleculeReaderBase.h:45
vtkMoleculeReaderBase::ReadMolecule
int ReadMolecule(FILE *fp, vtkPolyData *output)
Reads a molecule from the passed file pointer and creates a vtkPolyData.
vtkMoleculeReaderBase::ReadSpecificMolecule
virtual void ReadSpecificMolecule(FILE *fp)=0
vtkMoleculeReaderBase::~vtkMoleculeReaderBase
~vtkMoleculeReaderBase() override
vtkMoleculeReaderBase::NumberOfAtoms
vtkIdType NumberOfAtoms
Definition: vtkMoleculeReaderBase.h:86
vtkPolyDataAlgorithm.h
vtkX3D::points
@ points
Definition: vtkX3D.h:452
vtkMoleculeReaderBase::FillOutputPortInformation
int FillOutputPortInformation(int, vtkInformation *) override
Fill the output port information objects for this algorithm.
vtkMoleculeReaderBase::AtomType
vtkSmartPointer< vtkIdTypeArray > AtomType
Definition: vtkMoleculeReaderBase.h:128
vtkMoleculeReaderBase::BScale
double BScale
Definition: vtkMoleculeReaderBase.h:84
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:290
vtkMoleculeReaderBase::HBScale
double HBScale
Definition: vtkMoleculeReaderBase.h:85
vtkMoleculeReaderBase::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkMoleculeReaderBase::Points
vtkSmartPointer< vtkPoints > Points
Definition: vtkMoleculeReaderBase.h:125
vtkNew< vtkPeriodicTable >
vtkMoleculeReaderBase::RGB
vtkSmartPointer< vtkUnsignedCharArray > RGB
Definition: vtkMoleculeReaderBase.h:126
vtkMoleculeReaderBase::SecondaryStructuresEnd
vtkSmartPointer< vtkUnsignedCharArray > SecondaryStructuresEnd
Definition: vtkMoleculeReaderBase.h:134
vtkMolecule
class describing a molecule
Definition: vtkMolecule.h:111
vtkMoleculeReaderBase::PeriodicTable
vtkNew< vtkPeriodicTable > PeriodicTable
Definition: vtkMoleculeReaderBase.h:123
vtkMoleculeReaderBase::SecondaryStructuresBegin
vtkSmartPointer< vtkUnsignedCharArray > SecondaryStructuresBegin
Definition: vtkMoleculeReaderBase.h:133
vtkPeriodicTable
Access to information about the elements.
Definition: vtkPeriodicTable.h:39
vtkMoleculeReaderBase::vtkGetFilePathMacro
vtkGetFilePathMacro(FileName)
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:183
vtkMoleculeReaderBase::MakeAtomType
unsigned int MakeAtomType(const char *atomType)
Given a string for the type (name) of an atom, returns a unique number for that atom.
vtkMoleculeReaderBase::Chain
vtkSmartPointer< vtkUnsignedCharArray > Chain
Definition: vtkMoleculeReaderBase.h:131
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:145
vtkMoleculeReaderBase::FileName
char * FileName
Definition: vtkMoleculeReaderBase.h:83
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:195
vtkMoleculeReaderBase::vtkMoleculeReaderBase
vtkMoleculeReaderBase()
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:146
vtkMoleculeReaderBase::SecondaryStructures
vtkSmartPointer< vtkUnsignedCharArray > SecondaryStructures
Definition: vtkMoleculeReaderBase.h:132
vtkMoleculeReaderBase::Residue
vtkSmartPointer< vtkIdTypeArray > Residue
Definition: vtkMoleculeReaderBase.h:130
vtkMoleculeReaderBase::Molecule
vtkSmartPointer< vtkMolecule > Molecule
Definition: vtkMoleculeReaderBase.h:124
vtkMoleculeReaderBase::AtomTypeStrings
vtkSmartPointer< vtkStringArray > AtomTypeStrings
Definition: vtkMoleculeReaderBase.h:129
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:151