Public Member Functions | Private Member Functions | Private Attributes | List of all members
SurgSim::Physics::FixedRepresentationLocalization Class Reference

This class implement the localization on a FixedRepresentation, as a local position. More...

#include <SurgSim/Physics/FixedRepresentationLocalization.h>

Inheritance diagram for SurgSim::Physics::FixedRepresentationLocalization:
SurgSim::Physics::Localization

Public Member Functions

 FixedRepresentationLocalization ()
 Default constructor. More...
 
 FixedRepresentationLocalization (std::shared_ptr< Representation > representation)
 Constructor. More...
 
virtual ~FixedRepresentationLocalization ()
 Destructor. More...
 
void setLocalPosition (const SurgSim::Math::Vector3d &p)
 Sets the local position. More...
 
const SurgSim::Math::Vector3dgetLocalPosition () const
 Gets the local position. More...
 
- Public Member Functions inherited from SurgSim::Physics::Localization
 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

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

Private Attributes

SurgSim::Math::Vector3d m_position
 3D position in local coordinates More...
 

Detailed Description

This class implement the localization on a FixedRepresentation, as a local position.

Constructor & Destructor Documentation

SurgSim::Physics::FixedRepresentationLocalization::FixedRepresentationLocalization ( )
inline

Default constructor.

SurgSim::Physics::FixedRepresentationLocalization::FixedRepresentationLocalization ( std::shared_ptr< Representation representation)
inlineexplicit

Constructor.

Parameters
representationThe representation to assign to this localization
virtual SurgSim::Physics::FixedRepresentationLocalization::~FixedRepresentationLocalization ( )
inlinevirtual

Destructor.

Member Function Documentation

SurgSim::Math::Vector3d SurgSim::Physics::FixedRepresentationLocalization::doCalculatePosition ( double  time)
inlineprivatevirtual

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

Implements SurgSim::Physics::Localization.

const SurgSim::Math::Vector3d& SurgSim::Physics::FixedRepresentationLocalization::getLocalPosition ( ) const
inline

Gets the local position.

Returns
The local position set for this localization
void SurgSim::Physics::FixedRepresentationLocalization::setLocalPosition ( const SurgSim::Math::Vector3d p)
inline

Sets the local position.

Parameters
pThe local position to set the localization at

Member Data Documentation

SurgSim::Math::Vector3d SurgSim::Physics::FixedRepresentationLocalization::m_position
private

3D position in local coordinates


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