Static Public Member Functions

OpenTissue::skeleton::BoneAccess Class Reference

#include <skeleton_bone_access.h>

List of all members.

Static Public Member Functions

template<typename bone_type >
static void set_name (bone_type *bone, std::string const &name)
template<typename bone_type >
static void set_number (bone_type *bone, size_t const &number)
template<typename bone_type >
static void set_parent (bone_type *bone, bone_type *parent)
template<typename bone_type , typename skeleton_type >
static void set_skeleton (bone_type *bone, skeleton_type *skeleton)
template<typename bone_type >
static void add_child (bone_type *bone, bone_type *child)
template<typename bone_type >
static bone_typeget_first_child_ptr (bone_type const *bone)

Detailed Description

Bone Access Class. The purpose of this class is for others to obtain direct access to private and protected members of the bone class.

It is a back-door into the Bone class and should be used with care.


Member Function Documentation

template<typename bone_type >
static void OpenTissue::skeleton::BoneAccess::add_child ( bone_type bone,
bone_type child 
) [inline, static]

Add a child to a bone.

Parameters:
bone A pointer to the bone.
child The child that should be added to the bone.
template<typename bone_type >
static bone_type* OpenTissue::skeleton::BoneAccess::get_first_child_ptr ( bone_type const *  bone  )  [inline, static]

Get a pointer to the first child of the bone.

Parameters:
bone A pointer to the bone.
Returns:
A pointer to the first child bone or null if none exist.
template<typename bone_type >
static void OpenTissue::skeleton::BoneAccess::set_name ( bone_type bone,
std::string const &  name 
) [inline, static]

Set bone name.

Parameters:
bone A pointer to the bone.
name The new name of the bone.
template<typename bone_type >
static void OpenTissue::skeleton::BoneAccess::set_number ( bone_type bone,
size_t const &  number 
) [inline, static]

Set bone number.

Parameters:
bone A pointer to the bone.
number The new number of the bone.
template<typename bone_type >
static void OpenTissue::skeleton::BoneAccess::set_parent ( bone_type bone,
bone_type parent 
) [inline, static]

Set bone parent.

Parameters:
bone A pointer to the bone.
parent A pointer to the parent of the bone.
template<typename bone_type , typename skeleton_type >
static void OpenTissue::skeleton::BoneAccess::set_skeleton ( bone_type bone,
skeleton_type skeleton 
) [inline, static]

Set skeleton.

Parameters:
bone A pointer to the bone.
skeleton A pointer to the skeleton that the bone belongs to.

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