VTK
vtkMoleculeMapper.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkMoleculeMapper.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 vtkMoleculeMapper_h
28 #define vtkMoleculeMapper_h
29 
30 #include "vtkDomainsChemistryModule.h" // For export macro
31 #include "vtkMapper.h"
32 #include "vtkNew.h" // For vtkNew
33 
34 class vtkActor;
35 class vtkGlyph3DMapper;
36 class vtkIdTypeArray;
37 class vtkMolecule;
38 class vtkPeriodicTable;
39 class vtkPolyData;
40 class vtkPolyDataMapper;
41 class vtkRenderer;
42 class vtkSelection;
43 class vtkSphereSource;
44 class vtkTrivialProducer;
45 
46 class VTKDOMAINSCHEMISTRY_EXPORT vtkMoleculeMapper : public vtkMapper
47 {
48 public:
49  static vtkMoleculeMapper *New();
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
54 
57  void SetInputData(vtkMolecule *in);
60 
72  void UseBallAndStickSettings();
73 
85  void UseVDWSpheresSettings();
86 
98  void UseLiquoriceStickSettings();
99 
114  void UseFastSettings();
115 
117 
120  vtkGetMacro(RenderAtoms, bool);
121  vtkSetMacro(RenderAtoms, bool);
122  vtkBooleanMacro(RenderAtoms, bool);
124 
126 
129  vtkGetMacro(RenderBonds, bool);
130  vtkSetMacro(RenderBonds, bool);
131  vtkBooleanMacro(RenderBonds, bool);
133 
135 
139  vtkGetMacro(RenderLattice, bool)
140  vtkSetMacro(RenderLattice, bool)
141  vtkBooleanMacro(RenderLattice, bool)
143 
144  enum {
145  CovalentRadius = 0,
148  CustomArrayRadius
149  };
150 
152 
157  vtkGetMacro(AtomicRadiusType, int);
158  vtkSetMacro(AtomicRadiusType, int);
159  const char * GetAtomicRadiusTypeAsString();
161  {
162  this->SetAtomicRadiusType(CovalentRadius);
163  }
165  {
166  this->SetAtomicRadiusType(VDWRadius);
167  }
169  {
170  this->SetAtomicRadiusType(UnitRadius);
171  }
173  {
174  this->SetAtomicRadiusType(CustomArrayRadius);
175  }
177 
179 
184  vtkGetMacro(AtomicRadiusScaleFactor, float);
185  vtkSetMacro(AtomicRadiusScaleFactor, float);
187 
189 
193  vtkGetMacro(UseMultiCylindersForBonds, bool);
194  vtkSetMacro(UseMultiCylindersForBonds, bool);
195  vtkBooleanMacro(UseMultiCylindersForBonds, bool);
197 
198  enum {
199  SingleColor = 0,
200  DiscreteByAtom
201  };
202 
204 
214  vtkGetMacro(BondColorMode, int);
215  vtkSetMacro(BondColorMode, int);
216  const char * GetBondColorModeAsString();
218  {
219  this->SetBondColorMode(SingleColor);
220  }
222  {
223  this->SetBondColorMode(DiscreteByAtom);
224  }
226 
228 
232  vtkGetVector3Macro(BondColor, unsigned char);
233  vtkSetVector3Macro(BondColor, unsigned char);
235 
237 
240  vtkGetMacro(BondRadius, float);
241  vtkSetMacro(BondRadius, float);
243 
245 
249  vtkGetVector3Macro(LatticeColor, unsigned char)
250  vtkSetVector3Macro(LatticeColor, unsigned char)
252 
254 
258  virtual void GetSelectedAtomsAndBonds(vtkSelection *selection,
259  vtkIdTypeArray *atomIds,
260  vtkIdTypeArray *bondIds);
261  virtual void GetSelectedAtoms(vtkSelection *selection,
262  vtkIdTypeArray *atomIds)
263  {
264  this->GetSelectedAtomsAndBonds(selection, atomIds, nullptr);
265  }
266  virtual void GetSelectedBonds(vtkSelection *selection,
267  vtkIdTypeArray *bondIds)
268  {
269  this->GetSelectedAtomsAndBonds(selection, nullptr, bondIds);
270  }
272 
274 
277  void Render(vtkRenderer *, vtkActor *) override;
278  void ReleaseGraphicsResources(vtkWindow *) override;
279  double * GetBounds() override;
280  void GetBounds(double bounds[6]) override { vtkAbstractMapper3D::GetBounds(bounds); }
281  int FillInputPortInformation(int port, vtkInformation* info) override;
282  bool GetSupportsSelection() override {return true;}
284 
286 
290  vtkGetStringMacro(AtomicRadiusArrayName);
291  vtkSetStringMacro(AtomicRadiusArrayName);
293 
294 protected:
296  ~vtkMoleculeMapper() override;
297 
299 
307 
309 
315  float BondRadius;
316  unsigned char BondColor[3];
318 
320 
324  void GlyphRender(vtkRenderer *ren, vtkActor *act);
325 
327 
335  virtual void UpdateGlyphPolyData();
336  virtual void UpdateAtomGlyphPolyData();
337  virtual void UpdateBondGlyphPolyData();
339 
341 
347 
348  unsigned char LatticeColor[3];
351  virtual void UpdateLatticePolyData();
352 
357 
358 private:
359  vtkMoleculeMapper(const vtkMoleculeMapper&) = delete;
360  void operator=(const vtkMoleculeMapper&) = delete;
361 };
362 
363 #endif
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:42
vtkMoleculeMapper::SetAtomicRadiusTypeToCovalentRadius
void SetAtomicRadiusTypeToCovalentRadius()
Definition: vtkMoleculeMapper.h:160
vtkMapper::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMoleculeMapper::RenderLattice
bool RenderLattice
Definition: vtkMoleculeMapper.h:319
vtkMoleculeMapper::GetSupportsSelection
bool GetSupportsSelection() override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition: vtkMoleculeMapper.h:282
vtkMoleculeMapper::SetBondColorModeToSingleColor
void SetBondColorModeToSingleColor()
Definition: vtkMoleculeMapper.h:217
vtkAbstractMapper3D::GetBounds
virtual double * GetBounds()=0
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
vtkMoleculeMapper::PeriodicTable
vtkNew< vtkPeriodicTable > PeriodicTable
Periodic table for lookups.
Definition: vtkMoleculeMapper.h:356
vtkAlgorithm::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
vtkMoleculeMapper::SetAtomicRadiusTypeToVDWRadius
void SetAtomicRadiusTypeToVDWRadius()
Definition: vtkMoleculeMapper.h:164
vtkMoleculeMapper::SetAtomicRadiusTypeToCustomArrayRadius
void SetAtomicRadiusTypeToCustomArrayRadius()
Definition: vtkMoleculeMapper.h:172
vtkMoleculeMapper::AtomicRadiusScaleFactor
float AtomicRadiusScaleFactor
Definition: vtkMoleculeMapper.h:304
vtkMoleculeMapper::GlyphDataInitialized
bool GlyphDataInitialized
Definition: vtkMoleculeMapper.h:334
vtkSelection
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:63
vtkMoleculeMapper::BondGlyphPolyData
vtkNew< vtkPolyData > BondGlyphPolyData
Definition: vtkMoleculeMapper.h:332
vtkMoleculeMapper::AtomicRadiusArrayName
char * AtomicRadiusArrayName
Definition: vtkMoleculeMapper.h:305
vtkMoleculeMapper::LatticePolyData
vtkNew< vtkPolyData > LatticePolyData
Definition: vtkMoleculeMapper.h:349
vtkTrivialProducer
Producer for stand-alone data objects.
Definition: vtkTrivialProducer.h:37
vtkMoleculeMapper::RenderAtoms
bool RenderAtoms
Customize atom rendering.
Definition: vtkMoleculeMapper.h:302
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkMoleculeMapper::UseMultiCylindersForBonds
bool UseMultiCylindersForBonds
Definition: vtkMoleculeMapper.h:314
vtkMoleculeMapper::GetSelectedBonds
virtual void GetSelectedBonds(vtkSelection *selection, vtkIdTypeArray *bondIds)
Definition: vtkMoleculeMapper.h:266
vtkMapper.h
vtkX3D::port
Definition: vtkX3D.h:447
vtkMapper::Render
virtual void Render(vtkRenderer *ren, vtkActor *a)=0
Method initiates the mapping process.
vtkMoleculeMapper::AtomGlyphPolyData
vtkNew< vtkPolyData > AtomGlyphPolyData
Cached variables and update methods.
Definition: vtkMoleculeMapper.h:330
vtkMoleculeMapper::LatticeMapper
vtkNew< vtkPolyDataMapper > LatticeMapper
Definition: vtkMoleculeMapper.h:350
vtkMoleculeMapper::AtomGlyphPointOutput
vtkNew< vtkTrivialProducer > AtomGlyphPointOutput
Definition: vtkMoleculeMapper.h:331
vtkSphereSource
create a polygonal sphere centered at the origin
Definition: vtkSphereSource.h:46
vtkMapper
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:86
vtkGlyph3DMapper
vtkGlyph3D on the GPU.
Definition: vtkGlyph3DMapper.h:42
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:51
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkMoleculeMapper::AtomicRadiusType
int AtomicRadiusType
Definition: vtkMoleculeMapper.h:303
vtkMoleculeMapper::SetAtomicRadiusTypeToUnitRadius
void SetAtomicRadiusTypeToUnitRadius()
Definition: vtkMoleculeMapper.h:168
vtkMoleculeMapper::BondRadius
float BondRadius
Definition: vtkMoleculeMapper.h:315
vtkNew< vtkPolyData >
vtkMapper::GetInput
vtkDataSet * GetInput()
Get the input as a vtkDataSet.
vtkMolecule
class describing a molecule
Definition: vtkMolecule.h:94
vtkMapper::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
Definition: vtkMapper.h:114
vtkPeriodicTable
Access to information about the elements.
Definition: vtkPeriodicTable.h:41
vtkMoleculeMapper
Mapper that draws vtkMolecule objects.
Definition: vtkMoleculeMapper.h:46
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkMapper::GetBounds
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
vtkMoleculeMapper::AtomGlyphMapper
vtkNew< vtkGlyph3DMapper > AtomGlyphMapper
Internal mappers.
Definition: vtkMoleculeMapper.h:344
vtkX3D::info
Definition: vtkX3D.h:376
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkMoleculeMapper::VDWRadius
Definition: vtkMoleculeMapper.h:146
vtkMoleculeMapper::GetSelectedAtoms
virtual void GetSelectedAtoms(vtkSelection *selection, vtkIdTypeArray *atomIds)
Definition: vtkMoleculeMapper.h:261
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:41
vtkMoleculeMapper::UnitRadius
Definition: vtkMoleculeMapper.h:147
vtkNew.h
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:63
vtkMoleculeMapper::SetBondColorModeToDiscreteByAtom
void SetBondColorModeToDiscreteByAtom()
Definition: vtkMoleculeMapper.h:221
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
vtkMoleculeMapper::BondGlyphPointOutput
vtkNew< vtkTrivialProducer > BondGlyphPointOutput
Definition: vtkMoleculeMapper.h:333
vtkMoleculeMapper::GetBounds
void GetBounds(double bounds[6]) override
Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Definition: vtkMoleculeMapper.h:280
vtkMoleculeMapper::BondColorMode
int BondColorMode
Definition: vtkMoleculeMapper.h:313
vtkMoleculeMapper::RenderBonds
bool RenderBonds
Customize bond rendering.
Definition: vtkMoleculeMapper.h:312
vtkMoleculeMapper::BondGlyphMapper
vtkNew< vtkGlyph3DMapper > BondGlyphMapper
Definition: vtkMoleculeMapper.h:345