Public Member Functions | Public Attributes | List of all members
SurgSim::DataStructures::IndexedLocalCoordinate Struct Reference

A generic (size_t index, Vector coordinate) pair. More...

#include <SurgSim/DataStructures/IndexedLocalCoordinate.h>

Public Member Functions

 IndexedLocalCoordinate ()
 Default constructor with no initialization. More...
 
 IndexedLocalCoordinate (size_t index, const SurgSim::Math::Vector &coordinate)
 Constructor with initialization. More...
 

Public Attributes

size_t index
 Numeric index to indicate the entity w.r.t which the barycentricCoordinate is defined. More...
 
SurgSim::Math::Vector coordinate
 Coordinates with respect to the entity identified by the index. More...
 

Detailed Description

A generic (size_t index, Vector coordinate) pair.

The coordinate is a dynamic size vector. E.g. This can be used to represent a barycentric coordinate within a simplex (identified by the index).

Constructor & Destructor Documentation

SurgSim::DataStructures::IndexedLocalCoordinate::IndexedLocalCoordinate ( )

Default constructor with no initialization.

SurgSim::DataStructures::IndexedLocalCoordinate::IndexedLocalCoordinate ( size_t  index,
const SurgSim::Math::Vector coordinate 
)

Constructor with initialization.

Parameters
indexNumeric index.
coordinateCoordinates with respect to the entity identified by the index.
Note
Constructor does not throw when given malformed parameters.

Member Data Documentation

SurgSim::Math::Vector SurgSim::DataStructures::IndexedLocalCoordinate::coordinate

Coordinates with respect to the entity identified by the index.

size_t SurgSim::DataStructures::IndexedLocalCoordinate::index

Numeric index to indicate the entity w.r.t which the barycentricCoordinate is defined.


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