Public Member Functions | List of all members
SurgSim::DataStructures::PlyReaderDelegate Class Referenceabstract

PlyReaderDelegate abstract class. More...

#include <SurgSim/DataStructures/PlyReaderDelegate.h>

Inheritance diagram for SurgSim::DataStructures::PlyReaderDelegate:
SurgSim::DataStructures::TriangleMeshPlyReaderDelegate< M > SurgSim::Physics::FemPlyReaderDelegate SurgSim::DataStructures::TriangleMeshPlyReaderDelegate< Mesh > SurgSim::Physics::Fem1DPlyReaderDelegate SurgSim::Physics::Fem2DPlyReaderDelegate SurgSim::Physics::Fem3DPlyReaderDelegate SurgSim::Graphics::MeshPlyReaderDelegate

Public Member Functions

virtual ~PlyReaderDelegate ()
 Virtual destructor. More...
 
virtual bool registerDelegate (PlyReader *reader)=0
 Registers the delegate with the reader. More...
 
virtual bool fileIsAcceptable (const PlyReader &reader)=0
 Check whether the file in the reader can be used with this delegate, this gives the delegate a chance to make sure that all the elements and properties that are required are available in the file encapsulated by the reader. More...
 

Detailed Description

PlyReaderDelegate abstract class.

The purpose of this class is to customize the parsing and contain the callback functions that are being used in the parsing process.

Constructor & Destructor Documentation

virtual SurgSim::DataStructures::PlyReaderDelegate::~PlyReaderDelegate ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

virtual bool SurgSim::DataStructures::PlyReaderDelegate::fileIsAcceptable ( const PlyReader reader)
pure virtual

Check whether the file in the reader can be used with this delegate, this gives the delegate a chance to make sure that all the elements and properties that are required are available in the file encapsulated by the reader.

Implemented in SurgSim::DataStructures::TriangleMeshPlyReaderDelegate< M >, SurgSim::DataStructures::TriangleMeshPlyReaderDelegate< Mesh >, SurgSim::Physics::FemPlyReaderDelegate, SurgSim::Physics::Fem1DPlyReaderDelegate, and SurgSim::Physics::Fem2DPlyReaderDelegate.

virtual bool SurgSim::DataStructures::PlyReaderDelegate::registerDelegate ( PlyReader reader)
pure virtual

Registers the delegate with the reader.

Parameters
[out]readerThe reader that should be used by the delegate.
Returns
true usually if the reader is valid and fileIsAcceptable() is true.

Implemented in SurgSim::DataStructures::TriangleMeshPlyReaderDelegate< M >, SurgSim::DataStructures::TriangleMeshPlyReaderDelegate< Mesh >, SurgSim::Physics::FemPlyReaderDelegate, SurgSim::Physics::Fem1DPlyReaderDelegate, and SurgSim::Physics::Fem2DPlyReaderDelegate.


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