SurgSim::Physics::Fem1DPlyReaderDelegate Class Reference

`#include <SurgSim/Physics/Fem1DPlyReaderDelegate.h>`

Inheritance diagram for SurgSim::Physics::Fem1DPlyReaderDelegate:

## Public Member Functions

| Fem1DPlyReaderDelegate ()
| Default constructor. More...
| Fem1DPlyReaderDelegate (std::shared_ptr< Fem1D > mesh)
| Constructor. More...
Public Member Functions inherited from SurgSim::Physics::FemPlyReaderDelegate
| FemPlyReaderDelegate ()
| Constructor. More...
Public Member Functions inherited from SurgSim::DataStructures::PlyReaderDelegate
virtual | ~PlyReaderDelegate ()
| Virtual destructor. More...

## Protected Member Functions

std::string | getElementName () const override
bool | registerDelegate (PlyReader *reader) override
| Registers the delegate with the reader. More...
bool | fileIsAcceptable (const PlyReader &reader) override
| 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...
void | endParseFile () override
| Callback for end of PlyReader::parseFile. More...
void | processVertex (const std::string &elementName) override
| Callback function to process one vertex. More...
void | processFemElement (const std::string &elementName) override
| Callback function to process one FemElement. More...
void * | beginRadius (const std::string &elementName, size_t radiusCount)
| Callback function, begin the processing of radius. More...
void | endRadius (const std::string &elementName)
| Callback function, end the processing of radius. More...
void | processBoundaryCondition (const std::string &elementName) override
| Callback function to process one boundary condition. More...
Protected Member Functions inherited from SurgSim::Physics::FemPlyReaderDelegate
bool | registerDelegate (SurgSim::DataStructures::PlyReader *reader) override
| Registers the delegate with the reader. More...
bool | fileIsAcceptable (const SurgSim::DataStructures::PlyReader &reader) override
| 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...
virtual void * | beginVertices (const std::string &elementName, size_t vertexCount)
| Callback function, begin the processing of vertices. More...
virtual void | endVertices (const std::string &elementName)
| Callback function to finalize processing of vertices. More...
void * | beginFemElements (const std::string &elementName, size_t elementCount)
| Callback function, begin the processing of FemElements. More...
void | endFemElements (const std::string &elementName)
| Callback function to finalize processing of FemElements. More...
void * | beginMaterials (const std::string &elementName, size_t materialCount)
| Callback function, begin the processing of materials. More...
void | endMaterials (const std::string &elementName)
| Callback function, end the processing of materials. More...
void * | beginBoundaryConditions (const std::string &elementName, size_t boundaryConditionCount)
| Callback function, begin the processing of boundary conditions. More...

## Private Attributes

double | m_radius
| Element's radius information. More...
bool | m_enableShear
| Element's shear information. More...
std::shared_ptr< Fem1D > | m_mesh
| Fem1D mesh asset to contain the ply file information. More...

## Additional Inherited Members

Protected Attributes inherited from SurgSim::Physics::FemPlyReaderDelegate
struct SurgSim::Physics::FemPlyReaderDelegate::Vertex6DData | m_vertexData
bool | m_hasBoundaryConditions
| Flag indicating if the associated file has boundary conditions. More...
unsigned int | m_boundaryConditionData
| Internal data to receive the "boundary_condition" element. More...
struct SurgSim::Physics::FemPlyReaderDelegate::MaterialData | m_materialData
bool | m_hasMaterial
bool | m_hasPerElementMaterial
struct SurgSim::Physics::FemPlyReaderDelegate::ElementData | m_elementData
bool | m_hasRotationDOF

## Constructor & Destructor Documentation

## Fem1DPlyReaderDelegate() [1/2]

SurgSim::Physics::Fem1DPlyReaderDelegate::Fem1DPlyReaderDelegate | ( |  | ) |

Default constructor.

## Fem1DPlyReaderDelegate() [2/2]

SurgSim::Physics::Fem1DPlyReaderDelegate::Fem1DPlyReaderDelegate | ( | std::shared_ptr< Fem1D > | mesh | ) |

explicit

Constructor.

Parameters

  mesh | The mesh to be used, it will be cleared by the constructor.

## Member Function Documentation

## beginRadius()

void * SurgSim::Physics::Fem1DPlyReaderDelegate::beginRadius | ( | const std::string & | elementName,
|  | size_t | radiusCount
| ) |  |

protected

Callback function, begin the processing of radius.

Parameters

  elementName | Name of the element.
  radiusCount | Number of radii.

Returns
  memory for radius data to the reader.

## endParseFile()

void SurgSim::Physics::Fem1DPlyReaderDelegate::endParseFile | ( |  | ) |

override protected virtual

Callback for end of PlyReader::parseFile.

Implements SurgSim::Physics::FemPlyReaderDelegate.

## endRadius()

void SurgSim::Physics::Fem1DPlyReaderDelegate::endRadius | ( | const std::string & | elementName | ) |

protected

Callback function, end the processing of radius.

Parameters

  elementName | Name of the element.

## fileIsAcceptable()

bool SurgSim::Physics::Fem1DPlyReaderDelegate::fileIsAcceptable | ( | const PlyReader & | reader | ) |

override protected 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.

Implements SurgSim::DataStructures::PlyReaderDelegate.

## getElementName()

std::string SurgSim::Physics::Fem1DPlyReaderDelegate::getElementName | ( |  | ) | const

override protected virtual

Implements SurgSim::Physics::FemPlyReaderDelegate.

## processBoundaryCondition()

void SurgSim::Physics::Fem1DPlyReaderDelegate::processBoundaryCondition | ( | const std::string & | elementName | ) |

override protected virtual

Callback function to process one boundary condition.

Parameters

  elementName | Name of the element.

Implements SurgSim::Physics::FemPlyReaderDelegate.

## processFemElement()

void SurgSim::Physics::Fem1DPlyReaderDelegate::processFemElement | ( | const std::string & | elementName | ) |

override protected virtual

Callback function to process one FemElement.

Parameters

  elementName | Name of the element.

Implements SurgSim::Physics::FemPlyReaderDelegate.

## processVertex()

void SurgSim::Physics::Fem1DPlyReaderDelegate::processVertex | ( | const std::string & | elementName | ) |

override protected virtual

Callback function to process one vertex.

Parameters

  elementName | Name of the element.

Implements SurgSim::Physics::FemPlyReaderDelegate.

## registerDelegate()

bool SurgSim::Physics::Fem1DPlyReaderDelegate::registerDelegate | ( | PlyReader * | reader | ) |

override protected 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.

Implements SurgSim::DataStructures::PlyReaderDelegate.

## Member Data Documentation

## m_enableShear

bool SurgSim::Physics::Fem1DPlyReaderDelegate::m_enableShear

private

Element's shear information.

## m_mesh

std::shared_ptr<Fem1D> SurgSim::Physics::Fem1DPlyReaderDelegate::m_mesh

private

Fem1D mesh asset to contain the ply file information.

## m_radius

double SurgSim::Physics::Fem1DPlyReaderDelegate::m_radius

private

Element's radius information.

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

- SurgSim/Physics/Fem1DPlyReaderDelegate.h
- SurgSim/Physics/Fem1DPlyReaderDelegate.cpp