opensurgsim
Public Types | Public Member Functions | List of all members
MockSegmentMesh Class Reference

Triangle Mesh for testing using MockVertexData, MockEdgeData, and MockTriangleData. More...

Inheritance diagram for MockSegmentMesh:
SurgSim::DataStructures::SegmentMesh< MockVertexData, MockEdgeData > SurgSim::DataStructures::TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData > SurgSim::DataStructures::Vertices< MockVertexData > SurgSim::Framework::Asset SurgSim::Framework::Accessible SurgSim::Framework::FactoryBase< Asset >

Public Types

typedef SegmentMesh< MockVertexData, MockEdgeData >::VertexType VertexType
 Vertex type for convenience.
 
typedef SegmentMesh< MockVertexData, MockEdgeData >::EdgeType EdgeType
 Edge type for convenience.
 
typedef SegmentMesh< MockVertexData, MockEdgeData >::TriangleType TriangleType
 Triangle type for convenience.
 
- Public Types inherited from SurgSim::DataStructures::SegmentMesh< MockVertexData, MockEdgeData >
typedef TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyDataTriangleMeshType
 TriangleMesh type for convenience.
 
typedef TriangleMeshType::EdgeType EdgeType
 Edge type for convenience (Ids of the 2 vertices)
 
typedef TriangleMeshType::TriangleType TriangleType
 Triangle type for convenience (Ids of the 3 vertices)
 
- Public Types inherited from SurgSim::DataStructures::TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData >
typedef MeshElement< 2, MockEdgeDataEdgeType
 Edge type for convenience (Ids of the 2 vertices)
 
typedef MeshElement< 3, SegmentEmptyDataTriangleType
 Triangle type for convenience (Ids of the 3 vertices)
 
- Public Types inherited from SurgSim::DataStructures::Vertices< MockVertexData >
typedef Vertex< MockVertexDataVertexType
 Vertex type for convenience.
 
- Public Types inherited from SurgSim::Framework::Accessible
typedef std::function< boost::any(void)> GetterType
 
typedef std::function< void(boost::any)> SetterType
 
typedef std::function< YAML::Node(void)> EncoderType
 
typedef std::function< void(const YAML::Node *)> DecoderType
 
- Public Types inherited from SurgSim::Framework::FactoryBase< Asset >
typedef ObjectFactory< AssetFactoryType
 

Public Member Functions

 MockSegmentMesh ()
 Constructor. Start out with no vertices and 0 updates.
 
 SURGSIM_CLASSNAME (MockSegmentMesh)
 
virtual ~MockSegmentMesh ()
 Destructor.
 
size_t createVertex (const SurgSim::Math::Vector3d &position, const SurgSim::Math::Vector3d &normal)
 Create a new vertex in the mesh. More...
 
size_t createEdge (const std::array< size_t, 2 > &vertices)
 Create a new edge in the mesh. More...
 
const SurgSim::Math::Vector3dgetVertexNormal (size_t id) const
 Returns the normal of a vertex.
 
int getNumUpdates () const
 Returns the number of updates performed on the mesh.
 
- Public Member Functions inherited from SurgSim::DataStructures::SegmentMesh< MockVertexData, MockEdgeData >
 SegmentMesh ()
 Constructor. The mesh is initially empty (no vertices, no edges).
 
 SegmentMesh (const SegmentMesh< MockVertexData, MockEdgeData > &other)
 Copy constructor when the template data is the same type. More...
 
 SegmentMesh (const SegmentMesh< V, E > &other)
 Copy constructor when the template data is a different type. More...
 
 SegmentMesh (SegmentMesh &&other)
 Move Constructor. More...
 
virtual ~SegmentMesh ()
 Destructor.
 
SegmentMesh< MockVertexData, MockEdgeData > & operator= (const SegmentMesh< MockVertexData, MockEdgeData > &other)
 Copy Assignment. More...
 
SegmentMesh< MockVertexData, MockEdgeData > & operator= (SegmentMesh< MockVertexData, MockEdgeData > &&other)
 Move Assignment. More...
 
void createDefaultEdges ()
 Creates edges for all vertices in the mesh connecting all the points consecutively. More...
 
bool save (const std::string &fileName, bool asPhysics=true, double radius=0.0001, double massDensity=900, double poissonRatio=0.45, double youngsModulus=1.75e9)
 Save the current structure to a ply file. More...
 
size_t addTriangle (const TriangleType &triangle)
 
size_t getNumTriangles () const
 
const std::vector< TriangleType > & getTriangles () const
 
std::vector< TriangleType > & getTriangles ()
 
const TriangleTypegetTriangle (size_t id) const
 
TriangleTypegetTriangle (size_t id)
 
void removeTriangle (size_t id)
 
std::array< SurgSim::Math::Vector3d, 3 > getTrianglePositions (size_t id) const
 
void doClearTriangles () override
 Remove all triangles from the mesh.
 
- Public Member Functions inherited from SurgSim::DataStructures::TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData >
 TriangleMesh ()
 Constructor. The mesh is initially empty (no vertices, no edges, no triangles).
 
 TriangleMesh (const TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData > &other)
 Copy constructor when the template data is the same type. More...
 
 TriangleMesh (const TriangleMesh< V, E, T > &other)
 Copy constructor when the template data is a different type. More...
 
 TriangleMesh (TriangleMesh &&other)
 Move Constructor. More...
 
virtual ~TriangleMesh ()
 Destructor.
 
TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData > & operator= (const TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData > &other)
 Copy Assignment. More...
 
TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData > & operator= (TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData > &&other)
 Move Assignment. More...
 
std::string getClassName () const override
 Support serialization with a classname. More...
 
size_t addEdge (const EdgeType &edge)
 Adds an edge to the mesh. More...
 
size_t addTriangle (const TriangleType &triangle)
 Adds a triangle to the mesh. More...
 
size_t getNumEdges () const
 Get the number of edges. More...
 
size_t getNumTriangles () const
 Get the number of triangles. More...
 
const std::vector< EdgeType > & getEdges () const
 Retrieve all edges. More...
 
std::vector< EdgeType > & getEdges ()
 Retrieve all edges (non const version) More...
 
const std::vector< TriangleType > & getTriangles () const
 Retrieve all triangles. More...
 
std::vector< TriangleType > & getTriangles ()
 Retrieve all triangles (non const version) More...
 
const EdgeTypegetEdge (size_t id) const
 Retrieve a specific edge. More...
 
EdgeTypegetEdge (size_t id)
 Retrieve a specific edge (non const version) More...
 
std::array< SurgSim::Math::Vector3d, 2 > getEdgePositions (size_t id) const
 Returns an array of the edge's vertices' positions. More...
 
const TriangleTypegetTriangle (size_t id) const
 Retrieve a specific triangle. More...
 
TriangleTypegetTriangle (size_t id)
 Retrieve a specific triangle (non const version) More...
 
void removeTriangle (size_t id)
 Marks a triangle as invalid, the triangle cannot be accessed via getTriangle anymore. More...
 
std::array< SurgSim::Math::Vector3d, 3 > getTrianglePositions (size_t id) const
 Returns an array of the triangle's vertices' positions. More...
 
bool isValid () const
 Test if the TriangleMesh is valid (valid vertex Ids used in all MeshElements) More...
 
void save (const std::string &fileName)
 Save the triangle mesh in the ply format. More...
 
- Public Member Functions inherited from SurgSim::DataStructures::Vertices< MockVertexData >
 Vertices ()
 Constructor.
 
 Vertices (const Vertices< V > &other)
 Copy constructor when the template data is a different type In this case, no data will be copied. More...
 
Vertices< MockVertexData > & operator= (const Vertices< V > &other)
 Assignment when the template data is a different type In this case, no data will be copied. More...
 
virtual ~Vertices ()
 Destructor.
 
void clear ()
 Clear mesh to return to an empty state (no vertices).
 
bool update ()
 Performs any updates that are required when the vertices are modified. More...
 
size_t addVertex (const VertexType &vertex)
 Adds a vertex to the mesh. More...
 
size_t getNumVertices () const
 Returns the number of vertices in this mesh.
 
const VertexTypegetVertex (size_t id) const
 Returns the specified vertex.
 
VertexTypegetVertex (size_t id)
 Returns the specified vertex (non const version).
 
const std::vector< VertexType > & getVertices () const
 Returns a vector containing the position of each vertex.
 
std::vector< VertexType > & getVertices ()
 Returns a vector containing the position of each vertex (non const version).
 
void setVertexPosition (size_t id, const SurgSim::Math::Vector3d &position)
 Sets the position of a vertex. More...
 
const SurgSim::Math::Vector3dgetVertexPosition (size_t id) const
 Returns the position of a vertex. More...
 
void setVertexPositions (const std::vector< SurgSim::Math::Vector3d > &positions, bool doUpdate=true)
 Sets the position of each vertex. More...
 
void transform (const Math::RigidTransform3d &pose)
 Apply a rigid transform to each vertex. More...
 
bool operator== (const Vertices &mesh) const
 Compares the mesh with another one (equality) More...
 
bool operator!= (const Vertices &mesh) const
 Compares the mesh with another one (inequality) More...
 
- Public Member Functions inherited from SurgSim::Framework::Asset
 Asset ()
 Constructor.
 
 Asset (const Asset &rhs)
 Copy Constructor.
 
virtual ~Asset ()
 Destructor.
 
void load (const std::string &fileName, const SurgSim::Framework::ApplicationData &data)
 Load a file with given name using 'data' as look up path(s). More...
 
void load (const std::string &fileName)
 Overloaded function using SurgSim::Framework::Runtime::getApplicationData() as look up path(s). More...
 
std::string getFileName () const
 Return the name of file loaded by this class. More...
 
- Public Member Functions inherited from SurgSim::Framework::Accessible
 Accessible ()
 Default Constructor.
 
 ~Accessible ()
 Destructor.
 
template<class T >
getValue (const std::string &name) const
 Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...
 
boost::any getValue (const std::string &name) const
 Retrieves the value with the name by executing the getter if it is found. More...
 
template<class T >
bool getValue (const std::string &name, T *value) const
 Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...
 
void setValue (const std::string &name, const boost::any &value)
 Sets a value of a property that has setter. More...
 
bool isReadable (const std::string &name) const
 Check whether a property is readable. More...
 
bool isWriteable (const std::string &name) const
 Check whether a property is writable. More...
 
void setGetter (const std::string &name, GetterType func)
 Sets a getter for a given property. More...
 
void setSetter (const std::string &name, SetterType func)
 Sets a setter for a given property. More...
 
void setAccessors (const std::string &name, GetterType getter, SetterType setter)
 Sets the accessors getter and setter in one function. More...
 
void removeAccessors (const std::string &name)
 Removes all the accessors (getter and setter) for a given property. More...
 
void forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
 Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...
 
void setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
 Sets the functions used to convert data from and to a YAML::Node. More...
 
void setDecoder (const std::string &name, DecoderType decoder)
 Sets the functions used to convert data from a YAML::Node. More...
 
YAML::Node encode () const
 Encode this Accessible to a YAML::Node. More...
 
void decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
 Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...
 
std::vector< std::string > getProperties ()
 
template<>
boost::any getValue (const std::string &name) const
 

Additional Inherited Members

- Static Public Member Functions inherited from SurgSim::Framework::FactoryBase< Asset >
static FactoryTypegetFactory ()
 
- Protected Member Functions inherited from SurgSim::DataStructures::TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData >
std::string m_className
 
std::string m_className
 
std::string m_className
 
virtual void doClearEdges ()
 Remove all edges from the mesh.
 
virtual bool isEqual (const Vertices< MockVertexData > &mesh) const
 Internal comparison of meshes of the same type: returns true if equal, false if not equal. More...
 
bool doLoad (const std::string &fileName) override
 Derived classes will overwrite this method to do actual loading. More...
 
- Protected Member Functions inherited from SurgSim::DataStructures::Vertices< MockVertexData >
virtual void doClearVertices ()
 Remove all vertices from the mesh.
 
virtual bool isEqual (const Vertices &mesh) const
 Internal comparison of meshes of the same type: returns true if equal, false if not equal. More...
 
- Static Protected Attributes inherited from SurgSim::DataStructures::TriangleMesh< MockVertexData, MockEdgeData, SegmentEmptyData >
static std::string m_className
 

Detailed Description

Triangle Mesh for testing using MockVertexData, MockEdgeData, and MockTriangleData.

Member Function Documentation

§ createEdge()

size_t MockSegmentMesh::createEdge ( const std::array< size_t, 2 > &  vertices)
inline

Create a new edge in the mesh.

Parameters
verticesEdge vertices
Returns
Unique ID of vertex in the mesh

§ createVertex()

size_t MockSegmentMesh::createVertex ( const SurgSim::Math::Vector3d position,
const SurgSim::Math::Vector3d normal 
)
inline

Create a new vertex in the mesh.

Parameters
positionPosition of the vertex
normalNormal of the vertex
Returns
Unique ID of vertex in the mesh

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