BALL::VIEW::AddSurfaceModel Class Reference
[Model Processors]

#include <BALL/VIEW/MODELS/surfaceModel.h>

Inheritance diagram for BALL::VIEW::AddSurfaceModel:

Public Member Functions
Constructors and Destructor

	AddSurfaceModel ()
	Default Constructor.
	AddSurfaceModel (const AddSurfaceModel &add_surface_model)
	Copy constructor.
virtual	~AddSurfaceModel ()
	Destructor.
virtual void	clear ()
virtual void	clearComposites ()
Accessors

SurfaceProcessor::SurfaceType	getType () const
	Return the surface type (SES/SAS).
void	setType (SurfaceProcessor::SurfaceType type)
	Set the surface type (SES/SAS).
Processor specific methods

virtual Processor::Result	operator() (Composite &composite)
debuggers and diagnostics

HashSet< Atom * >	atoms_
SurfaceProcessor::SurfaceType	type_
float	probe_radius_
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const
void	setProbeRadius (float radius)
float	getProbeRadius () const
virtual bool	createGeometricObjects ()

Detailed Description

AddSurfaceModel class. The class AddSurfaceModel is a model processor that creates a surface model of the given Composite object. A Mesh object is created and filled with the method SurfaceProcessor::getSurface. The surface can be either a solvent excluded surface (SES, default) or the solvent accesible surface (SAS). See SurfaceProcessor for details.

See also:: Mesh; SurfaceProcessor

Definition at line 34 of file surfaceModel.h.

Constructor & Destructor Documentation

BALL::VIEW::AddSurfaceModel::AddSurfaceModel ( )

Default Constructor.

BALL::VIEW::AddSurfaceModel::AddSurfaceModel ( const AddSurfaceModel & add_surface_model )

Copy constructor.

virtual BALL::VIEW::AddSurfaceModel::~AddSurfaceModel ( ) [virtual]

Destructor.

Member Function Documentation

virtual void BALL::VIEW::AddSurfaceModel::clear ( ) [virtual]

Explicit default initialization. Calls ModelProcessor::clear.

Reimplemented from BALL::VIEW::ModelProcessor.

virtual void BALL::VIEW::AddSurfaceModel::clearComposites ( ) [virtual]

Needed in derived classes, which store references to the Composite instances they worked on. Here only needed for a common interface and therefore empty.

Reimplemented from BALL::VIEW::ModelProcessor.

virtual bool BALL::VIEW::AddSurfaceModel::createGeometricObjects ( ) [virtual]

Method to create geometric objects. This method is called in Representation::update() after all operator() was called for all Composites. To be overloaded in derived classes

Reimplemented from BALL::VIEW::ModelProcessor.

virtual void BALL::VIEW::AddSurfaceModel::dump	(	std::ostream &	s = `std::cout`,
		Size	depth = `0`
	)			const `[virtual]`

Internal value dump. Dump the current state to the output ostream with a given dumping depth. Calls ModelProcessor::dump.

Parameters:

	s	output stream where to output the state
	depth	the dumping depth

Reimplemented from BALL::VIEW::ModelProcessor.

float BALL::VIEW::AddSurfaceModel::getProbeRadius ( ) const [inline]

Definition at line 106 of file surfaceModel.h.

SurfaceProcessor::SurfaceType BALL::VIEW::AddSurfaceModel::getType ( ) const [inline]

Return the surface type (SES/SAS).

Definition at line 69 of file surfaceModel.h.

virtual Processor::Result BALL::VIEW::AddSurfaceModel::operator() ( Composite & composite ) [virtual]

Operator method. This method stores all Composite objects. In the finish() method for all stored start composite a Mesh object will be created. The resulting Representation is named after the first processed Composite.

Parameters:

composite

the Composite object that will be processed