Choreonoid  1.8
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
cnoid::BodyElementOverwriteItem Class Reference

#include <BodyElementOverwriteItem.h>

Inheritance diagram for cnoid::BodyElementOverwriteItem:
cnoid::Item cnoid::Referenced cnoid::DeviceOverwriteItem cnoid::LinkShapeOverwriteItem

Public Member Functions

BodyItembodyItem ()
BodyOverwriteAddonbodyOverwrite ()
- Public Member Functions inherited from cnoid::Item
virtual ~Item ()
Itemoperator= (const Item &rhs)=delete
int classId () const
ItemcreateNewInstance () const
void assign (Item *srcItem)
 Copy item properties as much as possible like the assignment operator. More...
Itemduplicate (Item *duplicatedParentItem=nullptr) const
ItemduplicateSubTree () const
 This function creates a copy of the item including its descendant items. More...
ItemduplicateAll () 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
ItemchildItem () const
ItemprevItem () const
ItemnextItem () const
ItemlastChildItem () const
ItemparentItem () const
ItemheadItem () const
RootItemfindRootItem () const
bool isConnectedToRoot () const
ItemlocalRootItem () 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="")
ItemfindItem (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
ItemfindChildItem (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
ItemfindSubItem (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)
virtual void notifyUpdate ()
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 MappingfileOptions () 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)
ItemfindOriginalItem () const
ItemfindReplacementItem () const
void putProperties (PutPropertyFunction &putProperty)
virtual bool store (Archive &archive)
virtual bool restore (const Archive &archive)
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()

Static Public Member Functions

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 Itemfind (const std::string &path)

Protected Member Functions

 BodyElementOverwriteItem ()
 BodyElementOverwriteItem (const BodyElementOverwriteItem &org)
void setBodyItem (BodyItem *item)
BodyItemnewBodyItem ()
 The next candidate of the target BodyItem when the item position is updated. More...
virtual bool onNewTreePositionCheck (bool isManualOperation, std::function< void()> &out_callbackWhenAdded) override final
virtual void onTreePathChanged () override final
virtual bool onCheckNewOverwritePosition (bool isManualOperation)
virtual void onDisconnectedFromBodyItem ()
- 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 ItemdoDuplicate () const
 Override this function to allow duplication of an instance. More...
virtual ItemdoDuplicate (Item *duplicatedParentItem) const
virtual void onAddedToParent ()
virtual void onTreePositionChanged ()
virtual void onPositionChanged ()
virtual void onConnectedToRoot ()
virtual void onRemovedFromParent (Item *parentItem, bool isParentBeingDeleted)
virtual void onDisconnectedFromRoot ()
virtual bool onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)
virtual void doPutProperties (PutPropertyFunction &putProperty)
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 Referenced (const Referenced &)
int refCount () const

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

Detailed Description

All the items that inherit this class works with BodyItem and BodyOverwriteAddon

Constructor & Destructor Documentation

◆ BodyElementOverwriteItem() [1/2]

BodyElementOverwriteItem::BodyElementOverwriteItem ( )

◆ BodyElementOverwriteItem() [2/2]

BodyElementOverwriteItem::BodyElementOverwriteItem ( const BodyElementOverwriteItem org)

Member Function Documentation

◆ bodyItem()

BodyItem* cnoid::BodyElementOverwriteItem::bodyItem ( )

◆ bodyOverwrite()

BodyOverwriteAddon * BodyElementOverwriteItem::bodyOverwrite ( )

◆ initializeClass()

void BodyElementOverwriteItem::initializeClass ( ExtensionManager ext)

◆ newBodyItem()

BodyItem* cnoid::BodyElementOverwriteItem::newBodyItem ( )

The next candidate of the target BodyItem when the item position is updated.

◆ onCheckNewOverwritePosition()

bool BodyElementOverwriteItem::onCheckNewOverwritePosition ( bool  isManualOperation)

◆ onDisconnectedFromBodyItem()

void BodyElementOverwriteItem::onDisconnectedFromBodyItem ( )

◆ onNewTreePositionCheck()

bool BodyElementOverwriteItem::onNewTreePositionCheck ( bool  isManualOperation,
std::function< void()> &  out_callbackWhenAdded 

Reimplemented from cnoid::Item.

◆ onTreePathChanged()

void BodyElementOverwriteItem::onTreePathChanged ( )

This function is called at the same time as sigTreePathChanged. The order in which it is called precedes the signal. By overriding this function in a derived item class, you can implement the necessary processing when the path in the item tree is changed.

Reimplemented from cnoid::Item.

◆ setBodyItem()

void cnoid::BodyElementOverwriteItem::setBodyItem ( BodyItem item)

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