All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SurgSim::Physics::Localization Class Referenceabstract

This class localize a point on a representation (representation specific) More...

#include <SurgSim/Physics/Localization.h>

Inheritance diagram for SurgSim::Physics::Localization:
Inheritance graph
[legend]

Public Member Functions

 Localization ()
 Default constructor. More...
 
 Localization (std::shared_ptr< Representation > representation)
 Constructor. More...
 
virtual ~Localization ()
 Destructor. More...
 
void setRepresentation (std::shared_ptr< Representation > representation)
 Sets the representation. More...
 
std::shared_ptr< RepresentationgetRepresentation () const
 Gets the representation. More...
 
SurgSim::Math::Vector3d calculatePosition (double time=1.0)
 Calculates the global position of this localization. More...
 
virtual bool isValidRepresentation (std::shared_ptr< Representation > representation)
 

Private Member Functions

virtual SurgSim::Math::Vector3d doCalculatePosition (double time)=0
 Calculates the global position of this localization. More...
 

Private Attributes

std::shared_ptr< Representationm_representation
 The representation on which the localization is defined. More...
 

Detailed Description

This class localize a point on a representation (representation specific)

Constructor & Destructor Documentation

Localization::Localization ( )

Default constructor.

Localization::Localization ( std::shared_ptr< Representation representation)
explicit

Constructor.

Parameters
representationThe representation on which the localization is defined
Localization::~Localization ( )
virtual

Destructor.

Member Function Documentation

SurgSim::Math::Vector3d SurgSim::Physics::Localization::calculatePosition ( double  time = 1.0)
inline

Calculates the global position of this localization.

Parameters
timeThe time in [0..1] at which the position should be calculated
Returns
The global position of the localization at the requested time
Note
time can useful when dealing with CCD
virtual SurgSim::Math::Vector3d SurgSim::Physics::Localization::doCalculatePosition ( double  time)
privatepure virtual

Calculates the global position of this localization.

Parameters
timeThe time in [0..1] at which the position should be calculated
Returns
The global position of the localization at the requested time
Note
time can useful when dealing with CCD

Implemented in SurgSim::Physics::FixedRepresentationLocalization, SurgSim::Physics::MassSpringRepresentationLocalization, SurgSim::Physics::RigidRepresentationLocalization, SurgSim::Physics::Fem3DRepresentationLocalization, SurgSim::Physics::Fem1DRepresentationLocalization, and SurgSim::Physics::Fem2DRepresentationLocalization.

std::shared_ptr<Representation> SurgSim::Physics::Localization::getRepresentation ( ) const
inline

Gets the representation.

Returns
The representation on which the localization is defined, nullptr if none has been defined
bool SurgSim::Physics::Localization::isValidRepresentation ( std::shared_ptr< Representation representation)
virtual
void SurgSim::Physics::Localization::setRepresentation ( std::shared_ptr< Representation representation)
inline

Sets the representation.

Parameters
representationThe representation on which the localization is defined

Member Data Documentation

std::shared_ptr<Representation> SurgSim::Physics::Localization::m_representation
private

The representation on which the localization is defined.


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