ShadowHandUtilityLibrary
Public Member Functions | Public Attributes | List of all members
shadow_hand::Hand Class Reference

Utility functions for managing groups of fingers of Shadow Hand. Constructs "Hand" class of shared pointers to multiple fingers, once multiple finger instances have been created. More...

#include "include/shadowlibs/shadow_hand.hpp"

Public Member Functions

 Hand (std::initializer_list< std::shared_ptr< shadow_finger::Finger >> fingers_list)
 Constructor for Hand class, takes in arbitrary number of shared pointers to Fingers. More...
 
void addFinger (const std::shared_ptr< shadow_finger::Finger > &finger)
 Add Finger to Hand. More...
 
int numFingers ()
 Get number of Fingers in hand. More...
 
std::vector< std::shared_ptr< shadow_finger::Finger > > getFingers ()
 Return all instances of Fingers in Hand as vector. More...
 

Public Attributes

std::vector< std::shared_ptr< shadow_finger::Finger > > _fingerVec
 Vector of the shared pointers to the fingers that we want to control Shared pointers because you cannot make a Hand without having created Fingers. More...
 

Detailed Description

Utility functions for managing groups of fingers of Shadow Hand. Constructs "Hand" class of shared pointers to multiple fingers, once multiple finger instances have been created.

Constructor & Destructor Documentation

shadow_hand::Hand::Hand ( std::initializer_list< std::shared_ptr< shadow_finger::Finger >>  fingers_list)
inline

Constructor for Hand class, takes in arbitrary number of shared pointers to Fingers.

Parameters
fingers_listList of shared pointers to Fingers

Member Function Documentation

void shadow_hand::Hand::addFinger ( const std::shared_ptr< shadow_finger::Finger > &  finger)
inline

Add Finger to Hand.

Parameters
fingerShared pointer to shadow_finger::Finger
std::vector<std::shared_ptr<shadow_finger::Finger> > shadow_hand::Hand::getFingers ( )
inline

Return all instances of Fingers in Hand as vector.

Returns
Vector of shared pointers to fingers
int shadow_hand::Hand::numFingers ( )
inline

Get number of Fingers in hand.

Returns
Integer size of _fingerVec

Member Data Documentation

std::vector<std::shared_ptr<shadow_finger::Finger> > shadow_hand::Hand::_fingerVec

Vector of the shared pointers to the fingers that we want to control Shared pointers because you cannot make a Hand without having created Fingers.


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