Choreonoid  1.8
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
cnoid::MprPosition Class Referenceabstract

#include <MprPosition.h>

Inheritance diagram for cnoid::MprPosition:
cnoid::ClonableReferenced cnoid::Referenced cnoid::MprFkPosition cnoid::MprIkPosition

Public Types

enum  PositionType { IK, FK }
 
enum  UpdateFlag { IdUpdate = 1 << 0, NoteUpdate = 1 << 1, PositionUpdate = 1 << 2, ObjectReplaced = 1 << 3 }
 

Public Member Functions

MprPositionoperator= (const MprPosition &rhs)=delete
 
MprPositionclone () const
 
const GeneralIdid () const
 
void setId (const GeneralId &id)
 
int positionType () const
 
bool isIK () const
 
bool isFK () const
 
MprIkPositionikPosition ()
 
MprFkPositionfkPosition ()
 
MprPositionListownerPositionList ()
 
virtual bool fetch (LinkKinematicsKit *kinematicsKit)=0
 
virtual bool apply (LinkKinematicsKit *kinematicsKit) const =0
 
const std::string & note () const
 
void setNote (const std::string &note)
 
virtual bool read (const Mapping &archive)
 
virtual bool write (Mapping &archive) const
 
SignalProxy< void(int flags)> sigUpdated ()
 
void notifyUpdate (int flags)
 
- Public Member Functions inherited from cnoid::ClonableReferenced
virtual ReferenceddoClone (CloneMap *cloneMap) const =0
 
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()
 

Static Public Attributes

static constexpr int MaxNumJoints = 8
 

Protected Member Functions

 MprPosition (PositionType type)
 
 MprPosition (PositionType type, const GeneralId &id)
 
 MprPosition (const MprPosition &org)
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &)
 
int refCount () const
 

Friends

class MprPositionList
 

Member Enumeration Documentation

◆ PositionType

Enumerator
IK 
FK 

◆ UpdateFlag

Enumerator
IdUpdate 
NoteUpdate 
PositionUpdate 
ObjectReplaced 

Constructor & Destructor Documentation

◆ MprPosition() [1/3]

MprPosition::MprPosition ( PositionType  type)
protected

◆ MprPosition() [2/3]

MprPosition::MprPosition ( PositionType  type,
const GeneralId id 
)
protected

◆ MprPosition() [3/3]

MprPosition::MprPosition ( const MprPosition org)
protected

Member Function Documentation

◆ apply()

virtual bool cnoid::MprPosition::apply ( LinkKinematicsKit kinematicsKit) const
pure virtual

◆ clone()

MprPosition* cnoid::MprPosition::clone ( ) const
inline

◆ fetch()

virtual bool cnoid::MprPosition::fetch ( LinkKinematicsKit kinematicsKit)
pure virtual

◆ fkPosition()

MprFkPosition * MprPosition::fkPosition ( )

◆ id()

const GeneralId& cnoid::MprPosition::id ( ) const
inline

◆ ikPosition()

MprIkPosition * MprPosition::ikPosition ( )

◆ isFK()

bool cnoid::MprPosition::isFK ( ) const
inline

◆ isIK()

bool cnoid::MprPosition::isIK ( ) const
inline

◆ note()

const std::string& cnoid::MprPosition::note ( ) const
inline

◆ notifyUpdate()

void MprPosition::notifyUpdate ( int  flags)

◆ operator=()

MprPosition& cnoid::MprPosition::operator= ( const MprPosition rhs)
delete

◆ ownerPositionList()

MprPositionList * MprPosition::ownerPositionList ( )

◆ positionType()

int cnoid::MprPosition::positionType ( ) const
inline

◆ read()

bool MprPosition::read ( const Mapping archive)
virtual

◆ setId()

void MprPosition::setId ( const GeneralId id)
Note
This function only works when the position is not belonging to any position list.

◆ setNote()

void cnoid::MprPosition::setNote ( const std::string &  note)
inline

◆ sigUpdated()

SignalProxy<void(int flags)> cnoid::MprPosition::sigUpdated ( )
inline

◆ write()

bool MprPosition::write ( Mapping archive) const
virtual

Friends And Related Function Documentation

◆ MprPositionList

friend class MprPositionList
friend

Member Data Documentation

◆ MaxNumJoints

constexpr int MprPosition::MaxNumJoints = 8
staticconstexpr

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