Developer Documentation
Loading...
Searching...
No Matches
SkeletonObjectData Class Reference

Data object attached to the skeleton. More...

#include <Type-Skeleton/ObjectTypes/Skeleton/SkeletonObjectData.hh>

Inheritance diagram for SkeletonObjectData:
PerObjectData

Public Member Functions

 SkeletonObjectData (const SkeletonObjectData &_copy)
 
PerObjectDatacopyPerObjectData ()
 Copy Function.
 
int skin (unsigned int _index)
 Get the skin with given index (0 <= _index < skinCount())
 
unsigned int skinCount ()
 Get the number of associated skins.
 
void addSkin (int _objectId)
 Add a skin to the skeleton.
 
void removeSkin (int _objectId)
 Remove a skin from the skeleton.
 
void clearSkins ()
 Remove all skins from the skeleton.
 
- Public Member Functions inherited from PerObjectData
 PerObjectData ()
 You have to provide your own constructor for your object.
 

Private Attributes

std::vector< int > skins_
 

Detailed Description

Data object attached to the skeleton.

It stores the object ids of skins attached to this skeleton

Definition at line 57 of file SkeletonObjectData.hh.

Constructor & Destructor Documentation

◆ SkeletonObjectData() [1/2]

SkeletonObjectData::SkeletonObjectData ( )
inline

Definition at line 60 of file SkeletonObjectData.hh.

◆ SkeletonObjectData() [2/2]

SkeletonObjectData::SkeletonObjectData ( const SkeletonObjectData _copy)
inline

Definition at line 63 of file SkeletonObjectData.hh.

◆ ~SkeletonObjectData()

SkeletonObjectData::~SkeletonObjectData ( )
inline

Definition at line 69 of file SkeletonObjectData.hh.

Member Function Documentation

◆ addSkin()

void SkeletonObjectData::addSkin ( int  _objectId)
inline

Add a skin to the skeleton.

Definition at line 98 of file SkeletonObjectData.hh.

◆ clearSkins()

void SkeletonObjectData::clearSkins ( )
inline

Remove all skins from the skeleton.

Definition at line 124 of file SkeletonObjectData.hh.

◆ copyPerObjectData()

PerObjectData * SkeletonObjectData::copyPerObjectData ( )
inlinevirtual

Copy Function.

You have to reimplement this function to allow the core to create a copies of your Object. By default it will return 0;

The function has to create a deep copy of the object, as it will also be used to create backups. If you use pointer inside your class, remember to not copy the pointer only but also the data!

Reimplemented from PerObjectData.

Definition at line 73 of file SkeletonObjectData.hh.

◆ removeSkin()

void SkeletonObjectData::removeSkin ( int  _objectId)
inline

Remove a skin from the skeleton.

Definition at line 110 of file SkeletonObjectData.hh.

◆ skin()

int SkeletonObjectData::skin ( unsigned int  _index)
inline

Get the skin with given index (0 <= _index < skinCount())

Definition at line 82 of file SkeletonObjectData.hh.

◆ skinCount()

unsigned int SkeletonObjectData::skinCount ( )
inline

Get the number of associated skins.

Definition at line 91 of file SkeletonObjectData.hh.

Member Data Documentation

◆ skins_

std::vector< int > SkeletonObjectData::skins_
private

Definition at line 130 of file SkeletonObjectData.hh.


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