SurgSim::DataStructures::PlyReaderDelegate Class Referenceabstract

PlyReaderDelegate abstract class. More...

`#include <SurgSim/DataStructures/PlyReaderDelegate.h>`

Inheritance diagram for SurgSim::DataStructures::PlyReaderDelegate:

## 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

## ~PlyReaderDelegate()

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

inline virtual

Virtual destructor.

## Member Function Documentation

## fileIsAcceptable()

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< SegmentMeshShape >, SurgSim::DataStructures::TriangleMeshPlyReaderDelegate< Mesh >, SurgSim::Math::SegmentMeshShapePlyReaderDelegate, SurgSim::Physics::Fem1DPlyReaderDelegate, SurgSim::Physics::Fem2DPlyReaderDelegate, SurgSim::Physics::Fem3DPlyReaderDelegate, SurgSim::Physics::FemPlyReaderDelegate, and SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase.

## registerDelegate()

virtual bool SurgSim::DataStructures::PlyReaderDelegate::registerDelegate | ( | PlyReader * | reader | ) |

pure virtual

Registers the delegate with the reader.

Parameters

  [out] | reader | The 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< SegmentMeshShape >, SurgSim::DataStructures::TriangleMeshPlyReaderDelegate< Mesh >, SurgSim::Math::SegmentMeshShapePlyReaderDelegate, SurgSim::Physics::Fem1DPlyReaderDelegate, SurgSim::Physics::Fem2DPlyReaderDelegate, SurgSim::Physics::FemPlyReaderDelegate, and SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase.

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

- SurgSim/DataStructures/PlyReaderDelegate.h