cnoid::Item Class Reference

#include <Item.h>

Inheritance diagram for cnoid::Item:

Public Types
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

Public Member Functions
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 ()
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()>	sigPositionChanged ()
SignalProxy< void(Item *topItem, Item *prevTopParentItem)>	sigPositionChanged2 ()
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
std::string	fileName () const
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)
virtual bool	store (Archive &archive)
virtual bool	restore (const Archive &archive)
Public Member Functions inherited from cnoid::Referenced
virtual	~Referenced ()

Static Public Member Functions
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
	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 () const
	Override this function to allow duplication of an instance. More...
virtual Item *	doDuplicate (Item *duplicatedParentItem) const
virtual bool	onNewPositionCheck (bool isManualOperation, std::function< void()> &out_callbackWhenAdded)
virtual void	onAddedToParent ()
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

Member Typedef Documentation

ItemPredicate

typedef std::function<bool(Item* item)> cnoid::Item::ItemPredicate

Member Enumeration Documentation

Attribute

enum cnoid::Item::Attribute

Enumerator
SubItem
Attached
Temporal
LoadOnly
NumAttributes
SUB_ITEM
TEMPORAL
LOAD_ONLY

CheckId

enum cnoid::Item::CheckId

Note

LogicalSumOfAllChecks is only valid for "isChecked(LogicalSumOfAllChecks)" and the signal returned by "sigCheckToggled(LogicalSumOfAllChecks)".

Enumerator
LogicalSumOfAllChecks
PrimaryCheck

Constructor & Destructor Documentation

Item() [1/3]

Item::Item ( )

protected

Item() [2/3]

Item::Item ( const std::string &  name )

protected

Item() [3/3]

Item::Item ( const Item &  item )

protected

~Item()

Item::~Item ( )

virtual

Member Function Documentation

addChildItem()

bool Item::addChildItem	(	Item *	item,
		bool	isManualOperation = false
	)

addons()

std::vector< ItemAddon * > Item::addons

(

)

addSubItem()

bool Item::addSubItem

(

Item *

item

)

This function adds a sub item to the item. The sub item is an item that is a required element of the main item, and the sub item cannot be removed from the main item.

assign()

void Item::assign

(

Item *

srcItem

)

Copy item properties as much as possible like the assignment operator.

childItem()

Item* cnoid::Item::childItem ( ) const

inline

childItems() [1/2]

ItemList Item::childItems

(

std::function< bool(Item *item)>

pred = nullptr

)

const

childItems() [2/2]

template<class ItemType >

ItemList<ItemType> cnoid::Item::childItems ( std::function< bool(ItemType *item)>  pred = nullptr ) const

inline

classId()

int cnoid::Item::classId ( ) const

inline

clearChildren()

void Item::clearChildren

(

)

clearFileInformation()

void Item::clearFileInformation

(

)

Use this function to disable the implicit overwrite next time.

countDescendantItems()

int Item::countDescendantItems

(

)

const

createNewInstance()

Item * Item::createNewInstance

(

)

const

descendantItems() [1/2]

ItemList Item::descendantItems

(

std::function< bool(Item *item)>

pred = nullptr

)

const

descendantItems() [2/2]

template<class ItemType >

ItemList<ItemType> cnoid::Item::descendantItems ( std::function< bool(ItemType *item)>  pred = nullptr ) const

inline

detachFromParentItem()

void cnoid::Item::detachFromParentItem ( )

inline

displayName()

std::string Item::displayName ( ) const

virtual

Reimplemented in cnoid::CoordinateFrameItem.

doAssign()

void Item::doAssign ( Item *  srcItem )

protectedvirtual

Implement the code to copy properties like the assingment operator.

Reimplemented in cnoid::BodyItem.

doDuplicate() [1/2]

Item * Item::doDuplicate ( ) const

protectedvirtual

Override this function to allow duplication of an instance.

Reimplemented in cnoid::BodyItem, cnoid::MultiPointSetItem, cnoid::CoordinateFrameListItem, cnoid::PointSetItem, cnoid::RootItem, cnoid::AISTSimulatorItem, cnoid::BodyMotionItem, cnoid::PositionTagGroupItem, cnoid::MprProgramItemBase, cnoid::CoordinateFrameItem, cnoid::WorldItem, cnoid::WorldLogFileItem, cnoid::BodyTrackingCameraItem, cnoid::SceneItem, cnoid::BodyMarkerItem, cnoid::MultiSeqItem< MultiSeqType >, cnoid::PythonScriptItem, cnoid::PythonSimScriptItem, cnoid::Vector3SeqItem, cnoid::ReferencedObjectSeqItem, cnoid::SimpleControllerItem, cnoid::BodyMotionControllerItem, cnoid::IoConnectionMapItem, cnoid::MprMultiVariableListItem, cnoid::SubProjectItem, cnoid::MessageLogItem, cnoid::MultiDeviceStateSeqItem, cnoid::LightingItem, cnoid::BodyContactPointLoggerItem, cnoid::SensorVisualizerItem, cnoid::FolderItem, cnoid::LinkOffsetFrameListItem, cnoid::ControllerLogItem, cnoid::MaterialTableItem, cnoid::KinematicSimulatorItem, cnoid::AudioItem, cnoid::GLVisionSimulatorItem, cnoid::MediaItem, cnoid::CollisionSeqItem, cnoid::ZMPSeqItem, and cnoid::ExtCommandItem.

doDuplicate() [2/2]

Item * Item::doDuplicate ( Item *  duplicatedParentItem ) const

protectedvirtual

Use this overload if the duplication process needs to know the duplicated parent item.

Note

If this function is implemented and returns a valid dupulicated object, the overload doDuplicate function without an argument is not called.

The parentItem argument may be nullptr.

Reimplemented in cnoid::DeviceOverwriteItem, and cnoid::LinkShapeOverwriteItem.

doPutProperties()

void Item::doPutProperties ( PutPropertyFunction &  putProperty )

protectedvirtual

Override this function to put properties of the item.

Note

Please call doPutProperties() of the parent class in this function. For example, when your class directly inherits the Item class, call Item::doPutProperties(putProperty).

Reimplemented in cnoid::SimulatorItem, cnoid::BodyItem, cnoid::MultiPointSetItem, cnoid::DeviceOverwriteItem, cnoid::CoordinateFrameListItem, cnoid::MprControllerItemBase, cnoid::PointSetItem, cnoid::ControllerItem, cnoid::AISTSimulatorItem, cnoid::PositionTagGroupItem, cnoid::CoordinateFrameItem, cnoid::WorldLogFileItem, cnoid::WorldItem, cnoid::SceneItem, cnoid::BodyTrackingCameraItem, cnoid::MprProgramItemBase, cnoid::BodyMarkerItem, cnoid::LinkShapeOverwriteItem, cnoid::AbstractMultiSeqItem, cnoid::PythonScriptItem, cnoid::PythonSimScriptItem, cnoid::SimpleControllerItem, cnoid::BodyMotionControllerItem, cnoid::MprMultiVariableListItem, cnoid::SubProjectItem, cnoid::MessageLogItem, cnoid::LightingItem, cnoid::AbstractSeqItem, cnoid::KinematicSimulatorItem, cnoid::MaterialTableItem, cnoid::AudioItem, cnoid::GLVisionSimulatorItem, cnoid::SimulationScriptItem, cnoid::MediaItem, cnoid::ZMPSeqItem, cnoid::ExtCommandItem, and cnoid::SubSimulatorItem.

duplicate()

Item * Item::duplicate

(

Item *

duplicatedParentItem = nullptr

)

const

duplicateAll()

Item* cnoid::Item::duplicateAll ( ) const

inline

duplicateSubTree()

Item * Item::duplicateSubTree

(

)

const

This function creates a copy of the item including its descendant items.

fileFormat()

const std::string & Item::fileFormat

(

)

const

fileModificationTime()

std::time_t Item::fileModificationTime

(

)

const

fileName()

std::string Item::fileName

(

)

const

fileOptions()

const Mapping * Item::fileOptions

(

)

const

filePath()

const std::string & Item::filePath

(

)

const

find() [1/2]

static Item* cnoid::Item::find ( const std::string &  path )

inlinestatic

This is equivalent to RootItem::instance()->findItem(path);

find() [2/2]

template<class ItemType >

ItemType* cnoid::Item::find ( const std::string &  path = "" )

inline

findAddon()

template<class AddonType >

AddonType* cnoid::Item::findAddon ( )

inline

findChildItem() [1/3]

Item* cnoid::Item::findChildItem ( const std::string &  path, std::function< bool(Item *item)>  pred = nullptr  ) const

inline

Find an item that has the corresponding path from a child item to it

findChildItem() [2/3]

template<class ItemType >

ItemType* cnoid::Item::findChildItem ( const std::string &  path, std::function< bool(ItemType *item)>  pred = nullptr  ) const

inline

findChildItem() [3/3]

template<class ItemType >

ItemType* cnoid::Item::findChildItem ( std::function< bool(ItemType *item)>  pred = nullptr ) const

inline

findItem() [1/3]

Item* cnoid::Item::findItem ( const std::string &  path ) const

inline

Find an item that has the corresponding path to it in the sub tree

findItem() [2/3]

template<class ItemType >

ItemType* cnoid::Item::findItem ( const std::string &  path ) const

inline

findItem() [3/3]

template<class ItemType >

ItemType* cnoid::Item::findItem ( std::function< bool(ItemType *item)>  pred = nullptr ) const

inline

findOriginalItem()

Item * Item::findOriginalItem

(

)

const

findOwnerItem()

template<class ItemType >

ItemType* cnoid::Item::findOwnerItem ( bool  includeSelf = false ) const

inline

findReplacementItem()

Item * Item::findReplacementItem

(

)

const

findRootItem()

RootItem * Item::findRootItem

(

)

const

findSubItem() [1/2]

Item* cnoid::Item::findSubItem ( const std::string &  path ) const

inline

Find a sub item that has the corresponding path from a direct sub item to it

findSubItem() [2/2]

template<class ItemType >

ItemType* cnoid::Item::findSubItem ( const std::string &  path = "" ) const

inline

getAddon()

template<class AddonType >

AddonType* cnoid::Item::getAddon ( )

inline

getItemPredicate() [1/2]

template<class ItemType >

static ItemPredicate cnoid::Item::getItemPredicate ( )

inlinestatic

getItemPredicate() [2/2]

template<class ItemType >

static ItemPredicate cnoid::Item::getItemPredicate ( std::function< bool(ItemType *item)>  pred )

inlinestatic

hasAttribute()

bool Item::hasAttribute

(

Attribute

attribute

)

const

headItem()

Item * Item::headItem

(

)

const

Returns

When the item is embeded one, this function returs the first parent item which is not an embeded one. Otherwise the item itself is returned.

insertChild()

bool Item::insertChild	(	Item *	position,
		Item *	item,
		bool	isManualOperation = false
	)

insertChildItem()

bool Item::insertChildItem	(	Item *	item,
		Item *	nextItem,
		bool	isManualOperation = false
	)

insertSubItem()

bool Item::insertSubItem	(	Item *	item,
		Item *	nextItem
	)

isChecked()

bool Item::isChecked

(

int

checkId = PrimaryCheck

)

const

isConnectedToRoot()

bool Item::isConnectedToRoot

(

)

const

isConsistentWithFile()

bool Item::isConsistentWithFile

(

)

const

isOwnedBy()

bool Item::isOwnedBy

(

Item *

item

)

const

isSelected()

bool cnoid::Item::isSelected ( ) const

inline

isSubItem()

bool Item::isSubItem

(

)

const

isTemporal()

bool Item::isTemporal

(

)

const

If this is true, the item is not automatically saved or overwritten when a project is saved. For example, a motion item which is produced as a simulation result may be an temporal item because a user may not want to save the result. If a user manually save the item, the item becomes a non-temporal item. Or if a child item is manually attached to a temporal item, the item becomes non-temporal one, too.

lastChildItem()

Item* cnoid::Item::lastChildItem ( ) const

inline

load() [1/2]

bool Item::load	(	const std::string &	filename,
		const std::string &	format = std::string(),
		const Mapping *	options = nullptr
	)

This function loads the data of the item from a file by using a pre-registered loading function.

To make this function available, a loading function has to be registered to an ItemManager in advance by calling the addLoader() or addLoaderAndSaver() function. Otherwise, this function cannot be used. Note that this function should not be overloaded or overridden in the derived classes.

load() [2/2]

bool Item::load	(	const std::string &	filename,
		Item *	parent,
		const std::string &	format = std::string(),
		const Mapping *	options = nullptr
	)

Parameters

parent

specify this when the item is newly created one and will be attached to a parent item if loading succeeds.

localRootItem()

Item * Item::localRootItem

(

)

const

name()

const std::string& cnoid::Item::name ( ) const

inline

nextItem()

Item* cnoid::Item::nextItem ( ) const

inline

notifyNameChange()

void Item::notifyNameChange

(

)

notifyUpdate()

void Item::notifyUpdate ( )

virtual

Reimplemented in cnoid::BodyMotionItem, cnoid::WorldLogFileItem, and cnoid::PointSetItem.

numCheckStates()

int Item::numCheckStates

(

)

const

numChildren()

int cnoid::Item::numChildren ( ) const

inline

onAddedToParent()

void Item::onAddedToParent ( )

protectedvirtual

Reimplemented in cnoid::CoordinateFrameItem.

onChildItemAboutToBeAdded()

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

protectedvirtual

This function is called when a child item is about to added to this item.

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 in cnoid::CoordinateFrameListItem, and cnoid::BodyMotionItem.

onConnectedToRoot()

void Item::onConnectedToRoot ( )

protectedvirtual

This function is called when the item has been connected to the tree including the root item. Note that the onPositionChanged function is called after this function.

Reimplemented in cnoid::BodyItem, cnoid::PositionTagGroupItem, cnoid::MprProgramItemBase, cnoid::SubProjectItem, and cnoid::MessageLogItem.

onDisconnectedFromRoot()

void Item::onDisconnectedFromRoot ( )

protectedvirtual

Reimplemented in cnoid::SimulatorItem, cnoid::CoordinateFrameListItem, cnoid::MprControllerItemBase, cnoid::PositionTagGroupItem, cnoid::PythonScriptItem, cnoid::PythonSimScriptItem, cnoid::SimpleControllerItem, cnoid::BodyMotionControllerItem, cnoid::MessageLogItem, cnoid::SensorVisualizerItem, and cnoid::ExtCommandItem.

onNewPositionCheck()

bool Item::onNewPositionCheck ( bool  isManualOperation, std::function< void()> &  out_callbackWhenAdded  )

protectedvirtual

Reimplemented in cnoid::BodyElementOverwriteItem, and cnoid::PositionTagGroupItem.

onPositionChanged()

void Item::onPositionChanged ( )

protectedvirtual

This function is called when the item position in the whole item tree is changed. Note that this function is not called when the item is not connected to the root even if the item is newly attached to another item that is not connected to the root. For such items, the function is called for each item when the sub tree is connected to the root.

Reimplemented in cnoid::BodyElementOverwriteItem, cnoid::SimulatorItem, cnoid::BodyItem, cnoid::CoordinateFrameListItem, cnoid::MprProgramItemBase, cnoid::WorldLogFileItem, cnoid::BodyTrackingCameraItem, cnoid::BodyMarkerItem, cnoid::SimpleControllerItem, cnoid::IoConnectionMapItem, and cnoid::SensorVisualizerItem.

onRemovedFromParent()

void Item::onRemovedFromParent ( Item *  parentItem, bool  isParentBeingDeleted  )

protectedvirtual

Reimplemented in cnoid::CoordinateFrameItem.

operator=()

Item& cnoid::Item::operator= ( const Item &  rhs )

delete

overwrite()

bool Item::overwrite	(	bool	forceOverwrite = false,
		const std::string &	format = std::string()
	)

This function save the data of the item to the file from which the data of the item has been loaded. If the data has not been loaded from a file, a file save dialog opens and user specifies a file.

parentItem()

Item* cnoid::Item::parentItem ( ) const

inline

prevItem()

Item* cnoid::Item::prevItem ( ) const

inline

putProperties()

void Item::putProperties

(

PutPropertyFunction &

putProperty

)

reload()

bool Item::reload

(

)

removeAddon()

void Item::removeAddon

(

ItemAddon *

addon

)

removeFromParentItem()

void Item::removeFromParentItem

(

)

replace()

bool Item::replace

(

Item *

originalItem

)

restore()

bool Item::restore ( const Archive &  archive )

virtual

Reimplemented in cnoid::SimulatorItem, cnoid::BodyItem, cnoid::DeviceOverwriteItem, cnoid::MprControllerItemBase, cnoid::ControllerItem, cnoid::PointSetItem, cnoid::CoordinateFrameListItem, cnoid::RootItem, cnoid::MultiPointSetItem, cnoid::AISTSimulatorItem, cnoid::BodyMotionItem, cnoid::PositionTagGroupItem, cnoid::WorldLogFileItem, cnoid::WorldItem, cnoid::BodyTrackingCameraItem, cnoid::MprProgramItemBase, cnoid::BodyMarkerItem, cnoid::SceneItem, cnoid::LinkShapeOverwriteItem, cnoid::CoordinateFrameItem, cnoid::PythonScriptItem, cnoid::PythonSimScriptItem, cnoid::SimpleControllerItem, cnoid::BodyMotionControllerItem, cnoid::SubProjectItem, cnoid::MessageLogItem, cnoid::LightingItem, cnoid::IoConnectionMapItem, cnoid::MultiDeviceStateSeqItem, cnoid::SensorVisualizerItem, cnoid::MprMultiVariableListItem, cnoid::AbstractSeqItem, cnoid::KinematicSimulatorItem, cnoid::FolderItem, cnoid::MaterialTableItem, cnoid::AudioItem, cnoid::GLVisionSimulatorItem, cnoid::SimulationScriptItem, cnoid::MediaItem, cnoid::ExtCommandItem, cnoid::CollisionSeqItem, and cnoid::SubSimulatorItem.

save()

bool Item::save	(	const std::string &	filename,
		const std::string &	format = std::string(),
		const Mapping *	options = nullptr
	)

This function saves the data of the item to a file by using a pre-registered saving function.

To make this function available, a saving function has to be registered to an ItemManager in advance by calling the addSaver() or addLoaderAndSaver() function. Otherwise, this function cannot be used. Note that this function should not be overloaded or overridden in the derived classes.

selectedDescendantItems() [1/2]

ItemList Item::selectedDescendantItems

(

std::function< bool(Item *item)>

pred = nullptr

)

const

selectedDescendantItems() [2/2]

template<class ItemType >

ItemList<ItemType> cnoid::Item::selectedDescendantItems ( std::function< bool(Item *item)>  pred = nullptr ) const

inline

setAddon()

bool Item::setAddon

(

ItemAddon *

addon

)

setAttribute()

void Item::setAttribute

(

Attribute

attribute

)

setChecked() [1/2]

void Item::setChecked

(

bool

on

)

setChecked() [2/2]

void Item::setChecked	(	int	checkId,
		bool	on
	)

setConsistentWithFile()

void Item::setConsistentWithFile

(

bool

isConsistent

)

setDisplayNameModifier()

void Item::setDisplayNameModifier

(

std::function< std::string(const Item *item)>

modifier

)

setName()

bool Item::setName ( const std::string &  name )

virtual

Reimplemented in cnoid::DeviceOverwriteItem, cnoid::BodyItem, cnoid::BodyTrackingCameraItem, cnoid::SceneItem, cnoid::PointSetItem, cnoid::BodyMarkerItem, cnoid::PositionTagGroupItem, and cnoid::MprProgramItemBase.

setSelected()

void Item::setSelected	(	bool	on,
		bool	isCurrent = false
	)

setSubItemAttributes()

void Item::setSubItemAttributes

(

)

setSubTreeItemsSelected()

void Item::setSubTreeItemsSelected

(

bool

on

)

setTemporal()

void Item::setTemporal

(

bool

on = true

)

sigAnyCheckToggled()

SignalProxy< void(int checkId, bool on)> Item::sigAnyCheckToggled

(

)

sigCheckToggled()

SignalProxy< void(bool on)> Item::sigCheckToggled

(

int

checkId = PrimaryCheck

)

sigDetachedFromRoot()

SignalProxy<void()> cnoid::Item::sigDetachedFromRoot ( )

inline

sigDisconnectedFromRoot()

SignalProxy< void()> Item::sigDisconnectedFromRoot

(

)

sigNameChanged()

SignalProxy< void(const std::string &oldName)> Item::sigNameChanged

(

)

sigPositionChanged()

SignalProxy< void()> Item::sigPositionChanged

(

)

This signal is emitted when the position of this item in the item tree is changed. Being added to the tree and being removed from the tree are also the events to emit this signal. This signal is also emitted for descendent items when the position of an ancestor item is changed. This signal is emitted before RootItem::sigTreeChanged();

sigPositionChanged2()

SignalProxy< void(Item *topItem, Item *prevTopParentItem)> Item::sigPositionChanged2

(

)

The following signal name is temporary. This is a variant of sigPositionChanged, and should be a standard sigunature. When the template implementation of the Signal class is improved to connect to functions omitting some arguments defined in a signal, this sigunare should replace the old sigunature with no arguments. Do not use this signal if you don't have a special reason because this function name will be removed.

sigSelectionChanged()

SignalProxy< void(bool isSelected)> Item::sigSelectionChanged

(

)

sigSubTreeChanged()

SignalProxy< void()> Item::sigSubTreeChanged

(

)

sigUpdated()

SignalProxy< void()> Item::sigUpdated

(

)

store()

bool Item::store ( Archive &  archive )

virtual

Reimplemented in cnoid::SimulatorItem, cnoid::BodyItem, cnoid::DeviceOverwriteItem, cnoid::MprControllerItemBase, cnoid::ControllerItem, cnoid::PointSetItem, cnoid::CoordinateFrameListItem, cnoid::RootItem, cnoid::MultiPointSetItem, cnoid::AISTSimulatorItem, cnoid::BodyMotionItem, cnoid::PositionTagGroupItem, cnoid::WorldLogFileItem, cnoid::WorldItem, cnoid::BodyTrackingCameraItem, cnoid::MprProgramItemBase, cnoid::BodyMarkerItem, cnoid::SceneItem, cnoid::LinkShapeOverwriteItem, cnoid::CoordinateFrameItem, cnoid::PythonScriptItem, cnoid::PythonSimScriptItem, cnoid::SimpleControllerItem, cnoid::BodyMotionControllerItem, cnoid::SubProjectItem, cnoid::MessageLogItem, cnoid::LightingItem, cnoid::IoConnectionMapItem, cnoid::MultiDeviceStateSeqItem, cnoid::SensorVisualizerItem, cnoid::MprMultiVariableListItem, cnoid::AbstractSeqItem, cnoid::KinematicSimulatorItem, cnoid::FolderItem, cnoid::MaterialTableItem, cnoid::AudioItem, cnoid::GLVisionSimulatorItem, cnoid::SimulationScriptItem, cnoid::MediaItem, cnoid::ExtCommandItem, cnoid::CollisionSeqItem, and cnoid::SubSimulatorItem.

suggestFileUpdate()

void Item::suggestFileUpdate

(

)

traverse() [1/2]

bool Item::traverse

(

std::function< bool(Item *)>

pred

)

traverse() [2/2]

template<class ItemType >

bool cnoid::Item::traverse ( std::function< bool(ItemType *item)>  pred = nullptr )

inline

unsetAttribute()

void Item::unsetAttribute

(

Attribute

attribute

)

updateFileInformation()

void Item::updateFileInformation	(	const std::string &	filename,
		const std::string &	format,
		Mapping *	options = nullptr
	)

---

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

• Item.h
• Item.cpp