cnoid::BodyMotionItem Class Reference

#include <BodyMotionItem.h>

Inheritance diagram for cnoid::BodyMotionItem:

Public Member Functions
	BodyMotionItem ()
	BodyMotionItem (std::shared_ptr< BodyMotion > bodyMotion)
	BodyMotionItem (const BodyMotionItem &org)
	~BodyMotionItem ()
virtual std::shared_ptr< AbstractSeq >	abstractSeq () override
std::shared_ptr< BodyMotion >	motion ()
std::shared_ptr< const BodyMotion >	motion () const
MultiValueSeqItem *	jointPosSeqItem ()
const MultiValueSeqItem *	jointPosSeqItem () const
std::shared_ptr< MultiValueSeq >	jointPosSeq ()
MultiSE3SeqItem *	linkPosSeqItem ()
const MultiSE3SeqItem *	linkPosSeqItem () const
std::shared_ptr< MultiSE3Seq >	linkPosSeq ()
int	numExtraSeqItems () const
const std::string &	extraSeqKey (int index) const
AbstractSeqItem *	extraSeqItem (int index)
const AbstractSeqItem *	extraSeqItem (int index) const
SignalProxy< void()>	sigExtraSeqItemsChanged ()
void	updateExtraSeqItems ()
virtual void	notifyUpdate () override
Public Member Functions inherited from cnoid::AbstractSeqItem
	AbstractSeqItem ()
	AbstractSeqItem (const AbstractSeqItem &org)
virtual	~AbstractSeqItem ()
Public Member Functions inherited from cnoid::Item
virtual	~Item ()
Item &	operator= (const Item &rhs)=delete
int	classId () const
Item *	createNewInstance () const
void	assign (Item *srcItem)
	Copy item properties as much as possible like the assignment operator. More...
Item *	duplicate (Item *duplicatedParentItem=nullptr) const
Item *	duplicateSubTree () const
	This function creates a copy of the item including its descendant items. More...
Item *	duplicateAll () const
const std::string &	name () const
virtual bool	setName (const std::string &name)
virtual std::string	displayName () const
void	setDisplayNameModifier (std::function< std::string(const Item *item)> modifier)
SignalProxy< void(const std::string &oldName)>	sigNameChanged ()
void	notifyNameChange ()
	This function notifies the system of a displayName change. More...
void	setAttribute (Attribute attribute)
void	unsetAttribute (Attribute attribute)
bool	hasAttribute (Attribute attribute) const
bool	isSubItem () const
void	setSubItemAttributes ()
bool	isTemporal () const
void	setTemporal (bool on=true)
bool	isSelected () const
void	setSelected (bool on, bool isCurrent=false)
void	setSubTreeItemsSelected (bool on)
bool	isChecked (int checkId=PrimaryCheck) const
void	setChecked (bool on)
void	setChecked (int checkId, bool on)
int	numCheckStates () const
int	numChildren () const
int	countDescendantItems () const
Item *	childItem () const
Item *	prevItem () const
Item *	nextItem () const
Item *	lastChildItem () const
Item *	parentItem () const
Item *	headItem () const
RootItem *	findRootItem () const
bool	isConnectedToRoot () const
Item *	localRootItem () const
bool	addChildItem (Item *item, bool isManualOperation=false)
bool	insertChildItem (Item *item, Item *nextItem, bool isManualOperation=false)
bool	insertChild (Item *position, Item *item, bool isManualOperation=false)
bool	addSubItem (Item *item)
bool	insertSubItem (Item *item, Item *nextItem)
void	removeFromParentItem ()
void	detachFromParentItem ()
void	clearChildren ()
template<class ItemType >
ItemType *	find (const std::string &path="")
Item *	findItem (const std::string &path) const
template<class ItemType >
ItemType *	findItem (const std::string &path) const
template<class ItemType >
ItemType *	findItem (std::function< bool(ItemType *item)> pred=nullptr) const
Item *	findChildItem (const std::string &path, std::function< bool(Item *item)> pred=nullptr) const
template<class ItemType >
ItemType *	findChildItem (const std::string &path, std::function< bool(ItemType *item)> pred=nullptr) const
template<class ItemType >
ItemType *	findChildItem (std::function< bool(ItemType *item)> pred=nullptr) const
Item *	findSubItem (const std::string &path) const
template<class ItemType >
ItemType *	findSubItem (const std::string &path="") const
template<class ItemType >
ItemType *	findOwnerItem (bool includeSelf=false) const
bool	isOwnedBy (Item *item) const
ItemList	childItems (std::function< bool(Item *item)> pred=nullptr) const
template<class ItemType >
ItemList< ItemType >	childItems (std::function< bool(ItemType *item)> pred=nullptr) const
ItemList	descendantItems (std::function< bool(Item *item)> pred=nullptr) const
template<class ItemType >
ItemList< ItemType >	descendantItems (std::function< bool(ItemType *item)> pred=nullptr) const
ItemList	selectedDescendantItems (std::function< bool(Item *item)> pred=nullptr) const
template<class ItemType >
ItemList< ItemType >	selectedDescendantItems (std::function< bool(Item *item)> pred=nullptr) const
bool	traverse (std::function< bool(Item *)> pred)
template<class ItemType >
bool	traverse (std::function< bool(ItemType *item)> pred=nullptr)
SignalProxy< void()>	sigTreePathChanged ()
SignalProxy< void()>	sigTreePositionChanged ()
SignalProxy< void(Item *topItem, Item *prevTopParentItem)>	sigTreePositionChanged2 ()
SignalProxy< void()>	sigPositionChanged ()
SignalProxy< void()>	sigSubTreeChanged ()
SignalProxy< void()>	sigDisconnectedFromRoot ()
SignalProxy< void()>	sigDetachedFromRoot ()
SignalProxy< void(bool on)>	sigSelectionChanged ()
SignalProxy< void(int checkId, bool on)>	sigAnyCheckToggled ()
SignalProxy< void(bool on)>	sigCheckToggled (int checkId=PrimaryCheck)
SignalProxy< void()>	sigUpdated ()
bool	setAddon (ItemAddon *addon)
void	removeAddon (ItemAddon *addon)
template<class AddonType >
AddonType *	findAddon ()
template<class AddonType >
AddonType *	getAddon ()
std::vector< ItemAddon * >	addons ()
bool	load (const std::string &filename, const std::string &format=std::string(), const Mapping *options=nullptr)
bool	load (const std::string &filename, Item *parent, const std::string &format=std::string(), const Mapping *options=nullptr)
bool	save (const std::string &filename, const std::string &format=std::string(), const Mapping *options=nullptr)
bool	overwrite (bool forceOverwrite=false, const std::string &format=std::string())
const std::string &	filePath () const
	Full path file name. More...
std::string	fileName () const
	File name without the directory. More...
const std::string &	fileFormat () const
const Mapping *	fileOptions () const
std::time_t	fileModificationTime () const
bool	isConsistentWithFile () const
void	updateFileInformation (const std::string &filename, const std::string &format, Mapping *options=nullptr)
void	setConsistentWithFile (bool isConsistent)
void	suggestFileUpdate ()
void	clearFileInformation ()
	Use this function to disable the implicit overwrite next time. More...
bool	reload ()
bool	replace (Item *originalItem)
Item *	findOriginalItem () const
Item *	findReplacementItem () const
void	putProperties (PutPropertyFunction &putProperty)
Public Member Functions inherited from cnoid::Referenced
virtual	~Referenced ()

Static Public Member Functions
static void	initializeClass (ExtensionManager *ext)
static void	addExtraSeqItemFactory (const std::string &key, std::function< AbstractSeqItem *(std::shared_ptr< AbstractSeq > seq)> factory)
Static Public Member Functions inherited from cnoid::AbstractSeqItem
static void	initializeClass (ExtensionManager *ext)
Static Public Member Functions inherited from cnoid::Item
template<class ItemType >
static ItemPredicate	getItemPredicate ()
template<class ItemType >
static ItemPredicate	getItemPredicate (std::function< bool(ItemType *item)> pred)
static Item *	find (const std::string &path)

Protected Member Functions
virtual bool	onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation) override
virtual Item *	doDuplicate () const override
	Override this function to allow duplication of an instance. More...
virtual bool	store (Archive &archive) override
virtual bool	restore (const Archive &archive) override
Protected Member Functions inherited from cnoid::AbstractSeqItem
virtual void	doPutProperties (PutPropertyFunction &putProperty) override
Protected Member Functions inherited from cnoid::Item
	Item ()
	Item (const std::string &name)
	Item (const Item &item)
virtual void	doAssign (Item *srcItem)
	Implement the code to copy properties like the assingment operator. More...
virtual Item *	doDuplicate (Item *duplicatedParentItem) const
virtual bool	onNewTreePositionCheck (bool isManualOperation, std::function< void()> &out_callbackWhenAdded)
virtual void	onAddedToParent ()
virtual void	onTreePathChanged ()
virtual void	onTreePositionChanged ()
virtual void	onPositionChanged ()
virtual void	onConnectedToRoot ()
virtual void	onRemovedFromParent (Item *parentItem, bool isParentBeingDeleted)
virtual void	onDisconnectedFromRoot ()
Protected Member Functions inherited from cnoid::Referenced
	Referenced ()
	Referenced (const Referenced &)
int	refCount () const

Friends
class	BodyMotionItemImpl

Additional Inherited Members
Public Types inherited from cnoid::Item
enum	Attribute {   SubItem, Attached, Temporal, LoadOnly,   NumAttributes, SUB_ITEM = SubItem, TEMPORAL = Temporal, LOAD_ONLY = LoadOnly }
enum	CheckId { LogicalSumOfAllChecks = -1, PrimaryCheck = 0 }
typedef std::function< bool(Item *item)>	ItemPredicate

Constructor & Destructor Documentation

BodyMotionItem() [1/3]

BodyMotionItem::BodyMotionItem

(

)

BodyMotionItem() [2/3]

BodyMotionItem::BodyMotionItem

(

std::shared_ptr< BodyMotion >

bodyMotion

)

BodyMotionItem() [3/3]

BodyMotionItem::BodyMotionItem

(

const BodyMotionItem &

org

)

~BodyMotionItem()

BodyMotionItem::~BodyMotionItem

(

)

Member Function Documentation

abstractSeq()

std::shared_ptr< AbstractSeq > BodyMotionItem::abstractSeq ( )

overridevirtual

Implements cnoid::AbstractSeqItem.

addExtraSeqItemFactory()

void BodyMotionItem::addExtraSeqItemFactory ( const std::string &  key, std::function< AbstractSeqItem *(std::shared_ptr< AbstractSeq > seq)>  factory  )

static

doDuplicate()

Item * BodyMotionItem::doDuplicate ( ) const

overrideprotectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

extraSeqItem() [1/2]

AbstractSeqItem * BodyMotionItem::extraSeqItem

(

int

index

)

extraSeqItem() [2/2]

const AbstractSeqItem * BodyMotionItem::extraSeqItem

(

int

index

)

const

extraSeqKey()

const std::string & BodyMotionItem::extraSeqKey

(

int

index

)

const

initializeClass()

void BodyMotionItem::initializeClass ( ExtensionManager *  ext )

static

jointPosSeq()

std::shared_ptr<MultiValueSeq> cnoid::BodyMotionItem::jointPosSeq ( )

inline

jointPosSeqItem() [1/2]

MultiValueSeqItem* cnoid::BodyMotionItem::jointPosSeqItem ( )

inline

jointPosSeqItem() [2/2]

const MultiValueSeqItem* cnoid::BodyMotionItem::jointPosSeqItem ( ) const

inline

linkPosSeq()

std::shared_ptr<MultiSE3Seq> cnoid::BodyMotionItem::linkPosSeq ( )

inline

linkPosSeqItem() [1/2]

MultiSE3SeqItem* cnoid::BodyMotionItem::linkPosSeqItem ( )

inline

linkPosSeqItem() [2/2]

const MultiSE3SeqItem* cnoid::BodyMotionItem::linkPosSeqItem ( ) const

inline

motion() [1/2]

std::shared_ptr<BodyMotion> cnoid::BodyMotionItem::motion ( )

inline

motion() [2/2]

std::shared_ptr<const BodyMotion> cnoid::BodyMotionItem::motion ( ) const

inline

notifyUpdate()

void BodyMotionItem::notifyUpdate ( )

overridevirtual

Reimplemented from cnoid::Item.

numExtraSeqItems()

int BodyMotionItem::numExtraSeqItems

(

)

const

onChildItemAboutToBeAdded()

bool BodyMotionItem::onChildItemAboutToBeAdded ( Item *  childItem, bool  isManualOperation  )

overrideprotectedvirtual

This function is called when a child item is about to be added to this item. By overriding this function, you can check a child item and prevent the item from being added if necessary.

Returns

false if the item cannot be accepted as a child item

Note

The childItem is not actually connected to the item when this function is called.

Reimplemented from cnoid::Item.

restore()

bool BodyMotionItem::restore ( const Archive &  archive )

overrideprotectedvirtual

Reimplemented from cnoid::AbstractSeqItem.

sigExtraSeqItemsChanged()

SignalProxy< void()> BodyMotionItem::sigExtraSeqItemsChanged

(

)

store()

bool BodyMotionItem::store ( Archive &  archive )

overrideprotectedvirtual

Reimplemented from cnoid::AbstractSeqItem.

updateExtraSeqItems()

void BodyMotionItem::updateExtraSeqItems

(

)

Friends And Related Function Documentation

BodyMotionItemImpl

friend class BodyMotionItemImpl

friend

---

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

• BodyMotionItem.h
• BodyMotionItem.cpp